Fix: Use PlatformDispatcher.onError in Flutter 3.3 (#1039)

Co-authored-by: Manoel Aranda Neto <[email protected]>
Co-authored-by: Manoel Aranda Neto <[email protected]>

Author: denrase

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Features
+
+- Use PlatformDispatcher.onError in Flutter 3.3 ([#1039](https://github.com/getsentry/sentry-dart/pull/1039))
+
 ### Fixes
 
 - Bring protocol up to date with latest Sentry protocol ([#1038](https://github.com/getsentry/sentry-dart/pull/1038))

dart/lib/src/sentry.dart

@@ -36,6 +36,7 @@ class Sentry {
   static Future<void> init(
     OptionsConfiguration optionsConfiguration, {
     AppRunner? appRunner,
+    @internal bool callAppRunnerInRunZonedGuarded = true,
     @internal SentryOptions? options,
   }) async {
     final sentryOptions = options ?? SentryOptions();
@@ -56,7 +57,7 @@ class Sentry {
       throw ArgumentError('DSN is required.');
     }
 
-    await _init(sentryOptions, appRunner);
+    await _init(sentryOptions, appRunner, callAppRunnerInRunZonedGuarded);
   }
 
   static Future<void> _initDefaultValues(
@@ -96,7 +97,11 @@ class Sentry {
   }
 
   /// Initializes the SDK
-  static Future<void> _init(SentryOptions options, AppRunner? appRunner) async {
+  static Future<void> _init(
+    SentryOptions options,
+    AppRunner? appRunner,
+    bool callAppRunnerInRunZonedGuarded,
+  ) async {
     if (isEnabled) {
       options.logger(
         SentryLevel.warning,
@@ -113,21 +118,26 @@ class Sentry {
 
     // execute integrations after hub being enabled
     if (appRunner != null) {
-      var runIntegrationsAndAppRunner = () async {
-        final integrations =
-            options.integrations.where((i) => i is! RunZonedGuardedIntegration);
-        await _callIntegrations(integrations, options);
+      if (callAppRunnerInRunZonedGuarded) {
+        var runIntegrationsAndAppRunner = () async {
+          final integrations = options.integrations
+              .where((i) => i is! RunZonedGuardedIntegration);
+          await _callIntegrations(integrations, options);
+          await appRunner();
+        };
+
+        final runZonedGuardedIntegration =
+            RunZonedGuardedIntegration(runIntegrationsAndAppRunner);
+        options.addIntegrationByIndex(0, runZonedGuardedIntegration);
+
+        // RunZonedGuardedIntegration will run other integrations and appRunner
+        // runZonedGuarded so all exception caught in the error handler are
+        // handled
+        await runZonedGuardedIntegration(HubAdapter(), options);
+      } else {
+        await _callIntegrations(options.integrations, options);
         await appRunner();
-      };
-
-      final runZonedGuardedIntegration =
-          RunZonedGuardedIntegration(runIntegrationsAndAppRunner);
-      options.addIntegrationByIndex(0, runZonedGuardedIntegration);
-
-      // RunZonedGuardedIntegration will run other integrations and appRunner
-      // runZonedGuarded so all exception caught in the error handler are
-      // handled
-      await runZonedGuardedIntegration(HubAdapter(), options);
+      }
     } else {
       await _callIntegrations(options.integrations, options);
     }

dart/test/sentry_test.dart

@@ -284,6 +284,31 @@ void main() {
     });
   });
 
+  test('should complete when appRunner is not called in runZonedGuarded',
+      () async {
+    final completer = Completer();
+    var completed = false;
+
+    final init = Sentry.init(
+      (options) {
+        options.dsn = fakeDsn;
+      },
+      appRunner: () => completer.future,
+      callAppRunnerInRunZonedGuarded: false,
+    ).whenComplete(() => completed = true);
+
+    await Future(() {
+      // We make the expectation only after all microtasks have completed,
+      // that Sentry.init might have scheduled.
+      expect(completed, false);
+    });
+
+    completer.complete();
+    await init;
+
+    expect(completed, true);
+  });
+
   test('options.environment debug', () async {
     final sentryOptions = SentryOptions(dsn: fakeDsn)
       ..platformChecker = FakePlatformChecker.debugMode();

flutter/example/lib/main.dart

@@ -187,20 +187,6 @@ class MainScaffold extends StatelessWidget {
               },
               child: const Text('Capture from FlutterError.onError'),
             ),
-            ElevatedButton(
-              onPressed: () {
-                // Only usable on Flutter >= 3.3
-                // and needs the following additional setup:
-                // options.addIntegration(OnErrorIntegration());
-                (WidgetsBinding.instance.platformDispatcher as dynamic)
-                    .onError
-                    ?.call(
-                      Exception('PlatformDispatcher.onError'),
-                      StackTrace.current,
-                    );
-              },
-              child: const Text('Capture from PlatformDispatcher.onError'),
-            ),
             ElevatedButton(
               onPressed: () => makeWebRequest(context),
               child: const Text('Dart: Web request'),

flutter/example/pubspec.yaml

@@ -24,7 +24,7 @@ dependencies:
 
 dev_dependencies:
   pedantic: ^1.11.1
-  sentry_dart_plugin: ^1.0.0-alpha.4
+  sentry_dart_plugin: ^1.0.0-beta.1
 
 dependency_overrides:
   sentry:

flutter/lib/src/integrations/on_error_integration.dart

@@ -38,10 +38,6 @@ class OnErrorIntegration implements Integration<SentryFlutterOptions> {
     // WidgetsBinding works with WidgetsFlutterBinding and other custom bindings
     final wrapper = dispatchWrapper ??
         PlatformDispatcherWrapper(binding.platformDispatcher);
-
-    if (!wrapper.isOnErrorSupported(options)) {
-      return;
-    }
     _defaultOnError = wrapper.onError;
 
     _integrationOnError = (Object exception, StackTrace stackTrace) {

flutter/lib/src/sentry_flutter.dart

@@ -1,10 +1,11 @@
 import 'dart:async';
+import 'dart:ui';
 
 import 'package:flutter/scheduler.dart';
 import 'package:flutter/services.dart';
 import 'package:meta/meta.dart';
 import 'package:package_info_plus/package_info_plus.dart';
-import 'package:sentry/sentry.dart';
+import '../sentry_flutter.dart';
 import 'event_processor/android_platform_exception_event_processor.dart';
 import 'native_scope_observer.dart';
 import 'sentry_native.dart';
@@ -13,9 +14,7 @@ import 'sentry_native_channel.dart';
 import 'event_processor/flutter_enricher_event_processor.dart';
 import 'integrations/debug_print_integration.dart';
 import 'integrations/native_app_start_integration.dart';
-import 'sentry_flutter_options.dart';
 
-import 'default_integrations.dart';
 import 'file_system_transport.dart';
 
 import 'version.dart';
@@ -45,12 +44,17 @@ mixin SentryFlutter {
     final native = SentryNative();
     native.setNativeChannel(nativeChannel);
 
+    final platformDispatcher = PlatformDispatcher.instance;
+    final wrapper = PlatformDispatcherWrapper(platformDispatcher);
+    final isOnErrorSupported = wrapper.isOnErrorSupported(flutterOptions);
+
     // first step is to install the native integration and set default values,
     // so we are able to capture future errors.
     final defaultIntegrations = _createDefaultIntegrations(
       packageLoader,
       channel,
       flutterOptions,
+      isOnErrorSupported,
     );
     for (final defaultIntegration in defaultIntegrations) {
       flutterOptions.addIntegration(defaultIntegration);
@@ -65,6 +69,8 @@ mixin SentryFlutter {
       appRunner: appRunner,
       // ignore: invalid_use_of_internal_member
       options: flutterOptions,
+      // ignore: invalid_use_of_internal_member
+      callAppRunnerInRunZonedGuarded: !isOnErrorSupported,
     );
   }
 
@@ -96,6 +102,7 @@ mixin SentryFlutter {
     PackageLoader packageLoader,
     MethodChannel channel,
     SentryFlutterOptions options,
+    bool isOnErrorSupported,
   ) {
     final integrations = <Integration>[];
     final platformChecker = options.platformChecker;
@@ -104,6 +111,11 @@ mixin SentryFlutter {
     // Will call WidgetsFlutterBinding.ensureInitialized() before all other integrations.
     integrations.add(WidgetsFlutterBindingIntegration());
 
+    // Use PlatformDispatcher.onError instead of zones.
+    if (isOnErrorSupported) {
+      integrations.add(OnErrorIntegration());
+    }
+
     // Will catch any errors that may occur in the Flutter framework itself.
     integrations.add(FlutterErrorIntegration());
 

flutter/test/mocks.mocks.dart

@@ -1,4 +1,4 @@
-// Mocks generated by Mockito 5.3.1 from annotations
+// Mocks generated by Mockito 5.3.2 from annotations
 // in sentry_flutter/example/windows/flutter/ephemeral/.plugin_symlinks/sentry_flutter/example/linux/flutter/ephemeral/.plugin_symlinks/sentry_flutter/example/ios/.symlinks/plugins/sentry_flutter/test/mocks.dart.
 // Do not manually edit this file.