Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[v9]: remove manual TTID #2668

Merged
merged 5 commits into from
Feb 10, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

## Unreleased 9.0.0

- Remove `SentryDisplayWidget` and manual TTID implementation ([#2668](https://github.com/getsentry/sentry-dart/pull/2668))
- Increase minimum SDK version requirements to Dart v3.5.0 and Flutter v3.24.0 ([#2643](https://github.com/getsentry/sentry-dart/pull/2643))
- Remove screenshot option `attachScreenshotOnlyWhenResumed` ([#2664](https://github.com/getsentry/sentry-dart/pull/2664))
- Remove deprecated `beforeScreenshot` ([#2662](https://github.com/getsentry/sentry-dart/pull/2662))
Expand Down
2 changes: 1 addition & 1 deletion flutter/example/lib/main.dart
Original file line number Diff line number Diff line change
Expand Up @@ -730,7 +730,7 @@ void navigateToAutoCloseScreen(BuildContext context) {
MaterialPageRoute(
settings: const RouteSettings(name: 'AutoCloseScreen'),
// ignore: deprecated_member_use
builder: (context) => SentryDisplayWidget(child: const AutoCloseScreen()),
builder: (context) => const AutoCloseScreen(),
),
);
}
Expand Down
27 changes: 13 additions & 14 deletions flutter/lib/sentry_flutter.dart
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,23 @@ library;
// ignore: invalid_export_of_internal_element
export 'package:sentry/sentry.dart';

export 'src/binding_wrapper.dart'
show BindingWrapper, SentryWidgetsFlutterBinding;
export 'src/feedback/sentry_feedback_widget.dart';
export 'src/flutter_sentry_attachment.dart';
export 'src/integrations/load_release_integration.dart';
export 'src/integrations/on_error_integration.dart';
export 'src/navigation/sentry_navigator_observer.dart';
export 'src/sentry_flutter.dart';
export 'src/sentry_flutter_options.dart';
export 'src/sentry_replay_options.dart';
export 'src/replay/replay_quality.dart';
export 'src/sentry_privacy_options.dart';
export 'src/flutter_sentry_attachment.dart';
export 'src/sentry_asset_bundle.dart' show SentryAssetBundle;
export 'src/integrations/on_error_integration.dart';
export 'src/screenshot/masking_config.dart' show SentryMaskingDecision;
export 'src/screenshot/sentry_mask_widget.dart';
export 'src/screenshot/sentry_unmask_widget.dart';
export 'src/screenshot/sentry_screenshot_widget.dart';
export 'src/screenshot/sentry_screenshot_quality.dart';
export 'src/user_interaction/sentry_user_interaction_widget.dart';
export 'src/binding_wrapper.dart'
show BindingWrapper, SentryWidgetsFlutterBinding;
export 'src/screenshot/sentry_screenshot_widget.dart';
export 'src/screenshot/sentry_unmask_widget.dart';
export 'src/sentry_asset_bundle.dart' show SentryAssetBundle;
export 'src/sentry_flutter.dart';
export 'src/sentry_flutter_options.dart';
export 'src/sentry_privacy_options.dart';
export 'src/sentry_replay_options.dart';
export 'src/sentry_widget.dart';
export 'src/navigation/sentry_display_widget.dart';
export 'src/feedback/sentry_feedback_widget.dart';
export 'src/user_interaction/sentry_user_interaction_widget.dart';
64 changes: 0 additions & 64 deletions flutter/lib/src/navigation/sentry_display_widget.dart

This file was deleted.

33 changes: 2 additions & 31 deletions flutter/lib/src/navigation/time_to_initial_display_tracker.dart
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
import 'dart:async';

import 'package:meta/meta.dart';

// ignore: implementation_imports
import 'package:sentry/src/sentry_tracer.dart';

Expand All @@ -26,10 +25,8 @@ class TimeToInitialDisplayTracker {
TimeToInitialDisplayTracker._();

FrameCallbackHandler _frameCallbackHandler = DefaultFrameCallbackHandler();
bool _isManual = false;
Completer<DateTime?>? _trackingCompleter;
DateTime? _endTimestamp;
DateTime? _completeTrackingTimeStamp;

final Duration _determineEndtimeTimeout = Duration(seconds: 5);

Expand Down Expand Up @@ -61,10 +58,7 @@ class TimeToInitialDisplayTracker {
startTimestamp: startTimestamp,
);

ttidSpan.origin = origin ??
(_isManual
? SentryTraceOrigins.manualUiTimeToDisplay
: SentryTraceOrigins.autoUiTimeToDisplay);
ttidSpan.origin = origin ?? SentryTraceOrigins.autoUiTimeToDisplay;

final duration = Duration(
milliseconds: _endTimestamp.difference(startTimestamp).inMilliseconds);
Expand All @@ -87,46 +81,23 @@ class TimeToInitialDisplayTracker {
},
);

// If we already know it's manual we can return the future immediately
if (_isManual) {
final completeTrackingTimeStamp = _completeTrackingTimeStamp;
if (completeTrackingTimeStamp != null) {
// If complete was called before we could call start, complete it here.
_endTimestamp = completeTrackingTimeStamp;
_trackingCompleter?.complete(completeTrackingTimeStamp);
_completeTrackingTimeStamp = null;
}
return 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((_) {
if (!_isManual) {
completeTracking();
}
completeTracking();
});

return future;
}

void markAsManual() {
_isManual = true;
}

void completeTracking() {
final timestamp = DateTime.now();

if (_trackingCompleter != null && !_trackingCompleter!.isCompleted) {
_endTimestamp = timestamp;
_trackingCompleter?.complete(timestamp);
} else {
_completeTrackingTimeStamp = timestamp;
}
}

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
Expand Down
79 changes: 0 additions & 79 deletions flutter/test/navigation/sentry_display_widget_test.dart

This file was deleted.

29 changes: 0 additions & 29 deletions flutter/test/navigation/time_to_display_tracker_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -83,35 +83,6 @@ void main() {
await sut.track(transaction, startTimestamp: fixture.startTimestamp);
});
});

group('with manual strategy', () {
test('finishes ttid span', () async {
final sut = fixture.getSut();

Future.delayed(const Duration(milliseconds: 1), () {
fixture.ttidTracker?.markAsManual();
fixture.ttidTracker?.completeTracking();
});
final transaction = fixture.getTransaction() as SentryTracer;
await sut.track(transaction, startTimestamp: fixture.startTimestamp);

final ttidSpan = _getTTIDSpan(transaction);
expect(ttidSpan, isNotNull);
expect(ttidSpan?.finished, isTrue);
expect(ttidSpan?.origin, SentryTraceOrigins.manualUiTimeToDisplay);
});

// skipping test, flaky
test('completes with timeout when not completing the tracking', () async {
final sut = fixture.getSut();

fixture.ttidTracker?.markAsManual();
// Not calling completeTracking() triggers the manual timeout

final transaction = fixture.getTransaction() as SentryTracer;
await sut.track(transaction, startTimestamp: fixture.startTimestamp);
}, skip: true);
});
});

group('time to full display', () {
Expand Down
Loading
Loading