Skip to content
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

feat: custom event with remote config #1628

Merged
merged 4 commits into from
Dec 20, 2024
Merged

feat: custom event with remote config #1628

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
b6d8d04
feat: custom event with remote config
pauldambra Dec 20, 2024
2629b4f
this is a better place
pauldambra Dec 20, 2024
3b849be
tdd for realz
pauldambra Dec 20, 2024
62f1082
cypress refactor
pauldambra Dec 20, 2024
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
81 changes: 44 additions & 37 deletions cypress/e2e/session-recording.cy.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,31 +28,28 @@ function expectPageViewCustomEvent(snapshot: RRWebCustomEvent) {
expect(snapshot.data.tag).to.equal('$pageview')
}

function expectSessionIdChangedCustomEvent(snapshot: RRWebCustomEvent) {
function expectCustomEvent(snapshot: RRWebCustomEvent, tag: string) {
expect(snapshot.type).to.equal(5)
expect(snapshot.data.tag).to.equal('$session_id_change')
expect(snapshot.data.payload.changeReason).to.deep.equal({
noSessionId: true,
activityTimeout: true,
sessionPastMaximumLength: false,
})
expect(snapshot.data.tag).to.equal(tag)
}

function expectRemoteConfigCustomEvent(snapshot: RRWebCustomEvent) {
expectCustomEvent(snapshot, '$remote_config_received')
}

function expectPostHogConfigCustomEvent(snapshot: RRWebCustomEvent) {
expect(snapshot.type).to.equal(5)
expect(snapshot.data.tag).to.equal('$posthog_config')
expectCustomEvent(snapshot, '$posthog_config')
}

function expectSessionOptionsCustomEvent(snapshot: RRWebCustomEvent) {
expect(snapshot.type).to.equal(5)
expect(snapshot.data.tag).to.equal('$session_options')
expectCustomEvent(snapshot, '$session_options')
}

function sortByTag(snapshots: RRWebCustomEvent[]) {
return snapshots.sort((a, b) => a.data.tag?.localeCompare(b.data.tag))
}

function ensureActivitySendsSnapshots(initial = true) {
function ensureActivitySendsSnapshots(expectedCustomTags: string[] = []) {
cy.resetPhCaptures()

cy.get('[data-cy-input]')
Expand All @@ -63,23 +60,30 @@ function ensureActivitySendsSnapshots(initial = true) {
const capturedSnapshot = captures.find((e) => e.event === '$snapshot')
expect(capturedSnapshot).not.to.be.undefined

expect(capturedSnapshot['properties']['$snapshot_data']).to.have.length.above(14).and.below(40)
// a meta and then a full snapshot
expect(capturedSnapshot['properties']['$snapshot_data'][0].type).to.equal(4) // meta
expect(capturedSnapshot['properties']['$snapshot_data'][1].type).to.equal(2) // full_snapshot

if (initial) {
expectSessionOptionsCustomEvent(capturedSnapshot['properties']['$snapshot_data'][2])
expectPostHogConfigCustomEvent(capturedSnapshot['properties']['$snapshot_data'][3])
} else {
expectSessionOptionsCustomEvent(capturedSnapshot['properties']['$snapshot_data'][2])
expectPostHogConfigCustomEvent(capturedSnapshot['properties']['$snapshot_data'][3])
expectSessionIdChangedCustomEvent(capturedSnapshot['properties']['$snapshot_data'][4])
const capturedSnapshotData = capturedSnapshot['properties']['$snapshot_data']
expect(capturedSnapshotData).to.have.length.above(14).and.below(40)

// first a meta and then a full snapshot
expect(capturedSnapshotData.shift().type).to.equal(4)
expect(capturedSnapshotData.shift().type).to.equal(2)

// now the list should be all custom events until it is incremental
// and then only incremental snapshots
const customEvents = []
let seenIncremental = false
for (const snapshot of capturedSnapshotData) {
if (snapshot.type === 5) {
expect(seenIncremental).to.be.false
customEvents.push(snapshot)
} else if (snapshot.type === 3) {
seenIncremental = true
} else {
throw new Error(`Unexpected snapshot type: ${snapshot.type}`)
}
}

// Making a set from the rest should all be 3 - incremental snapshots
const remainder = capturedSnapshot['properties']['$snapshot_data'].slice(initial ? 4 : 5)
expect(Array.from(new Set(remainder.map((s) => s.type)))).to.deep.equal([3])
const customEventTags = customEvents.map((s) => s.data.tag)
cy.log('checked custom event tags', { customEventTags, expectedCustomTags })
expect(customEventTags).to.eql(expectedCustomTags)
})
})
}
Expand Down Expand Up @@ -145,10 +149,11 @@ describe('Session recording', () => {
// a meta and then a full snapshot
expect(captures[1]['properties']['$snapshot_data'][0].type).to.equal(4) // meta
expect(captures[1]['properties']['$snapshot_data'][1].type).to.equal(2) // full_snapshot
expect(captures[1]['properties']['$snapshot_data'][2].type).to.equal(5) // custom event with options
expect(captures[1]['properties']['$snapshot_data'][3].type).to.equal(5) // custom event with posthog config
expect(captures[1]['properties']['$snapshot_data'][2].type).to.equal(5) // custom event with remote config
expect(captures[1]['properties']['$snapshot_data'][3].type).to.equal(5) // custom event with options
expect(captures[1]['properties']['$snapshot_data'][4].type).to.equal(5) // custom event with posthog config
// Making a set from the rest should all be 3 - incremental snapshots
const incrementalSnapshots = captures[1]['properties']['$snapshot_data'].slice(4)
const incrementalSnapshots = captures[1]['properties']['$snapshot_data'].slice(5)
expect(Array.from(new Set(incrementalSnapshots.map((s) => s.type)))).to.deep.eq([3])

expect(captures[2]['properties']['$session_recording_start_reason']).to.equal(
Expand Down Expand Up @@ -374,7 +379,7 @@ describe('Session recording', () => {

cy.get('[data-cy-input]').type('hello world! ')
cy.wait(500)
ensureActivitySendsSnapshots()
ensureActivitySendsSnapshots(['$remote_config_received', '$session_options', '$posthog_config'])
cy.posthog().then((ph) => {
ph.stopSessionRecording()
})
Expand All @@ -385,7 +390,7 @@ describe('Session recording', () => {
cy.posthog().then((ph) => {
ph.startSessionRecording()
})
ensureActivitySendsSnapshots()
ensureActivitySendsSnapshots(['$session_options', '$posthog_config'])

// the session id is not rotated by stopping and starting the recording
cy.posthog().then((ph) => {
Expand Down Expand Up @@ -524,14 +529,16 @@ describe('Session recording', () => {
capturedSnapshot['properties']['$snapshot_data'][2],
capturedSnapshot['properties']['$snapshot_data'][3],
capturedSnapshot['properties']['$snapshot_data'][4],
capturedSnapshot['properties']['$snapshot_data'][5],
])

expectPageViewCustomEvent(customEvents[0])
expectPostHogConfigCustomEvent(customEvents[1])
expectSessionOptionsCustomEvent(customEvents[2])
expectRemoteConfigCustomEvent(customEvents[2])
expectSessionOptionsCustomEvent(customEvents[3])

const xPositions = []
for (let i = 5; i < capturedSnapshot['properties']['$snapshot_data'].length; i++) {
for (let i = 6; i < capturedSnapshot['properties']['$snapshot_data'].length; i++) {
expect(capturedSnapshot['properties']['$snapshot_data'][i].type).to.equal(3)
expect(capturedSnapshot['properties']['$snapshot_data'][i].data.source).to.equal(
6,
Expand Down Expand Up @@ -628,14 +635,14 @@ describe('Session recording', () => {
startingSessionId = ph.get_session_id()
})

ensureActivitySendsSnapshots()
ensureActivitySendsSnapshots(['$remote_config_received', '$session_options', '$posthog_config'])

cy.posthog().then((ph) => {
cy.log('resetting posthog')
ph.reset()
})

ensureActivitySendsSnapshots(false)
ensureActivitySendsSnapshots(['$session_options', '$posthog_config', '$session_id_change'])

// the session id is rotated after reset is called
cy.posthog().then((ph) => {
Expand Down
17 changes: 11 additions & 6 deletions src/__tests__/extensions/replay/sessionrecording.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1982,21 +1982,26 @@ describe('SessionRecording', () => {
})
sessionRecording = new SessionRecording(posthog)

expect(sessionRecording['queuedRRWebEvents']).toHaveLength(0)

sessionRecording.onRemoteConfig(makeDecideResponse({ sessionRecording: { endpoint: '/s/' } }))
sessionRecording.startIfEnabledOrStop()
expect(loadScriptMock).toHaveBeenCalled()

expect(sessionRecording['queuedRRWebEvents']).toHaveLength(0)
expect(sessionRecording['queuedRRWebEvents']).toHaveLength(1)

sessionRecording['_tryAddCustomEvent']('test', { test: 'test' })
sessionRecording.startIfEnabledOrStop()
expect(loadScriptMock).toHaveBeenCalled()
})

it('queues events', () => {
expect(sessionRecording['queuedRRWebEvents']).toHaveLength(1)
sessionRecording['_tryAddCustomEvent']('test', { test: 'test' })

expect(sessionRecording['queuedRRWebEvents']).toHaveLength(2)
})

it('limits the queue of events', () => {
expect(sessionRecording['queuedRRWebEvents']).toHaveLength(1)
sessionRecording['_tryAddCustomEvent']('test', { test: 'test' })

expect(sessionRecording['queuedRRWebEvents']).toHaveLength(2)

for (let i = 0; i < 100; i++) {
sessionRecording['_tryAddCustomEvent']('test', { test: 'test' })
Expand Down
1 change: 1 addition & 0 deletions src/extensions/replay/sessionrecording.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -621,6 +621,7 @@ export class SessionRecording {
}

onRemoteConfig(response: RemoteConfig) {
this._tryAddCustomEvent('$remote_config_received', response)
this._persistRemoteConfig(response)

this._linkedFlag = response.sessionRecording?.linkedFlag || null
Expand Down
Loading