Update tests

Author: buenaflor

dart/lib/src/sentry_span_operations.dart

@@ -5,4 +5,4 @@ class SentrySpanOperations {
   static const String uiLoad = 'ui.load';
   static const String uiTimeToInitialDisplay = 'ui.load.initial_display';
   static const String uiTimeToFullDisplay = 'ui.load.full_display';
-}
+}

dart/lib/src/sentry_tracer.dart

@@ -117,7 +117,8 @@ class SentryTracer extends ISentrySpan {
         for (var child in children) {
           final childEndTimestamp = child.endTimestamp;
           if (childEndTimestamp != null) {
-            if (latestEndTime == null || childEndTimestamp.isAfter(latestEndTime)) {
+            if (latestEndTime == null ||
+                childEndTimestamp.isAfter(latestEndTime)) {
               latestEndTime = child.endTimestamp;
             }
           }

flutter/lib/src/frame_callback_handler.dart

@@ -1,11 +1,11 @@
 import 'package:flutter/scheduler.dart';
 import 'package:flutter/widgets.dart';
 
-abstract class IFrameCallbackHandler {
+abstract class FrameCallbackHandler {
   void addPostFrameCallback(FrameCallback callback, {String debugLabel});
 }
 
-class DefaultFrameCallbackHandler implements IFrameCallbackHandler {
+class DefaultFrameCallbackHandler implements FrameCallbackHandler {
   @override
   void addPostFrameCallback(FrameCallback callback,
       {String debugLabel = 'callback'}) {

flutter/lib/src/integrations/app_start/app_start_tracker.dart

@@ -27,7 +27,6 @@ class AppStartTracker {
   void setAppStartInfo(AppStartInfo? appStartInfo) {
     _appStartInfo = appStartInfo;
     if (!_appStartCompleter.isCompleted) {
-
       // Complete the completer with the app start info when it becomes available
       _appStartCompleter.complete(appStartInfo);
     } else {

flutter/lib/src/navigation/sentry_display_widget.dart

@@ -6,13 +6,14 @@ import '../frame_callback_handler.dart';
 
 class SentryDisplayWidget extends StatefulWidget {
   final Widget child;
-  final IFrameCallbackHandler _frameCallbackHandler;
+  final FrameCallbackHandler _frameCallbackHandler;
 
   SentryDisplayWidget({
     super.key,
     required this.child,
-    IFrameCallbackHandler? frameCallbackHandler,
-  }) : _frameCallbackHandler = frameCallbackHandler ?? DefaultFrameCallbackHandler();
+    FrameCallbackHandler? frameCallbackHandler,
+  }) : _frameCallbackHandler =
+            frameCallbackHandler ?? DefaultFrameCallbackHandler();
 
   @override
   _SentryDisplayWidgetState createState() => _SentryDisplayWidgetState();

flutter/lib/src/navigation/time_to_display_tracker.dart

@@ -61,9 +61,8 @@ class TimeToDisplayTracker {
 
     if (appStartInfo == null || name == null) return;
 
-    final transaction = await _ttdTransactionHandler.startTransaction(
-        name, arguments,
-        startTimestamp: appStartInfo.start);
+    final transaction = await _ttdTransactionHandler
+        .startTransaction(name, arguments, startTimestamp: appStartInfo.start);
     if (transaction == null) return;
 
     await _ttidTracker.trackAppStart(transaction, appStartInfo, name);
@@ -81,7 +80,8 @@ class TimeToDisplayTracker {
 
     if (transaction == null || routeName == null) return;
 
-    await _ttidTracker.trackRegularRoute(transaction, startTimestamp, routeName);
+    await _ttidTracker.trackRegularRoute(
+        transaction, startTimestamp, routeName);
 
     if (_enableTimeToFullDisplayTracing) {
       _ttfdTracker.startTracking(transaction, startTimestamp, routeName);

flutter/lib/src/navigation/time_to_full_display_tracker.dart

@@ -4,12 +4,28 @@ import '../../sentry_flutter.dart';
 import '../sentry_flutter_measurement.dart';
 import 'time_to_initial_display_tracker.dart';
 
+abstract class EndTimestampProvider {
+  DateTime? get endTimestamp;
+}
+
+class TTIDEndTimestampProvider implements EndTimestampProvider {
+  @override
+  DateTime? get endTimestamp => TimeToInitialDisplayTracker().endTimestamp;
+}
+
 class TimeToFullDisplayTracker {
-  static final TimeToFullDisplayTracker _singleton =
+  static final TimeToFullDisplayTracker _instance =
       TimeToFullDisplayTracker._internal();
 
-  factory TimeToFullDisplayTracker() {
-    return _singleton;
+  factory TimeToFullDisplayTracker(
+      {EndTimestampProvider? endTimestampProvider, Duration? autoFinishAfter}) {
+    if (autoFinishAfter != null) {
+      _instance._autoFinishAfter = autoFinishAfter;
+    }
+    if (endTimestampProvider != null) {
+      _instance._endTimestampProvider = endTimestampProvider;
+    }
+    return _instance;
   }
 
   TimeToFullDisplayTracker._internal();
@@ -18,23 +34,8 @@ class TimeToFullDisplayTracker {
   ISentrySpan? _ttfdSpan;
   Timer? _ttfdTimer;
   ISentrySpan? _transaction;
-  Duration ttfdAutoFinishAfter = const Duration(seconds: 30);
-
-  Future<void> reportFullyDisplayed() async {
-    _ttfdTimer?.cancel();
-    final endTimestamp = DateTime.now();
-    final startTimestamp = _startTimestamp;
-    final ttfdSpan = _ttfdSpan;
-
-    if (ttfdSpan == null ||
-        ttfdSpan.finished == true ||
-        startTimestamp == null) {
-      return;
-    }
-
-    _setTTFDMeasurement(startTimestamp, endTimestamp);
-    return ttfdSpan.finish(endTimestamp: endTimestamp);
-  }
+  Duration _autoFinishAfter = const Duration(seconds: 30);
+  EndTimestampProvider _endTimestampProvider = TTIDEndTimestampProvider();
 
   void startTracking(
       ISentrySpan transaction, DateTime startTimestamp, String routeName) {
@@ -43,7 +44,7 @@ class TimeToFullDisplayTracker {
     _ttfdSpan = transaction.startChild(SentrySpanOperations.uiTimeToFullDisplay,
         description: '$routeName full display', startTimestamp: startTimestamp);
     _ttfdSpan?.origin = SentryTraceOrigins.manualUiTimeToDisplay;
-    _ttfdTimer = Timer(ttfdAutoFinishAfter, handleTimeToFullDisplayTimeout);
+    _ttfdTimer = Timer(_autoFinishAfter, handleTimeToFullDisplayTimeout);
   }
 
   void handleTimeToFullDisplayTimeout() {
@@ -56,15 +57,31 @@ class TimeToFullDisplayTracker {
     }
 
     // If for some reason we can't get the ttid end timestamp
-    // we'll use the start timestamp + autoFinishTime as a fallback
-    final endTimestamp = TimeToInitialDisplayTracker().endTimestamp ??
-        startTimestamp.add(ttfdAutoFinishAfter);
+    // we'll use the start timestamp + autoFinishAfter as a fallback
+    final endTimestamp = _endTimestampProvider.endTimestamp ??
+        startTimestamp.add(_autoFinishAfter);
 
     _setTTFDMeasurement(startTimestamp, endTimestamp);
     ttfdSpan.finish(
         status: SpanStatus.deadlineExceeded(), endTimestamp: endTimestamp);
   }
 
+  Future<void> reportFullyDisplayed() async {
+    _ttfdTimer?.cancel();
+    final endTimestamp = DateTime.now();
+    final startTimestamp = _startTimestamp;
+    final ttfdSpan = _ttfdSpan;
+
+    if (ttfdSpan == null ||
+        ttfdSpan.finished == true ||
+        startTimestamp == null) {
+      return;
+    }
+
+    _setTTFDMeasurement(startTimestamp, endTimestamp);
+    return ttfdSpan.finish(endTimestamp: endTimestamp);
+  }
+
   void _setTTFDMeasurement(DateTime startTimestamp, DateTime endTimestamp) {
     final duration = endTimestamp.difference(startTimestamp);
     final measurement = SentryFlutterMeasurement.timeToFullDisplay(duration);

flutter/lib/src/navigation/time_to_initial_display_tracker.dart

@@ -14,10 +14,18 @@ import '../sentry_flutter_measurement.dart';
 class TimeToInitialDisplayTracker {
   static final TimeToInitialDisplayTracker _instance =
       TimeToInitialDisplayTracker._internal();
-  factory TimeToInitialDisplayTracker() => _instance;
+
+  factory TimeToInitialDisplayTracker(
+      {FrameCallbackHandler? frameCallbackHandler}) {
+    if (frameCallbackHandler != null) {
+      _instance._frameCallbackHandler = frameCallbackHandler;
+    }
+    return _instance;
+  }
+
   TimeToInitialDisplayTracker._internal();
 
-  IFrameCallbackHandler frameCallbackHandler = DefaultFrameCallbackHandler();
+  FrameCallbackHandler _frameCallbackHandler = DefaultFrameCallbackHandler();
   bool _isManual = false;
   Completer<DateTime>? _trackingCompleter;
   DateTime? _endTimestamp;
@@ -26,7 +34,8 @@ class TimeToInitialDisplayTracker {
   @internal
   DateTime? get endTimestamp => _endTimestamp;
 
-  Future<void> trackRegularRoute(ISentrySpan transaction, DateTime startTimestamp, String routeName) async {
+  Future<void> trackRegularRoute(ISentrySpan transaction,
+      DateTime startTimestamp, String routeName) async {
     final endTimestamp = await determineEndTime();
     if (endTimestamp == null) return;
 
@@ -41,19 +50,20 @@ class TimeToInitialDisplayTracker {
       ttidSpan.origin = SentryTraceOrigins.autoUiTimeToDisplay;
     }
 
-    // Reset after completion
-    _isManual = false;
-
     final ttidMeasurement = SentryFlutterMeasurement.timeToInitialDisplay(
         Duration(
             milliseconds:
-            endTimestamp.difference(startTimestamp).inMilliseconds));
+                endTimestamp.difference(startTimestamp).inMilliseconds));
     transaction.setMeasurement(ttidMeasurement.name, ttidMeasurement.value,
         unit: ttidMeasurement.unit);
-    return ttidSpan.finish(endTimestamp: endTimestamp);
+    await ttidSpan.finish(endTimestamp: endTimestamp);
+
+    // We can clear the state after creating and finishing the ttid span has finished
+    clear();
   }
 
-  Future<void> trackAppStart(ISentrySpan transaction, AppStartInfo appStartInfo, String routeName) async {
+  Future<void> trackAppStart(ISentrySpan transaction, AppStartInfo appStartInfo,
+      String routeName) async {
     final ttidSpan = transaction.startChild(
       SentrySpanOperations.uiTimeToInitialDisplay,
       description: '$routeName initial display',
@@ -68,7 +78,8 @@ class TimeToInitialDisplayTracker {
     final ttidMeasurement = SentryFlutterMeasurement.timeToInitialDisplay(
       Duration(milliseconds: appStartInfo.measurement.value.toInt()),
     );
-    transaction.setMeasurement(ttidMeasurement.name, ttidMeasurement.value, unit: ttidMeasurement.unit);
+    transaction.setMeasurement(ttidMeasurement.name, ttidMeasurement.value,
+        unit: ttidMeasurement.unit);
 
     // Since app start measurement is immediate, finish the TTID span with the app start's end timestamp
     await ttidSpan.finish(endTimestamp: appStartInfo.end);
@@ -80,9 +91,14 @@ class TimeToInitialDisplayTracker {
   Future<DateTime>? determineEndTime() {
     _trackingCompleter = Completer<DateTime>();
 
+    // If we already know it's manual we can return the future immediately
+    if (_isManual) {
+      return _trackingCompleter?.future;
+    }
+
     // Schedules a check at the end of the frame to determine if the tracking
     // should be completed immediately (approximation mode) or deferred (manual mode).
-    frameCallbackHandler.addPostFrameCallback((_) {
+    _frameCallbackHandler.addPostFrameCallback((_) {
       if (!_isManual) {
         completeTracking();
       }
@@ -103,4 +119,11 @@ class TimeToInitialDisplayTracker {
       _trackingCompleter?.complete(endTimestamp);
     }
   }
+
+  void clear() {
+    _isManual = false;
+    _trackingCompleter = null;
+    // We can't clear the ttid end time stamp here, because it might be needed
+    // in the [TimeToFullDisplayTracker] class
+  }
 }

flutter/lib/src/sentry_flutter.dart

@@ -34,7 +34,8 @@ typedef FlutterOptionsConfiguration = FutureOr<void> Function(
 mixin SentryFlutter {
   static const _channel = MethodChannel('sentry_flutter');
 
-  static Future<void> init(FlutterOptionsConfiguration optionsConfiguration, {
+  static Future<void> init(
+    FlutterOptionsConfiguration optionsConfiguration, {
     AppRunner? appRunner,
     @internal MethodChannel channel = _channel,
     @internal PlatformChecker? platformChecker,
@@ -82,7 +83,7 @@ mixin SentryFlutter {
     await _initDefaultValues(flutterOptions, channel);
 
     await Sentry.init(
-          (options) => optionsConfiguration(options as SentryFlutterOptions),
+      (options) => optionsConfiguration(options as SentryFlutterOptions),
       appRunner: appRunner,
       // ignore: invalid_use_of_internal_member
       options: flutterOptions,
@@ -98,8 +99,10 @@ mixin SentryFlutter {
     }
   }
 
-  static Future<void> _initDefaultValues(SentryFlutterOptions options,
-      MethodChannel channel,) async {
+  static Future<void> _initDefaultValues(
+    SentryFlutterOptions options,
+    MethodChannel channel,
+  ) async {
     options.addEventProcessor(FlutterExceptionEventProcessor());
 
     // Not all platforms have a native integration.
@@ -123,9 +126,11 @@ mixin SentryFlutter {
 
   /// Install default integrations
   /// https://medium.com/flutter-community/error-handling-in-flutter-98fce88a34f0
-  static List<Integration> _createDefaultIntegrations(MethodChannel channel,
-      SentryFlutterOptions options,
-      bool isOnErrorSupported,) {
+  static List<Integration> _createDefaultIntegrations(
+    MethodChannel channel,
+    SentryFlutterOptions options,
+    bool isOnErrorSupported,
+  ) {
     final integrations = <Integration>[];
     final platformChecker = options.platformChecker;
     final platform = platformChecker.platform;
@@ -185,7 +190,7 @@ mixin SentryFlutter {
     if (_native != null) {
       integrations.add(NativeAppStartIntegration(
         _native!,
-            () {
+        () {
           try {
             /// Flutter >= 2.12 throws if SchedulerBinding.instance isn't initialized.
             return SchedulerBinding.instance;

flutter/test/fake_frame_callback_handler.dart

@@ -1,7 +1,7 @@
 import 'package:flutter/scheduler.dart';
 import 'package:sentry_flutter/src/frame_callback_handler.dart';
 
-class FakeFrameCallbackHandler implements IFrameCallbackHandler {
+class FakeFrameCallbackHandler implements FrameCallbackHandler {
   FrameCallback? storedCallback;
 
   final Duration _finishAfterDuration;

flutter/test/mocks.dart

@@ -9,7 +9,6 @@ import 'package:sentry/src/sentry_tracer.dart';
 
 import 'package:meta/meta.dart';
 import 'package:sentry_flutter/sentry_flutter.dart';
-import 'package:sentry_flutter/src/frame_callback_handler.dart';
 import 'package:sentry_flutter/src/renderer/renderer.dart';
 import 'package:sentry_flutter/src/native/sentry_native.dart';
 import 'package:sentry_flutter/src/native/sentry_native_binding.dart';
@@ -48,7 +47,6 @@ ISentrySpan startTransactionShim(
   SentryTracer,
   SentryTransaction,
   MethodChannel,
-  IFrameCallbackHandler,
 ], customMocks: [
   MockSpec<Hub>(fallbackGenerators: {#startTransaction: startTransactionShim})
 ])