refactor(ios): Migrate from PrivateSentrySDKOnly to SentrySDK.internal

CHANGELOG.md

@@ -8,6 +8,12 @@
 
 ## Unreleased
 
+### Internal
+
+- Migrate iOS code from the deprecated `PrivateSentrySDKOnly` SPI (and `SentrySwizzle.h` macro) to the new `SentrySDK.internal` Swift API exposed by sentry-cocoa 9.19.0, via a thin in-pod ObjC↔Swift bridge ([#6370](https://github.com/getsentry/sentry-react-native/issues/6370))
+
+## 8.16.0
+
 ### Features
 
 - Capture errors that hit Expo Router's per-route `ErrorBoundary` ([#6318](https://github.com/getsentry/sentry-react-native/pull/6318))

packages/core/RNSentry.podspec

@@ -41,7 +41,8 @@ Pod::Spec.new do |s|
 
   s.preserve_paths = '*.js'
 
-  s.source_files = 'ios/**/*.{h,m,mm}'
+  s.source_files = 'ios/**/*.{h,m,mm,swift}'
+  s.swift_versions = ['5.5']
   s.public_header_files = 'ios/RNSentry.h', 'ios/RNSentrySDK.h', 'ios/RNSentryStart.h', 'ios/RNSentryVersion.h', 'ios/RNSentryBreadcrumb.h', 'ios/RNSentryReplay.h', 'ios/RNSentryReplayBreadcrumbConverter.h', 'ios/Replay/RNSentryReplayMask.h', 'ios/Replay/RNSentryReplayUnmask.h', 'ios/RNSentryTimeToDisplay.h'
 
   s.compiler_flags = other_cflags

packages/core/RNSentryCocoaTester/RNSentryCocoaTesterTests/RNSentryReplayOptionsTests.swift

@@ -69,7 +69,7 @@ final class RNSentryReplayOptions: XCTestCase {
         ] as NSDictionary).mutableCopy() as! NSMutableDictionary
         RNSentryReplay.updateOptions(optionsDict)
 
-        let actualOptions = try! PrivateSentrySDKOnly.options(with: optionsDict as! [String: Any])
+        let actualOptions = try! SentrySDK.internal.options(fromDictionary: optionsDict as! [String: Any])
         XCTAssertEqual(actualOptions.sessionReplay.sessionSampleRate, 0.75)
     }
 
@@ -80,7 +80,7 @@ final class RNSentryReplayOptions: XCTestCase {
         ] as NSDictionary).mutableCopy() as! NSMutableDictionary
         RNSentryReplay.updateOptions(optionsDict)
 
-        let actualOptions = try! PrivateSentrySDKOnly.options(with: optionsDict as! [String: Any])
+        let actualOptions = try! SentrySDK.internal.options(fromDictionary: optionsDict as! [String: Any])
         XCTAssertEqual(actualOptions.sessionReplay.onErrorSampleRate, 0.75)
     }
 
@@ -110,7 +110,7 @@ final class RNSentryReplayOptions: XCTestCase {
 
         RNSentryReplay.updateOptions(optionsDict)
 
-        let actualOptions = try! PrivateSentrySDKOnly.options(with: optionsDict as! [String: Any])
+        let actualOptions = try! SentrySDK.internal.options(fromDictionary: optionsDict as! [String: Any])
 
         XCTAssertEqual(actualOptions.sessionReplay.maskAllImages, true)
         assertContainsClass(classArray: actualOptions.sessionReplay.maskedViewClasses, stringClass: "RCTImageView")
@@ -125,7 +125,7 @@ final class RNSentryReplayOptions: XCTestCase {
 
         RNSentryReplay.updateOptions(optionsDict)
 
-        let actualOptions = try! PrivateSentrySDKOnly.options(with: optionsDict as! [String: Any])
+        let actualOptions = try! SentrySDK.internal.options(fromDictionary: optionsDict as! [String: Any])
 
         XCTAssertEqual(actualOptions.sessionReplay.maskAllImages, false)
         XCTAssertEqual(actualOptions.sessionReplay.maskedViewClasses.count, 0)
@@ -140,7 +140,7 @@ final class RNSentryReplayOptions: XCTestCase {
 
         RNSentryReplay.updateOptions(optionsDict)
 
-        let actualOptions = try! PrivateSentrySDKOnly.options(with: optionsDict as! [String: Any])
+        let actualOptions = try! SentrySDK.internal.options(fromDictionary: optionsDict as! [String: Any])
 
         XCTAssertEqual(actualOptions.sessionReplay.maskAllText, true)
         assertContainsClass(classArray: actualOptions.sessionReplay.maskedViewClasses, stringClass: "RCTTextView")
@@ -167,7 +167,7 @@ final class RNSentryReplayOptions: XCTestCase {
 
         RNSentryReplay.updateOptions(optionsDict)
 
-        let actualOptions = try! PrivateSentrySDKOnly.options(with: optionsDict as! [String: Any])
+        let actualOptions = try! SentrySDK.internal.options(fromDictionary: optionsDict as! [String: Any])
 
         XCTAssertEqual(actualOptions.sessionReplay.maskAllText, false)
         XCTAssertEqual(actualOptions.sessionReplay.maskedViewClasses.count, 0)
@@ -181,7 +181,7 @@ final class RNSentryReplayOptions: XCTestCase {
 
         RNSentryReplay.updateOptions(optionsDict)
 
-        let actualOptions = try! PrivateSentrySDKOnly.options(with: optionsDict as! [String: Any])
+        let actualOptions = try! SentrySDK.internal.options(fromDictionary: optionsDict as! [String: Any])
 
         XCTAssertTrue(actualOptions.sessionReplay.enableViewRendererV2)
     }
@@ -195,7 +195,7 @@ final class RNSentryReplayOptions: XCTestCase {
 
         RNSentryReplay.updateOptions(optionsDict)
 
-        let actualOptions = try! PrivateSentrySDKOnly.options(with: optionsDict as! [String: Any])
+        let actualOptions = try! SentrySDK.internal.options(fromDictionary: optionsDict as! [String: Any])
 
         XCTAssertTrue(actualOptions.sessionReplay.enableViewRendererV2)
     }
@@ -209,7 +209,7 @@ final class RNSentryReplayOptions: XCTestCase {
 
         RNSentryReplay.updateOptions(optionsDict)
 
-        let actualOptions = try! PrivateSentrySDKOnly.options(with: optionsDict as! [String: Any])
+        let actualOptions = try! SentrySDK.internal.options(fromDictionary: optionsDict as! [String: Any])
 
         XCTAssertFalse(actualOptions.sessionReplay.enableViewRendererV2)
     }
@@ -222,7 +222,7 @@ final class RNSentryReplayOptions: XCTestCase {
 
         RNSentryReplay.updateOptions(optionsDict)
 
-        let actualOptions = try! PrivateSentrySDKOnly.options(with: optionsDict as! [String: Any])
+        let actualOptions = try! SentrySDK.internal.options(fromDictionary: optionsDict as! [String: Any])
 
         XCTAssertFalse(actualOptions.sessionReplay.enableFastViewRendering)
     }
@@ -236,7 +236,7 @@ final class RNSentryReplayOptions: XCTestCase {
 
         RNSentryReplay.updateOptions(optionsDict)
 
-        let actualOptions = try! PrivateSentrySDKOnly.options(with: optionsDict as! [String: Any])
+        let actualOptions = try! SentrySDK.internal.options(fromDictionary: optionsDict as! [String: Any])
 
         XCTAssertTrue(actualOptions.sessionReplay.enableFastViewRendering)
     }
@@ -250,7 +250,7 @@ final class RNSentryReplayOptions: XCTestCase {
 
         RNSentryReplay.updateOptions(optionsDict)
 
-        let actualOptions = try! PrivateSentrySDKOnly.options(with: optionsDict as! [String: Any])
+        let actualOptions = try! SentrySDK.internal.options(fromDictionary: optionsDict as! [String: Any])
 
         XCTAssertFalse(actualOptions.sessionReplay.enableFastViewRendering)
     }
@@ -263,7 +263,7 @@ final class RNSentryReplayOptions: XCTestCase {
 
         RNSentryReplay.updateOptions(optionsDict)
 
-        let actualOptions = try! PrivateSentrySDKOnly.options(with: optionsDict as! [String: Any])
+        let actualOptions = try! SentrySDK.internal.options(fromDictionary: optionsDict as! [String: Any])
 
         XCTAssertEqual(actualOptions.sessionReplay.quality, SentryReplayOptions.SentryReplayQuality.medium)
     }
@@ -277,7 +277,7 @@ final class RNSentryReplayOptions: XCTestCase {
 
         RNSentryReplay.updateOptions(optionsDict)
 
-        let actualOptions = try! PrivateSentrySDKOnly.options(with: optionsDict as! [String: Any])
+        let actualOptions = try! SentrySDK.internal.options(fromDictionary: optionsDict as! [String: Any])
 
         XCTAssertEqual(actualOptions.sessionReplay.quality, SentryReplayOptions.SentryReplayQuality.low)
     }
@@ -291,7 +291,7 @@ final class RNSentryReplayOptions: XCTestCase {
 
         RNSentryReplay.updateOptions(optionsDict)
 
-        let actualOptions = try! PrivateSentrySDKOnly.options(with: optionsDict as! [String: Any])
+        let actualOptions = try! SentrySDK.internal.options(fromDictionary: optionsDict as! [String: Any])
 
         XCTAssertEqual(actualOptions.sessionReplay.quality, SentryReplayOptions.SentryReplayQuality.medium)
     }
@@ -305,7 +305,7 @@ final class RNSentryReplayOptions: XCTestCase {
 
         RNSentryReplay.updateOptions(optionsDict)
 
-        let actualOptions = try! PrivateSentrySDKOnly.options(with: optionsDict as! [String: Any])
+        let actualOptions = try! SentrySDK.internal.options(fromDictionary: optionsDict as! [String: Any])
 
         XCTAssertEqual(actualOptions.sessionReplay.quality, SentryReplayOptions.SentryReplayQuality.high)
     }
@@ -319,7 +319,7 @@ final class RNSentryReplayOptions: XCTestCase {
 
         RNSentryReplay.updateOptions(optionsDict)
 
-        let actualOptions = try! PrivateSentrySDKOnly.options(with: optionsDict as! [String: Any])
+        let actualOptions = try! SentrySDK.internal.options(fromDictionary: optionsDict as! [String: Any])
 
         XCTAssertEqual(actualOptions.sessionReplay.quality, SentryReplayOptions.SentryReplayQuality.medium)
     }
@@ -333,7 +333,7 @@ final class RNSentryReplayOptions: XCTestCase {
 
         RNSentryReplay.updateOptions(optionsDict)
 
-        let actualOptions = try! PrivateSentrySDKOnly.options(with: optionsDict as! [String: Any])
+        let actualOptions = try! SentrySDK.internal.options(fromDictionary: optionsDict as! [String: Any])
 
         let includedViewClasses = actualOptions.sessionReplay.includedViewClasses
         XCTAssertEqual(includedViewClasses.count, 3)
@@ -351,7 +351,7 @@ final class RNSentryReplayOptions: XCTestCase {
 
         RNSentryReplay.updateOptions(optionsDict)
 
-        let actualOptions = try! PrivateSentrySDKOnly.options(with: optionsDict as! [String: Any])
+        let actualOptions = try! SentrySDK.internal.options(fromDictionary: optionsDict as! [String: Any])
 
         let excludedViewClasses = actualOptions.sessionReplay.excludedViewClasses
         XCTAssertEqual(excludedViewClasses.count, 3)
@@ -372,7 +372,7 @@ final class RNSentryReplayOptions: XCTestCase {
 
         RNSentryReplay.updateOptions(optionsDict)
 
-        let actualOptions = try! PrivateSentrySDKOnly.options(with: optionsDict as! [String: Any])
+        let actualOptions = try! SentrySDK.internal.options(fromDictionary: optionsDict as! [String: Any])
 
         let includedViewClasses = actualOptions.sessionReplay.includedViewClasses
         XCTAssertEqual(includedViewClasses.count, 2)

packages/core/RNSentryCocoaTester/RNSentryCocoaTesterTests/RNSentryStartFromFileTests.swift

@@ -1,3 +1,4 @@
+import Sentry
 import XCTest
 
 final class RNSentryStartFromFileTests: XCTestCase {
@@ -11,7 +12,7 @@ final class RNSentryStartFromFileTests: XCTestCase {
 
         XCTAssertTrue(wasConfigurationCalled)
 
-        let actualOptions = PrivateSentrySDKOnly.options
+        let actualOptions = SentrySDK.internal.options
         XCTAssertNil(actualOptions.dsn)
         XCTAssertNil(actualOptions.parsedDsn)
     }
@@ -25,7 +26,7 @@ final class RNSentryStartFromFileTests: XCTestCase {
 
         XCTAssertTrue(wasConfigurationCalled)
 
-        let actualOptions = PrivateSentrySDKOnly.options
+        let actualOptions = SentrySDK.internal.options
         XCTAssertNil(actualOptions.dsn)
         XCTAssertNil(actualOptions.parsedDsn)
     }
@@ -39,7 +40,7 @@ final class RNSentryStartFromFileTests: XCTestCase {
 
         XCTAssertTrue(wasConfigurationCalled)
 
-        let actualOptions = PrivateSentrySDKOnly.options
+        let actualOptions = SentrySDK.internal.options
         XCTAssertNil(actualOptions.dsn)
         XCTAssertNotNil(actualOptions.parsedDsn)
         XCTAssertEqual(actualOptions.environment, "environment-from-invalid-file")
@@ -54,7 +55,7 @@ final class RNSentryStartFromFileTests: XCTestCase {
 
         XCTAssertTrue(wasConfigurationCalled)
 
-        let actualOptions = PrivateSentrySDKOnly.options
+        let actualOptions = SentrySDK.internal.options
         XCTAssertNil(actualOptions.dsn)
         XCTAssertNotNil(actualOptions.parsedDsn)
         XCTAssertEqual(actualOptions.environment, "environment-from-valid-file")
@@ -76,7 +77,7 @@ final class RNSentryStartFromFileTests: XCTestCase {
             options.environment = "new-environment"
         }
 
-        let actualOptions = PrivateSentrySDKOnly.options
+        let actualOptions = SentrySDK.internal.options
         XCTAssertEqual(actualOptions.environment, "new-environment")
     }
 

packages/core/RNSentryCocoaTester/RNSentryCocoaTesterTests/RNSentryStartTests.swift

@@ -1,3 +1,4 @@
+import Sentry
 import XCTest
 
 final class RNSentryStartTests: XCTestCase {
@@ -29,7 +30,7 @@ final class RNSentryStartTests: XCTestCase {
             "dsn": "https://abcd@efgh.ingest.sentry.io/123456"
         ])
 
-        let actualOptions = PrivateSentrySDKOnly.options
+        let actualOptions = SentrySDK.internal.options
         assertReactDefaults(actualOptions)
     }
 
@@ -63,10 +64,10 @@ final class RNSentryStartTests: XCTestCase {
         for startMethod in testCases {
             try startMethod()
 
-            let actualOptions = PrivateSentrySDKOnly.options
+            let actualOptions = SentrySDK.internal.options
 
-            XCTAssertTrue(PrivateSentrySDKOnly.appStartMeasurementHybridSDKMode)
-            XCTAssertTrue(PrivateSentrySDKOnly.framesTrackingMeasurementHybridSDKMode)
+            XCTAssertTrue(SentrySDK.internal.appStart.hybridSDKMode)
+            XCTAssertTrue(SentrySDK.internal.performance.framesTrackingHybridSDKMode)
         }
     }
 
@@ -89,10 +90,10 @@ final class RNSentryStartTests: XCTestCase {
         for startMethod in testCases {
             try startMethod()
 
-            let actualOptions = PrivateSentrySDKOnly.options
+            let actualOptions = SentrySDK.internal.options
 
-            XCTAssertFalse(PrivateSentrySDKOnly.appStartMeasurementHybridSDKMode)
-            XCTAssertFalse(PrivateSentrySDKOnly.framesTrackingMeasurementHybridSDKMode)
+            XCTAssertFalse(SentrySDK.internal.appStart.hybridSDKMode)
+            XCTAssertFalse(SentrySDK.internal.performance.framesTrackingHybridSDKMode)
         }
     }
 
@@ -113,7 +114,7 @@ final class RNSentryStartTests: XCTestCase {
         for startMethod in testCases {
             try startMethod()
 
-            let actualOptions = PrivateSentrySDKOnly.options
+            let actualOptions = SentrySDK.internal.options
 
             let actualEvent = actualOptions.beforeSend!(createUnhandledJsExceptionEvent())
 
@@ -138,7 +139,7 @@ final class RNSentryStartTests: XCTestCase {
         for startMethod in testCases {
             try startMethod()
 
-            let actualOptions = PrivateSentrySDKOnly.options
+            let actualOptions = SentrySDK.internal.options
 
             let actualEvent = actualOptions.beforeSend!(createNativeEvent())
 
@@ -160,7 +161,7 @@ final class RNSentryStartTests: XCTestCase {
             }
         }
 
-        PrivateSentrySDKOnly.options.beforeSend!(genericEvent())
+        SentrySDK.internal.options.beforeSend!(genericEvent())
 
         XCTAssertTrue(executed)
     }
@@ -207,7 +208,7 @@ final class RNSentryStartTests: XCTestCase {
             ]
         ])
 
-        let actualOptions = PrivateSentrySDKOnly.options
+        let actualOptions = SentrySDK.internal.options
         XCTAssertTrue(actualOptions.attachScreenshot)
         XCTAssertFalse(actualOptions.screenshot.maskAllText)
         XCTAssertTrue(actualOptions.screenshot.maskAllImages)
@@ -219,7 +220,7 @@ final class RNSentryStartTests: XCTestCase {
             "attachScreenshot": true
         ])
 
-        let actualOptions = PrivateSentrySDKOnly.options
+        let actualOptions = SentrySDK.internal.options
         XCTAssertTrue(actualOptions.attachScreenshot)
         XCTAssertTrue(actualOptions.screenshot.maskAllText)
         XCTAssertTrue(actualOptions.screenshot.maskAllImages)
@@ -258,8 +259,8 @@ final class RNSentryStartTests: XCTestCase {
         var actualEvent: Event?
 
         // This is the closest to the sent event we can get using the actual Sentry start method
-        let originalBeforeSend = PrivateSentrySDKOnly.options.beforeSend
-        PrivateSentrySDKOnly.options.beforeSend = { event in
+        let originalBeforeSend = SentrySDK.internal.options.beforeSend
+        SentrySDK.internal.options.beforeSend = { event in
             if let originalBeforeSend = originalBeforeSend {
                 let processedEvent = originalBeforeSend(event)
                 actualEvent = processedEvent

packages/core/ios/AGENTS.md

@@ -56,5 +56,15 @@ RCT_EXPORT_METHOD(nativeOperation:(NSString *)param
 2. Edit `RNSentry.podspec` to remove version constraint
 3. Add local pod to sample's Podfile:
    ```ruby
-   pod 'Sentry/HybridSDK', :path => '../../../../sentry-cocoa'
+   pod 'Sentry', :path => '../../../../sentry-cocoa'
    ```
+
+## Internal API access (`SentrySDK.internal`)
+
+RNSentry consumes sentry-cocoa's hybrid-SDK surface (`SentrySDK.internal.*`)
+through a Swift bridge in `RNSentryInternal.swift`. The bridge imports Sentry
+with `@_spi(Private)` because several sub-APIs (`performance.currentScreenFrames`,
+`replay.configure`, `envelope.{store,capture,deserialize}`) are SPI-gated.
+`.m`/`.mm` callers import the auto-generated `RNSentry-Swift.h` and route
+through `[RNSentryInternal …]` instead of touching `PrivateSentrySDKOnly`
+(deprecated since cocoa 9.19.0 and slated for removal in the next major).

packages/core/ios/RNSentry+fetchNativeStack.m

@@ -2,7 +2,6 @@
 #import "RNSentryBreadcrumb.h"
 #import "RNSentryHexFormatter.h"
 #import "RNSentryId.h"
-#import <Sentry/PrivateSentrySDKOnly.h>
 @import Sentry;
 
 // This method was moved to a new category so we can use `@import Sentry` to use Sentry's Swift