DAS plugins: Wire up initial screen for new plugins.

This renames the old screen, "Legacy plugins" and adds a new screen,
"Plugins". On the new plugins screen, we ask the plugins isolate(s) for
their plugins details, and print the following, for eadh plugin:

* the plugin's name
* the names of the registered lint rules
* the names of the registered warning rules
* the IDs and "messages" of the registered assists
* the IDs and "messages" and associated diagnostic codes of the
  registered quick fixes

More to come in follow ups:

* The resolved versions of plugin packages (coming from package_config.json)

Change-Id: Ic3dc4c5bffa64fd4da4097c042a847cc064e41ce
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/447763
Commit-Queue: Samuel Rawlins <[email protected]>
Reviewed-by: Brian Wilkerson <[email protected]>

Author: srawlins

pkg/analysis_server/doc/api.html

@@ -177,6 +177,19 @@ final Matcher isAnalysisStatus = LazyMatcher(
   ),
 );
 
+/// AssistDescription
+///
+/// {
+///   "id": String
+///   "message": String
+/// }
+final Matcher isAssistDescription = LazyMatcher(
+  () => MatchesJsonObject('AssistDescription', {
+    'id': isString,
+    'message': isString,
+  }),
+);
+
 /// BulkFix
 ///
 /// {
@@ -588,6 +601,21 @@ final Matcher isFileKind = MatchesEnum('FileKind', ['LIBRARY', 'PART']);
 /// String
 final Matcher isFilePath = isString;
 
+/// FixDescription
+///
+/// {
+///   "id": String
+///   "message": String
+///   "codes": List<String>
+/// }
+final Matcher isFixDescription = LazyMatcher(
+  () => MatchesJsonObject('FixDescription', {
+    'id': isString,
+    'message': isString,
+    'codes': isListOf(isString),
+  }),
+);
+
 /// FlutterOutline
 ///
 /// {
@@ -1358,6 +1386,25 @@ final Matcher isParameterKind = MatchesEnum('ParameterKind', [
   'REQUIRED_POSITIONAL',
 ]);
 
+/// PluginDetails
+///
+/// {
+///   "name": String
+///   "lintRules": List<String>
+///   "warningRules": List<String>
+///   "assists": List<AssistDescription>
+///   "fixes": List<FixDescription>
+/// }
+final Matcher isPluginDetails = LazyMatcher(
+  () => MatchesJsonObject('PluginDetails', {
+    'name': isString,
+    'lintRules': isListOf(isString),
+    'warningRules': isListOf(isString),
+    'assists': isListOf(isAssistDescription),
+    'fixes': isListOf(isFixDescription),
+  }),
+);
+
 /// Position
 ///
 /// {

pkg/analysis_server/integration_test/support/protocol_matchers.dart

@@ -53,13 +53,16 @@ class PluginIsolate {
 
   CaughtException? _exception;
 
+  bool isLegacy;
+
   PluginIsolate(
     this._path,
     this.executionPath,
     this.packagesPath,
     this._notificationManager,
-    this._instrumentationService,
-  );
+    this._instrumentationService, {
+    required this.isLegacy,
+  });
 
   /// The data known about this plugin, for instrumentation and exception
   /// purposes.
@@ -141,6 +144,25 @@ class PluginIsolate {
     _notificationManager.handlePluginError(message);
   }
 
+  /// Requests plugin details from the plugin isolate.
+  Future<PluginDetailsResult?> requestDetails() async {
+    if (currentSession case PluginSession currentSession) {
+      Response response;
+      try {
+        response = await currentSession
+            .sendRequest(PluginDetailsParams())
+            .timeout(const Duration(seconds: 5));
+      } on TimeoutException {
+        // TODO(srawlins): Return a `PluginDetailsResult` with a specific error?
+        return null;
+      }
+      if (response.error != null) throw response.error!;
+      return PluginDetailsResult.fromResponse(response);
+    } else {
+      return null;
+    }
+  }
+
   /// If the plugin is currently running, sends a request based on the given
   /// [params] to the plugin.
   ///

pkg/analysis_server/lib/src/plugin/plugin_isolate.dart

@@ -127,7 +127,15 @@ class PluginManager {
     this.instrumentationService,
   );
 
-  /// Return a list of all of the plugins that are currently known.
+  /// All of the legacy plugins that are currently known.
+  List<PluginIsolate> get legacyPluginIsolates =>
+      pluginIsolates.where((p) => p.isLegacy).toList();
+
+  /// All of the "new" plugins that are currently known.
+  List<PluginIsolate> get newPluginIsolates =>
+      pluginIsolates.where((p) => !p.isLegacy).toList();
+
+  /// All of the plugins that are currently known.
   List<PluginIsolate> get pluginIsolates => _pluginMap.values.toList();
 
   /// Stream emitting an event when known [pluginIsolates] change.
@@ -159,6 +167,7 @@ class PluginManager {
           null,
           _notificationManager,
           instrumentationService,
+          isLegacy: isLegacyPlugin,
         );
         pluginIsolate.reportException(CaughtException(exception, stackTrace));
         _pluginMap[path] = pluginIsolate;
@@ -170,6 +179,7 @@ class PluginManager {
         pluginFiles.packageConfig.path,
         _notificationManager,
         instrumentationService,
+        isLegacy: isLegacyPlugin,
       );
       _pluginMap[path] = pluginIsolate;
       try {

pkg/analysis_server/lib/src/plugin/plugin_manager.dart

@@ -71,7 +71,7 @@ environment:
 dependencies:
   # The version of the analysis_server_plugin package that matches the protocol
   # used by the active analysis_server.
-  analysis_server_plugin: ^0.2.0
+  analysis_server_plugin: ^0.3.0
 ''');
 
     for (var configuration in _configurations) {

pkg/analysis_server/lib/src/plugin2/generator.dart

@@ -29,6 +29,7 @@ import 'package:analysis_server/src/status/pages/exceptions_page.dart';
 import 'package:analysis_server/src/status/pages/feedback_page.dart';
 import 'package:analysis_server/src/status/pages/file_byte_store_timing_page.dart';
 import 'package:analysis_server/src/status/pages/fixes_page.dart';
+import 'package:analysis_server/src/status/pages/legacy_plugins_page.dart';
 import 'package:analysis_server/src/status/pages/lsp_capabilities_page.dart';
 import 'package:analysis_server/src/status/pages/lsp_client_page.dart';
 import 'package:analysis_server/src/status/pages/lsp_registrations_page.dart';
@@ -440,6 +441,7 @@ td.pre {
     var server = socketServer.analysisServer;
     if (server != null) {
       pages.add(PluginsPage(this, server));
+      pages.add(LegacyPluginsPage(this, server));
     }
     if (server is LegacyAnalysisServer) {
       pages.add(ClientPage(this));

pkg/analysis_server/lib/src/status/diagnostics.dart

@@ -0,0 +1,115 @@
+// Copyright (c) 2017, the Dart project authors. Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+import 'dart:async';
+
+import 'package:analysis_server/src/analysis_server.dart';
+import 'package:analysis_server/src/plugin/plugin_manager.dart';
+import 'package:analysis_server/src/status/diagnostics.dart';
+import 'package:analysis_server/src/status/utilities/string_extensions.dart';
+import 'package:analyzer/dart/analysis/context_root.dart';
+import 'package:path/path.dart' as path;
+
+class LegacyPluginsPage extends DiagnosticPageWithNav {
+  @override
+  AnalysisServer server;
+
+  LegacyPluginsPage(DiagnosticsSite site, this.server)
+    : super(
+        site,
+        'legacy-plugins',
+        'Legacy Plugins',
+        description: 'Legacy plugins in use.',
+      );
+
+  @override
+  Future<void> generateContent(Map<String, String> params) async {
+    h3('Legacy analysis plugins');
+    var plugins = server.pluginManager.legacyPluginIsolates;
+
+    if (plugins.isEmpty) {
+      blankslate('No known legacy analysis plugins.');
+      return;
+    }
+
+    plugins.sort((a, b) => a.pluginId.compareTo(b.pluginId));
+    for (var plugin in plugins) {
+      var id = plugin.pluginId;
+      var data = plugin.data;
+
+      var components = path.split(id);
+      var length = components.length;
+      var name = switch (length) {
+        0 => 'unknown plugin',
+        > 2 => components[length - 3],
+        _ => components[length - 1],
+      };
+      h4(name);
+
+      _emitTable([
+        ['Bootstrap package path', id],
+        if (plugin.executionPath case var executionPath?)
+          ['Execution path:', executionPath.wordBreakOnSlashes],
+        if (plugin.packagesPath case var packagesPath?)
+          ['Packages file path', packagesPath.wordBreakOnSlashes],
+      ]);
+
+      if (data.name == null) {
+        if (plugin.exception != null) {
+          p('Not running due to:');
+          pre(() {
+            buf.write(plugin.exception);
+          });
+        } else {
+          p(
+            'Not running for unknown reason (no exception was caught while '
+            'starting).',
+          );
+        }
+        return;
+      }
+
+      p('Name: ${data.name}');
+      p('Version: ${data.version}');
+      p('Associated contexts:');
+      var contexts = plugin.contextRoots;
+      if (contexts.isEmpty) {
+        blankslate('none');
+      } else {
+        ul(contexts.toList(), (ContextRoot root) {
+          buf.writeln(root.root);
+        });
+      }
+
+      p('Performance:');
+      var responseTimes = PluginManager.pluginResponseTimes[plugin] ?? {};
+      var entries = responseTimes.entries.toList();
+      entries.sort((first, second) => first.key.compareTo(second.key));
+      for (var entry in entries) {
+        var requestName = entry.key;
+        var data = entry.value;
+        // TODO(brianwilkerson): Consider displaying these times as a graph,
+        //  similar to the one in CompletionPage.generateContent.
+        var buffer = StringBuffer();
+        buffer.write(requestName);
+        buffer.write(' ');
+        buffer.write(data.toAnalyticsString());
+        p(buffer.toString());
+      }
+    }
+  }
+
+  void _emitTable(List<List<String>> data) {
+    buf.writeln('<table>');
+    for (var row in data) {
+      buf.writeln('<tr>');
+      for (var value in row) {
+        buf.writeln('<td>$value</td>');
+      }
+      buf.writeln('</tr>');
+    }
+
+    buf.writeln('</table>');
+  }
+}