docs: Add Objective C examples to cocoa onboarding + non UI verification options (#92506)

itaybre · web-flow · commit 4e4d46a59736 · 2025-06-03T11:03:51.000-07:00
Apple onboarding only had Swift + UIKit verification steps. Added: - Objective C code - Non UI options to verify the setup Fixes [getsentry/sentry-cocoa#4991](getsentry/sentry-cocoa#4991) ### Legal Boilerplate Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.
diff --git a/static/app/gettingStartedDocs/apple/ios.spec.tsx b/static/app/gettingStartedDocs/apple/ios.spec.tsx
@@ -18,11 +18,26 @@ describe('apple-ios onboarding docs', function () {
     expect(screen.getByRole('heading', {name: 'Verify'})).toBeInTheDocument();
   });
 
+  it('renders swift onboarding docs correctly', async function () {
+    renderWithOnboardingLayout(docs, {
+      selectedProducts: [ProductSolution.ERROR_MONITORING],
+      selectedOptions: {
+        installationMode: InstallationMode.MANUAL_SWIFT,
+      },
+    });
+
+    expect(
+      await screen.findAllByText(
+        textWithMarkupMatcher(/throw MyCustomError\.myFirstIssue/)
+      )
+    ).toHaveLength(1);
+  });
+
   it('renders performance onboarding docs correctly', async function () {
     renderWithOnboardingLayout(docs, {
       selectedProducts: [ProductSolution.PERFORMANCE_MONITORING],
       selectedOptions: {
-        installationMode: InstallationMode.MANUAL,
+        installationMode: InstallationMode.MANUAL_SWIFT,
       },
     });
 
@@ -34,7 +49,7 @@ describe('apple-ios onboarding docs', function () {
   it('renders transaction profiling', async function () {
     renderWithOnboardingLayout(docs, {
       selectedOptions: {
-        installationMode: InstallationMode.MANUAL,
+        installationMode: InstallationMode.MANUAL_SWIFT,
       },
     });
 
@@ -61,7 +76,7 @@ describe('apple-ios onboarding docs', function () {
       docs,
       {
         selectedOptions: {
-          installationMode: InstallationMode.MANUAL,
+          installationMode: InstallationMode.MANUAL_SWIFT,
         },
       },
       {
@@ -87,4 +102,17 @@ describe('apple-ios onboarding docs', function () {
     expect(lifecycleElements).toHaveLength(2);
     lifecycleElements.forEach(element => expect(element).toBeInTheDocument());
   });
+
+  it('renders manual objective-c docs correctly', async function () {
+    renderWithOnboardingLayout(docs, {
+      selectedProducts: [ProductSolution.ERROR_MONITORING],
+      selectedOptions: {
+        installationMode: InstallationMode.MANUAL_OBJECTIVE_C,
+      },
+    });
+
+    expect(
+      await screen.findAllByText(textWithMarkupMatcher(/@import Sentry;/))
+    ).toHaveLength(1);
+  });
 });
diff --git a/static/app/gettingStartedDocs/apple/ios.tsx b/static/app/gettingStartedDocs/apple/ios.tsx
@@ -20,7 +20,8 @@ import {getWizardInstallSnippet} from 'sentry/utils/gettingStartedDocs/mobileWiz
 
 export enum InstallationMode {
   AUTO = 'auto',
-  MANUAL = 'manual',
+  MANUAL_SWIFT = 'manual-swift',
+  MANUAL_OBJECTIVE_C = 'manual-objective-c',
 }
 
 const platformOptions = {
@@ -32,8 +33,12 @@ const platformOptions = {
         value: InstallationMode.AUTO,
       },
       {
-        label: t('Manual'),
-        value: InstallationMode.MANUAL,
+        label: t('Manual (Swift)'),
+        value: InstallationMode.MANUAL_SWIFT,
+      },
+      {
+        label: t('Manual (Objective-C)'),
+        value: InstallationMode.MANUAL_OBJECTIVE_C,
       },
     ],
     defaultValue: InstallationMode.AUTO,
@@ -46,14 +51,19 @@ type Params = DocsParams<PlatformOptions>;
 const isAutoInstall = (params: Params) =>
   params.platformOptions.installationMode === InstallationMode.AUTO;
 
+const isManualSwift = (params: Params) =>
+  params.platformOptions.installationMode === InstallationMode.MANUAL_SWIFT;
+
+const selectedLanguage = (params: Params) => (isManualSwift(params) ? 'swift' : 'objc');
+
 const getManualInstallSnippet = (params: Params) => `
 .package(url: "https://github.com/getsentry/sentry-cocoa", from: "${getPackageVersion(
   params,
   'sentry.cocoa',
   '8.49.0'
 )}"),`;
 
-const getConfigurationSnippet = (params: Params) => `
+const getConfigurationSnippetSwift = (params: Params) => `
 import Sentry
 
 // ....
@@ -108,6 +118,58 @@ func application(_ application: UIApplication,
     return true
 }`;
 
+const getConfigurationSnippetObjectiveC = (params: Params) => `
+@import Sentry;
+
+// ....
+
+- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
+    [SentrySDK startWithConfigureOptions:^(SentryOptions *options) {
+        options.dsn = "${params.dsn.public}";
+        options.debug = YES; // Enabling debug when first installing is always helpful
+
+        // Adds IP for users.
+        // For more information, visit: https://docs.sentry.io/platforms/apple/data-management/data-collected/
+        options.sendDefaultPii = YES;${
+          params.isPerformanceSelected
+            ? `
+
+        // Set tracesSampleRate to 1.0 to capture 100% of transactions for tracing.
+        // We recommend adjusting this value in production.
+        options.tracesSampleRate = @1.0;`
+            : ''
+        }${
+          params.isProfilingSelected &&
+          params.profilingOptions?.defaultProfilingMode !== 'continuous'
+            ? `
+
+        // Set tracesSampleRate to 1.0 to capture 100% of transactions for tracing.
+        // We recommend adjusting this value in production.
+        options.tracesSampleRate = @1.0;`
+            : params.isProfilingSelected &&
+                params.profilingOptions?.defaultProfilingMode === 'continuous'
+              ? `
+
+        // Configure the profiler to start profiling when there is an active root span
+        // For more information, visit: https://docs.sentry.io/platforms/apple/profiling/
+        [options setConfigureProfiling:^(SentryProfileOptions * _Nonnull profiling) {
+              profiling.lifecycle = SentryProfileLifecycleTrace;
+              profiling.sessionSampleRate = 1.0;
+        }];`
+              : ''
+        }${
+          params.isReplaySelected
+            ? `
+
+        // Record Session Replays for 100% of Errors and 10% of Sessions
+        options.sessionReplay.onErrorSampleRate = 1.0;
+        options.sessionReplay.sessionSampleRate = 0.1;`
+            : ''
+        }
+    }];
+    return YES;
+}`;
+
 const getConfigurationSnippetSwiftUi = (params: Params) => `
 import Sentry
 
@@ -160,15 +222,37 @@ struct SwiftUIApp: App {
     }
 }`;
 
-const getVerifySnippet = () => `
-let button = UIButton(type: .roundedRect)
-button.frame = CGRect(x: 20, y: 50, width: 100, height: 30)
-button.setTitle("Break the world", for: [])
-button.addTarget(self, action: #selector(self.breakTheWorld(_:)), for: .touchUpInside)
-view.addSubview(button)
+const getVerifySnippet = (params: Params) =>
+  isManualSwift(params)
+    ? `
+enum MyCustomError: Error {
+    case myFirstIssue
+}
+
+func thisFunctionThrows() throws {
+    throw MyCustomError.myFirstIssue
+}
 
-@IBAction func breakTheWorld(_ sender: AnyObject) {
-    fatalError("Break the world")
+func verifySentrySDK() {
+    do {
+        try thisFunctionThrows()
+    } catch {
+        SentrySDK.capture(error: error)
+    }
+}`
+    : `
+- (void)thisFunctionReturnsAnError:(NSError **)error {
+    *error = [NSError errorWithDomain:@"com.example.myapp"
+                                 code:1001
+                             userInfo:@{
+      NSLocalizedDescriptionKey: @"Something went wrong."
+    }];
+}
+
+- (void)verifySentrySDK {
+    NSError *error = nil;
+    [self thisFunctionReturnsAnError:&error];
+    [SentrySDK captureError:error];
 }`;
 
 const getReplaySetupSnippet = (params: Params) => `
@@ -314,28 +398,35 @@ const onboarding: OnboardingConfig<PlatformOptions> = {
                 )}
               </p>
             ),
-            configurations: [
-              {
-                language: 'swift',
-                code: getConfigurationSnippet(params),
-              },
-              {
-                description: (
-                  <p>
-                    {tct(
-                      "When using SwiftUI and your app doesn't implement an app delegate, initialize the SDK within the [initializer: App conformer's initializer]:",
-                      {
-                        initializer: (
-                          <ExternalLink href="https://developer.apple.com/documentation/swiftui/app/main()" />
-                        ),
-                      }
-                    )}
-                  </p>
-                ),
-                language: 'swift',
-                code: getConfigurationSnippetSwiftUi(params),
-              },
-            ],
+            configurations: isManualSwift(params)
+              ? [
+                  {
+                    language: 'swift',
+                    code: getConfigurationSnippetSwift(params),
+                  },
+                  {
+                    description: (
+                      <p>
+                        {tct(
+                          "When using SwiftUI and your app doesn't implement an app delegate, initialize the SDK within the [initializer: App conformer's initializer]:",
+                          {
+                            initializer: (
+                              <ExternalLink href="https://developer.apple.com/documentation/swiftui/app/main()" />
+                            ),
+                          }
+                        )}
+                      </p>
+                    ),
+                    language: 'swift',
+                    code: getConfigurationSnippetSwiftUi(params),
+                  },
+                ]
+              : [
+                  {
+                    language: 'objc',
+                    code: getConfigurationSnippetObjectiveC(params),
+                  },
+                ],
           },
         ],
   verify: params =>
@@ -354,17 +445,17 @@ const onboarding: OnboardingConfig<PlatformOptions> = {
             description: (
               <p>
                 {tct(
-                  'This snippet contains an intentional error you can use to test that errors are uploaded to Sentry correctly. You can add it to your main [viewController: ViewController].',
+                  'This snippet contains an intentional error you can use to test that errors are uploaded to Sentry correctly. You can call [verifySentrySDK: verifySentrySDK()] from where you want to test it.',
                   {
-                    viewController: <code />,
+                    verifySentrySDK: <code />,
                   }
                 )}
               </p>
             ),
             configurations: [
               {
-                language: 'swift',
-                code: getVerifySnippet(),
+                language: selectedLanguage(params),
+                code: getVerifySnippet(params),
               },
             ],
           },
