[analytics] track time in fix producer compute()s

Adds some insight into fix producer `compute` calls to the `GetFixes` diagnostics page.

See updated screenshot in #60258.

Bug: #60258
Change-Id: I5d8c1911e86ef02b8d543fcda367b3e9aa6544f6
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/414341
Reviewed-by: Brian Wilkerson <[email protected]>
Commit-Queue: Phil Quitslund <[email protected]>

Author: pq

pkg/analysis_server/lib/src/handler/legacy/edit_get_fixes.dart

@@ -212,6 +212,7 @@ class EditGetFixesHandler extends LegacyHandler
                 content: unitResult.content,
                 offset: offset,
                 requestLatency: peformanceTracker.computeTime!.inMilliseconds,
+                producerTimings: peformanceTracker.producerTimings,
               ),
             );
           } on InconsistentAnalysisException {

pkg/analysis_server/lib/src/lsp/handlers/code_actions/dart.dart

@@ -186,7 +186,6 @@ class DartCodeActionsProducer extends AbstractCodeActionsProducer {
           error: error,
         );
 
-        // TODO(pq): move this timer UP?
         var peformanceTracker = FixPerformance();
 
         var fixes = await computeFixes(context, performance: peformanceTracker);
@@ -199,6 +198,7 @@ class DartCodeActionsProducer extends AbstractCodeActionsProducer {
               content: unitResult.content,
               offset: offset,
               requestLatency: peformanceTracker.computeTime!.inMilliseconds,
+              producerTimings: peformanceTracker.producerTimings,
             ),
           );
         }

pkg/analysis_server/lib/src/services/correction/fix_performance.dart

@@ -3,6 +3,7 @@
 // BSD-style license that can be found in the LICENSE file.
 
 import 'package:analysis_server/src/server/performance.dart';
+import 'package:analysis_server_plugin/src/correction/fix_processor.dart';
 
 // TODO(pq): update to share w/ completion_performance
 /// Compute a string representing a get fixes request at the
@@ -38,13 +39,15 @@ String _computeSourceSnippet(String contents, int offset) {
 class GetFixesPerformance extends RequestPerformance {
   final String path;
   final String snippet;
+  final List<ProducerTiming> producerTimings;
 
   GetFixesPerformance({
     required super.performance,
     required this.path,
     super.requestLatency,
     required String content,
     required int offset,
+    required this.producerTimings,
   }) : snippet = _computeSourceSnippet(content, offset),
        super(operation: 'GetFixes');
 

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

@@ -1571,14 +1571,19 @@ class GetFixesPage extends DiagnosticPageWithNav with PerformanceChartMixin {
 
     // Emit the data as a table
     buf.writeln('<table>');
-    buf.writeln('<tr><th>Time</th><th>Source</th><th>Snippet</th></tr>');
+    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 (producerTime, producerDetails) = _producerDetails(request);
       buf.writeln(
         '<tr>'
         '<td class="pre right"><a href="/timing?id=${request.id}&kind=getFixes">'
         '${_formatTiming(request)}'
         '</a></td>'
+        '<td><abbr title="$producerDetails">${printMilliseconds(producerTime)}</abbr></td>'
         '<td>${escape(shortName)}</td>'
         '<td><code>${escape(request.snippet)}</code></td>'
         '</tr>',
@@ -1601,6 +1606,24 @@ class GetFixesPage extends DiagnosticPageWithNav with PerformanceChartMixin {
 
     return buffer.toString();
   }
+
+  (int, String) _producerDetails(GetFixesPerformance request) {
+    var details = StringBuffer();
+
+    var totalProducerTime = 0;
+    var producerTimings = request.producerTimings;
+
+    for (var timing
+        in producerTimings.sortedBy((t) => t.elapsedTime).reversed) {
+      var producerTime = timing.elapsedTime;
+      totalProducerTime += producerTime;
+      details.write(timing.className);
+      details.write(': ');
+      details.writeln(printMilliseconds(producerTime));
+    }
+
+    return (totalProducerTime, details.toString());
+  }
 }
 
 class LspCapabilitiesPage extends DiagnosticPageWithNav {

pkg/analysis_server_plugin/lib/src/correction/fix_processor.dart

@@ -15,30 +15,42 @@ import 'package:analyzer_plugin/utilities/change_builder/conflicting_edit_except
 Future<List<Fix>> computeFixes(DartFixContext context,
     {FixPerformance? performance}) async {
   return [
-    ...await FixProcessor(context).compute(performance: performance),
+    ...await FixProcessor(context, performance: performance).compute(),
     ...await FixInFileProcessor(context).compute(),
   ];
 }
 
+/// Timing information for a producer's call to `compute()`.
+typedef ProducerTiming = ({
+  /// The producer class name.
+  String className,
+
+  /// The time elapsed during `compute()`.
+  int elapsedTime,
+});
+
 /// A callback for recording fix request timings.
 class FixPerformance {
   Duration? computeTime;
+  List<ProducerTiming> producerTimings = [];
 }
 
 /// The computer for Dart fixes.
 class FixProcessor {
   final DartFixContext _fixContext;
+  final FixPerformance? _performance;
+  final Stopwatch _timer = Stopwatch();
 
   final List<Fix> _fixes = <Fix>[];
 
-  FixProcessor(this._fixContext);
+  FixProcessor(this._fixContext, {FixPerformance? performance})
+      : _performance = performance;
 
-  Future<List<Fix>> compute({FixPerformance? performance}) async {
-    var timer = Stopwatch();
-    timer.start();
+  Future<List<Fix>> compute() async {
+    _timer.start();
     await _addFromProducers();
-    timer.stop();
-    performance?.computeTime = timer.elapsed;
+    _timer.stop();
+    _performance?.computeTime = _timer.elapsed;
     return _fixes;
   }
 
@@ -74,7 +86,18 @@ class FixProcessor {
           ChangeBuilder(workspace: _fixContext.workspace, eol: producer.eol);
       try {
         var fixKind = producer.fixKind;
-        await producer.compute(builder);
+
+        if (_performance != null) {
+          var startTime = _timer.elapsedMilliseconds;
+          await producer.compute(builder);
+          _performance.producerTimings.add((
+            className: producer.runtimeType.toString(),
+            elapsedTime: _timer.elapsedMilliseconds - startTime,
+          ));
+        } else {
+          await producer.compute(builder);
+        }
+
         assert(
           !producer.canBeAppliedAcrossSingleFile || producer.fixKind == fixKind,
           'Producers used in bulk fixes must not modify the FixKind during '