test: remove npm/sandbox operations from fastify esm test (#6622)

Author: bengl

integration-tests/helpers/index.js

@@ -522,14 +522,26 @@ function checkSpansForServiceName (spans, name) {
   return spans.some((span) => span.some((nestedSpan) => nestedSpan.name === name))
 }
 
+/**
+ * @overload
+ * @param {string} cwd
+ * @param {string} serverFile
+ * @param {string|number} agentPort
+ * @param {Record<string, string|undefined>} [additionalEnvArgs]
+ */
 /**
  * @param {string} cwd
  * @param {string} serverFile
  * @param {string|number} agentPort
  * @param {function} [stdioHandler]
  * @param {Record<string, string|undefined>} [additionalEnvArgs]
  */
-async function spawnPluginIntegrationTestProc (cwd, serverFile, agentPort, stdioHandler, additionalEnvArgs = {}) {
+async function spawnPluginIntegrationTestProc (cwd, serverFile, agentPort, stdioHandler, additionalEnvArgs) {
+  if (typeof stdioHandler !== 'function' && !additionalEnvArgs) {
+    additionalEnvArgs = stdioHandler
+    stdioHandler = undefined
+  }
+  additionalEnvArgs = additionalEnvArgs || {}
   let env = /** @type {Record<string, string|undefined>} */ ({
     NODE_OPTIONS: `--loader=${hookFile}`,
     DD_TRACE_AGENT_PORT: String(agentPort)

packages/datadog-plugin-fastify/test/integration-test/client.spec.js

@@ -2,30 +2,24 @@
 
 const {
   FakeAgent,
-  createSandbox,
   curlAndAssertMessage,
   checkSpansForServiceName,
   spawnPluginIntegrationTestProc
 } = require('../../../../integration-tests/helpers')
-const { withVersions } = require('../../../dd-trace/test/setup/mocha')
+const { withVersions, insertVersionDep } = require('../../../dd-trace/test/setup/mocha')
 const { assert } = require('chai')
+const { join } = require('path')
 
 describe('esm', () => {
   let agent
   let proc
-  let sandbox
+  const env = {
+    NODE_OPTIONS: `--loader=${join(__dirname, '..', '..', '..', '..', 'initialize.mjs')}`
+  }
 
   // skip older versions of fastify due to syntax differences
   withVersions('fastify', 'fastify', '>=3', (version, _, specificVersion) => {
-    before(async function () {
-      this.timeout(60000)
-      sandbox = await createSandbox([`'fastify@${version}'`], false,
-        ['./packages/datadog-plugin-fastify/test/integration-test/*'])
-    })
-
-    after(async () => {
-      await sandbox.remove()
-    })
+    insertVersionDep(__dirname, 'fastify', version)
 
     beforeEach(async () => {
       agent = await new FakeAgent().start()
@@ -37,7 +31,7 @@ describe('esm', () => {
     })
 
     it('is instrumented', async () => {
-      proc = await spawnPluginIntegrationTestProc(sandbox.folder, 'server.mjs', agent.port)
+      proc = await spawnPluginIntegrationTestProc(__dirname, 'server.mjs', agent.port, env)
 
       return curlAndAssertMessage(agent, proc, ({ headers, payload }) => {
         assert.propertyVal(headers, 'host', `127.0.0.1:${agent.port}`)
@@ -47,7 +41,7 @@ describe('esm', () => {
     }).timeout(20000)
 
     it('* import fastify is instrumented', async () => {
-      proc = await spawnPluginIntegrationTestProc(sandbox.folder, 'server1.mjs', agent.port)
+      proc = await spawnPluginIntegrationTestProc(__dirname, 'server1.mjs', agent.port, env)
 
       return curlAndAssertMessage(agent, proc, ({ headers, payload }) => {
         assert.propertyVal(headers, 'host', `127.0.0.1:${agent.port}`)
@@ -57,7 +51,7 @@ describe('esm', () => {
     }).timeout(20000)
 
     it('Fastify import fastify is instrumented', async () => {
-      proc = await spawnPluginIntegrationTestProc(sandbox.folder, 'server2.mjs', agent.port)
+      proc = await spawnPluginIntegrationTestProc(__dirname, 'server2.mjs', agent.port, env)
 
       return curlAndAssertMessage(agent, proc, ({ headers, payload }) => {
         assert.propertyVal(headers, 'host', `127.0.0.1:${agent.port}`)

packages/datadog-plugin-fastify/test/integration-test/server.mjs

@@ -1,4 +1,3 @@
-import 'dd-trace/init.js'
 import fastify from 'fastify'
 import { createAndStartServer } from './helper.mjs'
 

packages/datadog-plugin-fastify/test/integration-test/server1.mjs

@@ -1,4 +1,3 @@
-import 'dd-trace/init.js'
 import * as Fastify from 'fastify'
 import { createAndStartServer } from './helper.mjs'
 

packages/datadog-plugin-fastify/test/integration-test/server2.mjs

@@ -1,4 +1,3 @@
-import 'dd-trace/init.js'
 import Fastify from 'fastify'
 import { createAndStartServer } from './helper.mjs'
 

packages/dd-trace/test/setup/mocha.js

@@ -4,6 +4,7 @@ const assert = require('node:assert')
 const util = require('node:util')
 const { platform } = require('node:os')
 const path = require('node:path')
+const fs = require('node:fs')
 
 const { expect } = require('chai')
 const { describe, it, beforeEach, afterEach, before, after } = require('mocha')
@@ -25,6 +26,7 @@ exports.withVersions = withVersions
 exports.withExports = withExports
 exports.withNamingSchema = withNamingSchema
 exports.withPeerService = withPeerService
+exports.insertVersionDep = insertVersionDep
 
 const testedPlugins = agent.testedPlugins
 
@@ -321,6 +323,30 @@ function getModulePath (moduleName, version) {
   return `../../../../versions/${moduleName}@${version}`
 }
 
+/**
+ * Sets up a symlink to the tested version of a package in the given directory,
+ * and tears it down once tests are done.
+ *
+ * @param {string} dir - The directory to operate in. Typically __dirname.
+ * @param {string} pkgName - The name of the package being tested.
+ * @param {string} version - The "version" string, as used with `withVersions`
+ */
+function insertVersionDep (dir, pkgName, version) {
+  const nmDir = path.join(dir, 'node_modules')
+  const pkgDir = path.join(nmDir, pkgName)
+
+  before(() => {
+    const pkgPath = path.dirname(require(getModulePath(pkgName, version)).pkgJsonPath())
+    fs.mkdirSync(nmDir)
+    fs.symlinkSync(pkgPath, pkgDir)
+  })
+
+  after(() => {
+    fs.unlinkSync(pkgDir)
+    fs.rmdirSync(nmDir)
+  })
+}
+
 exports.mochaHooks = {
   afterEach () {
     agent.reset()