refactor: use options.clock wherever possible (#1110)

Author: vaind

dart/lib/src/default_integrations.dart

@@ -48,6 +48,7 @@ class RunZonedGuardedIntegration extends Integration {
         final event = SentryEvent(
           throwable: throwableMechanism,
           level: SentryLevel.fatal,
+          timestamp: hub.options.clock(),
         );
 
         await hub.captureEvent(event, stackTrace: stackTrace);

dart/lib/src/http_client/failed_request_client.dart

@@ -198,6 +198,7 @@ class FailedRequestClient extends BaseClient {
     final event = SentryEvent(
       throwable: throwableMechanism,
       request: sentryRequest,
+      timestamp: _hub.options.clock(),
     );
 
     if (response != null) {

dart/lib/src/isolate_error_integration.dart

@@ -72,6 +72,7 @@ Future<void> handleIsolateError(
     final event = SentryEvent(
       throwable: throwableMechanism,
       level: SentryLevel.fatal,
+      timestamp: hub.options.clock(),
     );
 
     await hub.captureEvent(event, stackTrace: stackTrace);

dart/lib/src/protocol/sentry_span.dart

@@ -32,7 +32,7 @@ class SentrySpan extends ISentrySpan {
     this.samplingDecision,
     Function({DateTime? endTimestamp})? finishedCallback,
   }) {
-    _startTimestamp = startTimestamp?.toUtc() ?? getUtcDateTime();
+    _startTimestamp = startTimestamp?.toUtc() ?? _hub.options.clock();
     _finishedCallback = finishedCallback;
   }
 
@@ -42,20 +42,20 @@ class SentrySpan extends ISentrySpan {
       return;
     }
 
-    final utcDateTime = getUtcDateTime();
-
     if (status != null) {
       _status = status;
     }
 
-    if (endTimestamp?.isBefore(_startTimestamp) ?? false) {
+    if (endTimestamp == null) {
+      _endTimestamp = _hub.options.clock();
+    } else if (endTimestamp.isBefore(_startTimestamp)) {
       _hub.options.logger(
         SentryLevel.warning,
         'End timestamp ($endTimestamp) cannot be before start timestamp ($_startTimestamp)',
       );
-      _endTimestamp = utcDateTime;
+      _endTimestamp = _hub.options.clock();
     } else {
-      _endTimestamp = endTimestamp?.toUtc() ?? utcDateTime;
+      _endTimestamp = endTimestamp.toUtc();
     }
 
     // associate error

dart/lib/src/sentry_options.dart

@@ -41,6 +41,8 @@ class SentryOptions {
 
   /// If [clock] is provided, it is used to get time instead of the system
   /// clock. This is useful in tests. Should be an implementation of [ClockProvider].
+  /// The ClockProvider is expected to return UTC time.
+  @internal
   ClockProvider clock = getUtcDateTime;
 
   int _maxBreadcrumbs = 100;
@@ -87,6 +89,7 @@ class SentryOptions {
     _maxSpans = maxSpans;
   }
 
+  // ignore: deprecated_member_use_from_same_package
   SentryLogger _logger = noOpLogger;
 
   /// Logger interface to log useful debugging information if debug is enabled
@@ -117,10 +120,12 @@ class SentryOptions {
 
   set debug(bool newValue) {
     _debug = newValue;
+    // ignore: deprecated_member_use_from_same_package
     if (_debug == true && logger == noOpLogger) {
-      _logger = dartLogger;
+      _logger = _debugLogger;
     }
-    if (_debug == false && logger == dartLogger) {
+    if (_debug == false && logger == _debugLogger) {
+      // ignore: deprecated_member_use_from_same_package
       _logger = noOpLogger;
     }
   }
@@ -359,6 +364,23 @@ class SentryOptions {
   @internal
   late SentryClientAttachmentProcessor clientAttachmentProcessor =
       SentryClientAttachmentProcessor();
+
+  void _debugLogger(
+    SentryLevel level,
+    String message, {
+    String? logger,
+    Object? exception,
+    StackTrace? stackTrace,
+  }) {
+    log(
+      '[${level.name}] $message',
+      level: level.toDartLogLevel(),
+      name: logger ?? 'sentry',
+      time: clock(),
+      error: exception,
+      stackTrace: stackTrace,
+    );
+  }
 }
 
 /// This function is called with an SDK specific event object and can return a modified event
@@ -391,6 +413,7 @@ typedef TracesSamplerCallback = double? Function(
     SentrySamplingContext samplingContext);
 
 /// A NoOp logger that does nothing
+@Deprecated('This will be made private or removed in the future')
 void noOpLogger(
   SentryLevel level,
   String message, {
@@ -400,6 +423,7 @@ void noOpLogger(
 }) {}
 
 /// A Logger that prints out the level and message
+@Deprecated('This will be made private or removed in the future')
 void dartLogger(
   SentryLevel level,
   String message, {

dart/lib/src/sentry_tracer.dart

@@ -2,7 +2,6 @@ import 'dart:async';
 
 import 'package:intl/intl.dart';
 import 'package:meta/meta.dart';
-import 'utils.dart';
 
 import '../sentry.dart';
 import 'sentry_tracer_finish_status.dart';
@@ -72,7 +71,7 @@ class SentryTracer extends ISentrySpan {
 
   @override
   Future<void> finish({SpanStatus? status, DateTime? endTimestamp}) async {
-    final commonEndTimestamp = endTimestamp ?? getUtcDateTime();
+    final commonEndTimestamp = endTimestamp ?? _hub.options.clock();
     _autoFinishAfterTimer?.cancel();
     _finishStatus = SentryTracerFinishStatus.finishing(status);
     if (!_rootSpan.finished &&

dart/test/sentry_options_test.dart

@@ -34,9 +34,13 @@ void main() {
 
   test('SentryLogger sets a diagnostic logger', () {
     final options = SentryOptions(dsn: fakeDsn);
+    // ignore: deprecated_member_use_from_same_package
+    expect(options.logger, noOpLogger);
+    // ignore: deprecated_member_use_from_same_package
     options.logger = dartLogger;
 
-    expect(false, options.logger == noOpLogger);
+    // ignore: deprecated_member_use_from_same_package
+    expect(options.logger, isNot(noOpLogger));
   });
 
   test('tracesSampler is null by default', () {

dart/test/sentry_test.dart

@@ -342,20 +342,23 @@ void main() {
     }, options: sentryOptions);
   });
 
-  test('options.logger is not dartLogger after debug = false', () async {
+  test('options.logger is set by setting the debug flag', () async {
     final sentryOptions =
         SentryOptions(dsn: fakeDsn, checker: FakePlatformChecker.debugMode());
 
     await Sentry.init((options) {
       options.dsn = fakeDsn;
       options.debug = true;
-      expect(options.logger, dartLogger);
+      // ignore: deprecated_member_use_from_same_package
+      expect(options.logger, isNot(noOpLogger));
 
       options.debug = false;
+      // ignore: deprecated_member_use_from_same_package
       expect(options.logger, noOpLogger);
     }, options: sentryOptions);
 
-    expect(sentryOptions.logger == dartLogger, false);
+    // ignore: deprecated_member_use_from_same_package
+    expect(sentryOptions.logger, isNot(dartLogger));
   });
 
   group("Sentry init optionsConfiguration", () {

flutter/lib/src/integrations/flutter_error_integration.dart

@@ -74,6 +74,8 @@ class FlutterErrorIntegration extends Integration<SentryFlutterOptions> {
           contexts: flutterErrorDetails.isNotEmpty
               ? (Contexts()..['flutter_error_details'] = flutterErrorDetails)
               : null,
+          // ignore: invalid_use_of_internal_member
+          timestamp: options.clock(),
         );
 
         await hub.captureEvent(event, stackTrace: errorDetails.stack);

flutter/lib/src/integrations/native_app_start_integration.dart

@@ -24,7 +24,8 @@ class NativeAppStartIntegration extends Integration<SentryFlutterOptions> {
             'Scheduler binding is null. Can\'t auto detect app start time.');
       } else {
         schedulerBinding.addPostFrameCallback((timeStamp) {
-          _native.appStartEnd = DateTime.now().toUtc();
+          // ignore: invalid_use_of_internal_member
+          _native.appStartEnd = options.clock();
         });
       }
     }