feat(replay): Deprecate old replay sample rate configs (#6414)

Author: mydea

packages/replay/src/index.ts

@@ -146,8 +146,8 @@ export class Replay implements Integration {
     initialFlushDelay = 5000,
     stickySession = true,
     useCompression = true,
-    sessionSampleRate = DEFAULT_SESSION_SAMPLE_RATE,
-    errorSampleRate = DEFAULT_ERROR_SAMPLE_RATE,
+    sessionSampleRate,
+    errorSampleRate,
     maskAllText = true,
     maskAllInputs = true,
     blockAllMedia = true,
@@ -171,13 +171,37 @@ export class Replay implements Integration {
       flushMaxDelay,
       stickySession,
       initialFlushDelay,
-      sessionSampleRate,
-      errorSampleRate,
+      sessionSampleRate: DEFAULT_SESSION_SAMPLE_RATE,
+      errorSampleRate: DEFAULT_ERROR_SAMPLE_RATE,
       useCompression,
       maskAllText,
       blockAllMedia,
     };
 
+    if (typeof sessionSampleRate === 'number') {
+      // eslint-disable-next-line
+      console.warn(
+        `[Replay] You are passing \`sessionSampleRate\` to the Replay integration.
+This option is deprecated and will be removed soon.
+Instead, configure \`replaysSessionSampleRate\` directly in the SDK init options, e.g.:
+Sentry.init({ replaysSessionSampleRate: ${sessionSampleRate} })`,
+      );
+
+      this.options.sessionSampleRate = sessionSampleRate;
+    }
+
+    if (typeof errorSampleRate === 'number') {
+      // eslint-disable-next-line
+      console.warn(
+        `[Replay] You are passing \`errorSampleRate\` to the Replay integration.
+This option is deprecated and will be removed soon.
+Instead, configure \`replaysOnErrorSampleRate\` directly in the SDK init options, e.g.:
+Sentry.init({ replaysOnErrorSampleRate: ${errorSampleRate} })`,
+      );
+
+      this.options.errorSampleRate = errorSampleRate;
+    }
+
     if (this.options.maskAllText) {
       // `maskAllText` is a more user friendly option to configure
       // `maskTextSelector`. This means that all nodes will have their text
@@ -1354,11 +1378,11 @@ export class Replay implements Integration {
     const client = getCurrentHub().getClient() as BrowserClient | undefined;
     const opt = client && (client.getOptions() as BrowserOptions | undefined);
 
-    if (opt && opt.replaysSessionSampleRate) {
+    if (opt && typeof opt.replaysSessionSampleRate === 'number') {
       this.options.sessionSampleRate = opt.replaysSessionSampleRate;
     }
 
-    if (opt && opt.replaysOnErrorSampleRate) {
+    if (opt && typeof opt.replaysOnErrorSampleRate === 'number') {
       this.options.errorSampleRate = opt.replaysOnErrorSampleRate;
     }
   }

packages/replay/src/types.ts

@@ -103,22 +103,6 @@ export interface ReplayPluginOptions extends SessionOptions {
    */
   useCompression: boolean;
 
-  /**
-   * Only capture replays when an error happens
-   *
-   * @deprecated
-   * @see errorSampleRate
-   */
-  captureOnlyOnError?: boolean;
-
-  /**
-   * The sample rate for replays. 1.0 will record all replays, 0 will record none.
-   *
-   * @deprecated
-   * @see sessionSampleRate
-   */
-  replaysSamplingRate?: number;
-
   /**
    * Mask all text in recordings. All text will be replaced with asterisks by default.
    */

packages/replay/test/mocks/index.ts

@@ -1,11 +1,11 @@
 import { getCurrentHub } from '@sentry/core';
 
-import { ReplayConfiguration } from '../../src/types';
 import { Replay } from './../../src';
 import { BASE_TIMESTAMP, RecordMock } from './../index';
 import { DomHandler, MockTransportSend } from './../types';
+import { MockSdkParams } from './mockSdk';
 
-export async function resetSdkMock(options?: ReplayConfiguration): Promise<{
+export async function resetSdkMock({ replayOptions, sentryOptions }: MockSdkParams): Promise<{
   domHandler: DomHandler;
   mockRecord: RecordMock;
   mockTransportSend: MockTransportSend;
@@ -38,9 +38,8 @@ export async function resetSdkMock(options?: ReplayConfiguration): Promise<{
 
   const { mockSdk } = await import('./mockSdk');
   const { replay } = await mockSdk({
-    replayOptions: {
-      ...options,
-    },
+    replayOptions,
+    sentryOptions,
   });
 
   const mockTransportSend = getCurrentHub()?.getClient()?.getTransport()?.send as MockTransportSend;

packages/replay/test/mocks/mockSdk.ts

@@ -4,7 +4,7 @@ import { Envelope, Transport } from '@sentry/types';
 import { Replay as ReplayClass } from '../../src';
 import { ReplayConfiguration } from '../../src/types';
 
-interface MockSdkParams {
+export interface MockSdkParams {
   replayOptions?: ReplayConfiguration;
   sentryOptions?: BrowserOptions;
 }
@@ -34,25 +34,25 @@ class MockTransport implements Transport {
   }
 }
 
-export async function mockSdk({
-  replayOptions = {
+export async function mockSdk({ replayOptions, sentryOptions }: MockSdkParams = {}): Promise<{ replay: ReplayClass }> {
+  const { init } = jest.requireActual('@sentry/browser');
+
+  const { Replay } = await import('../../src');
+  const replay = new Replay({
     stickySession: false,
-    sessionSampleRate: 1.0,
-    errorSampleRate: 0.0,
-  },
-  sentryOptions = {
+    ...replayOptions,
+  });
+
+  init({
     dsn: 'https://[email protected]/1',
     autoSessionTracking: false,
     sendClientReports: false,
     transport: () => new MockTransport(),
-  },
-}: MockSdkParams = {}): Promise<{ replay: ReplayClass }> {
-  const { init } = jest.requireActual('@sentry/browser');
-
-  const { Replay } = await import('../../src');
-  const replay = new Replay(replayOptions);
-
-  init({ ...sentryOptions, integrations: [replay] });
+    replaysSessionSampleRate: 1.0,
+    replaysOnErrorSampleRate: 0.0,
+    ...sentryOptions,
+    integrations: [replay],
+  });
 
   // setupOnce is only called the first time, so we ensure to re-parse the options every time
   replay['_loadReplayOptionsFromClient']();

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

@@ -25,11 +25,14 @@ describe('Replay (errorSampleRate)', () => {
 
   beforeEach(async () => {
     ({ mockRecord, mockTransportSend, domHandler, replay } = await resetSdkMock({
-      errorSampleRate: 1.0,
-      sessionSampleRate: 0.0,
-      stickySession: true,
+      replayOptions: {
+        stickySession: true,
+      },
+      sentryOptions: {
+        replaysSessionSampleRate: 0.0,
+        replaysOnErrorSampleRate: 1.0,
+      },
     }));
-    // jest.advanceTimersToNextTimer();
   });
 
   afterEach(async () => {
@@ -322,7 +325,9 @@ describe('Replay (errorSampleRate)', () => {
       `{"segmentId":0,"id":"fd09adfc4117477abc8de643e5a5798a","sampled":"error","started":${BASE_TIMESTAMP},"lastActivity":${BASE_TIMESTAMP}}`,
     );
     ({ mockRecord, mockTransportSend, replay } = await resetSdkMock({
-      stickySession: true,
+      replayOptions: {
+        stickySession: true,
+      },
     }));
     replay.start();
 

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

@@ -12,9 +12,13 @@ let replay: Replay;
 
 beforeEach(async () => {
   ({ replay } = await resetSdkMock({
-    errorSampleRate: 1.0,
-    sessionSampleRate: 0.0,
-    stickySession: false,
+    replayOptions: {
+      stickySession: false,
+    },
+    sentryOptions: {
+      replaysSessionSampleRate: 0.0,
+      replaysOnErrorSampleRate: 1.0,
+    },
   }));
 });
 
@@ -106,10 +110,7 @@ it('strips out dropped events from errorIds', async () => {
 });
 
 it('tags errors and transactions with replay id for session samples', async () => {
-  ({ replay } = await resetSdkMock({
-    sessionSampleRate: 1.0,
-    errorSampleRate: 0,
-  }));
+  ({ replay } = await resetSdkMock({}));
   replay.start();
   const transaction = Transaction();
   const error = Error();