chore: move findNodeAddonForBindings() to path-utils

Author: Mariusz Pasinski

packages/host/src/node/babel-plugin/plugin.test.ts

@@ -4,7 +4,7 @@ import path from "node:path";
 
 import { transformFileSync } from "@babel/core";
 
-import { plugin, findNodeAddonForBindings, type PluginOptions } from "./plugin.js";
+import { plugin } from "./plugin.js";
 import { setupTempDirectory } from "../test-utils.js";
 
 describe("plugin", () => {
@@ -113,31 +113,3 @@ describe("plugin", () => {
     };
   });
 });
-
-describe("findNodeAddonForBindings()", () => {
-  it("should look for addons in common paths", (context) => {
-    // Arrange
-    const expectedPaths = {
-      "addon_1": "addon_1.node",
-      "addon_2": "build/Release/addon_2.node",
-      "addon_3": "build/Debug/addon_3.node",
-      "addon_4": "build/addon_4.node",
-      "addon_5": "out/Release/addon_5.node",
-      "addon_6": "out/Debug/addon_6.node",
-      "addon_7": "Release/addon_7.node",
-      "addon_8": "Debug/addon_8.node",
-    };
-    const tempDirectoryPath = setupTempDirectory(context,
-      Object.fromEntries(
-        Object.values(expectedPaths)
-        .map((p) => [p, "// This is supposed to be a binary file"])
-      )
-    );
-    // Act & Assert
-    Object.entries(expectedPaths).forEach(([name, relPath]) => {
-      const expectedPath = path.join(tempDirectoryPath, relPath);
-      const actualPath = findNodeAddonForBindings(name, tempDirectoryPath);
-      assert.equal(actualPath, expectedPath);
-    });
-  });
-});

packages/host/src/node/babel-plugin/plugin.ts

@@ -4,7 +4,11 @@ import path from "node:path";
 import type { PluginObj, NodePath } from "@babel/core";
 import * as t from "@babel/types";
 
-import { determineModuleContext, isNodeApiModule } from "../path-utils";
+import {
+  determineModuleContext,
+  isNodeApiModule,
+  findNodeAddonForBindings,
+} from "../path-utils";
 
 export type PluginOptions = {
   stripPathSuffix?: boolean;
@@ -50,29 +54,6 @@ function tryResolveModulePath(id: string, from: string): string | undefined {
   }
 }
 
-const nodeBindingsSubdirs = [
-  "./",
-  "./build/Release",
-  "./build/Debug",
-  "./build",
-  "./out/Release",
-  "./out/Debug",
-  "./Release",
-  "./Debug",
-];
-export function findNodeAddonForBindings(id: string, fromDir: string) {
-  const idWithExt = id.endsWith(".node") ? id : `${id}.node`;
-  // Support traversing the filesystem to find the Node-API module.
-  // Currently, we check the most common directories like `bindings` does.
-  for (const subdir of nodeBindingsSubdirs) {
-    const resolvedPath = path.join(fromDir, subdir, idWithExt);
-    if (isNodeApiModule(resolvedPath)) {
-      return resolvedPath;
-    }
-  }
-  return undefined;
-}
-
 export function replaceWithRequireNodeAddon3(
   p: NodePath,
   resolvedPath: string,

packages/host/src/node/path-utils.test.ts

@@ -7,6 +7,7 @@ import fswin from "fswin";
 import {
   determineModuleContext,
   determineNormalizedModuleContext,
+  findNodeAddonForBindings,
   findNodeApiModulePaths,
   findPackageDependencyPaths,
   getLibraryName,
@@ -400,3 +401,31 @@ describe("determineModuleContext", () => {
     assert.equal(readCount, 1);
   });
 });
+
+describe("findNodeAddonForBindings()", () => {
+  it("should look for addons in common paths", (context) => {
+    // Arrange
+    const expectedPaths = {
+      "addon_1": "addon_1.node",
+      "addon_2": "build/Release/addon_2.node",
+      "addon_3": "build/Debug/addon_3.node",
+      "addon_4": "build/addon_4.node",
+      "addon_5": "out/Release/addon_5.node",
+      "addon_6": "out/Debug/addon_6.node",
+      "addon_7": "Release/addon_7.node",
+      "addon_8": "Debug/addon_8.node",
+    };
+    const tempDirectoryPath = setupTempDirectory(context,
+      Object.fromEntries(
+        Object.values(expectedPaths)
+        .map((p) => [p, "// This is supposed to be a binary file"])
+      )
+    );
+    // Act & Assert
+    Object.entries(expectedPaths).forEach(([name, relPath]) => {
+      const expectedPath = path.join(tempDirectoryPath, relPath);
+      const actualPath = findNodeAddonForBindings(name, tempDirectoryPath);
+      assert.equal(actualPath, expectedPath);
+    });
+  });
+});

packages/host/src/node/path-utils.ts

@@ -405,3 +405,29 @@ export function getLatestMtime(fromPath: string): number {
 
   return latest;
 }
+
+// NOTE: List of paths influenced by `node-bindings` itself
+// https://github.com/TooTallNate/node-bindings/blob/v1.3.0/bindings.js#L21
+const nodeBindingsSubdirs = [
+  "./",
+  "./build/Release",
+  "./build/Debug",
+  "./build",
+  "./out/Release",
+  "./out/Debug",
+  "./Release",
+  "./Debug",
+];
+
+export function findNodeAddonForBindings(id: string, fromDir: string) {
+  const idWithExt = id.endsWith(".node") ? id : `${id}.node`;
+  // Support traversing the filesystem to find the Node-API module.
+  // Currently, we check the most common directories like `bindings` does.
+  for (const subdir of nodeBindingsSubdirs) {
+    const resolvedPath = path.join(fromDir, subdir, idWithExt);
+    if (isNodeApiModule(resolvedPath)) {
+      return resolvedPath;
+    }
+  }
+  return undefined;
+}