Reorganize the status/diagnostic pages

I moved several classes out of `diagnostics.dart` into their own
libraries under `pages`. I also moved one of the singling files into
`pages`. Several other sibling pages were moved to `utilities`. In the
process I needed to make a couple of methods public rather than private.

There are no functional changes.

I was going to split out the rest of the classes from `diagnostics.dart`
and `pages.dart` but I haven't yet decided whether they should all go
into a single directory or whether they should be in two directories.
The classes in `pages.dart` appear to be classes appropriate for any
web site generating code while those in `diagnostics.dart` are specific
to this web site, but it isn't clear to me that the abstraction is
helpful given that we only have one web site to build.

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

Author: bwilkerson

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

@@ -0,0 +1,53 @@
+// 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/status/diagnostics.dart';
+import 'package:analysis_server/src/status/pages.dart';
+import 'package:analyzer/src/util/performance/operation_performance.dart';
+
+class AnalysisDriverPage extends DiagnosticPageWithNav implements PostablePage {
+  static const _resetFormId = 'reset-driver-timers';
+
+  AnalysisDriverPage(DiagnosticsSite site)
+    : super(
+        site,
+        'analysis-driver',
+        'Analysis driver',
+        description:
+            'Timing statistics collected by the analysis driver scheduler since the last reset.',
+        indentInNav: true,
+      );
+
+  @override
+  Future<void> generateContent(Map<String, String> params) async {
+    // Output the current values.
+    var buffer = StringBuffer();
+    server.analysisDriverScheduler.accumulatedPerformance.write(buffer: buffer);
+    pre(() {
+      buf.write('<code>');
+      buf.write(escape('$buffer'));
+      buf.writeln('</code>');
+    });
+
+    // Add a button to reset the timers.
+    buf.write('''
+<form action="$path?$_resetFormId=true" method="post">
+<input type="submit" class="btn btn-danger" value="Reset Timers" />
+</form>
+''');
+  }
+
+  @override
+  Future<String> handlePost(Map<String, String> params) async {
+    if (params[_resetFormId]?.isNotEmpty ?? false) {
+      server
+          .analysisDriverScheduler
+          .accumulatedPerformance = OperationPerformanceImpl('<scheduler>');
+    }
+
+    return path;
+  }
+}

pkg/analysis_server/lib/src/status/pages/analysis_driver_page.dart

@@ -0,0 +1,50 @@
+// 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 'dart:io';
+
+import 'package:analysis_server/src/status/diagnostics.dart';
+import 'package:analysis_server/src/utilities/stream_string_stink.dart';
+
+class AnalysisPerformanceLogPage extends WebSocketLoggingPage {
+  AnalysisPerformanceLogPage(DiagnosticsSite site)
+    : super(
+        site,
+        'analysis-performance-log',
+        'Analysis performance log',
+        description: 'Real-time logging from the analysis performance log',
+      );
+
+  @override
+  Future<void> generateContent(Map<String, String> params) async {
+    writeWebSocketLogPanel();
+  }
+
+  @override
+  Future<void> handleWebSocket(WebSocket socket) async {
+    var logger = server.analysisPerformanceLogger;
+
+    // We were able to attach our temporary sink. Forward all data over the
+    // WebSocket and wait for it to close (this is done by the user clicking
+    // the Stop button or navigating away from the page).
+    var controller = StreamController<String>();
+    var sink = StreamStringSink(controller.sink);
+    try {
+      unawaited(socket.addStream(controller.stream));
+      logger.sink.addSink(sink);
+
+      // Wait for the socket to be closed so we can remove the secondary sink.
+      var completer = Completer<void>();
+      socket.listen(
+        null,
+        onDone: completer.complete,
+        onError: completer.complete,
+      );
+      await completer.future;
+    } finally {
+      logger.sink.removeSink(sink);
+    }
+  }
+}

pkg/analysis_server/lib/src/status/pages/analysis_performance_log_page.dart

@@ -0,0 +1,66 @@
+// 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/status/diagnostics.dart';
+import 'package:analysis_server/src/status/pages.dart';
+import 'package:analysis_server_plugin/src/correction/assist_performance.dart';
+import 'package:path/path.dart' as path;
+
+class AssistsPage extends DiagnosticPageWithNav with PerformanceChartMixin {
+  AssistsPage(DiagnosticsSite site)
+    : super(
+        site,
+        'assists',
+        'Assists',
+        description: 'Latency and timing statistics for getting assists.',
+        indentInNav: true,
+      );
+
+  path.Context get pathContext => server.resourceProvider.pathContext;
+
+  List<GetAssistsPerformance> get performanceItems =>
+      server.recentPerformance.getAssists.items.toList();
+
+  @override
+  Future<void> generateContent(Map<String, String> params) async {
+    var requests = performanceItems;
+
+    if (requests.isEmpty) {
+      blankslate('No assist requests recorded.');
+      return;
+    }
+
+    var fastCount =
+        requests.where((c) => c.elapsedInMilliseconds <= 100).length;
+    p(
+      '${requests.length} results; ${printPercentage(fastCount / requests.length)} within 100ms.',
+    );
+
+    drawChart(requests);
+
+    // Emit the data as a table
+    buf.writeln('<table>');
+    buf.writeln(
+      '<tr><th>Time</th><th align = "left" title="Time in correction producer `compute()` calls">Producer.compute()</th><th align = "left">Source</th><th>Snippet</th></tr>',
+    );
+
+    for (var request in requests) {
+      var shortName = pathContext.basename(request.path);
+      var (:time, :details) = producerTimeAndDetails(request);
+      buf.writeln(
+        '<tr>'
+        '<td class="pre right"><a href="/timing?id=${request.id}&kind=getAssists">'
+        '${formatLatencyTiming(request.elapsedInMilliseconds, request.requestLatency)}'
+        '</a></td>'
+        '<td><abbr title="$details">${printMilliseconds(time)}</abbr></td>'
+        '<td>${escape(shortName)}</td>'
+        '<td><code>${escape(request.snippet)}</code></td>'
+        '</tr>',
+      );
+    }
+    buf.writeln('</table>');
+  }
+}

pkg/analysis_server/lib/src/status/pages/assists_page.dart

@@ -0,0 +1,61 @@
+// 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/status/diagnostics.dart';
+import 'package:analysis_server/src/status/pages.dart';
+import 'package:analysis_server/src/status/utilities/ast_writer.dart';
+import 'package:analyzer/dart/analysis/results.dart';
+
+class AstPage extends DiagnosticPageWithNav {
+  String? _description;
+
+  AstPage(DiagnosticsSite site)
+    : super(site, 'ast', 'AST', description: 'The AST for a file.');
+
+  @override
+  String? get description => _description ?? super.description;
+
+  @override
+  bool get showInNav => false;
+
+  @override
+  Future<void> generateContent(Map<String, String> params) async {
+    var filePath = params['file'];
+    if (filePath == null) {
+      p('No file path provided.');
+      return;
+    }
+    var driver = server.getAnalysisDriver(filePath);
+    if (driver == null) {
+      p(
+        'The file <code>${escape(filePath)}</code> is not being analyzed.',
+        raw: true,
+      );
+      return;
+    }
+    var result = await driver.getResolvedUnit(filePath);
+    if (result is ResolvedUnitResult) {
+      var writer = AstWriter(buf);
+      result.unit.accept(writer);
+    } else {
+      p(
+        'An AST could not be produced for the file '
+        '<code>${escape(filePath)}</code>.',
+        raw: true,
+      );
+    }
+  }
+
+  @override
+  Future<void> generatePage(Map<String, String> params) async {
+    try {
+      _description = params['file'];
+      await super.generatePage(params);
+    } finally {
+      _description = null;
+    }
+  }
+}

pkg/analysis_server/lib/src/status/pages/ast_page.dart

@@ -0,0 +1,18 @@
+// 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/status/diagnostics.dart';
+
+class ClientPage extends DiagnosticPageWithNav {
+  ClientPage(super.site, [super.id = 'client', super.title = 'Client'])
+    : super(description: 'Information about the client.');
+
+  @override
+  Future<void> generateContent(Map<String, String> params) async {
+    h3('Client Diagnostic Information');
+    prettyJson(server.clientDiagnosticInformation);
+  }
+}

pkg/analysis_server/lib/src/status/pages/client_page.dart

@@ -0,0 +1,66 @@
+// 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/services/completion/completion_performance.dart';
+import 'package:analysis_server/src/status/diagnostics.dart';
+import 'package:analysis_server/src/status/pages.dart';
+import 'package:path/path.dart' as path;
+
+class CodeCompletionPage extends DiagnosticPageWithNav
+    with PerformanceChartMixin {
+  CodeCompletionPage(DiagnosticsSite site)
+    : super(
+        site,
+        'code-completion',
+        'Code Completion',
+        description: 'Latency statistics for code completion.',
+        indentInNav: true,
+      );
+
+  path.Context get pathContext => server.resourceProvider.pathContext;
+
+  List<CompletionPerformance> get performanceItems =>
+      server.recentPerformance.completion.items.toList();
+
+  @override
+  Future<void> generateContent(Map<String, String> params) async {
+    var completions = performanceItems;
+
+    if (completions.isEmpty) {
+      blankslate('No completions recorded.');
+      return;
+    }
+
+    var fastCount =
+        completions.where((c) => c.elapsedInMilliseconds <= 100).length;
+    p(
+      '${completions.length} results; ${printPercentage(fastCount / completions.length)} within 100ms.',
+    );
+
+    drawChart(completions);
+
+    // emit the data as a table
+    buf.writeln('<table>');
+    buf.writeln(
+      '<tr><th>Time</th><th>Computed Results</th><th>Transmitted Results</th><th>Source</th><th>Snippet</th></tr>',
+    );
+    for (var completion in completions) {
+      var shortName = pathContext.basename(completion.path);
+      buf.writeln(
+        '<tr>'
+        '<td class="pre right"><a href="/timing?id=${completion.id}&kind=completion">'
+        '${formatLatencyTiming(completion.elapsedInMilliseconds, completion.requestLatency)}'
+        '</a></td>'
+        '<td class="right">${completion.computedSuggestionCountStr}</td>'
+        '<td class="right">${completion.transmittedSuggestionCountStr}</td>'
+        '<td>${escape(shortName)}</td>'
+        '<td><code>${escape(completion.snippet)}</code></td>'
+        '</tr>',
+      );
+    }
+    buf.writeln('</table>');
+  }
+}