♻️ [RUM-2445] align rum and logs common context implementation

Align both implementations by:

* move the logs `buildCommonContext` in its own module (similar to RUM)
* craft a `getCommonContext` based on `buildCommonContext` in both
  rumPublicApi and logsPublicApi, and pass it to `startRum` and
  `startLogs`.

This slightly refactors how common contexts are computed.

packages/logs/src/boot/logsPublicApi.spec.ts

@@ -151,8 +151,8 @@ describe('logs entry', () => {
     it('should have the current date, view and global context', () => {
       LOGS.setGlobalContextProperty('foo', 'bar')
 
-      const buildCommonContext = startLogs.calls.mostRecent().args[2]
-      expect(buildCommonContext()).toEqual({
+      const getCommonContext = startLogs.calls.mostRecent().args[2]
+      expect(getCommonContext()).toEqual({
         view: {
           referrer: document.referrer,
           url: window.location.href,
@@ -352,8 +352,8 @@ describe('logs entry', () => {
         const user = { id: 'foo', name: 'bar', email: 'qux', foo: { bar: 'qux' } }
         logsPublicApi.setUser(user)
 
-        const buildCommonContext = startLogs.calls.mostRecent().args[2]
-        expect(buildCommonContext().user).toEqual({
+        const getCommonContext = startLogs.calls.mostRecent().args[2]
+        expect(getCommonContext().user).toEqual({
           email: 'qux',
           foo: { bar: 'qux' },
           id: 'foo',
@@ -364,8 +364,8 @@ describe('logs entry', () => {
       it('should sanitize predefined properties', () => {
         const user = { id: null, name: 2, email: { bar: 'qux' } }
         logsPublicApi.setUser(user as any)
-        const buildCommonContext = startLogs.calls.mostRecent().args[2]
-        expect(buildCommonContext().user).toEqual({
+        const getCommonContext = startLogs.calls.mostRecent().args[2]
+        expect(getCommonContext().user).toEqual({
           email: '[object Object]',
           id: 'null',
           name: '2',
@@ -377,8 +377,8 @@ describe('logs entry', () => {
         logsPublicApi.setUser(user)
         logsPublicApi.clearUser()
 
-        const buildCommonContext = startLogs.calls.mostRecent().args[2]
-        expect(buildCommonContext().user).toEqual({})
+        const getCommonContext = startLogs.calls.mostRecent().args[2]
+        expect(getCommonContext().user).toEqual({})
       })
 
       it('should reject non object input', () => {

packages/logs/src/boot/logsPublicApi.ts

@@ -21,7 +21,7 @@ import type { LogsInitConfiguration } from '../domain/configuration'
 import { validateAndBuildLogsConfiguration } from '../domain/configuration'
 import type { HandlerType, StatusType, LogsMessage } from '../domain/logger'
 import { Logger } from '../domain/logger'
-import type { CommonContext } from '../rawLogsEvent.types'
+import { buildCommonContext } from '../domain/contexts/commonContext'
 import type { startLogs } from './startLogs'
 
 export interface LoggerConfiguration {
@@ -55,7 +55,7 @@ export function makeLogsPublicApi(startLogsImpl: StartLogs) {
   let handleLogStrategy: StartLogsResult['handleLog'] = (
     logsMessage: LogsMessage,
     logger: Logger,
-    savedCommonContext = deepClone(buildCommonContext()),
+    savedCommonContext = getCommonContext(),
     date = timeStampNow()
   ) => {
     beforeInitLoggerLog.add(() => handleLogStrategy(logsMessage, logger, savedCommonContext, date))
@@ -67,15 +67,8 @@ export function makeLogsPublicApi(startLogsImpl: StartLogs) {
     customerDataTrackerManager.createDetachedTracker()
   )
 
-  function buildCommonContext(): CommonContext {
-    return {
-      view: {
-        referrer: document.referrer,
-        url: window.location.href,
-      },
-      context: globalContextManager.getContext(),
-      user: userContextManager.getContext(),
-    }
+  function getCommonContext() {
+    return buildCommonContext(globalContextManager, userContextManager)
   }
 
   return makePublicApi({
@@ -125,7 +118,7 @@ export function makeLogsPublicApi(startLogsImpl: StartLogs) {
       ;({ handleLog: handleLogStrategy, getInternalContext: getInternalContextStrategy } = startLogsImpl(
         initConfiguration,
         configuration,
-        buildCommonContext
+        getCommonContext
       ))
 
       beforeInitLoggerLog.drain()

packages/logs/src/boot/startLogs.ts

@@ -13,17 +13,17 @@ import { startNetworkErrorCollection } from '../domain/networkError/networkError
 import { startRuntimeErrorCollection } from '../domain/runtimeError/runtimeErrorCollection'
 import { LifeCycle, LifeCycleEventType } from '../domain/lifeCycle'
 import { startLoggerCollection } from '../domain/logger/loggerCollection'
-import type { CommonContext } from '../rawLogsEvent.types'
 import { startLogsBatch } from '../transport/startLogsBatch'
 import { startLogsBridge } from '../transport/startLogsBridge'
 import { startInternalContext } from '../domain/contexts/internalContext'
 import { startReportError } from '../domain/reportError'
 import { startLogsTelemetry } from '../domain/logsTelemetry'
+import type { CommonContext } from '../rawLogsEvent.types'
 
 export function startLogs(
   initConfiguration: LogsInitConfiguration,
   configuration: LogsConfiguration,
-  buildCommonContext: () => CommonContext
+  getCommonContext: () => CommonContext
 ) {
   const lifeCycle = new LifeCycle()
   const cleanupTasks: Array<() => void> = []
@@ -53,7 +53,7 @@ export function startLogs(
   startReportCollection(configuration, lifeCycle)
   const { handleLog } = startLoggerCollection(lifeCycle)
 
-  startLogsAssembly(session, configuration, lifeCycle, buildCommonContext, reportError)
+  startLogsAssembly(session, configuration, lifeCycle, getCommonContext, reportError)
 
   if (!canUseEventBridge()) {
     const { stop: stopLogsBatch } = startLogsBatch(configuration, lifeCycle, reportError, pageExitObservable, session)

packages/logs/src/domain/assembly.ts

@@ -12,7 +12,7 @@ export function startLogsAssembly(
   sessionManager: LogsSessionManager,
   configuration: LogsConfiguration,
   lifeCycle: LifeCycle,
-  buildCommonContext: () => CommonContext,
+  getCommonContext: () => CommonContext,
   reportError: (error: RawError) => void
 ) {
   const statusWithCustom = (STATUSES as string[]).concat(['custom'])
@@ -31,7 +31,7 @@ export function startLogsAssembly(
         return
       }
 
-      const commonContext = savedCommonContext || buildCommonContext()
+      const commonContext = savedCommonContext || getCommonContext()
       const log = combine(
         {
           service: configuration.service,

packages/logs/src/domain/contexts/commonContext.ts

@@ -0,0 +1,16 @@
+import type { ContextManager } from '@datadog/browser-core'
+import type { CommonContext } from '../../rawLogsEvent.types'
+
+export function buildCommonContext(
+  globalContextManager: ContextManager,
+  userContextManager: ContextManager
+): CommonContext {
+  return {
+    view: {
+      referrer: document.referrer,
+      url: window.location.href,
+    },
+    context: globalContextManager.getContext(),
+    user: userContextManager.getContext(),
+  }
+}

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

@@ -209,7 +209,7 @@ describe('rum public api', () => {
           rumPublicApi.init(DEFAULT_INIT_CONFIGURATION)
 
           expect(startDeflateWorkerSpy).not.toHaveBeenCalled()
-          const createEncoder: (streamId: DeflateEncoderStreamId) => Encoder = startRumSpy.calls.mostRecent().args[7]
+          const createEncoder: (streamId: DeflateEncoderStreamId) => Encoder = startRumSpy.calls.mostRecent().args[6]
           expect(createEncoder).toBe(createIdentityEncoder)
         })
       })
@@ -222,7 +222,7 @@ describe('rum public api', () => {
           })
 
           expect(startDeflateWorkerSpy).toHaveBeenCalledTimes(1)
-          const createEncoder: (streamId: DeflateEncoderStreamId) => Encoder = startRumSpy.calls.mostRecent().args[7]
+          const createEncoder: (streamId: DeflateEncoderStreamId) => Encoder = startRumSpy.calls.mostRecent().args[6]
           expect(createEncoder).not.toBe(createIdentityEncoder)
         })
 
@@ -896,7 +896,7 @@ describe('rum public api', () => {
 
         rumPublicApi.init(MANUAL_CONFIGURATION)
         expect(startRumSpy).toHaveBeenCalled()
-        const initialViewOptions: ViewOptions | undefined = startRumSpy.calls.argsFor(0)[6]
+        const initialViewOptions: ViewOptions | undefined = startRumSpy.calls.argsFor(0)[5]
         expect(initialViewOptions).toEqual({ name: 'foo' })
         expect(recorderApiOnRumStartSpy).toHaveBeenCalled()
         expect(startViewSpy).not.toHaveBeenCalled()
@@ -909,7 +909,7 @@ describe('rum public api', () => {
 
         rumPublicApi.startView('foo')
         expect(startRumSpy).toHaveBeenCalled()
-        const initialViewOptions: ViewOptions | undefined = startRumSpy.calls.argsFor(0)[6]
+        const initialViewOptions: ViewOptions | undefined = startRumSpy.calls.argsFor(0)[5]
         expect(initialViewOptions).toEqual({ name: 'foo' })
         expect(recorderApiOnRumStartSpy).toHaveBeenCalled()
         expect(startViewSpy).not.toHaveBeenCalled()
@@ -921,7 +921,7 @@ describe('rum public api', () => {
         rumPublicApi.startView('bar')
 
         expect(startRumSpy).toHaveBeenCalled()
-        const initialViewOptions: ViewOptions | undefined = startRumSpy.calls.argsFor(0)[6]
+        const initialViewOptions: ViewOptions | undefined = startRumSpy.calls.argsFor(0)[5]
         expect(initialViewOptions).toEqual({ name: 'foo' })
         expect(recorderApiOnRumStartSpy).toHaveBeenCalled()
         expect(startViewSpy).toHaveBeenCalled()

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

@@ -97,6 +97,10 @@ export function makeRumPublicApi(
   )
   let userContextManager = createContextManager(customerDataTrackerManager.getOrCreateTracker(CustomerDataType.User))
 
+  function getCommonContext() {
+    return buildCommonContext(globalContextManager, userContextManager, recorderApi)
+  }
+
   let getInternalContextStrategy: StartRumResult['getInternalContext'] = () => undefined
   let getInitConfigurationStrategy = (): InitConfiguration | undefined => undefined
   let stopSessionStrategy: () => void = noop
@@ -109,16 +113,10 @@ export function makeRumPublicApi(
   let startViewStrategy: StartRumResult['startView'] = (options, startClocks = clocksNow()) => {
     bufferApiCalls.add(() => startViewStrategy(options, startClocks))
   }
-  let addActionStrategy: StartRumResult['addAction'] = (
-    action,
-    commonContext = buildCommonContext(globalContextManager, userContextManager, recorderApi)
-  ) => {
+  let addActionStrategy: StartRumResult['addAction'] = (action, commonContext = getCommonContext()) => {
     bufferApiCalls.add(() => addActionStrategy(action, commonContext))
   }
-  let addErrorStrategy: StartRumResult['addError'] = (
-    providedError,
-    commonContext = buildCommonContext(globalContextManager, userContextManager, recorderApi)
-  ) => {
+  let addErrorStrategy: StartRumResult['addError'] = (providedError, commonContext = getCommonContext()) => {
     bufferApiCalls.add(() => addErrorStrategy(providedError, commonContext))
   }
 
@@ -238,8 +236,7 @@ export function makeRumPublicApi(
       configuration,
       recorderApi,
       customerDataTrackerManager,
-      globalContextManager,
-      userContextManager,
+      getCommonContext,
       initialViewOptions,
       deflateWorker && createDeflateEncoder
         ? (streamId) => createDeflateEncoder(configuration, deflateWorker!, streamId)

packages/rum-core/src/boot/startRum.spec.ts

@@ -1,6 +1,5 @@
 import type { Observable, RawError, Duration, RelativeTime } from '@datadog/browser-core'
 import {
-  createContextManager,
   stopSessionManager,
   toServerDuration,
   ONE_SECOND,
@@ -10,7 +9,6 @@ import {
   relativeNow,
   createIdentityEncoder,
   createCustomerDataTracker,
-  CustomerDataType,
 } from '@datadog/browser-core'
 import {
   createNewEvent,
@@ -334,8 +332,7 @@ describe('view events', () => {
         configuration,
         noopRecorderApi,
         customerDataTrackerManager,
-        createContextManager(customerDataTrackerManager.getOrCreateTracker(CustomerDataType.GlobalContext)),
-        createContextManager(customerDataTrackerManager.getOrCreateTracker(CustomerDataType.User)),
+        () => ({ user: {}, context: {}, hasReplay: undefined }),
         undefined,
         createIdentityEncoder
       )

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

@@ -2,7 +2,6 @@ import type {
   Observable,
   TelemetryEvent,
   RawError,
-  ContextManager,
   DeflateEncoderStreamId,
   Encoder,
   CustomerDataTrackerManager,
@@ -44,7 +43,6 @@ import { startFeatureFlagContexts } from '../domain/contexts/featureFlagContext'
 import { startCustomerDataTelemetry } from '../domain/startCustomerDataTelemetry'
 import { startPageStateHistory } from '../domain/contexts/pageStateHistory'
 import type { CommonContext } from '../domain/contexts/commonContext'
-import { buildCommonContext } from '../domain/contexts/commonContext'
 import { startDisplayContext } from '../domain/contexts/displayContext'
 import type { RecorderApi } from './rumPublicApi'
 
@@ -53,8 +51,7 @@ export function startRum(
   configuration: RumConfiguration,
   recorderApi: RecorderApi,
   customerDataTrackerManager: CustomerDataTrackerManager,
-  globalContextManager: ContextManager,
-  userContextManager: ContextManager,
+  getCommonContext: () => CommonContext,
   initialViewOptions: ViewOptions | undefined,
   createEncoder: (streamId: DeflateEncoderStreamId) => Encoder
 ) {
@@ -128,7 +125,7 @@ export function startRum(
     session,
     locationChangeObservable,
     domMutationObservable,
-    () => buildCommonContext(globalContextManager, userContextManager, recorderApi),
+    getCommonContext,
     reportError
   )
   cleanupTasks.push(stopRumEventCollection)
@@ -201,7 +198,7 @@ export function startRumEventCollection(
   sessionManager: RumSessionManager,
   locationChangeObservable: Observable<LocationChange>,
   domMutationObservable: Observable<void>,
-  buildCommonContext: () => CommonContext,
+  getCommonContext: () => CommonContext,
   reportError: (error: RawError) => void
 ) {
   const viewContexts = startViewContexts(lifeCycle)
@@ -226,7 +223,7 @@ export function startRumEventCollection(
     urlContexts,
     actionContexts,
     displayContext,
-    buildCommonContext,
+    getCommonContext,
     reportError
   )
 

packages/rum-core/src/domain/assembly.ts

@@ -67,7 +67,7 @@ export function startRumAssembly(
   urlContexts: UrlContexts,
   actionContexts: ActionContexts,
   displayContext: DisplayContext,
-  buildCommonContext: () => CommonContext,
+  getCommonContext: () => CommonContext,
   reportError: (error: RawError) => void
 ) {
   modifiableFieldPathsByEvent = {
@@ -124,7 +124,7 @@ export function startRumAssembly(
       const urlContext = urlContexts.findUrl(startTime)
       const session = sessionManager.findTrackedSession(startTime)
       if (session && viewContext && urlContext) {
-        const commonContext = savedCommonContext || buildCommonContext()
+        const commonContext = savedCommonContext || getCommonContext()
         const actionId = actionContexts.findActionId(startTime)
 
         const rumContext: RumContext = {