fix: resolve Minicap resource loading in ESM and CommonJS environments

Author: UrielCh

CHANGELOG.md

@@ -1,6 +1,9 @@
 # CHANGELOG
 
-## V5.1.0 (2025-07-01)
+## V5.1.1 (2025-07-03)
+* fix Minicap resource loading issue in nodeJS using npm:import-meta-resolve
+
+## V5.1.0 (2025-07-02)
 * remove some dev depencences from depencences
 * Allow authorization of known public keys in the tcp usb bridge [#540](https://github.com/DeviceFarmer/adbkit/pull/540)
 * Add attach / detach commands [#534](https://github.com/DeviceFarmer/adbkit/pull/534)

package.json

@@ -1,6 +1,6 @@
 {
     "name": "@u4/adbkit",
-    "version": "5.1.0",
+    "version": "5.1.1",
     "description": "A Typescript client for the Android Debug Bridge.",
     "type": "module",
     "keywords": [
@@ -69,6 +69,7 @@
         "commander": "14.0.0",
         "debug": "~4.4.1",
         "get-port": "7.1.0",
+        "import-meta-resolve": "^4.1.0",
         "node-forge": "^1.3.1",
         "promise-duplex": "^8.0.0",
         "promise-readable": "^8.0.1",
@@ -77,7 +78,6 @@
     },
     "devDependencies": {
         "@jest/globals": "^30.0.3",
-        "jest": "^30.0.3",
         "@types/debug": "^4.1.12",
         "@types/jest": "^30.0.0",
         "@types/mocha": "^10.0.10",
@@ -89,6 +89,7 @@
         "@typescript-eslint/parser": "^8.35.1",
         "chai": "~5.2.0",
         "eslint": "^9.30.1",
+        "jest": "^30.0.3",
         "mocha": "~11.7.1",
         "picocolors": "^1.1.1",
         "prettier": "^3.6.2",

src/adb/thirdparty/minicap/Minicap.ts

@@ -8,6 +8,7 @@ import PromiseDuplex from 'promise-duplex';
 import ThirdUtils from "../ThirdUtils.js";
 import Utils from '../../utils.js';
 import Stats from '../../sync/stats.js';
+import { resolve } from 'import-meta-resolve';
 
 /**
  * Application binary interface known CPU
@@ -30,6 +31,23 @@ interface IEmissions {
   error: (error: Error) => void
   disconnect: (cause: string) => void
 }
+// fs.ReadStream | 
+function getResource(path: string): string | null {
+  try {
+    return require.resolve(path);
+  } catch (e) {
+    try {
+      if (e instanceof Error && e.message.includes('require is not defined')) {
+        return resolve(path, import.meta.url);
+        // .pathname;
+        // return new URL(path, import.meta.url).pathname;
+      }
+    } catch (e) {
+      return null;
+    }
+    return null;
+  }
+}
 
 export default class Minicap extends EventEmitter {
   private config: MinicapOptions;
@@ -133,29 +151,28 @@ export default class Minicap extends EventEmitter {
     const sdkLevel = parseInt(props['ro.build.version.sdk']);
     const minicapName = (sdkLevel >= 16) ? 'minicap' : 'minicap-nopie';
 
-    let binFile: string;
-    let soFile = '';
+    let binFile: string | null = null;
+    let soFile: string | null = null;
 
-    try {
-      binFile = require.resolve(`@devicefarmer/minicap-prebuilt/prebuilt/${abi}/bin/${minicapName}`);
-    } catch (e) {
-      throw Error(`minicap not found in @devicefarmer/minicap-prebuilt/prebuilt/${abi}/bin/ please install @devicefarmer/minicap-prebuilt to use minicap ${e}`);
+
+    binFile = getResource(`@devicefarmer/minicap-prebuilt/prebuilt/${abi}/bin/${minicapName}`);
+    if (!binFile)
+      throw Error(`minicap not found in @devicefarmer/minicap-prebuilt/prebuilt/${abi}/bin/ please install @devicefarmer/minicap-prebuilt to use minicap`);
+
+    if (sdkLevel === 32) {
+      soFile = getResource(`@u4/minicap-prebuilt/prebuilt/${abi}/lib/android-${sdkLevel}/minicap.so`);
+    } else {
+      soFile = getResource(`@devicefarmer/minicap-prebuilt/prebuilt/${abi}/lib/android-${sdkLevel}/minicap.so`);
     }
 
-    try {
-      if (sdkLevel === 32) {
-        soFile = require.resolve(`@u4/minicap-prebuilt/prebuilt/${abi}/lib/android-${sdkLevel}/minicap.so`);
-      } else {
-        soFile = require.resolve(`@devicefarmer/minicap-prebuilt/prebuilt/${abi}/lib/android-${sdkLevel}/minicap.so`);
-      }
-    } catch (e) {
-      throw Error(`minicap.so for your device check for @devicefarmer/minicap-prebuilt update that support android-${sdkLevel}, ${soFile} is missing ${e}`);
+    if (!soFile) {
+      throw Error(`minicap.so for your device check for @devicefarmer/minicap-prebuilt update that support android-${sdkLevel}, ${soFile} is missing`);
     }
 
     // only upload minicap binary in tmp filder if file is missing
     try {
       await this.client.stat('/data/local/tmp/minicap');
-      debug(`/data/local/tmp/minicap already presentin ${this.client.serial}`)
+      debug(`/data/local/tmp/minicap already present in ${this.client.serial}`)
     } catch {
       debug(`pushing minicap binary to ${this.client.serial}`)
       const tr = await this.client.push(binFile, '/data/local/tmp/minicap', 0o755);