fix: Propagate span when copying scope (#2952)

Previously, copied scopes (such as those created in -[SentrySDK captureEvent:withScopeBlock:]) did not inherit the original scope's span. This resulted in emitted events not linking back to the relevant span. Other SDKs do copy over the parent span/transaction. This is fixed now.

Author: kabiroberai

CHANGELOG.md

@@ -17,6 +17,7 @@
 - Possible crash in Core Data tracking (#2865)
 - Ensure the current GPU frame rate is always reported for concurrent transaction profiling metrics (#2929)
 - Move profiler metric collection to a background queue (#2956)
+- Propagate span when copying scope (#2952)
 
 ## 8.5.0
 

Sources/Sentry/SentryScope.m

@@ -115,6 +115,7 @@ - (instancetype)initWithScope:(SentryScope *)scope
         self.distString = scope.distString;
         self.environmentString = scope.environmentString;
         self.levelEnum = scope.levelEnum;
+        self.span = scope.span;
     }
     return self;
 }

Tests/SentryTests/SentryScopeSwiftTests.swift

@@ -118,6 +118,37 @@ class SentryScopeSwiftTests: XCTestCase {
         XCTAssertNil(actual["transaction"])
         XCTAssertNotNil(actual["breadcrumbs"])
     }
+
+    func testInitWithScope() {
+        let scope = fixture.scope
+        scope.span = fixture.transaction
+
+        let snapshot = scope.serialize() as! [String: AnyHashable]
+
+        let cloned = Scope(scope: scope)
+        XCTAssertEqual(cloned.serialize() as! [String: AnyHashable], snapshot)
+
+        let (event1, event2) = (Event(), Event())
+        (event1.timestamp, event2.timestamp) = (fixture.date, fixture.date)
+        event2.eventId = event1.eventId
+        scope.applyTo(event: event1, maxBreadcrumbs: 10)
+        cloned.applyTo(event: event2, maxBreadcrumbs: 10)
+        XCTAssertEqual(
+            event1.serialize() as! [String: AnyHashable],
+            event2.serialize() as! [String: AnyHashable]
+        )
+
+        cloned.setExtras(["aa": "b"])
+        cloned.setTags(["ab": "c"])
+        cloned.addBreadcrumb(Breadcrumb(level: .debug, category: "http2"))
+        cloned.setUser(User(userId: "aid"))
+        cloned.setContext(value: ["ae": "af"], key: "myContext")
+        cloned.setDist("a456")
+        cloned.setEnvironment("a789")
+
+        XCTAssertEqual(scope.serialize() as! [String: AnyHashable], snapshot)
+        XCTAssertNotEqual(scope.serialize() as! [String: AnyHashable], cloned.serialize() as! [String: AnyHashable])
+    }
 
     func testApplyToEvent() {
         let actual = fixture.scope.applyTo(event: fixture.event, maxBreadcrumbs: 10)

Tests/SentryTests/SentryScopeTests.m

@@ -163,34 +163,4 @@ - (void)testClearBreadcrumb
     XCTAssertTrue([[[scope serialize] objectForKey:@"breadcrumbs"] count] == 0);
 }
 
-- (void)testInitWithScope
-{
-    SentryScope *scope = [[SentryScope alloc] init];
-    [scope setExtras:@{ @"a" : @"b" }];
-    [scope setTags:@{ @"b" : @"c" }];
-    [scope addBreadcrumb:[self getBreadcrumb]];
-    [scope setUser:[[SentryUser alloc] initWithUserId:@"id"]];
-    [scope setContextValue:@{ @"e" : @"f" } forKey:@"myContext"];
-    [scope setDist:@"456"];
-    [scope setEnvironment:@"789"];
-    [scope setFingerprint:@[ @"a" ]];
-
-    NSMutableDictionary *snapshot = [scope serialize].mutableCopy;
-
-    SentryScope *cloned = [[SentryScope alloc] initWithScope:scope];
-    XCTAssertEqualObjects(snapshot, [cloned serialize]);
-
-    [cloned setExtras:@{ @"aa" : @"b" }];
-    [cloned setTags:@{ @"ab" : @"c" }];
-    [cloned addBreadcrumb:[[SentryBreadcrumb alloc] initWithLevel:kSentryLevelDebug
-                                                         category:@"http2"]];
-    [cloned setUser:[[SentryUser alloc] initWithUserId:@"aid"]];
-    [cloned setContextValue:@{ @"ae" : @"af" } forKey:@"myContext"];
-    [cloned setDist:@"a456"];
-    [cloned setEnvironment:@"a789"];
-
-    XCTAssertEqualObjects(snapshot, [scope serialize]);
-    XCTAssertNotEqualObjects([scope serialize], [cloned serialize]);
-}
-
 @end