ref: Move check to _loadAndCheckSession

Author: mydea

packages/replay/src/replay.ts

@@ -149,7 +149,7 @@ export class ReplayContainer implements ReplayContainerInterface {
   public start(): void {
     this._setInitialState();
 
-    this._loadSession({ expiry: SESSION_IDLE_DURATION });
+    this._loadSession();
 
     // If there is no session, then something bad has happened - can't continue
     if (!this.session) {
@@ -258,8 +258,7 @@ export class ReplayContainer implements ReplayContainerInterface {
    * new DOM checkout.`
    */
   public resume(): void {
-    if (!this.session || !this.session.sampled) {
-      this.stop();
+    if (!this._loadAndCheckSession()) {
       return;
     }
 
@@ -309,12 +308,7 @@ export class ReplayContainer implements ReplayContainerInterface {
     if (!this._stopRecording) {
       // Create a new session, otherwise when the user action is flushed, it
       // will get rejected due to an expired session.
-      this._loadSession({ expiry: SESSION_IDLE_DURATION });
-
-      // We know this is set, because it is always set in _loadSession
-      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-      if (!this.session!.sampled) {
-        this.stop();
+      if (!this._loadAndCheckSession()) {
         return;
       }
 
@@ -354,7 +348,7 @@ export class ReplayContainer implements ReplayContainerInterface {
    * Returns true if session is not expired, false otherwise.
    * @hidden
    */
-  public checkAndHandleExpiredSession({ expiry = SESSION_IDLE_DURATION }: { expiry?: number } = {}): boolean | void {
+  public checkAndHandleExpiredSession(expiry?: number): boolean | void {
     const oldSessionId = this.getSessionId();
 
     // Prevent starting a new session if the last user activity is older than
@@ -369,12 +363,7 @@ export class ReplayContainer implements ReplayContainerInterface {
 
     // --- There is recent user activity --- //
     // This will create a new session if expired, based on expiry length
-    this._loadSession({ expiry });
-
-    // We know this is set, because it is always set in _loadSession
-    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-    if (!this.session!.sampled) {
-      this.stop();
+    if (!this._loadAndCheckSession(expiry)) {
       return;
     }
 
@@ -404,7 +393,7 @@ export class ReplayContainer implements ReplayContainerInterface {
    * Loads a session from storage, or creates a new one if it does not exist or
    * is expired.
    */
-  private _loadSession({ expiry }: { expiry: number }): void {
+  private _loadSession(expiry = SESSION_IDLE_DURATION): void {
     const { type, session } = getSession({
       expiry,
       stickySession: Boolean(this._options.stickySession),
@@ -630,9 +619,7 @@ export class ReplayContainer implements ReplayContainerInterface {
       return;
     }
 
-    const isSessionActive = this.checkAndHandleExpiredSession({
-      expiry: VISIBILITY_CHANGE_TIMEOUT,
-    });
+    const isSessionActive = this.checkAndHandleExpiredSession(VISIBILITY_CHANGE_TIMEOUT);
 
     if (!isSessionActive) {
       // If the user has come back to the page within VISIBILITY_CHANGE_TIMEOUT
@@ -891,4 +878,18 @@ export class ReplayContainer implements ReplayContainerInterface {
       }, rateLimitDuration);
     }
   }
+
+  /** Loads (or refreshes) the current session. Returns false if session is not recorded. */
+  private _loadAndCheckSession(expiry?: number): boolean {
+    this._loadSession(expiry);
+
+    // We know this is set, because it is always set in _loadSession
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    if (!this.session!.sampled) {
+      this.stop();
+      return false;
+    }
+
+    return true;
+  }
 }

packages/replay/test/integration/events.test.ts

@@ -40,7 +40,7 @@ describe('Integration | events', () => {
     // 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['_loadSession']({ expiry: 0 });
+    replay['_loadSession'](0);
     mockTransportSend.mockClear();
   });
 
@@ -93,7 +93,7 @@ describe('Integration | events', () => {
 
   it('has correct timestamps when there are events earlier than initial timestamp', async function () {
     clearSession(replay);
-    replay['_loadSession']({ expiry: 0 });
+    replay['_loadSession'](0);
     mockTransportSend.mockClear();
     Object.defineProperty(document, 'visibilityState', {
       configurable: true,

packages/replay/test/integration/flush.test.ts

@@ -95,7 +95,7 @@ describe('Integration | flush', () => {
     jest.setSystemTime(new Date(BASE_TIMESTAMP));
     sessionStorage.clear();
     clearSession(replay);
-    replay['_loadSession']({ expiry: SESSION_IDLE_DURATION });
+    replay['_loadSession'](SESSION_IDLE_DURATION);
     mockRecord.takeFullSnapshot.mockClear();
     Object.defineProperty(WINDOW, 'location', {
       value: prevLocation,

packages/replay/test/integration/rateLimiting.test.ts

@@ -46,7 +46,7 @@ describe('Integration | rate-limiting behaviour', () => {
     // 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['_loadSession']({ expiry: 0 });
+    replay['_loadSession'](0);
 
     mockSendReplayRequest.mockClear();
   });
@@ -57,7 +57,7 @@ describe('Integration | rate-limiting behaviour', () => {
     jest.setSystemTime(new Date(BASE_TIMESTAMP));
     clearSession(replay);
     jest.clearAllMocks();
-    replay['_loadSession']({ expiry: SESSION_IDLE_DURATION });
+    replay['_loadSession'](SESSION_IDLE_DURATION);
   });
 
   afterAll(() => {

packages/replay/test/integration/sendReplayEvent.test.ts

@@ -59,7 +59,7 @@ describe('Integration | sendReplayEvent', () => {
     // 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['_loadSession']({ expiry: 0 });
+    replay['_loadSession'](0);
 
     mockSendReplayRequest.mockClear();
   });
@@ -69,7 +69,7 @@ describe('Integration | sendReplayEvent', () => {
     await new Promise(process.nextTick);
     jest.setSystemTime(new Date(BASE_TIMESTAMP));
     clearSession(replay);
-    replay['_loadSession']({ expiry: SESSION_IDLE_DURATION });
+    replay['_loadSession'](SESSION_IDLE_DURATION);
   });
 
   afterAll(() => {

packages/replay/test/integration/session.test.ts

@@ -451,7 +451,7 @@ describe('Integration | session', () => {
 
   it('increases segment id after each event', async () => {
     clearSession(replay);
-    replay['_loadSession']({ expiry: 0 });
+    replay['_loadSession'](0);
 
     Object.defineProperty(document, 'visibilityState', {
       configurable: true,

packages/replay/test/integration/stop.test.ts

@@ -44,7 +44,7 @@ describe('Integration | stop', () => {
     jest.setSystemTime(new Date(BASE_TIMESTAMP));
     sessionStorage.clear();
     clearSession(replay);
-    replay['_loadSession']({ expiry: SESSION_IDLE_DURATION });
+    replay['_loadSession'](SESSION_IDLE_DURATION);
     mockRecord.takeFullSnapshot.mockClear();
     mockAddInstrumentationHandler.mockClear();
     Object.defineProperty(WINDOW, 'location', {