feat: Add field (#3644)

This property returns true if the SDK detected a start-up crash during
SDK initialization.

Fixes GH-3639

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 ### Features
 
+- Add field `SentrySDK.detectedStartUpCrash` (#3644)
 - Automatically profile app launches (#3529)
 
 ### Improvements

SentryTestUtils/ClearTestState.swift

@@ -20,6 +20,7 @@ class TestCleanup: NSObject {
         SentrySDK.setCurrentHub(nil)
         SentrySDK.crashedLastRunCalled = false
         SentrySDK.startInvocations = 0
+        SentrySDK.setDetectedStartUpCrash(false)
         PrivateSentrySDKOnly.appStartMeasurementHybridSDKMode = false
         SentryNetworkTracker.sharedInstance.disable()
 

Sources/Sentry/Public/SentrySDK.h

@@ -253,6 +253,16 @@ SENTRY_NO_INIT
  */
 @property (nonatomic, class, readonly) BOOL crashedLastRun;
 
+/**
+ * Checks if the SDK detected a start-up crash during SDK initialization.
+ *
+ * @note The SDK init waits synchronously for up to 5 seconds to flush out events if the app crashes
+ * within 2 seconds after the SDK init.
+ *
+ * @return @c YES if the SDK detected a start-up crash and @c NO if not.
+ */
+@property (nonatomic, class, readonly) BOOL detectedStartUpCrash;
+
 /**
  * Set user to the current Scope of the current Hub.
  * @param user The user to set to the current Scope.

Sources/Sentry/SentryCrashReportSink.m

@@ -50,6 +50,9 @@ - (void)filterReports:(NSArray *)reports
     if (durationFromCrashStateInitToLastCrash > 0
         && durationFromCrashStateInitToLastCrash <= SENTRY_APP_START_CRASH_DURATION_THRESHOLD) {
         SENTRY_LOG_WARN(@"Startup crash: detected.");
+
+        [SentrySDK setDetectedStartUpCrash:YES];
+
         [self sendReports:reports onCompletion:onCompletion];
 
         [SentrySDK flush:SENTRY_APP_START_CRASH_FLUSH_DURATION];

Sources/Sentry/SentrySDK.m

@@ -42,6 +42,7 @@ @implementation SentrySDK
 static BOOL crashedLastRunCalled;
 static SentryAppStartMeasurement *sentrySDKappStartMeasurement;
 static NSObject *sentrySDKappStartMeasurementLock;
+static BOOL _detectedStartUpCrash;
 
 /**
  * @brief We need to keep track of the number of times @c +[startWith...] is called, because our OOM
@@ -59,6 +60,7 @@ + (void)initialize
     if (self == [SentrySDK class]) {
         sentrySDKappStartMeasurementLock = [[NSObject alloc] init];
         startInvocations = 0;
+        _detectedStartUpCrash = NO;
     }
 }
 
@@ -382,6 +384,16 @@ + (BOOL)crashedLastRun
     return SentryDependencyContainer.sharedInstance.crashReporter.crashedLastLaunch;
 }
 
++ (BOOL)detectedStartUpCrash
+{
+    return _detectedStartUpCrash;
+}
+
++ (void)setDetectedStartUpCrash:(BOOL)value
+{
+    _detectedStartUpCrash = value;
+}
+
 + (void)startSession
 {
     [SentrySDK.currentHub startSession];

Sources/Sentry/include/SentrySDK+Private.h

@@ -16,6 +16,8 @@ SentrySDK ()
  */
 @property (nonatomic, class) BOOL crashedLastRunCalled;
 
++ (void)setDetectedStartUpCrash:(BOOL)value;
+
 + (void)setAppStartMeasurement:(nullable SentryAppStartMeasurement *)appStartMeasurement;
 
 + (nullable SentryAppStartMeasurement *)getAppStartMeasurement;

Tests/SentryTests/SentryCrash/SentryCrashReportSinkTests.swift

@@ -1,3 +1,4 @@
+import Nimble
 import SentryTestUtils
 import XCTest
 
@@ -20,6 +21,11 @@ class SentryCrashReportSinkTests: SentrySDKIntegrationTestsBase {
 
         givenSdkWithHub()
     }
+
+    override func tearDown() {
+        super.tearDown()
+        clearTestState()
+    }
 
     func testFilterReports_withScreenShots() {
         filterReportWithAttachment()
@@ -58,6 +64,14 @@ class SentryCrashReportSinkTests: SentrySDKIntegrationTestsBase {
         XCTAssertEqual(0, fixture.dispatchQueue.dispatchAsyncCalled)
     }
 
+    func testAppStartCrash_LowerBound_SetsDetectedStartUpCrash() {
+        fixture.crashWrapper.internalDurationFromCrashStateInitToLastCrash = 0.001
+
+        filterReportWithAttachment()
+
+        expect(SentrySDK.detectedStartUpCrash) == true
+    }
+
     func testAppStartCrash_UpperBound_CallsFlush() {
         fixture.crashWrapper.internalDurationFromCrashStateInitToLastCrash = 2.0
 

Tests/SentryTests/SentrySDKTests.swift

@@ -195,7 +195,19 @@ class SentrySDKTests: XCTestCase {
     }
 
     func testCrashedLastRun() {
-        XCTAssertEqual(SentryDependencyContainer.sharedInstance().crashReporter.crashedLastLaunch, SentrySDK.crashedLastRun) 
+        expect(SentryDependencyContainer.sharedInstance().crashReporter.crashedLastLaunch) == SentrySDK.crashedLastRun
+    }
+
+    func testDetectedStartUpCrash_DefaultValue() {
+        expect(SentrySDK.detectedStartUpCrash) == false
+    }
+
+    func testDetectedStartUpCrash() {
+        SentrySDK.setDetectedStartUpCrash(true)
+        expect(SentrySDK.detectedStartUpCrash) == true
+
+        SentrySDK.setDetectedStartUpCrash(false)
+        expect(SentrySDK.detectedStartUpCrash) == false
     }
 
     func testCaptureCrashEvent() {