Use package name and relative paths when hashing (#11)

* Use package name and relative path when hashing

* Add utility command to print the hash of an xcframework

* Add tests for hashNodeApiModulePath

* Delete package.json files to avoid collisions

* Update comment

* Rename hashNodeApiModulePath to hashModulePath and fix its implementation

* Rename getNodeApiRequireCallArgument to getLibraryInstallName

* Add print-xcframeworks command

* Exclude paths in findXCFrameworkPaths

* Improve helpers

* fixup! Rename getNodeApiRequireCallArgument to getLibraryInstallName

* Asserting file existence in hashModulePath

* fixup! Add print-xcframeworks command

* Add missing .length

* Use reassignment over recursion

Author: kraenhansen

package-lock.json

@@ -66,4 +66,15 @@ for (const src of ALLOW_LIST) {
   const destPath = path.join(EXAMPLES_DIR, src);
   console.log("Copying from", srcPath, "to", destPath);
   fs.cpSync(srcPath, destPath, { recursive: true });
+  // Delete all package.json files recursively, as they have duplicate names, causing collisions when hashing
+  for (const entry of fs.readdirSync(destPath, {
+    withFileTypes: true,
+    recursive: true,
+  })) {
+    if (entry.name === "package.json") {
+      const filePath = path.join(entry.parentPath, entry.name);
+      console.log("Deleting", filePath);
+      fs.rmSync(filePath);
+    }
+  }
 }

packages/node-addon-examples/scripts/copy-examples.mts

@@ -48,7 +48,9 @@
     "bufout": "^0.3.1",
     "chalk": "^5.4.1",
     "commander": "^13.1.0",
-    "ora": "^8.2.0"
+    "ora": "^8.2.0",
+    "pkg-dir": "^8.0.0",
+    "read-pkg": "^9.0.1"
   },
   "devDependencies": {
     "@babel/core": "^7.26.10",

packages/react-native-node-api-modules/package.json

@@ -6,7 +6,7 @@ import { transformFileSync } from "@babel/core";
 
 import { plugin } from "./plugin.js";
 import { setupTempDirectory } from "../test-utils.js";
-import { getNodeApiRequireCallArgument } from "../path-utils.js";
+import { getLibraryInstallName } from "../path-utils.js";
 
 describe("plugin", () => {
   it("transforms require calls, regardless", (context) => {
@@ -38,10 +38,10 @@ describe("plugin", () => {
       `,
     });
 
-    const ADDON_1_REQUIRE_ARG = getNodeApiRequireCallArgument(
+    const ADDON_1_REQUIRE_ARG = getLibraryInstallName(
       path.join(tempDirectoryPath, "addon-1")
     );
-    const ADDON_2_REQUIRE_ARG = getNodeApiRequireCallArgument(
+    const ADDON_2_REQUIRE_ARG = getLibraryInstallName(
       path.join(tempDirectoryPath, "addon-2")
     );
 

packages/react-native-node-api-modules/src/node/babel-plugin/plugin.test.ts

@@ -4,13 +4,13 @@ import type { PluginObj, NodePath } from "@babel/core";
 import * as t from "@babel/types";
 
 import {
-  getNodeApiRequireCallArgument,
+  getLibraryInstallName,
   isNodeApiModule,
   replaceWithNodeExtension,
 } from "../path-utils";
 
 export function replaceWithRequireNodeAddon(p: NodePath, modulePath: string) {
-  const requireCallArgument = getNodeApiRequireCallArgument(
+  const requireCallArgument = getLibraryInstallName(
     replaceWithNodeExtension(modulePath)
   );
   p.replaceWith(

packages/react-native-node-api-modules/src/node/babel-plugin/plugin.ts

@@ -10,10 +10,14 @@ describe("findPackageDependencyPaths", () => {
     const tempDir = setupTempDirectory(context, {
       "node_modules/lib-a/package.json": JSON.stringify({
         name: "lib-a",
+        main: "index.js",
       }),
+      "node_modules/lib-a/index.js": "",
       "test-package/node_modules/lib-b/package.json": JSON.stringify({
         name: "lib-b",
+        main: "index.js",
       }),
+      "test-package/node_modules/lib-b/index.js": "",
       "test-package/package.json": JSON.stringify({
         name: "test-package",
         dependencies: {
@@ -43,10 +47,50 @@ describe("findXCFrameworkPaths", () => {
       "sub-directory/lib-b.xcframework/react-native-node-api-module": "",
     });
     const result = findXCFrameworkPaths(tempDir);
-    assert.deepEqual(result, [
+    assert.deepEqual(result.sort(), [
       path.join(tempDir, "root.xcframework"),
       path.join(tempDir, "sub-directory/lib-a.xcframework"),
       path.join(tempDir, "sub-directory/lib-b.xcframework"),
     ]);
   });
+
+  it("respects default exclude patterns", (context) => {
+    const tempDir = setupTempDirectory(context, {
+      "root.xcframework/react-native-node-api-module": "",
+      "child-dir/dependency/lib.xcframework/react-native-node-api-module": "",
+      "child-dir/node_modules/dependency/lib.xcframework/react-native-node-api-module":
+        "",
+    });
+    const result = findXCFrameworkPaths(tempDir);
+    assert.deepEqual(result.sort(), [
+      path.join(tempDir, "child-dir/dependency/lib.xcframework"),
+      path.join(tempDir, "root.xcframework"),
+    ]);
+  });
+
+  it("respects explicit exclude patterns", (context) => {
+    const tempDir = setupTempDirectory(context, {
+      "root.xcframework/react-native-node-api-module": "",
+      "child-dir/dependency/lib.xcframework/react-native-node-api-module": "",
+      "child-dir/node_modules/dependency/lib.xcframework/react-native-node-api-module":
+        "",
+    });
+    const result = findXCFrameworkPaths(tempDir, { excludePatterns: [/root/] });
+    assert.deepEqual(result.sort(), [
+      path.join(tempDir, "child-dir/dependency/lib.xcframework"),
+      path.join(tempDir, "child-dir/node_modules/dependency/lib.xcframework"),
+    ]);
+  });
+
+  it("disregards parts futher up in filesystem when excluding", (context) => {
+    const tempDir = setupTempDirectory(context, {
+      "node_modules/root.xcframework/react-native-node-api-module": "",
+      "node_modules/child-dir/node_modules/dependency/lib.xcframework/react-native-node-api-module":
+        "",
+    });
+    const result = findXCFrameworkPaths(path.join(tempDir, "node_modules"));
+    assert.deepEqual(result, [
+      path.join(tempDir, "node_modules/root.xcframework"),
+    ]);
+  });
 });