From 9cfcba3568cf7802fad87aa97d01513d5a5341d1 Mon Sep 17 00:00:00 2001 From: GIancarlo Buenaflor Date: Tue, 10 Dec 2024 16:36:17 +0100 Subject: [PATCH 1/3] deprecate --- flutter/example/lib/main.dart | 1 + flutter/lib/src/navigation/sentry_display_widget.dart | 5 ++++- flutter/test/navigation/sentry_display_widget_test.dart | 1 + 3 files changed, 6 insertions(+), 1 deletion(-) diff --git a/flutter/example/lib/main.dart b/flutter/example/lib/main.dart index 454be356f6..d5c7d71d71 100644 --- a/flutter/example/lib/main.dart +++ b/flutter/example/lib/main.dart @@ -781,6 +781,7 @@ void navigateToAutoCloseScreen(BuildContext context) { context, MaterialPageRoute( settings: const RouteSettings(name: 'AutoCloseScreen'), + // ignore: deprecated_member_use builder: (context) => SentryDisplayWidget(child: const AutoCloseScreen()), ), ); diff --git a/flutter/lib/src/navigation/sentry_display_widget.dart b/flutter/lib/src/navigation/sentry_display_widget.dart index e42f5c4f72..7672109eb4 100644 --- a/flutter/lib/src/navigation/sentry_display_widget.dart +++ b/flutter/lib/src/navigation/sentry_display_widget.dart @@ -1,7 +1,7 @@ import 'package:flutter/cupertino.dart'; -import 'time_to_initial_display_tracker.dart'; import '../frame_callback_handler.dart'; +import 'time_to_initial_display_tracker.dart'; /// A widget that reports the Time To Initially Displayed (TTID) of its child widget. /// @@ -27,6 +27,9 @@ import '../frame_callback_handler.dart'; /// See also: /// - [Sentry's documentation on Flutter integrations](https://docs.sentry.io/platforms/flutter/) /// for more information on how to integrate Sentry into your Flutter application. +@Deprecated( + 'Manual TTID tracking is no longer needed - Sentry automatically tracks TTID accurately.' + ' You can safely remove this widget.') class SentryDisplayWidget extends StatefulWidget { final Widget child; final FrameCallbackHandler _frameCallbackHandler; diff --git a/flutter/test/navigation/sentry_display_widget_test.dart b/flutter/test/navigation/sentry_display_widget_test.dart index 14d025c438..334c75b9b0 100644 --- a/flutter/test/navigation/sentry_display_widget_test.dart +++ b/flutter/test/navigation/sentry_display_widget_test.dart @@ -69,6 +69,7 @@ class Fixture { MaterialApp getSut() { return MaterialApp( + // ignore: deprecated_member_use_from_same_package home: SentryDisplayWidget( frameCallbackHandler: frameCallbackHandler, child: Text('my text'), From 873b9819728e807a887d9f144f7ca8abec98caa7 Mon Sep 17 00:00:00 2001 From: GIancarlo Buenaflor Date: Tue, 10 Dec 2024 17:31:59 +0100 Subject: [PATCH 2/3] update --- CHANGELOG.md | 4 ++++ flutter/lib/src/navigation/sentry_display_widget.dart | 1 + flutter/test/navigation/time_to_display_tracker_test.dart | 3 ++- 3 files changed, 7 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5785ed2e28..fa85a5645a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,10 @@ ## Unreleased +### Deprecate + +- Manual TTID ([#2477](https://github.com/getsentry/sentry-dart/pull/2477)) + ### Features - Replay: device orientation change support & improve video size fit on Android ([#2462](https://github.com/getsentry/sentry-dart/pull/2462)) diff --git a/flutter/lib/src/navigation/sentry_display_widget.dart b/flutter/lib/src/navigation/sentry_display_widget.dart index 7672109eb4..77a5ac2882 100644 --- a/flutter/lib/src/navigation/sentry_display_widget.dart +++ b/flutter/lib/src/navigation/sentry_display_widget.dart @@ -45,6 +45,7 @@ class SentryDisplayWidget extends StatefulWidget { _SentryDisplayWidgetState createState() => _SentryDisplayWidgetState(); } +// ignore: deprecated_member_use_from_same_package class _SentryDisplayWidgetState extends State { @override void initState() { diff --git a/flutter/test/navigation/time_to_display_tracker_test.dart b/flutter/test/navigation/time_to_display_tracker_test.dart index 369370d18a..9a8d820d29 100644 --- a/flutter/test/navigation/time_to_display_tracker_test.dart +++ b/flutter/test/navigation/time_to_display_tracker_test.dart @@ -101,6 +101,7 @@ void main() { expect(ttidSpan?.origin, SentryTraceOrigins.manualUiTimeToDisplay); }); + // skipping test, flaky test('completes with timeout when not completing the tracking', () async { final sut = fixture.getSut(); @@ -109,7 +110,7 @@ void main() { final transaction = fixture.getTransaction() as SentryTracer; await sut.track(transaction, startTimestamp: fixture.startTimestamp); - }); + }, skip: true); }); }); From 7baa6a88fb6fe2d3afb06db1a456e3fbc501fb47 Mon Sep 17 00:00:00 2001 From: GIancarlo Buenaflor Date: Thu, 12 Dec 2024 19:53:08 +0100 Subject: [PATCH 3/3] revert test skip --- flutter/test/navigation/time_to_display_tracker_test.dart | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/flutter/test/navigation/time_to_display_tracker_test.dart b/flutter/test/navigation/time_to_display_tracker_test.dart index 9a8d820d29..369370d18a 100644 --- a/flutter/test/navigation/time_to_display_tracker_test.dart +++ b/flutter/test/navigation/time_to_display_tracker_test.dart @@ -101,7 +101,6 @@ void main() { expect(ttidSpan?.origin, SentryTraceOrigins.manualUiTimeToDisplay); }); - // skipping test, flaky test('completes with timeout when not completing the tracking', () async { final sut = fixture.getSut(); @@ -110,7 +109,7 @@ void main() { final transaction = fixture.getTransaction() as SentryTracer; await sut.track(transaction, startTimestamp: fixture.startTimestamp); - }, skip: true); + }); }); });