stabilize tests

Author: metal-messiah

src/common/config/init-types.js

@@ -35,7 +35,7 @@
  * @property {Object} [metrics]
  * @property {boolean} [metrics.enabled] - Turn on/off the metrics feature (on by default).
  * @property {boolean} [metrics.autoStart] - If true, the agent will automatically start the metrics feature. Otherwise, it will be in a deferred state until the `start` API method is called.
- * @property {Array<Object>} [obfuscate] - Array of regexp and corresponding replacement patterns for obfuscating data.
+ * @property {{regex: regex | string, replacement: string}} [obfuscate] - Array of regexp and corresponding replacement patterns for obfuscating data.
  * @property {Object} [page_action]
  * @property {boolean} [page_action.enabled] - Must be true to allow PageAction events to be captured.
  * @property {Object} [page_view_event]

src/features/session_replay/aggregate/index.js

@@ -210,7 +210,7 @@ export class Aggregate extends AggregateBase {
   makeHarvestPayload () {
     if (this.mode !== MODE.FULL || this.blocked) return // harvests should only be made in FULL mode, and not if the feature is blocked
     if (this.shouldCompress && !this.gzipper) return // if compression is enabled, but the libraries have not loaded, wait for them to load
-    if (!this.recorder || !this.timeKeeper?.ready || !this.recorder.hasSeenSnapshot) return // if the recorder or the timekeeper is not ready, or the recorder has not yet seen a snapshot, do not harvest
+    if (!this.recorder || !this.timeKeeper?.ready || !(this.recorder.hasSeenSnapshot && this.recorder.hasSeenMeta)) return // if the recorder or the timekeeper is not ready, or the recorder has not yet seen a snapshot, do not harvest
 
     const recorderEvents = this.recorder.getEvents()
     // get the event type and use that to trigger another harvest if needed
@@ -241,7 +241,6 @@ export class Aggregate extends AggregateBase {
     // TODO -- Gracefully handle the buffer for retries.
     if (!this.agentRef.runtime.session.state.sessionReplaySentFirstChunk) this.syncWithSessionManager({ sessionReplaySentFirstChunk: true })
     this.recorder.clearBuffer()
-    if (recorderEvents.type === 'preloaded') this.agentRef.runtime.harvester.triggerHarvestFor(this)
 
     if (!this.agentRef.runtime.session.state.traceHarvestStarted) {
       warn(59, JSON.stringify(this.agentRef.runtime.session.state))

src/features/session_replay/shared/recorder.js

@@ -47,6 +47,7 @@ export class Recorder {
     this.backloggedEvents = new RecorderEvents(this.shouldFix)
     /** Only set to true once a snapshot node has been processed.  Used to block harvests from sending before we know we have a snapshot */
     this.hasSeenSnapshot = false
+    this.hasSeenMeta = false
     /** Hold on to the last meta node, so that it can be re-inserted if the meta and snapshot nodes are broken up due to harvesting */
     this.lastMeta = false
     /** The method to stop recording. This defaults to a noop, but is overwritten once the recording library is imported and initialized */
@@ -186,9 +187,9 @@ export class Recorder {
     }
 
     // meta event
-    this.events.hasMeta ||= event.type === RRWEB_EVENT_TYPES.Meta
+    this.hasSeenMeta ||= this.events.hasMeta ||= event.type === RRWEB_EVENT_TYPES.Meta
     // snapshot event
-    this.events.hasSnapshot ||= this.hasSeenSnapshot ||= event.type === RRWEB_EVENT_TYPES.FullSnapshot
+    this.hasSeenSnapshot ||= this.events.hasSnapshot ||= event.type === RRWEB_EVENT_TYPES.FullSnapshot
 
     //* dont let the EventBuffer class double evaluate the event data size, it's a performance burden and we have special reasons to do it outside the event buffer */
     this.events.add(event, eventBytes)

src/features/utils/aggregate-base.js

@@ -176,8 +176,8 @@ export class AggregateBase extends FeatureBase {
    * @param {boolean=} result.retry - whether the harvest should be retried
    */
   postHarvestCleanup (result = {}) {
-    const harvestFailed = result.sent && result.retry
-    if (harvestFailed) this.events.reloadSave(this.harvestOpts)
+    this.isRetrying = result.sent && result.retry
+    if (this.isRetrying) this.events.reloadSave(this.harvestOpts)
     this.events.clearSave(this.harvestOpts)
   }
 

tests/assets/rrweb-instrumented.html

@@ -51,6 +51,7 @@
     <hr />
     <div id="content-editable-div" contenteditable="true">text</div>
     <button onclick="moveImage()">Click</button>
+    <button id="error-click" onclick="1=2">Click for Error</button>
     <img src="https://upload.wikimedia.org/wikipedia/commons/d/d7/House_of_Commons_Chamber_1.png" />
     <a href="./rrweb-instrumented.html" target="_blank">New Tab</a>
     <script>

tests/specs/session-replay/ingest.e2e.js

@@ -17,8 +17,6 @@ describe('Session Replay Ingest Behavior', () => {
     await browser.url(await browser.testHandle.assetURL('rrweb-instrumented.html', srConfig()))
       .then(() => browser.waitForSessionReplayRecording())
 
-    expect((await getSR()).events.length).toBeGreaterThan(0)
-
     await sessionReplaysCapture.waitForResult({ totalCount: 2 })
 
     expect((await getSR()).events.length).toEqual(0)
@@ -40,7 +38,7 @@ describe('Session Replay Ingest Behavior', () => {
       browser.testHandle.scheduleReply('bamServer', {
         test: testBlobReplayRequest,
         statusCode: 429
-      }),
+      }).then(() => $('body').click()),
       sessionReplaysCapture.waitForResult({ timeout: 10000 })
     ])
 

tests/specs/session-replay/payload.e2e.js

@@ -75,42 +75,53 @@ describe('Session Replay Payload Validation', () => {
   })
 
   it('should match expected payload - standard', async () => {
-    const [[sessionReplayHarvest], { localStorage: { value: session } }] = await Promise.all([
-      sessionReplaysCapture.waitForResult({ totalCount: 1 }),
+    const [sessionReplayHarvests, { localStorage: { value: session } }] = await Promise.all([
+      sessionReplaysCapture.waitForResult({ totalCount: 2 }),
       browser.url(await browser.testHandle.assetURL('rrweb-instrumented.html', srConfig()))
         .then(() => browser.waitForAgentLoad())
         .then(() => browser.getAgentSessionInfo())
     ])
 
+    const firstChunk = sessionReplayHarvests.find(x => x.request.query.attributes.includes('isFirstChunk=true'))
+
     testExpectedReplay({
-      data: sessionReplayHarvest.request,
+      data: firstChunk.request,
       session,
       hasError: false,
       hasMeta: true,
       hasSnapshot: true,
       isFirstChunk: true,
-      currentUrl: sessionReplayHarvest.request.headers.origin + '/tests/assets/rrweb-instrumented.html'
+      currentUrl: firstChunk.request.headers.origin + '/tests/assets/rrweb-instrumented.html'
     })
   })
 
   it('should match expected payload - error', async () => {
-    const [[sessionReplayHarvest], { localStorage: { value: session } }] = await Promise.all([
-      sessionReplaysCapture.waitForResult({ totalCount: 1 }),
+    const [sessionReplayHarvests, { localStorage: { value: session } }] = await Promise.all([
+      sessionReplaysCapture.waitForResult({ totalCount: 2 }),
       browser.url(await browser.testHandle.assetURL('rrweb-instrumented.html', srConfig()))
         .then(() => browser.waitForAgentLoad())
         .then(() => browser.getAgentSessionInfo())
     ])
 
-    testExpectedReplay({ data: sessionReplayHarvest.request, session, hasError: false, hasMeta: true, hasSnapshot: true, isFirstChunk: true })
+    const firstChunk = sessionReplayHarvests.find(x => x.request.query.attributes.includes('isFirstChunk=true'))
 
-    const [sessionReplayHarvests] = await Promise.all([
+    testExpectedReplay({
+      data: firstChunk.request,
+      session,
+      hasError: false,
+      hasMeta: true,
+      hasSnapshot: true,
+      isFirstChunk: true
+    })
+
+    const [errorHarvest] = await Promise.all([
       sessionReplaysCapture.waitForResult({ timeout: 10000 }),
       browser.execute(function () {
-        newrelic.noticeError(new Error('test'))
+        document.querySelector('#error-click').click()
       })
     ])
 
-    const errorSessionReplayHarvest = sessionReplayHarvests.find(harvest => harvest.request.query.attributes.indexOf('hasError=true') !== -1)
+    const errorSessionReplayHarvest = errorHarvest.find(harvest => harvest.request.query.attributes.indexOf('hasError=true') !== -1)
     testExpectedReplay({ data: errorSessionReplayHarvest.request, session, hasError: true, isFirstChunk: false })
   })
 

tests/specs/session-replay/rrweb-configuration.e2e.js

@@ -93,7 +93,8 @@ describe('RRWeb Configuration', () => {
 
       const sessionReplaysHarvests = await sessionReplaysCapture.waitForResult({ timeout: 10000 })
       expect(sessionReplaysHarvests.length).toBeGreaterThanOrEqual(1)
-      expect(decodeAttributes(sessionReplaysHarvests[0].request.query.attributes).hasSnapshot).toEqual(true)
+      const snapshotHarvest = sessionReplaysHarvests.find(x => decodeAttributes(x.request.query.attributes).hasSnapshot === true)
+      expect(snapshotHarvest).toBeDefined()
 
       // note: we need to leave text nodes containing only whitespace as-is to avoid adding extraneous '*'
       const whitespaceOnlyNodes = JSONPath({ path: '$.[*].request.body.[?(!!@ && @.type===3 && !!@.textContent && @.textContent.match(/^\\s+$/) && ![\'script\',\'link\',\'style\'].includes(@parent.tagName))]', json: sessionReplaysHarvests })
@@ -120,7 +121,8 @@ describe('RRWeb Configuration', () => {
 
       const sessionReplaysHarvests = await sessionReplaysCapture.waitForResult({ timeout: 10000 })
       expect(sessionReplaysHarvests.length).toBeGreaterThanOrEqual(1)
-      expect(decodeAttributes(sessionReplaysHarvests[0].request.query.attributes).hasSnapshot).toEqual(true)
+      const snapshotHarvest = sessionReplaysHarvests.find(x => decodeAttributes(x.request.query.attributes).hasSnapshot === true)
+      expect(snapshotHarvest).toBeDefined()
 
       const testNodes = JSONPath({ path: '$.[*].request.body.[?(!!@ && @.type===3 && !!@.textContent && ![\'script\',\'link\',\'style\'].includes(@parent.tagName))]', json: sessionReplaysHarvests })
       expect(testNodes.length).toBeGreaterThan(0)
@@ -397,10 +399,12 @@ async function checkSessionReplayInputMasking (sessionReplaysCapture, elements)
   // Wait 10 seconds for additional harvests
   const sessionReplaysHarvests = await sessionReplaysCapture.waitForResult({ timeout: 10000 })
   expect(sessionReplaysHarvests.length).toBeGreaterThanOrEqual(1)
-  expect(decodeAttributes(sessionReplaysHarvests[0].request.query.attributes).hasSnapshot).toEqual(true)
+
+  const snapshotHarvest = sessionReplaysHarvests.find(x => decodeAttributes(x.request.query.attributes).hasSnapshot === true)
+  expect(snapshotHarvest).toBeDefined()
 
   elements.forEach(el => {
-    const snapshotNodes = JSONPath({ path: `$.request.body.[?(${el.jsonPathFilter})]`, json: sessionReplaysHarvests[0] })
+    const snapshotNodes = JSONPath({ path: `$.request.body.[?(${el.jsonPathFilter})]`, json: snapshotHarvest })
     expect(snapshotNodes.length).toBeGreaterThanOrEqual(1)
 
     snapshotNodes.forEach(node => {

tests/specs/session-replay/session-state.e2e.js

@@ -50,7 +50,7 @@ describe('session manager state behavior', () => {
     it('should end recording and clear the buffer', async () => {
       const sessionReplayCapture = await browser.testHandle.createNetworkCaptures('bamServer', { test: testBlobReplayRequest })
       await browser.enableSessionReplay()
-      await browser.url(await browser.testHandle.assetURL('rrweb-instrumented.html', { init: { session: { expiresMs: 7500 }, session_replay: { enabled: true } } }))
+      await browser.url(await browser.testHandle.assetURL('rrweb-instrumented.html', { init: { session_replay: { enabled: true } } }))
         .then(() => browser.waitForSessionReplayRecording())
 
       // session has started, replay should have set mode to "FULL"
@@ -66,7 +66,8 @@ describe('session manager state behavior', () => {
         })
       ])
 
-      expect(sessionReplayHarvests.length).toEqual(1)
+      // Shouldnt find the click because the session reset and doesnt force a harvest
+      expect(sessionReplayHarvests.find(x => x.request.body.find(y => y.type === RRWEB_EVENT_TYPES.IncrementalSnapshot && y.data.x === 0 && y.data.y === 0))).not.toBeTruthy()
     })
   })