Feat: Allow manual init of the Native SDK (#765)

Author: marandaneto

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## Unreleased
 
 - Fix serialization of threads (#844)
+- Feat: Allow manual init of the Native SDK (#765)
 
 ## 6.6.0-alpha.1
 
@@ -67,7 +68,7 @@
 * Fix: Disable log by default in debug mode (#753)
 * [Dio] Ref: Replace FailedRequestAdapter with FailedRequestInterceptor (#728)
 * Fix: Add missing return values - dart analyzer (#742)
-* Feature: Add `DioEventProcessor` which improves DioError crash reports (#718)
+* Feat: Add `DioEventProcessor` which improves DioError crash reports (#718)
 * Fix: Do not report duplicated packages and integrations (#760)
 * Feat: Allow manual init of the Native SDK or no Native SDK at all (#765)
 

dart/lib/src/enricher/io_enricher_event_processor.dart

@@ -24,9 +24,11 @@ class IoEnricherEventProcessor extends EventProcessor {
   FutureOr<SentryEvent> apply(SentryEvent event, {dynamic hint}) {
     // If there's a native integration available, it probably has better
     // information available than Flutter.
+
     final os = _options.platformChecker.hasNativeIntegration
         ? null
         : _getOperatingSystem(event.contexts.operatingSystem);
+
     final device = _options.platformChecker.hasNativeIntegration
         ? null
         : _getDevice(event.contexts.device);

dart/lib/src/sentry_options.dart

@@ -210,11 +210,11 @@ class SentryOptions {
   /// breadcrumbs.
   bool enablePrintBreadcrumbs = true;
 
-  /// If [platformChecker] is provided, it is used get the envirnoment.
+  /// If [platformChecker] is provided, it is used get the environment.
   /// This is useful in tests. Should be an implementation of [PlatformChecker].
   PlatformChecker platformChecker = PlatformChecker();
 
-  /// If [environmentVariables] is provided, it is used get the envirnoment
+  /// If [environmentVariables] is provided, it is used get the environment
   /// variables. This is useful in tests.
   EnvironmentVariables environmentVariables = EnvironmentVariables.instance();
 

flutter/android/src/main/kotlin/io/sentry/flutter/SentryFlutterPlugin.kt

@@ -11,7 +11,6 @@ import io.flutter.plugin.common.MethodChannel
 import io.flutter.plugin.common.MethodChannel.MethodCallHandler
 import io.flutter.plugin.common.MethodChannel.Result
 import io.sentry.HubAdapter
-import io.sentry.Sentry
 import io.sentry.SentryEvent
 import io.sentry.SentryLevel
 import io.sentry.android.core.ActivityFramesTracker
@@ -270,7 +269,7 @@ class SentryFlutterPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
   }
 
   private fun closeNativeSdk(result: Result) {
-    Sentry.close()
+    HubAdapter.getInstance().close()
     framesTracker?.stop()
     framesTracker = null
 

flutter/lib/src/default_integrations.dart

@@ -325,7 +325,7 @@ class _LoadContextsIntegrationEventProcessor extends EventProcessor {
   }
 }
 
-/// Enables Sentry's native SDKs (Android and iOS)
+/// Enables Sentry's native SDKs (Android and iOS) with options.
 class NativeSdkIntegration extends Integration<SentryFlutterOptions> {
   NativeSdkIntegration(this._channel);
 
@@ -335,6 +335,9 @@ class NativeSdkIntegration extends Integration<SentryFlutterOptions> {
   @override
   FutureOr<void> call(Hub hub, SentryFlutterOptions options) async {
     _options = options;
+    if (!options.autoInitializeNative) {
+      return;
+    }
     try {
       await _channel.invokeMethod<void>('initNativeSdk', <String, dynamic>{
         'dsn': options.dsn,
@@ -377,6 +380,10 @@ class NativeSdkIntegration extends Integration<SentryFlutterOptions> {
 
   @override
   FutureOr<void> close() async {
+    final options = _options;
+    if (options != null && !options.autoInitializeNative) {
+      return;
+    }
     try {
       await _channel.invokeMethod<void>('closeNativeSdk');
     } catch (exception, stackTrace) {

flutter/lib/src/sentry_flutter.dart

@@ -27,7 +27,6 @@ typedef FlutterOptionsConfiguration = FutureOr<void> Function(
 mixin SentryFlutter {
   static const _channel = MethodChannel('sentry_flutter');
 
-  /// Initializes the SDK
   static Future<void> init(
     FlutterOptionsConfiguration optionsConfiguration, {
     AppRunner? appRunner,
@@ -115,13 +114,15 @@ mixin SentryFlutter {
     }
 
     // Will enrich events with device context, native packages and integrations
-    if (!options.platformChecker.isWeb &&
+    if (options.platformChecker.hasNativeIntegration &&
+        !options.platformChecker.isWeb &&
         (options.platformChecker.platform.isIOS ||
             options.platformChecker.platform.isMacOS)) {
       integrations.add(LoadContextsIntegration(channel));
     }
 
-    if (!options.platformChecker.isWeb &&
+    if (options.platformChecker.hasNativeIntegration &&
+        !options.platformChecker.isWeb &&
         options.platformChecker.platform.isAndroid) {
       integrations.add(LoadAndroidImageListIntegration(channel));
     }

flutter/lib/src/sentry_flutter_options.dart

@@ -11,6 +11,14 @@ class SentryFlutterOptions extends SentryOptions {
     enableBreadcrumbTrackingForCurrentPlatform();
   }
 
+  /// Initializes the Native SDKs on init.
+  /// Set this to `false` if you have an existing native SDK and don't want to re-initialize.
+  ///
+  /// NOTE: Be careful and only use this if you know what you are doing.
+  /// If you use this flag, make sure a native SDK is running before the Flutter Engine initializes or events might not be captured.
+  /// Defaults to `true`.
+  bool autoInitializeNative = true;
+
   /// Enable or disable reporting of used packages.
   bool reportPackages = true;
 

flutter/test/default_integrations_test.dart

@@ -256,6 +256,37 @@ void main() {
     expect(closeCalled, true);
   });
 
+  test('nativeSdkIntegration does not call native sdk when auto init disabled',
+      () async {
+    var methodChannelCalled = false;
+    _channel.setMockMethodCallHandler((MethodCall methodCall) async {
+      methodChannelCalled = true;
+    });
+    fixture.options.autoInitializeNative = false;
+
+    final integration = NativeSdkIntegration(_channel);
+
+    await integration.call(fixture.hub, fixture.options);
+
+    expect(methodChannelCalled, false);
+  });
+
+  test('nativeSdkIntegration does not close native when auto init disabled',
+      () async {
+    var methodChannelCalled = false;
+    _channel.setMockMethodCallHandler((MethodCall methodCall) async {
+      methodChannelCalled = true;
+    });
+    fixture.options.autoInitializeNative = false;
+
+    final integration = NativeSdkIntegration(_channel);
+
+    await integration(fixture.hub, fixture.options);
+    await integration.close();
+
+    expect(methodChannelCalled, false);
+  });
+
   test('loadContextsIntegration adds integration', () async {
     _channel.setMockMethodCallHandler((MethodCall methodCall) async {});
 

flutter/test/sentry_flutter_test.dart

@@ -154,8 +154,8 @@ void main() {
       await Sentry.close();
     });
 
-    test('Web && (iOS)', () async {
-      // Tests that iOS || macOS integrations aren't added on a browswer which
+    test('Web && (iOS || macOS) ', () async {
+      // Tests that iOS || macOS integrations aren't added on a browser which
       // runs on iOS or macOS
       await SentryFlutter.init(
         getConfigurationTester(