import-in-the-middle 1.13.2 → 1.14.1

package/.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "1.13.2"
+  ".": "1.14.1"
 }

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [1.14.1](https://github.com/nodejs/import-in-the-middle/compare/import-in-the-middle-v1.14.0...import-in-the-middle-v1.14.1) (2025-06-12)
+
+
+### Bug Fixes
+
+* Account for invalid identifiers ([#198](https://github.com/nodejs/import-in-the-middle/issues/198)) ([2cc8207](https://github.com/nodejs/import-in-the-middle/commit/2cc82070a5ca947463b70f28647b03496a9526f0))
+
+## [1.14.0](https://github.com/nodejs/import-in-the-middle/compare/import-in-the-middle-v1.13.2...import-in-the-middle-v1.14.0) (2025-05-24)
+
+
+### Features
+
+* Optionally hook internal paths like `require-in-the-middle` ([#194](https://github.com/nodejs/import-in-the-middle/issues/194)) ([976d032](https://github.com/nodejs/import-in-the-middle/commit/976d0320426dcbf8e6260504eccbb62d83513f5a))
+
 ## [1.13.2](https://github.com/nodejs/import-in-the-middle/compare/import-in-the-middle-v1.13.1...import-in-the-middle-v1.13.2) (2025-05-12)
 
 

package/README.md

@@ -109,6 +109,23 @@ fs.readFileSync('file.txt')
 node --import=./instrument.mjs ./my-app.mjs
 ```
 
+### Experimental `experimentalPatchInternals` option
+
+It was found that `import-in-the-middle` didn't match the hooking behavior of `require-in-the-middle` in some cases: 
+https://github.com/nodejs/import-in-the-middle/issues/185
+
+The `experimentalPatchInternals` option forces the loader to match the behavior of `require-in-the-middle` in these cases.
+
+This option is experimental and may be removed or made the default in the future.
+
+```js
+import { register } from 'module'
+
+register('import-in-the-middle/hook.mjs', import.meta.url, {
+  data: { experimentalPatchInternals: true }
+})
+```
+
 ## Limitations
 
 * You cannot add new exports to a module. You can only modify existing ones.

package/hook.js

@@ -7,6 +7,7 @@ const { inspect } = require('util')
 const { builtinModules } = require('module')
 const specifiers = new Map()
 const isWin = process.platform === 'win32'
+let experimentalPatchInternals = false
 
 // FIXME: Typescript extensions are added temporarily until we find a better
 // way of supporting arbitrary extensions
@@ -253,19 +254,23 @@ async function processModule ({ srcUrl, context, parentGetSource, parentResolve,
         addSetter(name, setter, true)
       }
     } else {
+      const variableName = `$${n.replace(/[^a-zA-Z0-9_]/g, '_')}`
+      const objectKey = JSON.stringify(n)
+      const reExportedName = n === 'default' || NODE_MAJOR < 16 ? n : objectKey
+
       addSetter(n, `
-      let $${n}
+      let ${variableName}
       try {
-        $${n} = _.${n} = namespace.${n}
+        ${variableName} = _[${objectKey}] = namespace[${objectKey}]
       } catch (err) {
         if (!(err instanceof ReferenceError)) throw err
       }
-      export { $${n} as ${n} }
-      set.${n} = (v) => {
-        $${n} = v
+      export { ${variableName} as ${reExportedName} }
+      set[${objectKey}] = (v) => {
+        ${variableName} = v
         return true
       }
-      get.${n} = () => $${n}
+      get[${objectKey}] = () => ${variableName}
       `)
     }
   }
@@ -292,6 +297,10 @@ function createHook (meta) {
     global.__import_in_the_middle_initialized__ = true
 
     if (data) {
+      if (data.experimentalPatchInternals) {
+        experimentalPatchInternals = true
+      }
+
       includeModules = ensureArrayWithBareSpecifiersFileUrlsAndRegex(data.include, 'include')
       excludeModules = ensureArrayWithBareSpecifiersFileUrlsAndRegex(data.exclude, 'exclude')
 
@@ -410,6 +419,7 @@ function createHook (meta) {
           source: `
 import { register } from '${iitmURL}'
 import * as namespace from ${JSON.stringify(realUrl)}
+${experimentalPatchInternals ? `import { setExperimentalPatchInternals } from '${iitmURL}'\nsetExperimentalPatchInternals(true)` : ''}
 
 // Mimic a Module object (https://tc39.es/ecma262/#sec-module-namespace-objects).
 const _ = Object.create(null, { [Symbol.toStringTag]: { value: 'Module' } })

package/index.js

@@ -10,7 +10,8 @@ const { MessageChannel } = require('worker_threads')
 const {
   importHooks,
   specifiers,
-  toHook
+  toHook,
+  getExperimentalPatchInternals
 } = require('./lib/register')
 
 function addHook (hook) {
@@ -144,7 +145,7 @@ function Hook (modules, options, hookFn) {
             if (internals) {
               name = name + path.sep + path.relative(baseDir, fileURLToPath(filename))
             } else {
-              if (!baseDir.endsWith(specifiers.get(filename))) continue
+              if (!getExperimentalPatchInternals() && !baseDir.endsWith(specifiers.get(filename))) continue
             }
           }
           callHookFn(hookFn, namespace, name, baseDir)

package/lib/register.js

@@ -43,7 +43,19 @@ function register (name, namespace, set, get, specifier) {
   toHook.push([name, proxy])
 }
 
+let experimentalPatchInternals = false
+
+function getExperimentalPatchInternals () {
+  return experimentalPatchInternals
+}
+
+function setExperimentalPatchInternals (value) {
+  experimentalPatchInternals = value
+}
+
 exports.register = register
 exports.importHooks = importHooks
 exports.specifiers = specifiers
 exports.toHook = toHook
+exports.getExperimentalPatchInternals = getExperimentalPatchInternals
+exports.setExperimentalPatchInternals = setExperimentalPatchInternals

package/package.json

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

package/test/fixtures/invalid-identifier.js

@@ -0,0 +1,5 @@
+// These export identifiers are only supported in Node 16+
+exports['one.two'] = () => console.log('b')
+
+// See: https://github.com/nodejs/import-in-the-middle/issues/94
+exports['unsigned short'] = 'something'

package/test/fixtures/module-exports-cjs-shim.mjs

@@ -0,0 +1,7 @@
+// Regression test for https://github.com/nodejs/import-in-the-middle/issues/196
+
+export default function foo () {
+  // do nothing
+}
+
+export { foo as 'module.exports' }

package/test/hook/v16-fake-cjs-export.mjs

@@ -0,0 +1,4 @@
+import ui from '../fixtures/module-exports-cjs-shim.mjs'
+import { notStrictEqual } from 'assert'
+
+notStrictEqual(ui, undefined)

package/test/hook/v16-invalid-identifier.mjs

@@ -0,0 +1,5 @@
+import * as lib from '../fixtures/invalid-identifier.js'
+import { strictEqual } from 'assert'
+
+strictEqual(typeof lib['one.two'], 'function')
+strictEqual(typeof lib['unsigned short'], 'string')

package/test/register/v18.19-experimental-patch-internals.mjs

@@ -0,0 +1,14 @@
+import { register } from 'module'
+import Hook from '../../index.js'
+import { strictEqual } from 'assert'
+
+register('../../hook.mjs', import.meta.url, { data: { experimentalPatchInternals: true } })
+
+Hook(['c8'], (exports, name) => {
+  strictEqual(name, 'c8')
+  exports.Report = () => 42
+})
+
+const { Report } = await import('c8/index.js')
+
+strictEqual(Report({}), 42)