♻️ [RUM-8123] Introduce a hook to assemble events

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

@@ -39,12 +39,14 @@ import { startViewCollection } from '../domain/view/viewCollection'
 import type { RumEvent, RumViewEvent } from '../rumEvent.types'
 import type { LocationChange } from '../browser/locationChangeObservable'
 import { startLongAnimationFrameCollection } from '../domain/longAnimationFrame/longAnimationFrameCollection'
-import type { RumSessionManager } from '..'
+import { startViewHistory, type RumSessionManager } from '..'
 import type { RumConfiguration } from '../domain/configuration'
 import { RumEventType } from '../rawRumEvent.types'
 import { startFeatureFlagContexts } from '../domain/contexts/featureFlagContext'
 import type { PageStateHistory } from '../domain/contexts/pageStateHistory'
 import { createCustomVitalsState } from '../domain/vital/vitalCollection'
+import { createHooks } from '../hooks'
+import { startUrlContexts } from '../domain/contexts/urlContexts'
 import { startRum, startRumEventCollection } from './startRum'
 
 function collectServerEvents(lifeCycle: LifeCycle) {
@@ -66,16 +68,20 @@ function startRumStub(
   pageStateHistory: PageStateHistory,
   reportError: (error: RawError) => void
 ) {
+  const hooks = createHooks()
+  const viewHistory = startViewHistory(lifeCycle)
+  const urlContexts = startUrlContexts(lifeCycle, hooks, locationChangeObservable, location)
+
   const { stop: rumEventCollectionStop } = startRumEventCollection(
     lifeCycle,
+    hooks,
     configuration,
-    location,
     sessionManager,
     pageStateHistory,
-    locationChangeObservable,
     domMutationObservable,
     startFeatureFlagContexts(lifeCycle, createCustomerDataTracker(noop)),
     windowOpenObservable,
+    viewHistory,
     () => ({
       context: {},
       user: {},
@@ -85,18 +91,22 @@ function startRumStub(
   )
   const { stop: viewCollectionStop } = startViewCollection(
     lifeCycle,
+    hooks,
     configuration,
     location,
     domMutationObservable,
     windowOpenObservable,
     locationChangeObservable,
     pageStateHistory,
-    noopRecorderApi
+    noopRecorderApi,
+    viewHistory
   )
 
   startLongAnimationFrameCollection(lifeCycle, configuration)
   return {
     stop: () => {
+      viewHistory.stop()
+      urlContexts.stop()
       rumEventCollectionStop()
       viewCollectionStop()
     },

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

@@ -23,6 +23,7 @@ import { createWindowOpenObservable } from '../browser/windowOpenObservable'
 import { startRumAssembly } from '../domain/assembly'
 import { startInternalContext } from '../domain/contexts/internalContext'
 import { LifeCycle, LifeCycleEventType } from '../domain/lifeCycle'
+import type { ViewHistory } from '../domain/contexts/viewHistory'
 import { startViewHistory } from '../domain/contexts/viewHistory'
 import { startRequestCollection } from '../domain/requestCollection'
 import { startActionCollection } from '../domain/action/actionCollection'
@@ -34,7 +35,6 @@ import { startRumSessionManager, startRumSessionManagerStub } from '../domain/ru
 import { startRumBatch } from '../transport/startRumBatch'
 import { startRumEventBridge } from '../transport/startRumEventBridge'
 import { startUrlContexts } from '../domain/contexts/urlContexts'
-import type { LocationChange } from '../browser/locationChangeObservable'
 import { createLocationChangeObservable } from '../browser/locationChangeObservable'
 import type { RumConfiguration } from '../domain/configuration'
 import type { ViewOptions } from '../domain/view/trackViews'
@@ -51,6 +51,8 @@ import { startCiVisibilityContext } from '../domain/contexts/ciVisibilityContext
 import { startLongAnimationFrameCollection } from '../domain/longAnimationFrame/longAnimationFrameCollection'
 import { RumPerformanceEntryType } from '../browser/performanceObservable'
 import { startLongTaskCollection } from '../domain/longTask/longTaskCollection'
+import type { Hooks } from '../hooks'
+import { createHooks } from '../hooks'
 import type { RecorderApi } from './rumPublicApi'
 
 export type StartRum = typeof startRum
@@ -72,6 +74,7 @@ export function startRum(
 ) {
   const cleanupTasks: Array<() => void> = []
   const lifeCycle = new LifeCycle()
+  const hooks = createHooks()
 
   lifeCycle.subscribe(LifeCycleEventType.RUM_EVENT_COLLECTED, (event) => sendToExtension('rum', event))
 
@@ -128,25 +131,26 @@ export function startRum(
   const domMutationObservable = createDOMMutationObservable()
   const locationChangeObservable = createLocationChangeObservable(configuration, location)
   const pageStateHistory = startPageStateHistory(configuration)
+  const viewHistory = startViewHistory(lifeCycle)
+  const urlContexts = startUrlContexts(lifeCycle, hooks, locationChangeObservable, location)
+
   const { observable: windowOpenObservable, stop: stopWindowOpen } = createWindowOpenObservable()
   cleanupTasks.push(stopWindowOpen)
 
   const {
-    viewHistory,
-    urlContexts,
     actionContexts,
     addAction,
     stop: stopRumEventCollection,
   } = startRumEventCollection(
     lifeCycle,
+    hooks,
     configuration,
-    location,
     session,
     pageStateHistory,
-    locationChangeObservable,
     domMutationObservable,
     featureFlagContexts,
     windowOpenObservable,
+    viewHistory,
     getCommonContext,
     reportError
   )
@@ -164,15 +168,18 @@ export function startRum(
     stop: stopViewCollection,
   } = startViewCollection(
     lifeCycle,
+    hooks,
     configuration,
     location,
     domMutationObservable,
     windowOpenObservable,
     locationChangeObservable,
     pageStateHistory,
     recorderApi,
+    viewHistory,
     initialViewOptions
   )
+
   cleanupTasks.push(stopViewCollection)
 
   const { stop: stopResourceCollection } = startResourceCollection(lifeCycle, configuration, pageStateHistory)
@@ -235,20 +242,17 @@ function startRumTelemetry(configuration: RumConfiguration) {
 
 export function startRumEventCollection(
   lifeCycle: LifeCycle,
+  hooks: Hooks,
   configuration: RumConfiguration,
-  location: Location,
   sessionManager: RumSessionManager,
   pageStateHistory: PageStateHistory,
-  locationChangeObservable: Observable<LocationChange>,
   domMutationObservable: Observable<void>,
   featureFlagContexts: FeatureFlagContexts,
   windowOpenObservable: Observable<void>,
+  viewHistory: ViewHistory,
   getCommonContext: () => CommonContext,
   reportError: (error: RawError) => void
 ) {
-  const viewHistory = startViewHistory(lifeCycle)
-  const urlContexts = startUrlContexts(lifeCycle, locationChangeObservable, location)
-
   const actionCollection = startActionCollection(
     lifeCycle,
     domMutationObservable,
@@ -263,9 +267,9 @@ export function startRumEventCollection(
   startRumAssembly(
     configuration,
     lifeCycle,
+    hooks,
     sessionManager,
     viewHistory,
-    urlContexts,
     actionCollection.actionContexts,
     displayContext,
     ciVisibilityContext,
@@ -275,17 +279,13 @@ export function startRumEventCollection(
   )
 
   return {
-    viewHistory,
     pageStateHistory,
-    urlContexts,
     addAction: actionCollection.addAction,
     actionContexts: actionCollection.actionContexts,
     stop: () => {
       actionCollection.stop()
       ciVisibilityContext.stop()
       displayContext.stop()
-      urlContexts.stop()
-      viewHistory.stop()
       pageStateHistory.stop()
     },
   }