feat(replay): Filter Sentry event breadcrumbs (#3925)

Author: krystofwoldrich

CHANGELOG.md

@@ -7,6 +7,7 @@
 - Improve touch event component info if annotated with [`@sentry/babel-plugin-component-annotate`](https://www.npmjs.com/package/@sentry/babel-plugin-component-annotate) ([#3899](https://github.com/getsentry/sentry-react-native/pull/3899))
 - Add replay breadcrumbs for touch & navigation events ([#3846](https://github.com/getsentry/sentry-react-native/pull/3846))
 - Add network data to Session Replays ([#3912](https://github.com/getsentry/sentry-react-native/pull/3912))
+- Filter Sentry Event Breadcrumbs from Mobile Replays ([#3925](https://github.com/getsentry/sentry-react-native/pull/3925))
 
 ### Dependencies
 

RNSentryAndroidTester/app/src/test/java/io/sentry/rnsentryandroidtester/RNSentryReplayBreadcrumbConverterTest.kt

@@ -1,5 +1,6 @@
 package io.sentry.rnsentryandroidtester
 
+import io.sentry.Breadcrumb
 import io.sentry.react.RNSentryReplayBreadcrumbConverter
 import org.junit.Assert.assertEquals
 import org.junit.Test
@@ -9,6 +10,24 @@ import org.junit.runners.JUnit4
 @RunWith(JUnit4::class)
 class RNSentryReplayBreadcrumbConverterTest {
 
+    @Test
+    fun doesNotConvertSentryEventBreadcrumb() {
+        val converter = RNSentryReplayBreadcrumbConverter()
+        val testBreadcrumb = Breadcrumb();
+        testBreadcrumb.category = "sentry.event"
+        val actual = converter.convert(testBreadcrumb)
+        assertEquals(null, actual)
+    }
+
+    @Test
+    fun doesNotConvertSentryTransactionBreadcrumb() {
+        val converter = RNSentryReplayBreadcrumbConverter()
+        val testBreadcrumb = Breadcrumb();
+        testBreadcrumb.category = "sentry.transaction"
+        val actual = converter.convert(testBreadcrumb)
+        assertEquals(null, actual)
+    }
+
     @Test
     fun doesNotConvertNullPath() {
         val actual = RNSentryReplayBreadcrumbConverter.getTouchPathMessage(null)
@@ -52,4 +71,4 @@ class RNSentryReplayBreadcrumbConverterTest {
             mapOf("name" to "name7")))
         assertEquals("label5(element5, file5) > label4(file4) > label3(element3) > label2", actual)
     }
-}
+}

RNSentryCocoaTester/RNSentryCocoaTesterTests/RNSentryReplayBreadcrumbConverterTests.swift

@@ -2,13 +2,29 @@ import XCTest
 
 final class RNSentryReplayBreadcrumbConverterTests: XCTestCase {
 
+    func testNotConvertSentryEventBreadcrumb() {
+        let converter = RNSentryReplayBreadcrumbConverter()
+        let testBreadcrumb = Breadcrumb()
+        testBreadcrumb.category = "sentry.event"
+        let actual = converter.convert(from: testBreadcrumb)
+        XCTAssertNil(actual)
+    }
+
+    func testNotConvertSentryTransactionBreadcrumb() {
+        let converter = RNSentryReplayBreadcrumbConverter()
+        let testBreadcrumb = Breadcrumb()
+        testBreadcrumb.category = "sentry.transaction"
+        let actual = converter.convert(from: testBreadcrumb)
+        XCTAssertNil(actual)
+    }
+
     func testTouchMessageReturnsNilOnEmptyArray() throws {
-      let actual = RNSentryReplayBreadcrumbConverter.getTouchPathMessage(from: [])
+        let actual = RNSentryReplayBreadcrumbConverter.getTouchPathMessage(from: [])
         XCTAssertEqual(actual, nil);
     }
 
     func testTouchMessageReturnsNilOnNilArray() throws {
-      let actual = RNSentryReplayBreadcrumbConverter.getTouchPathMessage(from: nil as [Any]?)
+        let actual = RNSentryReplayBreadcrumbConverter.getTouchPathMessage(from: nil as [Any]?)
         XCTAssertEqual(actual, nil);
     }
 

android/src/main/java/io/sentry/react/RNSentryReplayBreadcrumbConverter.java

@@ -24,6 +24,12 @@ public RNSentryReplayBreadcrumbConverter() {
       return null;
     }
 
+    // Do not add Sentry Event breadcrumbs to replay
+    if (breadcrumb.getCategory().equals("sentry.event") ||
+      breadcrumb.getCategory().equals("sentry.transaction")) {
+      return null;
+    }
+
     if (breadcrumb.getCategory().equals("touch")) {
       return convertTouchBreadcrumb(breadcrumb);
     }

ios/RNSentryReplayBreadcrumbConverter.h

@@ -10,5 +10,7 @@
 
 + (NSString* _Nullable) getTouchPathMessageFrom:(NSArray* _Nullable) path;
 
+- (id<SentryRRWebEvent> _Nullable)convertFrom:(SentryBreadcrumb *_Nonnull) breadcrumb;
+
 @end
 #endif

ios/RNSentryReplayBreadcrumbConverter.m

@@ -20,6 +20,12 @@ - (instancetype _Nonnull)init {
     (SentryBreadcrumb *_Nonnull)breadcrumb {
   assert(breadcrumb.timestamp != nil);
 
+  if ([breadcrumb.category isEqualToString:@"sentry.event"] ||
+      [breadcrumb.category isEqualToString:@"sentry.transaction"]) {
+    // Do not add Sentry Event breadcrumbs to replay
+    return nil;
+  }
+  
   if ([breadcrumb.category isEqualToString:@"http"]) {
     // Drop native network breadcrumbs to avoid duplicates
     return nil;