fix: replacing macro {napi_build_versions} in binary filename by usin…

…g `binary.napi_build_versions` in package.json. Fixes: electron#554
mmaietta · Apr 12, 2023 · dc1ce32 · dc1ce32
1 parent 29365ad
commit dc1ce32
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 2 deletions.
diff --git a/src/module-type/node-gyp.ts b/src/module-type/node-gyp.ts
@@ -50,6 +50,10 @@ export class NodeGyp extends NativeModule {
 
   async buildArgsFromBinaryField(): Promise<string[]> {
     const binary = await this.packageJSONFieldWithDefault('binary', {}) as Record<string, string>;
+    let napi_build_version: number | undefined = undefined
+    if (Array.isArray(binary.napi_versions)) {
+      napi_build_version = this.nodeAPI.getNapiVersion(binary.napi_versions as number[])
+    }
     const flags = await Promise.all(Object.entries(binary).map(async ([binaryKey, binaryValue]) => {
       if (binaryKey === 'napi_versions') {
         return;
@@ -67,7 +71,9 @@ export class NodeGyp extends NativeModule {
         .replace('{arch}', this.rebuilder.arch)
         .replace('{version}', await this.packageJSONField('version') as string)
         .replace('{libc}', await detectLibc.family() || 'unknown');
-
+      if (napi_build_version !== undefined) {
+        value = value.replace('{napi_build_version}', napi_build_version.toString())
+      }
       for (const [replaceKey, replaceValue] of Object.entries(binary)) {
         value = value.replace(`{${replaceKey}}`, replaceValue);
       }

diff --git a/test/fixture/native-app1/package.json b/test/fixture/native-app1/package.json
@@ -22,7 +22,8 @@
     "farmhash": "3.2.1",
     "level": "6.0.0",
     "native-hello-world": "2.0.0",
-    "ref-napi": "1.4.2"
+    "ref-napi": "1.4.2",
+    "sqlite3": "5.1.6"
   },
   "optionalDependencies": {
     "bcrypt": "3.0.6"

diff --git a/test/rebuild.ts b/test/rebuild.ts
@@ -194,4 +194,35 @@ describe('rebuilder', () => {
       await expectNativeModuleToBeRebuilt(testModulePath, 'ffi-napi');
     });
   });
+
+  describe('rebuild with napi_build_versions in binary config', async function () {
+    this.timeout(10 * MINUTES_IN_MILLISECONDS);
+
+    before(async () => await resetTestModule(testModulePath));
+    after(async() => await cleanupTestModule(testModulePath));
+
+    // https://github.com/electron/rebuild/issues/554
+    const archs = ['x64', 'arm64']
+    for (const arch of archs) {
+      it(`${ arch } arch should have rebuilt bianry with napi_build_versions array provided`, async () => {
+        const napiBuildVersion = 6;
+        const binaryPath = path.resolve(testModulePath, `node_modules/sqlite3/lib/binding/napi-v${ napiBuildVersion }-${ process.platform }-unknown-${ arch }/node_sqlite3.node`);
+        if (await fs.pathExists(binaryPath)) {
+          fs.removeSync(binaryPath)
+        }
+        expect(await fs.pathExists(binaryPath)).to.be.false;
+
+        await rebuild({
+          buildPath: testModulePath,
+          electronVersion: testElectronVersion,
+          arch,
+          onlyModules: ['sqlite3'],
+        });
+        await expectNativeModuleToBeRebuilt(testModulePath, 'sqlite3');
+
+        expect(await fs.pathExists(binaryPath)).to.be.true;
+        fs.removeSync(binaryPath);
+      });
+    }
+  });
 });