Skip to content

Show debug-mode message for widget rebuilds in profile mode #9755

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.

Sign up for GitHub

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

Open
crackedhandle wants to merge 2 commits into
base: master
Choose a base branch
from
+89 −46
Open

Show debug-mode message for widget rebuilds in profile mode #9755

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1a35297
Show debug-mode message for widget rebuilds in profile mode
crackedhandle Apr 3, 2026
44942d2
Move RebuildStatsView tests to performance_screen_test
crackedhandle Apr 8, 2026
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
13 changes: 13 additions & 0 deletions packages/devtools_app/lib/src/screens/performance/panes/rebuild_stats/rebuild_stats.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,19 @@ class _RebuildStatsViewState extends State<RebuildStatsView>

@override
Widget build(BuildContext context) {
final isProfileBuild =
serviceConnection.serviceManager.connectedApp?.isProfileBuildNow ??
false;
if (isProfileBuild) {
return const Center(
child: Text(
'Rebuild information is not available for this frame.\n'
'Widget rebuild counts are only available when running '
'an app in debug-mode.',
textAlign: TextAlign.center,
),
);
}
return Column(
crossAxisAlignment: CrossAxisAlignment.start,
children: [
Expand Down
122 changes: 76 additions & 46 deletions packages/devtools_app/test/screens/performance/performance_screen_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ import 'dart:async';

import 'package:devtools_app/devtools_app.dart';
import 'package:devtools_app/src/screens/performance/panes/controls/performance_controls.dart';
import 'package:devtools_app/src/screens/performance/panes/flutter_frames/flutter_frame_model.dart';
import 'package:devtools_app/src/screens/performance/panes/rebuild_stats/rebuild_stats.dart';
import 'package:devtools_app/src/screens/performance/panes/rebuild_stats/rebuild_stats_model.dart';
import 'package:devtools_app/src/screens/performance/panes/timeline_events/timeline_events_view.dart';
import 'package:devtools_app/src/screens/performance/tabbed_performance_view.dart';
import 'package:devtools_app/src/shared/feature_flags.dart';
Expand All @@ -18,6 +21,7 @@ import 'package:devtools_app_shared/utils.dart';
import 'package:devtools_shared/devtools_test_utils.dart';
import 'package:devtools_test/devtools_test.dart';
import 'package:devtools_test/helpers.dart';
import 'package:flutter/foundation.dart';
import 'package:flutter/material.dart';
import 'package:flutter_markdown/flutter_markdown.dart';
import 'package:flutter_test/flutter_test.dart';
Expand Down Expand Up @@ -153,7 +157,6 @@ void main() {
findsOneWidget,
);

// Make sure NO Flutter-specific information is included:
expect(
markdownFinder('The Flutter framework emits timeline events'),
findsNothing,
Expand Down Expand Up @@ -183,7 +186,6 @@ void main() {
findsOneWidget,
);

// Make sure Flutter-specific information is included:
expect(
markdownFinder('The Flutter framework emits timeline events'),
findsOneWidget,
Expand Down Expand Up @@ -222,7 +224,6 @@ void main() {
final chartButtonFinder = find.byType(VisibilityButton);
expect(chartButtonFinder, findsOneWidget);

// The flutter frames chart is visible.
expect(find.byType(FramesChartControls), findsOneWidget);
expect(
preferences.performance.showFlutterFramesChart.value,
Expand All @@ -232,7 +233,6 @@ void main() {
await tester.tap(chartButtonFinder);
await tester.pumpAndSettle();

// The flutter frames chart should no longer be visible.
expect(find.byType(FramesChartControls), findsNothing);
expect(
preferences.performance.showFlutterFramesChart.value,
Expand All @@ -242,7 +242,6 @@ void main() {
await tester.tap(chartButtonFinder);
await tester.pumpAndSettle();

// The flutter frames chart should be visible again.
expect(find.byType(FramesChartControls), findsOneWidget);
expect(
preferences.performance.showFlutterFramesChart.value,
Expand All @@ -252,46 +251,6 @@ void main() {
},
);

// testWidgetsWithWindowSize(
// 'clears timeline on clear',
// windowSize,
// (WidgetTester tester) async {
// await tester.runAsync(() async {
// await pumpPerformanceScreen(tester, runAsync: true);
// await tester.pumpAndSettle();

// // Ensure the Timeline Events tab is selected.
// final timelineEventsTabFinder = find.text('Timeline Events');
// expect(timelineEventsTabFinder, findsOneWidget);
// await tester.tap(timelineEventsTabFinder);
// await tester.pumpAndSettle();

// expect(
// controller.timelineEventsController.allTraceEvents,
// isNotEmpty,
// );
// expect(find.byType(FlutterFramesChart), findsOneWidget);
// expect(find.byType(TimelineFlameChart), findsOneWidget);
// expect(
// find.byKey(TimelineEventsView.emptyTimelineKey),
// findsNothing,
// );
// expect(find.byType(EventDetails), findsOneWidget);

// await tester.tap(find.byIcon(Icons.block));
// await tester.pumpAndSettle();
// expect(controller.timelineEventsController.allTraceEvents, isEmpty);
// expect(find.byType(FlutterFramesChart), findsOneWidget);
// expect(find.byType(TimelineFlameChart), findsNothing);
// expect(
// find.byKey(TimelineEventsView.emptyTimelineKey),
// findsOneWidget,
// );
// expect(find.byType(EventDetails), findsNothing);
// });
// },
// );

testWidgetsWithWindowSize('opens enhance tracing overlay', windowSize, (
WidgetTester tester,
) async {
Expand Down Expand Up @@ -395,9 +354,80 @@ void main() {
},
);
});

group('RebuildStatsView', () {
late FakeServiceConnectionManager fakeServiceConnection;
late RebuildCountModel model;
late ValueNotifier<FlutterFrame?> selectedFrame;

setUp(() {
fakeServiceConnection = FakeServiceConnectionManager();
final app = fakeServiceConnection.serviceManager.connectedApp!;
when(app.initialized).thenReturn(Completer()..complete(true));
when(app.isDartWebAppNow).thenReturn(false);
when(app.isFlutterAppNow).thenReturn(true);
when(app.isDartCliAppNow).thenReturn(false);
when(app.isDartWebApp).thenAnswer((_) async => false);
when(app.isProfileBuild).thenAnswer((_) async => false);
setGlobal(ServiceConnectionManager, fakeServiceConnection);
setGlobal(IdeTheme, IdeTheme());
setGlobal(NotificationService, NotificationService());
setGlobal(BannerMessagesController, BannerMessagesController());
setGlobal(PreferencesController, PreferencesController());
setGlobal(OfflineDataController, OfflineDataController());
model = RebuildCountModel();
selectedFrame = ValueNotifier<FlutterFrame?>(null);
});

testWidgets(
'shows message when running in profile mode',
(WidgetTester tester) async {
final app = fakeServiceConnection.serviceManager.connectedApp!;
when(app.isProfileBuildNow).thenReturn(true);

await tester.pumpWidget(
wrapWithControllers(
RebuildStatsView(
model: model,
selectedFrame: selectedFrame,
),
),
);
await tester.pump();

expect(
find.textContaining('Widget rebuild counts are only available'),
findsOneWidget,
);
},
);

testWidgets(
'shows normal UI when running in debug mode',
(WidgetTester tester) async {
final app = fakeServiceConnection.serviceManager.connectedApp!;
when(app.isProfileBuildNow).thenReturn(false);

await tester.pumpWidget(
wrapWithControllers(
RebuildStatsView(
model: model,
selectedFrame: selectedFrame,
),
),
);
await tester.pump();

expect(
find.textContaining('Widget rebuild counts are only available'),
findsNothing,
);
},
);
});
});
}

Finder markdownFinder(String textMatch) => find.byWidgetPredicate(
(widget) => widget is Markdown && widget.data.contains(textMatch),
);
);