Merge afaa316 into 5f8ee7a

philipphofmann · web-flow · commit 121d6d3a27e8 · 2023-11-03T10:12:41.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,6 +10,7 @@
 
 - Stop sending empty thread names (#3361)
 - Work around edge case with a thread info kernel call sometimes returning invalid data, leading to a crash (#3364)
+- Crash when initializing SentryHub manually (#3374)
 
 ## 8.14.2
 
diff --git a/Sentry.xcodeproj/project.pbxproj b/Sentry.xcodeproj/project.pbxproj
@@ -79,6 +79,7 @@
 		622C08DB29E554B9002571D4 /* SentrySpanContext+Private.h in Headers */ = {isa = PBXBuildFile; fileRef = 622C08D929E554B9002571D4 /* SentrySpanContext+Private.h */; };
 		623C45B02A651D8200D9E88B /* SentryCoreDataTracker+Test.m in Sources */ = {isa = PBXBuildFile; fileRef = 623C45AF2A651D8200D9E88B /* SentryCoreDataTracker+Test.m */; };
 		627E7589299F6FE40085504D /* SentryInternalDefines.h in Headers */ = {isa = PBXBuildFile; fileRef = 627E7588299F6FE40085504D /* SentryInternalDefines.h */; };
+		62831DB62AF4E2E500B6B854 /* SentryPropagationContextTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 62831DB52AF4E2E500B6B854 /* SentryPropagationContextTests.swift */; };
 		62885DA729E946B100554F38 /* TestConncurrentModifications.swift in Sources */ = {isa = PBXBuildFile; fileRef = 62885DA629E946B100554F38 /* TestConncurrentModifications.swift */; };
 		62950F1029E7FE0100A42624 /* SentryTransactionContextTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 62950F0F29E7FE0100A42624 /* SentryTransactionContextTests.swift */; };
 		629690532AD3E060000185FA /* SentryReachabilitySwiftTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 629690522AD3E060000185FA /* SentryReachabilitySwiftTests.swift */; };
@@ -959,6 +960,7 @@
 		623C45AE2A651C4500D9E88B /* SentryCoreDataTracker+Test.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "SentryCoreDataTracker+Test.h"; sourceTree = "<group>"; };
 		623C45AF2A651D8200D9E88B /* SentryCoreDataTracker+Test.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = "SentryCoreDataTracker+Test.m"; sourceTree = "<group>"; };
 		627E7588299F6FE40085504D /* SentryInternalDefines.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; name = SentryInternalDefines.h; path = include/SentryInternalDefines.h; sourceTree = "<group>"; };
+		62831DB52AF4E2E500B6B854 /* SentryPropagationContextTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SentryPropagationContextTests.swift; sourceTree = "<group>"; };
 		62885DA629E946B100554F38 /* TestConncurrentModifications.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = TestConncurrentModifications.swift; sourceTree = "<group>"; };
 		62950F0F29E7FE0100A42624 /* SentryTransactionContextTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SentryTransactionContextTests.swift; sourceTree = "<group>"; };
 		629690522AD3E060000185FA /* SentryReachabilitySwiftTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SentryReachabilitySwiftTests.swift; sourceTree = "<group>"; };
@@ -2698,6 +2700,7 @@
 			children = (
 				7B944FAD2469B43700A10721 /* TestHub.swift */,
 				7B7A30C924B48523005A4C6E /* SentryHub+Test.h */,
+				62831DB52AF4E2E500B6B854 /* SentryPropagationContextTests.swift */,
 			);
 			path = State;
 			sourceTree = "<group>";
@@ -4436,6 +4439,7 @@
 				63FE721320DA66EC00CDBAE8 /* SentryCrashMonitor_Signal_Tests.m in Sources */,
 				7BBD18B32451805500427C76 /* SentryRateLimitsParserTests.swift in Sources */,
 				7B82722B27A3220A00F4BFF4 /* SentryFileIoTrackingUnitTests.swift in Sources */,
+				62831DB62AF4E2E500B6B854 /* SentryPropagationContextTests.swift in Sources */,
 				7BF9EF7A2722B58900B5BBEF /* SentrySubClassFinderTests.swift in Sources */,
 				7B59398224AB47650003AAD2 /* SentrySessionTrackerTests.swift in Sources */,
 				7B05A61824A4D14A00EF211D /* SentrySessionGeneratorTests.swift in Sources */,
diff --git a/Sources/Sentry/SentryClient.m b/Sources/Sentry/SentryClient.m
@@ -371,7 +371,8 @@ - (nullable SentryTraceContext *)getTraceStateWithEvent:(SentryEvent *)event
     }
 
     if (event.error || event.exceptions.count > 0) {
-        return scope.propagationContext.traceContext;
+        return [scope.propagationContext getTraceContext:self.options
+                                             userSegment:scope.userObject.segment];
     }
 
     return nil;
diff --git a/Sources/Sentry/SentryNetworkTracker.m b/Sources/Sentry/SentryNetworkTracker.m
@@ -23,6 +23,7 @@
 #import "SentryTraceHeader.h"
 #import "SentryTraceOrigins.h"
 #import "SentryTracer.h"
+#import "SentryUser.h"
 #import <objc/runtime.h>
 @import SentryPrivate;
 
@@ -216,7 +217,10 @@ - (void)urlSessionTaskResume:(NSURLSessionTask *)sessionTask
 - (void)addTraceWithoutTransactionToTask:(NSURLSessionTask *)sessionTask
 {
     SentryPropagationContext *propagationContext = SentrySDK.currentHub.scope.propagationContext;
-    [self addBaggageHeader:[[propagationContext traceContext] toBaggage]
+    SentryTraceContext *traceContext =
+        [propagationContext getTraceContext:SentrySDK.currentHub.client.options
+                                userSegment:SentrySDK.currentHub.scope.userObject.segment];
+    [self addBaggageHeader:[traceContext toBaggage]
                traceHeader:[propagationContext traceHeader]
                  toRequest:sessionTask];
 }
diff --git a/Sources/Sentry/SentryPropagationContext.h b/Sources/Sentry/SentryPropagationContext.h
@@ -1,19 +1,29 @@
 #import <Foundation/Foundation.h>
 
-@class SentryId, SentrySpanId, SentryTraceContext, SentryTraceHeader;
+@class SentryId, SentrySpanId, SentryTraceContext, SentryTraceHeader, SentryOptions, SentryScope;
 
 NS_ASSUME_NONNULL_BEGIN
 
 @interface SentryPropagationContext : NSObject
 
 @property (nonatomic, strong) SentryId *traceId;
 @property (nonatomic, strong) SentrySpanId *spanId;
-@property (nonatomic, readonly, nullable) SentryTraceContext *traceContext;
-
 @property (nonatomic, readonly) SentryTraceHeader *traceHeader;
 
 - (NSDictionary<NSString *, NSString *> *)traceContextForEvent;
 
+/**
+ * We need to pass in the options and the user segment instead of retrieving them from the static
+ * API cause, for example, the SentryClient can have multiple instances with different options and
+ * scopes running and in that scenario we need can't retrieve these values from the static API.
+ *
+ *  @param options The current active options.
+ *  @param userSegment You can retrieve this usually from the `scope.userObject.segment`.
+ */
+- (SentryTraceContext *)getTraceContext:(SentryOptions *)options
+                            userSegment:(nullable NSString *)userSegment
+    NS_SWIFT_NAME(getTraceContext(options:userSegment:));
+
 @end
 
 NS_ASSUME_NONNULL_END
diff --git a/Sources/Sentry/SentryPropagationContext.m b/Sources/Sentry/SentryPropagationContext.m
@@ -28,16 +28,16 @@ - (SentryTraceHeader *)traceHeader
                                               sampled:kSentrySampleDecisionNo];
 }
 
-- (SentryTraceContext *)traceContext
+- (SentryTraceContext *)getTraceContext:(SentryOptions *)options
+                            userSegment:(nullable NSString *)userSegment
 {
-    SentryOptions *options = SentrySDK.options;
-    SentryScope *scope = SentrySDK.currentHub.scope;
+
     return [[SentryTraceContext alloc] initWithTraceId:self.traceId
                                              publicKey:options.parsedDsn.url.user
                                            releaseName:options.releaseName
                                            environment:options.environment
                                            transaction:nil
-                                           userSegment:scope.userObject.segment
+                                           userSegment:userSegment
                                             sampleRate:nil
                                                sampled:nil];
 }
diff --git a/Tests/SentryTests/Integrations/Performance/Network/SentryNetworkTrackerTests.swift b/Tests/SentryTests/Integrations/Performance/Network/SentryNetworkTrackerTests.swift
@@ -590,7 +590,8 @@ class SentryNetworkTrackerTests: XCTestCase {
         sut.urlSessionTaskResume(task)
 
         let expectedTraceHeader = SentrySDK.currentHub().scope.propagationContext.traceHeader.value()
-        let expectedBaggageHeader = SentrySDK.currentHub().scope.propagationContext.traceContext?.toBaggage().toHTTPHeader()
+        let traceContext = SentrySDK.currentHub().scope.propagationContext.getTraceContext(options: self.fixture.options, userSegment: self.fixture.scope.userObject?.segment)
+        let expectedBaggageHeader = traceContext.toBaggage().toHTTPHeader()
         XCTAssertEqual(task.currentRequest?.allHTTPHeaderFields?["baggage"] ?? "", expectedBaggageHeader)
         XCTAssertEqual(task.currentRequest?.allHTTPHeaderFields?["sentry-trace"] ?? "", expectedTraceHeader)
     }
@@ -601,7 +602,8 @@ class SentryNetworkTrackerTests: XCTestCase {
         sut.urlSessionTaskResume(task)
 
         let expectedTraceHeader = SentrySDK.currentHub().scope.propagationContext.traceHeader.value()
-        let expectedBaggageHeader = SentrySDK.currentHub().scope.propagationContext.traceContext?.toBaggage().toHTTPHeader()
+        let traceContext = SentrySDK.currentHub().scope.propagationContext.getTraceContext(options: self.fixture.options, userSegment: self.fixture.scope.userObject?.segment)
+        let expectedBaggageHeader = traceContext.toBaggage().toHTTPHeader()
         XCTAssertEqual(task.currentRequest?.allHTTPHeaderFields?["baggage"] ?? "", expectedBaggageHeader)
         XCTAssertEqual(task.currentRequest?.allHTTPHeaderFields?["sentry-trace"] ?? "", expectedTraceHeader)
     }
diff --git a/Tests/SentryTests/SentryClientTests.swift b/Tests/SentryTests/SentryClientTests.swift
@@ -555,8 +555,9 @@ class SentryClientTest: XCTestCase {
             try assertValidErrorEvent(eventWithSessionArguments.event, error)
             XCTAssertEqual(fixture.session, eventWithSessionArguments.session)
             
-            XCTAssertEqual(eventWithSessionArguments.traceContext?.traceId, 
-                           scope.propagationContext.traceContext?.traceId)
+            let expectedTraceContext = scope.propagationContext.getTraceContext(options: Options(), userSegment: "segment")
+            XCTAssertEqual(eventWithSessionArguments.traceContext?.traceId,
+                           expectedTraceContext.traceId)
         }
     }
     
diff --git a/Tests/SentryTests/SentryHubTests.swift b/Tests/SentryTests/SentryHubTests.swift
@@ -80,6 +80,17 @@ class SentryHubTests: XCTestCase {
         fixture.fileManager.deleteAllEnvelopes()
     }
     
+    func testCaptureErrorWithRealDSN() {
+        let sentryOption = Options()
+        sentryOption.dsn = "https://6cc9bae94def43cab8444a99e0031c28@o447951.ingest.sentry.io/5428557"
+                
+        let scope = Scope()
+        let sentryHub = SentryHub(client: SentryClient(options: sentryOption), andScope: scope)
+
+        let error = NSError(domain: "Test.CaptureErrorWithRealDSN", code: 12)
+        sentryHub.capture(error: error)
+    }
+    
     func testBeforeBreadcrumbWithoutCallbackStoresBreadcrumb() {
         let hub = fixture.getSut()
         
diff --git a/Tests/SentryTests/State/SentryPropagationContextTests.swift b/Tests/SentryTests/State/SentryPropagationContextTests.swift
@@ -0,0 +1,40 @@
+import SentryTestUtils
+import XCTest
+
+final class SentryPropagationContextTests: XCTestCase {
+    
+    func testGetTraceContextWithOptionsAndSegment() throws {
+        let options = Options()
+        options.dsn = TestConstants.realDSN
+    
+        let sut = SentryPropagationContext()
+        let traceContext = try XCTUnwrap(sut.getTraceContext(options: options, userSegment: "segment"))
+        
+        XCTAssertEqual(options.parsedDsn?.url.user, traceContext.publicKey)
+        XCTAssertEqual(sut.traceId, traceContext.traceId)
+        XCTAssertEqual(options.releaseName, traceContext.releaseName)
+        XCTAssertEqual(options.environment, traceContext.environment)
+        XCTAssertNil(traceContext.transaction)
+        XCTAssertEqual("segment", traceContext.userSegment)
+        XCTAssertNil(traceContext.sampleRate)
+        XCTAssertNil(traceContext.sampled)
+    }
+    
+    func testGetTraceContextWithOptionsOnly() throws {
+        let options = Options()
+        options.dsn = TestConstants.realDSN
+    
+        let sut = SentryPropagationContext()
+        let traceContext = try XCTUnwrap(sut.getTraceContext(options: options, userSegment: nil))
+        
+        XCTAssertEqual(options.parsedDsn?.url.user, traceContext.publicKey)
+        XCTAssertEqual(sut.traceId, traceContext.traceId)
+        XCTAssertEqual(options.releaseName, traceContext.releaseName)
+        XCTAssertEqual(options.environment, traceContext.environment)
+        XCTAssertNil(traceContext.transaction)
+        XCTAssertNil(traceContext.userSegment)
+        XCTAssertNil(traceContext.sampleRate)
+        XCTAssertNil(traceContext.sampled)
+    }
+
+}
diff --git a/scripts/no-changes-in-high-risk-files.sh b/scripts/no-changes-in-high-risk-files.sh
@@ -5,7 +5,7 @@ set -euo pipefail
 
 ACTUAL=$(shasum -a 256 ./Sources/Sentry/SentryNSURLSessionTaskSearch.m ./Sources/Sentry/SentryNetworkTracker.m ./Sources/Sentry/SentryUIViewControllerSwizzling.m ./Sources/Sentry/SentryNSDataSwizzling.m ./Sources/Sentry/SentrySubClassFinder.m ./Sources/Sentry/SentryCoreDataSwizzling.m ./Sources/Sentry/SentrySwizzleWrapper.m ./Sources/Sentry/include/SentrySwizzle.h ./Sources/Sentry/SentrySwizzle.m)
 EXPECTED="819d5ca5e3db2ac23c859b14c149b7f0754d3ae88bea1dba92c18f49a81da0e1  ./Sources/Sentry/SentryNSURLSessionTaskSearch.m
-57056426d77fd1cc27e72bdcea4bbf617dd8c1e82eecf003df8f0e348aae90ab  ./Sources/Sentry/SentryNetworkTracker.m
+76074e49d05f18bb96b6c2ae9a7eb65e320bb778674460c01fbfd90ee7ee1571  ./Sources/Sentry/SentryNetworkTracker.m
 132a491c706bdb68b47c2e0a14aeaa5c611664f34156565dbfc874b360d6a742  ./Sources/Sentry/SentryUIViewControllerSwizzling.m
 e95e62ec7363984f20c78643bb7d992a41a740f97e1befb71525ac34caf88b37  ./Sources/Sentry/SentryNSDataSwizzling.m
 cc3849725bd1733515c71742872bed94ca47d2c115ef9d8c98383eae2e171925  ./Sources/Sentry/SentrySubClassFinder.m

Original file line number	Diff line number	Diff line change
`@@ -371,7 +371,8 @@ - (nullable SentryTraceContext )getTraceStateWithEvent:(SentryEvent )event`
`371`	`371`	`}`
`372`	`372`
`373`	`373`	`if (event.error \|\| event.exceptions.count > 0) {`
`374`		`- return scope.propagationContext.traceContext;`
	`374`	`+ return [scope.propagationContext getTraceContext:self.options`
	`375`	`+ userSegment:scope.userObject.segment];`
`375`	`376`	`}`
`376`	`377`
`377`	`378`	`return nil;`
Original file line number	Diff line number	Diff line change
`@@ -555,8 +555,9 @@ class SentryClientTest: XCTestCase {`
`555`	`555`	`try assertValidErrorEvent(eventWithSessionArguments.event, error)`
`556`	`556`	`XCTAssertEqual(fixture.session, eventWithSessionArguments.session)`
`557`	`557`
`558`		`- XCTAssertEqual(eventWithSessionArguments.traceContext?.traceId,`
`559`		`- scope.propagationContext.traceContext?.traceId)`
	`558`	`+ let expectedTraceContext = scope.propagationContext.getTraceContext(options: Options(), userSegment: "segment")`
	`559`	`+ XCTAssertEqual(eventWithSessionArguments.traceContext?.traceId,`
	`560`	`+ expectedTraceContext.traceId)`
`560`	`561`	`}`
`561`	`562`	`}`
`562`	`563`