Support custom Sentry.runZoneGuarded zone creation

CHANGELOG.md

@@ -49,6 +49,27 @@
   });
   ```
   - Replace deprecated `BeforeScreenshotCallback` with new `BeforeCaptureCallback`.
+- Support custom `Sentry.runZoneGuarded` zone creation ([#2088](https://github.com/getsentry/sentry-dart/pull/2088))
+  - Sentry will not create a custom zone anymore if it is started within a custom one.
+  - `Sentry.runZonedGuarded` creates a zone and also captures exceptions & breadcrumbs automatically.
+  ```dart
+  Sentry.runZonedGuarded(() {
+    WidgetsBinding.ensureInitialized();
+
+    // Errors before init will not be handled by Sentry
+
+    SentryFlutter.init(
+      (options) {
+      ...
+      },
+      appRunner: () => runApp(MyApp()),
+    );
+  } (error, stackTrace) {
+    // Automatically sends errors to Sentry, no need to do any
+    // captureException calls on your part.
+    // On top of that, you can do your own custom stuff in this callback.
+  });
+  ```
 
 ### Fixes
 

dart/lib/src/platform_checker.dart

@@ -1,14 +1,17 @@
+import 'dart:async';
 import 'platform/platform.dart';
 
-/// Helper to check in which enviroment the library is running.
-/// The envirment checks (release/debug/profile) are mutually exclusive.
+/// Helper to check in which environment the library is running.
+/// The environment checks (release/debug/profile) are mutually exclusive.
 class PlatformChecker {
   static const _jsUtil = 'dart.library.js_util';
 
   PlatformChecker({
     this.platform = instance,
     bool? isWeb,
-  }) : isWeb = isWeb ?? _isWebWithWasmSupport();
+    bool? isRootZone,
+  })  : isWeb = isWeb ?? _isWebWithWasmSupport(),
+        isRootZone = isRootZone ?? Zone.current == Zone.root;
 
   /// Check if running in release/production environment
   bool isReleaseMode() {
@@ -26,6 +29,7 @@ class PlatformChecker {
   }
 
   final bool isWeb;
+  final bool isRootZone;
 
   String get compileMode {
     return isReleaseMode()

dart/lib/src/run_zoned_guarded_integration.dart

@@ -1,12 +1,7 @@
 import 'dart:async';
 
-import 'package:meta/meta.dart';
-
-import 'hub.dart';
-import 'integration.dart';
-import 'protocol.dart';
-import 'sentry_options.dart';
-import 'throwable_mechanism.dart';
+import '../sentry.dart';
+import 'sentry_run_zoned_guarded.dart';
 
 /// Called inside of `runZonedGuarded`
 typedef RunZonedGuardedRunner = Future<void> Function();
@@ -26,107 +21,17 @@ class RunZonedGuardedIntegration extends Integration<SentryOptions> {
   final RunZonedGuardedRunner _runner;
   final RunZonedGuardedOnError? _onError;
 
-  /// Needed to check if we somehow caused a `print()` recursion
-  bool _isPrinting = false;
-
-  @visibleForTesting
-  Future<void> captureError(
-    Hub hub,
-    SentryOptions options,
-    Object exception,
-    StackTrace stackTrace,
-  ) async {
-    options.logger(
-      SentryLevel.error,
-      'Uncaught zone error',
-      logger: 'sentry.runZonedGuarded',
-      exception: exception,
-      stackTrace: stackTrace,
-    );
-
-    // runZonedGuarded doesn't crash the app, but is not handled by the user.
-    final mechanism = Mechanism(type: 'runZonedGuarded', handled: false);
-    final throwableMechanism = ThrowableMechanism(mechanism, exception);
-
-    final event = SentryEvent(
-      throwable: throwableMechanism,
-      level: options.markAutomaticallyCollectedErrorsAsFatal
-          ? SentryLevel.fatal
-          : SentryLevel.error,
-      timestamp: hub.options.clock(),
-    );
-
-    // marks the span status if none to `internal_error` in case there's an
-    // unhandled error
-    hub.configureScope(
-      (scope) => scope.span?.status ??= const SpanStatus.internalError(),
-    );
-
-    await hub.captureEvent(event, stackTrace: stackTrace);
-  }
-
   @override
   Future<void> call(Hub hub, SentryOptions options) {
     final completer = Completer<void>();
 
-    runZonedGuarded(
-      () async {
-        try {
-          await _runner();
-        } finally {
-          completer.complete();
-        }
-      },
-      (exception, stackTrace) async {
-        await captureError(hub, options, exception, stackTrace);
-        final onError = _onError;
-        if (onError != null) {
-          await onError(exception, stackTrace);
-        }
-      },
-      zoneSpecification: ZoneSpecification(
-        print: (self, parent, zone, line) {
-          if (!options.enablePrintBreadcrumbs || !hub.isEnabled) {
-            // early bail out, in order to better guard against the recursion
-            // as described below.
-            parent.print(zone, line);
-            return;
-          }
-
-          if (_isPrinting) {
-            // We somehow landed in a recursion.
-            // This happens for example if:
-            // - hub.addBreadcrumb() called print() itself
-            // - This happens for example if hub.isEnabled == false and
-            //   options.logger == dartLogger
-            //
-            // Anyway, in order to not cause a stack overflow due to recursion
-            // we drop any further print() call while adding a breadcrumb.
-            parent.print(
-              zone,
-              'Recursion during print() call. '
-              'Abort adding print() call as Breadcrumb.',
-            );
-            return;
-          }
-
-          _isPrinting = true;
-
-          try {
-            hub.addBreadcrumb(
-              Breadcrumb.console(
-                message: line,
-                level: SentryLevel.debug,
-              ),
-            );
-
-            parent.print(zone, line);
-          } finally {
-            _isPrinting = false;
-          }
-        },
-      ),
-    );
+    SentryRunZonedGuarded.sentryRunZonedGuarded(hub, () async {
+      try {
+        await _runner();
+      } finally {
+        completer.complete();
+      }
+    }, _onError);
 
     options.sdk.addIntegration('runZonedGuardedIntegration');
 

dart/lib/src/sentry.dart

@@ -21,6 +21,7 @@ import 'noop_isolate_error_integration.dart'
 import 'protocol.dart';
 import 'sentry_client.dart';
 import 'sentry_options.dart';
+import 'sentry_run_zoned_guarded.dart';
 import 'sentry_user_feedback.dart';
 import 'tracing.dart';
 import 'sentry_attachment/sentry_attachment.dart';
@@ -365,4 +366,47 @@ class Sentry {
 
   @internal
   static Hub get currentHub => _hub;
+
+  /// With [runZonedGuarded] you can create a custom zone, and still let Sentry
+  /// report errors and breadcrumbs automatically.
+  ///
+  /// It takes the same parameters as the dart function.
+  ///
+  /// Please be aware that any errors in the zone which occur before the [init]
+  /// call cannot be handled by Sentry.
+  ///
+  /// ```dart
+  /// Sentry.runZonedGuarded(() {
+  ///   WidgetsBinding.ensureInitialized();
+  ///
+  ///   // Errors before init will not be handled by Sentry
+  ///
+  ///   SentryFlutter.init(
+  ///     (options) {
+  ///     ...
+  ///     },
+  ///     appRunner: () => runApp(MyApp()),
+  ///   );
+  /// } (error, stackTrace) {
+  ///   // Automatically sends errors to Sentry, no need to do any
+  ///   // captureException calls on your part.
+  ///   // On top of that, you can do your own custom stuff in this callback.
+  /// });
+  /// ```
+  ///
+  /// This function also records calls to `print()` as Breadcrumbs.
+  /// This can be configured with [SentryOptions.enablePrintBreadcrumbs]
+  static runZonedGuarded<R>(
+    R Function() body,
+    void Function(Object error, StackTrace stack)? onError, {
+    Map<Object?, Object?>? zoneValues,
+    ZoneSpecification? zoneSpecification,
+  }) =>
+      SentryRunZonedGuarded.sentryRunZonedGuarded(
+        _hub,
+        body,
+        onError,
+        zoneValues: zoneValues,
+        zoneSpecification: zoneSpecification,
+      );
 }

dart/lib/src/sentry_run_zoned_guarded.dart

@@ -0,0 +1,118 @@
+import 'dart:async';
+
+import 'package:meta/meta.dart';
+
+import '../sentry.dart';
+
+@internal
+class SentryRunZonedGuarded {
+  /// Needed to check if we somehow caused a `print()` recursion
+  static var _isPrinting = false;
+
+  static R? sentryRunZonedGuarded<R>(
+    Hub hub,
+    R Function() body,
+    void Function(Object error, StackTrace stack)? onError, {
+    Map<Object?, Object?>? zoneValues,
+    ZoneSpecification? zoneSpecification,
+  }) {
+    final sentryOnError = (exception, stackTrace) async {
+      final options = hub.options;
+      await _captureError(hub, options, exception, stackTrace);
+
+      if (onError != null) {
+        onError(exception, stackTrace);
+      }
+    };
+
+    final userPrint = zoneSpecification?.print;
+
+    final sentryZoneSpecification = ZoneSpecification.from(
+      zoneSpecification ?? ZoneSpecification(),
+      print: (self, parent, zone, line) async {
+        final options = hub.options;
+
+        if (userPrint != null) {
+          userPrint(self, parent, zone, line);
+        }
+
+        if (!options.enablePrintBreadcrumbs || !hub.isEnabled) {
+          // early bail out, in order to better guard against the recursion
+          // as described below.
+          parent.print(zone, line);
+          return;
+        }
+        if (_isPrinting) {
+          // We somehow landed in a recursion.
+          // This happens for example if:
+          // - hub.addBreadcrumb() called print() itself
+          // - This happens for example if hub.isEnabled == false and
+          //   options.logger == dartLogger
+          //
+          // Anyway, in order to not cause a stack overflow due to recursion
+          // we drop any further print() call while adding a breadcrumb.
+          parent.print(
+            zone,
+            'Recursion during print() call.'
+            'Abort adding print() call as Breadcrumb.',
+          );
+          return;
+        }
+
+        try {
+          _isPrinting = true;
+          await hub.addBreadcrumb(
+            Breadcrumb.console(
+              message: line,
+              level: SentryLevel.debug,
+            ),
+          );
+          parent.print(zone, line);
+        } finally {
+          _isPrinting = false;
+        }
+      },
+    );
+    return runZonedGuarded(
+      body,
+      sentryOnError,
+      zoneValues: zoneValues,
+      zoneSpecification: sentryZoneSpecification,
+    );
+  }
+
+  static Future<void> _captureError(
+    Hub hub,
+    SentryOptions options,
+    Object exception,
+    StackTrace stackTrace,
+  ) async {
+    options.logger(
+      SentryLevel.error,
+      'Uncaught zone error',
+      logger: 'sentry.runZonedGuarded',
+      exception: exception,
+      stackTrace: stackTrace,
+    );
+
+    // runZonedGuarded doesn't crash the app, but is not handled by the user.
+    final mechanism = Mechanism(type: 'runZonedGuarded', handled: false);
+    final throwableMechanism = ThrowableMechanism(mechanism, exception);
+
+    final event = SentryEvent(
+      throwable: throwableMechanism,
+      level: options.markAutomaticallyCollectedErrorsAsFatal
+          ? SentryLevel.fatal
+          : SentryLevel.error,
+      timestamp: hub.options.clock(),
+    );
+
+    // marks the span status if none to `internal_error` in case there's an
+    // unhandled error
+    hub.configureScope(
+      (scope) => scope.span?.status ??= const SpanStatus.internalError(),
+    );
+
+    await hub.captureEvent(event, stackTrace: stackTrace);
+  }
+}