fix: Resolve remaining nullability warnings and enabling them as errors (#6563)

Author: philprime

CHANGELOG.md

@@ -23,6 +23,7 @@
 - Remove unused `SentryFrame.instruction` property (#6504)
 - Remove `uuid` and `name` of `SentryDebugMeta` (#6512) Use `debugID` instead of `uuid` and `codeFile` instead of `name`.
 - Enable enablePreWarmedAppStartTracing by default (#6508). With this option enabled, the SDK collects [prewarmed app starts](https://docs.sentry.io/platforms/apple/tracing/instrumentation/automatic-instrumentation/#prewarmed-app-start-tracing).
+- Change `value` and `type` of `SentryException` to be nullable (#6563)
 
 ### Features
 

Sentry.xcodeproj/project.pbxproj

@@ -6636,8 +6636,6 @@
 				OTHER_CFLAGS = (
 					"-Wnullable-to-nonnull-conversion",
 					"-Wnullability-completeness",
-					"-Wno-error=nullable-to-nonnull-conversion",
-					"-Wno-error=nullability-completeness",
 				);
 			};
 			name = Debug;
@@ -6650,8 +6648,6 @@
 				OTHER_CFLAGS = (
 					"-Wnullable-to-nonnull-conversion",
 					"-Wnullability-completeness",
-					"-Wno-error=nullable-to-nonnull-conversion",
-					"-Wno-error=nullability-completeness",
 				);
 			};
 			name = Release;
@@ -6747,8 +6743,6 @@
 				OTHER_CFLAGS = (
 					"-Wnullable-to-nonnull-conversion",
 					"-Wnullability-completeness",
-					"-Wno-error=nullable-to-nonnull-conversion",
-					"-Wno-error=nullability-completeness",
 				);
 			};
 			name = TestCI;
@@ -6810,8 +6804,6 @@
 				OTHER_CFLAGS = (
 					"-Wnullable-to-nonnull-conversion",
 					"-Wnullability-completeness",
-					"-Wno-error=nullable-to-nonnull-conversion",
-					"-Wno-error=nullability-completeness",
 				);
 			};
 			name = DebugWithoutUIKit;
@@ -7219,8 +7211,6 @@
 				OTHER_CFLAGS = (
 					"-Wnullable-to-nonnull-conversion",
 					"-Wnullability-completeness",
-					"-Wno-error=nullable-to-nonnull-conversion",
-					"-Wno-error=nullability-completeness",
 				);
 			};
 			name = ReleaseWithoutUIKit;
@@ -7516,8 +7506,6 @@
 				OTHER_CFLAGS = (
 					"-Wnullable-to-nonnull-conversion",
 					"-Wnullability-completeness",
-					"-Wno-error=nullable-to-nonnull-conversion",
-					"-Wno-error=nullability-completeness",
 				);
 			};
 			name = Test;
@@ -8282,8 +8270,6 @@
 				OTHER_CFLAGS = (
 					"-Wnullable-to-nonnull-conversion",
 					"-Wnullability-completeness",
-					"-Wno-error=nullable-to-nonnull-conversion",
-					"-Wno-error=nullability-completeness",
 				);
 			};
 			name = DebugV9;
@@ -8564,8 +8550,6 @@
 				OTHER_CFLAGS = (
 					"-Wnullable-to-nonnull-conversion",
 					"-Wnullability-completeness",
-					"-Wno-error=nullable-to-nonnull-conversion",
-					"-Wno-error=nullability-completeness",
 				);
 			};
 			name = ReleaseV9;

Sources/Sentry/PrivateSentrySDKOnly.m

@@ -261,9 +261,12 @@ + (SentryScreenFrames *)currentScreenFrames
 #if SENTRY_TARGET_REPLAY_SUPPORTED
     // As the options are not passed in by the hybrid SDK, we need to use the options from the
     // current hub.
-    SentryScreenshotSource *_Nonnull screenshotSource
+    SentryScreenshotSource *_Nullable screenshotSource
         = SentryDependencyContainer.sharedInstance.screenshotSource;
-    return [screenshotSource appScreenshotsData];
+    if (!screenshotSource) {
+        return nil;
+    }
+    return [SENTRY_UNWRAP_NULLABLE(SentryScreenshotSource, screenshotSource) appScreenshotsData];
 #else
     SENTRY_LOG_DEBUG(
         @"PrivateSentrySDKOnly.captureScreenshots only works with UIKit enabled. Ensure you're "
@@ -283,7 +286,13 @@ + (void)setCurrentScreen:(NSString *_Nullable)screenName
 + (NSData *)captureViewHierarchy
 {
 #if SENTRY_HAS_UIKIT
-    return [SentryDependencyContainer.sharedInstance.viewHierarchyProvider appViewHierarchy];
+    SentryViewHierarchyProvider *_Nullable viewHierarchyProvider
+        = SentryDependencyContainer.sharedInstance.viewHierarchyProvider;
+    if (!viewHierarchyProvider) {
+        return nil;
+    }
+    return [SENTRY_UNWRAP_NULLABLE(SentryViewHierarchyProvider, viewHierarchyProvider)
+        appViewHierarchy];
 #else
     SENTRY_LOG_DEBUG(
         @"PrivateSentrySDKOnly.captureViewHierarchy only works with UIKit enabled. Ensure you're "

Sources/Sentry/Profiling/SentryProfiledTracerConcurrency.mm

@@ -240,7 +240,7 @@
 void
 sentry_stopProfilerDueToFinishedTransaction(
     SentryHub *hub, SentryDispatchQueueWrapper *dispatchQueue, SentryTransaction *transaction,
-    BOOL isProfiling, NSDate *traceStartTimestamp, uint64_t startSystemTime
+    BOOL isProfiling, NSDate *_Nullable traceStartTimestamp, uint64_t startSystemTime
 #    if SENTRY_HAS_UIKIT
     ,
     SentryAppStartMeasurement *appStartMeasurement
@@ -334,7 +334,7 @@
 }
 
 SentryId *_Nullable sentry_startProfilerForTrace(SentryTracerConfiguration *configuration,
-    SentryHub *hub, SentryTransactionContext *transactionContext)
+    SentryHub *_Nullable hub, SentryTransactionContext *transactionContext)
 {
     if (sentry_profileConfiguration.profileOptions != nil) {
         // launch profile; there's no hub to get options from, so they're read from the launch

Sources/Sentry/Profiling/SentryProfilerSerialization.m

@@ -385,8 +385,12 @@
     NSMutableDictionary *transactionDict = [[NSMutableDictionary alloc] initWithDictionary:@ {
         @"id" : transaction.eventId.sentryIdString,
         @"trace_id" : transaction.trace.traceId.sentryIdString,
-        @"active_thread_id" : [transaction.trace.transactionContext sentry_threadInfo].threadId
     }];
+    NSNumber *_Nullable activeThreadId =
+        [transaction.trace.transactionContext sentry_threadInfo].threadId;
+    if (activeThreadId != nil || [activeThreadId isEqual:@0]) {
+        transactionDict[@"active_thread_id"] = activeThreadId;
+    }
     if (transaction.transaction) {
         transactionDict[@"name"] = transaction.transaction;
     }

Sources/Sentry/Public/SentryException.h

@@ -21,12 +21,12 @@ SENTRY_NO_INIT
 /**
  * The name of the exception
  */
-@property (nonatomic, copy) NSString *value;
+@property (nonatomic, copy) NSString *_Nullable value;
 
 /**
  * Type of the exception
  */
-@property (nonatomic, copy) NSString *type;
+@property (nonatomic, copy) NSString *_Nullable type;
 
 /**
  * Additional information about the exception
@@ -49,12 +49,13 @@ SENTRY_NO_INIT
 @property (nonatomic, strong) SentryStacktrace *_Nullable stacktrace;
 
 /**
- * Initialize an SentryException with value and type
- * @param value String
- * @param type String
+ * Initialize an SentryException with value and type.
+ * @param value Nullable string describing the exception
+ * @param type Nullable string with the type of the exception
  * @return SentryException
+ * @note At least one of value or type must be non-nil. This is asserted in debug builds.
  */
-- (instancetype)initWithValue:(NSString *)value type:(NSString *)type;
+- (instancetype)initWithValue:(NSString *_Nullable)value type:(NSString *_Nullable)type;
 
 @end
 

Sources/Sentry/SentryANRTrackingIntegration.m

@@ -51,7 +51,12 @@ - (BOOL)installWithOptions:(SentryOptions *)options
         [SentryDependencyContainer.sharedInstance getANRTracker:options.appHangTimeoutInterval];
 
 #endif // SENTRY_HAS_UIKIT
-    self.fileManager = SentryDependencyContainer.sharedInstance.fileManager;
+    SentryFileManager *fileManager = SentryDependencyContainer.sharedInstance.fileManager;
+    if (!fileManager) {
+        SENTRY_LOG_FATAL(@"File manager is not available");
+        return NO;
+    }
+    self.fileManager = fileManager;
     self.dispatchQueueWrapper = SentryDependencyContainer.sharedInstance.dispatchQueueWrapper;
     self.crashWrapper = SentryDependencyContainer.sharedInstance.crashWrapper;
     self.debugImageProvider = SentryDependencyContainer.sharedInstance.debugImageProvider;

Sources/Sentry/SentryAppStartTracker.m

@@ -188,6 +188,12 @@ - (void)buildAppStartMeasurement:(NSDate *)appStartEnd
             appStartDuration = 0;
         }
 
+        NSDate *sdkStart = SentrySDKInternal.startTimestamp;
+        if (sdkStart == nil) {
+            SENTRY_LOG_DEBUG(@"Skipping app start measurement: missing SDK start timestamp.");
+            return;
+        }
+
         SentryAppStartMeasurement *appStartMeasurement =
             [[SentryAppStartMeasurement alloc] initWithType:appStartType
                                                 isPreWarmed:isPreWarmed
@@ -196,7 +202,7 @@ - (void)buildAppStartMeasurement:(NSDate *)appStartEnd
                                                    duration:appStartDuration
                                        runtimeInitTimestamp:runtimeInit
                               moduleInitializationTimestamp:sysctl.moduleInitializationTimestamp
-                                          sdkStartTimestamp:SentrySDKInternal.startTimestamp
+                                          sdkStartTimestamp:sdkStart
                                 didFinishLaunchingTimestamp:self.didFinishLaunchingTimestamp];
 
         SentrySDKInternal.appStartMeasurement = appStartMeasurement;

Sources/Sentry/SentryAutoBreadcrumbTrackingIntegration.m

@@ -26,15 +26,22 @@ - (BOOL)installWithOptions:(SentryOptions *)options
         return NO;
     }
 
+    SentryFileManager *_Nullable fileManager = SentryDependencyContainer.sharedInstance.fileManager;
+    if (!fileManager) {
+        SENTRY_LOG_FATAL(@"File manager is not available");
+        return NO;
+    }
+
 #if TARGET_OS_IOS && SENTRY_HAS_UIKIT
     [self installWithOptions:options
              breadcrumbTracker:[[SentryBreadcrumbTracker alloc] initReportAccessibilityIdentifier:
                                        options.reportAccessibilityIdentifier]
-        systemEventBreadcrumbs:
-            [[SentrySystemEventBreadcrumbs alloc]
-                         initWithFileManager:[SentryDependencyContainer sharedInstance].fileManager
-                andNotificationCenterWrapper:[SentryDependencyContainer sharedInstance]
-                                                 .notificationCenterWrapper]];
+        systemEventBreadcrumbs:[[SentrySystemEventBreadcrumbs alloc]
+                                            initWithFileManager:SENTRY_UNWRAP_NULLABLE(
+                                                                    SentryFileManager, fileManager)
+                                   andNotificationCenterWrapper:SentryDependencyContainer
+                                                                    .sharedInstance
+                                                                    .notificationCenterWrapper]];
 #else
     [self installWithOptions:options
            breadcrumbTracker:[[SentryBreadcrumbTracker alloc]

Sources/Sentry/SentryClient.m

@@ -555,8 +555,10 @@ - (void)captureReplayEvent:(SentryReplayEvent *)replayEvent
 
     // Hybrid SDKs may override the sdk info for a replay Event,
     // the same SDK should be used for the envelope header.
-    SentrySdkInfo *sdkInfo = replayEvent.sdk ? [[SentrySdkInfo alloc] initWithDict:replayEvent.sdk]
-                                             : [SentrySdkInfo global];
+    SentrySdkInfo *sdkInfo = replayEvent.sdk
+        ? [[SentrySdkInfo alloc]
+              initWithDict:SENTRY_UNWRAP_NULLABLE_DICT(NSString *, id, replayEvent.sdk)]
+        : [SentrySdkInfo global];
     SentryEnvelopeHeader *envelopeHeader =
         [[SentryEnvelopeHeader alloc] initWithId:replayEvent.eventId
                                          sdkInfo:sdkInfo
@@ -664,7 +666,7 @@ - (void)close
     SENTRY_LOG_DEBUG(@"Closed the Client.");
 }
 
-- (SentryEvent *_Nullable)prepareEvent:(SentryEvent *)event
+- (SentryEvent *_Nullable)prepareEvent:(SentryEvent *_Nullable)event
                              withScope:(SentryScope *)scope
                 alwaysAttachStacktrace:(BOOL)alwaysAttachStacktrace
                           isFatalEvent:(BOOL)isFatalEvent
@@ -713,7 +715,7 @@ - (SentryEvent *_Nullable)prepareEvent:(SentryEvent *)event
         event.dist = dist;
     }
 
-    [self setSdk:event];
+    [self setSdk:SENTRY_UNWRAP_NULLABLE(SentryEvent, event)];
 
     // We don't want to attach debug meta and stacktraces for transactions, replays or user
     // feedback.
@@ -759,25 +761,29 @@ - (SentryEvent *_Nullable)prepareEvent:(SentryEvent *)event
     // Crash events are from a previous run. Applying the current scope would potentially apply
     // current data.
     if (!isFatalEvent) {
-        event = [scope applyToEvent:event maxBreadcrumb:self.options.maxBreadcrumbs];
+        // Unwrapping the event because we assume that the event will be returned
+        event = SENTRY_UNWRAP_NULLABLE(
+            SentryEvent, [scope applyToEvent:event maxBreadcrumb:self.options.maxBreadcrumbs]);
     }
 
     if (!eventIsNotReplay) {
         event.breadcrumbs = nil;
     }
 
-    if ([self isWatchdogTermination:event isFatalEvent:isFatalEvent]) {
+    if ([self isWatchdogTermination:SENTRY_UNWRAP_NULLABLE(SentryEvent, event)
+                       isFatalEvent:isFatalEvent]) {
         // Remove some mutable properties from the device/app contexts which are no longer
         // applicable
-        [self removeExtraDeviceContextFromEvent:event];
+        [self removeExtraDeviceContextFromEvent:SENTRY_UNWRAP_NULLABLE(SentryEvent, event)];
     } else if (!isFatalEvent) {
         // Store the current free memory battery level and more mutable properties,
         // at the time of this event, but not for crashes as the current data isn't guaranteed to be
         // the same as when the app crashed.
-        [self applyExtraDeviceContextToEvent:event];
-        [self applyCultureContextToEvent:event];
+        [self applyExtraDeviceContextToEvent:SENTRY_UNWRAP_NULLABLE(SentryEvent, event)];
+        [self applyCultureContextToEvent:SENTRY_UNWRAP_NULLABLE(SentryEvent, event)];
 #if SENTRY_HAS_UIKIT
-        [self applyCurrentViewNamesToEventContext:event withScope:scope];
+        [self applyCurrentViewNamesToEventContext:SENTRY_UNWRAP_NULLABLE(SentryEvent, event)
+                                        withScope:scope];
 #endif // SENTRY_HAS_UIKIT
     }
 
@@ -788,7 +794,7 @@ - (SentryEvent *_Nullable)prepareEvent:(SentryEvent *)event
     }
 
     // Need to do this after the scope is applied cause this sets the user if there is any
-    [self setUserIdIfNoUserSet:event];
+    [self setUserIdIfNoUserSet:SENTRY_UNWRAP_NULLABLE(SentryEvent, event)];
 
     BOOL eventIsATransaction
         = event.type != nil && [event.type isEqualToString:SentryEnvelopeItemTypes.transaction];
@@ -822,7 +828,7 @@ - (SentryEvent *_Nullable)prepareEvent:(SentryEvent *)event
     }
 
     if (eventIsNotUserFeedback && event != nil && nil != self.options.beforeSend) {
-        event = self.options.beforeSend(event);
+        event = self.options.beforeSend(SENTRY_UNWRAP_NULLABLE(SentryEvent, event));
         if (event == nil) {
             [self recordLost:eventIsNotATransaction reason:kSentryDiscardReasonBeforeSend];
             if (eventIsATransaction) {
@@ -843,7 +849,7 @@ - (SentryEvent *_Nullable)prepareEvent:(SentryEvent *)event
     if (event != nil) {
         // if the event is dropped by beforeSend we should not execute event processors as they
         // might trigger e.g. unnecessary replay capture
-        event = [self callEventProcessors:event];
+        event = [self callEventProcessors:SENTRY_UNWRAP_NULLABLE(SentryEvent, event)];
         if (event == nil) {
             [self recordLost:eventIsNotATransaction reason:kSentryDiscardReasonEventProcessor];
             if (eventIsATransaction) {
@@ -866,7 +872,7 @@ - (SentryEvent *_Nullable)prepareEvent:(SentryEvent *)event
         // We only want to call the callback once. It can occur that multiple crash events are
         // about to be sent.
         SentrySDKInternal.crashedLastRunCalled = YES;
-        self.options.onCrashedLastRun(event);
+        self.options.onCrashedLastRun(SENTRY_UNWRAP_NULLABLE(SentryEvent, event));
     }
 
     return event;
@@ -926,7 +932,7 @@ - (void)setSdk:(SentryEvent *)event
     event.sdk = [[[SentrySdkInfo alloc] initWithOptions:self.options] serialize];
 }
 
-- (void)setUserInfo:(NSDictionary *)userInfo withEvent:(SentryEvent *)event
+- (void)setUserInfo:(NSDictionary *_Nullable)userInfo withEvent:(SentryEvent *_Nullable)event
 {
     if (nil != event && nil != userInfo && userInfo.count > 0) {
         NSMutableDictionary *context;
@@ -989,14 +995,23 @@ - (void)applyExtraDeviceContextToEvent:(SentryEvent *)event
     [self modifyContext:event
                     key:SENTRY_CONTEXT_DEVICE_KEY
                   block:^(NSMutableDictionary *device) {
-                      [device addEntriesFromDictionary:extraContext[SENTRY_CONTEXT_DEVICE_KEY]];
+                      if (extraContext[SENTRY_CONTEXT_DEVICE_KEY] != nil &&
+                          [extraContext[SENTRY_CONTEXT_DEVICE_KEY]
+                              isKindOfClass:NSDictionary.class]) {
+                          [device addEntriesFromDictionary:extraContext[SENTRY_CONTEXT_DEVICE_KEY]
+                                  ?: @ {}];
+                      }
                   }];
 
-    [self modifyContext:event
-                    key:@"app"
-                  block:^(NSMutableDictionary *app) {
-                      [app addEntriesFromDictionary:extraContext[@"app"]];
-                  }];
+    [self
+        modifyContext:event
+                  key:SENTRY_CONTEXT_APP_KEY
+                block:^(NSMutableDictionary *app) {
+                    if (extraContext[SENTRY_CONTEXT_APP_KEY] != nil &&
+                        [extraContext[SENTRY_CONTEXT_APP_KEY] isKindOfClass:NSDictionary.class]) {
+                        [app addEntriesFromDictionary:extraContext[SENTRY_CONTEXT_APP_KEY] ?: @ {}];
+                    }
+                }];
 }
 
 #if SENTRY_HAS_UIKIT