Make hint non-nullable in BeforeSendCallback, BeforeBreadcrumbCall and EventProcessor (#1574)

Author: denrase

CHANGELOG.md

@@ -10,7 +10,9 @@
   - Older self-hosted sentry instances will drop transactions containing unfinished spans.
     - This change was introduced in [relay/#1690](https://github.com/getsentry/relay/pull/1690) and released with [22.12.0](https://github.com/getsentry/relay/releases/tag/22.12.0)
 - Do not leak extensions of external classes ([#1576](https://github.com/getsentry/sentry-dart/pull/1576))
-
+- Make `hint` non-nullable in `BeforeSendCallback`, `BeforeBreadcrumbCall` and `EventProcessor` ([#1574](https://github.com/getsentry/sentry-dart/pull/1574))
+  - This will affect your callbacks, making this a breaking change.
+  
 ## Unreleased
 
 ### Fixes

dart/example/bin/example.dart

@@ -104,7 +104,7 @@ Future<void> decode() async {
 
 class TagEventProcessor implements EventProcessor {
   @override
-  SentryEvent? apply(SentryEvent event, {hint}) {
+  SentryEvent? apply(SentryEvent event, hint) {
     return event..tags?.addAll({'page-locale': 'en-us'});
   }
 }

dart/example_web/web/main.dart

@@ -129,7 +129,7 @@ Future<void> parseData() async {
 
 class TagEventProcessor implements EventProcessor {
   @override
-  SentryEvent? apply(SentryEvent event, {hint}) {
+  SentryEvent? apply(SentryEvent event, Hint hint) {
     return event..tags?.addAll({'page-locale': 'en-us'});
   }
 }

dart/lib/src/event_processor.dart

@@ -8,7 +8,7 @@ import 'protocol.dart';
 /// null in case the event will be dropped and not sent.
 abstract class EventProcessor {
   FutureOr<SentryEvent?> apply(
-    SentryEvent event, {
-    Hint? hint,
-  });
+    SentryEvent event,
+    Hint hint,
+  );
 }

dart/lib/src/event_processor/deduplication_event_processor.dart

@@ -26,7 +26,7 @@ class DeduplicationEventProcessor implements EventProcessor {
   final SentryOptions _options;
 
   @override
-  SentryEvent? apply(SentryEvent event, {Hint? hint}) {
+  SentryEvent? apply(SentryEvent event, Hint hint) {
     if (event is SentryTransaction) {
       return event;
     }

dart/lib/src/event_processor/enricher/io_enricher_event_processor.dart

@@ -18,7 +18,7 @@ class IoEnricherEventProcessor implements EnricherEventProcessor {
   final SentryOptions _options;
 
   @override
-  SentryEvent? apply(SentryEvent event, {Hint? hint}) {
+  SentryEvent? apply(SentryEvent event, Hint hint) {
     // If there's a native integration available, it probably has better
     // information available than Flutter.
 

dart/lib/src/event_processor/enricher/web_enricher_event_processor.dart

@@ -21,7 +21,7 @@ class WebEnricherEventProcessor implements EnricherEventProcessor {
   final SentryOptions _options;
 
   @override
-  SentryEvent? apply(SentryEvent event, {Hint? hint}) {
+  SentryEvent? apply(SentryEvent event, Hint hint) {
     // Web has no native integration, so no need to check for it
 
     final contexts = event.contexts.copyWith(

dart/lib/src/event_processor/exception/io_exception_event_processor.dart

@@ -14,7 +14,7 @@ class IoExceptionEventProcessor implements ExceptionEventProcessor {
   final SentryOptions _options;
 
   @override
-  SentryEvent? apply(SentryEvent event, {Hint? hint}) {
+  SentryEvent? apply(SentryEvent event, Hint hint) {
     final throwable = event.throwable;
     if (throwable is HttpException) {
       return _applyHttpException(throwable, event);

dart/lib/src/event_processor/exception/web_exception_event_processor.dart

@@ -8,5 +8,5 @@ ExceptionEventProcessor exceptionEventProcessor(SentryOptions _) =>
 
 class WebExcptionEventProcessor implements ExceptionEventProcessor {
   @override
-  SentryEvent apply(SentryEvent event, {Hint? hint}) => event;
+  SentryEvent apply(SentryEvent event, Hint hint) => event;
 }

dart/lib/src/hint.dart

@@ -11,8 +11,8 @@ import 'sentry_attachment/sentry_attachment.dart';
 /// Example:
 ///
 /// ```dart
-/// options.beforeSend = (event, {hint}) {
-///     final syntheticException = hint?.get(TypeCheckHint.syntheticException);
+/// options.beforeSend = (event, hint) {
+///     final syntheticException = hint.get(TypeCheckHint.syntheticException);
 ///     if (syntheticException is FlutterErrorDetails) {
 ///       // Do something with hint data
 ///     }
@@ -28,14 +28,14 @@ import 'sentry_attachment/sentry_attachment.dart';
 /// ```dart
 /// import 'dart:convert';
 ///
-/// options.beforeSend = (event, {hint}) {
+/// options.beforeSend = (event, hint) {
 ///   final text = 'This event should not be sent happen in prod. Investigate.';
 ///   final textAttachment = SentryAttachment.fromIntList(
 ///     utf8.encode(text),
 ///     'event_info.txt',
 ///     contentType: 'text/plain',
 ///   );
-///   hint?.attachments.add(textAttachment);
+///   hint.attachments.add(textAttachment);
 ///   return event;
 /// };
 /// ```