fix(profiling): Change path of non-sandboxed macOS app launch profile configuration (#5143)

Co-authored-by: Philip Niedertscheider <[email protected]>

Author: armcknight

.github/workflows/build.yml

@@ -57,8 +57,8 @@ jobs:
         # other sample projects are built in ui-tests
         include:
           - scheme: macOS-Swift
-            xcode: 15.4
-            runs-on: macos-14
+            xcode: 16.3
+            runs-on: macos-15
           - scheme: iOS13-Swift
             xcode: 15.4
             runs-on: macos-14

CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## Unreleased
+
+> ![Important]
+> Version 8.21.0 introduced an issue for app launch profiling **only for macOS apps that run without a sandbox** (i.e. distributed outside the Mac App Store).
+> This issue could lead to starting the app launch profiler even when it's not configured via the options.
+> We recommend upgrading to at least this version.
+
+### Fixes
+
+- Non-sandboxed macOS app launch profile configuration are now respected (#5144)
+
 ## 8.49.1
 
 ### Fixes
@@ -17,7 +28,7 @@
 - New continuous profiling configuration API (#4952 and #5063)
 
 > [!Important]
-> With the addition of the new profiling configuation API, the previous profiling API are deprecated and will be removed in the next major version of the SDK:
+> With the addition of the new profiling configuration API, the previous profiling API are deprecated and will be removed in the next major version of the SDK:
 >
 > - `SentryOptions.enableProfiling`
 > - `SentryOptions.isProfilingEnabled`
@@ -897,6 +908,11 @@ The following two features, disabled by default, were mistakenly added to the re
 
 ## 8.21.0
 
+> ![Important]
+> This version introduced an issue for app launch profiling **only for macOS apps that run without a sandbox** (i.e. distributed outside the Mac App Store).
+> This issue could lead to starting the app launch profiler even when it's not configured via the options.
+> We recommend upgrading to at least version 8.49.2.
+
 ### Features
 
 - Add support for Sentry [Spotlight](https://spotlightjs.com/) (#3642), which is basically Sentry

Plans/iOS13-Swift_Base.xctestplan

@@ -11,10 +11,7 @@
   "defaultOptions" : {
     "codeCoverage" : false,
     "commandLineArgumentEntries" : [
-      {
-        "argument" : "--io.sentry.profiling.enable",
-        "enabled" : false
-      }
+
     ],
     "targetForVariableExpansion" : {
       "containerPath" : "container:iOS-Swift.xcodeproj",

Plans/macOS-Swift_Base.xctestplan

@@ -11,10 +11,7 @@
   "defaultOptions" : {
     "codeCoverage" : false,
     "commandLineArgumentEntries" : [
-      {
-        "argument" : "--io.sentry.profiling.enable",
-        "enabled" : false
-      }
+
     ],
     "targetForVariableExpansion" : {
       "containerPath" : "container:macOS-Swift.xcodeproj",
@@ -24,7 +21,13 @@
     "uiTestingScreenshotsLifetime" : "keepAlways"
   },
   "testTargets" : [
-
+    {
+      "target" : {
+        "containerPath" : "container:macOS-Swift.xcodeproj",
+        "identifier" : "84B5A90E2DBD1AA4003327C9",
+        "name" : "macOS-Swift-UITests"
+      }
+    }
   ],
   "version" : 1
 }

Samples/iOS-Swift/iOS-Swift-UITests/UserFeedbackUITests.swift

@@ -8,6 +8,7 @@ class UserFeedbackUITests: BaseUITest {
     let fm = FileManager.default
 
     /// The Application Support directory is different between this UITest runner app and the target app under test. We have to retrieve the target app's app support directory using UI elements and store it here for usage.
+    /// - note: The SDK does not use application support for anything. We only use the app support directory for these tests to write marker files from the app indicating which feedback hooks have fired.
     var appSupportDirectory: String?
 
     override func setUp() {

Samples/iOS-Swift/iOS-Swift.xcodeproj/xcshareddata/xcschemes/iOS13-Swift.xcscheme

@@ -66,12 +66,6 @@
             ReferencedContainer = "container:iOS-Swift.xcodeproj">
          </BuildableReference>
       </BuildableProductRunnable>
-      <CommandLineArguments>
-         <CommandLineArgument
-            argument = "--io.sentry.profiling.enable"
-            isEnabled = "NO">
-         </CommandLineArgument>
-      </CommandLineArguments>
    </LaunchAction>
    <ProfileAction
       buildConfiguration = "Release"

Samples/iOS-Swift/iOS-Swift/Profiling/NSObject+SentryAppSetup.m

@@ -5,13 +5,18 @@ + (void)load
 {
     NSLog(@"[iOS-Swift] Starting app launch work");
     if ([NSProcessInfo.processInfo.arguments containsObject:@"--io.sentry.slow-load-method"]) {
-        NSMutableString *a = [NSMutableString string];
-        // 1,000,000 iterations takes about 225 milliseconds in the iPhone 15 simulator on an
-        // M2 macbook pro; we might have to adapt this for CI
-        for (NSUInteger i = 0; i < 4000000; i++) {
-            [a appendFormat:@"%d", arc4random() % 12345];
-        }
+        [self sentry_slowLoadWork];
     }
     NSLog(@"[iOS-Swift] Finishing app launch work");
 }
+
++ (void)sentry_slowLoadWork
+{
+    NSMutableString *a = [NSMutableString string];
+    // 1,000,000 iterations takes about 225 milliseconds in the iPhone 15 simulator on an
+    // M2 macbook pro; we might have to adapt this for CI
+    for (NSUInteger i = 0; i < 4000000; i++) {
+        [a appendFormat:@"%d", arc4random() % 12345];
+    }
+}
 @end

Samples/macOS-Swift/macOS-Swift/AppDelegate.swift renamed to Samples/macOS-Swift/Shared/AppDelegate.swift

@@ -5,23 +5,30 @@ import Sentry
 class AppDelegate: NSObject, NSApplicationDelegate {
 
     func applicationDidFinishLaunching(_ aNotification: Notification) {
-
         // Insert code here to initialize your application
         SentrySDK.start { options in
             options.dsn = "https://[email protected]/5428557"
             options.debug = true
             options.tracesSampleRate = 1.0
 
             let args = ProcessInfo.processInfo.arguments
-            
-            if args.contains("--io.sentry.profiling.enable") {
-                options.profilesSampleRate = 1
+
+            // Set the profilesSampleRate to `nil` to enable the configureProfiling block
+            options.profilesSampleRate = nil
+            options.configureProfiling = {
+                $0.profileAppStarts = ProcessInfo.processInfo.arguments.contains("--io.sentry.enable-profile-app-starts")
+                $0.sessionSampleRate = 1
+            }
+
+            if args.contains("--disable-auto-performance-tracing") {
+                options.enableAutoPerformanceTracing = false
             }
+
             if #available(macOS 12.0, *), !args.contains("--disable-metrickit-integration") {
                 options.enableMetricKit = true
                 options.enableMetricKitRawPayload = true
             }
-            
+
             options.initialScope = { scope in
                 if let path = Bundle.main.path(forResource: "Tongariro", ofType: "jpg") {
                     scope.addAttachment(Attachment(path: path, filename: "Tongariro.jpg", contentType: "image/jpeg"))