switch to bun for integration tests using the sandbox (#6693)

rochdev · web-flow · commit c44d8e5e62d8 · 2025-10-24T11:57:53.000-04:00
diff --git a/.github/actions/install/action.yml b/.github/actions/install/action.yml
@@ -19,8 +19,10 @@ runs:
       if: inputs.cache == 'true' && steps.yarn-cache.outputs.cache-hit == 'true'
       # Retry in case of server error from registry.
       # Wait 60 seconds to give the registry server time to heal.
-    - run: yarn install --frozen-lockfile --ignore-engines || sleep 60 && yarn install --frozen-lockfile --ignore-engines
+    - run: bun install --linker=hoisted --trust || sleep 60 && bun install --linker=hoisted --trust
       shell: bash
+      env:
+        _DD_IGNORE_ENGINES: 'true'
     - run: tar -cf node_modules.tar node_modules
       shell: bash
       if: inputs.cache == 'true' && steps.yarn-cache.outputs.cache-hit != 'true'
diff --git a/.github/actions/node/action.yml b/.github/actions/node/action.yml
@@ -19,3 +19,6 @@ runs:
           inputs.version }}
         check-latest: true
         registry-url: ${{ inputs.registry-url || 'https://registry.npmjs.org' }}
+    - uses: oven-sh/setup-bun@735343b667d3e6f658f44d0eca948eb6282f2b76 # v2.0.2
+      with:
+        bun-version: "1.2.23"
diff --git a/.github/workflows/aiguard.yml b/.github/workflows/aiguard.yml
@@ -68,10 +68,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
-      - uses: ./.github/actions/install
       - uses: ./.github/actions/node
         with:
           version: ${{ matrix.version }}
+      - uses: ./.github/actions/install
       - run: yarn test:integration:aiguard
       - uses: DataDog/junit-upload-github-action@762867566348d59ac9bcf479ebb4ec040db8940a  # v2.0.0
         if: always()
diff --git a/.github/workflows/apm-integrations.yml b/.github/workflows/apm-integrations.yml
@@ -241,9 +241,9 @@ jobs:
     steps:
       - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
       - uses: ./.github/actions/testagent/start
-      - uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6.0.0
+      - uses: ./.github/actions/node
         with:
-          node-version: ${{ matrix.node-version }}
+          version: ${{ matrix.node-version }}
       - uses: ./.github/actions/install
       - run: yarn test:plugins:ci
       - if: always()
diff --git a/.github/workflows/appsec.yml b/.github/workflows/appsec.yml
@@ -352,10 +352,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
-      - uses: ./.github/actions/install
       - uses: ./.github/actions/node
         with:
           version: ${{ matrix.version }}
+      - uses: ./.github/actions/install
       - run: yarn test:integration:appsec
       - uses: DataDog/junit-upload-github-action@762867566348d59ac9bcf479ebb4ec040db8940a  # v2.0.0
         if: always()
diff --git a/.github/workflows/platform.yml b/.github/workflows/platform.yml
@@ -24,6 +24,17 @@ env:
 # TODO: upstream jobs
 
 jobs:
+  bun-pack:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - uses: ./.github/actions/node/active-lts
+      - uses: ./.github/actions/install
+      - run: mkdir npm bun
+      - run: FILENAME=$(npm pack) && tar -zxf $FILENAME -C npm
+      - run: ./node_modules/.bin/bun pm pack --gzip-level 0 --filename bun.tgz && tar -zxf bun.tgz -C bun
+      - run: diff -r npm bun
+
   core:
     runs-on: ubuntu-latest
     steps:
@@ -402,9 +413,8 @@ jobs:
         with:
           version: ${{ matrix.version }}
       - uses: ./.github/actions/install
-      - run: yarn add --ignore-scripts mocha@10 # Use older mocha to support old Node.js versions
-      - run: yarn add --ignore-scripts express@4 # Use older express to support old Node.js versions
-      - run: npm i -g npm@8 # Recent enough to support `--pack-destination` and old enough for old Node.js versions
+      - run: bun add --linker=hoisted --ignore-scripts mocha@10 # Use older mocha to support old Node.js versions
+      - run: bun add --linker=hoisted --ignore-scripts express@4 # Use older express to support old Node.js versions
       - run: node node_modules/.bin/mocha --colors --timeout 30000 integration-tests/init.spec.js
       - uses: DataDog/junit-upload-github-action@762867566348d59ac9bcf479ebb4ec040db8940a  # v2.0.0
         if: always()
diff --git a/.github/workflows/test-optimization.yml b/.github/workflows/test-optimization.yml
@@ -57,7 +57,7 @@ jobs:
     name: integration-playwright (${{ matrix.playwright-version}}, node-${{ matrix.node-version }})
     runs-on: ubuntu-latest
     container:
-      image: rochdev/playwright-tools@sha256:4903e8078c956b04d3190973732de99eea4e0fd5074188e007c8f6c7af066504 # 1.54.1-2
+      image: rochdev/playwright-tools@sha256:99a8e8df71996aa7797f83e98df50bc550c7c6eaf0b701f19fa4f928f2cf93b2 # 1.54.1-3
     env:
       DD_SERVICE: dd-trace-js-integration-tests
       DD_CIVISIBILITY_AGENTLESS_ENABLED: 1
diff --git a/.gitignore b/.gitignore
@@ -107,7 +107,10 @@ typings/
 # End of https://www.gitignore.io/api/node,macos,visualstudiocode
 
 /versions
+.bun
 .next
+bun.lock
+bun.lockb
 package-lock.json
 out
 build
diff --git a/LICENSE-3rdparty.csv b/LICENSE-3rdparty.csv
@@ -50,6 +50,7 @@ dev,@stylistic/eslint-plugin,MIT,Copyright OpenJS Foundation and other contribut
 dev,axios,MIT,Copyright 2014-present Matt Zabriskie
 dev,benchmark,MIT,Copyright 2010-2016 Mathias Bynens Robert Kieffer John-David Dalton
 dev,body-parser,MIT,Copyright 2014 Jonathan Ong 2014-2015 Douglas Christopher Wilson
+dev,bun,MIT,Copyright contributors
 dev,chai,MIT,Copyright 2017 Chai.js Assertion Library
 dev,eslint,MIT,Copyright JS Foundation and other contributors https://js.foundation
 dev,eslint-plugin-cypress,MIT,Copyright (c) 2019 Cypress.io
diff --git a/integration-tests/helpers/bun.js b/integration-tests/helpers/bun.js
@@ -0,0 +1,13 @@
+'use strict'
+
+const { join, resolve } = require('path')
+
+const PROJECT_ROOT = resolve(__dirname, '..', '..')
+const BUN_INSTALL = join(PROJECT_ROOT, '.bun')
+const BUN = join(PROJECT_ROOT, 'node_modules', '.bin', 'bun')
+
+function withBun (env = process.env) {
+  return { ...env, BUN_INSTALL, _DD_IGNORE_ENGINES: true }
+}
+
+module.exports = { BUN, withBun }
diff --git a/integration-tests/helpers/index.js b/integration-tests/helpers/index.js
@@ -11,9 +11,10 @@ const path = require('path')
 const assert = require('assert')
 const FakeAgent = require('./fake-agent')
 const id = require('../../packages/dd-trace/src/id')
-const { version } = require('../../package.json')
 const { getCappedRange } = require('../../packages/dd-trace/test/plugins/versions')
+const { BUN, withBun } = require('./bun')
 
+const sandboxRoot = path.join(os.tmpdir(), id().toString())
 const hookFile = 'dd-trace/loader-hook.mjs'
 
 // This is set by the setShouldKill function
@@ -220,7 +221,7 @@ function execHelper (command, options) {
     console.log('Exec SUCCESS: ', command)
   } catch (error) {
     console.error('Exec ERROR: ', command, error)
-    if (command.startsWith('yarn')) {
+    if (command.startsWith('bun')) {
       try {
         console.log('Exec RETRY START: ', command)
         execSync(command, options)
@@ -260,7 +261,7 @@ async function createSandbox (
   })
 
   // We might use NODE_OPTIONS to init the tracer. We don't want this to affect this operations
-  const { NODE_OPTIONS, ...restOfEnv } = process.env
+  const { NODE_OPTIONS, ...restOfEnv } = withBun(process.env)
   const noSandbox = String(process.env.TESTING_NO_INTEGRATION_SANDBOX)
   if (noSandbox === '1' || noSandbox.toLowerCase() === 'true') {
     // Execute integration tests without a sandbox. This is useful when you have other components
@@ -272,17 +273,22 @@ async function createSandbox (
     // ... run the tests in the current directory.
     return { folder: path.join(process.cwd(), 'integration-tests'), remove: async () => {} }
   }
-  const folder = path.join(os.tmpdir(), id().toString())
-  const out = path.join(folder, `dd-trace-${version}.tgz`)
-  const allDependencies = [`file:${out}`].concat(cappedDependencies)
+  const folder = path.join(sandboxRoot, id().toString())
+  const out = path.join(sandboxRoot, 'dd-trace.tgz')
+  const deps = cappedDependencies.concat(`file:${out}`)
 
-  await fs.mkdir(folder)
-  const preferOfflineFlag = process.env.OFFLINE === '1' || process.env.OFFLINE === 'true' ? ' --prefer-offline' : ''
-  const addCommand = `yarn add ${allDependencies.join(' ')} --ignore-engines${preferOfflineFlag}`
+  await fs.mkdir(folder, { recursive: true })
   const addOptions = { cwd: folder, env: restOfEnv }
-  execHelper(`npm pack --silent --pack-destination ${folder}`, { env: restOfEnv }) // TODO: cache this
+  const addFlags = ['--linker=hoisted', '--trust']
+  if (!existsSync(out)) {
+    execHelper(`${BUN} pm pack --quiet --gzip-level 0 --filename ${out}`, { env: restOfEnv })
+  }
+
+  if (process.env.OFFLINE === '1' || process.env.OFFLINE === 'true') {
+    addFlags.push('--prefer-offline')
+  }
 
-  execHelper(addCommand, addOptions)
+  execHelper(`${BUN} add ${deps.join(' ')} ${addFlags.join(' ')}`, addOptions)
 
   for (const path of integrationTestsPaths) {
     if (process.platform === 'win32') {
diff --git a/package.json b/package.json
@@ -186,6 +186,7 @@
     "axios": "^1.12.2",
     "benchmark": "^2.1.4",
     "body-parser": "^2.2.0",
+    "bun": "1.2.23",
     "chai": "^4.5.0",
     "eslint": "^9.29.0",
     "eslint-plugin-cypress": "^5.1.0",
diff --git a/scripts/preinstall.js b/scripts/preinstall.js
@@ -17,7 +17,9 @@ const nodeMajor = Number(process.versions.node.split('.')[0])
 
 const min = Number(requirePackageJson(path.join(__dirname, '..')).engines.node.match(/\d+/)[0])
 
-const hasIgnoreEngines = npmArgv &&
+// Most package managers don't support `npm_config_argv`, so we need a custom
+// flag to allow installing dd-trace on unsupported engines.
+const hasIgnoreEngines = process.env._DD_IGNORE_ENGINES === 'true' || npmArgv &&
   npmArgv.original &&
   npmArgv.original.includes('--ignore-engines')
 
diff --git a/yarn.lock b/yarn.lock
