-
-
Notifications
You must be signed in to change notification settings - Fork 238
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Support custom
Sentry.runZoneGuarded zone creation (#2088)
- Loading branch information
Showing
11 changed files
with
397 additions
and
203 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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); | ||
| } | ||
| } |
Oops, something went wrong.