Skip to content

🐛 [RUM Profiler] Fix profiler stuck when session expires #4152

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
thomasbertet merged 4 commits into from
Feb 11, 2026
Merged

🐛 [RUM Profiler] Fix profiler stuck when session expires #4152

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0c96814
🐛 [PROF-13701] Fix profiler stuck when session expires while paused
thomasbertet Feb 9, 2026
e1f9df7
🐛 [PROF-13701] Fix race condition when session renews during stop
thomasbertet Feb 9, 2026
7e19e62
[PROF-13701] Refactor to sync state changes with fire-and-forget data…
thomasbertet Feb 9, 2026
2cccbb3
[PROF-13701] Cleanup tests: remove overkill waitForBoolean after sync…
thomasbertet Feb 9, 2026
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
2 changes: 1 addition & 1 deletion packages/rum/src/boot/profilerApi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ export function makeProfilerApi(): ProfilerApi {
return {
onRumStart,
stop: () => {
profiler?.stop().catch(monitorError)
profiler?.stop()
},
}
}
205 changes: 149 additions & 56 deletions packages/rum/src/domain/profiling/profiler.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import {
DEFAULT_FETCH_MOCK,
readFormDataRequest,
mockClock,
waitNextMicrotask,
} from '@datadog/browser-core/test'
import { LONG_TASK_ID_HISTORY_TIME_OUT_DELAY } from 'packages/rum-core/src/domain/longTask/longTaskCollection'
import { createRumSessionManagerMock, mockRumConfiguration, mockViewHistory } from '../../../../rum-core/test'
Expand Down Expand Up @@ -135,14 +136,15 @@ describe('profiler', () => {

expect(profilingContextManager.get()?.status).toBe('running')

// Stop collection of profile.
await profiler.stop()

// Wait for stop of collection.
await waitForBoolean(() => profiler.isStopped())
// Stop collection of profile (sync - state changes immediately)
profiler.stop()

expect(profiler.isStopped()).toBe(true)
expect(profilingContextManager.get()?.status).toBe('stopped')

// Wait for data collection to complete (async fire-and-forget)
await waitForBoolean(() => interceptor.requests.length >= 1)

expect(interceptor.requests.length).toBe(1)

const request = await readFormDataRequest<ProfileEventPayload>(interceptor.requests[0])
Expand All @@ -168,6 +170,9 @@ describe('profiler', () => {
// From an external point of view, the profiler is still running, but it's not collecting data.
expect(profilingContextManager.get()?.status).toBe('running')

// Wait for data collection to complete (async fire-and-forget)
await waitForBoolean(() => interceptor.requests.length >= 1)

// Assert that the profiler has collected data on pause.
expect(interceptor.requests.length).toBe(1)

Expand All @@ -179,13 +184,15 @@ describe('profiler', () => {
await waitForBoolean(() => profiler.isRunning())
expect(profilingContextManager.get()?.status).toBe('running')

// Stop collection of profile.
await profiler.stop()
// Stop collection of profile (sync - state changes immediately)
profiler.stop()

// Wait for stop of collection.
await waitForBoolean(() => profiler.isStopped())
expect(profiler.isStopped()).toBe(true)
expect(profilingContextManager.get()?.status).toBe('stopped')

// Wait for data collection to complete (async fire-and-forget)
await waitForBoolean(() => interceptor.requests.length >= 2)

expect(interceptor.requests.length).toBe(2)

// Check the the sendProfilesSpy was called with the mocked trace
Expand Down Expand Up @@ -219,10 +226,13 @@ describe('profiler', () => {
entryType: RumPerformanceEntryType.LONG_ANIMATION_FRAME,
})

// Stop first profiling session.
// Stop first profiling session (sync - state changes immediately)
clock.tick(105)
await profiler.stop()
await waitForBoolean(() => profiler.isStopped())
profiler.stop()
expect(profiler.isStopped()).toBe(true)

// Flush microtasks for first session's data collection
await waitNextMicrotask()

// start a new profiling session
profiler.start()
Expand All @@ -237,12 +247,18 @@ describe('profiler', () => {

clock.tick(500)

// stop the second profiling session
await profiler.stop()
await waitForBoolean(() => profiler.isStopped())
// stop the second profiling session (sync - state changes immediately)
profiler.stop()
expect(profiler.isStopped()).toBe(true)
expect(profilingContextManager.get()?.status).toBe('stopped')

// Data collection uses Promises (microtasks), not setTimeout.
// With mockClock(), we can't use waitForBoolean (which polls via setTimeout).
// Flush microtasks: one for profiler.stop() Promise, one for transport.send()
await waitNextMicrotask()
await waitNextMicrotask()

expect(interceptor.requests.length).toBe(2)
expect(profilingContextManager.get()?.status).toBe('stopped')

const requestOne = await readFormDataRequest<ProfileEventPayload>(interceptor.requests[0])
const requestTwo = await readFormDataRequest<ProfileEventPayload>(interceptor.requests[1])
Expand Down Expand Up @@ -310,14 +326,15 @@ describe('profiler', () => {
},
})

// Stop collection of profile.
await profiler.stop()

// Wait for stop of collection.
await waitForBoolean(() => profiler.isStopped())
// Stop collection of profile (sync - state changes immediately)
profiler.stop()

expect(profiler.isStopped()).toBe(true)
expect(profilingContextManager.get()?.status).toBe('stopped')

// Wait for data collection to complete (async fire-and-forget)
await waitForBoolean(() => interceptor.requests.length >= 1)

const request = await readFormDataRequest<ProfileEventPayload>(interceptor.requests[0])
const views = request['wall-time.json'].views

Expand Down Expand Up @@ -369,6 +386,9 @@ describe('profiler', () => {
// Wait for profiler to pause
await waitForBoolean(() => profiler.isPaused())

// Wait for data collection to complete (async fire-and-forget)
await waitForBoolean(() => interceptor.requests.length >= 1)

// Assert that the profiler has collected data on pause.
expect(interceptor.requests.length).toBe(1)

Expand All @@ -395,13 +415,15 @@ describe('profiler', () => {
await waitForBoolean(() => profiler.isRunning())
expect(profilingContextManager.get()?.status).toBe('running')

// Stop collection of profile.
await profiler.stop()
// Stop collection of profile (sync - state changes immediately)
profiler.stop()

// Wait for stop of collection.
await waitForBoolean(() => profiler.isStopped())
expect(profiler.isStopped()).toBe(true)
expect(profilingContextManager.get()?.status).toBe('stopped')

// Wait for data collection to complete (async fire-and-forget)
await waitForBoolean(() => interceptor.requests.length >= 2)

expect(interceptor.requests.length).toBe(2)

// Check the the sendProfilesSpy was called with the mocked trace
Expand All @@ -420,14 +442,15 @@ describe('profiler', () => {

expect(profilingContextManager.get()?.status).toBe('running')

// Notify that the session has expired
// Notify that the session has expired (sync - state changes immediately)
lifeCycle.notify(LifeCycleEventType.SESSION_EXPIRED)

// Wait for profiler to stop
await waitForBoolean(() => profiler.isStopped())

expect(profiler.isStopped()).toBe(true)
expect(profilingContextManager.get()?.status).toBe('stopped')

// Wait for data collection to complete (async fire-and-forget)
await waitForBoolean(() => interceptor.requests.length >= 1)

// Verify that profiler collected data before stopping
expect(interceptor.requests.length).toBe(1)
})
Expand All @@ -442,17 +465,14 @@ describe('profiler', () => {

expect(profilingContextManager.get()?.status).toBe('running')

// Notify that the session has expired
// Notify that the session has expired (sync - state changes immediately)
lifeCycle.notify(LifeCycleEventType.SESSION_EXPIRED)

// Wait for profiler to stop
await waitForBoolean(() => profiler.isStopped())

expect(profiler.isStopped()).toBe(true)
expect(profilingContextManager.get()?.status).toBe('stopped')

// Change visibility to hidden and back to visible
setVisibilityState('hidden')
await waitForBoolean(() => profiler.isStopped())

setVisibilityState('visible')

Expand All @@ -474,14 +494,15 @@ describe('profiler', () => {

expect(profilingContextManager.get()?.status).toBe('running')

// Notify that the session has expired
// Notify that the session has expired (sync - state changes immediately)
lifeCycle.notify(LifeCycleEventType.SESSION_EXPIRED)

// Wait for profiler to stop
await waitForBoolean(() => profiler.isStopped())

expect(profiler.isStopped()).toBe(true)
expect(profilingContextManager.get()?.status).toBe('stopped')

// Wait for data collection to complete (async fire-and-forget)
await waitForBoolean(() => interceptor.requests.length >= 1)

// Verify that profiler collected data before stopping
expect(interceptor.requests.length).toBe(1)

Expand All @@ -493,10 +514,13 @@ describe('profiler', () => {

expect(profilingContextManager.get()?.status).toBe('running')

// Stop profiler and verify it collected data from the new session
await profiler.stop()
// Stop profiler and verify it collected data from the new session (sync)
profiler.stop()

await waitForBoolean(() => profiler.isStopped())
expect(profiler.isStopped()).toBe(true)

// Wait for data collection to complete (async fire-and-forget)
await waitForBoolean(() => interceptor.requests.length >= 2)

// Should have collected data from both sessions (before expiration and after renewal)
expect(interceptor.requests.length).toBe(2)
Expand All @@ -512,35 +536,36 @@ describe('profiler', () => {

expect(profilingContextManager.get()?.status).toBe('running')

// First cycle: expire and renew
// First cycle: expire and renew (sync - state changes immediately)
lifeCycle.notify(LifeCycleEventType.SESSION_EXPIRED)
await waitForBoolean(() => profiler.isStopped())

expect(profiler.isStopped()).toBe(true)
expect(profilingContextManager.get()?.status).toBe('stopped')

await waitForBoolean(() => interceptor.requests.length >= 1)
expect(interceptor.requests.length).toBe(1)

lifeCycle.notify(LifeCycleEventType.SESSION_RENEWED)
await waitForBoolean(() => profiler.isRunning())

expect(profilingContextManager.get()?.status).toBe('running')

// Second cycle: expire and renew again
// Second cycle: expire and renew again (sync)
lifeCycle.notify(LifeCycleEventType.SESSION_EXPIRED)
await waitForBoolean(() => profiler.isStopped())

expect(profiler.isStopped()).toBe(true)
expect(profilingContextManager.get()?.status).toBe('stopped')

await waitForBoolean(() => interceptor.requests.length >= 2)
expect(interceptor.requests.length).toBe(2)

lifeCycle.notify(LifeCycleEventType.SESSION_RENEWED)
await waitForBoolean(() => profiler.isRunning())

expect(profilingContextManager.get()?.status).toBe('running')

// Stop profiler
await profiler.stop()
await waitForBoolean(() => profiler.isStopped())
// Stop profiler (sync)
profiler.stop()
expect(profiler.isStopped()).toBe(true)

// Should have collected data from: initial session + first renewal + second renewal = 3 profiles
await waitForBoolean(() => interceptor.requests.length >= 3)
expect(interceptor.requests.length).toBe(3)
})

Expand All @@ -554,11 +579,10 @@ describe('profiler', () => {

expect(profilingContextManager.get()?.status).toBe('running')

// Manually stop the profiler (not via session expiration)
await profiler.stop()

await waitForBoolean(() => profiler.isStopped())
// Manually stop the profiler (not via session expiration) - sync
profiler.stop()

expect(profiler.isStopped()).toBe(true)
expect(profilingContextManager.get()?.status).toBe('stopped')

// Notify that the session has been renewed
Expand All @@ -571,6 +595,75 @@ describe('profiler', () => {
expect(profiler.isStopped()).toBe(true)
expect(profilingContextManager.get()?.status).toBe('stopped')
})

it('should restart profiling when session renews while stop is still in progress', async () => {
const { profiler, profilingContextManager } = setupProfiler()

profiler.start()

// Wait for start of collection.
await waitForBoolean(() => profiler.isRunning())

expect(profilingContextManager.get()?.status).toBe('running')

// Session expires while profiler is running
// With sync state changes, the profiler state becomes 'stopped' immediately
// while data collection continues in the background (fire-and-forget)
lifeCycle.notify(LifeCycleEventType.SESSION_EXPIRED)

// State is immediately 'stopped' (sync), even though data collection is async
expect(profiler.isStopped()).toBe(true)

// Session renews IMMEDIATELY - even before async data collection completes
// This simulates the scenario where user activity triggers renewal
// while data is still being collected in the background
lifeCycle.notify(LifeCycleEventType.SESSION_RENEWED)

// The profiler should restart because the sync state was already 'stopped'
// when SESSION_RENEWED fired
await waitForBoolean(() => profiler.isRunning())

expect(profiler.isRunning()).toBe(true)
expect(profilingContextManager.get()?.status).toBe('running')

// Clean up
profiler.stop()
expect(profiler.isStopped()).toBe(true)
})

it('should restart profiling when session expires while paused and then renews', async () => {
const { profiler, profilingContextManager } = setupProfiler()

profiler.start()

// Wait for start of collection.
await waitForBoolean(() => profiler.isRunning())

expect(profilingContextManager.get()?.status).toBe('running')

// Pause the profiler by hiding the tab
setVisibilityState('hidden')

// Wait for profiler to pause
await waitForBoolean(() => profiler.isPaused())

// Session expires while profiler is paused (sync - state changes immediately)
lifeCycle.notify(LifeCycleEventType.SESSION_EXPIRED)

expect(profiler.isStopped()).toBe(true)
expect(profilingContextManager.get()?.status).toBe('stopped')

// Session is renewed
lifeCycle.notify(LifeCycleEventType.SESSION_RENEWED)

// Wait for profiler to restart
await waitForBoolean(() => profiler.isRunning())
expect(profilingContextManager.get()?.status).toBe('running')

// Clean up
profiler.stop()
expect(profiler.isStopped()).toBe(true)
})
})

function waitForBoolean(booleanCallback: () => boolean) {
Expand Down
Loading