wip: test preload files

README.md

@@ -13,7 +13,7 @@ The app is a typical Electron dev setup, excepting the use of [esbuild][1].
 yarn
 
 # start the development build and watch script
-yarn start
+yarn dev
 
 # If error with sqlite library versions
 yarn run electron-rebuild

package.json

@@ -10,11 +10,11 @@
     "lint:prettier:write": "prettier . --write",
     "lint:types:check": "tsc --noEmit --skipLibCheck",
     "postinstall": "yarn run electron-rebuild",
-    "prestart": "tailwindcss -i ./src/index.css -o ./src/index-compiled.css",
+    "predev": "tailwindcss -i ./src/index.css -o ./src/index-compiled.css",
     "prebuild": "yarn run lint && tailwindcss -i ./src/index.css -o ./src/index-compiled.css",
-    "start": "node ./scripts/dev.js",
-    "pretest": "node ./scripts/test.mjs",
-    "test": "mocha 'src/**/*.test.bundle.js'"
+    "dev": "node ./scripts/dev.js",
+    "pretest": "node ./scripts/pretest.mjs",
+    "test": "electron-mocha --renderer 'src/**/*.test.bundle.js'"
   },
   "dependencies": {
     "ajv": "^8.6.2",
@@ -50,6 +50,7 @@
     "class-variance-authority": "^0.7.0",
     "date-fns": "^3.3.1",
     "electron": "^28.2.0",
+    "electron-mocha": "^12.3.0",
     "emotion": "^10.0.27",
     "esbuild": "^0.20.0",
     "evergreen-ui": "^7.1.9",

scripts/pretest.mjs

@@ -0,0 +1,50 @@
+import esbuild from "esbuild";
+import fs from "fs";
+import path from "path";
+
+// Function to find test files
+function findTestFiles(dir, files = [], ignorePreload = false) {
+  fs.readdirSync(dir, { withFileTypes: true }).forEach((dirent) => {
+    const res = path.resolve(dir, dirent.name);
+    if (dirent.isDirectory()) {
+      if (!(ignorePreload && res.includes("src/preload"))) {
+        findTestFiles(res, files, ignorePreload);
+      }
+    } else if (dirent.name.endsWith(".test.ts")) {
+      files.push(res);
+    }
+  });
+  return files;
+}
+
+// Find browser test files, excluding preload directory
+const browserTestFiles = findTestFiles("src", [], true);
+console.log(browserTestFiles);
+
+// Find preload test files
+const preloadTestFiles = findTestFiles("src/preload");
+console.log(preloadTestFiles);
+
+// Bundle browser test files
+browserTestFiles.forEach(async (file) => {
+  await esbuild.build({
+    entryPoints: [file],
+    outfile: file.replace(".test.ts", ".test.bundle.js"),
+    bundle: true,
+    platform: "node",
+    external: ["mocha"],
+    plugins: [],
+  });
+});
+
+// Bundle preload test files
+preloadTestFiles.forEach(async (file) => {
+  await esbuild.build({
+    entryPoints: [file],
+    outfile: file.replace(".test.ts", ".test.bundle.js"),
+    bundle: true,
+    platform: "node",
+    external: ["knex", "electron", "electron-store", "better-sqlite3", "mocha"],
+    plugins: [],
+  });
+});

scripts/production.js

@@ -1,47 +1,48 @@
+const fs = require("fs");
+const path = require("path");
 const esbuild = require("esbuild");
 
-// After successful build, log results
-function afterBuild(name) {
-  return {
-    name: `after-build-${name}`,
-    setup(build) {
-      build.onEnd((result) => {
-        if (result.errors.length) {
-          console.error(`${name} bundle completed with errors`, errors);
-          process.exit(1);
-        } else {
-          console.log(`${name} bundle completed`);
-        }
-      });
-    },
-  };
+// Function to find test files
+function findTestFiles(dir, files = [], ignorePreload = false) {
+  fs.readdirSync(dir, { withFileTypes: true }).forEach((dirent) => {
+    const res = path.resolve(dir, dirent.name);
+    if (dirent.isDirectory()) {
+      if (!(ignorePreload && res.includes("src/preload"))) {
+        findTestFiles(res, files, ignorePreload);
+      }
+    } else if (dirent.name.endsWith(".test.ts")) {
+      files.push(res);
+    }
+  });
+  return files;
 }
 
-// build renderer bundle
-esbuild.build({
-  entryPoints: ["src/index.tsx"],
-  outfile: "src/renderer.bundle.js",
-  bundle: true,
-  platform: "browser",
-  plugins: [afterBuild("renderer")],
-});
+// Find browser test files, excluding preload directory
+const browserTestFiles = findTestFiles("src", [], true);
+
+// Find preload test files
+const preloadTestFiles = findTestFiles("src/preload");
 
-// build preload bundle
-esbuild.build({
-  entryPoints: ["src/preload/index.ts"],
-  outfile: "src/preload.bundle.js",
-  bundle: true,
-  platform: "node",
-  external: ["knex", "electron", "electron-store", "better-sqlite3"],
-  plugins: [afterBuild("preload")],
+// Bundle browser test files
+browserTestFiles.forEach(async (file) => {
+  await esbuild.build({
+    entryPoints: [file],
+    outfile: file.replace(".test.ts", ".test.bundle.js"),
+    bundle: true,
+    platform: "node", // NOTE: this differs from the build script, which uses "browser", b/c we're running tests in Node
+    external: ["mocha"],
+    plugins: [],
+  });
 });
 
-// build electron main bundle
-esbuild.build({
-  entryPoints: ["src/electron/index.js"],
-  outfile: "src/main.bundle.js",
-  bundle: true,
-  platform: "node",
-  external: ["electron", "electron-store", "better-sqlite3"],
-  plugins: [afterBuild("main")],
+// Bundle preload test files
+preloadTestFiles.forEach(async (file) => {
+  await esbuild.build({
+    entryPoints: [file],
+    outfile: file.replace(".test.ts", ".test.bundle.js"),
+    bundle: true,
+    platform: "node",
+    external: ["knex", "electron", "electron-store", "better-sqlite3"],
+    plugins: [], // Include any necessary plugins here
+  });
 });

src/preload/client/documents.test.ts

@@ -0,0 +1,53 @@
+import { test, suite, before } from "mocha";
+import { create } from "../client";
+
+// migrate a temporary db file
+// over-ride the electron store setup in client
+
+// client index (src/preload/client/index.ts)
+// const settings = new Store({
+//   name: "settings",
+// });
+
+// // todo: validation, put this somewhere proper
+// const db = DB(settings.get("DATABASE_URL") as string);
+
+// I need to overide the DATABASE_URL before importing the client
+
+import DB from "better-sqlite3";
+import Knex from "knex";
+import Store from "electron-store";
+
+function setupClient() {
+  const settings = new Store({
+    name: "settings-test",
+  });
+
+  // todo: validation, put this somewhere proper
+  const db = DB(settings.get("DATABASE_URL") as string);
+
+  type IDB = ReturnType<typeof DB>;
+
+  // Added knex for search which required lots of query mix and
+  // matching
+  // todo: migrate codebase to prefer knex to directly using
+  // the better-sqlite3 client
+  const knex = Knex({
+    client: "better-sqlite3", // or 'better-sqlite3'
+    connection: {
+      filename: settings.get("DATABASE_URL") as string,
+    },
+  });
+
+  return create(db, knex, settings);
+}
+
+suite("client.documents", function () {
+  before("Setup database", function () {
+    setupClient();
+  });
+
+  test("loads", function () {
+    throw "Hello mocha";
+  });
+});

src/preload/client/index.ts

@@ -8,28 +8,33 @@ import DB from "better-sqlite3";
 import Knex from "knex";
 
 import Store from "electron-store";
-const settings = new Store({
-  name: "settings",
-});
+// const settings = new Store({
+//   name: "settings",
+// });
 
 // todo: validation, put this somewhere proper
-const db = DB(settings.get("DATABASE_URL") as string);
+// const db = DB(settings.get("DATABASE_URL") as string);
+
+type IDB = ReturnType<typeof DB>;
+type IKnex = ReturnType<typeof Knex>;
 
 // Added knex for search which required lots of query mix and
 // matching
 // todo: migrate codebase to prefer knex to directly using
 // the better-sqlite3 client
-const knex = Knex({
-  client: "better-sqlite3", // or 'better-sqlite3'
-  connection: {
-    filename: settings.get("DATABASE_URL") as string,
-  },
-});
+// const knex = Knex({
+//   client: "better-sqlite3", // or 'better-sqlite3'
+//   connection: {
+//     filename: settings.get("DATABASE_URL") as string,
+//   },
+// });
 
 export { GetDocumentResponse } from "./documents";
 
+// todo: Given how this client is setup, I wonder if singleton approach is really necessary
 let client: IClient;
-export function create(): IClient {
+
+export function create(db: IDB, knex: IKnex, settings: Store): IClient {
   if (!client) {
     client = {
       journals: new JournalsClient(db),

src/preload/importer/importChronicles.ts

@@ -6,7 +6,9 @@
 import { DateTime } from "luxon";
 
 import { create } from "../client";
+
+// todo: move create setup to a shared file
 const client = create();
 
 async function findOrCreate(name: string) {
   const journals = await client.journals.list();

src/preload/index.ts

@@ -2,6 +2,30 @@ import { contextBridge } from "electron";
 import { create } from "./client";
 import "./utils.electron";
 
+import DB from "better-sqlite3";
+import Knex from "knex";
+
+import Store from "electron-store";
+const settings = new Store({
+  name: "settings",
+});
+
+// todo: validation, put this somewhere proper
+const db = DB(settings.get("DATABASE_URL") as string);
+
+type IDB = ReturnType<typeof DB>;
+
+// Added knex for search which required lots of query mix and
+// matching
+// todo: migrate codebase to prefer knex to directly using
+// the better-sqlite3 client
+const knex = Knex({
+  client: "better-sqlite3", // or 'better-sqlite3'
+  connection: {
+    filename: settings.get("DATABASE_URL") as string,
+  },
+});
+
 contextBridge.exposeInMainWorld("chronicles", {
-  createClient: create,
+  createClient: () => create(db, knex, settings),
 });

src/views/edit/index.test.ts

@@ -1,9 +1,11 @@
-import { test } from "mocha";
+import { test, suite } from "mocha";
 
-test("loads");
-test("has loading state");
-test("saves document");
-test("cannot edit while saving");
-test("saving a document twice updates it...");
-test("saving error is surfaced");
-test("loading error is surfaced");
+suite("views.edit", function () {
+  test("loads");
+  test("has loading state");
+  test("saves document");
+  test("cannot edit while saving");
+  test("saving a document twice updates it...");
+  test("saving error is surfaced");
+  test("loading error is surfaced");
+});