Disable the Raster Stats tool for Impeller (#6616)

Author: kenzieschmoll

packages/devtools_app/lib/devtools_app.dart

@@ -57,6 +57,7 @@ export 'src/service/json_to_service_cache.dart';
 export 'src/service/resolved_uri_manager.dart';
 export 'src/service/service_extensions.dart';
 export 'src/service/service_manager.dart';
+export 'src/service/service_registrations.dart';
 export 'src/service/timeline_streams.dart';
 export 'src/service/vm_flags.dart';
 export 'src/service/vm_service_wrapper.dart';

packages/devtools_app/lib/src/screens/performance/panes/frame_analysis/frame_hints.dart

@@ -370,10 +370,10 @@ class ShaderCompilationHint extends StatelessWidget {
                 LinkTextSpan(
                   link: Link(
                     display: 'Impeller',
-                    url: impellerWikiUrl,
+                    url: impellerDocsUrl,
                     gaScreenName: gac.performance,
                     gaSelectedItemDescription:
-                        gac.PerformanceDocs.impellerWikiLink.name,
+                        gac.PerformanceDocs.impellerDocsLink.name,
                   ),
                   context: context,
                 ),

packages/devtools_app/lib/src/screens/performance/panes/raster_stats/raster_stats.dart

@@ -14,19 +14,48 @@ import '../../../../shared/globals.dart';
 import '../../../../shared/primitives/utils.dart';
 import '../../../../shared/table/table.dart';
 import '../../../../shared/table/table_data.dart';
+import '../../performance_utils.dart';
 import 'raster_stats_controller.dart';
 import 'raster_stats_model.dart';
 
 class RasterStatsView extends StatelessWidget {
   const RasterStatsView({
     super.key,
     required this.rasterStatsController,
+    required this.impellerEnabled,
   });
 
   final RasterStatsController rasterStatsController;
 
+  final bool impellerEnabled;
+
   @override
   Widget build(BuildContext context) {
+    if (impellerEnabled) {
+      return Center(
+        child: RichText(
+          textAlign: TextAlign.center,
+          text: TextSpan(
+            text: 'The Raster Stats tool is not currently available for the '
+                'Impeller backend.\nLearn more about the status of ',
+            style: Theme.of(context).regularTextStyle,
+            children: [
+              LinkTextSpan(
+                link: Link(
+                  display: 'Impeller',
+                  url: impellerDocsUrl,
+                  gaScreenName: gac.performance,
+                  gaSelectedItemDescription:
+                      gac.PerformanceDocs.impellerDocsLinkFromRasterStats.name,
+                ),
+                context: context,
+              ),
+              const TextSpan(text: '.'),
+            ],
+          ),
+        ),
+      );
+    }
     return Column(
       children: [
         if (!offlineController.offlineMode.value)

packages/devtools_app/lib/src/screens/performance/panes/raster_stats/raster_stats_controller.dart

@@ -41,6 +41,10 @@ class RasterStatsController extends PerformanceFeatureController {
       setData(rasterStats);
     } catch (e, st) {
       _log.shout('Error collecting raster stats: $e', e, st);
+      notificationService.pushError(
+        'Error collecting raster stats: $e',
+        stackTrace: st.toString(),
+      );
       clearData();
     } finally {
       _loadingSnapshot.value = false;

packages/devtools_app/lib/src/screens/performance/performance_controller.dart

@@ -7,6 +7,7 @@ import 'dart:async';
 import 'package:devtools_app_shared/utils.dart';
 import 'package:vm_service/vm_service.dart';
 
+import '../../service/service_registrations.dart' as registrations;
 import '../../shared/diagnostics/inspector_service.dart';
 import '../../shared/feature_flags.dart';
 import '../../shared/globals.dart';
@@ -98,6 +99,9 @@ class PerformanceController extends DisposableController
   /// in selected timeline event, selected frame, etc.).
   PerformanceData? offlinePerformanceData;
 
+  bool get impellerEnabled => _impellerEnabled;
+  late final bool _impellerEnabled;
+
   final _initialized = Completer<void>();
 
   Future<void> get initialized => _initialized.future;
@@ -115,6 +119,17 @@ class PerformanceController extends DisposableController
     if (!offlineController.offlineMode.value) {
       await serviceConnection.serviceManager.onServiceAvailable;
 
+      if (serviceConnection.serviceManager.connectedApp?.isFlutterAppNow ??
+          false) {
+        final impellerEnabledResponse = await serviceConnection.serviceManager
+            .callServiceExtensionOnMainIsolate(
+          registrations.isImpellerEnabled,
+        );
+        _impellerEnabled = impellerEnabledResponse.json?['enabled'] == true;
+      } else {
+        _impellerEnabled = false;
+      }
+
       enhanceTracingController.init();
 
       // Listen for Flutter.Frame events with frame timing data.

packages/devtools_app/lib/src/screens/performance/performance_utils.dart

@@ -87,7 +87,7 @@ void debugTraceEventCallback(VoidCallback callback) {
 
 const preCompileShadersDocsUrl = 'https://docs.flutter.dev/perf/shader';
 
-const impellerWikiUrl = 'https://github.com/flutter/flutter/wiki/Impeller';
+const impellerDocsUrl = 'https://docs.flutter.dev/perf/impeller';
 
 extension TraceEventExtension on TraceEvent {
   bool get isThreadNameEvent =>

packages/devtools_app/lib/src/screens/performance/tabbed_performance_view.dart

@@ -152,6 +152,7 @@ class _TabbedPerformanceViewState extends State<TabbedPerformanceView>
             child: Center(
               child: RasterStatsView(
                 rasterStatsController: controller.rasterStatsController,
+                impellerEnabled: controller.impellerEnabled,
               ),
             ),
           ),

packages/devtools_app/lib/src/service/service_registrations.dart

@@ -58,3 +58,7 @@ const renderFrameWithRasterStats = '_flutter.renderFrameWithRasterStats';
 
 /// Dwds listens to events for recording end-to-end analytics.
 const dwdsSendEvent = 'ext.dwds.sendEvent';
+
+/// Service extension that returns whether or not the Impeller rendering engine
+/// is being used (if false, the app is using SKIA).
+const isImpellerEnabled = 'ext.ui.window.impellerEnabled';

packages/devtools_app/lib/src/shared/analytics/constants/_performance_constants.dart

@@ -50,6 +50,7 @@ enum PerformanceDocs {
   intrinsicOperationsDocs,
   shaderCompilationDocs,
   shaderCompilationDocsTooltipLink,
-  impellerWikiLink,
+  impellerDocsLink,
+  impellerDocsLinkFromRasterStats,
   platformChannelsDocs,
 }

packages/devtools_app/lib/src/shared/banner_messages.dart

@@ -355,10 +355,10 @@ class ShaderJankMessage {
           LinkTextSpan(
             link: Link(
               display: 'Impeller',
-              url: impellerWikiUrl,
+              url: impellerDocsUrl,
               gaScreenName: screenId,
               gaSelectedItemDescription:
-                  gac.PerformanceDocs.impellerWikiLink.name,
+                  gac.PerformanceDocs.impellerDocsLink.name,
             ),
             context: context,
             style: theme.errorMessageLinkStyle,

packages/devtools_app/lib/src/shared/common_widgets.dart

@@ -976,10 +976,7 @@ class CenteredMessage extends StatelessWidget {
   @override
   Widget build(BuildContext context) {
     return Center(
-      child: Text(
-        message,
-        style: Theme.of(context).textTheme.titleLarge,
-      ),
+      child: Text(message),
     );
   }
 }

packages/devtools_app/release_notes/NEXT_RELEASE_NOTES.md

@@ -19,7 +19,7 @@ video provides a brief tutorial for each DevTools screen.
 
 * Fix a bug with service extension states not being cleared on app disconnect.
 [#6547](https://github.com/flutter/devtools/pull/6547)
-- Improved styling of bottom status bar when connected to an app. [#6525](https://github.com/flutter/devtools/pull/6525)
+* Improved styling of bottom status bar when connected to an app. [#6525](https://github.com/flutter/devtools/pull/6525)
 
 ## Inspector updates
 
@@ -28,7 +28,7 @@ TODO: Remove this section if there are not any general updates.
 ## Performance updates
 
 * Added an option in the "Enhance Tracing" menu for tracking platform channel
-activity. This is useful for apps with plugins.
+activity. This is useful for apps with plugins. [#6515](https://github.com/flutter/devtools/pull/6515)
 
     ![Track platform channels setting](images/track_platform_channels.png "Track platform channels setting")
 
@@ -37,6 +37,10 @@ previously saved from DevTools can be reloaded for viewing from this screen. [#6
 * Added an "Open" button to the Performance controls for loading data that was previously saved
 from DevTools. [#6567](https://github.com/flutter/devtools/pull/6567)
 
+    ![Open file button on the performance screen](images/open_file_performance_screen.png "Open file button on the performance screen")
+
+* Disable the Raster Stats tool for the Impeller backend since it is not supported. [#6616](https://github.com/flutter/devtools/pull/6616)
+
 ## CPU profiler updates
 
 * Tree guidelines are now always enabled for the "Bottom Up" and "Call Tree" tabs. [#6534](https://github.com/flutter/devtools/pull/6534)
@@ -55,7 +59,7 @@ TODO: Remove this section if there are not any general updates.
 
 ## Network profiler updates
 
-* Network statuses now show with an error color when the request failed [#6527](https://github.com/flutter/devtools/pull/6527)
+* Network statuses now show with an error color when the request failed. [#6527](https://github.com/flutter/devtools/pull/6527)
 
 ## Logging updates
 
@@ -68,7 +72,7 @@ TODO: Remove this section if there are not any general updates.
 ## VS Code Sidebar updates
 
 * When using VS Code with a light theme, the embedded sidebar provided by DevTools will now also show in the light
-theme [#6581](https://github.com/flutter/devtools/pull/6581)
+theme. [#6581](https://github.com/flutter/devtools/pull/6581)
 
 ## Full commit history
 

packages/devtools_app/release_notes/images/open_file_performance_screen.png

@@ -29,6 +29,7 @@ void main() {
       );
       setGlobal(ServiceConnectionManager, mockServiceConnection);
       setGlobal(IdeTheme, IdeTheme());
+      setGlobal(NotificationService, NotificationService());
 
       controller =
           RasterStatsController(createMockPerformanceControllerWithDefaults());

packages/devtools_app/test/performance/raster_stats/raster_stats_controller_test.dart

@@ -32,11 +32,15 @@ void main() {
       await controller.collectRasterStats();
     });
 
-    Future<void> pumpRenderingLayerVisualizer(WidgetTester tester) async {
+    Future<void> pumpRasterStatsView(
+      WidgetTester tester, {
+      bool impellerEnabled = false,
+    }) async {
       await tester.pumpWidget(
         wrap(
           RasterStatsView(
             rasterStatsController: controller,
+            impellerEnabled: impellerEnabled,
           ),
         ),
       );
@@ -45,7 +49,7 @@ void main() {
 
     testWidgets('renders in empty state', (WidgetTester tester) async {
       controller.clearData();
-      await pumpRenderingLayerVisualizer(tester);
+      await pumpRasterStatsView(tester);
 
       expect(find.byType(LayerSnapshotTable), findsNothing);
       expect(find.byType(LayerImage), findsNothing);
@@ -58,7 +62,7 @@ void main() {
     });
 
     testWidgets('renders with data', (tester) async {
-      await pumpRenderingLayerVisualizer(tester);
+      await pumpRasterStatsView(tester);
 
       expect(find.byType(LayerSnapshotTable), findsOneWidget);
       expect(find.richText('Layer'), findsOneWidget);
@@ -79,8 +83,23 @@ void main() {
       );
     });
 
+    testWidgets('renders for Impeller', (WidgetTester tester) async {
+      controller.clearData();
+      await pumpRasterStatsView(tester, impellerEnabled: true);
+
+      expect(find.byType(LayerSnapshotTable), findsNothing);
+      expect(find.byType(LayerImage), findsNothing);
+      expect(
+        find.richTextContaining(
+          'The Raster Stats tool is not currently available for the '
+          'Impeller backend.',
+        ),
+        findsOneWidget,
+      );
+    });
+
     testWidgets('can change layer selection', (tester) async {
-      await pumpRenderingLayerVisualizer(tester);
+      await pumpRasterStatsView(tester);
 
       final rasterStats = controller.rasterStats.value!;
       final layers = rasterStats.layerSnapshots;

packages/devtools_app/test/performance/raster_stats/raster_stats_test.dart

@@ -104,7 +104,9 @@ class FakeServiceManager extends Fake
     this.availableServices = const [],
     this.availableLibraries = const [],
     this.onVmServiceOpened,
-  }) {
+    Map<String, Response>? serviceExtensionResponses,
+  }) : serviceExtensionResponses =
+            serviceExtensionResponses ?? _defaultServiceExtensionResponses {
     this.service = service ?? createFakeService();
     mockConnectedApp(
       connectedApp!,
@@ -149,6 +151,12 @@ class FakeServiceManager extends Fake
 
   final Function? onVmServiceOpened;
 
+  final Map<String, Response> serviceExtensionResponses;
+
+  static final _defaultServiceExtensionResponses = <String, Response>{
+    isImpellerEnabled: Response.parse({'enabled': false})!,
+  };
+
   @override
   VmServiceWrapper? service;
 
@@ -195,6 +203,19 @@ class FakeServiceManager extends Fake
     when(state.isPaused).thenReturn(ValueNotifier(value));
   }
 
+  @override
+  Future<Response> callServiceExtensionOnMainIsolate(
+    String method, {
+    Map<String, dynamic>? args,
+  }) async {
+    if (!serviceExtensionResponses.containsKey(method)) {
+      throw UnimplementedError(
+        'Unimplemented response for service extension: $method',
+      );
+    }
+    return serviceExtensionResponses[method]!;
+  }
+
   @override
   ValueListenable<bool> registeredServiceListenable(String name) {
     if (availableServices.contains(name)) {