✨ [RUMF-909] add beforeSend context

packages/core/src/browser/fetchProxy.spec.ts

@@ -36,7 +36,7 @@ describe('fetch proxy', () => {
       expect(request.method).toEqual('GET')
       expect(request.url).toEqual(FAKE_URL)
       expect(request.status).toEqual(500)
-      expect(request.response).toEqual('fetch error')
+      expect(request.responseText).toEqual('fetch error')
       expect(request.isAborted).toBe(false)
       done()
     })
@@ -50,8 +50,9 @@ describe('fetch proxy', () => {
       expect(request.method).toEqual('GET')
       expect(request.url).toEqual(FAKE_URL)
       expect(request.status).toEqual(0)
-      expect(request.response).toMatch(/Error: fetch error/)
+      expect(request.responseText).toMatch(/Error: fetch error/)
       expect(request.isAborted).toBe(false)
+      expect(request.error).toEqual(new Error('fetch error'))
       done()
     })
   })
@@ -64,8 +65,9 @@ describe('fetch proxy', () => {
       expect(request.method).toEqual('GET')
       expect(request.url).toEqual(FAKE_URL)
       expect(request.status).toEqual(0)
-      expect(request.response).toContain('AbortError: The user aborted a request')
+      expect(request.responseText).toContain('AbortError: The user aborted a request')
       expect(request.isAborted).toBe(true)
+      expect(request.error).toEqual(new DOMException('The user aborted a request', 'AbortError'))
       done()
     })
   })
@@ -79,8 +81,9 @@ describe('fetch proxy', () => {
       expect(request.method).toEqual('GET')
       expect(request.url).toEqual(FAKE_URL)
       expect(request.status).toEqual(200)
-      expect(request.response).toMatch(/Error: locked/)
+      expect(request.responseText).toMatch(/Error: locked/)
       expect(request.isAborted).toBe(false)
+      expect(request.error).toBeUndefined()
       done()
     })
   })
@@ -107,7 +110,7 @@ describe('fetch proxy', () => {
       expect(request.method).toEqual('GET')
       expect(request.url).toEqual(FAKE_URL)
       expect(request.status).toEqual(400)
-      expect(request.response).toEqual('Not found')
+      expect(request.responseText).toEqual('Not found')
       expect(request.isAborted).toBe(false)
       done()
     })

packages/core/src/browser/fetchProxy.ts

@@ -28,9 +28,11 @@ export interface FetchStartContext {
 export interface FetchCompleteContext extends FetchStartContext {
   duration: Duration
   status: number
-  response: string
+  response?: Response
+  responseText: string
   responseType?: string
   isAborted: boolean
+  error?: Error
 }
 
 let fetchProxySingleton: FetchProxy | undefined
@@ -111,8 +113,9 @@ function afterSend(responsePromise: Promise<Response>, context: FetchStartContex
 
     if ('stack' in response || response instanceof Error) {
       context.status = 0
-      context.response = toStackTraceString(computeStackTrace(response))
+      context.responseText = toStackTraceString(computeStackTrace(response))
       context.isAborted = response instanceof DOMException && response.code === DOMException.ABORT_ERR
+      context.error = response
 
       onRequestCompleteCallbacks.forEach((callback) => callback(context as FetchCompleteContext))
     } else if ('status' in response) {
@@ -122,7 +125,8 @@ function afterSend(responsePromise: Promise<Response>, context: FetchStartContex
       } catch (e) {
         text = `Unable to retrieve response: ${e as string}`
       }
-      context.response = text
+      context.response = response
+      context.responseText = text
       context.responseType = response.type
       context.status = response.status
       context.isAborted = false

packages/core/src/browser/xhrProxy.spec.ts

@@ -33,7 +33,7 @@ describe('xhr proxy', () => {
         const request = getRequest(0)
         expect(request.method).toBe('GET')
         expect(request.url).toContain('/ok')
-        expect(request.response).toBe('ok')
+        expect(request.responseText).toBe('ok')
         expect(request.status).toBe(200)
         expect(request.isAborted).toBe(false)
         expect(request.startTime).toEqual(jasmine.any(Number))
@@ -54,7 +54,7 @@ describe('xhr proxy', () => {
         const request = getRequest(0)
         expect(request.method).toBe('GET')
         expect(request.url).toContain('/expected-404')
-        expect(request.response).toBe('NOT FOUND')
+        expect(request.responseText).toBe('NOT FOUND')
         expect(request.status).toBe(404)
         expect(request.isAborted).toBe(false)
         expect(request.startTime).toEqual(jasmine.any(Number))
@@ -75,7 +75,7 @@ describe('xhr proxy', () => {
         const request = getRequest(0)
         expect(request.method).toBe('GET')
         expect(request.url).toContain('/throw')
-        expect(request.response).toEqual('expected server error')
+        expect(request.responseText).toEqual('expected server error')
         expect(request.status).toBe(500)
         expect(request.isAborted).toBe(false)
         expect(request.startTime).toEqual(jasmine.any(Number))
@@ -96,7 +96,7 @@ describe('xhr proxy', () => {
         const request = getRequest(0)
         expect(request.method).toBe('GET')
         expect(request.url).toBe('http://foo.bar/qux')
-        expect(request.response).toBe('')
+        expect(request.responseText).toBe('')
         expect(request.status).toBe(0)
         expect(request.isAborted).toBe(false)
         expect(request.startTime).toEqual(jasmine.any(Number))
@@ -120,7 +120,7 @@ describe('xhr proxy', () => {
         const request = getRequest(0)
         expect(request.method).toBe('GET')
         expect(request.url).toContain('/ok')
-        expect(request.response).toBe('ok')
+        expect(request.responseText).toBe('ok')
         expect(request.status).toBe(200)
         expect(request.startTime).toEqual(jasmine.any(Number))
         expect(request.duration).toEqual(jasmine.any(Number))
@@ -143,7 +143,7 @@ describe('xhr proxy', () => {
         const request = getRequest(0)
         expect(request.method).toBe('GET')
         expect(request.url).toContain('/ok')
-        expect(request.response).toBeUndefined()
+        expect(request.responseText).toBeUndefined()
         expect(request.status).toBe(0)
         expect(request.startTime).toEqual(jasmine.any(Number))
         expect(request.duration).toEqual(jasmine.any(Number))
@@ -166,7 +166,7 @@ describe('xhr proxy', () => {
         const request = getRequest(0)
         expect(request.method).toBe('GET')
         expect(request.url).toContain('/ok')
-        expect(request.response).toBe('ok')
+        expect(request.responseText).toBe('ok')
         expect(request.status).toBe(200)
         expect(request.isAborted).toBe(false)
         expect(request.startTime).toEqual(jasmine.any(Number))

packages/core/src/browser/xhrProxy.ts

@@ -29,8 +29,9 @@ export interface XhrStartContext {
 export interface XhrCompleteContext extends XhrStartContext {
   duration: Duration
   status: number
-  response: string | undefined
+  responseText: string | undefined
   isAborted: boolean
+  xhr: XMLHttpRequest
 }
 
 let xhrProxySingleton: XhrProxy | undefined
@@ -126,8 +127,9 @@ function proxyXhr() {
           const xhrCompleteContext: XhrCompleteContext = {
             ...xhrPendingContext,
             duration: elapsed(xhrPendingContext.startClocks.timeStamp, timeStampNow()),
-            response: this.response as string | undefined,
+            responseText: this.response as string | undefined,
             status: this.status,
+            xhr: this,
           }
 
           onRequestCompleteCallbacks.forEach((callback) => callback(xhrCompleteContext))

packages/core/src/domain/automaticErrorCollection.spec.ts

@@ -238,7 +238,7 @@ describe('network error tracker', () => {
     })
   })
 
-  it('should add a default error response', (done) => {
+  it('should add a default error response text', (done) => {
     fetchStub(FAKE_URL).resolveWith({ ...DEFAULT_REQUEST, responseText: undefined })
 
     fetchStubManager.whenAllComplete(() => {
@@ -249,7 +249,7 @@ describe('network error tracker', () => {
     })
   })
 
-  it('should truncate error response', (done) => {
+  it('should truncate error response text', (done) => {
     fetchStub(FAKE_URL).resolveWith({
       ...DEFAULT_REQUEST,
       responseText: 'Lorem ipsum dolor sit amet orci aliquam.',

packages/core/src/domain/automaticErrorCollection.ts

@@ -70,6 +70,7 @@ export function startRuntimeErrorTracking(errorObservable: ErrorObservable) {
       type,
       source: ErrorSource.SOURCE,
       startClocks: clocksNow(),
+      originalError: errorObject,
     })
   }
   subscribe(traceKitReportHandler)
@@ -97,7 +98,7 @@ export function trackNetworkError(configuration: Configuration, errorObservable:
           url: request.url,
         },
         source: ErrorSource.NETWORK,
-        stack: truncateResponse(request.response, configuration) || 'Failed to load',
+        stack: truncateResponseText(request.responseText, configuration) || 'Failed to load',
         startClocks: request.startClocks,
       })
     }
@@ -119,11 +120,11 @@ function isServerError(request: { status: number }) {
   return request.status >= 500
 }
 
-function truncateResponse(response: string | undefined, configuration: Configuration) {
-  if (response && response.length > configuration.requestErrorResponseLengthLimit) {
-    return `${response.substring(0, configuration.requestErrorResponseLengthLimit)}...`
+function truncateResponseText(responseText: string | undefined, configuration: Configuration) {
+  if (responseText && responseText.length > configuration.requestErrorResponseLengthLimit) {
+    return `${responseText.substring(0, configuration.requestErrorResponseLengthLimit)}...`
   }
-  return response
+  return responseText
 }
 
 function format(type: RequestType) {

packages/core/src/domain/configuration.spec.ts

@@ -47,8 +47,8 @@ describe('configuration', () => {
         }
       }
       const configuration = buildConfiguration({ clientToken, beforeSend }, usEnv)
-      expect(configuration.beforeSend!({ view: { url: '/foo' } })).toBeFalse()
-      expect(configuration.beforeSend!({ view: { url: '/bar' } })).toBeUndefined()
+      expect(configuration.beforeSend!({ view: { url: '/foo' } }, {})).toBeFalse()
+      expect(configuration.beforeSend!({ view: { url: '/bar' } }, {})).toBeUndefined()
     })
 
     it('should catch errors and log them', () => {
@@ -58,7 +58,7 @@ describe('configuration', () => {
       }
       const configuration = buildConfiguration({ clientToken, beforeSend }, usEnv)
       const displaySpy = spyOn(display, 'error')
-      expect(configuration.beforeSend!(null)).toBeUndefined()
+      expect(configuration.beforeSend!(null, {})).toBeUndefined()
       expect(displaySpy).toHaveBeenCalledWith('beforeSend threw an error:', myError)
     })
   })

packages/core/src/domain/configuration.ts

@@ -53,7 +53,7 @@ export interface UserConfiguration {
   trackInteractions?: boolean
   trackViewsManually?: boolean
   proxyHost?: string
-  beforeSend?: (event: any) => void
+  beforeSend?: BeforeSendCallback
 
   service?: string
   env?: string
@@ -68,6 +68,8 @@ export interface UserConfiguration {
   replica?: ReplicaUserConfiguration
 }
 
+export type BeforeSendCallback = (event: any, context?: any) => unknown
+
 interface ReplicaUserConfiguration {
   applicationId?: string
   clientToken: string
@@ -78,7 +80,7 @@ export type Configuration = typeof DEFAULT_CONFIGURATION &
     cookieOptions: CookieOptions
 
     service?: string
-    beforeSend?: (event: any) => unknown
+    beforeSend?: BeforeSendCallback
 
     isEnabled: (feature: string) => boolean
   }

packages/core/src/index.ts

@@ -1,4 +1,10 @@
-export { DEFAULT_CONFIGURATION, Configuration, UserConfiguration, buildCookieOptions } from './domain/configuration'
+export {
+  DEFAULT_CONFIGURATION,
+  Configuration,
+  UserConfiguration,
+  buildCookieOptions,
+  BeforeSendCallback,
+} from './domain/configuration'
 export { startAutomaticErrorCollection, ErrorObservable } from './domain/automaticErrorCollection'
 export { computeStackTrace } from './domain/tracekit'
 export {

packages/core/src/tools/error.ts

@@ -13,6 +13,7 @@ export interface RawError {
     statusCode: number
     method: string
   }
+  originalError?: unknown
 }
 
 export const ErrorSource = {

packages/rum-core/src/boot/rumPublicApi.ts

@@ -19,14 +19,14 @@ import {
   InternalMonitoring,
 } from '@datadog/browser-core'
 import { ProvidedSource } from '../domain/rumEventsCollection/error/errorCollection'
-import { CommonContext, User, ActionType } from '../rawRumEvent.types'
+import { CommonContext, User, ActionType, RumEventDomainContext } from '../rawRumEvent.types'
 import { RumEvent } from '../rumEvent.types'
 import { buildEnv } from './buildEnv'
 import { startRum } from './startRum'
 
 export interface RumUserConfiguration extends UserConfiguration {
   applicationId: string
-  beforeSend?: (event: RumEvent) => void | boolean
+  beforeSend?: (event: RumEvent, context: RumEventDomainContext) => void | boolean
 }
 
 export type RumPublicApi = ReturnType<typeof makeRumPublicApi>

packages/rum-core/src/browser/performanceCollection.ts

@@ -16,6 +16,7 @@ import { LifeCycle, LifeCycleEventType } from '../domain/lifeCycle'
 import { FAKE_INITIAL_DOCUMENT, isAllowedRequestUrl } from '../domain/rumEventsCollection/resource/resourceUtils'
 
 import { getDocumentTraceId } from '../domain/tracing/getDocumentTraceId'
+import { PerformanceEntryRepresentation } from '../rawRumEvent.types'
 
 export interface RumPerformanceResourceTiming {
   entryType: 'resource'
@@ -42,6 +43,7 @@ export interface RumPerformanceLongTaskTiming {
   entryType: 'longtask'
   startTime: RelativeTime
   duration: Duration
+  toJSON(): PerformanceEntryRepresentation
 }
 
 export interface RumPerformancePaintTiming {