[RUM] Catch errors thrown by user callbacks

packages/core/src/boot/init.ts

@@ -2,6 +2,7 @@ import { areCookiesAuthorized, CookieOptions } from '../browser/cookie'
 import { buildConfiguration, UserConfiguration } from '../domain/configuration'
 import { setDebugMode, startInternalMonitoring } from '../domain/internalMonitoring'
 import { Datacenter } from '../domain/transportConfiguration'
+import { catchErrors } from '../tools/catchErrors'
 
 export function makePublicApi<T>(stub: T): T & { onReady(callback: () => void): void } {
   const publicApi = {
@@ -31,7 +32,7 @@ export function defineGlobal<Global, Name extends keyof Global>(global: Global,
   const existingGlobalVariable: { q?: Array<() => void> } | undefined = global[name]
   global[name] = api
   if (existingGlobalVariable && existingGlobalVariable.q) {
-    existingGlobalVariable.q.forEach((fn) => fn())
+    existingGlobalVariable.q.forEach((fn) => catchErrors(fn, 'Error thrown during SDK initialization:')())
   }
 }
 
@@ -48,6 +49,9 @@ export interface BuildEnv {
 }
 
 export function commonInit(userConfiguration: UserConfiguration, buildEnv: BuildEnv) {
+  if (userConfiguration.beforeSend) {
+    userConfiguration.beforeSend = catchErrors(userConfiguration.beforeSend, 'beforeSend threw an error:')
+  }
   const configuration = buildConfiguration(userConfiguration, buildEnv)
   const internalMonitoring = startInternalMonitoring(configuration)
 

packages/core/src/index.ts

@@ -43,6 +43,7 @@ export {
   resetFetchProxy,
 } from './browser/fetchProxy'
 export { BoundedBuffer } from './tools/boundedBuffer'
+export { catchErrors } from './tools/catchErrors'
 export { createContextManager } from './tools/contextManager'
 export { limitModification } from './tools/limitModification'
 

packages/core/src/tools/catchErrors.spec.ts

@@ -0,0 +1,18 @@
+import { catchErrors } from './catchErrors'
+
+describe('catchErrors', () => {
+  it('returns the same result as the original function', () => {
+    const wrappedFn = catchErrors((a: number, b: number) => a + b, 'Error during callback')
+    expect(wrappedFn(10, 2)).toBe(12)
+  })
+
+  it('logs errors using console.error and returns undefined', () => {
+    const consoleErrorSpy = spyOn(console, 'error')
+    const myError = 'Ooops!'
+    const wrappedFn = catchErrors(() => {
+      throw myError
+    }, 'Error during callback')
+    expect(wrappedFn()).toBe(undefined)
+    expect(consoleErrorSpy).toHaveBeenCalledWith('Error during callback', myError)
+  })
+})

packages/core/src/tools/catchErrors.ts

@@ -0,0 +1,11 @@
+export function catchErrors<Args extends any[], R>(fn: (...args: Args) => R, errorMsg: string) {
+  return (...args: Args) => {
+    let result
+    try {
+      result = fn(...args)
+    } catch (err) {
+      console.error(errorMsg, err)
+    }
+    return result
+  }
+}

packages/core/src/tools/limitModification.spec.ts

@@ -92,21 +92,4 @@ describe('limitModification', () => {
       foo: { bar: 'qux' },
     })
   })
-
-  it('should catch and log modifier exception', () => {
-    const object = { foo: { bar: 'bar' }, qux: 'qux' }
-    const modifier = (candidate: any) => {
-      candidate.qux = 'modified'
-      candidate.foo.qux.bar = 'will throw'
-    }
-    const errorSpy = spyOn(console, 'error')
-
-    limitModification(object, ['foo.bar', 'qux'], modifier)
-
-    expect(errorSpy).toHaveBeenCalled()
-    expect(object).toEqual({
-      foo: { bar: 'bar' },
-      qux: 'qux',
-    })
-  })
 })

packages/core/src/tools/limitModification.ts

@@ -11,13 +11,7 @@ export function limitModification<T extends Context, Result>(
   modifier: (object: T) => Result
 ): Result | undefined {
   const clone = deepClone(object)
-  let result
-  try {
-    result = modifier(clone)
-  } catch (e) {
-    console.error(e)
-    return
-  }
+  const result = modifier(clone)
   modifiableFieldPaths.forEach((path) => {
     const originalValue = get(object, path)
     const newValue = get(clone, path)

packages/rum-core/src/domain/rumEventsCollection/view/trackViews.ts

@@ -1,4 +1,13 @@
-import { addEventListener, DOM_EVENT, generateUUID, monitor, noop, ONE_MINUTE, throttle } from '@datadog/browser-core'
+import {
+  addEventListener,
+  catchErrors,
+  DOM_EVENT,
+  generateUUID,
+  monitor,
+  noop,
+  ONE_MINUTE,
+  throttle,
+} from '@datadog/browser-core'
 import { NewLocationListener } from '../../../boot/rum'
 
 import { supportPerformanceTimingEvent } from '../../../browser/performanceCollection'
@@ -41,7 +50,7 @@ export function trackViews(
   lifeCycle: LifeCycle,
   onNewLocation: NewLocationListener = () => undefined
 ) {
-  onNewLocation = wrapOnNewLocation(onNewLocation)
+  onNewLocation = catchErrors(onNewLocation, 'onNewLocation threw an error:')
   const startOrigin = 0
   const initialView = newView(
     lifeCycle,
@@ -345,15 +354,3 @@ function sanitizeTiming(name: string) {
   }
   return sanitized
 }
-
-function wrapOnNewLocation(onNewLocation: NewLocationListener): NewLocationListener {
-  return (newLocation, oldLocation) => {
-    let result
-    try {
-      result = onNewLocation(newLocation, oldLocation)
-    } catch (err) {
-      console.error('onNewLocation threw an error:', err)
-    }
-    return result
-  }
-}