Renamed LeadingCapture to ScheduledCapture (#1363)

matux · web-flow · commit 91c75eb6450e · 2025-10-10T10:19:28.000-03:00
diff --git a/src/browser/replay/replayManager.js b/src/browser/replay/replayManager.js
@@ -3,7 +3,7 @@ import id from '../../tracing/id.js';
 import logger from '../../logger.js';
 import Recorder from './recorder.js';
 import ReplayPredicates from './replayPredicates.js';
-import LeadingCapture from './leadingCapture.js';
+import ScheduledCapture from './scheduledCapture.js';
 
 /** @typedef {import('./recorder.js').BufferCursor} BufferCursor */
 /** @typedef {import('./recorder.js').Recorder} Recorder */
@@ -29,7 +29,7 @@ export default class ReplayManager {
   _recorder;
   _tracing;
   _telemeter;
-  _leadingCapture;
+  _scheduledCapture;
   _trailingStatus;
 
   /**
@@ -50,37 +50,37 @@ export default class ReplayManager {
     this._telemeter = telemeter;
     this._trailingStatus = new Map();
     this._predicates = new ReplayPredicates(options);
-    this._leadingCapture = new LeadingCapture({
+    this._scheduledCapture = new ScheduledCapture({
       recorder: this._recorder,
       tracing: this._tracing,
       telemeter: this._telemeter,
-      shouldSend: this._shouldSendLeading.bind(this),
-      onComplete: this._onLeadingComplete.bind(this),
+      shouldSend: this._shouldSendScheduled.bind(this),
+      onComplete: this._onScheduledComplete.bind(this),
     });
   }
 
   /**
-   * Called when a leading capture completes (sent or discarded).
+   * Called when a scheduled capture completes (sent or discarded).
    * Cleans up the trailing status coordination state.
    *
    * @param {string} replayId - The replay ID
    * @private
    */
-  _onLeadingComplete(replayId) {
+  _onScheduledComplete(replayId) {
     this._trailingStatus.delete(replayId);
   }
 
   /**
-   * Determines if a leading replay should be sent based on coordination state.
+   * Determines if a scheduled replay should be sent based on coordination state.
    *
-   * Leading replays can only be sent after the trailing replay has been
+   * Scheduled replays can only be sent after the trailing replay has been
    * successfully sent or explicitly skipped (for leading-only captures).
    *
    * @param {string} replayId - The replay ID
-   * @returns {boolean} True if leading replay can be sent
+   * @returns {boolean} True if scheduled replay can be sent
    * @private
    */
-  _shouldSendLeading(replayId) {
+  _shouldSendScheduled(replayId) {
     const status = this._trailingStatus.get(replayId);
     return status === TrailingStatus.SENT || status === TrailingStatus.SKIPPED;
   }
@@ -125,7 +125,7 @@ export default class ReplayManager {
 
     const leadingSeconds = this._recorder.options?.postDuration || 0;
     if (leadingSeconds > 0) {
-      this._leadingCapture.schedule(replayId, occurrenceUuid, leadingSeconds);
+      this._scheduledCapture.schedule(replayId, occurrenceUuid, leadingSeconds);
       this._trailingStatus.set(replayId, TrailingStatus.PENDING);
     }
   }
@@ -263,7 +263,7 @@ export default class ReplayManager {
     });
 
     this._trailingStatus.set(replayId, TrailingStatus.SENT);
-    await this._leadingCapture.sendIfReady(replayId);
+    await this._scheduledCapture.sendIfReady(replayId);
   }
 
   /**
@@ -280,7 +280,7 @@ export default class ReplayManager {
     }
 
     this._trailingStatus.set(replayId, TrailingStatus.FAILED);
-    this._leadingCapture.discard(replayId);
+    this._scheduledCapture.discard(replayId);
 
     if (!this._map.has(replayId)) {
       logger.error(
diff --git a/src/browser/replay/scheduledCapture.js b/src/browser/replay/scheduledCapture.js
@@ -3,12 +3,14 @@ import logger from '../../logger.js';
 /** @typedef {import('./recorder.js').BufferCursor} BufferCursor */
 
 /**
- * Manages delayed "leading" (post-trigger) replay captures.
+ * A utility for coordinating delayed, cursor-based captures.
  *
- * Coordinates timing, buffer cursor stability, and payload preparation
- * for events that occur AFTER the trigger event.
+ * Manages timer-based capture scheduling, buffer cursor stability across
+ * checkouts, and payload preparation. Used primarily for capturing events
+ * that occur after a trigger (leading replays), but the implementation is
+ * generic and could be used for any delayed capture scenario.
  */
-export default class LeadingCapture {
+export default class ScheduledCapture {
   _recorder;
   _tracing;
   _telemeter;
@@ -17,7 +19,7 @@ export default class LeadingCapture {
   _onComplete;
 
   /**
-   * Creates a new LeadingCapture instance
+   * Creates a new ScheduledCapture instance
    *
    * @param {Object} props - Configuration object
    * @param {Object} props.recorder - Recorder instance for capturing events
diff --git a/test/replay/integration/replayManager.bufferIndex.checkoutResilience.test.js b/test/replay/integration/replayManager.bufferIndex.checkoutResilience.test.js
@@ -72,7 +72,7 @@ describe('ReplayManager – Buffer Index Checkout Resilience', function () {
     await clock.tickAsync(100);
 
     const cursor =
-      replayManager._leadingCapture._pending.get(replayId).bufferCursor;
+      replayManager._scheduledCapture._pending.get(replayId).bufferCursor;
     expect(cursor).to.be.an('object');
     expect(cursor.slot).to.equal(0);
 
@@ -107,7 +107,7 @@ describe('ReplayManager – Buffer Index Checkout Resilience', function () {
       { resourceSpans: [{ spanData: 'test' }] },
       { 'X-Rollbar-Replay-Id': replayId },
     ]);
-    expect(replayManager._leadingCapture._pending.size).to.equal(0);
+    expect(replayManager._scheduledCapture._pending.size).to.equal(0);
 
     recorder.exportRecordingSpan.restore();
   });
@@ -165,7 +165,7 @@ describe('ReplayManager – Buffer Index Checkout Resilience', function () {
       { resourceSpans: [{ spanData: 'test' }] },
       { 'X-Rollbar-Replay-Id': replayId },
     ]);
-    expect(replayManager._leadingCapture._pending.size).to.equal(0);
+    expect(replayManager._scheduledCapture._pending.size).to.equal(0);
 
     recorder.exportRecordingSpan.restore();
   });
@@ -195,7 +195,7 @@ describe('ReplayManager – Buffer Index Checkout Resilience', function () {
     await clock.tickAsync(100);
 
     const cursor =
-      replayManager._leadingCapture._pending.get(replayId).bufferCursor;
+      replayManager._scheduledCapture._pending.get(replayId).bufferCursor;
     expect(cursor).to.be.an('object');
 
     await clock.tickAsync(2000);
@@ -229,7 +229,7 @@ describe('ReplayManager – Buffer Index Checkout Resilience', function () {
       { resourceSpans: [{ spanData: 'test' }] },
       { 'X-Rollbar-Replay-Id': replayId },
     ]);
-    expect(replayManager._leadingCapture._pending.size).to.equal(0);
+    expect(replayManager._scheduledCapture._pending.size).to.equal(0);
 
     recorder.exportRecordingSpan.restore();
   });
@@ -266,7 +266,7 @@ describe('ReplayManager – Buffer Index Checkout Resilience', function () {
       { resourceSpans: [{ spanData: 'test' }] },
       { 'X-Rollbar-Replay-Id': replayId },
     ]);
-    expect(replayManager._leadingCapture._pending.size).to.equal(0);
+    expect(replayManager._scheduledCapture._pending.size).to.equal(0);
   });
 
   it('collects events strictly after the cursor', async function () {
@@ -292,7 +292,7 @@ describe('ReplayManager – Buffer Index Checkout Resilience', function () {
     await clock.tickAsync(100);
 
     const cursor =
-      replayManager._leadingCapture._pending.get(replayId).bufferCursor;
+      replayManager._scheduledCapture._pending.get(replayId).bufferCursor;
 
     sinon.spy(recorder, '_collectEventsFromCursor');
 
@@ -315,7 +315,7 @@ describe('ReplayManager – Buffer Index Checkout Resilience', function () {
       { resourceSpans: [{ spanData: 'test' }] },
       { 'X-Rollbar-Replay-Id': replayId },
     ]);
-    expect(replayManager._leadingCapture._pending.size).to.equal(0);
+    expect(replayManager._scheduledCapture._pending.size).to.equal(0);
 
     recorder._collectEventsFromCursor.restore();
   });
@@ -357,7 +357,7 @@ describe('ReplayManager – Buffer Index Checkout Resilience', function () {
     );
 
     expect(replayManager._map.has(replayId)).to.be.false;
-    expect(replayManager._leadingCapture._pending.has(replayId)).to.be.false;
+    expect(replayManager._scheduledCapture._pending.has(replayId)).to.be.false;
     sinon.assert.notCalled(api.postSpans);
 
     logger.error.restore();
@@ -401,7 +401,7 @@ describe('ReplayManager – Buffer Index Checkout Resilience', function () {
       { resourceSpans: [{ spanData: 'test' }] },
       { 'X-Rollbar-Replay-Id': replayId },
     ]);
-    expect(replayManager._leadingCapture._pending.has(replayId)).to.be.false;
+    expect(replayManager._scheduledCapture._pending.has(replayId)).to.be.false;
   });
 
   it('discard cancels timer; success clears state', async function () {
@@ -422,7 +422,7 @@ describe('ReplayManager – Buffer Index Checkout Resilience', function () {
     replayManager.capture(replayId1, 'test-uuid-1', trigger, triggerContext);
     await clock.tickAsync(100);
 
-    expect(replayManager._leadingCapture._pending.has(replayId1)).to.be.true;
+    expect(replayManager._scheduledCapture._pending.has(replayId1)).to.be.true;
 
     replayManager.discard(replayId1);
     await clock.tickAsync(10000);
@@ -441,7 +441,7 @@ describe('ReplayManager – Buffer Index Checkout Resilience', function () {
       { resourceSpans: [{ spanData: 'test' }] },
       { 'X-Rollbar-Replay-Id': replayId2 },
     ]);
-    expect(replayManager._leadingCapture._pending.has(replayId2)).to.be.false;
+    expect(replayManager._scheduledCapture._pending.has(replayId2)).to.be.false;
     expect(replayManager._trailingStatus.has(replayId2)).to.be.false;
   });
 });
diff --git a/test/replay/integration/replayManager.bufferIndex.test.js b/test/replay/integration/replayManager.bufferIndex.test.js
@@ -81,7 +81,7 @@ describe('ReplayManager buffer-index integration', function () {
       { timestamp: 2000, type: EventType.Meta, data: {} },
     ]);
 
-    sinon.spy(replayManager._leadingCapture, 'sendIfReady');
+    sinon.spy(replayManager._scheduledCapture, 'sendIfReady');
 
     const replayId = 'test-replay-id';
     const occurrenceUuid = 'test-uuid';
@@ -90,19 +90,19 @@ describe('ReplayManager buffer-index integration', function () {
     replayManager.capture(replayId, occurrenceUuid, triggerContext);
     await clock.tickAsync(100);
 
-    sinon.assert.notCalled(replayManager._leadingCapture.sendIfReady);
+    sinon.assert.notCalled(replayManager._scheduledCapture.sendIfReady);
 
     await replayManager.send(replayId);
-    sinon.assert.calledOnce(replayManager._leadingCapture.sendIfReady);
+    sinon.assert.calledOnce(replayManager._scheduledCapture.sendIfReady);
 
     await clock.tickAsync(5000);
 
-    sinon.assert.calledTwice(replayManager._leadingCapture.sendIfReady);
+    sinon.assert.calledTwice(replayManager._scheduledCapture.sendIfReady);
     expect(
-      replayManager._leadingCapture.sendIfReady.secondCall.args,
+      replayManager._scheduledCapture.sendIfReady.secondCall.args,
     ).to.deep.equal([replayId]);
 
-    replayManager._leadingCapture.sendIfReady.restore();
+    replayManager._scheduledCapture.sendIfReady.restore();
   });
 
   it('captures and sends leading replay with buffer-index', async function () {
@@ -177,7 +177,7 @@ describe('ReplayManager buffer-index integration', function () {
     await clock.tickAsync(100);
 
     const capturedCursor =
-      replayManager._leadingCapture._pending.get(replayId).bufferCursor;
+      replayManager._scheduledCapture._pending.get(replayId).bufferCursor;
     expect(capturedCursor).to.be.an('object');
     expect(capturedCursor).to.have.property('slot', 0);
     expect(capturedCursor).to.have.property('offset', 0);
@@ -205,7 +205,7 @@ describe('ReplayManager buffer-index integration', function () {
       { resourceSpans: [{ spanData: 'test' }] },
       { 'X-Rollbar-Replay-Id': replayId },
     ]);
-    expect(replayManager._leadingCapture._pending.has(replayId)).to.be.false;
+    expect(replayManager._scheduledCapture._pending.has(replayId)).to.be.false;
   });
 
   it('discards leading when trailing fails', async function () {
@@ -228,7 +228,7 @@ describe('ReplayManager buffer-index integration', function () {
     await clock.tickAsync(5000);
 
     sinon.assert.notCalled(tracing.exporter.post);
-    expect(replayManager._leadingCapture._pending.has(replayId)).to.be.false;
+    expect(replayManager._scheduledCapture._pending.has(replayId)).to.be.false;
   });
 
   it('waits while trailing is pending, then sends once trailing is SENT', async function () {
@@ -255,7 +255,8 @@ describe('ReplayManager buffer-index integration', function () {
 
     await clock.tickAsync(5000);
 
-    const pendingContext = replayManager._leadingCapture._pending.get(replayId);
+    const pendingContext =
+      replayManager._scheduledCapture._pending.get(replayId);
     expect(pendingContext.ready).to.be.true;
     sinon.assert.notCalled(tracing.exporter.post);
 
@@ -301,7 +302,7 @@ describe('ReplayManager buffer-index integration', function () {
       { resourceSpans: [{ spanData: 'test' }] },
       { 'X-Rollbar-Replay-Id': replayId },
     ]);
-    expect(replayManager._leadingCapture._pending.has(replayId)).to.be.false;
+    expect(replayManager._scheduledCapture._pending.has(replayId)).to.be.false;
   });
 
   it('does not schedule leading when trailing export throws', async function () {
@@ -317,7 +318,7 @@ describe('ReplayManager buffer-index integration', function () {
     await clock.tickAsync(100);
 
     expect(replayManager._map.has(replayId)).to.be.false;
-    expect(replayManager._leadingCapture._pending.has(replayId)).to.be.false;
+    expect(replayManager._scheduledCapture._pending.has(replayId)).to.be.false;
   });
 
   it('cleanup: discard cancels timer; success clears state', async function () {
@@ -336,7 +337,7 @@ describe('ReplayManager buffer-index integration', function () {
     replayManager.capture(replayId1, occurrenceUuid1, triggerContext);
     await clock.tickAsync(100);
 
-    expect(replayManager._leadingCapture._pending.has(replayId1)).to.be.true;
+    expect(replayManager._scheduledCapture._pending.has(replayId1)).to.be.true;
 
     replayManager.discard(replayId1);
     await clock.tickAsync(10000);
@@ -370,7 +371,7 @@ describe('ReplayManager buffer-index integration', function () {
       { resourceSpans: [{ spanData: 'test' }] },
       { 'X-Rollbar-Replay-Id': replayId2 },
     ]);
-    expect(replayManager._leadingCapture._pending.has(replayId2)).to.be.false;
+    expect(replayManager._scheduledCapture._pending.has(replayId2)).to.be.false;
     expect(replayManager._trailingStatus.has(replayId2)).to.be.false;
   });
 });
diff --git a/test/replay/unit/scheduledCapture.test.js b/test/replay/unit/scheduledCapture.test.js
