Fix and improve esbuild and add it to the CI (#5877)

* Test latest versions together with esbuild

* Fix esbuild not picking up all files and test more

This makes sure we run our tests with the oldest and newest esbuild
version as well as adding the tests to our CI. They did not yet
run in the CI before.
It seems like esbuild does not pick up dynamic require calls, so I
changed the ones I could find. This should fix the profiler to also
be included in esbuild outputs in the future.

Author: BridgeAR

.github/workflows/platform.yml

@@ -281,6 +281,7 @@ jobs:
       - uses: ./.github/actions/install
       - run: sudo sysctl -w kernel.core_pattern='|/bin/false'
       - run: yarn test:integration
+      - run: yarn test:integration:esbuild
 
   # We'll run these separately for earlier (i.e. unsupported) versions
   integration-guardrails:

integration-tests/esbuild/index.spec.js

@@ -11,59 +11,69 @@ const fs = require('fs')
 const TEST_DIR = path.join(__dirname, '.')
 process.chdir(TEST_DIR)
 
-describe('esbuild', () => {
-  before(() => {
-    chproc.execSync('npm install', {
-      timeout: 1000 * 30
+// This should switch to our withVersion helper. The order here currently matters.
+const esbuildVersions = ['latest', '0.16.12']
+
+esbuildVersions.forEach((version) => {
+  describe(`esbuild ${version}`, () => {
+    before(() => {
+      chproc.execSync('npm install', {
+        timeout: 1000 * 30
+      })
+      if (version !== 'latest') {
+        chproc.execSync(`npm install esbuild@${version}`, {
+          timeout: 1000 * 30
+        })
+      }
     })
-  })
 
-  it('works', () => {
-    console.log('npm run build')
-    chproc.execSync('npm run build')
+    it('works', () => {
+      console.log('npm run build')
+      chproc.execSync('npm run build')
 
-    console.log('npm run built')
-    try {
-      chproc.execSync('npm run built', {
+      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
       })
-    } 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 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 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
+    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/package.json

@@ -18,13 +18,13 @@
   "author": "Thomas Hunter II <tlhunter@datadog.com>",
   "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",
+    "@apollo/server": "*",
+    "@koa/router": "*",
+    "aws-sdk": "*",
+    "axios": "*",
+    "esbuild": "*",
     "express": "^4.16.2",
-    "knex": "^2.4.2",
-    "koa": "^2.13.4"
+    "knex": "*",
+    "koa": "*"
   }
 }

packages/dd-trace/src/exporters/agent/writer.js

@@ -69,7 +69,9 @@ function setHeader (headers, key, value) {
 }
 
 function getEncoder (protocolVersion) {
-  return require(`../../encode/${protocolVersion === '0.5' ? '0.5' : '0.4'}`).AgentEncoder
+  return protocolVersion === '0.5'
+    ? require('../../encode/0.5').AgentEncoder
+    : require('../../encode/0.4').AgentEncoder
 }
 
 function makeRequest (version, data, count, url, headers, lookup, needsStartupLog, cb) {

packages/dd-trace/src/profiling/profilers/events.js

@@ -291,8 +291,16 @@ class NodeApiEventSource {
 
 class DatadogInstrumentationEventSource {
   constructor (eventHandler, eventFilter) {
-    this.plugins = ['dns_lookup', 'dns_lookupservice', 'dns_resolve', 'dns_reverse', 'fs', 'net'].map(m => {
-      const Plugin = require(`./event_plugins/${m}`)
+    // List all entries explicitly for bundlers to pick up the require calls correctly.
+    const plugins = [
+      require('./event_plugins/dns_lookup'),
+      require('./event_plugins/dns_lookupservice'),
+      require('./event_plugins/dns_resolve'),
+      require('./event_plugins/dns_reverse'),
+      require('./event_plugins/fs'),
+      require('./event_plugins/net')
+    ]
+    this.plugins = plugins.map((Plugin) => {
       return new Plugin(eventHandler, eventFilter)
     })