fix(replay): Add app lifecycle breadcrumbs conversion tests (#3932)

Author: krystofwoldrich

CHANGELOG.md

@@ -17,6 +17,10 @@
   module.exports = withSentryConfig(getDefaultConfig(__dirname), { annotateReactComponents: true });
   ```
 
+### Fixes
+
+- Add `app.foreground/background` breadcrumbs to iOS Replays ([#3932](https://github.com/getsentry/sentry-react-native/pull/3932))
+
 ## 5.25.0-alpha.2
 
 ### Features

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

@@ -2,6 +2,7 @@ package io.sentry.rnsentryandroidtester
 
 import io.sentry.Breadcrumb
 import io.sentry.react.RNSentryReplayBreadcrumbConverter
+import io.sentry.rrweb.RRWebBreadcrumbEvent
 import org.junit.Assert.assertEquals
 import org.junit.Test
 import org.junit.runner.RunWith
@@ -10,6 +11,30 @@ import org.junit.runners.JUnit4
 @RunWith(JUnit4::class)
 class RNSentryReplayBreadcrumbConverterTest {
 
+    @Test
+    fun testConvertForegroundBreadcrumb() {
+        val converter = RNSentryReplayBreadcrumbConverter()
+        val testBreadcrumb = Breadcrumb()
+        testBreadcrumb.type = "navigation"
+        testBreadcrumb.category = "app.lifecycle"
+        testBreadcrumb.setData("state", "foreground");
+        val actual = converter.convert(testBreadcrumb) as RRWebBreadcrumbEvent
+
+        assertEquals("app.foreground", actual.category)
+    }
+
+    @Test
+    fun testConvertBackgroundBreadcrumb() {
+        val converter = RNSentryReplayBreadcrumbConverter()
+        val testBreadcrumb = Breadcrumb()
+        testBreadcrumb.type = "navigation"
+        testBreadcrumb.category = "app.lifecycle"
+        testBreadcrumb.setData("state", "background");
+        val actual = converter.convert(testBreadcrumb) as RRWebBreadcrumbEvent
+
+        assertEquals("app.background", actual.category)
+    }
+
     @Test
     fun doesNotConvertSentryEventBreadcrumb() {
         val converter = RNSentryReplayBreadcrumbConverter()

RNSentryCocoaTester/RNSentryCocoaTesterTests/RNSentryReplayBreadcrumbConverterTests.swift

@@ -2,6 +2,34 @@ import XCTest
 
 final class RNSentryReplayBreadcrumbConverterTests: XCTestCase {
 
+    func testConvertForegroundBreadcrumb() {
+        let converter = RNSentryReplayBreadcrumbConverter()
+        let testBreadcrumb = Breadcrumb()
+        testBreadcrumb.type = "navigation"
+        testBreadcrumb.category = "app.lifecycle"
+        testBreadcrumb.data = ["state": "foreground"]
+        let actual = converter.convert(from: testBreadcrumb)
+
+        XCTAssertNotNil(actual)
+        let data = actual!.serialize()["data"] as! [String: Any?];
+        let payload = data["payload"] as! [String: Any?];
+        XCTAssertEqual(payload["category"] as! String, "app.foreground")
+    }
+
+    func testConvertBackgroundBreadcrumb() {
+        let converter = RNSentryReplayBreadcrumbConverter()
+        let testBreadcrumb = Breadcrumb()
+        testBreadcrumb.type = "navigation"
+        testBreadcrumb.category = "app.lifecycle"
+        testBreadcrumb.data = ["state": "background"]
+        let actual = converter.convert(from: testBreadcrumb)
+
+        XCTAssertNotNil(actual)
+        let data = actual!.serialize()["data"] as! [String: Any?];
+        let payload = data["payload"] as! [String: Any?];
+        XCTAssertEqual(payload["category"] as! String, "app.background")
+    }
+
     func testNotConvertSentryEventBreadcrumb() {
         let converter = RNSentryReplayBreadcrumbConverter()
         let testBreadcrumb = Breadcrumb()

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

@@ -29,6 +29,10 @@ public RNSentryReplayBreadcrumbConverter() {
       breadcrumb.getCategory().equals("sentry.transaction")) {
       return null;
     }
+    if (breadcrumb.getCategory().equals("http")) {
+      // Drop native http breadcrumbs to avoid duplicates
+      return null;
+    }
 
     if (breadcrumb.getCategory().equals("touch")) {
       return convertTouchBreadcrumb(breadcrumb);
@@ -42,10 +46,6 @@ public RNSentryReplayBreadcrumbConverter() {
     if (breadcrumb.getCategory().equals("xhr")) {
       return convertNetworkBreadcrumb(breadcrumb);
     }
-    if (breadcrumb.getCategory().equals("http")) {
-      // Drop native http breadcrumbs to avoid duplicates
-      return null;
-    }
 
     RRWebEvent nativeBreadcrumb = super.convert(breadcrumb);
 

ios/RNSentryReplayBreadcrumbConverter.m

@@ -25,15 +25,11 @@ - (instancetype _Nonnull)init {
     // Do not add Sentry Event breadcrumbs to replay
     return nil;
   }
-  
+
   if ([breadcrumb.category isEqualToString:@"http"]) {
     // Drop native network breadcrumbs to avoid duplicates
     return nil;
   }
-  if ([breadcrumb.type isEqualToString:@"navigation"] && ![breadcrumb.category isEqualToString:@"navigation"]) {
-    // Drop native navigation breadcrumbs to avoid duplicates
-    return nil;
-  }
 
   if ([breadcrumb.category isEqualToString:@"touch"]) {
     return [self convertTouch:breadcrumb];
@@ -71,7 +67,7 @@ - (instancetype _Nonnull)init {
   if (breadcrumb.data == nil) {
     return nil;
   }
-  
+
   NSMutableArray *path = [breadcrumb.data valueForKey:@"path"];
   NSString* message = [RNSentryReplayBreadcrumbConverter getTouchPathMessageFrom:path];
 
@@ -87,7 +83,7 @@ + (NSString* _Nullable) getTouchPathMessageFrom:(NSArray* _Nullable) path {
   if (path == nil) {
     return nil;
   }
-  
+
   NSInteger pathCount = [path count];
   if (pathCount <= 0) {
     return nil;
@@ -129,7 +125,7 @@ + (NSString* _Nullable) getTouchPathMessageFrom:(NSArray* _Nullable) path {
       [message appendString:@" > "];
     }
   }
-  
+
   return message;
 }