Merge 6c538b6 into 3db98a8

getsentry · Feb 14, 2024 · 990435a · 990435a
2 parents 3db98a8 + 6c538b6
commit 990435a
Show file tree

Hide file tree

Showing 5 changed files with 55 additions and 16 deletions.
diff --git a/Sources/Sentry/Profiling/SentryLaunchProfiling.m b/Sources/Sentry/Profiling/SentryLaunchProfiling.m
@@ -15,9 +15,10 @@
 #    import "SentrySamplerDecision.h"
 #    import "SentrySampling.h"
 #    import "SentrySamplingContext.h"
+#    import "SentryTraceOrigins.h"
 #    import "SentryTracer+Private.h"
 #    import "SentryTracerConfiguration.h"
-#    import "SentryTransactionContext.h"
+#    import "SentryTransactionContext+Private.h"
 
 NS_ASSUME_NONNULL_BEGIN
 
@@ -108,6 +109,29 @@
     }];
 }
 
+SentryTransactionContext *
+context(NSNumber *tracesRate)
+{
+    SentryTransactionContext *context =
+        [[SentryTransactionContext alloc] initWithName:@"launch"
+                                            nameSource:kSentryTransactionNameSourceCustom
+                                             operation:@"app.lifecycle"
+                                                origin:SentryTraceOriginAutoAppStartProfile
+                                               sampled:kSentrySampleDecisionYes];
+    context.sampleRate = tracesRate;
+    return context;
+}
+
+SentryTracerConfiguration *
+config(NSNumber *profilesRate)
+{
+    SentryTracerConfiguration *config = [SentryTracerConfiguration defaultConfiguration];
+    config.profilesSamplerDecision =
+        [[SentrySamplerDecision alloc] initWithDecision:kSentrySampleDecisionYes
+                                          forSampleRate:profilesRate];
+    return config;
+}
+
 void
 startLaunchProfile(void)
 {
@@ -128,25 +152,19 @@
         [SentryLog configure:YES diagnosticLevel:kSentryLevelDebug];
 #    endif // defined(DEBUG)
 
-        SENTRY_LOG_INFO(@"Starting app launch profile.");
-
-        SentryTransactionContext *context =
-            [[SentryTransactionContext alloc] initWithName:@"launch"
-                                                 operation:@"app.lifecycle"
-                                                   sampled:kSentrySampleDecisionYes];
-        SentryTracerConfiguration *config = [SentryTracerConfiguration defaultConfiguration];
         NSDictionary<NSString *, NSNumber *> *rates = appLaunchProfileConfiguration();
         NSNumber *profilesRate = rates[kSentryLaunchProfileConfigKeyProfilesSampleRate];
         NSNumber *tracesRate = rates[kSentryLaunchProfileConfigKeyTracesSampleRate];
-        if (profilesRate != nil && tracesRate != nil) {
-            config.profilesSamplerDecision =
-                [[SentrySamplerDecision alloc] initWithDecision:kSentrySampleDecisionYes
-                                                  forSampleRate:profilesRate];
-            context.sampleRate = tracesRate;
+        if (profilesRate == nil || tracesRate == nil) {
+            SENTRY_LOG_DEBUG(
+                @"Received a nil configured launch sample rate, will not trace or profile.");
+            return;
         }
-        launchTracer = [[SentryTracer alloc] initWithTransactionContext:context
+
+        SENTRY_LOG_INFO(@"Starting app launch profile.");
+        launchTracer = [[SentryTracer alloc] initWithTransactionContext:context(tracesRate)
                                                                     hub:nil
-                                                          configuration:config];
+                                                          configuration:config(profilesRate)];
     });
 }
 
@@ -155,6 +173,7 @@
 {
     if (launchTracer == nil) {
         SENTRY_LOG_DEBUG(@"No launch tracer present to stop.");
+        return;
     }
 
     SENTRY_LOG_DEBUG(@"Finishing launch tracer.");

diff --git a/Sources/Sentry/include/SentryLaunchProfiling.h b/Sources/Sentry/include/SentryLaunchProfiling.h
@@ -15,7 +15,7 @@ NS_ASSUME_NONNULL_BEGIN
 SENTRY_EXTERN BOOL isTracingAppLaunch;
 
 /** Try to start a profiled trace for this app launch, if the configuration allows. */
-void startLaunchProfile(void);
+SENTRY_EXTERN void startLaunchProfile(void);
 
 /** Stop any profiled trace that may be in flight from the start of the app launch. */
 void stopLaunchProfile(SentryHub *hub);

diff --git a/Sources/Sentry/include/SentryTraceOrigins.h b/Sources/Sentry/include/SentryTraceOrigins.h
@@ -4,6 +4,7 @@ static NSString *const SentryTraceOriginManual = @"manual";
 static NSString *const SentryTraceOriginUIEventTracker = @"auto.ui.event_tracker";
 
 static NSString *const SentryTraceOriginAutoAppStart = @"auto.app.start";
+static NSString *const SentryTraceOriginAutoAppStartProfile = @"auto.app.start.profile";
 static NSString *const SentryTraceOriginAutoNSData = @"auto.file.ns_data";
 static NSString *const SentryTraceOriginAutoDBCoreData = @"auto.db.core_data";
 static NSString *const SentryTraceOriginAutoHttpNSURLSession = @"auto.http.ns_url_session";

diff --git a/Tests/SentryProfilerTests/SentryAppLaunchProfilingTests.m b/Tests/SentryProfilerTests/SentryAppLaunchProfilingTests.m
@@ -3,6 +3,8 @@
 #import "SentryOptions+Private.h"
 #import "SentryProfilingConditionals.h"
 #import "SentrySDK+Tests.h"
+#import "SentryTraceOrigins.h"
+#import "SentryTransactionContext.h"
 #import <XCTest/XCTest.h>
 
 #if SENTRY_TARGET_PROFILING_SUPPORTED
@@ -12,6 +14,14 @@ @interface SentryAppLaunchProfilingTests : XCTestCase
 
 @implementation SentryAppLaunchProfilingTests
 
+- (void)testLaunchProfileTransactionContext
+{
+    SentryTransactionContext *actualContext = context(@1);
+    XCTAssertEqual(actualContext.nameSource, kSentryTransactionNameSourceCustom);
+    XCTAssert([actualContext.origin isEqualToString:SentryTraceOriginAutoAppStartProfile]);
+    XCTAssert(actualContext.sampled);
+}
+
 #    define SENTRY_OPTION(name, value)                                                             \
         NSStringFromSelector(@selector(name))                                                      \
             : value
@@ -146,6 +156,8 @@ - (void)testDisablingUIViewControllerTracingOptionDisablesAppLaunchProfiling
 }
 #    endif // SENTRY_HAS_UIKIT
 
+#    pragma mark - Private
+
 - (SentryOptions *)defaultLaunchProfilingOptionsWithOverrides:
     (NSDictionary<NSString *, id> *)overrides
 {

diff --git a/Tests/SentryTests/SentryLaunchProfiling+Tests.h b/Tests/SentryTests/SentryLaunchProfiling+Tests.h
@@ -1,6 +1,8 @@
 #import "SentryDefines.h"
 #import "SentryLaunchProfiling.h"
 
+#if SENTRY_TARGET_PROFILING_SUPPORTED
+
 @class SentrySamplerDecision;
 @class SentryOptions;
 
@@ -17,4 +19,9 @@ SENTRY_EXTERN SentryLaunchProfileConfig shouldProfileNextLaunch(SentryOptions *o
 SENTRY_EXTERN NSString *const kSentryLaunchProfileConfigKeyTracesSampleRate;
 SENTRY_EXTERN NSString *const kSentryLaunchProfileConfigKeyProfilesSampleRate;
 
+SENTRY_EXTERN SentryTransactionContext *context(NSNumber *tracesRate);
+SENTRY_EXTERN SentryTracerConfiguration *config(NSNumber *profilesRate);
+
 NS_ASSUME_NONNULL_END
+
+#endif // SENTRY_TARGET_PROFILING_SUPPORTED