retrieve fingerprint from addError calls

DataDog · Apr 26, 2023 · 7ed5427 · 7ed5427
1 parent 0e957c1
commit 7ed5427
Show file tree

Hide file tree

Showing 5 changed files with 44 additions and 0 deletions.
diff --git a/packages/core/src/domain/error/error.ts b/packages/core/src/domain/error/error.ts
@@ -41,6 +41,7 @@ export function computeRawError({
     : NO_ERROR_STACK_PRESENT_MESSAGE
   const causes = isErrorInstance ? flattenErrorCauses(originalError as ErrorWithCause, source) : undefined
   const type = stackTrace?.name
+  const fingerprint = isErrorWithFingerprint(originalError) ? String(originalError.dd_fingerprint) : undefined
 
   return {
     startClocks,
@@ -52,6 +53,7 @@ export function computeRawError({
     message,
     stack,
     causes,
+    fingerprint,
   }
 }
 
@@ -65,6 +67,10 @@ function hasUsableStack(isErrorInstance: boolean, stackTrace?: StackTrace): stac
   return stackTrace.stack.length > 0 && (stackTrace.stack.length > 1 || stackTrace.stack[0].url !== undefined)
 }
 
+function isErrorWithFingerprint(error: unknown): error is { dd_fingerprint: unknown } {
+  return error instanceof Error && 'dd_fingerprint' in error
+}
+
 export function toStackTraceString(stack: StackTrace) {
   let result = formatErrorMessage(stack)
   stack.stack.forEach((frame) => {

diff --git a/packages/core/src/domain/error/error.types.ts b/packages/core/src/domain/error/error.types.ts
@@ -21,6 +21,7 @@ export interface RawError {
   handling?: ErrorHandling
   handlingStack?: string
   causes?: RawErrorCause[]
+  fingerprint?: string
 }
 
 export const ErrorSource = {

diff --git a/packages/rum-core/src/domain/rumEventsCollection/error/errorCollection.spec.ts b/packages/rum-core/src/domain/rumEventsCollection/error/errorCollection.spec.ts
@@ -80,6 +80,7 @@ describe('error collection', () => {
               handling: ErrorHandling.HANDLED,
               source_type: 'browser',
               causes: undefined,
+              fingerprint: undefined,
             },
             type: RumEventType.ERROR,
             view: {
@@ -118,6 +119,39 @@ describe('error collection', () => {
       expect(error?.causes?.[1].source).toEqual(ErrorSource.CUSTOM)
     })
 
+    it('should extract fingerprint from error', () => {
+      const { rawRumEvents } = setupBuilder.build()
+
+      interface DatadogError extends Error {
+        dd_fingerprint?: string
+      }
+      const error = new Error('foo')
+      ;(error as DatadogError).dd_fingerprint = 'my-fingerprint'
+
+      addError({
+        error,
+        handlingStack: 'Error: handling foo',
+        startClocks: { relative: 1234 as RelativeTime, timeStamp: 123456789 as TimeStamp },
+      })
+
+      expect((rawRumEvents[0].rawRumEvent as RawRumErrorEvent).error.fingerprint).toEqual('my-fingerprint')
+    })
+
+    it('should sanitize error fingerprint', () => {
+      const { rawRumEvents } = setupBuilder.build()
+
+      const error = new Error('foo')
+      ;(error as any).dd_fingerprint = 2
+
+      addError({
+        error,
+        handlingStack: 'Error: handling foo',
+        startClocks: { relative: 1234 as RelativeTime, timeStamp: 123456789 as TimeStamp },
+      })
+
+      expect((rawRumEvents[0].rawRumEvent as RawRumErrorEvent).error.fingerprint).toEqual('2')
+    })
+
     it('should save the specified customer context', () => {
       const { rawRumEvents } = setupBuilder.build()
       addError({
@@ -218,6 +252,7 @@ describe('error collection', () => {
           handling: undefined,
           source_type: 'browser',
           causes: undefined,
+          fingerprint: undefined,
         },
         view: {
           in_foreground: true,

diff --git a/packages/rum-core/src/domain/rumEventsCollection/error/errorCollection.ts b/packages/rum-core/src/domain/rumEventsCollection/error/errorCollection.ts
@@ -104,6 +104,7 @@ function processError(
       handling: error.handling,
       causes: error.causes,
       source_type: 'browser',
+      fingerprint: error.fingerprint,
     },
     type: RumEventType.ERROR as const,
   }

diff --git a/packages/rum-core/src/rawRumEvent.types.ts b/packages/rum-core/src/rawRumEvent.types.ts
@@ -59,6 +59,7 @@ export interface RawRumErrorEvent {
     type?: string
     stack?: string
     handling_stack?: string
+    fingerprint?: string
     source: ErrorSource
     message: string
     handling?: ErrorHandling