import-in-the-middle 1.2.1 → 1.3.0

package/hook.mjs

@@ -4,36 +4,74 @@
 
 const specifiers = new Map()
 
-const EXTENSION_RE = /\.(js|mjs|cjs)$/
+// FIXME: Typescript extensions are added temporarily until we find a better
+// way of supporting arbitrary extensions
+const EXTENSION_RE = /\.(js|mjs|cjs|ts|mts|cts)$/
+
+const NODE_MAJOR = Number(process.versions.node.split('.')[0])
 
 let entrypoint
 
+function hasIitm (url) {
+  try {
+    return new URL(url).searchParams.has('iitm')
+  } catch {
+    return false
+  }
+}
+
+function deleteIitm (url) {
+  let resultUrl
+  try {
+    const urlObj = new URL(url)
+    if (urlObj.searchParams.has('iitm')) {
+      urlObj.searchParams.delete('iitm')
+      resultUrl = urlObj.href
+      if (resultUrl.startsWith('file:node:')) {
+        resultUrl = resultUrl.replace('file:', '')
+      }
+      if (resultUrl.startsWith('file:///node:')) {
+        resultUrl = resultUrl.replace('file:///', '')
+      }
+    } else {
+      resultUrl = urlObj.href
+    }
+  } catch {
+    resultUrl = url
+  }
+  return resultUrl
+}
+
+function addIitm (url) {
+  const urlObj = new URL(url)
+  urlObj.searchParams.set('iitm', 'true')
+  return urlObj.protocol !== 'file:' && NODE_MAJOR < 18 ? 'file:' + urlObj.href :  urlObj.href
+}
+
 export async function resolve (specifier, context, parentResolve) {
   const { parentURL = '' } = context
 
-  if (specifier.startsWith('file:iitm:')) {
-    specifier = specifier.replace('file:iitm:', '')
-  }
-  const url = await parentResolve(specifier, context, parentResolve)
+  const url = await parentResolve(deleteIitm(specifier), context, parentResolve)
 
   if (parentURL === '' && !EXTENSION_RE.test(url.url)) {
     entrypoint = url.url
     return { url: url.url, format: 'commonjs' }
   }
 
-  if (parentURL === import.meta.url || parentURL.startsWith('file:iitm:')) {
+  if (parentURL === import.meta.url || hasIitm(parentURL)) {
     return url
   }
 
   specifiers.set(url.url, specifier)
 
   return {
-    url: `file:iitm:${url.url}`
+    url: addIitm(url.url),
+    shortCircuit: true
   }
 }
 
 export function getFormat (url, context, parentGetFormat) {
-  if (url.startsWith('file:iitm:')) {
+  if (hasIitm(url)) {
     return {
       format: 'module'
     }
@@ -49,8 +87,8 @@ export function getFormat (url, context, parentGetFormat) {
 
 const iitmURL = new URL('lib/register.js', import.meta.url).toString()
 export async function getSource (url, context, parentGetSource) {
-  if (url.startsWith('file:iitm:')) {
-    const realUrl = url.replace('file:iitm:', '')
+  if (hasIitm(url)) {
+    const realUrl = deleteIitm(url)
     const realModule = await import(realUrl)
     const exportNames = Object.keys(realModule)
     return {
@@ -76,10 +114,11 @@ register('${realUrl}', namespace, set, '${specifiers.get(realUrl)}')
 
 // For Node.js 16.12.0 and higher.
 export async function load (url, context, parentLoad) {
-  if (url.startsWith('file:iitm:')) {
+  if (hasIitm(url)) {
     const { source } = await getSource(url, context)
     return {
       source,
+      shortCircuit: true,
       format: 'module'
     }
   }

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "import-in-the-middle",
-  "version": "1.2.1",
+  "version": "1.3.0",
   "description": "Intercept imports in Node.js",
   "main": "index.js",
   "scripts": {
     "test": "c8 --check-coverage --lines 90 imhotap --runner test/runtest --files test/{hook,low-level,other}/*",
+    "test:ts": "c8 imhotap --runner test/runtest --files test/typescript/*.test.mts",
     "coverage": "c8 --reporter html imhotap --runner test/runtest --files test/{hook,low-level,other}/* && echo '\nNow open coverage/index.html\n'"
   },
   "repository": {
@@ -26,8 +27,11 @@
   },
   "homepage": "https://github.com/DataDog/import-in-the-middle#readme",
   "devDependencies": {
+    "@types/node": "^18.0.6",
     "c8": "^7.8.0",
-    "imhotap": "^2.0.0"
+    "imhotap": "^2.0.0",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.7.4"
   },
   "dependencies": {
     "module-details-from-path": "^1.0.3"

package/test/fixtures/say-hi.mts

@@ -0,0 +1,3 @@
+export const sayHi = (name: string) => {
+  return `Hi ${name}`
+};

package/test/runtest

@@ -15,7 +15,12 @@ const args = [
   ...process.argv.slice(2)
 ]
 if (!filename.includes('disabled')) {
-  args.unshift(`--experimental-loader=${path.join(__dirname, '..', 'hook.mjs')}`)
+  const isTypescript = path.extname(filename).slice(-2) === 'ts'
+  const loaderPath = isTypescript
+    ? path.join(__dirname, 'typescript', 'iitm-ts-node-loader.mjs')
+    : path.join(__dirname, '..', 'hook.mjs')
+
+  args.unshift(`--experimental-loader=${loaderPath}`)
 }
 
 spawn('node', args, { stdio: 'inherit' }).on('close', code => {

package/test/typescript/iitm-ts-node-loader.mjs

@@ -0,0 +1,18 @@
+import * as iitm from '../../hook.mjs'
+import * as tsNode from 'ts-node/esm.mjs'
+
+const makeNext = (loader, fnName, parentResolveOrLoad) => {
+  return (specifierOrUrl, context) => {
+    return loader[fnName](specifierOrUrl, context, parentResolveOrLoad)
+  }
+}
+
+export async function resolve(specifier, context, defaultResolve) {
+  const next = makeNext(tsNode, 'resolve', defaultResolve)
+  return iitm.resolve(specifier, context, next)
+}
+
+export async function load(url, context, defaultLoad) {
+  let next = makeNext(tsNode, 'load', defaultLoad)
+  return iitm.load(url, context, next)
+}

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

@@ -0,0 +1,11 @@
+import assert from 'node:assert/strict'
+import { addHook } from '../../index.js'
+import { sayHi } from '../fixtures/say-hi.mjs'
+
+addHook((url, exported) => {
+  if (url.toLowerCase().endsWith('say-hi.mts')) {
+    exported.sayHi = () => 'Hooked'
+  }
+})
+
+assert.equal(sayHi('test'), 'Hooked')

package/tsconfig.json

@@ -0,0 +1,14 @@
+{
+    "compilerOptions": {
+      "target": "esnext",
+      "module": "esnext",
+      "moduleResolution": "node",
+      "experimentalDecorators": true,
+      "emitDecoratorMetadata": true,
+      "allowSyntheticDefaultImports": true,
+      "noEmit": true
+    },
+    "ts-node": {
+      "esm": true
+    }
+  }