Fix beforeSend signature in code snippets for dart platforms (#9770)

MrLightful · buenaflor · web-flow · commit 903b00b23f92 · 2024-04-23T16:31:54.000Z
* Fix beforeSend signature in code snippets for dart platforms A breaking change introduced in v8.0.0: getsentry/sentry-dart#1478 * Update beforeBreadcrumb signature for dart platforms (pt1) Co-authored-by: Giancarlo Buenaflor <giancarlobuenaflor97@gmail.com> * Update beforeBreadcrumb signature for dart platforms (pt2) Co-authored-by: Giancarlo Buenaflor <giancarlobuenaflor97@gmail.com> --------- Co-authored-by: Giancarlo Buenaflor <giancarlobuenaflor97@gmail.com>
diff --git a/platform-includes/configuration/before-breadcrumb-hint/dart.mdx b/platform-includes/configuration/before-breadcrumb-hint/dart.mdx
@@ -1,7 +1,7 @@
 ```dart
 import 'package:sentry/sentry.dart';
 
-Breadcrumb beforeBreadcrumb(Breadcrumb crumb, {Hint? hint}) {
+Breadcrumb? beforeBreadcrumb(Breadcrumb? breadcrumb, Hint hint) {
   return hint is MyHint ? null : crumb;
 }
 
diff --git a/platform-includes/configuration/before-send-fingerprint/dart.mdx b/platform-includes/configuration/before-send-fingerprint/dart.mdx
@@ -1,7 +1,7 @@
 ```dart
 import 'package:sentry/sentry.dart';
 
-FutureOr<SentryEvent?> beforeSend(SentryEvent event, {Hint? hint}) async {
+FutureOr<SentryEvent?> beforeSend(SentryEvent event, Hint hint) async {
   if (event.throwable is DatabaseException) {
     event = event.copyWith(fingerprint: ['database-connection-error']);
   }
diff --git a/platform-includes/configuration/before-send-hint/dart.mdx b/platform-includes/configuration/before-send-hint/dart.mdx
@@ -1,7 +1,7 @@
 ```dart
 import 'package:sentry/sentry.dart';
 
-FutureOr<SentryEvent?> beforeSend(SentryEvent event, {Hint? hint}) async {
+FutureOr<SentryEvent?> beforeSend(SentryEvent event, Hint hint) async {
   return hint is MyHint ? null : event;
 }
 
diff --git a/platform-includes/configuration/before-send/dart.mdx b/platform-includes/configuration/before-send/dart.mdx
@@ -1,7 +1,7 @@
 ```dart
 import 'package:sentry/sentry.dart';
 
-FutureOr<SentryEvent?> beforeSend(SentryEvent event, {Hint? hint}) async {
+FutureOr<SentryEvent?> beforeSend(SentryEvent event, Hint hint) async {
   // Modify the event here:
   event = event.copyWith(serverName: null); // Don't send server names.
   return event;
diff --git a/platform-includes/enriching-events/breadcrumbs/before-breadcrumb/dart.mdx b/platform-includes/enriching-events/breadcrumbs/before-breadcrumb/dart.mdx
@@ -1,7 +1,7 @@
 ```dart
 import 'package:sentry/sentry.dart';
 
-Breadcrumb beforeBreadcrumb(Breadcrumb breadcrumb, {Hint? hint}) {
+Breadcrumb? beforeBreadcrumb(Breadcrumb? breadcrumb, Hint hint) {
   return 'a.spammy.Logger' == breadcrumb.category ? null : breadcrumb;
 }
 
diff --git a/platform-includes/set-fingerprint/basic/dart.mdx b/platform-includes/set-fingerprint/basic/dart.mdx
@@ -1,7 +1,7 @@
 ```dart
 import 'package:sentry/sentry.dart';
 
-FutureOr<SentryEvent?> beforeSend(SentryEvent event, {Hint? hint}) async {
+FutureOr<SentryEvent?> beforeSend(SentryEvent event, Hint hint) async {
   if (event.throwable is DatabaseException) {
     event = event.copyWith(fingerprint: ['database-connection-error']);
   }
diff --git a/platform-includes/set-fingerprint/database-connection/dart.mdx b/platform-includes/set-fingerprint/database-connection/dart.mdx
@@ -1,7 +1,7 @@
 ```dart
 import 'package:sentry/sentry.dart';
 
-FutureOr<SentryEvent?> beforeSend(SentryEvent event, {Hint? hint}) async {
+FutureOr<SentryEvent?> beforeSend(SentryEvent event, Hint hint) async {
   if (event.throwable is DatabaseException) {
     event = event.copyWith(fingerprint: ['database-connection-error']);
   }
diff --git a/platform-includes/set-fingerprint/rpc/dart.mdx b/platform-includes/set-fingerprint/rpc/dart.mdx
@@ -8,7 +8,7 @@ class MyRpcException implements Exception {
   MyRpcException(this.function, this.httpStatusCode);
 }
 
-FutureOr<SentryEvent?> beforeSend(SentryEvent event, {Hint? hint}) async {
+FutureOr<SentryEvent?> beforeSend(SentryEvent event, Hint hint) async {
   if (event.throwable is MyRpcException) {
     final exception = event.throwable as MyRpcException;
     event = event.copyWith(fingerprint: [

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	```dart
`2`	`2`	`import 'package:sentry/sentry.dart';`
`3`	`3`
`4`		`-Breadcrumb beforeBreadcrumb(Breadcrumb crumb, {Hint? hint}) {`
	`4`	`+Breadcrumb? beforeBreadcrumb(Breadcrumb? breadcrumb, Hint hint) {`
`5`	`5`	`return hint is MyHint ? null : crumb;`
`6`	`6`	`}`
`7`	`7`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ class MyRpcException implements Exception {`
`8`	`8`	`MyRpcException(this.function, this.httpStatusCode);`
`9`	`9`	`}`
`10`	`10`
`11`		`-FutureOr<SentryEvent?> beforeSend(SentryEvent event, {Hint? hint}) async {`
	`11`	`+FutureOr<SentryEvent?> beforeSend(SentryEvent event, Hint hint) async {`
`12`	`12`	`if (event.throwable is MyRpcException) {`
`13`	`13`	`final exception = event.throwable as MyRpcException;`
`14`	`14`	`event = event.copyWith(fingerprint: [`