[DI] Ensure probe EMITTING status is sent correctly (#5133)

watson · web-flow · commit 34499f33571c · 2025-01-20T11:17:30.000+01:00
Queue the probe EMITTING status before trying to queue the probe
payload.

Before, the EMITTING status was only emitted if the probe payload was
successfully received by the agnet. If the agent didn't return a HTTP
2xx status code, the EMITTING status would never be sent.
diff --git a/packages/dd-trace/src/debugger/devtools_client/index.js b/packages/dd-trace/src/debugger/devtools_client/index.js
@@ -146,10 +146,9 @@ session.on('Debugger.paused', async ({ params }) => {
       }
     }
 
+    ackEmitting(probe)
     // TODO: Process template (DEBUG-2628)
-    send(probe.template, logger, dd, snapshot, () => {
-      ackEmitting(probe)
-    })
+    send(probe.template, logger, dd, snapshot)
   }
 })
 
diff --git a/packages/dd-trace/src/debugger/devtools_client/send.js b/packages/dd-trace/src/debugger/devtools_client/send.js
@@ -29,10 +29,9 @@ const ddtags = [
 
 const path = `/debugger/v1/input?${stringify({ ddtags })}`
 
-let callbacks = []
 const jsonBuffer = new JSONBuffer({ size: config.maxTotalPayloadSize, timeout: 1000, onFlush })
 
-function send (message, logger, dd, snapshot, cb) {
+function send (message, logger, dd, snapshot) {
   const payload = {
     ddsource,
     hostname,
@@ -58,7 +57,6 @@ function send (message, logger, dd, snapshot, cb) {
   }
 
   jsonBuffer.write(json, size)
-  callbacks.push(cb)
 }
 
 function onFlush (payload) {
@@ -69,11 +67,7 @@ function onFlush (payload) {
     headers: { 'Content-Type': 'application/json; charset=utf-8' }
   }
 
-  const _callbacks = callbacks
-  callbacks = []
-
   request(payload, opts, (err) => {
     if (err) log.error('[debugger:devtools_client] Error sending probe payload', err)
-    else _callbacks.forEach(cb => cb())
   })
 }
diff --git a/packages/dd-trace/test/debugger/devtools_client/send.spec.js b/packages/dd-trace/test/debugger/devtools_client/send.spec.js
@@ -54,13 +54,9 @@ describe('input message http requests', function () {
   })
 
   it('should call request with the expected payload once the buffer is flushed', function (done) {
-    const callback1 = sinon.spy()
-    const callback2 = sinon.spy()
-    const callback3 = sinon.spy()
-
-    send({ message: 1 }, logger, dd, snapshot, callback1)
-    send({ message: 2 }, logger, dd, snapshot, callback2)
-    send({ message: 3 }, logger, dd, snapshot, callback3)
+    send({ message: 1 }, logger, dd, snapshot)
+    send({ message: 2 }, logger, dd, snapshot)
+    send({ message: 3 }, logger, dd, snapshot)
     expect(request).to.not.have.been.called
 
     expectWithin(1200, () => {
@@ -83,16 +79,6 @@ describe('input message http requests', function () {
           `git.repository_url%3A${repositoryUrl}`
       )
 
-      expect(callback1).to.not.have.been.calledOnce
-      expect(callback2).to.not.have.been.calledOnce
-      expect(callback3).to.not.have.been.calledOnce
-
-      request.firstCall.callback()
-
-      expect(callback1).to.have.been.calledOnce
-      expect(callback2).to.have.been.calledOnce
-      expect(callback3).to.have.been.calledOnce
-
       done()
     })
   })

Original file line number	Diff line number	Diff line change
`@@ -146,10 +146,9 @@ session.on('Debugger.paused', async ({ params }) => {`
`146`	`146`	`}`
`147`	`147`	`}`
`148`	`148`
	`149`	`+ ackEmitting(probe)`
`149`	`150`	`// TODO: Process template (DEBUG-2628)`
`150`		`- send(probe.template, logger, dd, snapshot, () => {`
`151`		`- ackEmitting(probe)`
`152`		`- })`
	`151`	`+ send(probe.template, logger, dd, snapshot)`
`153`	`152`	`}`
`154`	`153`	`})`
`155`	`154`
Original file line number	Diff line number	Diff line change
`@@ -29,10 +29,9 @@ const ddtags = [`
`29`	`29`
`30`	`30`	const path = `/debugger/v1/input?${stringify({ ddtags })}`
`31`	`31`
`32`		`-let callbacks = []`
`33`	`32`	`const jsonBuffer = new JSONBuffer({ size: config.maxTotalPayloadSize, timeout: 1000, onFlush })`
`34`	`33`
`35`		`-function send (message, logger, dd, snapshot, cb) {`
	`34`	`+function send (message, logger, dd, snapshot) {`
`36`	`35`	`const payload = {`
`37`	`36`	`ddsource,`
`38`	`37`	`hostname,`
`@@ -58,7 +57,6 @@ function send (message, logger, dd, snapshot, cb) {`
`58`	`57`	`}`
`59`	`58`
`60`	`59`	`jsonBuffer.write(json, size)`
`61`		`- callbacks.push(cb)`
`62`	`60`	`}`
`63`	`61`
`64`	`62`	`function onFlush (payload) {`
`@@ -69,11 +67,7 @@ function onFlush (payload) {`
`69`	`67`	`headers: { 'Content-Type': 'application/json; charset=utf-8' }`
`70`	`68`	`}`
`71`	`69`
`72`		`- const _callbacks = callbacks`
`73`		`- callbacks = []`
`74`		`-`
`75`	`70`	`request(payload, opts, (err) => {`
`76`	`71`	`if (err) log.error('[debugger:devtools_client] Error sending probe payload', err)`
`77`		`- else _callbacks.forEach(cb => cb())`
`78`	`72`	`})`
`79`	`73`	`}`