getsentry · denrase · Dec 12, 2022 · Nov 15, 2022 · Nov 15, 2022 · Nov 15, 2022
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,11 @@
 
 ## 7.0.0
 
+### Features
+
+- Feat: Introduce `Hint` data bag ([#1136](https://github.com/getsentry/sentry-dart/pull/1136))
+- Feat: Use `Hint` for screenshots ([#1165](https://github.com/getsentry/sentry-dart/pull/1165))
+
 ### Fixes
 
 - Fix: Remove `SentryOptions` related parameters from classes which also take `Hub` as a parameter (#816)

diff --git a/dart/lib/sentry.dart b/dart/lib/sentry.dart
@@ -30,3 +30,5 @@ export 'src/sentry_user_feedback.dart';
 export 'src/utils/tracing_utils.dart';
 // tracing
 export 'src/tracing.dart';
+export 'src/hint.dart';
+export 'src/type_check_hint.dart';
diff --git a/dart/lib/sentry_private.dart b/dart/lib/sentry_private.dart
diff --git a/dart/lib/src/event_processor.dart b/dart/lib/src/event_processor.dart
@@ -1,5 +1,6 @@
 import 'dart:async';
 
+import 'hint.dart';
 import 'protocol.dart';
 
 /// [EventProcessor]s are callbacks that run for every event. They can either
@@ -8,6 +9,6 @@ import 'protocol.dart';
 abstract class EventProcessor {
   FutureOr<SentryEvent?> apply(
     SentryEvent event, {
-    dynamic hint,
+    Hint? hint,
   });
 }
diff --git a/dart/lib/src/event_processor/enricher/io_enricher_event_processor.dart b/dart/lib/src/event_processor/enricher/io_enricher_event_processor.dart
@@ -1,8 +1,7 @@
 import 'dart:async';
 import 'dart:io';
 
-import '../../protocol.dart';
-import '../../sentry_options.dart';
+import '../../../sentry.dart';
 import 'enricher_event_processor.dart';
 
 EnricherEventProcessor enricherEventProcessor(SentryOptions options) {
@@ -20,7 +19,7 @@ class IoEnricherEventProcessor implements EnricherEventProcessor {
   final SentryOptions _options;
 
   @override
-  FutureOr<SentryEvent> apply(SentryEvent event, {dynamic hint}) {
+  FutureOr<SentryEvent> apply(SentryEvent event, {Hint? hint}) {
     // If there's a native integration available, it probably has better
     // information available than Flutter.
 

diff --git a/dart/lib/src/event_processor/enricher/web_enricher_event_processor.dart b/dart/lib/src/event_processor/enricher/web_enricher_event_processor.dart
@@ -1,8 +1,7 @@
 import 'dart:async';
 import 'dart:html' as html show window, Window;
 
-import '../../protocol.dart';
-import '../../sentry_options.dart';
+import '../../../sentry.dart';
 import 'enricher_event_processor.dart';
 
 EnricherEventProcessor enricherEventProcessor(SentryOptions options) {
@@ -23,7 +22,7 @@ class WebEnricherEventProcessor implements EnricherEventProcessor {
   final SentryOptions _options;
 
   @override
-  FutureOr<SentryEvent> apply(SentryEvent event, {dynamic hint}) {
+  FutureOr<SentryEvent> apply(SentryEvent event, {Hint? hint}) {
     // Web has no native integration, so no need to check for it
 
     final contexts = event.contexts.copyWith(

diff --git a/dart/lib/src/hint.dart b/dart/lib/src/hint.dart
@@ -0,0 +1,63 @@
+import 'sentry_attachment/sentry_attachment.dart';
+
+/// Hints are used in [BeforeSendCallback], [BeforeBreadcrumbCallback] and
+/// event processors.
+///
+/// Event and breadcrumb hints are objects containing various information used
+/// to put together an event or a breadcrumb. Typically hints hold the original
+/// exception so that additional data can be extracted or grouping can be
+/// affected.
+///
+/// Example:
+///
+/// ```dart
+/// options.beforeSend = (event, {hint}) {
+///     final syntheticException = hint?.get(TypeCheckHint.syntheticException);
+///     if (syntheticException is FlutterErrorDetails) {
+///       // Do something with hint data
+///     }
+///     return event;
+///   };
+/// }
+/// ```
+class Hint {
+  final Map<String, Object> _internalStorage = {};
+
+  SentryAttachment? screenshot;
+
+  Hint();
+
+  factory Hint.withMap(Map<String, Object> map) {
+    final hint = Hint();
+    hint.addAll(map);
+    return hint;
+  }
+
+  factory Hint.withScreenshot(SentryAttachment screenshot) {
+    final hint = Hint();
+    hint.screenshot = screenshot;
+    return hint;
+  }
+
+  // Objects
+
+  void addAll(Map<String, Object> keysAndValues) {
+    _internalStorage.addAll(keysAndValues);
+  }
+
+  void set(String key, Object value) {
+    _internalStorage[key] = value;
+  }
+
+  Object? get(String key) {
+    return _internalStorage[key];
+  }
+
+  void remove(String key) {
+    _internalStorage.remove(key);
+  }
+
+  void clear() {
+    _internalStorage.clear();
+  }
+}
diff --git a/dart/lib/src/http_client/failed_request_client.dart b/dart/lib/src/http_client/failed_request_client.dart
@@ -1,4 +1,6 @@
 import 'package:http/http.dart';
+import '../hint.dart';
+import '../type_check_hint.dart';
 import 'sentry_http_client_error.dart';
 import '../protocol.dart';
 import '../hub.dart';
@@ -176,15 +178,22 @@ class FailedRequestClient extends BaseClient {
       timestamp: _hub.options.clock(),
     );
 
+    final hint = Hint.withMap({TypeCheckHint.httpRequest: request});
+
     if (response != null) {
       event.contexts.response = SentryResponse(
         headers: _hub.options.sendDefaultPii ? response.headers : null,
         bodySize: response.contentLength,
         statusCode: response.statusCode,
       );
+      hint.set(TypeCheckHint.httpResponse, response);
     }
 
-    await _hub.captureEvent(event, stackTrace: stackTrace);
+    await _hub.captureEvent(
+      event,
+      stackTrace: stackTrace,
+      hint: hint,
+    );
   }
 
   // Types of Request can be found here:

diff --git a/dart/lib/src/hub.dart b/dart/lib/src/hub.dart
@@ -69,7 +69,7 @@ class Hub {
   Future<SentryId> captureEvent(
     SentryEvent event, {
     dynamic stackTrace,
-    dynamic hint,
+    Hint? hint,
     ScopeCallback? withScope,
   }) async {
     var sentryId = SentryId.empty();
@@ -112,7 +112,7 @@ class Hub {
   Future<SentryId> captureException(
     dynamic throwable, {
     dynamic stackTrace,
-    dynamic hint,
+    Hint? hint,
     ScopeCallback? withScope,
   }) async {
     var sentryId = SentryId.empty();
@@ -168,7 +168,7 @@ class Hub {
     SentryLevel? level,
     String? template,
     List<dynamic>? params,
-    dynamic hint,
+    Hint? hint,
     ScopeCallback? withScope,
   }) async {
     var sentryId = SentryId.empty();
@@ -258,7 +258,7 @@ class Hub {
   }
 
   /// Adds a breacrumb to the current Scope
-  Future<void> addBreadcrumb(Breadcrumb crumb, {dynamic hint}) async {
+  Future<void> addBreadcrumb(Breadcrumb crumb, {Hint? hint}) async {
     if (!_isEnabled) {
       _options.logger(
         SentryLevel.warning,

diff --git a/dart/lib/src/hub_adapter.dart b/dart/lib/src/hub_adapter.dart
@@ -1,6 +1,7 @@
 import 'dart:async';
 
 import 'package:meta/meta.dart';
+import 'hint.dart';
 
 import 'hub.dart';
 import 'protocol.dart';
@@ -25,7 +26,7 @@ class HubAdapter implements Hub {
   }
 
   @override
-  Future<void> addBreadcrumb(Breadcrumb crumb, {dynamic hint}) async =>
+  Future<void> addBreadcrumb(Breadcrumb crumb, {Hint? hint}) async =>
       await Sentry.addBreadcrumb(crumb, hint: hint);
 
   @override
@@ -35,7 +36,7 @@ class HubAdapter implements Hub {
   Future<SentryId> captureEvent(
     SentryEvent event, {
     dynamic stackTrace,
-    dynamic hint,
+    Hint? hint,
     ScopeCallback? withScope,
   }) =>
       Sentry.captureEvent(
@@ -49,7 +50,7 @@ class HubAdapter implements Hub {
   Future<SentryId> captureException(
     dynamic throwable, {
     dynamic stackTrace,
-    dynamic hint,
+    Hint? hint,
     ScopeCallback? withScope,
   }) =>
       Sentry.captureException(
@@ -65,7 +66,7 @@ class HubAdapter implements Hub {
     SentryLevel? level,
     String? template,
     List? params,
-    dynamic hint,
+    Hint? hint,
     ScopeCallback? withScope,
   }) =>
       Sentry.captureMessage(

diff --git a/dart/lib/src/noop_hub.dart b/dart/lib/src/noop_hub.dart
@@ -2,6 +2,7 @@ import 'dart:async';
 
 import 'package:meta/meta.dart';
 
+import 'hint.dart';
 import 'hub.dart';
 import 'protocol.dart';
 import 'sentry_client.dart';
@@ -31,7 +32,7 @@ class NoOpHub implements Hub {
   Future<SentryId> captureEvent(
     SentryEvent event, {
     dynamic stackTrace,
-    dynamic hint,
+    Hint? hint,
     ScopeCallback? withScope,
   }) async =>
       SentryId.empty();
@@ -40,7 +41,7 @@ class NoOpHub implements Hub {
   Future<SentryId> captureException(
     dynamic throwable, {
     dynamic stackTrace,
-    dynamic hint,
+    Hint? hint,
     ScopeCallback? withScope,
   }) async =>
       SentryId.empty();
@@ -51,7 +52,7 @@ class NoOpHub implements Hub {
     SentryLevel? level,
     String? template,
     List? params,
-    dynamic hint,
+    Hint? hint,
     ScopeCallback? withScope,
   }) async =>
       SentryId.empty();
@@ -72,7 +73,7 @@ class NoOpHub implements Hub {
   SentryId get lastEventId => SentryId.empty();
 
   @override
-  Future<void> addBreadcrumb(Breadcrumb crumb, {dynamic hint}) async {}
+  Future<void> addBreadcrumb(Breadcrumb crumb, {Hint? hint}) async {}
 
   @override
   Future<SentryId> captureTransaction(

diff --git a/dart/lib/src/noop_sentry_client.dart b/dart/lib/src/noop_sentry_client.dart
@@ -1,5 +1,6 @@
 import 'dart:async';
 
+import 'hint.dart';
 import 'protocol.dart';
 import 'scope.dart';
 import 'sentry_client.dart';
@@ -21,7 +22,7 @@ class NoOpSentryClient implements SentryClient {
     SentryEvent event, {
     dynamic stackTrace,
     Scope? scope,
-    dynamic hint,
+    Hint? hint,
   }) async =>
       SentryId.empty();
 
@@ -30,7 +31,7 @@ class NoOpSentryClient implements SentryClient {
     dynamic exception, {
     dynamic stackTrace,
     Scope? scope,
-    dynamic hint,
+    Hint? hint,
   }) async =>
       SentryId.empty();
 
@@ -41,7 +42,7 @@ class NoOpSentryClient implements SentryClient {
     String? template,
     List<dynamic>? params,
     Scope? scope,
-    dynamic hint,
+    Hint? hint,
   }) async =>
       SentryId.empty();
 

diff --git a/dart/lib/src/run_zoned_guarded_integration.dart b/dart/lib/src/run_zoned_guarded_integration.dart
@@ -82,10 +82,12 @@ class RunZonedGuardedIntegration extends Integration {
           _isPrinting = true;
 
           try {
-            hub.addBreadcrumb(Breadcrumb.console(
-              message: line,
-              level: SentryLevel.debug,
-            ));
+            hub.addBreadcrumb(
+              Breadcrumb.console(
+                message: line,
+                level: SentryLevel.debug,
+              ),
+            );
 
             parent.print(zone, line);
           } finally {

diff --git a/dart/lib/src/scope.dart b/dart/lib/src/scope.dart
@@ -2,6 +2,7 @@ import 'dart:async';
 import 'dart:collection';
 
 import 'event_processor.dart';
+import 'hint.dart';
 import 'protocol.dart';
 import 'scope_observer.dart';
 import 'sentry_attachment/sentry_attachment.dart';
@@ -155,7 +156,7 @@ class Scope {
 
   Scope(this._options);
 
-  bool _addBreadCrumbSync(Breadcrumb breadcrumb, {dynamic hint}) {
+  bool _addBreadCrumbSync(Breadcrumb breadcrumb, {Hint? hint}) {
     // bail out if maxBreadcrumbs is zero
     if (_options.maxBreadcrumbs == 0) {
       return false;
@@ -197,7 +198,7 @@ class Scope {
   }
 
   /// Adds a breadcrumb to the breadcrumbs queue
-  Future<void> addBreadcrumb(Breadcrumb breadcrumb, {dynamic hint}) async {
+  Future<void> addBreadcrumb(Breadcrumb breadcrumb, {Hint? hint}) async {
     if (_addBreadCrumbSync(breadcrumb, hint: hint)) {
       await _callScopeObservers((scopeObserver) async =>
           await scopeObserver.addBreadcrumb(breadcrumb));
@@ -284,7 +285,7 @@ class Scope {
 
   Future<SentryEvent?> applyToEvent(
     SentryEvent event, {
-    dynamic hint,
+    Hint? hint,
   }) async {
     event = event.copyWith(
       transaction: event.transaction ?? transaction,