import-in-the-middle 1.8.0 → 1.8.1

package/hook.js

@@ -129,15 +129,32 @@ function isBareSpecifier (specifier) {
  */
 async function processModule ({ srcUrl, context, parentGetSource, parentResolve, excludeDefault }) {
   const exportNames = await getExports(srcUrl, context, parentGetSource)
-  const duplicates = new Set()
+  const starExports = new Set()
   const setters = new Map()
 
-  const addSetter = (name, setter) => {
-    // When doing an `import *` duplicates become undefined, so do the same
+  const addSetter = (name, setter, isStarExport = false) => {
     if (setters.has(name)) {
-      duplicates.add(name)
-      setters.delete(name)
-    } else if (!duplicates.has(name)) {
+      if (isStarExport) {
+        // If there's already a matching star export, delete it
+        if (starExports.has(name)) {
+          setters.delete(name)
+        }
+        // and return so this is excluded
+        return
+      }
+
+      // if we already have this export but it is from a * export, overwrite it
+      if (starExports.has(name)) {
+        starExports.delete(name)
+        setters.set(name, setter)
+      }
+    } else {
+      // Store export * exports so we know they can be overridden by explicit
+      // named exports
+      if (isStarExport) {
+        starExports.add(name)
+      }
+
       setters.set(name, setter)
     }
   }
@@ -161,10 +178,11 @@ async function processModule ({ srcUrl, context, parentGetSource, parentResolve,
         srcUrl: modUrl,
         context,
         parentGetSource,
+        parentResolve,
         excludeDefault: true
       })
       for (const [name, setter] of setters.entries()) {
-        addSetter(name, setter)
+        addSetter(name, setter, true)
       }
     } else {
       addSetter(n, `
@@ -246,14 +264,16 @@ function createHook (meta) {
   async function getSource (url, context, parentGetSource) {
     if (hasIitm(url)) {
       const realUrl = deleteIitm(url)
-      const setters = await processModule({
-        srcUrl: realUrl,
-        context,
-        parentGetSource,
-        parentResolve: cachedResolve
-      })
-      return {
-        source: `
+
+      try {
+        const setters = await processModule({
+          srcUrl: realUrl,
+          context,
+          parentGetSource,
+          parentResolve: cachedResolve
+        })
+        return {
+          source: `
 import { register } from '${iitmURL}'
 import * as namespace from ${JSON.stringify(realUrl)}
 
@@ -268,6 +288,25 @@ ${Array.from(setters.values()).join('\n')}
 
 register(${JSON.stringify(realUrl)}, _, set, ${JSON.stringify(specifiers.get(realUrl))})
 `
+        }
+      } catch (cause) {
+        // If there are other ESM loader hooks registered as well as iitm,
+        // depending on the order they are registered, source might not be
+        // JavaScript.
+        //
+        // If we fail to parse a module for exports, we should fall back to the
+        // parent loader. These modules will not be wrapped with proxies and
+        // cannot be Hook'ed but at least this does not take down the entire app
+        // and block iitm from being used.
+        //
+        // We log the error because there might be bugs in iitm and without this
+        // it would be very tricky to debug
+        const err = new Error(`'import-in-the-middle' failed to wrap '${realUrl}'`)
+        err.cause = cause
+        console.warn(err)
+
+        // Revert back to the non-iitm URL
+        url = realUrl
       }
     }
 

package/index.d.ts

@@ -27,7 +27,7 @@ export type Options = {
   internals?: boolean
 }
 
-declare class Hook {
+export declare class Hook {
   /**
    * Creates a hook to be run on any already loaded modules and any that will
    * be loaded in the future. It will be run once per loaded module. If

package/lib/get-esm-exports.js

@@ -29,7 +29,7 @@ function warn (txt) {
  * @param {string} params.moduleSource The source code of the module to parse
  * and interpret.
  *
- * @returns {string[]} The identifiers exported by the module along with any
+ * @returns {Set<string>} The identifiers exported by the module along with any
  * custom directives.
  */
 function getEsmExports (moduleSource) {
@@ -62,7 +62,7 @@ function getEsmExports (moduleSource) {
         warn('unrecognized export type: ' + node.type)
     }
   }
-  return Array.from(exportedNames)
+  return exportedNames
 }
 
 function parseDeclaration (node, exportedNames) {

package/lib/get-exports.js

@@ -1,36 +1,60 @@
 'use strict'
 
 const getEsmExports = require('./get-esm-exports.js')
-const { parse: getCjsExports } = require('cjs-module-lexer')
-const fs = require('fs')
+const { parse: parseCjs } = require('cjs-module-lexer')
+const { readFileSync } = require('fs')
+const { builtinModules } = require('module')
 const { fileURLToPath, pathToFileURL } = require('url')
+const { dirname } = require('path')
 
 function addDefault (arr) {
-  return Array.from(new Set(['default', ...arr]))
+  return new Set(['default', ...arr])
+}
+
+// Cached exports for Node built-in modules
+const BUILT_INS = new Map()
+
+function getExportsForNodeBuiltIn (name) {
+  let exports = BUILT_INS.get()
+
+  if (!exports) {
+    exports = new Set(addDefault(Object.keys(require(name))))
+    BUILT_INS.set(name, exports)
+  }
+
+  return exports
 }
 
 const urlsBeingProcessed = new Set() // Guard against circular imports.
 
-async function getFullCjsExports (url, context, parentLoad, source) {
+async function getCjsExports (url, context, parentLoad, source) {
   if (urlsBeingProcessed.has(url)) {
     return []
   }
   urlsBeingProcessed.add(url)
 
-  const ex = getCjsExports(source)
-  const full = Array.from(new Set([
-    ...addDefault(ex.exports),
-    ...(await Promise.all(ex.reexports.map(re => getExports(
-      (/^(..?($|\/|\\))/).test(re)
-        ? pathToFileURL(require.resolve(fileURLToPath(new URL(re, url)))).toString()
-        : pathToFileURL(require.resolve(re)).toString(),
-      context,
-      parentLoad
-    )))).flat()
-  ]))
-
-  urlsBeingProcessed.delete(url)
-  return full
+  try {
+    const result = parseCjs(source)
+    const full = addDefault(result.exports)
+
+    await Promise.all(result.reexports.map(async re => {
+      if (re.startsWith('node:') || builtinModules.includes(re)) {
+        for (const each of getExportsForNodeBuiltIn(re)) {
+          full.add(each)
+        }
+      } else {
+        // Resolve the re-exported module relative to the current module.
+        const newUrl = pathToFileURL(require.resolve(re, { paths: [dirname(fileURLToPath(url))] })).href
+        for (const each of await getExports(newUrl, context, parentLoad)) {
+          full.add(each)
+        }
+      }
+    }))
+
+    return full
+  } finally {
+    urlsBeingProcessed.delete(url)
+  }
 }
 
 /**
@@ -45,7 +69,7 @@ async function getFullCjsExports (url, context, parentLoad, source) {
  * @param {Function} parentLoad Next hook function in the loaders API
  * hook chain.
  *
- * @returns {Promise<string[]>} An array of identifiers exported by the module.
+ * @returns {Promise<Set<string>>} An array of identifiers exported by the module.
  * Please see {@link getEsmExports} for caveats on special identifiers that may
  * be included in the result set.
  */
@@ -57,23 +81,23 @@ async function getExports (url, context, parentLoad) {
   let source = parentCtx.source
   const format = parentCtx.format
 
-  // TODO support non-node/file urls somehow?
-  if (format === 'builtin') {
-    // Builtins don't give us the source property, so we're stuck
-    // just requiring it to get the exports.
-    return addDefault(Object.keys(require(url)))
-  }
-
   if (!source) {
-    // Sometimes source is retrieved by parentLoad, sometimes it isn't.
-    source = fs.readFileSync(fileURLToPath(url), 'utf8')
+    if (format === 'builtin') {
+      // Builtins don't give us the source property, so we're stuck
+      // just requiring it to get the exports.
+      return getExportsForNodeBuiltIn(url)
+    }
+
+    // Sometimes source is retrieved by parentLoad, CommonJs isn't.
+    source = readFileSync(fileURLToPath(url), 'utf8')
   }
 
   if (format === 'module') {
     return getEsmExports(source)
   }
+
   if (format === 'commonjs') {
-    return getFullCjsExports(url, context, parentLoad, source)
+    return getCjsExports(url, context, parentLoad, source)
   }
 
   // At this point our `format` is either undefined or not known by us. Fall
@@ -84,7 +108,7 @@ async function getExports (url, context, parentLoad) {
     // isn't set at first and yet we have an ESM module with no exports.
     // I couldn't construct an example that would do this, so maybe it's
     // impossible?
-    return getFullCjsExports(url, context, parentLoad, source)
+    return getCjsExports(url, context, parentLoad, source)
   }
 }
 

package/package.json

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

package/test/fixtures/duplicate-b.mjs

@@ -1 +1 @@
-export const foo = 'a'
+export const foo = 'b'

package/test/fixtures/duplicate-c.mjs

@@ -0,0 +1 @@
+export const foo = 'c'

package/test/fixtures/duplicate-explicit.mjs

@@ -0,0 +1,5 @@
+export * from './duplicate-a.mjs'
+export * from './duplicate-b.mjs'
+export { foo } from './duplicate-c.mjs'
+export * from './duplicate-a.mjs'
+export * from './duplicate-b.mjs'

package/test/fixtures/json-attributes.mjs

@@ -0,0 +1,5 @@
+import coolFile from './something.json' with { type: 'json' }
+
+export default {
+  data: coolFile.data
+}

package/test/fixtures/re-export-cjs-built-in.js

@@ -0,0 +1 @@
+module.exports = require('util').deprecate

package/test/fixtures/re-export-cjs.js

@@ -0,0 +1 @@
+module.exports = require('some-external-cjs-module').foo

package/test/get-esm-exports/v20-get-esm-exports.js

@@ -15,7 +15,7 @@ fixture.split('\n').forEach(line => {
   if (expectedNames[0] === '') {
     expectedNames.length = 0
   }
-  const names = getEsmExports(mod)
+  const names = Array.from(getEsmExports(mod))
   assert.deepEqual(expectedNames, names)
   console.log(`${mod}\n  ✅ contains exports: ${testStr}`)
 })

package/test/hook/duplicate-exports-explicit.mjs

@@ -0,0 +1,13 @@
+import * as lib from '../fixtures/duplicate-explicit.mjs'
+import { strictEqual } from 'assert'
+import Hook from '../../index.js'
+
+Hook((exports, name) => {
+  if (name.endsWith('duplicate-explicit.mjs')) {
+    strictEqual(exports.foo, 'c')
+    exports.foo += '-wrapped'
+  }
+})
+
+// foo should not be exported because there are duplicate exports
+strictEqual(lib.foo, 'c-wrapped')

package/test/hook/duplicate-exports.mjs

@@ -4,8 +4,8 @@ import Hook from '../../index.js'
 
 Hook((exports, name) => {
   if (name.match(/duplicate\.mjs/)) {
-    // foo should not be exported because there are duplicate exports
-    strictEqual(exports.foo, undefined)
+    // foo should not be exported because there are duplicate * exports
+    strictEqual('foo' in exports, false)
     // default should be exported
     strictEqual(exports.default, 'foo')
   }
@@ -14,6 +14,6 @@ Hook((exports, name) => {
 notEqual(lib, undefined)
 
 // foo should not be exported because there are duplicate exports
-strictEqual(lib.foo, undefined)
+strictEqual('foo' in lib, false)
 // default should be exported
 strictEqual(lib.default, 'foo')

package/test/hook/re-export-cjs.mjs

@@ -0,0 +1,19 @@
+import Hook from '../../index.js'
+import foo from '../fixtures/re-export-cjs-built-in.js'
+import foo2 from '../fixtures/re-export-cjs.js'
+import { strictEqual } from 'assert'
+
+Hook((exports, name) => {
+  if (name.endsWith('fixtures/re-export-cjs-built-in.js')) {
+    strictEqual(typeof exports.default, 'function')
+    exports.default = '1'
+  }
+
+  if (name.endsWith('fixtures/re-export-cjs.js')) {
+    strictEqual(exports.default, 'bar')
+    exports.default = '2'
+  }
+})
+
+strictEqual(foo, '1')
+strictEqual(foo2, '2')

package/test/hook/v18.19-openai.mjs

@@ -8,3 +8,9 @@ Hook((exports, name) => {
 })
 
 console.assert(OpenAI)
+
+const openAI = new OpenAI({
+  apiKey: 'doesnt-matter'
+})
+
+console.assert(openAI)

package/test/hook/v20.10-static-import-attributes.mjs

@@ -0,0 +1,17 @@
+// Unless explicitly stated otherwise all files in this repository are licensed under the Apache 2.0 License.
+//
+// This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2021 Datadog, Inc.
+
+import jsonMjs from '../fixtures/json-attributes.mjs'
+import { strictEqual } from 'assert'
+
+// Acorn does not support import attributes so an error is logged but the import
+// still works!
+//
+// Hook((exports, name) => {
+//   if (name.match(/json\.mjs/)) {
+//     exports.default.data += '-dawg'
+//   }
+// })
+
+strictEqual(jsonMjs.data, 'dog')

package/test/other/v20.10-import-executable.mjs

@@ -0,0 +1,8 @@
+// Unless explicitly stated otherwise all files in this repository are licensed under the Apache 2.0 License.
+//
+// This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2021 Datadog, Inc.
+
+(async () => {
+  const lib = await import('../fixtures/executable')
+  console.assert(lib)
+})()

package/test/typescript/ts-node.test.mts

@@ -1,5 +1,5 @@
 import assert from 'node:assert/strict'
-import { addHook } from '../../index.js'
+import defaultHook, { Hook, addHook } from '../../index.js'
 import { sayHi } from '../fixtures/say-hi.mjs'
 
 addHook((url, exported) => {
@@ -8,4 +8,12 @@ addHook((url, exported) => {
   }
 })
 
-assert.equal(sayHi('test'), 'Hooked')
+new defaultHook((exported: any, name: string, baseDir: string|void)  => {
+
+});
+
+new Hook((exported: any, name: string, baseDir: string|void)  => {
+
+});
+
+assert.equal(sayHi('test'), 'Hooked')

package/test/other/import-executable.mjs

@@ -1,19 +0,0 @@
-// Unless explicitly stated otherwise all files in this repository are licensed under the Apache 2.0 License.
-//
-// This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2021 Datadog, Inc.
-
-import { rejects } from 'assert'
-(async () => {
-  const [processMajor, processMinor] = process.versions.node.split('.').map(Number)
-  const extensionlessSupported = processMajor >= 21 ||
-    (processMajor === 20 && processMinor >= 10) ||
-    (processMajor === 18 && processMinor >= 19)
-  if (extensionlessSupported) {
-    // Files without extension are supported in Node.js ^21, ^20.10.0, and ^18.19.0
-    return
-  }
-  await rejects(() => import('./executable'), {
-    name: 'TypeError',
-    code: 'ERR_UNKNOWN_FILE_EXTENSION'
-  })
-})()