Fix and test rebuilding

Author: timfish

.github/workflows/ci.yml

@@ -408,6 +408,33 @@ jobs:
       - name: Run tests
         run: yarn test
 
+  job_test_bindings_recompile:
+    name: Test (recompile from source) (v${{ matrix.node }}) ${{ matrix.os }}
+    needs: [job_build]
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-late4st, macos-latest, windows-latest]
+        node: [18, 26]
+    steps:
+      - name: Check out current commit
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+      - name: Set up Node
+        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4
+        with:
+          node-version: ${{ matrix.node }}
+      - name: Install dependencies
+        run: yarn install --ignore-engines --ignore-scripts --frozen-lockfile
+      - name: Download Tarball
+        uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4
+        with:
+          name: ${{ github.sha }}
+      - name: Clear binaries
+        run: yarn clean:binaries
+      - name: Run tests
+        run: yarn test
+
   job_required_jobs_passed:
     name: All required jobs passed
     needs: [job_lint, job_test_bindings]

package.json

@@ -32,6 +32,7 @@
     "build:bindings:arm64": "yarn build:lib && node-gyp build --arch=arm64 && yarn build:copy-binary",
     "build:tarball": "npm pack",
     "clean": "node-gyp clean && rm -rf lib && rm -rf build && rm -f *.tgz",
+    "clean:binaries": "node -e \"require('fs').readdirSync('lib').filter(f=>f.endsWith('.node')).forEach(f=>require('fs').rmSync('lib/'+f))\"",
     "test": "node ./test/prepare.mjs && vitest run --poolOptions.forks.singleFork --silent=false --disable-console-intercept"
   },
   "gypfile": false,

src/index.ts

@@ -1,6 +1,7 @@
 /* eslint-disable no-console */
 import type { AsyncLocalStorage } from 'node:async_hooks';
 import { spawnSync } from 'node:child_process';
+import * as fs from 'node:fs';
 import * as path from 'node:path';
 import { env } from 'node:process';
 import { threadId } from 'node:worker_threads';
@@ -54,23 +55,24 @@ function clean(err: Buffer): string {
 
 function recompileFromSource(): void {
   const cwd = path.join(__dirname, '..');
+  // Resolve node-gyp from its package entry so it's found even when
+  // node_modules/.bin/ is not in PATH (e.g. outside of npm run scripts).
+  const nodeGyp = require.resolve('node-gyp/bin/node-gyp.js');
   console.log('Compiling from source...');
-  let spawn = spawnSync('node-gyp', ['configure'], {
+  let spawn = spawnSync(process.execPath, [nodeGyp, 'configure'], {
     cwd,
     stdio: ['inherit', 'inherit', 'pipe'],
     env: process.env,
-    shell: true,
   });
   if (spawn.status !== 0) {
     console.log('Failed to configure gyp');
     if (spawn.stderr) console.log(clean(spawn.stderr));
     return;
   }
-  spawn = spawnSync('node-gyp', ['build'], {
+  spawn = spawnSync(process.execPath, [nodeGyp, 'build'], {
     cwd,
     stdio: ['inherit', 'inherit', 'pipe'],
     env: process.env,
-    shell: true,
   });
   if (spawn.status !== 0) {
     console.log('Failed to build bindings');
@@ -255,13 +257,29 @@ function getNativeModule(): Native {
     return nativeModule;
   }
 
-  try {
-    recompileFromSource();
-  } catch (e) {
-    console.warn('Failed to compile from source:', e);
+  // Exclusive-create a lock file so only one process/thread runs node-gyp at a
+  // time. Losers (EEXIST) wait for the winner to finish before trying to load.
+  const lockFile = path.join(__dirname, '..', '.rebuild-lock');
+  let lockFd: number | undefined;
+  try { lockFd = fs.openSync(lockFile, 'wx'); } catch { /* another caller holds the lock */ }
+
+  if (lockFd !== undefined) {
+    try {
+      recompileFromSource();
+    } catch (e) {
+      console.warn('Failed to compile from source:', e);
+    } finally {
+      try { fs.closeSync(lockFd); } catch { /* ignore */ }
+      try { fs.unlinkSync(lockFile); } catch { /* ignore */ }
+    }
+  } else {
+    const timer = new Int32Array(new SharedArrayBuffer(4));
+    while (fs.existsSync(lockFile)) {
+      Atomics.wait(timer, 0, 0, 250);
+    }
   }
 
-  // Try again after attempting to recompile, in case the binary is now available.
+  // Try again after recompile (or after another caller finished theirs).
   nativeModule = tryLoad();
 
   if (nativeModule) {