enh: use lifecycle hook for before send event

dart/lib/sentry.dart

@@ -21,7 +21,6 @@ export 'src/integration.dart';
 export 'src/noop_isolate_error_integration.dart'
     if (dart.library.io) 'src/isolate_error_integration.dart';
 // ignore: invalid_export_of_internal_element
-export 'src/observers.dart';
 export 'src/performance_collector.dart';
 export 'src/protocol.dart';
 export 'src/protocol/sentry_feature_flag.dart';
@@ -38,7 +37,7 @@ export 'src/sentry_baggage.dart';
 // ignore: invalid_export_of_internal_element
 export 'src/sentry_client.dart';
 // ignore: invalid_export_of_internal_element
-export 'src/lifecycle/on_before_capture_log.dart';
+export 'src/sdk_lifecycle_hooks.dart';
 export 'src/sentry_envelope.dart';
 export 'src/sentry_envelope_item.dart';
 export 'src/sentry_options.dart';

dart/lib/src/hub.dart

@@ -630,13 +630,23 @@
 
   SentryProfilerFactory? _profilerFactory;
 
+  @internal
+  Map<Type, List<Function>> get lifecycleCallbacks =>
+      _peek().client.lifecycleCallbacks;
+
   @internal
   void registerCallback<T extends SdkLifecycleEvent>(
       SdkLifecycleCallback<T> callback) {
     final item = _peek();
     item.client.registerCallback<T>(callback);
   }
 
+  @internal
+  void removeCallback<T extends SdkLifecycleEvent>(
+      SdkLifecycleCallback<T> callback) {
+    _peek().client.removeCallback<T>(callback);
+  }
+
   SentryEvent _assignTraceContext(SentryEvent event) {
     // assign trace context
     if (event.throwable != null && event.contexts.trace == null) {

dart/lib/src/hub_adapter.dart

@@ -200,9 +200,19 @@
   @override
   FutureOr<void> captureLog(SentryLog log) => Sentry.currentHub.captureLog(log);
 
+  @override
+  Map<Type, List<Function>> get lifecycleCallbacks =>
+      Sentry.currentHub.lifecycleCallbacks;
+
   @override
   void registerCallback<T extends SdkLifecycleEvent>(
       SdkLifecycleCallback<T> callback) {
     Sentry.currentHub.registerCallback(callback);
   }
+
+  @override
+  void removeCallback<T extends SdkLifecycleEvent>(
+      SdkLifecycleCallback<T> callback) {
+    Sentry.currentHub.removeCallback(callback);
+  }
 }

dart/lib/src/logs_enricher_integration.dart

@@ -1,12 +1,12 @@
 import 'dart:async';
 import 'package:meta/meta.dart';
 
+import 'sdk_lifecycle_hooks.dart';
 import 'utils/os_utils.dart';
 import 'integration.dart';
 import 'hub.dart';
 import 'protocol/sentry_log_attribute.dart';
 import 'sentry_options.dart';
-import 'lifecycle/on_before_capture_log.dart';
 
 @internal
 class LogsEnricherIntegration extends Integration<SentryOptions> {

dart/lib/src/noop_hub.dart

@@ -145,8 +145,14 @@
   @override
   Scope get scope => Scope(_options);
 
-  @internal
+  @override
+  Map<Type, List<Function>> get lifecycleCallbacks => {};
+
   @override
   void registerCallback<T extends SdkLifecycleEvent>(
       SdkLifecycleCallback<T> callback) {}
+
+  @override
+  void removeCallback<T extends SdkLifecycleEvent>(
+      SdkLifecycleCallback<T> callback) {}
 }

dart/lib/src/noop_sentry_client.dart

@@ -70,7 +70,14 @@ class NoOpSentryClient implements SentryClient {
   @override
   FutureOr<void> captureLog(SentryLog log, {Scope? scope}) async {}
 
+  @override
+  Map<Type, List<Function>> get lifecycleCallbacks => {};
+
   @override
   void registerCallback<T extends SdkLifecycleEvent>(
       SdkLifecycleCallback<T> callback) {}
+
+  @override
+  void removeCallback<T extends SdkLifecycleEvent>(
+      SdkLifecycleCallback<T> callback) {}
 }

dart/lib/src/sdk_lifecycle_hooks.dart

@@ -0,0 +1,17 @@
+import 'package:meta/meta.dart';
+
+import '../sentry.dart';
+
+@internal
+class OnBeforeCaptureLog extends SdkLifecycleEvent {
+  OnBeforeCaptureLog(this.log);
+
+  final SentryLog log;
+}
+
+@internal
+class OnBeforeSendEvent extends SdkLifecycleEvent {
+  OnBeforeSendEvent(this.event);
+
+  final SentryEvent event;
+}

dart/lib/src/sentry_client.dart

@@ -7,6 +7,7 @@
 import 'client_reports/discard_reason.dart';
 import 'event_processor/run_event_processors.dart';
 import 'hint.dart';
+import 'sdk_lifecycle_hooks.dart';
 import 'protocol.dart';
 import 'protocol/sentry_feedback.dart';
 import 'scope.dart';
@@ -29,7 +30,7 @@
 import 'utils/stacktrace_utils.dart';
 import 'sentry_log_batcher.dart';
 import 'version.dart';
-import 'lifecycle/on_before_capture_log.dart';
+import 'sdk_lifecycle_hooks.dart';
 
 /// Default value for [SentryUser.ipAddress]. It gets set when an event does not have
 /// a user and IP address. Only applies if [SentryOptions.sendDefaultPii] is set
@@ -58,6 +59,8 @@
 
   SentryStackTraceFactory get _stackTraceFactory => _options.stackTraceFactory;
 
+  @internal
+  Map<Type, List<Function>> get lifecycleCallbacks => _lifecycleCallbacks;
   final Map<Type, List<Function>> _lifecycleCallbacks = {};
 
   /// Instantiates a client using [SentryOptions]
@@ -174,8 +177,8 @@
       return _emptySentryId;
     }
 
-    // Event is fully processed and ready to be sent, emit beforeSendEvent observer
-    await _emitBeforeSendEventObserver(preparedEvent, hint);
+    // Event is fully processed and ready to be sent
+    await _dispatchCallback(OnBeforeSendEvent(event));
 
     var attachments = List<SentryAttachment>.from(scope?.attachments ?? []);
     attachments.addAll(hint.attachments);
@@ -581,7 +584,7 @@
     }
 
     if (processedLog != null) {
-      await _dispatchCallbacks(OnBeforeCaptureLog(processedLog));
+      await _dispatchCallback(OnBeforeCaptureLog(processedLog));
       _options.logBatcher.addLog(processedLog);
     } else {
       _options.recorder.recordLostEvent(
@@ -687,37 +690,21 @@
     }
   }
 
-  FutureOr<void> _emitBeforeSendEventObserver(
-      SentryEvent event, Hint hint) async {
-    for (final observer in _options.beforeSendEventObservers) {
-      try {
-        final result = observer.onBeforeSendEvent(event, hint);
-        if (result is Future) {
-          await result;
-        }
-      } catch (exception, stackTrace) {
-        _options.log(
-          SentryLevel.error,
-          'Error while running beforeSendEvent observer',
-          exception: exception,
-          stackTrace: stackTrace,
-        );
-        if (_options.automatedTestMode) {
-          rethrow;
-        }
-      }
-    }
-  }
-
   @internal
   void registerCallback<T extends SdkLifecycleEvent>(
       SdkLifecycleCallback<T> callback) {
     _lifecycleCallbacks[T] ??= [];
     _lifecycleCallbacks[T]?.add(callback);
   }
 
-  FutureOr<void> _dispatchCallbacks<T extends SdkLifecycleEvent>(
-      T event) async {
+  @internal
+  void removeCallback<T extends SdkLifecycleEvent>(
+      SdkLifecycleCallback<T> callback) {
+    final callbacks = _lifecycleCallbacks[T];
+    callbacks?.remove(callback);
+  }
+
+  FutureOr<void> _dispatchCallback<T extends SdkLifecycleEvent>(T event) async {
     final callbacks = _lifecycleCallbacks[event.runtimeType] ?? [];
     for (final cb in callbacks) {
       try {

dart/lib/src/sentry_options.dart

@@ -511,26 +511,6 @@ class SentryOptions {
   /// iOS only supports http proxies, while macOS also supports socks.
   SentryProxy? proxy;
 
-  final List<BeforeSendEventObserver> _beforeSendEventObserver = [];
-
-  @internal
-  List<BeforeSendEventObserver> get beforeSendEventObservers =>
-      List.unmodifiable(_beforeSendEventObserver);
-
-  /// Adds an observer which is called right before an event is sent.
-  /// This should not be used to mutate the event.
-  ///
-  /// Note: this is not triggered for transactions/spans with startTransaction or startChild.
-  @internal
-  void addBeforeSendEventObserver(BeforeSendEventObserver observer) {
-    _beforeSendEventObserver.add(observer);
-  }
-
-  @internal
-  void removeBeforeSendEventObserver(BeforeSendEventObserver observer) {
-    _beforeSendEventObserver.remove(observer);
-  }
-
   /// Whether to group exceptions hierarchically.
   ///
   /// If true, exceptions will be grouped hierarchically if possible.

dart/test/sentry_client_test.dart

@@ -2640,49 +2640,6 @@ void main() {
       await client.captureEvent(fakeEvent, stackTrace: StackTrace.current);
     });
   });
-
-  group('beforeSendEvent observer', () {
-    late Fixture fixture;
-
-    setUp(() {
-      fixture = Fixture();
-    });
-
-    test('is called with correct event and hint', () async {
-      final observer = _TestEventObserver();
-      fixture.options.addBeforeSendEventObserver(observer);
-
-      final client = fixture.getSut();
-      final hint = Hint();
-      final event = SentryEvent(type: 'some random type');
-
-      await client.captureEvent(event, hint: hint);
-
-      expect(observer.inspectedEvent?.type, 'some random type');
-      expect(observer.inspectedHint, same(hint));
-    });
-
-    test('is called after all other processors', () async {
-      final processingOrder = <String>[];
-      final beforeSend = (SentryEvent event, Hint hint) {
-        processingOrder.add('beforeSend');
-        return event;
-      };
-
-      fixture.options
-          .addBeforeSendEventObserver(_TestOrderObserver(processingOrder));
-
-      final client = fixture.getSut(
-          beforeSend: beforeSend,
-          eventProcessor: _TestEventProcessor(processingOrder));
-      final event = SentryEvent();
-
-      await client.captureEvent(event);
-
-      expect(
-          processingOrder, ['eventProcessor', 'beforeSend', 'beforeSendEvent']);
-    });
-  });
 }
 
 Future<SentryEvent> eventFromEnvelope(SentryEnvelope envelope) async {
@@ -2905,37 +2862,3 @@ class ExceptionWithStackTraceExtractor
     return error.stackTrace;
   }
 }
-
-class _TestEventObserver implements BeforeSendEventObserver {
-  SentryEvent? inspectedEvent;
-  Hint? inspectedHint;
-
-  @override
-  FutureOr<void> onBeforeSendEvent(SentryEvent event, Hint hint) {
-    inspectedEvent = event;
-    inspectedHint = hint;
-  }
-}
-
-class _TestEventProcessor extends EventProcessor {
-  _TestEventProcessor(this._processingOrder);
-
-  final List<String> _processingOrder;
-
-  @override
-  FutureOr<SentryEvent?> apply(SentryEvent event, Hint hint) {
-    _processingOrder.add('eventProcessor');
-    return event;
-  }
-}
-
-class _TestOrderObserver extends BeforeSendEventObserver {
-  final List<String> _processingOrder;
-
-  _TestOrderObserver(this._processingOrder);
-
-  @override
-  FutureOr<void> onBeforeSendEvent(SentryEvent event, Hint hint) {
-    _processingOrder.add('beforeSendEvent');
-  }
-}

flutter/example/pubspec.yaml

@@ -38,7 +38,7 @@ dependencies:
 
 dev_dependencies:
   flutter_lints: ^2.0.0
-  sentry_dart_plugin: ^3.0.0
+  sentry_dart_plugin: ^2.2.0
   integration_test:
     sdk: flutter
   flutter_test: