feat(experimental): Add native startWithConfigureOptions for Apple …

…platforms`

CHANGELOG.md

@@ -16,6 +16,7 @@
 
 - Rename `navigation.processing` span to more expressive `Navigation dispatch to screen A mounted/navigation cancelled` ([#4423](https://github.com/getsentry/sentry-react-native/pull/4423))
 - Add RN SDK package to `sdk.packages` for Cocoa ([#4381](https://github.com/getsentry/sentry-react-native/pull/4381))
+- Add experimental version of `startWithConfigureOptions` for Apple platforms ([#4444](https://github.com/getsentry/sentry-react-native/pull/4444))
 
 ### Internal
 

packages/core/RNSentry.podspec

@@ -33,7 +33,7 @@ Pod::Spec.new do |s|
   s.preserve_paths = '*.js'
 
   s.source_files = 'ios/**/*.{h,m,mm}'
-  s.public_header_files = 'ios/RNSentry.h'
+  s.public_header_files = 'ios/RNSentry.h', 'ios/RNSentrySDK.h'
 
   s.compiler_flags = other_cflags
 

packages/core/RNSentryCocoaTester/RNSentryCocoaTester.xcodeproj/project.pbxproj

@@ -27,6 +27,7 @@
 		332D334A2CDCC8EB00547D76 /* RNSentryCocoaTesterTests-Bridging-Header.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "RNSentryCocoaTesterTests-Bridging-Header.h"; sourceTree = "<group>"; };
 		333B58A82D35BA93000F8D04 /* RNSentryStart.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; name = RNSentryStart.h; path = ../ios/RNSentryStart.h; sourceTree = SOURCE_ROOT; };
 		333B58A92D35BB2D000F8D04 /* RNSentryStart+Test.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; name = "RNSentryStart+Test.h"; path = "RNSentryCocoaTesterTests/RNSentryStart+Test.h"; sourceTree = SOURCE_ROOT; };
+		333B58AF2D36A7FD000F8D04 /* RNSentrySDK.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; name = RNSentrySDK.h; path = ../ios/RNSentrySDK.h; sourceTree = SOURCE_ROOT; };
 		336084382C32E382008CC412 /* RNSentryReplayBreadcrumbConverterTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = RNSentryReplayBreadcrumbConverterTests.swift; sourceTree = "<group>"; };
 		3360843A2C32E3A8008CC412 /* RNSentryReplayBreadcrumbConverter.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = RNSentryReplayBreadcrumbConverter.h; path = ../ios/RNSentryReplayBreadcrumbConverter.h; sourceTree = "<group>"; };
 		3360843C2C340C76008CC412 /* RNSentryBreadcrumbTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = RNSentryBreadcrumbTests.swift; sourceTree = "<group>"; };
@@ -118,6 +119,7 @@
 		33AFE0122B8F319000AAB120 /* RNSentry */ = {
 			isa = PBXGroup;
 			children = (
+				333B58AF2D36A7FD000F8D04 /* RNSentrySDK.h */,
 				333B58A92D35BB2D000F8D04 /* RNSentryStart+Test.h */,
 				333B58A82D35BA93000F8D04 /* RNSentryStart.h */,
 				3380C6C02CDEC56B0018B9B6 /* Replay */,

packages/core/RNSentryCocoaTester/RNSentryCocoaTesterTests/RNSentryTests.mm

@@ -2,6 +2,7 @@
 #import "RNSentryStart+Test.h"
 #import <OCMock/OCMock.h>
 #import <RNSentry/RNSentry.h>
+#import <Sentry/PrivateSentrySDKOnly.h>
 #import <Sentry/SentryDebugImageProvider+HybridSDKs.h>
 #import <UIKit/UIKit.h>
 #import <XCTest/XCTest.h>
@@ -12,9 +13,8 @@ @interface RNSentryInitNativeSdkTests : XCTestCase
 
 @implementation RNSentryInitNativeSdkTests
 
-- (void)testCreateOptionsWithDictionaryRemovesPerformanceProperties
+- (void)testStartWithDictionaryRemovesPerformanceProperties
 {
-    RNSentry *rnSentry = [[RNSentry alloc] init];
     NSError *error = nil;
 
     NSDictionary *_Nonnull mockedReactNativeDictionary =
@@ -26,9 +26,8 @@ - (void)testCreateOptionsWithDictionaryRemovesPerformanceProperties
 , @"enableTracing" : @YES,
 }
 ;
-SentryOptions *actualOptions =
-    [RNSentryStart createOptionsWithDictionary:mockedReactNativeDictionary error:&error];
-
+[RNSentryStart startWithOptions:mockedReactNativeDictionary error:&error];
+SentryOptions *actualOptions = PrivateSentrySDKOnly.options;
 XCTAssertNotNil(actualOptions, @"Did not create sentry options");
 XCTAssertNil(error, @"Should not pass no error");
 XCTAssertNotNil(
@@ -41,14 +40,13 @@ - (void)testCreateOptionsWithDictionaryRemovesPerformanceProperties
 
 - (void)testCaptureFailedRequestsIsDisabled
 {
-    RNSentry *rnSentry = [[RNSentry alloc] init];
     NSError *error = nil;
 
     NSDictionary *_Nonnull mockedReactNativeDictionary = @{
         @"dsn" : @"https://abcd@efgh.ingest.sentry.io/123456",
     };
-    SentryOptions *actualOptions =
-        [RNSentryStart createOptionsWithDictionary:mockedReactNativeDictionary error:&error];
+    [RNSentryStart startWithOptions:mockedReactNativeDictionary error:&error];
+    SentryOptions *actualOptions = PrivateSentrySDKOnly.options;
 
     XCTAssertNotNil(actualOptions, @"Did not create sentry options");
     XCTAssertNil(error, @"Should not pass no error");
@@ -57,7 +55,6 @@ - (void)testCaptureFailedRequestsIsDisabled
 
 - (void)testCreateOptionsWithDictionaryNativeCrashHandlingDefault
 {
-    RNSentry *rnSentry = [[RNSentry alloc] init];
     NSError *error = nil;
 
     NSDictionary *_Nonnull mockedReactNativeDictionary = @{
@@ -73,7 +70,6 @@ - (void)testCreateOptionsWithDictionaryNativeCrashHandlingDefault
 
 - (void)testCreateOptionsWithDictionaryAutoPerformanceTracingDefault
 {
-    RNSentry *rnSentry = [[RNSentry alloc] init];
     NSError *error = nil;
 
     NSDictionary *_Nonnull mockedReactNativeDictionary = @{
@@ -89,7 +85,6 @@ - (void)testCreateOptionsWithDictionaryAutoPerformanceTracingDefault
 
 - (void)testCreateOptionsWithDictionaryNativeCrashHandlingEnabled
 {
-    RNSentry *rnSentry = [[RNSentry alloc] init];
     NSError *error = nil;
 
     NSDictionary *_Nonnull mockedReactNativeDictionary = @{
@@ -106,7 +101,6 @@ - (void)testCreateOptionsWithDictionaryNativeCrashHandlingEnabled
 
 - (void)testCreateOptionsWithDictionaryAutoPerformanceTracingEnabled
 {
-    RNSentry *rnSentry = [[RNSentry alloc] init];
     NSError *error = nil;
 
     NSDictionary *_Nonnull mockedReactNativeDictionary = @{
@@ -123,7 +117,6 @@ - (void)testCreateOptionsWithDictionaryAutoPerformanceTracingEnabled
 
 - (void)testCreateOptionsWithDictionaryNativeCrashHandlingDisabled
 {
-    RNSentry *rnSentry = [[RNSentry alloc] init];
     NSError *error = nil;
 
     NSDictionary *_Nonnull mockedReactNativeDictionary = @{
@@ -140,7 +133,6 @@ - (void)testCreateOptionsWithDictionaryNativeCrashHandlingDisabled
 
 - (void)testCreateOptionsWithDictionaryAutoPerformanceTracingDisabled
 {
-    RNSentry *rnSentry = [[RNSentry alloc] init];
     NSError *error = nil;
 
     NSDictionary *_Nonnull mockedReactNativeDictionary = @{
@@ -157,7 +149,6 @@ - (void)testCreateOptionsWithDictionaryAutoPerformanceTracingDisabled
 
 - (void)testCreateOptionsWithDictionarySpotlightEnabled
 {
-    RNSentry *rnSentry = [[RNSentry alloc] init];
     NSError *error = nil;
 
     NSDictionary *_Nonnull mockedReactNativeDictionary = @{
@@ -175,7 +166,6 @@ - (void)testCreateOptionsWithDictionarySpotlightEnabled
 
 - (void)testCreateOptionsWithDictionarySpotlightOne
 {
-    RNSentry *rnSentry = [[RNSentry alloc] init];
     NSError *error = nil;
 
     NSDictionary *_Nonnull mockedReactNativeDictionary = @{
@@ -193,7 +183,6 @@ - (void)testCreateOptionsWithDictionarySpotlightOne
 
 - (void)testCreateOptionsWithDictionarySpotlightUrl
 {
-    RNSentry *rnSentry = [[RNSentry alloc] init];
     NSError *error = nil;
 
     NSDictionary *_Nonnull mockedReactNativeDictionary = @{
@@ -210,7 +199,6 @@ - (void)testCreateOptionsWithDictionarySpotlightUrl
 
 - (void)testCreateOptionsWithDictionarySpotlightDisabled
 {
-    RNSentry *rnSentry = [[RNSentry alloc] init];
     NSError *error = nil;
 
     NSDictionary *_Nonnull mockedReactNativeDictionary = @{
@@ -226,7 +214,6 @@ - (void)testCreateOptionsWithDictionarySpotlightDisabled
 
 - (void)testCreateOptionsWithDictionarySpotlightZero
 {
-    RNSentry *rnSentry = [[RNSentry alloc] init];
     NSError *error = nil;
 
     NSDictionary *_Nonnull mockedReactNativeDictionary = @{
@@ -242,7 +229,6 @@ - (void)testCreateOptionsWithDictionarySpotlightZero
 
 - (void)testPassesErrorOnWrongDsn
 {
-    RNSentry *rnSentry = [[RNSentry alloc] init];
     NSError *error = nil;
 
     NSDictionary *_Nonnull mockedReactNativeDictionary = @{
@@ -257,7 +243,6 @@ - (void)testPassesErrorOnWrongDsn
 
 - (void)testBeforeBreadcrumbsCallbackFiltersOutSentryDsnRequestBreadcrumbs
 {
-    RNSentry *rnSentry = [[RNSentry alloc] init];
     NSError *error = nil;
 
     NSDictionary *_Nonnull mockedDictionary = @{
@@ -278,7 +263,6 @@ - (void)testBeforeBreadcrumbsCallbackFiltersOutSentryDsnRequestBreadcrumbs
 
 - (void)testBeforeBreadcrumbsCallbackFiltersOutDevServerRequestBreadcrumbs
 {
-    RNSentry *rnSentry = [[RNSentry alloc] init];
     NSError *error = nil;
 
     NSString *mockDevServer = @"http://localhost:8081";
@@ -299,7 +283,6 @@ - (void)testBeforeBreadcrumbsCallbackFiltersOutDevServerRequestBreadcrumbs
 
 - (void)testBeforeBreadcrumbsCallbackDoesNotFiltersOutNonDevServerOrDsnRequestBreadcrumbs
 {
-    RNSentry *rnSentry = [[RNSentry alloc] init];
     NSError *error = nil;
 
     NSDictionary *_Nonnull mockedDictionary = @{
@@ -320,7 +303,6 @@ - (void)testBeforeBreadcrumbsCallbackDoesNotFiltersOutNonDevServerOrDsnRequestBr
 
 - (void)testBeforeBreadcrumbsCallbackKeepsBreadcrumbWhenDevServerUrlIsNotPassedAndDsnDoesNotMatch
 {
-    RNSentry *rnSentry = [[RNSentry alloc] init];
     NSError *error = nil;
 
     NSDictionary *_Nonnull mockedDictionary = @{ // dsn is always validated in SentryOptions initialization
@@ -340,7 +322,6 @@ - (void)testBeforeBreadcrumbsCallbackKeepsBreadcrumbWhenDevServerUrlIsNotPassedA
 
 - (void)testEventFromSentryCocoaReactNativeHasOriginAndEnvironmentTags
 {
-    RNSentry *rnSentry = [[RNSentry alloc] init];
     SentryEvent *testEvent = [[SentryEvent alloc] init];
     testEvent.sdk = @{
         @"name" : @"sentry.cocoa.react-native",
@@ -354,7 +335,6 @@ - (void)testEventFromSentryCocoaReactNativeHasOriginAndEnvironmentTags
 
 - (void)testEventFromSentryReactNativeOriginAndEnvironmentTagsAreOverwritten
 {
-    RNSentry *rnSentry = [[RNSentry alloc] init];
     SentryEvent *testEvent = [[SentryEvent alloc] init];
     testEvent.sdk = @{
         @"name" : @"sentry.cocoa.react-native",

packages/core/ios/RNSentry.h

@@ -11,6 +11,9 @@
 #import <Sentry/SentryDebugImageProvider.h>
 #import <Sentry/SentryOptions.h>
 
+// This import exposes public RNSentrySDK start
+#import "RNSentrySDK.h"
+
 typedef int (*SymbolicateCallbackType)(const void *, Dl_info *);
 
 @interface

packages/core/ios/RNSentry.mm

@@ -94,13 +94,11 @@ - (instancetype)init
                   : (RCTPromiseRejectBlock)reject)
 {
     NSError *error = nil;
-    SentryOptions *sentryOptions = [RNSentryStart createOptionsWithDictionary:options error:&error];
+    [RNSentryStart startWithOptions:options error:&error];
     if (error != nil) {
         reject(@"SentryReactNative", error.localizedDescription, error);
         return;
     }
-
-    [RNSentryStart startWithOptions:sentryOptions];
     resolve(@YES);
 }
 

packages/core/ios/RNSentrySDK.h

@@ -0,0 +1,17 @@
+#import <Sentry/Sentry.h>
+
+@interface RNSentrySDK : NSObject
+SENTRY_NO_INIT
+
+/**
+ * @experimental
+ * Inits and configures Sentry for React Native applications. Make sure to
+ * set a valid DSN.
+ *
+ * @discussion Call this method on the main thread. When calling it from a background thread, the
+ * SDK starts on the main thread async.
+ */
++ (void)startWithConfigureOptions:(void (^)(SentryOptions *options))configureOptions
+    NS_SWIFT_NAME(start(configureOptions:));
+
+@end

packages/core/ios/RNSentrySDK.m

@@ -0,0 +1,15 @@
+#import "RNSentrySDK.h"
+#import "RNSentryStart.h"
+
+@implementation RNSentrySDK
+
++ (void)startWithConfigureOptions:(void (^)(SentryOptions *options))configureOptions
+{
+    SentryOptions *options = [[SentryOptions alloc] init];
+    [RNSentryStart updateWithReactDefaults:options];
+    configureOptions(options);
+    [RNSentryStart updateWithReactFinals:options];
+    [RNSentryStart startWithOptions:options];
+}
+
+@end

packages/core/ios/RNSentryStart.h

@@ -4,9 +4,15 @@
 @interface RNSentryStart : NSObject
 SENTRY_NO_INIT
 
++ (void)startWithOptions:(NSDictionary *_Nonnull)javascriptOptions
+                   error:(NSError *_Nonnull *_Nonnull)errorPointer;
+
 + (SentryOptions *_Nullable)createOptionsWithDictionary:(NSDictionary *_Nonnull)options
                                                   error:(NSError *_Nonnull *_Nonnull)errorPointer;
 
++ (void)updateWithReactDefaults:(SentryOptions *)options;
++ (void)updateWithReactFinals:(SentryOptions *)options;
+
 /**
  * @experimental
  * Inits and configures Sentry for React Native applications. Make sure to