import-in-the-middle 1.9.1 → 1.10.0

package/.release-please-manifest.json

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

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # 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)
 
 

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,19 +210,24 @@ async function processModule ({ srcUrl, context, parentGetSource, parentResolve,
     if (isStarExportLine(n) === true) {
       const [, modFile] = n.split('* from ')
 
-      async function processSubModule (url, ctx) {
-        const setters = await processModule({ srcUrl: url, context: ctx, parentGetSource, parentResolve, excludeDefault: true })
-        for (const [name, setter] of setters.entries()) {
-          addSetter(name, setter, true)
-        }
-      }
-
-      if (isBareSpecifier(modFile)) {
-        // Bare specifiers need to be resolved relative to the parent module.
-        const result = await parentResolve(modFile, { parentURL: srcUrl })
-        await processSubModule(result.url, { ...context, format: result.format })
-      } else {
-        await processSubModule(new URL(modFile, srcUrl).href, 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 subSetters.entries()) {
+        addSetter(name, setter, true)
       }
     } else {
       addSetter(n, `
@@ -248,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')
     }
   }
 
@@ -278,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
     }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "import-in-the-middle",
-  "version": "1.9.1",
+  "version": "1.10.0",
   "description": "Intercept imports in Node.js",
   "main": "index.js",
   "scripts": {

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

@@ -1,5 +1,8 @@
-// https://github.com/nodejs/import-in-the-middle/issues/139
 import { strictEqual } from 'assert'
-import * as lib from 'vue/server-renderer'
+// 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 lib.renderToString, 'function')
+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)