Skip to content

♻️ inline lazyLoadRecorder into postStartStrategy using mockable() #4326

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
BenoitZugmeyer merged 1 commit into from
Mar 25, 2026
Merged

♻️ inline lazyLoadRecorder into postStartStrategy using mockable() #4326

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/rum/src/boot/postStartStrategy.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import { asyncRunOnReadyState, monitorError, Observable } from '@datadog/browser
import { getSessionReplayLink } from '../domain/getSessionReplayLink'
import { startRecorderInitTelemetry } from '../domain/startRecorderInitTelemetry'
import type { startRecording } from './startRecording'
import { lazyLoadRecorder } from './lazyLoadRecorder'

export type StartRecording = typeof startRecording

Expand Down Expand Up @@ -48,7 +49,6 @@ export function createPostStartStrategy(
lifeCycle: LifeCycle,
sessionManager: RumSessionManager,
viewHistory: ViewHistory,
loadRecorder: () => Promise<StartRecording | undefined>,
getOrCreateDeflateEncoder: () => DeflateEncoder | undefined,
telemetry: Telemetry
): Strategy {
Expand All @@ -75,7 +75,7 @@ export function createPostStartStrategy(
observable.notify({ type: 'start', forced })

const [startRecordingImpl] = await Promise.all([
notifyWhenSettled(observable, { type: 'recorder-settled' }, loadRecorder()),
notifyWhenSettled(observable, { type: 'recorder-settled' }, lazyLoadRecorder()),
notifyWhenSettled(observable, { type: 'document-ready' }, asyncRunOnReadyState(configuration, 'interactive')),
])

Expand Down
61 changes: 31 additions & 30 deletions packages/rum/src/boot/recorderApi.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,13 @@ import * as replayStats from '../domain/replayStats'
import { type RecorderInitMetrics } from '../domain/startRecorderInitTelemetry'
import { makeRecorderApi } from './recorderApi'
import type { StartRecording } from './postStartStrategy'
import { importRecorder } from './lazyLoadRecorder'

describe('makeRecorderApi', () => {
let lifeCycle: LifeCycle
let recorderApi: RecorderApi
let startRecordingSpy: jasmine.Spy
let loadRecorderSpy: jasmine.Spy<() => Promise<StartRecording>>
let importRecorderSpy: jasmine.Spy<() => Promise<StartRecording>>
let stopRecordingSpy: jasmine.Spy<() => void>
let mockWorker: MockWorker
let createDeflateWorkerSpy: jasmine.Spy<CreateDeflateWorker>
Expand All @@ -59,13 +60,13 @@ describe('makeRecorderApi', () => {
lifeCycle = new LifeCycle()
stopRecordingSpy = jasmine.createSpy('stopRecording')
startRecordingSpy = jasmine.createSpy('startRecording')
loadRecorderSpy = jasmine.createSpy('loadRecorder')
importRecorderSpy = replaceMockableWithSpy(importRecorder)

if (loadRecorderError) {
loadRecorderSpy.and.resolveTo(undefined)
importRecorderSpy.and.resolveTo(undefined)
} else {
// Workaround because using resolveTo(startRecordingSpy) was not working
loadRecorderSpy.and.resolveTo((...args: any) => {
importRecorderSpy.and.resolveTo((...args: any) => {
startRecordingSpy(...args)
return {
stop: stopRecordingSpy,
Expand All @@ -77,7 +78,7 @@ describe('makeRecorderApi', () => {
startSessionReplayRecordingManually: startSessionReplayRecordingManually ?? false,
})

recorderApi = makeRecorderApi(loadRecorderSpy)
recorderApi = makeRecorderApi()
rumInit = ({ worker } = {}) => {
recorderApi.onRumStart(
lifeCycle,
Expand All @@ -98,7 +99,7 @@ describe('makeRecorderApi', () => {
describe('with automatic start', () => {
it('starts recording when init() is called', async () => {
setupRecorderApi()
expect(loadRecorderSpy).not.toHaveBeenCalled()
expect(importRecorderSpy).not.toHaveBeenCalled()
expect(startRecordingSpy).not.toHaveBeenCalled()
expect(await telemetry.hasEvents()).toEqual(false)
rumInit()
Expand All @@ -112,7 +113,7 @@ describe('makeRecorderApi', () => {
const { triggerOnDomLoaded } = mockDocumentReadyState()
rumInit()

expect(loadRecorderSpy).toHaveBeenCalled()
expect(importRecorderSpy).toHaveBeenCalled()
expect(startRecordingSpy).not.toHaveBeenCalled()
expect(await telemetry.hasEvents()).toEqual(false)

Expand All @@ -127,11 +128,11 @@ describe('makeRecorderApi', () => {
describe('with manual start', () => {
it('does not start recording when init() is called', async () => {
setupRecorderApi({ startSessionReplayRecordingManually: true })
expect(loadRecorderSpy).not.toHaveBeenCalled()
expect(importRecorderSpy).not.toHaveBeenCalled()
expect(startRecordingSpy).not.toHaveBeenCalled()
expect(await telemetry.hasEvents()).toEqual(false)
rumInit()
expect(loadRecorderSpy).not.toHaveBeenCalled()
expect(importRecorderSpy).not.toHaveBeenCalled()
expect(startRecordingSpy).not.toHaveBeenCalled()
expect(await telemetry.hasEvents()).toEqual(false)
})
Expand All @@ -140,11 +141,11 @@ describe('makeRecorderApi', () => {
setupRecorderApi({ startSessionReplayRecordingManually: true })
const { triggerOnDomLoaded } = mockDocumentReadyState()
rumInit()
expect(loadRecorderSpy).not.toHaveBeenCalled()
expect(importRecorderSpy).not.toHaveBeenCalled()
expect(startRecordingSpy).not.toHaveBeenCalled()
expect(await telemetry.hasEvents()).toEqual(false)
triggerOnDomLoaded()
expect(loadRecorderSpy).not.toHaveBeenCalled()
expect(importRecorderSpy).not.toHaveBeenCalled()
expect(startRecordingSpy).not.toHaveBeenCalled()
expect(await telemetry.hasEvents()).toEqual(false)
})
Expand Down Expand Up @@ -183,7 +184,7 @@ describe('makeRecorderApi', () => {
rumInit()
recorderApi.start()

expect(loadRecorderSpy).not.toHaveBeenCalled()
expect(importRecorderSpy).not.toHaveBeenCalled()
expect(startRecordingSpy).not.toHaveBeenCalled()
})

Expand All @@ -194,7 +195,7 @@ describe('makeRecorderApi', () => {
})
rumInit()
recorderApi.start()
expect(loadRecorderSpy).not.toHaveBeenCalled()
expect(importRecorderSpy).not.toHaveBeenCalled()
expect(startRecordingSpy).not.toHaveBeenCalled()
})

Expand Down Expand Up @@ -232,7 +233,7 @@ describe('makeRecorderApi', () => {
setupRecorderApi({ loadRecorderError: true })
rumInit()

expect(loadRecorderSpy).toHaveBeenCalled()
expect(importRecorderSpy).toHaveBeenCalled()

await new Promise((resolve) => setTimeout(resolve, 1000))

Expand All @@ -247,7 +248,7 @@ describe('makeRecorderApi', () => {
createDeflateWorkerSpy.and.throwError('Crash')
recorderApi.start()

expect(loadRecorderSpy).toHaveBeenCalled()
expect(importRecorderSpy).toHaveBeenCalled()
await collectAsyncCalls(createDeflateWorkerSpy, 1)

expect(startRecordingSpy).not.toHaveBeenCalled()
Expand All @@ -264,7 +265,7 @@ describe('makeRecorderApi', () => {
setupRecorderApi({ startSessionReplayRecordingManually: true })
rumInit()
recorderApi.start()
expect(loadRecorderSpy).toHaveBeenCalled()
expect(importRecorderSpy).toHaveBeenCalled()

await collectAsyncCalls(startRecordingSpy, 1)
mockWorker.dispatchErrorEvent()
Expand Down Expand Up @@ -315,7 +316,7 @@ describe('makeRecorderApi', () => {
rumInit()
recorderApi.start()

expect(loadRecorderSpy).not.toHaveBeenCalled()
expect(importRecorderSpy).not.toHaveBeenCalled()
expect(startRecordingSpy).not.toHaveBeenCalled()
})
})
Expand All @@ -336,7 +337,7 @@ describe('makeRecorderApi', () => {
setupRecorderApi({ startSessionReplayRecordingManually: true })
recorderApi.start()
rumInit()
expect(loadRecorderSpy).not.toHaveBeenCalled()
expect(importRecorderSpy).not.toHaveBeenCalled()
expect(startRecordingSpy).not.toHaveBeenCalled()
})
})
Expand All @@ -361,7 +362,7 @@ describe('makeRecorderApi', () => {
recorderApi.stop()
triggerOnDomLoaded()

await collectAsyncCalls(loadRecorderSpy, 1)
await collectAsyncCalls(importRecorderSpy, 1)

expect(startRecordingSpy).not.toHaveBeenCalled()
})
Expand Down Expand Up @@ -399,7 +400,7 @@ describe('makeRecorderApi', () => {
lifeCycle.notify(LifeCycleEventType.SESSION_EXPIRED)
lifeCycle.notify(LifeCycleEventType.SESSION_RENEWED)

expect(loadRecorderSpy).not.toHaveBeenCalled()
expect(importRecorderSpy).not.toHaveBeenCalled()
expect(startRecordingSpy).not.toHaveBeenCalled()
})
})
Expand All @@ -415,7 +416,7 @@ describe('makeRecorderApi', () => {
lifeCycle.notify(LifeCycleEventType.SESSION_EXPIRED)
lifeCycle.notify(LifeCycleEventType.SESSION_RENEWED)

expect(loadRecorderSpy).not.toHaveBeenCalled()
expect(importRecorderSpy).not.toHaveBeenCalled()
expect(startRecordingSpy).not.toHaveBeenCalled()
expect(stopRecordingSpy).not.toHaveBeenCalled()
})
Expand All @@ -431,7 +432,7 @@ describe('makeRecorderApi', () => {
lifeCycle.notify(LifeCycleEventType.SESSION_EXPIRED)
lifeCycle.notify(LifeCycleEventType.SESSION_RENEWED)

expect(loadRecorderSpy).not.toHaveBeenCalled()
expect(importRecorderSpy).not.toHaveBeenCalled()
expect(startRecordingSpy).not.toHaveBeenCalled()
expect(stopRecordingSpy).not.toHaveBeenCalled()
})
Expand All @@ -451,7 +452,7 @@ describe('makeRecorderApi', () => {
lifeCycle.notify(LifeCycleEventType.SESSION_EXPIRED)
expect(stopRecordingSpy).toHaveBeenCalled()
lifeCycle.notify(LifeCycleEventType.SESSION_RENEWED)
expect(loadRecorderSpy).toHaveBeenCalledTimes(1)
expect(importRecorderSpy).toHaveBeenCalledTimes(1)
expect(startRecordingSpy).toHaveBeenCalledTimes(1)
})

Expand All @@ -463,7 +464,7 @@ describe('makeRecorderApi', () => {
lifeCycle.notify(LifeCycleEventType.SESSION_EXPIRED)
lifeCycle.notify(LifeCycleEventType.SESSION_RENEWED)
triggerOnDomLoaded()
expect(loadRecorderSpy).toHaveBeenCalled()
expect(importRecorderSpy).toHaveBeenCalled()
expect(startRecordingSpy).not.toHaveBeenCalled()
})
})
Expand All @@ -481,7 +482,7 @@ describe('makeRecorderApi', () => {
lifeCycle.notify(LifeCycleEventType.SESSION_EXPIRED)
expect(stopRecordingSpy).toHaveBeenCalled()
lifeCycle.notify(LifeCycleEventType.SESSION_RENEWED)
expect(loadRecorderSpy).toHaveBeenCalledTimes(1)
expect(importRecorderSpy).toHaveBeenCalledTimes(1)
expect(startRecordingSpy).toHaveBeenCalledTimes(1)
})
})
Expand All @@ -500,7 +501,7 @@ describe('makeRecorderApi', () => {
lifeCycle.notify(LifeCycleEventType.SESSION_RENEWED)
await collectAsyncCalls(startRecordingSpy, 2)

expect(loadRecorderSpy).toHaveBeenCalledTimes(2)
expect(importRecorderSpy).toHaveBeenCalledTimes(2)
expect(startRecordingSpy).toHaveBeenCalledTimes(2)
})

Expand All @@ -512,7 +513,7 @@ describe('makeRecorderApi', () => {
expect(stopRecordingSpy).toHaveBeenCalledTimes(1)
lifeCycle.notify(LifeCycleEventType.SESSION_EXPIRED)
lifeCycle.notify(LifeCycleEventType.SESSION_RENEWED)
expect(loadRecorderSpy).toHaveBeenCalledTimes(1)
expect(importRecorderSpy).toHaveBeenCalledTimes(1)
expect(startRecordingSpy).toHaveBeenCalledTimes(1)
expect(stopRecordingSpy).toHaveBeenCalledTimes(1)
})
Expand Down Expand Up @@ -541,7 +542,7 @@ describe('makeRecorderApi', () => {
sessionManager.setTrackedWithSessionReplay()
lifeCycle.notify(LifeCycleEventType.SESSION_EXPIRED)
lifeCycle.notify(LifeCycleEventType.SESSION_RENEWED)
expect(loadRecorderSpy).not.toHaveBeenCalled()
expect(importRecorderSpy).not.toHaveBeenCalled()
expect(startRecordingSpy).not.toHaveBeenCalled()
expect(stopRecordingSpy).not.toHaveBeenCalled()
})
Expand All @@ -557,7 +558,7 @@ describe('makeRecorderApi', () => {
sessionManager.setTrackedWithoutSessionReplay()
lifeCycle.notify(LifeCycleEventType.SESSION_EXPIRED)
lifeCycle.notify(LifeCycleEventType.SESSION_RENEWED)
expect(loadRecorderSpy).not.toHaveBeenCalled()
expect(importRecorderSpy).not.toHaveBeenCalled()
expect(startRecordingSpy).not.toHaveBeenCalled()
expect(stopRecordingSpy).not.toHaveBeenCalled()
})
Expand All @@ -572,7 +573,7 @@ describe('makeRecorderApi', () => {
rumInit()
lifeCycle.notify(LifeCycleEventType.SESSION_EXPIRED)
lifeCycle.notify(LifeCycleEventType.SESSION_RENEWED)
expect(loadRecorderSpy).not.toHaveBeenCalled()
expect(importRecorderSpy).not.toHaveBeenCalled()
expect(startRecordingSpy).not.toHaveBeenCalled()
expect(stopRecordingSpy).not.toHaveBeenCalled()
})
Expand Down
4 changes: 1 addition & 3 deletions packages/rum/src/boot/recorderApi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,10 @@ import {
startDeflateWorker,
} from '../domain/deflate'
import { isBrowserSupported } from './isBrowserSupported'
import type { StartRecording } from './postStartStrategy'
import { createPostStartStrategy } from './postStartStrategy'
import { createPreStartStrategy } from './preStartStrategy'

export function makeRecorderApi(loadRecorder: () => Promise<StartRecording | undefined>): RecorderApi {
export function makeRecorderApi(): RecorderApi {
if ((canUseEventBridge() && !bridgeSupports(BridgeCapability.RECORDS)) || !isBrowserSupported()) {
return {
start: noop,
Expand Down Expand Up @@ -101,7 +100,6 @@ export function makeRecorderApi(loadRecorder: () => Promise<StartRecording | und
lifeCycle,
sessionManager,
viewHistory,
loadRecorder,
getOrCreateDeflateEncoder,
telemetry
)
Expand Down
3 changes: 1 addition & 2 deletions packages/rum/src/entries/internalSynthetics.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,14 @@
*/
import { makeRumPublicApi } from '@datadog/browser-rum-core'
import { makeRecorderApi } from '../boot/recorderApi'
import { lazyLoadRecorder } from '../boot/lazyLoadRecorder'
import { makeProfilerApi } from '../boot/profilerApi'

export { DefaultPrivacyLevel } from '@datadog/browser-core'

// Disable the rule that forbids potential side effects, because we know that those functions don't
// have side effects.
/* eslint-disable local-rules/disallow-side-effects */
const recorderApi = makeRecorderApi(lazyLoadRecorder)
const recorderApi = makeRecorderApi()
const profilerApi = makeProfilerApi()
export const datadogRum = makeRumPublicApi(recorderApi, profilerApi, {
ignoreInitIfSyntheticsWillInjectRum: false,
Expand Down
3 changes: 1 addition & 2 deletions packages/rum/src/entries/main.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ import type { RumPublicApi } from '@datadog/browser-rum-core'
import { makeRumPublicApi } from '@datadog/browser-rum-core'
import { makeRecorderApi } from '../boot/recorderApi'
import { createDeflateEncoder, startDeflateWorker } from '../domain/deflate'
import { lazyLoadRecorder } from '../boot/lazyLoadRecorder'
import { makeProfilerApi } from '../boot/profilerApi'

export type {
Expand Down Expand Up @@ -73,7 +72,7 @@ export type {
RumLongTaskEventDomainContext,
} from '@datadog/browser-rum-core'

const recorderApi = makeRecorderApi(lazyLoadRecorder)
const recorderApi = makeRecorderApi()

const profilerApi = makeProfilerApi()

Expand Down
Loading