update callback signature, always pass hint

denrase · denrase · commit 2dbeef5f20f5 · 2026-03-27T14:21:05.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,10 @@
 
 - Add Hint support to `beforeSendLog` and pass LogRecord from sentry_logging ([#3549](https://github.com/getsentry/sentry-dart/pull/3549))
 
+### Breaking Changes
+
+- `BeforeSendLogCallback` now takes `Hint` as a required positional parameter (matching `BeforeSendCallback` and `BeforeSendTransactionCallback`) ([#3549](https://github.com/getsentry/sentry-dart/pull/3549))
+
 ## 9.16.0
 
 ### Dependencies
diff --git a/packages/dart/lib/src/sentry_options.dart b/packages/dart/lib/src/sentry_options.dart
@@ -710,8 +710,10 @@ typedef BeforeBreadcrumbCallback = Breadcrumb? Function(
 
 /// This function is called right before a log is about to be sent.
 /// Can return a modified log or null to drop the log.
-typedef BeforeSendLogCallback = FutureOr<SentryLog?> Function(SentryLog log,
-    {Hint? hint});
+typedef BeforeSendLogCallback = FutureOr<SentryLog?> Function(
+  SentryLog log,
+  Hint hint,
+);
 
 /// This function is called right before a metric is about to be emitted.
 /// Can return true to emit the metric, or false to drop it.
diff --git a/packages/dart/lib/src/telemetry/log/default_logger.dart b/packages/dart/lib/src/telemetry/log/default_logger.dart
@@ -126,13 +126,15 @@ final class _DefaultSentryLoggerFormatter implements SentryLoggerFormatter {
     String templateBody,
     List<dynamic> arguments, {
     Map<String, SentryAttribute>? attributes,
+    Hint? hint,
   }) {
     return _format(
       templateBody,
       arguments,
       attributes,
       (formattedBody, allAttributes) {
-        return _logger.trace(formattedBody, attributes: allAttributes);
+        return _logger.trace(formattedBody,
+            attributes: allAttributes, hint: hint);
       },
     );
   }
@@ -142,13 +144,15 @@ final class _DefaultSentryLoggerFormatter implements SentryLoggerFormatter {
     String templateBody,
     List<dynamic> arguments, {
     Map<String, SentryAttribute>? attributes,
+    Hint? hint,
   }) {
     return _format(
       templateBody,
       arguments,
       attributes,
       (formattedBody, allAttributes) {
-        return _logger.debug(formattedBody, attributes: allAttributes);
+        return _logger.debug(formattedBody,
+            attributes: allAttributes, hint: hint);
       },
     );
   }
@@ -158,13 +162,15 @@ final class _DefaultSentryLoggerFormatter implements SentryLoggerFormatter {
     String templateBody,
     List<dynamic> arguments, {
     Map<String, SentryAttribute>? attributes,
+    Hint? hint,
   }) {
     return _format(
       templateBody,
       arguments,
       attributes,
       (formattedBody, allAttributes) {
-        return _logger.info(formattedBody, attributes: allAttributes);
+        return _logger.info(formattedBody,
+            attributes: allAttributes, hint: hint);
       },
     );
   }
@@ -174,13 +180,15 @@ final class _DefaultSentryLoggerFormatter implements SentryLoggerFormatter {
     String templateBody,
     List<dynamic> arguments, {
     Map<String, SentryAttribute>? attributes,
+    Hint? hint,
   }) {
     return _format(
       templateBody,
       arguments,
       attributes,
       (formattedBody, allAttributes) {
-        return _logger.warn(formattedBody, attributes: allAttributes);
+        return _logger.warn(formattedBody,
+            attributes: allAttributes, hint: hint);
       },
     );
   }
@@ -190,13 +198,15 @@ final class _DefaultSentryLoggerFormatter implements SentryLoggerFormatter {
     String templateBody,
     List<dynamic> arguments, {
     Map<String, SentryAttribute>? attributes,
+    Hint? hint,
   }) {
     return _format(
       templateBody,
       arguments,
       attributes,
       (formattedBody, allAttributes) {
-        return _logger.error(formattedBody, attributes: allAttributes);
+        return _logger.error(formattedBody,
+            attributes: allAttributes, hint: hint);
       },
     );
   }
@@ -206,13 +216,15 @@ final class _DefaultSentryLoggerFormatter implements SentryLoggerFormatter {
     String templateBody,
     List<dynamic> arguments, {
     Map<String, SentryAttribute>? attributes,
+    Hint? hint,
   }) {
     return _format(
       templateBody,
       arguments,
       attributes,
       (formattedBody, allAttributes) {
-        return _logger.fatal(formattedBody, attributes: allAttributes);
+        return _logger.fatal(formattedBody,
+            attributes: allAttributes, hint: hint);
       },
     );
   }
diff --git a/packages/dart/lib/src/telemetry/log/log_capture_pipeline.dart b/packages/dart/lib/src/telemetry/log/log_capture_pipeline.dart
@@ -40,7 +40,7 @@ class LogCapturePipeline {
       SentryLog? processedLog = log;
       if (beforeSendLog != null) {
         try {
-          final callbackResult = beforeSendLog(log, hint: hint);
+          final callbackResult = beforeSendLog(log, hint ?? Hint());
 
           if (callbackResult is Future<SentryLog?>) {
             processedLog = await callbackResult;
diff --git a/packages/dart/lib/src/telemetry/log/logger.dart b/packages/dart/lib/src/telemetry/log/logger.dart
@@ -63,40 +63,46 @@ abstract interface class SentryLoggerFormatter {
     String templateBody,
     List<dynamic> arguments, {
     Map<String, SentryAttribute>? attributes,
+    Hint? hint,
   });
 
   /// Logs a formatted message at DEBUG level.
   FutureOr<void> debug(
     String templateBody,
     List<dynamic> arguments, {
     Map<String, SentryAttribute>? attributes,
+    Hint? hint,
   });
 
   /// Logs a formatted message at INFO level.
   FutureOr<void> info(
     String templateBody,
     List<dynamic> arguments, {
     Map<String, SentryAttribute>? attributes,
+    Hint? hint,
   });
 
   /// Logs a formatted message at WARN level.
   FutureOr<void> warn(
     String templateBody,
     List<dynamic> arguments, {
     Map<String, SentryAttribute>? attributes,
+    Hint? hint,
   });
 
   /// Logs a formatted message at ERROR level.
   FutureOr<void> error(
     String templateBody,
     List<dynamic> arguments, {
     Map<String, SentryAttribute>? attributes,
+    Hint? hint,
   });
 
   /// Logs a formatted message at FATAL level.
   FutureOr<void> fatal(
     String templateBody,
     List<dynamic> arguments, {
     Map<String, SentryAttribute>? attributes,
+    Hint? hint,
   });
 }
diff --git a/packages/dart/lib/src/telemetry/log/noop_logger.dart b/packages/dart/lib/src/telemetry/log/noop_logger.dart
@@ -63,40 +63,46 @@ final class _NoOpSentryLoggerFormatter implements SentryLoggerFormatter {
     String templateBody,
     List<dynamic> arguments, {
     Map<String, SentryAttribute>? attributes,
+    Hint? hint,
   }) {}
 
   @override
   FutureOr<void> debug(
     String templateBody,
     List<dynamic> arguments, {
     Map<String, SentryAttribute>? attributes,
+    Hint? hint,
   }) {}
 
   @override
   FutureOr<void> info(
     String templateBody,
     List<dynamic> arguments, {
     Map<String, SentryAttribute>? attributes,
+    Hint? hint,
   }) {}
 
   @override
   FutureOr<void> warn(
     String templateBody,
     List<dynamic> arguments, {
     Map<String, SentryAttribute>? attributes,
+    Hint? hint,
   }) {}
 
   @override
   FutureOr<void> error(
     String templateBody,
     List<dynamic> arguments, {
     Map<String, SentryAttribute>? attributes,
+    Hint? hint,
   }) {}
 
   @override
   FutureOr<void> fatal(
     String templateBody,
     List<dynamic> arguments, {
     Map<String, SentryAttribute>? attributes,
+    Hint? hint,
   }) {}
 }
diff --git a/packages/dart/test/telemetry/log/log_capture_pipeline_test.dart b/packages/dart/test/telemetry/log/log_capture_pipeline_test.dart
@@ -98,7 +98,7 @@ void main() {
               event.log.attributes.containsKey('scope-attr');
         });
 
-        fixture.options.beforeSendLog = (log, {Hint? hint}) {
+        fixture.options.beforeSendLog = (log, hint) {
           operations.add('beforeSendLog');
           return log;
         };
@@ -145,7 +145,7 @@ void main() {
 
     group('when beforeSendLog is configured', () {
       test('returning null drops the log', () async {
-        fixture.options.beforeSendLog = (_, {Hint? hint}) => null;
+        fixture.options.beforeSendLog = (_, hint) => null;
 
         final log = givenLog();
 
@@ -155,7 +155,7 @@ void main() {
       });
 
       test('returning null records lost event in client report', () async {
-        fixture.options.beforeSendLog = (_, {Hint? hint}) => null;
+        fixture.options.beforeSendLog = (_, hint) => null;
 
         final log = givenLog();
 
@@ -169,7 +169,7 @@ void main() {
       });
 
       test('can mutate the log', () async {
-        fixture.options.beforeSendLog = (log, {Hint? hint}) {
+        fixture.options.beforeSendLog = (log, hint) {
           log.body = 'modified-body';
           log.attributes['added-key'] = SentryAttribute.string('added');
           return log;
@@ -186,7 +186,7 @@ void main() {
       });
 
       test('async callback is awaited', () async {
-        fixture.options.beforeSendLog = (log, {Hint? hint}) async {
+        fixture.options.beforeSendLog = (log, hint) async {
           await Future.delayed(Duration(milliseconds: 10));
           log.body = 'async-modified';
           return log;
@@ -201,10 +201,41 @@ void main() {
         expect(captured.body, 'async-modified');
       });
 
+      test('forwards hint to beforeSendLog callback', () async {
+        Hint? receivedHint;
+        fixture.options.beforeSendLog = (log, hint) {
+          receivedHint = hint;
+          return log;
+        };
+
+        final log = givenLog();
+        final hint = Hint.withMap({'custom-key': 'custom-value'});
+
+        await fixture.pipeline
+            .captureLog(log, scope: fixture.scope, hint: hint);
+
+        expect(receivedHint, isNotNull);
+        expect(receivedHint!.get('custom-key'), 'custom-value');
+      });
+
+      test('provides empty Hint when no hint is passed', () async {
+        Hint? receivedHint;
+        fixture.options.beforeSendLog = (log, hint) {
+          receivedHint = hint;
+          return log;
+        };
+
+        final log = givenLog();
+
+        await fixture.pipeline.captureLog(log, scope: fixture.scope);
+
+        expect(receivedHint, isNotNull);
+      });
+
       test('exception in callback is caught and log is still captured',
           () async {
         fixture.options.automatedTestMode = false;
-        fixture.options.beforeSendLog = (log, {Hint? hint}) {
+        fixture.options.beforeSendLog = (log, hint) {
           throw Exception('test');
         };
 
diff --git a/packages/dart/test/telemetry/log/logger_setup_integration_test.dart b/packages/dart/test/telemetry/log/logger_setup_integration_test.dart
@@ -135,40 +135,46 @@ class _CustomSentryLoggerFormatter implements SentryLoggerFormatter {
     String templateBody,
     List<dynamic> arguments, {
     Map<String, SentryAttribute>? attributes,
+    Hint? hint,
   }) {}
 
   @override
   FutureOr<void> debug(
     String templateBody,
     List<dynamic> arguments, {
     Map<String, SentryAttribute>? attributes,
+    Hint? hint,
   }) {}
 
   @override
   FutureOr<void> info(
     String templateBody,
     List<dynamic> arguments, {
     Map<String, SentryAttribute>? attributes,
+    Hint? hint,
   }) {}
 
   @override
   FutureOr<void> warn(
     String templateBody,
     List<dynamic> arguments, {
     Map<String, SentryAttribute>? attributes,
+    Hint? hint,
   }) {}
 
   @override
   FutureOr<void> error(
     String templateBody,
     List<dynamic> arguments, {
     Map<String, SentryAttribute>? attributes,
+    Hint? hint,
   }) {}
 
   @override
   FutureOr<void> fatal(
     String templateBody,
     List<dynamic> arguments, {
     Map<String, SentryAttribute>? attributes,
+    Hint? hint,
   }) {}
 }
