fix: Exclude client reports from offline storage

Author: timfish

packages/core/src/transports/offline.ts

@@ -1,22 +1,10 @@
 import type { Envelope, InternalBaseTransportOptions, Transport, TransportMakeRequestResponse } from '@sentry/types';
-import { forEachEnvelopeItem, logger, parseRetryAfterHeader } from '@sentry/utils';
+import { envelopeContainItemType, logger, parseRetryAfterHeader } from '@sentry/utils';
 
 export const MIN_DELAY = 100; // 100 ms
 export const START_DELAY = 5_000; // 5 seconds
 const MAX_DELAY = 3.6e6; // 1 hour
 
-function isReplayEnvelope(envelope: Envelope): boolean {
-  let isReplay = false;
-
-  forEachEnvelopeItem(envelope, (_, type) => {
-    if (type === 'replay_event') {
-      isReplay = true;
-    }
-  });
-
-  return isReplay;
-}
-
 function log(msg: string, error?: Error): void {
   __DEBUG_BUILD__ && logger.info(`[Offline]: ${msg}`, error);
 }
@@ -74,7 +62,8 @@ export function makeOfflineTransport<TO>(
       // We don't queue Session Replay envelopes because they are:
       // - Ordered and Replay relies on the response status to know when they're successfully sent.
       // - Likely to fill the queue quickly and block other events from being sent.
-      if (isReplayEnvelope(env)) {
+      // We also want to drop client reports because they can be generated when we retry sending events while offline.
+      if (envelopeContainItemType(env, 'replay_event', 'replay_recording', 'client_report')) {
         return false;
       }
 

packages/utils/src/envelope.ts

@@ -53,6 +53,21 @@ export function forEachEnvelopeItem<E extends Envelope>(
   });
 }
 
+/**
+ * Returns true if the envelope contains any of the given envelope item types
+ */
+export function envelopeContainItemType(envelope: Envelope, ...types: EnvelopeItemType[]): boolean {
+  let isType = false;
+
+  forEachEnvelopeItem(envelope, (_, type) => {
+    if (types.includes(type)) {
+      isType = true;
+    }
+  });
+
+  return isType;
+}
+
 /**
  * Encode a string to UTF8.
  */