ref: asserts and warnings (#3139)

Author: armcknight

Sources/Sentry/SentryNSTimerFactory.m

@@ -1,11 +1,17 @@
 #import "SentryNSTimerFactory.h"
+#import "SentryInternalDefines.h"
 
 @implementation SentryNSTimerFactory
 
 - (NSTimer *)scheduledTimerWithTimeInterval:(NSTimeInterval)interval
                                     repeats:(BOOL)repeats
                                       block:(void (^)(NSTimer *timer))block
 {
+    SENTRY_ASSERT([NSThread isMainThread],
+        @"Timers must be scheduled from the main thread, or they may never fire. See the attribute "
+        @"on the declaration in NSTimer.h. See "
+        @"https://stackoverflow.com/questions/8304702/"
+        @"how-do-i-create-a-nstimer-on-a-background-thread for more info.");
     return [NSTimer scheduledTimerWithTimeInterval:interval repeats:repeats block:block];
 }
 
@@ -15,6 +21,11 @@ - (NSTimer *)scheduledTimerWithTimeInterval:(NSTimeInterval)ti
                                    userInfo:(nullable id)userInfo
                                     repeats:(BOOL)yesOrNo
 {
+    SENTRY_ASSERT([NSThread isMainThread],
+        @"Timers must be scheduled from the main thread, or they may never fire. See the attribute "
+        @"on the declaration in NSTimer.h. See "
+        @"https://stackoverflow.com/questions/8304702/"
+        @"how-do-i-create-a-nstimer-on-a-background-thread for more info.");
     return [NSTimer scheduledTimerWithTimeInterval:ti
                                             target:aTarget
                                           selector:aSelector

Sources/Sentry/SentryProfileTimeseries.mm

@@ -18,7 +18,8 @@
 logSlicingFailureWithArray(
     NSArray<SentrySample *> *array, SentryTransaction *transaction, BOOL start)
 {
-    if (!SENTRY_CASSERT(array.count > 0, @"Should not have attempted to slice an empty array.")) {
+    if (!SENTRY_CASSERT_RETURN(
+            array.count > 0, @"Should not have attempted to slice an empty array.")) {
         return;
     }
 

Sources/Sentry/SentryTracerConcurrency.mm

@@ -3,6 +3,7 @@
 #if SENTRY_TARGET_PROFILING_SUPPORTED
 
 #    import "SentryId.h"
+#    import "SentryInternalDefines.h"
 #    import "SentryLog.h"
 #    import "SentryProfiler+Private.h"
 #    import "SentryTracer.h"
@@ -41,7 +42,7 @@
     SENTRY_LOG_DEBUG(
         @"Tracking relationship between profiler id %@ and tracer id %@", profilerKey, tracerKey);
 
-    NSCAssert((_gProfilersToTracers == nil && _gTracersToProfilers == nil)
+    SENTRY_CASSERT((_gProfilersToTracers == nil && _gTracersToProfilers == nil)
             || (_gProfilersToTracers != nil && _gTracersToProfilers != nil),
         @"Both structures must be initialized simultaneously.");
 
@@ -69,16 +70,14 @@
 {
     std::lock_guard<std::mutex> l(_gStateLock);
 
-    NSCAssert(_gTracersToProfilers != nil && _gProfilersToTracers != nil,
+    SENTRY_CASSERT(_gTracersToProfilers != nil && _gProfilersToTracers != nil,
         @"Structures should have already been initialized by the time they are being queried");
 
     const auto tracerKey = tracer.traceId.sentryIdString;
     const auto profiler = _gTracersToProfilers[tracerKey];
 
-    NSCAssert(
-        profiler != nil, @"Expected a profiler to be associated with tracer id %@.", tracerKey);
-    if (profiler == nil) {
-        SENTRY_LOG_WARN(@"Could not find a profiler associated with tracer id %@.", tracerKey);
+    if (!SENTRY_CASSERT_RETURN(profiler != nil,
+            @"Expected a profiler to be associated with tracer id %@.", tracerKey)) {
         return nil;
     }
 

Sources/Sentry/include/SentryInternalDefines.h

@@ -1,13 +1,32 @@
+#import "SentryLog.h"
 #import <Foundation/Foundation.h>
 
 static NSString *const SentryDebugImageType = @"macho";
 
+/**
+ * Abort if assertion fails in debug, and log a warning if it fails in production.
+ */
+#define SENTRY_ASSERT(cond, ...)                                                                   \
+    if (!(cond)) {                                                                                 \
+        SENTRY_LOG_WARN(__VA_ARGS__);                                                              \
+        NSAssert(NO, __VA_ARGS__);                                                                 \
+    }
+
+/**
+ * Abort if assertion fails in debug, and log a warning if it fails in production.
+ */
+#define SENTRY_CASSERT(cond, ...)                                                                  \
+    if (!(cond)) {                                                                                 \
+        SENTRY_LOG_WARN(__VA_ARGS__);                                                              \
+        NSCAssert(NO, __VA_ARGS__);                                                                \
+    }
+
 /**
  * Abort if assertion fails in debug, and log a warning if it fails in production.
  * @return The result of the assertion condition, so it can be used to e.g. early return from the
  * point of it's check if that's also desirable in production.
  */
-#define SENTRY_ASSERT(cond, ...)                                                                   \
+#define SENTRY_ASSERT_RETURN(cond, ...)                                                            \
     ({                                                                                             \
         const auto __cond_result = (cond);                                                         \
         if (!__cond_result) {                                                                      \
@@ -22,7 +41,7 @@ static NSString *const SentryDebugImageType = @"macho";
  * @return The result of the assertion condition, so it can be used to e.g. early return from the
  * point of it's check if that's also desirable in production.
  */
-#define SENTRY_CASSERT(cond, ...)                                                                  \
+#define SENTRY_CASSERT_RETURN(cond, ...)                                                           \
     ({                                                                                             \
         const auto __cond_result = (cond);                                                         \
         if (!__cond_result) {                                                                      \