Fix esbuild not instrumenting namespaced modules (#5588)

* Fix esbuild not instrumenting namespaced modules

As drive-by it simplifies the tests and moved the test to the
dedicated esbuild part.

* Install esbuild dependencies before running tests

That prevents the need to add these dependencies to the root.

Author: BridgeAR

integration-tests/esbuild.spec.js

@@ -1,5 +1,6 @@
 #!/usr/bin/env node
 /* eslint-disable no-console */
+const fs = require('fs')
 const { spawnSync } = require('child_process')
 
 const ddPlugin = require('../../esbuild') // dd-trace/esbuild
@@ -31,5 +32,5 @@ esbuild.build({
   console.error(err)
   process.exit(1)
 }).finally(() => {
-  // fs.rmSync(SCRIPT)
+  fs.rmSync(SCRIPT, { force: true })
 })

integration-tests/esbuild/.gitignore

@@ -0,0 +1,36 @@
+#!/usr/bin/env node
+
+import fs from 'fs/promises'
+
+import * as esbuild from 'esbuild'
+import assert from 'assert'
+
+import ddPlugin from '../../esbuild.js'
+
+try {
+  await esbuild.build({
+    entryPoints: ['./koa.mjs'],
+    bundle: true,
+    outfile: './outfile.js',
+    minify: false,
+    sourcemap: false,
+    platform: 'node',
+    target: 'es2022',
+    plugins: [ddPlugin],
+    external: [
+      'graphql/language/visitor',
+      'graphql/language/printer',
+      'graphql/utilities'
+    ]
+  })
+
+  // Verify instrumentation
+  const data = await fs.readFile('./outfile.js', 'utf8')
+
+  assert.match(data, /^ {8}package: "koa",$/m, 'Bundle should contain the koa instrumentation')
+  assert.match(data, /^ {8}package: "@koa\/router",$/m, 'Bundle should contain the @koa/router instrumentation')
+
+  console.log('ok') // eslint-disable-line no-console
+} finally {
+  await fs.rm('./outfile.js', { force: true })
+}

integration-tests/esbuild/build-and-test-aws-sdk.js

@@ -21,8 +21,9 @@ esbuild.build({
   assert(output.includes('require("knex")'), 'bundle should contain a require call to non-bundled knex')
   assert(!output.includes('require("axios")'), 'bundle should not contain a require call to bundled axios')
   console.log('ok') // eslint-disable-line no-console
-  fs.rmSync('./skip-external-out.js')
 }).catch((err) => {
   console.error(err) // eslint-disable-line no-console
   process.exit(1)
+}).finally(() => {
+  fs.rmSync('./skip-external-out.js', { force: true })
 })

integration-tests/esbuild/build-and-test-koa.mjs

@@ -6,21 +6,23 @@ import * as esbuild from 'esbuild'
 
 import ddPlugin from '../../esbuild.js'
 
-await esbuild.build({
-  entryPoints: ['typescript-app.ts'],
-  bundle: true,
-  outfile: 'typescript-app-out.js',
-  minify: false,
-  sourcemap: false,
-  platform: 'node',
-  target: 'es2022',
-  plugins: [ddPlugin],
-  external: [
-    'graphql/language/visitor',
-    'graphql/language/printer',
-    'graphql/utilities'
-  ]
-})
-
-console.log('ok') // eslint-disable-line no-console
-fs.rmSync('typescript-app-out.js')
+try {
+  await esbuild.build({
+    entryPoints: ['typescript-app.ts'],
+    bundle: true,
+    outfile: 'typescript-app-out.js',
+    minify: false,
+    sourcemap: false,
+    platform: 'node',
+    target: 'es2022',
+    plugins: [ddPlugin],
+    external: [
+      'graphql/language/visitor',
+      'graphql/language/printer',
+      'graphql/utilities'
+    ]
+  })
+  console.log('ok') // eslint-disable-line no-console
+} finally {
+  fs.rmSync('typescript-app-out.js', { force: true })
+}

integration-tests/esbuild/build-and-test-skip-external.js

@@ -0,0 +1,69 @@
+#!/usr/bin/env node
+
+/* eslint-disable no-console */
+
+'use strict'
+
+const chproc = require('child_process')
+const path = require('path')
+const fs = require('fs')
+
+const TEST_DIR = path.join(__dirname, '.')
+process.chdir(TEST_DIR)
+
+describe('esbuild', () => {
+  before(() => {
+    chproc.execSync('npm install', {
+      timeout: 1000 * 30
+    })
+  })
+
+  it('works', () => {
+    console.log('npm run build')
+    chproc.execSync('npm run build')
+
+    console.log('npm run built')
+    try {
+      chproc.execSync('npm run built', {
+        timeout: 1000 * 30
+      })
+    } catch (err) {
+      console.error(err)
+      process.exit(1)
+    } finally {
+      fs.rmSync('./out.js', { force: true })
+    }
+  })
+
+  it('does not bundle modules listed in .external', () => {
+    const command = 'node ./build-and-test-skip-external.js'
+    console.log(command)
+    chproc.execSync(command, {
+      timeout: 1000 * 30
+    })
+  })
+
+  it('handles typescript apps that import without file extensions', () => {
+    const command = 'node ./build-and-test-typescript.mjs'
+    console.log(command)
+    chproc.execSync(command, {
+      timeout: 1000 * 30
+    })
+  })
+
+  it('handles the complex aws-sdk package with dynamic requires', () => {
+    const command = 'node ./build-and-test-aws-sdk.js'
+    console.log(command)
+    chproc.execSync(command, {
+      timeout: 1000 * 30
+    })
+  })
+
+  it('handles scoped node_modules', () => {
+    const command = 'node ./build-and-test-koa.mjs'
+    console.log(command)
+    chproc.execSync(command, {
+      timeout: 1000 * 30
+    })
+  })
+})

integration-tests/esbuild/build-and-test-typescript.mjs

@@ -0,0 +1,14 @@
+import Koa from 'koa'
+import Router from '@koa/router'
+
+const app = new Koa()
+
+const fooRouter = new Router()
+
+fooRouter.get('/foo', (ctx) => {
+  ctx.body = 'foo'
+})
+
+app.use(fooRouter.routes())
+
+app.listen(3000)

integration-tests/esbuild/index.spec.js

@@ -19,10 +19,12 @@
   "license": "ISC",
   "dependencies": {
     "@apollo/server": "^4.11.0",
+    "@koa/router": "^10.0.0",
     "aws-sdk": "^2.1446.0",
     "axios": "^1.6.7",
     "esbuild": "0.16.12",
     "express": "^4.16.2",
-    "knex": "^2.4.2"
+    "knex": "^2.4.2",
+    "koa": "^2.13.4"
   }
 }

integration-tests/esbuild/koa.mjs

@@ -48,6 +48,7 @@
     "test:integration:cucumber": "mocha --timeout 60000 -r \"packages/dd-trace/test/setup/core.js\" \"integration-tests/cucumber/*.spec.js\"",
     "test:integration:cypress": "mocha --timeout 60000 -r \"packages/dd-trace/test/setup/core.js\" \"integration-tests/cypress/*.spec.js\"",
     "test:integration:debugger": "mocha --timeout 60000 -r \"packages/dd-trace/test/setup/core.js\" \"integration-tests/debugger/*.spec.js\"",
+    "test:integration:esbuild": "mocha --timeout 60000 -r \"packages/dd-trace/test/setup/core.js\" \"integration-tests/esbuild/*.spec.js\"",
     "test:integration:jest": "mocha --timeout 60000 -r \"packages/dd-trace/test/setup/core.js\" \"integration-tests/jest/*.spec.js\"",
     "test:integration:mocha": "mocha --timeout 60000 -r \"packages/dd-trace/test/setup/core.js\" \"integration-tests/mocha/*.spec.js\"",
     "test:integration:playwright": "mocha --timeout 60000 -r \"packages/dd-trace/test/setup/core.js\" \"integration-tests/playwright/*.spec.js\"",