deprecate: manual ttid widget (#2477)

* deprecate * update * revert test skip
getsentry · Dec 12, 2024 · d44ba48 · d44ba48
1 parent dc6fc46
commit d44ba48
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Deprecate
+
+- Manual TTID ([#2477](https://github.com/getsentry/sentry-dart/pull/2477))
+
 ### Enhancements
 
 - Warning (in a debug build) if a potentially sensitive widget is not masked or unmasked explicitly ([#2375](https://github.com/getsentry/sentry-dart/pull/2375))

diff --git 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
@@ -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;
@@ -42,6 +45,7 @@ class SentryDisplayWidget extends StatefulWidget {
   _SentryDisplayWidgetState createState() => _SentryDisplayWidgetState();
 }
 
+// ignore: deprecated_member_use_from_same_package
 class _SentryDisplayWidgetState extends State<SentryDisplayWidget> {
   @override
   void initState() {

diff --git 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'),