test(child_process): drain ls spans in span-maintenance tests

BridgeAR · BridgeAR · commit 7a066a56875e · 2026-06-28T01:15:49.000+02:00
The shared mock agent now stays alive across every test in the Integration suite. The "should maintain previous span" cases spawn an async ls child process but never await its command_execution span, so a late flush can land during a later test whose expectSomeSpan carries the same ls expectation and be consumed there, masking a regression in that later command instead of failing. Awaiting the span in the originating test consumes it before the next test runs. Refs: #9113 (comment)
diff --git a/packages/datadog-plugin-child_process/test/index.spec.js b/packages/datadog-plugin-child_process/test/index.spec.js
@@ -1,6 +1,7 @@
 'use strict'
 
 const assert = require('node:assert/strict')
+const events = require('node:events')
 
 const { after, afterEach, before, beforeEach, describe, it } = require('mocha')
 const sinon = require('sinon')
@@ -528,47 +529,49 @@ describe('Child process plugin', () => {
 
           methods.forEach(({ methodName, async }) => {
             describe(methodName, () => {
-              it('should be instrumented', (done) => {
-                const expected = {
-                  type: 'system',
-                  name: 'command_execution',
-                  error: 0,
-                  meta: {
-                    component: 'subprocess',
-                    'cmd.shell': 'ls',
-                    'cmd.exit_code': '0',
-                  },
-                }
+              const lsExpected = {
+                type: 'system',
+                name: 'command_execution',
+                error: 0,
+                meta: {
+                  component: 'subprocess',
+                  'cmd.shell': 'ls',
+                  'cmd.exit_code': '0',
+                },
+              }
 
-                expectSomeSpan(agent, expected).then(done, done)
+              it('should be instrumented', (done) => {
+                expectSomeSpan(agent, lsExpected).then(done, done)
 
                 const res = childProcess[methodName]('ls')
                 if (async) {
                   res.on('close', noop)
                 }
               })
 
-              it('should maintain previous span after the execution', (done) => {
+              it('should maintain previous span after the execution', async () => {
+                const drained = expectSomeSpan(agent, lsExpected)
+
                 const res = childProcess[methodName]('ls')
-                const span = storage('legacy').getStore()?.span
-                assert.strictEqual(span, parentSpan)
+                assert.strictEqual(storage('legacy').getStore()?.span, parentSpan)
                 if (async) {
-                  res.on('close', () => {
-                    assert.strictEqual(span, parentSpan)
-                    done()
-                  })
+                  await Promise.all([drained, (async () => {
+                    await events.once(res, 'close')
+                    assert.strictEqual(storage('legacy').getStore()?.span, parentSpan)
+                  })()])
                 } else {
-                  done()
+                  await drained
                 }
               })
 
               if (async) {
-                it('should maintain previous span in the callback', (done) => {
-                  childProcess[methodName]('ls', () => {
-                    const span = storage('legacy').getStore()?.span
-                    assert.strictEqual(span, parentSpan)
-                    done()
-                  })
+                it('should maintain previous span in the callback', async () => {
+                  await Promise.all([expectSomeSpan(agent, lsExpected), new Promise(resolve => {
+                    childProcess[methodName]('ls', () => {
+                      assert.strictEqual(storage('legacy').getStore()?.span, parentSpan)
+                      resolve()
+                    })
+                  })])
                 })
               }
 
