Version 2.19.0-405.0.dev

Merge ba662eb into dev

Author: Dart CI

pkg/analysis_server/lib/lsp_protocol/protocol_custom_generated.dart

@@ -307,16 +307,20 @@ class DartNotImportedCompletionResolutionInfo
   DartNotImportedCompletionResolutionInfo({
     required this.file,
     required this.libraryUri,
+    this.ref,
   });
   static DartNotImportedCompletionResolutionInfo fromJson(
       Map<String, Object?> json) {
     final fileJson = json['file'];
     final file = fileJson as String;
     final libraryUriJson = json['libraryUri'];
     final libraryUri = libraryUriJson as String;
+    final refJson = json['ref'];
+    final ref = refJson as String?;
     return DartNotImportedCompletionResolutionInfo(
       file: file,
       libraryUri: libraryUri,
+      ref: ref,
     );
   }
 
@@ -328,11 +332,19 @@ class DartNotImportedCompletionResolutionInfo
   /// The URI to be imported if this completion is selected.
   final String libraryUri;
 
+  /// The ElementLocation of the item being completed.
+  ///
+  /// This is used to provide documentation in the resolved response.
+  final String? ref;
+
   @override
   Map<String, Object?> toJson() {
     var result = <String, Object?>{};
     result['file'] = file;
     result['libraryUri'] = libraryUri;
+    if (ref != null) {
+      result['ref'] = ref;
+    }
     return result;
   }
 
@@ -342,8 +354,12 @@ class DartNotImportedCompletionResolutionInfo
           allowsUndefined: false, allowsNull: false)) {
         return false;
       }
-      return _canParseString(obj, reporter, 'libraryUri',
-          allowsUndefined: false, allowsNull: false);
+      if (!_canParseString(obj, reporter, 'libraryUri',
+          allowsUndefined: false, allowsNull: false)) {
+        return false;
+      }
+      return _canParseString(obj, reporter, 'ref',
+          allowsUndefined: true, allowsNull: false);
     } else {
       reporter.reportError(
           'must be of type DartNotImportedCompletionResolutionInfo');
@@ -356,13 +372,15 @@ class DartNotImportedCompletionResolutionInfo
     return other is DartNotImportedCompletionResolutionInfo &&
         other.runtimeType == DartNotImportedCompletionResolutionInfo &&
         file == other.file &&
-        libraryUri == other.libraryUri;
+        libraryUri == other.libraryUri &&
+        ref == other.ref;
   }
 
   @override
   int get hashCode => Object.hash(
         file,
         libraryUri,
+        ref,
       );
 
   @override

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

@@ -13,6 +13,7 @@ import 'package:analysis_server/src/lsp/mapping.dart';
 import 'package:analysis_server/src/provisional/completion/completion_core.dart';
 import 'package:analysis_server/src/services/completion/completion_performance.dart';
 import 'package:analysis_server/src/services/completion/dart/completion_manager.dart';
+import 'package:analysis_server/src/services/completion/dart/dart_completion_suggestion.dart';
 import 'package:analysis_server/src/services/completion/filtering/fuzzy_matcher.dart';
 import 'package:analysis_server/src/services/completion/yaml/analysis_options_generator.dart';
 import 'package:analysis_server/src/services/completion/yaml/fix_data_generator.dart';
@@ -455,12 +456,17 @@ class CompletionHandler extends MessageHandler<CompletionParams, CompletionList>
         // call later.
         CompletionItemResolutionInfo? resolutionInfo;
         final libraryUri = item.libraryUri;
+
         if (useNotImportedCompletions &&
             libraryUri != null &&
             (item.isNotImported ?? false)) {
+          final dartElement =
+              item is DartCompletionSuggestion ? item.dartElement : null;
+
           resolutionInfo = DartNotImportedCompletionResolutionInfo(
             file: unit.path,
             libraryUri: libraryUri,
+            ref: dartElement?.location?.encoding,
           );
         }
 

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

@@ -4,13 +4,13 @@
 
 import 'package:analysis_server/lsp_protocol/protocol.dart' hide Element;
 import 'package:analysis_server/src/computer/computer_hover.dart';
-import 'package:analysis_server/src/lsp/client_capabilities.dart';
 import 'package:analysis_server/src/lsp/constants.dart';
 import 'package:analysis_server/src/lsp/handlers/handlers.dart';
 import 'package:analysis_server/src/lsp/mapping.dart';
 import 'package:analyzer/dart/analysis/results.dart';
 import 'package:analyzer/dart/analysis/session.dart';
-import 'package:analyzer/dart/element/element.dart';
+import 'package:analyzer/src/dart/element/element.dart';
+import 'package:analyzer/src/utilities/extensions/analysis_session.dart';
 import 'package:analyzer_plugin/utilities/change_builder/change_builder_core.dart';
 
 class CompletionResolveHandler
@@ -47,13 +47,25 @@ class CompletionResolveHandler
     }
   }
 
-  Future<ErrorOr<CompletionItem>> resolveDartCompletion(
+  Future<ErrorOr<CompletionItem>> resolveDartNotImportedCompletion(
     CompletionItem item,
-    LspClientCapabilities clientCapabilities,
-    CancellationToken token, {
-    required String file,
-    required Uri libraryUri,
-  }) async {
+    DartNotImportedCompletionResolutionInfo data,
+    CancellationToken token,
+  ) async {
+    final clientCapabilities = server.clientCapabilities;
+    if (clientCapabilities == null) {
+      // This should not happen unless a client misbehaves.
+      return error(ErrorCodes.ServerNotInitialized,
+          'Requests not before server is initilized');
+    }
+
+    final file = data.file;
+    final libraryUri = Uri.parse(data.libraryUri);
+    final elementLocationReference = data.ref;
+    final elementLocation = elementLocationReference != null
+        ? ElementLocationImpl.con2(elementLocationReference)
+        : null;
+
     const timeout = Duration(milliseconds: 1000);
     var timer = Stopwatch()..start();
     _latestCompletionItem = item;
@@ -108,7 +120,9 @@ class CompletionResolveHandler
 
         // Look up documentation if we can get an element for this item.
         Either2<MarkupContent, String>? documentation;
-        final element = await _getElement(session, libraryUri, item);
+        final element = elementLocation != null
+            ? await session.locateElement(elementLocation)
+            : null;
         if (element != null) {
           final formats = clientCapabilities.completionDocumentationFormats;
           final dartDocInfo = server.getDartdocDirectiveInfoForSession(session);
@@ -172,27 +186,6 @@ class CompletionResolveHandler
     );
   }
 
-  Future<ErrorOr<CompletionItem>> resolveDartNotImportedCompletion(
-    CompletionItem item,
-    DartNotImportedCompletionResolutionInfo data,
-    CancellationToken token,
-  ) async {
-    final clientCapabilities = server.clientCapabilities;
-    if (clientCapabilities == null) {
-      // This should not happen unless a client misbehaves.
-      return error(ErrorCodes.ServerNotInitialized,
-          'Requests not before server is initilized');
-    }
-
-    return resolveDartCompletion(
-      item,
-      clientCapabilities,
-      token,
-      file: data.file,
-      libraryUri: Uri.parse(data.libraryUri),
-    );
-  }
-
   Future<ErrorOr<CompletionItem>> resolvePubPackageCompletion(
     CompletionItem item,
     PubPackageCompletionItemResolutionInfo data,
@@ -228,32 +221,4 @@ class CompletionResolveHandler
       data: item.data,
     ));
   }
-
-  /// Gets the [Element] for the completion item [item] in [libraryUri].
-  Future<Element?> _getElement(
-    AnalysisSession session,
-    Uri libraryUri,
-    CompletionItem item,
-  ) async {
-    // If filterText is different to the label, it's because label has
-    // parens/args appended so we should take the filterText to get the
-    // elements name without. We cannot use insertText as it may include
-    // snippets, whereas filterText is always just the pure string.
-    var name = item.filterText ?? item.label;
-
-    // The label might be `MyEnum.myValue`, but we need to find `MyEnum`.
-    if (name.contains('.')) {
-      name = name.substring(0, name.indexOf('.'));
-    }
-
-    // TODO(dantup): This is not handling default constructors or enums
-    //  correctly, so they will both show dart docs from the class/enum and not
-    //  the constructor/enum member. Extension members are not found at all and
-    //  will provide no docs.
-
-    final result = await session.getLibraryByUri(libraryUri.toString());
-    return result is LibraryElementResult
-        ? result.element.exportNamespace.get(name)
-        : null;
-  }
 }

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

@@ -0,0 +1,42 @@
+// Copyright (c) 2022, 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 'package:analysis_server/src/protocol_server.dart'
+    show CompletionSuggestion;
+import 'package:analyzer/dart/element/element.dart';
+
+/// An extension of [CompletionSuggestion] that includes additional
+/// Dart-specific fields that are not part of the JSON protocol.
+class DartCompletionSuggestion extends CompletionSuggestion {
+  final Element? dartElement;
+
+  DartCompletionSuggestion(
+    super.kind,
+    super.relevance,
+    super.completion,
+    super.selectionOffset,
+    super.selectionLength,
+    super.isDeprecated,
+    super.isPotential, {
+    super.displayText,
+    super.replacementOffset,
+    super.replacementLength,
+    super.docSummary,
+    super.docComplete,
+    super.declaringType,
+    super.defaultArgumentListString,
+    super.defaultArgumentListTextRanges,
+    super.element,
+    super.returnType,
+    super.parameterNames,
+    super.parameterTypes,
+    super.requiredParameterCount,
+    super.hasNamedParameters,
+    super.parameterName,
+    super.parameterType,
+    super.libraryUri,
+    super.isNotImported,
+    required this.dartElement,
+  });
+}

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

@@ -11,6 +11,7 @@ import 'package:analysis_server/src/protocol_server.dart'
     hide Element, ElementKind;
 import 'package:analysis_server/src/provisional/completion/dart/completion_dart.dart';
 import 'package:analysis_server/src/services/completion/dart/completion_manager.dart';
+import 'package:analysis_server/src/services/completion/dart/dart_completion_suggestion.dart';
 import 'package:analysis_server/src/services/completion/dart/feature_computer.dart';
 import 'package:analysis_server/src/services/completion/dart/utilities.dart';
 import 'package:analysis_server/src/utilities/extensions/ast.dart';
@@ -350,7 +351,7 @@ class SuggestionBuilder {
       required String displayText,
       required int selectionOffset,
     }) {
-      return CompletionSuggestion(
+      return DartCompletionSuggestion(
         CompletionSuggestionKind.INVOCATION,
         Relevance.closure,
         completion,
@@ -359,6 +360,7 @@ class SuggestionBuilder {
         false,
         false,
         displayText: displayText,
+        dartElement: type.element,
       );
     }
 
@@ -724,7 +726,7 @@ class SuggestionBuilder {
       buffer.write('$indent});');
 
       _addSuggestion(
-        CompletionSuggestion(
+        DartCompletionSuggestion(
           kind,
           relevance,
           buffer.toString(),
@@ -734,6 +736,7 @@ class SuggestionBuilder {
           false,
           // Let the user know that we are going to insert a complete statement.
           displayText: 'setState(() {});',
+          dartElement: method,
         ),
         textToMatchOverride: 'setState',
       );
@@ -812,7 +815,7 @@ class SuggestionBuilder {
       relevance = Relevance.namedArgument;
     }
 
-    var suggestion = CompletionSuggestion(
+    var suggestion = DartCompletionSuggestion(
         CompletionSuggestionKind.NAMED_ARGUMENT,
         relevance,
         completion,
@@ -822,7 +825,8 @@ class SuggestionBuilder {
         false,
         parameterName: name,
         parameterType: type,
-        replacementLength: replacementLength);
+        replacementLength: replacementLength,
+        dartElement: parameter);
     if (parameter is FieldFormalParameterElement) {
       _setDocumentation(suggestion, parameter);
       suggestion.element =
@@ -916,15 +920,16 @@ class SuggestionBuilder {
     var offsetDelta = targetId.offset + replacement.indexOf(completion);
     var displayText =
         displayTextBuffer.isNotEmpty ? displayTextBuffer.toString() : null;
-    var suggestion = CompletionSuggestion(
+    var suggestion = DartCompletionSuggestion(
         CompletionSuggestionKind.OVERRIDE,
         Relevance.override,
         completion,
         selectionRange.offset - offsetDelta,
         selectionRange.length,
         element.hasDeprecated,
         false,
-        displayText: displayText);
+        displayText: displayText,
+        dartElement: element);
     suggestion.element = protocol.convertElement(element,
         withNullability: _isNonNullableByDefault);
     _addSuggestion(
@@ -1418,6 +1423,7 @@ class SuggestionBuilder {
       documentation: documentation,
       defaultArgumentList: defaultArgumentList,
       element: suggestedElement,
+      dartElement: element,
     );
   }
 
@@ -1651,7 +1657,7 @@ class _CompletionSuggestionBuilderImpl implements CompletionSuggestionBuilder {
 
   @override
   CompletionSuggestion build() {
-    return CompletionSuggestion(
+    return DartCompletionSuggestion(
       kind,
       relevance,
       completion,
@@ -1672,6 +1678,7 @@ class _CompletionSuggestionBuilderImpl implements CompletionSuggestionBuilder {
       defaultArgumentListTextRanges: element.defaultArgumentList?.ranges,
       libraryUri: libraryUriStr,
       isNotImported: isNotImported ? true : null,
+      dartElement: element.dartElement,
     );
   }
 }
@@ -1691,6 +1698,7 @@ class _ElementCompletionData {
   CompletionDefaultArgumentList? defaultArgumentList;
   final _ElementDocumentation? documentation;
   final protocol.Element element;
+  final Element dartElement;
 
   _ElementCompletionData({
     required this.completion,
@@ -1704,6 +1712,7 @@ class _ElementCompletionData {
     required this.defaultArgumentList,
     required this.documentation,
     required this.element,
+    required this.dartElement,
   });
 }