Completion. Use CompletionSuggestionBuilder in completion metrics, faster.

For sdk/pkg/analyzer_cli

Before: 0:01:32.542000
After:  0:00:33.254000

So, about 3 times faster.

Change-Id: I8eae44eeefd5624f88a42fe37b8ae1c29427ee49
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/356310
Reviewed-by: Brian Wilkerson <[email protected]>
Commit-Queue: Konstantin Shcheglov <[email protected]>

Author: scheglov

pkg/analysis_server/lib/src/services/completion/dart/suggestion_builder.dart

@@ -31,6 +31,10 @@ abstract class CompletionSuggestionBuilder {
   /// See [CompletionSuggestion.completion].
   String get completion;
 
+  /// The kind of the element, if there is the associated element.
+  /// We use it for completion metrics, to avoid [build].
+  protocol.ElementKind? get elementKind;
+
   /// The key used to de-duplicate suggestions.
   String get key => completion;
 
@@ -1669,6 +1673,9 @@ class ValueCompletionSuggestionBuilder implements CompletionSuggestionBuilder {
   @override
   String get completion => _suggestion.completion;
 
+  @override
+  protocol.ElementKind? get elementKind => _suggestion.element?.kind;
+
   @override
   String get key => completion;
 
@@ -1716,6 +1723,9 @@ class _CompletionSuggestionBuilderImpl implements CompletionSuggestionBuilder {
     required this.isNotImported,
   });
 
+  @override
+  protocol.ElementKind? get elementKind => convertElementKind(orgElement.kind);
+
   // TODO(scheglov): implement better key for not-yet-imported
   @override
   String get key {

pkg/analysis_server/lib/src/services/completion/dart/utilities.dart

@@ -5,9 +5,9 @@
 /// A collection of utility methods used by completion contributors.
 library;
 
-import 'package:analysis_server/src/protocol_server.dart'
-    show CompletionSuggestion, Location;
+import 'package:analysis_server/src/protocol_server.dart' show Location;
 import 'package:analysis_server/src/services/completion/dart/completion_manager.dart';
+import 'package:analysis_server/src/services/completion/dart/suggestion_builder.dart';
 import 'package:analysis_server/src/utilities/extensions/ast.dart';
 import 'package:analyzer/dart/analysis/code_style_options.dart';
 import 'package:analyzer/dart/ast/ast.dart';
@@ -23,7 +23,7 @@ const DYNAMIC = 'dynamic';
 
 /// Sort by relevance first, highest to lowest, and then by the completion
 /// alphabetically.
-Comparator<CompletionSuggestion> completionComparator = (a, b) {
+Comparator<CompletionSuggestionBuilder> completionComparator = (a, b) {
   if (a.relevance == b.relevance) {
     return a.completion.compareTo(b.completion);
   }

pkg/analysis_server/tool/code_completion/completion_metrics.dart

@@ -523,7 +523,7 @@ class CompletionMetrics {
   void recordShadowedCompletion(
       String? completionLocation,
       ExpectedCompletion expectedCompletion,
-      protocol.CompletionSuggestion closeMatchSuggestion) {
+      CompletionSuggestionLite closeMatchSuggestion) {
     shadowedCompletions
         .putIfAbsent(completionLocation ?? 'unknown', () => [])
         .add(ShadowedCompletion(expectedCompletion, closeMatchSuggestion));
@@ -863,7 +863,7 @@ class CompletionQualityMetricsComputer extends CompletionMetricsComputer {
       MetricsSuggestionListener listener,
       ExpectedCompletion expectedCompletion,
       String? completionLocation,
-      List<protocol.CompletionSuggestion> suggestions,
+      List<CompletionSuggestionLite> suggestions,
       CompletionMetrics metrics,
       int elapsedMS) {
     var place = placementInSuggestionList(suggestions, expectedCompletion);
@@ -925,7 +925,7 @@ class CompletionQualityMetricsComputer extends CompletionMetricsComputer {
 
       if (options.printMissedCompletionDetails ||
           options.printShadowedCompletionDetails) {
-        protocol.CompletionSuggestion? closeMatchSuggestion;
+        CompletionSuggestionLite? closeMatchSuggestion;
         for (var suggestion in suggestions) {
           if (suggestion.completion == expectedCompletion.completion) {
             closeMatchSuggestion = suggestion;
@@ -1376,8 +1376,8 @@ class CompletionQualityMetricsComputer extends CompletionMetricsComputer {
   @override
   void setupForResolution(AnalysisContext context) {}
 
-  int _computeCharsBeforeTop(ExpectedCompletion target,
-      List<protocol.CompletionSuggestion> suggestions,
+  int _computeCharsBeforeTop(
+      ExpectedCompletion target, List<CompletionSuggestionLite> suggestions,
       {int minRank = 1}) {
     var rank = placementInSuggestionList(suggestions, target).rank;
     if (rank <= minRank) {
@@ -1397,15 +1397,13 @@ class CompletionQualityMetricsComputer extends CompletionMetricsComputer {
 
   /// Computes completion suggestions for [dartRequest], and returns the
   /// suggestions, sorted by rank and then by completion text.
-  Future<List<protocol.CompletionSuggestion>> _computeCompletionSuggestions(
+  Future<List<CompletionSuggestionLite>> _computeCompletionSuggestions(
       MetricsSuggestionListener listener,
       OperationPerformanceImpl performance,
       DartCompletionRequest dartRequest,
       NotImportedSuggestions notImportedSuggestions) async {
-    List<protocol.CompletionSuggestion> suggestions;
-
     var budget = CompletionBudget(Duration(seconds: 30));
-    var serverSuggestions = await DartCompletionManager(
+    var suggestions = await DartCompletionManager(
       budget: budget,
       listener: listener,
       notImportedSuggestions: notImportedSuggestions,
@@ -1414,19 +1412,16 @@ class CompletionQualityMetricsComputer extends CompletionMetricsComputer {
       performance,
       useFilter: true,
     );
-    suggestions = serverSuggestions.map((serverSuggestion) {
-      return serverSuggestion.build();
-    }).toList();
 
     // Note that some routes sort suggestions before responding differently.
     // The Cider and legacy handlers use [fuzzyFilterSort], which does not match
     // [completionComparator].
     suggestions.sort(completionComparator);
-    return suggestions;
+    return suggestions.map(CompletionSuggestionLite.fromBuilder).toList();
   }
 
-  List<protocol.CompletionSuggestion> _filterSuggestions(
-      String prefix, List<protocol.CompletionSuggestion> suggestions) {
+  List<CompletionSuggestionLite> _filterSuggestions(
+      String prefix, List<CompletionSuggestionLite> suggestions) {
     // TODO(brianwilkerson): Replace this with a more realistic filtering
     //  algorithm.
     return suggestions
@@ -1521,7 +1516,7 @@ class CompletionQualityMetricsComputer extends CompletionMetricsComputer {
   ///
   /// If [expectedCompletion] is not found, `Place.none()` is returned.
   static Place placementInSuggestionList(
-      List<protocol.CompletionSuggestion> suggestions,
+      List<CompletionSuggestionLite> suggestions,
       ExpectedCompletion expectedCompletion) {
     for (var i = 0; i < suggestions.length; i++) {
       if (expectedCompletion.matches(suggestions[i])) {
@@ -1705,6 +1700,78 @@ class CompletionResult {
   }
 }
 
+/// Enough data from [CompletionSuggestionBuilder] to compute metrics.
+///
+/// It excludes expensive parts that are not necessary, such as element
+/// properties.
+class CompletionSuggestionLite {
+  final String completion;
+  final protocol.ElementKind? elementKind;
+  final int relevance;
+  final protocol.CompletionSuggestionKind kind;
+
+  CompletionSuggestionLite({
+    required this.completion,
+    required this.elementKind,
+    required this.relevance,
+    required this.kind,
+  });
+
+  factory CompletionSuggestionLite.fromBuilder(
+    CompletionSuggestionBuilder builder,
+  ) {
+    return CompletionSuggestionLite(
+      completion: builder.completion,
+      elementKind: builder.elementKind,
+      relevance: builder.relevance,
+      kind: builder.kind,
+    );
+  }
+
+  factory CompletionSuggestionLite.fromJson(Map<String, Object?> map) {
+    var elementKindStr = map['elementKind'] as String?;
+
+    return CompletionSuggestionLite(
+      completion: map['completion'] as String,
+      elementKind: elementKindStr != null
+          ? protocol.ElementKind.fromJson(
+              ResponseDecoder(null),
+              '',
+              elementKindStr,
+            )
+          : null,
+      relevance: map['relevance'] as int,
+      kind: protocol.CompletionSuggestionKind.fromJson(
+        ResponseDecoder(null),
+        '',
+        map['kind'] as String,
+      ),
+    );
+  }
+
+  @override
+  int get hashCode => Object.hash(completion, kind);
+
+  @override
+  bool operator ==(Object other) {
+    return other is CompletionSuggestionLite &&
+        other.completion == completion &&
+        other.kind == kind &&
+        other.elementKind == elementKind &&
+        other.relevance == relevance;
+  }
+
+  /// Return a map used to represent this suggestion data in a JSON structure.
+  Map<String, Object?> toJson() {
+    return {
+      'completion': completion,
+      if (elementKind case var elementKind?) 'elementKind': elementKind.name,
+      'relevance': relevance,
+      'kind': kind.name,
+    };
+  }
+}
+
 /// The data to be printed on a single line in the table of mrr values per
 /// completion location.
 class LocationTableLine {
@@ -1738,7 +1805,7 @@ class MetricsSuggestionListener implements SuggestionListener {
     0.0
   ];
 
-  Map<protocol.CompletionSuggestion, List<double>> featureMap = Map.identity();
+  Map<CompletionSuggestionLite, List<double>> featureMap = Map.identity();
 
   List<double> cachedFeatures = noFeatures;
 
@@ -1747,8 +1814,8 @@ class MetricsSuggestionListener implements SuggestionListener {
   String? missingCompletionLocationTable;
 
   @override
-  void builtSuggestion(CompletionSuggestionBuilder suggestionBuilder) {
-    var suggestion = suggestionBuilder.build();
+  void builtSuggestion(CompletionSuggestionBuilder builder) {
+    var suggestion = CompletionSuggestionLite.fromBuilder(builder);
     featureMap[suggestion] = cachedFeatures;
     cachedFeatures = noFeatures;
   }
@@ -1826,15 +1893,15 @@ class RelevanceTables {
 class ShadowedCompletion {
   final ExpectedCompletion expectedCompletion;
 
-  final protocol.CompletionSuggestion closeMatchSuggestion;
+  final CompletionSuggestionLite closeMatchSuggestion;
 
   ShadowedCompletion(this.expectedCompletion, this.closeMatchSuggestion);
 }
 
 /// The information being remembered about an individual suggestion.
 class SuggestionData {
   /// The suggestion that was produced.
-  protocol.CompletionSuggestion suggestion;
+  CompletionSuggestionLite suggestion;
 
   /// The values of the features used to compute the suggestion.
   List<double> features;
@@ -1844,9 +1911,11 @@ class SuggestionData {
   /// Return an instance extracted from the decoded JSON [map].
   factory SuggestionData.fromJson(Map<String, dynamic> map) {
     return SuggestionData(
-        protocol.CompletionSuggestion.fromJson(ResponseDecoder(null), '',
-            map['suggestion'] as Map<String, dynamic>),
-        (map['features'] as List<dynamic>).cast<double>());
+      CompletionSuggestionLite.fromJson(
+        map['suggestion'] as Map<String, Object?>,
+      ),
+      (map['features'] as List<dynamic>).cast<double>(),
+    );
   }
 
   /// Return a map used to represent this suggestion data in a JSON structure.

pkg/analysis_server/tool/code_completion/visitors.dart

@@ -13,6 +13,8 @@ import 'package:analyzer/dart/element/element.dart' as element;
 import 'package:analyzer/dart/element/type.dart';
 import 'package:analyzer/source/line_info.dart';
 
+import 'completion_metrics.dart';
+
 class ExpectedCompletion {
   final String _filePath;
 
@@ -88,14 +90,14 @@ class ExpectedCompletion {
 
   SyntacticEntity get syntacticEntity => _entity;
 
-  bool matches(protocol.CompletionSuggestion completionSuggestion) {
+  bool matches(CompletionSuggestionLite completionSuggestion) {
     if (completionSuggestion.completion == completion) {
       if (kind != null && completionSuggestion.kind != kind) {
         return false;
       }
       if (elementKind != null &&
-          completionSuggestion.element?.kind != null &&
-          completionSuggestion.element?.kind != elementKind) {
+          completionSuggestion.elementKind != null &&
+          completionSuggestion.elementKind != elementKind) {
         return false;
       }
       return true;