fix: fixed packaged executable

Author: aryanjassal

flake.nix

@@ -60,7 +60,7 @@
           postBuild = ''
             npm run pkg -- \
               --output=out \
-              --bin=dist/polykey.mjs \
+              --bin=dist/polykey.cjs \
               --node-version=${utils.nodeVersion} \
               --platform=${platform} \
               --arch=${arch}

package.json

@@ -102,8 +102,7 @@
       "node_modules/sodium-native/prebuilds/darwin-arm64/node.napi.node",
       "node_modules/sodium-native/prebuilds/darwin-x64/node.napi.node",
       "node_modules/sodium-native/prebuilds/linux-x64/node.napi.node",
-      "node_modules/sodium-native/prebuilds/win32-x64/node.napi.node",
-      "node_modules/sodium-native/index.js"
+      "node_modules/sodium-native/prebuilds/win32-x64/node.napi.node"
     ],
     "scripts": [
       "dist/polykeyWorkerManifest.js"
@@ -121,7 +120,7 @@
     "lintfix": "eslint '{src,tests,scripts,benches}/**/*.{js,mjs,ts,mts,jsx,tsx}' --fix",
     "lint-shell": "find ./src ./tests ./scripts -type f -regextype posix-extended -regex '.*\\.(sh)' -exec shellcheck {} +",
     "docs": "shx rm -rf ./docs && typedoc --gitRevision master --tsconfig ./tsconfig.build.json --out ./docs src",
-    "pkg": "node ./scripts/pkg.mjs",
+    "pkg": "node ./scripts/build.mjs --pkg && node ./scripts/pkg.mjs",
     "polykey": "node dist/polykey.mjs",
     "start": "node dist/polykey.mjs -- agent start --verbose"
   },
@@ -173,4 +172,4 @@
     "typedoc": "^0.24.8",
     "typescript": "^5.1.6"
   }
-}
+}

pkg.json

@@ -0,0 +1 @@
+{"assets":["node_modules/@matrixai/db/prebuilds/darwin-x64+arm64/node.napi.node","node_modules/@matrixai/db/prebuilds/linux-x64/node.napi.node","node_modules/@matrixai/db/prebuilds/win32-x64/node.napi.node","node_modules/@matrixai/mdns-linux-x64/node.napi.node","node_modules/@matrixai/mdns-linux-x64/package.json","node_modules/@matrixai/quic-darwin-universal/node.napi.node","node_modules/@matrixai/quic-darwin-universal/package.json","node_modules/@matrixai/quic-linux-x64/node.napi.node","node_modules/@matrixai/quic-linux-x64/package.json","node_modules/@matrixai/quic-win32-x64/node.napi.node","node_modules/@matrixai/quic-win32-x64/package.json","node_modules/@matrixai/exec-darwin-universal/node.napi.node","node_modules/@matrixai/exec-darwin-universal/package.json","node_modules/@matrixai/exec-linux-x64/node.napi.node","node_modules/@matrixai/exec-linux-x64/package.json","node_modules/fd-lock/prebuilds/linux-x64/node.napi.node","node_modules/fd-lock/prebuilds/darwin-x64/node.napi.node","node_modules/fd-lock/prebuilds/darwin-arm64/node.napi.node","node_modules/fd-lock/prebuilds/win32-x64/node.napi.node","node_modules/sodium-native/prebuilds/darwin-arm64/node.napi.node","node_modules/sodium-native/prebuilds/darwin-x64/node.napi.node","node_modules/sodium-native/prebuilds/linux-x64/node.napi.node","node_modules/sodium-native/prebuilds/win32-x64/node.napi.node","node_modules/sodium-native/index.js","dist/**","node_modules/@matrixai/db/prebuilds/linux-x64/node.napi.node","node_modules/fd-lock/prebuilds/linux-x64/node.napi.node","node_modules/sodium-native/prebuilds/linux-x64/node.napi.node"],"scripts":["dist/polykeyWorkerManifest.js"]}

scripts/build.mjs

@@ -16,9 +16,69 @@ const projectPath = path.dirname(
 
 const platform = os.platform();
 
+/**
+ * This plugin intercepts loading of certain imports and replaces their contents.
+ * It overrides the import paths for native imports for rocksdb, fd-lock and sodium-native
+ */
+const nativeNodeModulesPlugin = {
+  name: 'native-node-modules',
+  setup(build) {
+    build.onLoad({ filter: /\.*/, namespace: 'file' }, (args) => {
+      const filename = path.basename(args.path);
+      if (filename === 'rocksdb.js') {
+        return {
+          contents: `
+            import path from 'node:path';
+            import url from 'node:url';
+            import nodeGypBuild from 'node-gyp-build';
+            const projectPath = path.join(path.dirname(url.fileURLToPath(import.meta.url)), '..', 'node_modules', '@matrixai', 'db');
+            const rocksdb = nodeGypBuild(projectPath);
+            export default rocksdb;
+            //# sourceMappingURL=rocksdb.js.map
+         `,
+          loader: 'js',
+        };
+      }
+      if (args.path.endsWith('fd-lock/index.js')) {
+        return {
+          contents: `
+            const path = require('path');
+            const binding = require('node-gyp-build')(path.join(__dirname, '..', 'node_modules', 'fd-lock'))
+            
+            lock.unlock = unlock
+            module.exports = lock
+            
+            function lock (fd) {
+              return !!binding.fd_lock(fd)
+            }
+            
+            function unlock (fd) {
+              return !!binding.fd_unlock(fd)
+            }
+          `,
+          loader: 'js',
+        };
+      }
+      if (args.path.endsWith('sodium-native/index.js')) {
+        return {
+          contents: `
+            const path = require('path');
+            module.exports = require('node-gyp-build')(path.join(__dirname, '..', 'node_modules', 'sodium-native'))
+          `,
+          loader: 'js',
+        };
+      }
+      return;
+    });
+  },
+};
+
 /* eslint-disable no-console */
 async function main(argv = process.argv) {
   argv = argv.slice(2);
+  const pkgIndex = argv.findIndex((v) => v === '--pkg');
+  if (pkgIndex >= 0) argv.splice(pkgIndex, 1);
+  const isPkg = pkgIndex >= 0;
   const buildPath = path.join(projectPath, 'build');
   const distPath = path.join(projectPath, 'dist');
   const gitPath = process.env.GIT_DIR ?? path.join(projectPath, '.git');
@@ -64,9 +124,29 @@ async function main(argv = process.argv) {
     path.join(buildPath, 'build.json'),
     JSON.stringify(buildJSON, null, 2),
   );
+
   // This specifies import paths that is left as an external require
   // This is kept to packages that have a native binding
-  const externalDependencies = Object.keys(packageJSON.optionalDependencies);
+  /** @type { import('esbuild').BuildOptions } */
+  const isPkgSwitchedOptions = isPkg
+    ? {
+        external: [],
+        format: 'cjs',
+        inject: [path.join(projectPath, './shims/import-meta-url-shim.mjs')],
+        // Fix import.meta.url in CJS output
+        define: {
+          'import.meta.url': '__import_meta_url',
+        },
+        outExtension: { '.js': '.cjs' },
+      }
+    : {
+        // External: externalDependencies,
+        format: 'esm',
+        inject: [path.join(projectPath, './shims/require-shim.mjs')],
+        outExtension: { '.js': '.mjs' },
+      };
+
+  /** @type { import('esbuild').BuildOptions } */
   const esbuildOptions = {
     // 2 entrypoints, the main script and the worker script
     entryPoints: [
@@ -77,17 +157,14 @@ async function main(argv = process.argv) {
     bundle: true,
     platform: 'node',
     outdir: distPath,
-    external: externalDependencies,
     treeShaking: true,
     // External source map for debugging
     sourcemap: true,
     // Minify and keep the original names
     minify: false,
     keepNames: true,
-    // Supporting ESM
-    format: 'esm',
-    inject: [path.join(projectPath, './shims/require-shim.mjs')],
-    outExtension: { '.js': '.mjs' },
+    plugins: [nativeNodeModulesPlugin],
+    ...isPkgSwitchedOptions,
   };
   console.error('Running esbuild:');
   console.error(esbuildOptions);
@@ -96,7 +173,11 @@ async function main(argv = process.argv) {
   console.error('Renaming worker script');
   childProcess.execFileSync(
     'mv',
-    ['dist/polykeyWorkerManifest.mjs', 'dist/polykeyWorkerManifest.js'],
+    [
+      `dist/polykeyWorkerManifest.${isPkg ? 'cjs' : 'mjs'}`,
+      'dist/polykeyWorkerManifest.js',
+    ],
+    // ['dist/polykeyWorkerManifest.mjs', 'dist/polykeyWorkerManifest.js'],
     {
       stdio: ['inherit', 'inherit', 'inherit'],
       windowsHide: true,
@@ -106,7 +187,10 @@ async function main(argv = process.argv) {
   );
   childProcess.execFileSync(
     'mv',
-    ['dist/polykeyWorkerManifest.mjs.map', 'dist/polykeyWorkerManifest.js.map'],
+    [
+      `dist/polykeyWorkerManifest.${isPkg ? 'cjs' : 'mjs'}.map`,
+      'dist/polykeyWorkerManifest.js.map',
+    ],
     {
       stdio: ['inherit', 'inherit', 'inherit'],
       windowsHide: true,

scripts/pkg.mjs

@@ -103,6 +103,7 @@ async function main(argv = process.argv) {
   const { default: nodeGypBuild } = await import('node-gyp-build');
   const pkgConfig = packageJSON.pkg ?? {};
   pkgConfig.assets = pkgConfig.assets ?? {};
+
   const npmLsOut = childProcess.execFileSync(
     'npm',
     ['ls', '--all', '--omit=dev', '--parseable'],
@@ -143,7 +144,6 @@ async function main(argv = process.argv) {
     `--config=${pkgConfigPath}`,
     `--targets=node${nodeVersion}-${pkgPlatform}-${pkgArch}`,
     '--no-bytecode',
-    '--no-native-build',
     '--options=experimental-require-module',
     '--public',
     "--public-packages='*'",

shims/import-meta-url-shim.mjs

@@ -0,0 +1,10 @@
+let __import_meta_url;
+if (typeof document === 'undefined') {
+  const { pathToFileURL } = require('url');
+  __import_meta_url = pathToFileURL(__filename).href;
+} else {
+  __import_meta_url =
+    (document.currentScript && document.currentScript.src) ||
+    new URL('main.js', document.baseURI).href;
+}
+export { __import_meta_url };