Fix trace correlation

Author: watson

packages/debugger/src/domain/api.spec.ts

@@ -321,7 +321,7 @@ describe('api', () => {
       expect(snapshot.duration).toBeGreaterThanOrEqual(10000000) // Should be in nanoseconds (>= 10ms)
     })
 
-    it('should include RUM context in logger', () => {
+    it('should omit trace correlation when no active span context is available', () => {
       const probe: Probe = {
         id: 'test-probe',
         version: 0,
@@ -341,10 +341,41 @@ describe('api', () => {
       onReturn(probes, null, {}, {}, {})
 
       const payload = mockBatchAdd.calls.mostRecent().args[0]
-      const dd = payload.dd
-      expect(dd).toEqual({
-        trace_id: 'test-session',
-        span_id: 'test-action',
+      expect(payload.dd).toBeUndefined()
+    })
+
+    it('should include trace correlation when active span context is available', () => {
+      mockRumGetInternalContext.and.returnValue({
+        session_id: 'test-session',
+        view: { id: 'test-view' },
+        user_action: { id: 'test-action' },
+        application_id: 'test-app-id',
+        trace_id: 'test-trace',
+        span_id: 'test-span',
+      })
+
+      const probe: Probe = {
+        id: 'test-probe',
+        version: 0,
+        type: 'LOG_PROBE',
+        where: { typeName: 'TestClass', methodName: 'traceContext' },
+        template: 'Test',
+        segments: [{ str: 'Test' }],
+        captureSnapshot: false,
+        capture: {},
+        sampling: {},
+        evaluateAt: 'ENTRY',
+      }
+      addProbe(probe)
+
+      const probes = getProbes('TestClass;traceContext')!
+      onEntry(probes, {}, {})
+      onReturn(probes, null, {}, {}, {})
+
+      const payload = mockBatchAdd.calls.mostRecent().args[0]
+      expect(payload.dd).toEqual({
+        trace_id: 'test-trace',
+        span_id: 'test-span',
       })
     })
   })

packages/debugger/src/domain/api.ts

@@ -15,6 +15,11 @@ interface Rum {
   getInternalContext?: () => RumInternalContext | undefined
 }
 
+interface TraceCorrelationContext extends Context {
+  trace_id: string
+  span_id: string
+}
+
 // Cache hostname at module initialization since it won't change during the app lifetime
 const globalObj = getGlobalObject<BrowserWindow & { DD_RUM?: Rum }>() // eslint-disable-line local-rules/disallow-side-effects
 const hostname = 'location' in globalObj ? globalObj.location.hostname : 'unknown'
@@ -273,7 +278,6 @@ function sendDebuggerSnapshot(probe: InitializedProbe, result: ActiveEntry): voi
         : undefined,
   }
 
-  const rumApi = globalObj.DD_RUM
   const debuggerApi = globalObj.DD_DEBUGGER!
 
   // TODO: Fill out logger with the right information
@@ -286,11 +290,7 @@ function sendDebuggerSnapshot(probe: InitializedProbe, result: ActiveEntry): voi
   }
 
   // Get the RUM internal context for trace correlation
-  const rumContext = rumApi?.getInternalContext?.()
-  const dd = {
-    trace_id: rumContext?.session_id,
-    span_id: rumContext?.user_action?.id || rumContext?.view?.id,
-  }
+  const dd = getTraceCorrelationContext()
 
   const ddtags = [
     buildTag('sdk_version', debuggerApi.version),
@@ -307,7 +307,7 @@ function sendDebuggerSnapshot(probe: InitializedProbe, result: ActiveEntry): voi
     service: debuggerConfig.service,
     ddtags: ddtags.join(','),
     logger,
-    dd,
+    ...(dd ? { dd } : {}),
     debugger: { snapshot },
   }
 
@@ -327,5 +327,23 @@ function detectThreadName() {
   return 'unknown'
 }
 
+function getTraceCorrelationContext(): TraceCorrelationContext | undefined {
+  const rumContext = globalObj.DD_RUM?.getInternalContext?.()
+  const traceId = getStringContextValue(rumContext, 'trace_id')
+  const spanId = getStringContextValue(rumContext, 'span_id')
+
+  return traceId && spanId
+    ? {
+        trace_id: traceId,
+        span_id: spanId,
+      }
+    : undefined
+}
+
+function getStringContextValue(context: Context | undefined, key: string): string | undefined {
+  const value = context?.[key]
+  return typeof value === 'string' && value !== '' ? value : undefined
+}
+
 declare const ServiceWorkerGlobalScope: typeof EventTarget
 declare function importScripts(...urls: string[]): void

test/e2e/scenario/debugger.scenario.ts

@@ -278,7 +278,7 @@ test.describe('debugger', () => {
       expect(intakeRegistry.debuggerEvents[0].message).toBe('Probe hit')
     })
 
-  createTest('include RUM correlation data when RUM is active')
+  createTest('omit trace correlation data when no active span is available')
     .withRum()
     .withDebugger()
     .run(async ({ intakeRegistry, flushEvents, page, browserName, servers }) => {
@@ -299,8 +299,6 @@ test.describe('debugger', () => {
       expect(intakeRegistry.debuggerEvents.length).toBeGreaterThanOrEqual(1)
 
       const event = intakeRegistry.debuggerEvents[0]
-      const dd = event.dd as { trace_id?: string; span_id?: string }
-      expect(dd.trace_id).toBeDefined()
-      expect(dd.trace_id).not.toBe('')
+      expect(event.dd).toBeUndefined()
     })
 })