import-in-the-middle 1.9.0 → 1.10.0

package/.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "1.9.0"
+  ".": "1.10.0"
 }

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## [1.10.0](https://github.com/nodejs/import-in-the-middle/compare/import-in-the-middle-v1.9.1...import-in-the-middle-v1.10.0) (2024-07-22)
+
+
+### Features
+
+* Allow regex for `include` and `exclude` options ([#148](https://github.com/nodejs/import-in-the-middle/issues/148)) ([697b0d2](https://github.com/nodejs/import-in-the-middle/commit/697b0d239b9a738f4952bb0f77c521c4a398ac79))
+
+
+### Bug Fixes
+
+* Use correct `format` when resolving exports from relative paths ([#145](https://github.com/nodejs/import-in-the-middle/issues/145)) ([632802f](https://github.com/nodejs/import-in-the-middle/commit/632802f4e7c797215b4e052ffdfa0fbda1780166))
+
+## [1.9.1](https://github.com/nodejs/import-in-the-middle/compare/import-in-the-middle-v1.9.0...import-in-the-middle-v1.9.1) (2024-07-15)
+
+
+### Bug Fixes
+
+* Don't wrap native modules ([#142](https://github.com/nodejs/import-in-the-middle/issues/142)) ([f3278a3](https://github.com/nodejs/import-in-the-middle/commit/f3278a3c76af78fe369b599d5b2bf1d87edf0a7a))
+* Use correct `format` when resolving exports from sub-modules ([#140](https://github.com/nodejs/import-in-the-middle/issues/140)) ([1db08ef](https://github.com/nodejs/import-in-the-middle/commit/1db08ef5f51346c20b4b3c313bf993e9cf1ca7d5))
+
 ## [1.9.0](https://github.com/nodejs/import-in-the-middle/compare/import-in-the-middle-v1.8.1...import-in-the-middle-v1.9.0) (2024-07-08)
 
 

package/README.md

@@ -54,9 +54,9 @@ node --import=./my-loader.mjs ./my-code.mjs
 ```
 
 When registering the loader hook programmatically, it's possible to pass a list
-of modules or file URLs to either exclude or specifically include which modules
-are intercepted. This is useful if a module is not compatible with the loader
-hook. 
+of modules, file URLs or regular expressions to either exclude or specifically
+include which modules are intercepted. This is useful if a module is not
+compatible with the loader hook. 
 ```js
 import * as module from 'module'
 

package/hook.js

@@ -116,7 +116,11 @@ function isBareSpecifier (specifier) {
   }
 }
 
-function isBareSpecifierOrFileUrl (input) {
+function isBareSpecifierFileUrlOrRegex (input) {
+  if (input instanceof RegExp) {
+    return true
+  }
+
   // Relative and absolute paths
   if (
     input.startsWith('.') ||
@@ -134,15 +138,15 @@ function isBareSpecifierOrFileUrl (input) {
   }
 }
 
-function ensureArrayWithBareSpecifiersAndFileUrls (array, type) {
+function ensureArrayWithBareSpecifiersFileUrlsAndRegex (array, type) {
   if (!Array.isArray(array)) {
     return undefined
   }
 
-  const invalid = array.filter(s => !isBareSpecifierOrFileUrl(s))
+  const invalid = array.filter(s => !isBareSpecifierFileUrlOrRegex(s))
 
   if (invalid.length) {
-    throw new Error(`'${type}' option only supports bare specifiers and file URLs. Invalid entries: ${inspect(invalid)}`)
+    throw new Error(`'${type}' option only supports bare specifiers, file URLs or regular expressions. Invalid entries: ${inspect(invalid)}`)
   }
 
   return array
@@ -206,23 +210,23 @@ async function processModule ({ srcUrl, context, parentGetSource, parentResolve,
     if (isStarExportLine(n) === true) {
       const [, modFile] = n.split('* from ')
 
-      let modUrl
-      if (isBareSpecifier(modFile)) {
-        // Bare specifiers need to be resolved relative to the parent module.
-        const result = await parentResolve(modFile, { parentURL: srcUrl })
-        modUrl = result.url
-      } else {
-        modUrl = new URL(modFile, srcUrl).href
-      }
-
-      const setters = await processModule({
-        srcUrl: modUrl,
-        context,
+      // Relative paths need to be resolved relative to the parent module
+      const newSpecifier = isBareSpecifier(modFile) ? modFile : new URL(modFile, srcUrl).href
+      // We need to call `parentResolve` to resolve bare specifiers to a full
+      // URL. We also need to call `parentResolve` for all sub-modules to get
+      // the `format`. We can't rely on the parents `format` to know if this
+      // sub-module is ESM or CJS!
+      const result = await parentResolve(newSpecifier, { parentURL: srcUrl })
+
+      const subSetters = await processModule({
+        srcUrl: result.url,
+        context: { ...context, format: result.format },
         parentGetSource,
         parentResolve,
         excludeDefault: true
       })
-      for (const [name, setter] of setters.entries()) {
+
+      for (const [name, setter] of subSetters.entries()) {
         addSetter(name, setter, true)
       }
     } else {
@@ -253,8 +257,8 @@ function createHook (meta) {
 
   async function initialize (data) {
     if (data) {
-      includeModules = ensureArrayWithBareSpecifiersAndFileUrls(data.include, 'include')
-      excludeModules = ensureArrayWithBareSpecifiersAndFileUrls(data.exclude, 'exclude')
+      includeModules = ensureArrayWithBareSpecifiersFileUrlsAndRegex(data.include, 'include')
+      excludeModules = ensureArrayWithBareSpecifiersFileUrlsAndRegex(data.exclude, 'exclude')
     }
   }
 
@@ -283,13 +287,21 @@ function createHook (meta) {
     // For included/excluded modules, we check the specifier to match libraries
     // that are loaded with bare specifiers from node_modules.
     //
-    // For non-bare specifier imports, we only support matching file URL strings
-    // because using relative paths would be very error prone!
-    if (includeModules && !includeModules.some(lib => lib === specifier || lib === result.url.url)) {
+    // For non-bare specifier imports, we match to the full file URL because
+    // using relative paths would be very error prone!
+    function match (each) {
+      if (each instanceof RegExp) {
+        return each.test(result.url)
+      }
+
+      return each === specifier || each === result.url
+    }
+
+    if (includeModules && !includeModules.some(match)) {
       return result
     }
 
-    if (excludeModules && excludeModules.some(lib => lib === specifier || lib === result.url.url)) {
+    if (excludeModules && excludeModules.some(match)) {
       return result
     }
 
@@ -297,6 +309,11 @@ function createHook (meta) {
       return result
     }
 
+    // We don't want to attempt to wrap native modules
+    if (result.url.endsWith('.node')) {
+      return result
+    }
+
     // Node.js v21 renames importAssertions to importAttributes
     if (
       (context.importAssertions && context.importAssertions.type === 'json') ||

package/lib/get-exports.js

@@ -48,6 +48,11 @@ async function getCjsExports (url, context, parentLoad, source) {
         }
         // Resolve the re-exported module relative to the current module.
         const newUrl = pathToFileURL(require.resolve(re, { paths: [dirname(fileURLToPath(url))] })).href
+
+        if (newUrl.endsWith('.node')) {
+          return
+        }
+
         for (const each of await getExports(newUrl, context, parentLoad)) {
           full.add(each)
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "import-in-the-middle",
-  "version": "1.9.0",
+  "version": "1.10.0",
   "description": "Intercept imports in Node.js",
   "main": "index.js",
   "scripts": {
@@ -37,6 +37,7 @@
     "@babel/core": "^7.23.7",
     "@babel/eslint-parser": "^7.23.3",
     "@babel/plugin-syntax-import-assertions": "^7.23.3",
+    "@node-rs/crc32": "^1.10.3",
     "@react-email/components": "^0.0.19",
     "@types/node": "^18.0.6",
     "c8": "^7.8.0",
@@ -51,7 +52,8 @@
     "imhotap": "^2.1.0",
     "openai": "^4.47.2",
     "ts-node": "^10.9.1",
-    "typescript": "^4.7.4"
+    "typescript": "^4.7.4",
+    "vue": "^3.4.31"
   },
   "dependencies": {
     "acorn": "^8.8.2",

package/test/fixtures/native-modules/darwin-arm64.js

@@ -0,0 +1 @@
+module.exports = require('@node-rs/crc32-darwin-arm64')

package/test/fixtures/native-modules/darwin-x64.js

@@ -0,0 +1 @@
+module.exports = require('@node-rs/crc32-darwin-x64')

package/test/fixtures/native-modules/linux-arm64.js

@@ -0,0 +1 @@
+module.exports = require('@node-rs/crc32-linux-arm64-gnu')

package/test/fixtures/native-modules/linux-x64.js

@@ -0,0 +1 @@
+module.exports = require('@node-rs/crc32-linux-x64-gnu')

package/test/fixtures/native-modules/win32-arm64.js

@@ -0,0 +1 @@
+module.exports = require('@node-rs/crc32-win32-arm64-msvc')

package/test/fixtures/native-modules/win32-x64.js

@@ -0,0 +1 @@
+module.exports = require('@node-rs/crc32-win32-x64-msvc')

package/test/hook/v14-native-modules.mjs

@@ -0,0 +1,10 @@
+import { strictEqual } from 'assert'
+
+// We dynamically import a specific file that imports the
+// native module for this platform and architecture.
+//
+// This way we know the file exists and the native module can
+// be loaded.
+const lib = await import(`../fixtures/native-modules/${process.platform}-${process.arch}.js`)
+
+strictEqual(typeof lib.default.crc32, 'function')

package/test/hook/vue-server-renderer.mjs

@@ -0,0 +1,8 @@
+import { strictEqual } from 'assert'
+// https://github.com/nodejs/import-in-the-middle/issues/139
+import * as libServer from 'vue/server-renderer'
+// https://github.com/nodejs/import-in-the-middle/issues/144
+import * as lib from 'vue'
+
+strictEqual(typeof libServer.renderToString, 'function')
+strictEqual(typeof lib.ref, 'function')

package/test/register/v18.19-exclude-regex.mjs

@@ -0,0 +1,16 @@
+import { register } from 'module'
+import Hook from '../../index.js'
+import { strictEqual } from 'assert'
+
+register('../../hook.mjs', import.meta.url, { data: { exclude: [/openai/] } })
+
+const hooked = new Set()
+
+Hook((_, name) => {
+  hooked.add(name)
+})
+
+await import('openai')
+
+strictEqual(hooked.has('openai'), false)
+strictEqual(hooked.has('fs'), true)