Merge d2119ed into 45623f3

CHANGELOG.md

@@ -10,6 +10,12 @@
 
 ### Fixes
 
+- Don't start the SDK inside Xcode preview (#4601)
+
+## 8.42.0-beta.2
+
+### Fixes
+
 - Fix GraphQL context for HTTP client error tracking (#4567)
 
 ### Improvements

SentryTestUtils/TestSentryNSProcessInfoWrapper.swift

@@ -5,6 +5,7 @@ public class TestSentryNSProcessInfoWrapper: SentryNSProcessInfoWrapper {
         public var processorCount: UInt?
         public var processDirectoryPath: String?
         public var thermalState: ProcessInfo.ThermalState?
+        public var environment: [String: String]?
     }
 
     public var overrides = Override()
@@ -20,4 +21,8 @@ public class TestSentryNSProcessInfoWrapper: SentryNSProcessInfoWrapper {
     public override var thermalState: ProcessInfo.ThermalState {
         overrides.thermalState ?? super.thermalState
     }
+
+    public override var environment: [String: String] {
+        overrides.environment ?? super.environment
+    }
 }

Sources/Sentry/SentryFramesTracker.m

@@ -20,7 +20,6 @@
 #    if SENTRY_TARGET_PROFILING_SUPPORTED
 #        import "SentryContinuousProfiler.h"
 #        import "SentryTraceProfiler.h"
-
 /** A mutable version of @c SentryFrameInfoTimeSeries so we can accumulate results. */
 typedef NSMutableArray<NSDictionary<NSString *, NSNumber *> *> SentryMutableFrameInfoTimeSeries;
 #    endif // SENTRY_TARGET_PROFILING_SUPPORTED
@@ -62,6 +61,7 @@ @implementation SentryFramesTracker {
     unsigned int _totalFrames;
     unsigned int _slowFrames;
     unsigned int _frozenFrames;
+    NSString *test;
 }
 
 - (instancetype)initWithDisplayLinkWrapper:(SentryDisplayLinkWrapper *)displayLinkWrapper
@@ -223,8 +223,8 @@ - (void)displayLinkCallback
         && frameDuration <= SentryFrozenFrameThreshold) {
         _slowFrames++;
 #    if SENTRY_TARGET_PROFILING_SUPPORTED
-        SENTRY_LOG_DEBUG(
-            @"Detected slow frame starting at %@ (frame tracker: %@).", profilingTimestamp, self);
+        SENTRY_LOG_DEBUG(@"Detected slow frame starting at %@ (frame tracker: %@). %@",
+            profilingTimestamp, self, test);
         [self recordTimestamp:profilingTimestamp
                         value:@(thisFrameSystemTimestamp - self.previousFrameSystemTimestamp)
                         array:self.slowFrameTimestamps];

Sources/Sentry/SentryNSProcessInfoWrapper.mm

@@ -50,4 +50,9 @@ - (NSProcessInfoThermalState)thermalState
     return NSProcessInfo.processInfo.thermalState;
 }
 
+- (NSDictionary<NSString *, NSString *> *)environment
+{
+    return NSProcessInfo.processInfo.environment;
+}
+
 @end

Sources/Sentry/SentrySDK.m

@@ -16,6 +16,7 @@
 #import "SentryLog.h"
 #import "SentryLogC.h"
 #import "SentryMeta.h"
+#import "SentryNSProcessInfoWrapper.h"
 #import "SentryOptions+Private.h"
 #import "SentryProfilingConditionals.h"
 #import "SentryReplayApi.h"
@@ -39,6 +40,8 @@
 #    import "SentryProfiler+Private.h"
 #endif // SENTRY_TARGET_PROFILING_SUPPORTED
 
+NSString *const SENTRY_XCODE_PREVIEW_ENVIRONMENT_KEY = @"XCODE_RUNNING_FOR_PREVIEWS";
+
 @interface SentrySDK ()
 
 @property (class) SentryHub *currentHub;
@@ -47,7 +50,6 @@ @interface SentrySDK ()
 
 NS_ASSUME_NONNULL_BEGIN
 @implementation SentrySDK
-
 static SentryHub *_Nullable currentHub;
 static NSObject *currentHubLock;
 static BOOL crashedLastRunCalled;
@@ -201,6 +203,11 @@ + (void)setStartTimestamp:(NSDate *)value
 
 + (void)startWithOptions:(SentryOptions *)options
 {
+    if ([SentryDependencyContainer.sharedInstance.processInfoWrapper
+                .environment[SENTRY_XCODE_PREVIEW_ENVIRONMENT_KEY] isEqualToString:@"1"]) {
+        return;
+    }
+
     startOption = options;
     [SentryLog configure:options.debug diagnosticLevel:options.diagnosticLevel];
 
@@ -613,6 +620,21 @@ + (void)stopProfiler
 }
 #endif // SENTRY_TARGET_PROFILING_SUPPORTED
 
+#if TEST || TESTCI
+static NSDictionary<NSString *, NSString *> *_processInfoEnvironment;
+
++ (void)setProcessInfoEnvironment:(NSDictionary<NSString *, NSString *> *)dictionary
+{
+    _processInfoEnvironment = dictionary;
+}
+
++ (NSDictionary<NSString *, NSString *> *)processInfoEnvironment
+{
+    return _processInfoEnvironment;
+}
+
+#endif
+
 @end
 
 NS_ASSUME_NONNULL_END

Sources/Sentry/include/SentryNSProcessInfoWrapper.h

@@ -8,6 +8,7 @@ NS_ASSUME_NONNULL_BEGIN
 @property (nullable, nonatomic, readonly) NSString *processPath;
 @property (readonly) NSUInteger processorCount;
 @property (readonly) NSProcessInfoThermalState thermalState;
+@property (readonly) NSDictionary<NSString *, NSString *> *environment;
 
 #if defined(TEST) || defined(TESTCI) || defined(DEBUG)
 - (void)setProcessPath:(NSString *)path;

Sources/SentrySwiftUI/SentryInternal/SentryInternal.h

@@ -15,6 +15,8 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
+extern NSString *const SENTRY_XCODE_PREVIEW_ENVIRONMENT_KEY;
+
 typedef NS_ENUM(NSInteger, SentryTransactionNameSource);
 
 @class SentrySpanId;

Sources/SentrySwiftUI/SentrySwiftUI.h

@@ -6,6 +6,8 @@ FOUNDATION_EXPORT double SentryUIVersionNumber;
 //! Project version string for SentryUI.
 FOUNDATION_EXPORT const unsigned char SentryUIVersionString[];
 
+extern NSString *const SENTRY_XCODE_PREVIEW_ENVIRONMENT_KEY;
+
 #if __has_include("SentryInternal.h")
 #    import "SentryInternal.h"
 #endif

Sources/SentrySwiftUI/SentryTracedView.swift

@@ -79,12 +79,21 @@ public struct SentryTracedView<Content: View>: View {
 
         return result
     }
+
+    private func shouldTrace() -> Bool {
+#if DEBUG
+        if  ProcessInfo.processInfo.environment[SENTRY_XCODE_PREVIEW_ENVIRONMENT_KEY] == "1" {
+            return false
+        }
+#endif
+        return !viewAppeared
+    }
 
     public var body: some View {
         var trace: SentryTracer?
         var spanId: SpanId?
 
-        if !viewAppeared {
+        if shouldTrace() {
             trace = ensureTransactionExists()
             spanId = createAndPushBodySpan(transactionCreated: trace != nil)
         }

Tests/SentryTests/SentrySDKTests.swift

@@ -194,6 +194,19 @@ class SentrySDKTests: XCTestCase {
         XCTAssertIdentical(scope, SentrySDK.currentHub().scope)
     }
 
+    func testDontStartInsideXcodePreview() {
+        let testProcessInfoWrapper = TestSentryNSProcessInfoWrapper()
+        testProcessInfoWrapper.overrides.environment = ["XCODE_RUNNING_FOR_PREVIEWS": "1"]
+
+        SentryDependencyContainer.sharedInstance().processInfoWrapper = testProcessInfoWrapper
+
+        SentrySDK.start { options in
+            options.debug = true
+        }
+
+        XCTAssertFalse(SentrySDK.isEnabled)
+    }
+
     func testCrashedLastRun() {
         XCTAssertEqual(SentryDependencyContainer.sharedInstance().crashReporter.crashedLastLaunch, SentrySDK.crashedLastRun)
     }