feat(replay): Do not capture errors originating from rrweb (getsentry#6521)

mydea · web-flow · commit 967dfb1c870e · 2022-12-14T11:08:19.000+01:00
Unless using `captureExceptions` experiment, we want to ignore these errors.
diff --git a/packages/replay/src/coreHandlers/handleGlobalEvent.ts b/packages/replay/src/coreHandlers/handleGlobalEvent.ts
@@ -1,13 +1,15 @@
 import { addBreadcrumb } from '@sentry/core';
 import { Event } from '@sentry/types';
+import { logger } from '@sentry/utils';
 
 import { REPLAY_EVENT_NAME, UNABLE_TO_SEND_REPLAY } from '../constants';
 import type { ReplayContainer } from '../types';
+import { isRrwebError } from '../util/isRrwebError';
 
 /**
  * Returns a listener to be added to `addGlobalEventProcessor(listener)`.
  */
-export function handleGlobalEventListener(replay: ReplayContainer): (event: Event) => Event {
+export function handleGlobalEventListener(replay: ReplayContainer): (event: Event) => Event | null {
   return (event: Event) => {
     // Do not apply replayId to the root event
     if (
@@ -20,6 +22,13 @@ export function handleGlobalEventListener(replay: ReplayContainer): (event: Even
       return event;
     }
 
+    // Unless `captureExceptions` is enabled, we want to ignore errors coming from rrweb
+    // As there can be a bunch of stuff going wrong in internals there, that we don't want to bubble up to users
+    if (isRrwebError(event) && !replay.getOptions()._experiments?.captureExceptions) {
+      __DEBUG_BUILD__ && logger.log('[Replay] Ignoring error from rrweb internals', event);
+      return null;
+    }
+
     // Only tag transactions with replayId if not waiting for an error
     // @ts-ignore private
     if (event.type !== 'transaction' || replay.recordingMode === 'session') {
diff --git a/packages/replay/src/util/isRrwebError.ts b/packages/replay/src/util/isRrwebError.ts
@@ -0,0 +1,16 @@
+import { Event } from '@sentry/types';
+
+export function isRrwebError(event: Event): boolean {
+  if (event.type || !event.exception?.values?.length) {
+    return false;
+  }
+
+  // Check if any exception originates from rrweb
+  return event.exception.values.some(exception => {
+    if (!exception.stacktrace?.frames?.length) {
+      return false;
+    }
+
+    return exception.stacktrace.frames.some(frame => frame.filename?.includes('/rrweb/src/'));
+  });
+}
diff --git a/packages/replay/test/unit/index-handleGlobalEvent.test.ts b/packages/replay/test/unit/index-handleGlobalEvent.test.ts
