build: integration testing support

Run integration tests in an electron environment for the main process.

Signed-off-by: Kristóf Marussy <kristof@marussy.com>

8 files changed, 130 insertions, 1 deletions

diff --git a/config/electronJestEnvironment.cjs b/config/electronJestEnvironment.cjs
new file mode 100644
index 0000000..385761e
--- /dev/null
+++ b/config/electronJestEnvironment.cjs
@@ -0,0 +1,10 @@
+const electron = require('electron');
+const { TestEnvironment } = require('jest-environment-node');
+
+module.exports = class ElectronEnvironment extends TestEnvironment {
+  /** @override */
+  async setup() {
+    await super.setup();
+    this.global.ELECTRON_MODULE = electron;
+  }
+};
diff --git a/config/electronJestGlobalSetup.cjs b/config/electronJestGlobalSetup.cjs
new file mode 100644
index 0000000..c57df68
--- /dev/null
+++ b/config/electronJestGlobalSetup.cjs
@@ -0,0 +1,3 @@
+const { app } = require('electron');
+
+module.exports = () => app.whenReady();
diff --git a/config/electronJestGlobalTeardown.cjs b/config/electronJestGlobalTeardown.cjs
new file mode 100644
index 0000000..f790a4f
--- /dev/null
+++ b/config/electronJestGlobalTeardown.cjs
@@ -0,0 +1,8 @@
+const { app } = require('electron');
+
+/** @type {(globalConfig: import('@jest/types').Config.InitialOptions) => void} */
+module.exports = (globalConfig) => {
+  if (!globalConfig.watch && !globalConfig.watchAll) {
+    app.quit();
+  }
+};
diff --git a/config/electronJestSetup.cjs b/config/electronJestSetup.cjs
new file mode 100644
index 0000000..c53a3f8
--- /dev/null
+++ b/config/electronJestSetup.cjs
@@ -0,0 +1,13 @@
+const electron = /** @type {{ ELECTRON_MODULE: import('electron')}} */ (
+  /** @type {unknown} */ (globalThis)
+).ELECTRON_MODULE;
+
+const { BrowserWindow } = electron;
+
+jest.mock('electron', () => electron);
+
+afterEach(() => {
+  BrowserWindow.getAllWindows().forEach((window) => {
+    window.destroy();
+  });
+});
diff --git a/config/jest.config.base.cjs b/config/jest.config.base.cjs
new file mode 100644
index 0000000..ee85d66
--- /dev/null
+++ b/config/jest.config.base.cjs
@@ -0,0 +1,27 @@
+const path = require('node:path');
+
+/** @type {import('@jest/types').Config.InitialOptions} */
+module.exports = {
+  transform: {
+    '\\.[jt]sx?$': path.join(__dirname, 'jestEsbuildCjsTransformer.cjs'),
+  },
+  testRegex: '(\\.|/)integ\\.spec\\.ts$',
+  transformIgnorePatterns: ['/node_modules/(?!(chalk|lodash-es)/)'],
+  moduleNameMapper: {
+    '^@sophie/(.+)$': path.join(__dirname, '../packages/$1/src/index.ts'),
+    '^(\\.{1,2}/.*)\\.jsx?$': '$1',
+    // Workaround for jest to recognize the vendored dependencies of chalk.
+    '^#ansi-styles$': path.join(
+      __dirname,
+      '../node_modules/chalk/source/vendor/ansi-styles/index.js',
+    ),
+    '^#supports-color$': path.join(
+      __dirname,
+      '../node_modules/chalk/source/vendor/supports-color/index.js',
+    ),
+  },
+  resetMocks: true,
+  restoreMocks: true,
+  testEnvironment: 'node',
+  testPathIgnorePatterns: ['/dist/', '/node_modules/'],
+};
diff --git a/config/jest.config.base.js b/config/jest.config.base.js
index d9865f9..32d2ecb 100644
--- a/config/jest.config.base.js
+++ b/config/jest.config.base.js
@@ -9,6 +9,7 @@ export default {
   transform: {
     '\\.tsx?$': path.join(thisDir, 'jestEsbuildTransformer.js'),
   },
+  testRegex: '((?<!integ)\\.|/)spec\\.tsx?$',
   extensionsToTreatAsEsm: ['.ts', '.tsx'],
   moduleNameMapper: {
     '^@sophie/(.+)$': path.join(thisDir, '../packages/$1/src/index.ts'),
diff --git a/config/jestEsbuildCjsTransformer.cjs b/config/jestEsbuildCjsTransformer.cjs
new file mode 100644
index 0000000..419d7b2
--- /dev/null
+++ b/config/jestEsbuildCjsTransformer.cjs
@@ -0,0 +1,57 @@
+const { readFileSync } = require('node:fs');
+const path = require('node:path');
+
+const { transformSync } = require('esbuild');
+
+const electronVendorsJson = readFileSync(
+  path.join(__dirname, '../.electron-vendors.cache.json'),
+  'utf8',
+);
+
+/** @type {{ node: number; }} */
+// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+const { node: nodeVersion } = JSON.parse(electronVendorsJson);
+
+/**
+ * @param {string} source
+ * @param {string} filePath
+ * @return {import('@jest/transform').TransformedSource}
+ */
+function process(source, filePath) {
+  /** @type {import('esbuild').Loader} */
+  let loader;
+  if (filePath.endsWith('tsx')) {
+    loader = 'tsx';
+  } else if (filePath.endsWith('ts')) {
+    loader = 'ts';
+  } else {
+    loader = 'js';
+  }
+  const { code, map } = transformSync(source, {
+    loader,
+    sourcefile: filePath,
+    format: 'cjs',
+    target: `node${nodeVersion}`,
+    sourcemap: true,
+    define: {
+      __DEV__: JSON.stringify(false), // For mobx
+      'process.env.NODE_ENV': 'test',
+      'process.env.MODE': 'test',
+      'import.meta.env': JSON.stringify({
+        DEV: false,
+        MODE: 'test',
+        PROD: true,
+      }),
+    },
+  });
+  return {
+    code,
+    map,
+  };
+}
+
+/** @type {import('@jest/transform').Transformer<void>} */
+module.exports = {
+  canInstrument: false,
+  process,
+};
diff --git a/config/jestEsbuildTransformer.js b/config/jestEsbuildTransformer.js
index b6f2fc3..6a4760f 100644
--- a/config/jestEsbuildTransformer.js
+++ b/config/jestEsbuildTransformer.js
@@ -4,7 +4,7 @@ import { node } from './buildConstants.js';
 
 /**
  * @param {string} source
- * @param {import('@jest/types').Config.Path} filePath
+ * @param {string} filePath
  * @return {Promise<import('@jest/transform').TransformedSource>}
  */
 async function processAsync(source, filePath) {
@@ -14,6 +14,16 @@ async function processAsync(source, filePath) {
     format: 'esm',
     target: node,
     sourcemap: true,
+    define: {
+      __DEV__: JSON.stringify(false), // For mobx
+      'process.env.NODE_ENV': 'test',
+      'process.env.MODE': 'test',
+      'import.meta.env': JSON.stringify({
+        DEV: false,
+        MODE: 'test',
+        PROD: true,
+      }),
+    },
   });
   return {
     code,