Fix(V3): Duplicated session / Fix incompatibility with Cocoa V9

CHANGELOG.md

@@ -6,6 +6,12 @@
 > [migration guide](https://docs.sentry.io/platforms/javascript/guides/capacitor/migration/) first.
 <!-- prettier-ignore-end -->
 
+## Unreleased
+
+### Fixes
+
+- Duplicated session When running Capacitor as an app ([#1088](https://github.com/getsentry/sentry-capacitor/pull/1088))
+
 ## 3.0.0-beta.2
 
 ### Features

Package.swift

@@ -11,7 +11,7 @@ let package = Package(
     ],
     dependencies: [
         .package(url: "https://github.com/ionic-team/capacitor-swift-pm.git", "7.0.0"..<"9.0.0"),
-        .package(url: "https://github.com/getsentry/sentry-cocoa", from: "9.0.0")
+        .package(url: "https://github.com/getsentry/sentry-cocoa", from: "9.2.0")
     ],
     targets: [
         .target(

ios/Sources/SentryCapacitorPlugin/SentryCapacitorPlugin.swift

@@ -2,11 +2,6 @@ import Foundation
 import Capacitor
 @preconcurrency import Sentry
 
-// Keep compatibility with CocoaPods.
-#if SWIFT_PACKAGE
-import Sentry._Hybrid
-#endif
-
 /**
  * Please read the Capacitor iOS Plugin Development Guide
  * here: https://capacitorjs.com/docs/plugins/ios
@@ -70,7 +65,7 @@ public class SentryCapacitorPlugin: CAPPlugin, CAPBridgedPlugin {
         }
 
         do {
-            let options = try SentryOptionsInternal.initWithDict(optionsDict)
+            let options = try createOptions(from: optionsDict)
             let sdkVersion = PrivateSentrySDKOnly.getSdkVersionString()
             PrivateSentrySDKOnly.setSdkName(nativeSdkName, andVersionString: sdkVersion)
 
@@ -102,8 +97,67 @@ public class SentryCapacitorPlugin: CAPPlugin, CAPBridgedPlugin {
 
             call.resolve()
         } catch {
-            call.reject("Failed to start native SDK")
+            call.reject("Failed to start native SDK: \(error.localizedDescription)")
+        }
+    }
+
+    private func createOptions(from dict: [AnyHashable: Any]) throws -> Options {
+        guard let dsn = dict["dsn"] as? String else {
+            throw NSError(domain: "SentryCapacitor", code: 1, userInfo: [NSLocalizedDescriptionKey: "DSN is required"])
+        }
+
+        let options = Options()
+        options.dsn = dsn
+
+        if let debug = dict["debug"] as? Bool {
+            options.debug = debug
+        }
+
+        if let environment = dict["environment"] as? String {
+            options.environment = environment
+        }
+
+        if let release = dict["release"] as? String {
+            options.releaseName = release
+        }
+
+        if let dist = dict["dist"] as? String {
+            options.dist = dist
+        }
+
+        if let enableAutoSessionTracking = dict["enableAutoSessionTracking"] as? Bool {
+            options.enableAutoSessionTracking = enableAutoSessionTracking
         }
+
+        if let sessionTrackingIntervalMillis = dict["sessionTrackingIntervalMillis"] as? Int {
+            options.sessionTrackingIntervalMillis = UInt(sessionTrackingIntervalMillis)
+        }
+
+        if let maxBreadcrumbs = dict["maxBreadcrumbs"] as? UInt {
+            options.maxBreadcrumbs = maxBreadcrumbs
+        }
+
+        if let enableNativeCrashHandling = dict["enableNativeCrashHandling"] as? Bool {
+            options.enableCrashHandler = enableNativeCrashHandling
+        }
+
+        if let attachStacktrace = dict["attachStacktrace"] as? Bool {
+            options.attachStacktrace = attachStacktrace
+        }
+
+        if let sampleRate = dict["sampleRate"] as? Double {
+            options.sampleRate = NSNumber(value: sampleRate)
+        }
+
+        if let tracesSampleRate = dict["tracesSampleRate"] as? Double {
+            options.tracesSampleRate = NSNumber(value: tracesSampleRate)
+        }
+
+        if let enableAutoPerformanceTracing = dict["enableAutoPerformanceTracing"] as? Bool {
+            options.enableAutoPerformanceTracing = enableAutoPerformanceTracing
+        }
+
+        return options
     }
 
     @objc func captureEnvelope(_ call: CAPPluginCall) {

src/integrations/default.ts

@@ -1,5 +1,5 @@
 import { breadcrumbsIntegration, browserApiErrorsIntegration, browserSessionIntegration, globalHandlersIntegration } from '@sentry/browser';
-import { type Integration,dedupeIntegration, functionToStringIntegration, inboundFiltersIntegration, linkedErrorsIntegration } from '@sentry/core';
+import { type Integration, dedupeIntegration, functionToStringIntegration, inboundFiltersIntegration, linkedErrorsIntegration } from '@sentry/core';
 import type { CapacitorOptions } from '../options';
 import { deviceContextIntegration } from './devicecontext';
 import { eventOriginIntegration } from './eventorigin';

src/sdk.ts

@@ -1,7 +1,6 @@
 import type { BrowserOptions } from '@sentry/browser';
 import { init as browserInit } from '@sentry/browser';
-import type { Integration } from '@sentry/core';
-import { debug, getClient, getGlobalScope, getIntegrationsToSetup, getIsolationScope  } from '@sentry/core';
+import { debug, getClient, getGlobalScope, getIsolationScope } from '@sentry/core';
 import { sdkInit } from './client';
 import { getDefaultIntegrations } from './integrations/default';
 import type { CapacitorClientOptions, CapacitorOptions } from './options';
@@ -19,48 +18,38 @@ import { NATIVE } from './wrapper';
  */
 export function init(
   passedOptions: CapacitorOptions,
-  originalInit: (passedOptions:BrowserOptions) => void = browserInit,
+  originalInit: (passedOptions: BrowserOptions) => void = browserInit,
 ): void {
 
-  const finalOptions = {
+  /**
+   * Shared options are the options that are shared between the browser and native SDKs.
+   */
+  const sharedOptions = {
     enableAutoSessionTracking: true,
     enableWatchdogTerminationTracking: true,
     enableCaptureFailedRequests: false,
     ...passedOptions,
   };
-  finalOptions.siblingOptions && delete finalOptions.siblingOptions;
+  sharedOptions.siblingOptions && delete sharedOptions.siblingOptions;
 
-  if (finalOptions.enabled === false || NATIVE.platform === 'web') {
-    finalOptions.enableNative = false;
-    finalOptions.enableNativeNagger = false;
+  if (sharedOptions.enabled === false || NATIVE.platform === 'web') {
+    sharedOptions.enableNative = false;
+    sharedOptions.enableNativeNagger = false;
   } else {
     // keep the original value if user defined it.
-    finalOptions.enableNativeNagger ??= true;
-    finalOptions.enableNative ??= true;
+    sharedOptions.enableNativeNagger ??= true;
+    sharedOptions.enableNative ??= true;
   }
-  //  const capacitorHub = new Hub(undefined, new CapacitorScope());
-  //  makeMain(capacitorHub);
-  const defaultIntegrations: false | Integration[] =
-passedOptions.defaultIntegrations === undefined
-      ? getDefaultIntegrations(finalOptions)
-: passedOptions.defaultIntegrations;
-
-  finalOptions.integrations = getIntegrationsToSetup({
-integrations: safeFactory(passedOptions.integrations, {
-      loggerMessage: 'The integrations threw an error',
-    }),
-    defaultIntegrations,
-  });
 
   if (
-    finalOptions.enableNative &&
-!passedOptions.transport &&
+    sharedOptions.enableNative &&
+    !passedOptions.transport &&
     NATIVE.platform !== 'web'
   ) {
-finalOptions.transport = passedOptions.transport || makeNativeTransport;
+    sharedOptions.transport = passedOptions.transport || makeNativeTransport;
 
-    finalOptions.transportOptions = {
-...(passedOptions.transportOptions ?? {}),
+    sharedOptions.transportOptions = {
+      ...(passedOptions.transportOptions ?? {}),
       bufferSize: DEFAULT_BUFFER_SIZE,
     };
   }
@@ -69,25 +58,35 @@ finalOptions.transport = passedOptions.transport || makeNativeTransport;
     useEncodePolyfill();
   }
 
-  if (finalOptions.enableNative) {
+  if (sharedOptions.enableNative) {
     enableSyncToNative(getGlobalScope());
     enableSyncToNative(getIsolationScope());
   }
 
+  /**
+   * Browser options are the options that are only used by the browser SDK.
+   */
   const browserOptions = {
     ...passedOptions.siblingOptions?.vueOptions,
     ...passedOptions.siblingOptions?.nuxtClientOptions,
-    ...finalOptions,
-    autoSessionTracking:
-      NATIVE.platform === 'web' && finalOptions.enableAutoSessionTracking,
-    enableMetrics: finalOptions._experiments?.enableMetrics,
-    beforeSendMetric: finalOptions._experiments?.beforeSendMetric,
+    ...sharedOptions,
+    integrations: safeFactory(passedOptions.integrations, { loggerMessage: 'The integrations threw an error' }),
+    enableMetrics: sharedOptions._experiments?.enableMetrics,
+    beforeSendMetric: sharedOptions._experiments?.beforeSendMetric,
   } as BrowserOptions;
 
+
+  browserOptions.defaultIntegrations = passedOptions.defaultIntegrations === undefined
+    ? getDefaultIntegrations(sharedOptions)
+    : passedOptions.defaultIntegrations;
+
+  /**
+   * Mobile options are the options that are only used by the native SDK.
+   */
   const mobileOptions = {
-    ...finalOptions,
+    ...sharedOptions,
     enableAutoSessionTracking:
-      NATIVE.platform !== 'web' && finalOptions.enableAutoSessionTracking,
+      NATIVE.platform !== 'web' && sharedOptions.enableAutoSessionTracking,
   } as CapacitorClientOptions;
 
   sdkInit(browserOptions, mobileOptions, originalInit, passedOptions.transport);