enh: use lifecycle hook for before send event (#3017)

* Add os and device attributes to Flutter logs

* cleanup + changelog

* dont return context

* update cl

* extract reading of os and device

* fix cl

* extract contexts enrichment

* cleanup

* update cl

* fix test

* change to hooks api approach

* update client tests

* update tests

* update cl

* test for LogsEnricherIntegration

* fix error

* fix analyzer issues

* update integration name

* use generic api to register lifecycle events

* use function type

* move to sep file

* check if logs are enabled

* Remove `LogsEnricherIntegration` in load contexts integration

* update test with real expected values

* add comment

* fix analyze issue

* fix type casts

* fix cl

* Update

* Update

* Update

* Update

* Update

* Update

* Fix analyze

* Update

* Update

* Update

* Updaet

* Update

* Use empty sentry options

* Update tests

---------

Co-authored-by: Denis Andrasec <denrase@gmail.com>

Author: buenaflor

CHANGELOG.md

@@ -8,6 +8,10 @@
   - [changelog](https://github.com/getsentry/sentry-java/blob/main/CHANGELOG.md#8170)
   - [diff](https://github.com/getsentry/sentry-java/compare/8.13.2...8.17.0)
 
+### Internal
+
+- Use lifecycle hook for before send event ([#3017](https://github.com/getsentry/sentry-dart/pull/3017))
+
 ## 9.5.0
 
 ### Features

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

@@ -651,10 +651,19 @@ class Hub {
   SentryProfilerFactory? _profilerFactory;
 
   @internal
-  void registerCallback<T extends SdkLifecycleEvent>(
+  Map<Type, List<Function>> get lifecycleCallbacks =>
+      _peek().client.lifeCycleRegistry.lifecycleCallbacks;
+
+  @internal
+  void registerSdkLifecycleCallback<T extends SdkLifecycleEvent>(
+      SdkLifecycleCallback<T> callback) {
+    _peek().client.lifeCycleRegistry.registerCallback<T>(callback);
+  }
+
+  @internal
+  void removeSdkLifecycleCallback<T extends SdkLifecycleEvent>(
       SdkLifecycleCallback<T> callback) {
-    final item = _peek();
-    item.client.registerCallback<T>(callback);
+    _peek().client.lifeCycleRegistry.removeCallback<T>(callback);
   }
 
   SentryEvent _assignTraceContext(SentryEvent event) {

dart/lib/src/hub_adapter.dart

@@ -8,6 +8,7 @@ import 'profiling.dart';
 import 'protocol.dart';
 import 'protocol/sentry_feedback.dart';
 import 'scope.dart';
+import 'sdk_lifecycle_hooks.dart';
 import 'sentry.dart';
 import 'sentry_client.dart';
 import 'sentry_options.dart';
@@ -201,8 +202,18 @@ class HubAdapter implements Hub {
   FutureOr<void> captureLog(SentryLog log) => Sentry.currentHub.captureLog(log);
 
   @override
-  void registerCallback<T extends SdkLifecycleEvent>(
+  Map<Type, List<Function>> get lifecycleCallbacks =>
+      Sentry.currentHub.lifecycleCallbacks;
+
+  @override
+  void registerSdkLifecycleCallback<T extends SdkLifecycleEvent>(
+      SdkLifecycleCallback<T> callback) {
+    Sentry.currentHub.registerSdkLifecycleCallback(callback);
+  }
+
+  @override
+  void removeSdkLifecycleCallback<T extends SdkLifecycleEvent>(
       SdkLifecycleCallback<T> callback) {
-    Sentry.currentHub.registerCallback(callback);
+    Sentry.currentHub.removeSdkLifecycleCallback(callback);
   }
 }

dart/lib/src/lifecycle/on_before_capture_log.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> {
@@ -15,7 +15,7 @@ class LogsEnricherIntegration extends Integration<SentryOptions> {
   @override
   FutureOr<void> call(Hub hub, SentryOptions options) {
     if (options.enableLogs) {
-      hub.registerCallback<OnBeforeCaptureLog>(
+      hub.registerSdkLifecycleCallback<OnBeforeCaptureLog>(
         (event) async {
           final os = getSentryOperatingSystem();
 

dart/lib/src/logs_enricher_integration.dart

@@ -8,6 +8,7 @@ import 'profiling.dart';
 import 'protocol.dart';
 import 'protocol/sentry_feedback.dart';
 import 'scope.dart';
+import 'sdk_lifecycle_hooks.dart';
 import 'sentry_client.dart';
 import 'sentry_options.dart';
 import 'tracing.dart';
@@ -145,8 +146,14 @@ class NoOpHub implements Hub {
   @override
   Scope get scope => Scope(_options);
 
-  @internal
   @override
-  void registerCallback<T extends SdkLifecycleEvent>(
+  Map<Type, List<Function>> get lifecycleCallbacks => {};
+
+  @override
+  void registerSdkLifecycleCallback<T extends SdkLifecycleEvent>(
+      SdkLifecycleCallback<T> callback) {}
+
+  @override
+  void removeSdkLifecycleCallback<T extends SdkLifecycleEvent>(
       SdkLifecycleCallback<T> callback) {}
 }

dart/lib/src/noop_hub.dart

@@ -4,8 +4,10 @@ import 'hint.dart';
 import 'protocol.dart';
 import 'protocol/sentry_feedback.dart';
 import 'scope.dart';
+import 'sdk_lifecycle_hooks.dart';
 import 'sentry_client.dart';
 import 'sentry_envelope.dart';
+import 'sentry_options.dart';
 import 'sentry_trace_context_header.dart';
 
 class NoOpSentryClient implements SentryClient {
@@ -70,7 +72,8 @@ class NoOpSentryClient implements SentryClient {
   @override
   FutureOr<void> captureLog(SentryLog log, {Scope? scope}) async {}
 
+  final _lifeCycleRegistry = SdkLifecycleRegistry(SentryOptions.empty());
+
   @override
-  void registerCallback<T extends SdkLifecycleEvent>(
-      SdkLifecycleCallback<T> callback) {}
+  SdkLifecycleRegistry get lifeCycleRegistry => _lifeCycleRegistry;
 }

dart/lib/src/noop_sentry_client.dart

@@ -0,0 +1,73 @@
+import 'dart:async';
+
+import 'package:meta/meta.dart';
+
+import '../sentry.dart';
+
+@internal
+typedef SdkLifecycleCallback<T extends SdkLifecycleEvent> = FutureOr<void>
+    Function(T event);
+
+@internal
+abstract class SdkLifecycleEvent {}
+
+/// Holds and dispatches SDK lifecycle events in a type-safe way.
+/// These are meant to be used internally and are not part of public api.
+@internal
+class SdkLifecycleRegistry {
+  SdkLifecycleRegistry(this._options);
+
+  final SentryOptions _options;
+  final _lifecycleCallbacks = <Type, List<Function>>{};
+
+  Map<Type, List<Function>> get lifecycleCallbacks => _lifecycleCallbacks;
+
+  void registerCallback<T extends SdkLifecycleEvent>(
+      SdkLifecycleCallback<T> callback) {
+    _lifecycleCallbacks[T] ??= [];
+    _lifecycleCallbacks[T]?.add(callback);
+  }
+
+  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 {
+        final result = (cb as SdkLifecycleCallback<T>)(event);
+        if (result is Future) {
+          await result;
+        }
+      } catch (exception, stackTrace) {
+        _options.log(
+          SentryLevel.error,
+          'The SDK lifecycle callback threw an exception',
+          exception: exception,
+          stackTrace: stackTrace,
+        );
+        if (_options.automatedTestMode) {
+          rethrow;
+        }
+      }
+    }
+  }
+}
+
+@internal
+class OnBeforeCaptureLog extends SdkLifecycleEvent {
+  OnBeforeCaptureLog(this.log);
+
+  final SentryLog log;
+}
+
+@internal
+class OnBeforeSendEvent extends SdkLifecycleEvent {
+  OnBeforeSendEvent(this.event, this.hint);
+
+  final SentryEvent event;
+  final Hint hint;
+}