Add tests and put feature under feature flag

Author: amortemousque

packages/core/src/tools/experimentalFeatures.ts

@@ -19,6 +19,7 @@ export enum ExperimentalFeature {
   FEATURE_OPERATION_VITAL = 'feature_operation_vital',
   SHORT_SESSION_INVESTIGATION = 'short_session_investigation',
   AVOID_FETCH_KEEPALIVE = 'avoid_fetch_keepalive',
+  SOURCE_CODE_CONTEXT = 'source_code_context',
 }
 
 const enabledExperimentalFeatures: Set<ExperimentalFeature> = new Set()

packages/rum-core/src/domain/contexts/sourceCodeContext.spec.ts

@@ -0,0 +1,183 @@
+import { ExperimentalFeature, HookNames } from '@datadog/browser-core'
+import type { RelativeTime } from '@datadog/browser-core'
+import type { Hooks } from '../hooks'
+import { createHooks } from '../hooks'
+import { mockExperimentalFeatures, registerCleanupTask } from '../../../../core/test'
+import type { BrowserWindow } from './sourceCodeContext'
+import { startSourceCodeContext } from './sourceCodeContext'
+
+describe('sourceCodeContext', () => {
+  let hooks: Hooks
+  let browserWindow: BrowserWindow
+  const TEST_STACK = `Error: Test error
+    at testFunction (http://localhost:8080/file.js:41:27)
+    at HTMLButtonElement.onclick (http://localhost:8080/file-2.js:107:146)`
+
+  const MATCHING_TEST_STACK = `Error: Another error
+    at anotherFunction (http://localhost:8080/file.js:41:27)
+    at HTMLButtonElement.onPointerUp (http://localhost:8080/another-file.js:107:146)`
+
+  beforeEach(() => {
+    hooks = createHooks()
+    browserWindow = window as BrowserWindow
+  })
+
+  function setupBrowserWindowWithContext() {
+    browserWindow.DD_SOURCE_CODE_CONTEXT = {
+      [TEST_STACK]: {
+        service: 'my-service',
+        version: '1.0.0',
+      },
+    }
+
+    registerCleanupTask(() => {
+      delete browserWindow.DD_SOURCE_CODE_CONTEXT
+    })
+  }
+
+  describe('assemble hook when FF disabled', () => {
+    it('should not add source code context', () => {
+      setupBrowserWindowWithContext()
+      startSourceCodeContext(hooks)
+
+      const result = hooks.triggerHook(HookNames.Assemble, {
+        eventType: 'error',
+        startTime: 0 as RelativeTime,
+        domainContext: {},
+        rawRumEvent: {
+          type: 'error',
+          error: {
+            stack: MATCHING_TEST_STACK,
+          },
+        } as any,
+      })
+
+      expect(result).toBeUndefined()
+    })
+  })
+
+  describe('assemble hook when FF enabled', () => {
+    beforeEach(() => {
+      mockExperimentalFeatures([ExperimentalFeature.SOURCE_CODE_CONTEXT])
+    })
+
+    it('should add source code context matching the error stack first frame URL', () => {
+      setupBrowserWindowWithContext()
+      startSourceCodeContext(hooks)
+
+      const result = hooks.triggerHook(HookNames.Assemble, {
+        eventType: 'error',
+        startTime: 0 as RelativeTime,
+        domainContext: {},
+        rawRumEvent: {
+          type: 'error',
+          error: {
+            stack: MATCHING_TEST_STACK,
+          },
+        } as any,
+      })
+
+      expect(result).toEqual({
+        type: 'error',
+        service: 'my-service',
+        version: '1.0.0',
+      })
+    })
+
+    it('should add source code context matching the handling_stack first frame URL', () => {
+      setupBrowserWindowWithContext()
+      startSourceCodeContext(hooks)
+
+      const result = hooks.triggerHook(HookNames.Assemble, {
+        eventType: 'action',
+        startTime: 0 as RelativeTime,
+        rawRumEvent: {
+          type: 'action',
+        } as any,
+        domainContext: {
+          handling_stack: MATCHING_TEST_STACK,
+        },
+      })
+
+      expect(result).toEqual({
+        type: 'action',
+        service: 'my-service',
+        version: '1.0.0',
+      })
+    })
+
+    it('should not add source code context matching no stack', () => {
+      setupBrowserWindowWithContext()
+      startSourceCodeContext(hooks)
+
+      const result = hooks.triggerHook(HookNames.Assemble, {
+        eventType: 'error',
+        startTime: 0 as RelativeTime,
+        domainContext: {},
+        rawRumEvent: {
+          type: 'error',
+          error: {
+            stack: `Error: Another error
+                at anotherFunction (http://localhost:8080/another-file.js:41:27)`,
+          },
+        } as any,
+      })
+
+      expect(result).toBeUndefined()
+    })
+
+    it('should support late updates to DD_SOURCE_CODE_CONTEXT', () => {
+      startSourceCodeContext(hooks)
+
+      // Add context AFTER initialization
+      setupBrowserWindowWithContext()
+
+      const result = hooks.triggerHook(HookNames.Assemble, {
+        eventType: 'error',
+        startTime: 0 as RelativeTime,
+        domainContext: {},
+        rawRumEvent: {
+          type: 'error',
+          error: {
+            stack: TEST_STACK,
+          },
+        } as any,
+      })
+
+      expect(result).toEqual({
+        type: 'error',
+        service: 'my-service',
+        version: '1.0.0',
+      })
+    })
+
+    it('should ignore updates to existing source code context after initialization', () => {
+      setupBrowserWindowWithContext()
+      startSourceCodeContext(hooks)
+
+      // Update existing entry
+      browserWindow.DD_SOURCE_CODE_CONTEXT![TEST_STACK] = {
+        service: 'updated-service',
+        version: '1.1.0',
+      }
+
+      const result = hooks.triggerHook(HookNames.Assemble, {
+        eventType: 'error',
+        startTime: 0 as RelativeTime,
+        domainContext: {},
+        rawRumEvent: {
+          type: 'error',
+          error: {
+            stack: TEST_STACK,
+          },
+        } as any,
+      })
+
+      expect(result).toEqual({
+        type: 'error',
+        service: 'my-service',
+        version: '1.0.0',
+      })
+    })
+  })
+})