-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(replay): Add
beforeAddRecordingEvent
Replay option
Allows you to modify/filter recording events for replays. Note this is only a recording event, not the replay event.
- Loading branch information
Showing
5 changed files
with
165 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
139 changes: 139 additions & 0 deletions
139
packages/replay/test/integration/beforeAddRecordingEvent.test.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,139 @@ | ||
import * as SentryCore from '@sentry/core'; | ||
import type { Transport } from '@sentry/types'; | ||
import * as SentryUtils from '@sentry/utils'; | ||
|
||
import type { Replay } from '../../src'; | ||
import type { ReplayContainer } from '../../src/replay'; | ||
import { clearSession } from '../../src/session/clearSession'; | ||
import * as SendReplayRequest from '../../src/util/sendReplayRequest'; | ||
import { BASE_TIMESTAMP, mockRrweb, mockSdk } from '../index'; | ||
import { useFakeTimers } from '../utils/use-fake-timers'; | ||
|
||
useFakeTimers(); | ||
|
||
async function advanceTimers(time: number) { | ||
jest.advanceTimersByTime(time); | ||
await new Promise(process.nextTick); | ||
} | ||
|
||
type MockTransportSend = jest.MockedFunction<Transport['send']>; | ||
|
||
describe('Integration | beforeAddRecordingEvent', () => { | ||
let replay: ReplayContainer; | ||
let integration: Replay; | ||
let mockTransportSend: MockTransportSend; | ||
let mockSendReplayRequest: jest.SpyInstance<any>; | ||
let domHandler: (args: any) => any; | ||
const { record: mockRecord } = mockRrweb(); | ||
|
||
beforeAll(async () => { | ||
jest.setSystemTime(new Date(BASE_TIMESTAMP)); | ||
jest.spyOn(SentryUtils, 'addInstrumentationHandler').mockImplementation((type, handler: (args: any) => any) => { | ||
if (type === 'dom') { | ||
domHandler = handler; | ||
} | ||
}); | ||
|
||
({ replay, integration } = await mockSdk({ | ||
replayOptions: { | ||
beforeAddRecordingEvent: event => { | ||
const eventData = event.data as Record<string, any>; | ||
|
||
if (eventData.tag === 'breadcrumb' && eventData.payload.category === 'ui.click') { | ||
return { | ||
...event, | ||
data: { | ||
...eventData, | ||
payload: { | ||
...eventData.payload, | ||
message: 'beforeAddRecordingEvent', | ||
}, | ||
}, | ||
}; | ||
} | ||
|
||
if (eventData.tag === 'options') { | ||
return null; | ||
} | ||
|
||
return event; | ||
}, | ||
_experiments: { | ||
captureExceptions: true, | ||
}, | ||
}, | ||
})); | ||
|
||
mockSendReplayRequest = jest.spyOn(SendReplayRequest, 'sendReplayRequest'); | ||
|
||
jest.runAllTimers(); | ||
mockTransportSend = SentryCore.getCurrentHub()?.getClient()?.getTransport()?.send as MockTransportSend; | ||
}); | ||
|
||
beforeEach(() => { | ||
jest.setSystemTime(new Date(BASE_TIMESTAMP)); | ||
mockRecord.takeFullSnapshot.mockClear(); | ||
mockTransportSend.mockClear(); | ||
|
||
// Create a new session and clear mocks because a segment (from initial | ||
// checkout) will have already been uploaded by the time the tests run | ||
clearSession(replay); | ||
replay['_loadAndCheckSession'](); | ||
|
||
mockSendReplayRequest.mockClear(); | ||
}); | ||
|
||
afterEach(async () => { | ||
jest.runAllTimers(); | ||
await new Promise(process.nextTick); | ||
jest.setSystemTime(new Date(BASE_TIMESTAMP)); | ||
clearSession(replay); | ||
replay['_loadAndCheckSession'](); | ||
}); | ||
|
||
afterAll(() => { | ||
integration && integration.stop(); | ||
}); | ||
|
||
it('changes click breadcrumbs message', async () => { | ||
domHandler({ | ||
name: 'click', | ||
}); | ||
|
||
await advanceTimers(5000); | ||
|
||
expect(replay).toHaveLastSentReplay({ | ||
recordingPayloadHeader: { segment_id: 0 }, | ||
recordingData: JSON.stringify([ | ||
{ | ||
type: 5, | ||
timestamp: BASE_TIMESTAMP, | ||
data: { | ||
tag: 'breadcrumb', | ||
payload: { | ||
timestamp: BASE_TIMESTAMP / 1000, | ||
type: 'default', | ||
category: 'ui.click', | ||
message: 'beforeAddRecordingEvent', | ||
data: {}, | ||
}, | ||
}, | ||
}, | ||
]), | ||
}); | ||
}); | ||
|
||
it('filters out the options event', async () => { | ||
mockTransportSend.mockClear(); | ||
await integration.stop(); | ||
|
||
integration.start(); | ||
|
||
jest.runAllTimers(); | ||
await new Promise(process.nextTick); | ||
expect(replay).toHaveLastSentReplay({ | ||
recordingPayloadHeader: { segment_id: 0 }, | ||
recordingData: JSON.stringify([{ data: { isCheckout: true }, timestamp: BASE_TIMESTAMP, type: 2 }]), | ||
}); | ||
}); | ||
}); |