test(replay): Streamline replay mocking (#6438)

Author: mydea

packages/replay/src/integration.ts

@@ -30,8 +30,13 @@ export class Replay implements Integration {
 
   readonly options: ReplayPluginOptions;
 
-  /** In tests, this is only called the first time */
-  protected _hasCalledSetupOnce: boolean = false;
+  protected get _isInitialized(): boolean {
+    return _initialized;
+  }
+
+  protected set _isInitialized(value: boolean) {
+    _initialized = value;
+  }
 
   private _replay?: ReplayContainer;
 
@@ -112,13 +117,13 @@ Sentry.init({ replaysOnErrorSampleRate: ${errorSampleRate} })`,
         : `${this.recordingOptions.blockSelector},${MEDIA_SELECTORS}`;
     }
 
-    if (isBrowser() && _initialized) {
+    if (isBrowser() && this._isInitialized) {
       const error = new Error('Multiple Sentry Session Replay instances are not supported');
       captureInternalException(error);
       throw error;
     }
 
-    _initialized = true;
+    this._isInitialized = true;
   }
 
   /**
@@ -137,7 +142,6 @@ Sentry.init({ replaysOnErrorSampleRate: ${errorSampleRate} })`,
     }
 
     this._setup();
-    this._hasCalledSetupOnce = true;
 
     // XXX: See method comments above
     setTimeout(() => this.start());

packages/replay/test/mocks/mockSdk.ts

@@ -1,4 +1,4 @@
-import type { BrowserOptions } from '@sentry/browser';
+import { BrowserOptions, init } from '@sentry/browser';
 import { Envelope, Transport } from '@sentry/types';
 
 import { Replay as ReplayIntegration } from '../../src';
@@ -39,10 +39,24 @@ export async function mockSdk({ replayOptions, sentryOptions }: MockSdkParams =
   replay: ReplayContainer;
   integration: ReplayIntegration;
 }> {
-  const { init } = jest.requireActual('@sentry/browser');
-
   const { Replay } = await import('../../src');
-  const replayIntegration = new Replay({
+
+  // Scope this to the test, instead of the module
+  let _initialized = false;
+  class TestReplayIntegration extends Replay {
+    protected get _isInitialized(): boolean {
+      return _initialized;
+    }
+    protected set _isInitialized(value: boolean) {
+      _initialized = value;
+    }
+
+    public setupOnce(): void {
+      // do nothing
+    }
+  }
+
+  const replayIntegration = new TestReplayIntegration({
     stickySession: false,
     ...replayOptions,
   });
@@ -54,18 +68,14 @@ export async function mockSdk({ replayOptions, sentryOptions }: MockSdkParams =
     transport: () => new MockTransport(),
     replaysSessionSampleRate: 1.0,
     replaysOnErrorSampleRate: 0.0,
+    defaultIntegrations: false,
     ...sentryOptions,
     integrations: [replayIntegration],
   });
 
-  // setupOnce is only called the first time, so we ensure to manually run setup in subsequent calls
-  if (replayIntegration['_hasCalledSetupOnce']) {
-    // The first time the integration is used, `start()` is called (in setupOnce)
-    // For consistency, we want to stop that
-    replayIntegration.stop();
-  } else {
-    replayIntegration['_setup']();
-  }
+  // Instead of `setupOnce`, which is tricky to test, we call this manually here
+  replayIntegration['_setup']();
+  replayIntegration.start();
 
   const replay = replayIntegration['_replay']!;
 

packages/replay/test/mocks/index.ts renamed to packages/replay/test/mocks/resetSdkMock.ts

@@ -3,7 +3,7 @@ import { getCurrentHub } from '@sentry/core';
 import { ReplayContainer } from '../../src/replay';
 import { BASE_TIMESTAMP, RecordMock } from './../index';
 import { DomHandler, MockTransportSend } from './../types';
-import { MockSdkParams } from './mockSdk';
+import { mockSdk, MockSdkParams } from './mockSdk';
 
 export async function resetSdkMock({ replayOptions, sentryOptions }: MockSdkParams): Promise<{
   domHandler: DomHandler;
@@ -36,7 +36,6 @@ export async function resetSdkMock({ replayOptions, sentryOptions }: MockSdkPara
   const SentryCore = await import('@sentry/core');
   const spyCaptureException = jest.spyOn(SentryCore, 'captureException');
 
-  const { mockSdk } = await import('./mockSdk');
   const { replay } = await mockSdk({
     replayOptions,
     sentryOptions,

packages/replay/test/unit/index-errorSampleRate.test.ts

@@ -6,7 +6,7 @@ import { REPLAY_SESSION_KEY, VISIBILITY_CHANGE_TIMEOUT, WINDOW } from '../../src
 import { ReplayContainer } from './../../src/replay';
 import { PerformanceEntryResource } from './../fixtures/performanceEntry/resource';
 import { BASE_TIMESTAMP, RecordMock } from './../index';
-import { resetSdkMock } from './../mocks';
+import { resetSdkMock } from './../mocks/resetSdkMock';
 import { DomHandler, MockTransportSend } from './../types';
 import { useFakeTimers } from './../utils/use-fake-timers';
 

packages/replay/test/unit/index-handleGlobalEvent.test.ts

@@ -4,7 +4,7 @@ import { REPLAY_EVENT_NAME } from '../../src/constants';
 import { ReplayContainer } from './../../src/replay';
 import { Error } from './../fixtures/error';
 import { Transaction } from './../fixtures/transaction';
-import { resetSdkMock } from './../mocks';
+import { resetSdkMock } from './../mocks/resetSdkMock';
 import { useFakeTimers } from './../utils/use-fake-timers';
 
 useFakeTimers();

packages/replay/test/unit/index.test.ts

@@ -10,7 +10,7 @@ import { RecordingEvent } from '../../src/types';
 import { useFakeTimers } from '../utils/use-fake-timers';
 import { PerformanceEntryResource } from './../fixtures/performanceEntry/resource';
 import { BASE_TIMESTAMP, RecordMock } from './../index';
-import { resetSdkMock } from './../mocks';
+import { resetSdkMock } from './../mocks/resetSdkMock';
 import { DomHandler, MockTransportSend } from './../types';
 
 useFakeTimers();