Added flush interval option as env variable and use it for ESM tests (#6723)

* Added flush interval option as env variable and use it for ESM tests

* added missing env into spawnPlugin function

* Defaulted resolveAtFirstSuccess to 1

* Reinstated flushInterval for prisma and azure ESM tests

* Changed to use spread operator

Author: pabloerhard

integration-tests/helpers/fake-agent.js

@@ -123,7 +123,7 @@ module.exports = class FakeAgent extends EventEmitter {
   // where multiple payloads are generated, and only one is expected to have the proper span (ie next.request),
   // but it't not guaranteed to be the last one (so, expectedMessageCount would not be helpful).
   // It can still fail if it takes longer than `timeout` duration or if none pass the assertions (timeout still called)
-  assertMessageReceived (fn, timeout, expectedMessageCount = 1, resolveAtFirstSuccess) {
+  assertMessageReceived (fn, timeout, expectedMessageCount = 1, resolveAtFirstSuccess = true) {
     timeout = timeout || 30000
     let resultResolve
     let resultReject

integration-tests/helpers/index.js

@@ -544,7 +544,8 @@ async function spawnPluginIntegrationTestProc (cwd, serverFile, agentPort, stdio
   additionalEnvArgs = additionalEnvArgs || {}
   let env = /** @type {Record<string, string|undefined>} */ ({
     NODE_OPTIONS: `--loader=${hookFile}`,
-    DD_TRACE_AGENT_PORT: String(agentPort)
+    DD_TRACE_AGENT_PORT: String(agentPort),
+    DD_TRACE_FLUSH_INTERVAL: '0'
   })
   env = { ...process.env, ...env, ...additionalEnvArgs }
   return spawnProc(path.join(cwd, serverFile), {

packages/datadog-plugin-azure-event-hubs/test/integration-test/client.spec.js

@@ -9,6 +9,8 @@ const {
 const { withVersions } = require('../../../dd-trace/test/setup/mocha')
 const { assert, expect } = require('chai')
 
+const spawnEnv = { DD_TRACE_FLUSH_INTERVAL: '2000' }
+
 describe('esm', () => {
   let agent
   let proc
@@ -42,7 +44,7 @@ describe('esm', () => {
         assert.strictEqual(checkSpansForServiceName(payload, 'azure.eventhubs.send'), true)
       })
 
-      proc = await spawnPluginIntegrationTestProc(sandbox.folder, 'server.mjs', agent.port)
+      proc = await spawnPluginIntegrationTestProc(sandbox.folder, 'server.mjs', agent.port, spawnEnv)
       await res
     }).timeout(20000)
 
@@ -86,15 +88,15 @@ describe('esm', () => {
         assert.strictEqual(parseLinks(payload[4][0]).length, 2)
       })
 
-      proc = await spawnPluginIntegrationTestProc(sandbox.folder, 'server.mjs', agent.port)
+      proc = await spawnPluginIntegrationTestProc(sandbox.folder, 'server.mjs', agent.port, spawnEnv)
       await res
     }).timeout(60000)
 
     it('does not add span links when they are disabled', async () => {
       const res = agent.assertMessageReceived(({ headers, payload }) => {
         expect(payload[2][0]).to.not.have.property('_dd.span_links')
       })
-      const envVar = { DD_TRACE_AZURE_EVENTHUBS_BATCH_LINKS_ENABLED: false }
+      const envVar = { DD_TRACE_AZURE_EVENTHUBS_BATCH_LINKS_ENABLED: false, ...spawnEnv }
       proc = await spawnPluginIntegrationTestProc(sandbox.folder, 'server.mjs', agent.port, undefined, envVar)
       await res
     }).timeout(60000)

packages/datadog-plugin-azure-service-bus/test/integration-test/client.spec.js

@@ -8,6 +8,8 @@ const {
 const { withVersions } = require('../../../dd-trace/test/setup/mocha')
 const { assert } = require('chai')
 
+const spawnEnv = { DD_TRACE_FLUSH_INTERVAL: '2000' }
+
 describe('esm', () => {
   let agent
   let proc
@@ -40,7 +42,7 @@ describe('esm', () => {
         assert.isArray(payload)
       })
 
-      proc = await spawnPluginIntegrationTestProc(sandbox.folder, 'server.mjs', agent.port)
+      proc = await spawnPluginIntegrationTestProc(sandbox.folder, 'server.mjs', agent.port, spawnEnv)
 
       await res
     }).timeout(20000)
@@ -151,7 +153,7 @@ describe('esm', () => {
         assert.strictEqual(parseLinks(payload[22][0]).length, 2)
       })
 
-      proc = await spawnPluginIntegrationTestProc(sandbox.folder, 'server.mjs', agent.port)
+      proc = await spawnPluginIntegrationTestProc(sandbox.folder, 'server.mjs', agent.port, spawnEnv)
 
       await res
     }).timeout(60000)

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

@@ -72,7 +72,9 @@ describe('esm', () => {
       // TODO: Integrate the assertions into the spawn command by adding a
       // callback. It should end the process when the assertions are met. That
       // way we can remove the Promise.all and the procPromise.then().
-      const procPromise = spawnPluginIntegrationTestProc(sandbox.folder, 'server.mjs', agent.port)
+      const procPromise = spawnPluginIntegrationTestProc(sandbox.folder, 'server.mjs', agent.port, {
+        DD_TRACE_FLUSH_INTERVAL: '2000'
+      })
 
       await Promise.all([
         procPromise.then((res) => {

packages/dd-trace/src/config.js

@@ -602,6 +602,7 @@ class Config {
       DD_TRACE_MIDDLEWARE_TRACING_ENABLED,
       DD_TRACE_OBFUSCATION_QUERY_STRING_REGEXP,
       DD_TRACE_PARTIAL_FLUSH_MIN_SPANS,
+      DD_TRACE_FLUSH_INTERVAL,
       DD_TRACE_PEER_SERVICE_MAPPING,
       DD_TRACE_PROPAGATION_EXTRACT_FIRST,
       DD_TRACE_PROPAGATION_BEHAVIOR_EXTRACT,
@@ -758,7 +759,7 @@ class Config {
     this.#envUnprocessed['experimental.aiguard.timeout'] = DD_AI_GUARD_TIMEOUT
     this.#setBoolean(env, 'experimental.enableGetRumData', DD_TRACE_EXPERIMENTAL_GET_RUM_DATA_ENABLED)
     this.#setString(env, 'experimental.exporter', DD_TRACE_EXPERIMENTAL_EXPORTER)
-    if (AWS_LAMBDA_FUNCTION_NAME) env.flushInterval = 0
+    env.flushInterval = AWS_LAMBDA_FUNCTION_NAME ? 0 : maybeInt(DD_TRACE_FLUSH_INTERVAL)
     env.flushMinSpans = maybeInt(DD_TRACE_PARTIAL_FLUSH_MIN_SPANS)
     this.#envUnprocessed.flushMinSpans = DD_TRACE_PARTIAL_FLUSH_MIN_SPANS
     this.#setBoolean(env, 'gitMetadataEnabled', DD_TRACE_GIT_METADATA_ENABLED)

packages/dd-trace/src/supported-configurations.json

@@ -282,6 +282,7 @@
     "DD_TRACE_FASTIFY_ENABLED": ["A"],
     "DD_TRACE_FETCH_ENABLED": ["A"],
     "DD_TRACE_FIND_MY_WAY_ENABLED": ["A"],
+    "DD_TRACE_FLUSH_INTERVAL": ["A"],
     "DD_TRACE_FS_ENABLED": ["A"],
     "DD_TRACE_GENERIC_POOL_ENABLED": ["A"],
     "DD_TRACE_GIT_METADATA_ENABLED": ["A"],

packages/dd-trace/test/config.spec.js

@@ -1503,6 +1503,7 @@ describe('Config', () => {
     process.env.DD_TRACE_GLOBAL_TAGS = 'foo:bar,baz:qux'
     process.env.DD_TRACE_MIDDLEWARE_TRACING_ENABLED = 'false'
     process.env.DD_TRACE_PARTIAL_FLUSH_MIN_SPANS = '2000'
+    process.env.DD_TRACE_FLUSH_INTERVAL = '2000'
     process.env.DD_TRACE_PEER_SERVICE_DEFAULTS_ENABLED = 'false'
     process.env.DD_TRACE_PEER_SERVICE_MAPPING = 'c:cc'
     process.env.DD_TRACE_PROPAGATION_BEHAVIOR_EXTRACT = 'restart'
@@ -1583,6 +1584,7 @@ describe('Config', () => {
         enableGetRumData: false
       },
       flushMinSpans: 500,
+      flushInterval: 500,
       hostname: 'server',
       iast: {
         dbRowsToTaint: 3,
@@ -1673,6 +1675,7 @@ describe('Config', () => {
     expect(config).to.have.nested.property('experimental.enableGetRumData', false)
     expect(config).to.have.nested.property('experimental.exporter', 'agent')
     expect(config).to.have.property('flushMinSpans', 500)
+    expect(config).to.have.property('flushInterval', 500)
     expect(config).to.have.nested.property('iast.dbRowsToTaint', 3)
     expect(config).to.have.nested.property('iast.deduplicationEnabled', true)
     expect(config).to.have.nested.property('iast.enabled', true)