[Analyzer] Add code completion for Pub package names

Change-Id: I0fa8fb1c2801e2acb2d2cf75f7efecf4f9058eeb
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/176120
Reviewed-by: Brian Wilkerson <[email protected]>
Reviewed-by: Jonas Jensen <[email protected]>
Commit-Queue: Brian Wilkerson <[email protected]>

Author: DanTup

pkg/analysis_server/lib/src/analysis_server.dart

@@ -54,6 +54,7 @@ import 'package:analyzer/src/util/file_paths.dart' as file_paths;
 import 'package:analyzer_plugin/protocol/protocol_common.dart' hide Element;
 import 'package:analyzer_plugin/src/utilities/navigation/navigation.dart';
 import 'package:analyzer_plugin/utilities/navigation/navigation_dart.dart';
+import 'package:http/http.dart' as http;
 import 'package:telemetry/crash_reporting.dart';
 import 'package:telemetry/telemetry.dart' as telemetry;
 import 'package:watcher/watcher.dart';
@@ -127,6 +128,7 @@ class AnalysisServer extends AbstractAnalysisServer {
     DartSdkManager sdkManager,
     CrashReportingAttachmentsBuilder crashReportingAttachmentsBuilder,
     InstrumentationService instrumentationService, {
+    http.Client httpClient,
     RequestStatisticsHelper requestStatistics,
     DiagnosticServer diagnosticServer,
     this.detachableFileSystemManager,
@@ -137,6 +139,7 @@ class AnalysisServer extends AbstractAnalysisServer {
           crashReportingAttachmentsBuilder,
           baseResourceProvider,
           instrumentationService,
+          httpClient,
           NotificationManager(channel, baseResourceProvider.pathContext),
           requestStatistics: requestStatistics,
         ) {
@@ -421,6 +424,14 @@ class AnalysisServer extends AbstractAnalysisServer {
 
   /// Set the priority files to the given [files].
   void setPriorityFiles(String requestId, List<String> files) {
+    bool isPubspec(String filePath) =>
+        file_paths.isPubspecYaml(resourceProvider.pathContext, filePath);
+
+    // When a pubspec is opened, trigger package name caching for completion.
+    if (!pubPackageService.isRunning && files.any(isPubspec)) {
+      pubPackageService.beginPackageNamePreload();
+    }
+
     priorityFiles.clear();
     priorityFiles.addAll(files);
     // Set priority files in drivers.
@@ -429,7 +440,12 @@ class AnalysisServer extends AbstractAnalysisServer {
     });
   }
 
+  @override
   Future<void> shutdown() {
+    super.shutdown();
+
+    pubApi.close();
+
     if (options.analytics != null) {
       options.analytics
           .waitForLastPing(timeout: Duration(milliseconds: 200))

pkg/analysis_server/lib/src/analysis_server_abstract.dart

@@ -4,6 +4,7 @@
 
 import 'dart:core';
 import 'dart:io' as io;
+import 'dart:io';
 
 import 'package:analysis_server/src/analysis_server.dart';
 import 'package:analysis_server/src/collections.dart';
@@ -15,6 +16,8 @@ import 'package:analysis_server/src/plugin/plugin_watcher.dart';
 import 'package:analysis_server/src/server/crash_reporting_attachments.dart';
 import 'package:analysis_server/src/server/diagnostic_server.dart';
 import 'package:analysis_server/src/services/correction/namespace.dart';
+import 'package:analysis_server/src/services/pub/pub_api.dart';
+import 'package:analysis_server/src/services/pub/pub_package_service.dart';
 import 'package:analysis_server/src/services/search/element_visitors.dart';
 import 'package:analysis_server/src/services/search/search_engine.dart';
 import 'package:analysis_server/src/services/search/search_engine_internal.dart';
@@ -42,6 +45,8 @@ import 'package:analyzer/src/dartdoc/dartdoc_directive_info.dart';
 import 'package:analyzer/src/generated/sdk.dart';
 import 'package:analyzer/src/services/available_declarations.dart';
 import 'package:analyzer/src/util/file_paths.dart' as file_paths;
+import 'package:http/http.dart' as http;
+import 'package:meta/meta.dart';
 
 /// Implementations of [AbstractAnalysisServer] implement a server that listens
 /// on a [CommunicationChannel] for analysis messages and process them.
@@ -93,6 +98,12 @@ abstract class AbstractAnalysisServer {
   /// or `null` if the initial analysis is not yet complete
   ServerPerformance performanceAfterStartup;
 
+  /// A client for making requests to the pub.dev API.
+  final PubApi pubApi;
+
+  /// A service for fetching pub.dev package details.
+  PubPackageService pubPackageService;
+
   /// The class into which performance information is currently being recorded.
   /// During startup, this will be the same as [performanceDuringStartup]
   /// and after startup is complete, this switches to [performanceAfterStartup].
@@ -126,9 +137,14 @@ abstract class AbstractAnalysisServer {
     this.crashReportingAttachmentsBuilder,
     ResourceProvider baseResourceProvider,
     this.instrumentationService,
+    http.Client httpClient,
     this.notificationManager, {
     this.requestStatistics,
-  }) : resourceProvider = OverlayResourceProvider(baseResourceProvider) {
+  })  : resourceProvider = OverlayResourceProvider(baseResourceProvider),
+        pubApi = PubApi(instrumentationService, httpClient,
+            Platform.environment['PUB_HOSTED_URL']) {
+    pubPackageService =
+        PubPackageService(instrumentationService, baseResourceProvider, pubApi);
     performance = performanceDuringStartup;
 
     pluginManager = PluginManager(
@@ -398,6 +414,11 @@ abstract class AbstractAnalysisServer {
     bool fatal = false,
   });
 
+  @mustCallSuper
+  void shutdown() {
+    pubPackageService.shutdown();
+  }
+
   /// Return the path to the location of the byte store on disk, or `null` if
   /// there is no on-disk byte store.
   String _getByteStorePath() {

pkg/analysis_server/lib/src/domain_completion.dart

@@ -163,7 +163,7 @@ class CompletionDomainHandler extends AbstractRequestHandler {
       var generator = FixDataGenerator(provider);
       return generator.getSuggestions(file, offset);
     } else if (file_paths.isPubspecYaml(pathContext, file)) {
-      var generator = PubspecGenerator(provider);
+      var generator = PubspecGenerator(provider, server.pubPackageService);
       return generator.getSuggestions(file, offset);
     }
     return const YamlCompletionResults.empty();

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

@@ -115,7 +115,8 @@ class CompletionHandler
         } else if (file_paths.isFixDataYaml(pathContext, path.result)) {
           generator = FixDataGenerator(server.resourceProvider);
         } else if (file_paths.isPubspecYaml(pathContext, path.result)) {
-          generator = PubspecGenerator(server.resourceProvider);
+          generator = PubspecGenerator(
+              server.resourceProvider, server.pubPackageService);
         }
         if (generator != null) {
           serverResultsFuture = _getServerYamlItems(

pkg/analysis_server/lib/src/lsp/lsp_analysis_server.dart

@@ -43,10 +43,11 @@ import 'package:analyzer/source/line_info.dart';
 import 'package:analyzer/src/dart/analysis/driver.dart' as nd;
 import 'package:analyzer/src/dart/analysis/status.dart' as nd;
 import 'package:analyzer/src/generated/sdk.dart';
+import 'package:analyzer/src/util/file_paths.dart' as file_paths;
 import 'package:analyzer_plugin/protocol/protocol_common.dart' as plugin;
 import 'package:analyzer_plugin/protocol/protocol_generated.dart' as plugin;
 import 'package:analyzer_plugin/src/protocol/protocol_internal.dart' as plugin;
-import 'package:path/path.dart';
+import 'package:http/http.dart' as http;
 import 'package:watcher/watcher.dart';
 
 /// Instances of the class [LspAnalysisServer] implement an LSP-based server
@@ -134,6 +135,7 @@ class LspAnalysisServer extends AbstractAnalysisServer {
     DartSdkManager sdkManager,
     CrashReportingAttachmentsBuilder crashReportingAttachmentsBuilder,
     InstrumentationService instrumentationService, {
+    http.Client httpClient,
     DiagnosticServer diagnosticServer,
   }) : super(
           options,
@@ -142,6 +144,7 @@ class LspAnalysisServer extends AbstractAnalysisServer {
           crashReportingAttachmentsBuilder,
           baseResourceProvider,
           instrumentationService,
+          httpClient,
           LspNotificationManager(channel, baseResourceProvider.pathContext),
         ) {
     notificationManager.server = this;
@@ -185,8 +188,14 @@ class LspAnalysisServer extends AbstractAnalysisServer {
   RefactoringWorkspace get refactoringWorkspace => _refactoringWorkspace ??=
       RefactoringWorkspace(driverMap.values, searchEngine);
 
-  void addPriorityFile(String path) {
-    final didAdd = priorityFiles.add(path);
+  void addPriorityFile(String filePath) {
+    // When a pubspec is opened, trigger package name caching for completion.
+    if (!pubPackageService.isRunning &&
+        file_paths.isPubspecYaml(resourceProvider.pathContext, filePath)) {
+      pubPackageService.beginPackageNamePreload();
+    }
+
+    final didAdd = priorityFiles.add(filePath);
     assert(didAdd);
     if (didAdd) {
       _updateDriversAndPluginsPriorityFiles();
@@ -616,7 +625,10 @@ class LspAnalysisServer extends AbstractAnalysisServer {
     return MessageActionItem.fromJson(response.result);
   }
 
+  @override
   Future<void> shutdown() {
+    super.shutdown();
+
     // Defer closing the channel so that the shutdown response can be sent and
     // logged.
     Future(() {
@@ -664,13 +676,15 @@ class LspAnalysisServer extends AbstractAnalysisServer {
       ..addAll(_temporaryAnalysisRoots.values);
 
     final excludedPaths = clientConfiguration.analysisExcludedFolders
-        .expand((excludePath) => isAbsolute(excludePath)
+        .expand((excludePath) => resourceProvider.pathContext
+                .isAbsolute(excludePath)
             ? [excludePath]
             // Apply the relative path to each open workspace folder.
             // TODO(dantup): Consider supporting per-workspace config by
             // calling workspace/configuration whenever workspace folders change
             // and caching the config for each one.
-            : _explicitAnalysisRoots.map((root) => join(root, excludePath)))
+            : _explicitAnalysisRoots.map(
+                (root) => resourceProvider.pathContext.join(root, excludePath)))
         .toSet();
 
     // If the roots didn't actually change from the last time they were set

pkg/analysis_server/lib/src/lsp/mapping.dart

@@ -308,12 +308,10 @@ lsp.CompletionItem declarationToCompletionItem(
   return lsp.CompletionItem(
     label: label,
     kind: completionKind,
-    tags: supportedTags.isNotEmpty
-        ? [
-            if (supportsDeprecatedTag && declaration.isDeprecated)
-              lsp.CompletionItemTag.Deprecated
-          ]
-        : null,
+    tags: nullIfEmpty([
+      if (supportsDeprecatedTag && declaration.isDeprecated)
+        lsp.CompletionItemTag.Deprecated
+    ]),
     commitCharacters:
         includeCommitCharacters ? lsp.dartCompletionCommitCharacters : null,
     detail: getDeclarationCompletionDetail(declaration, completionKind,
@@ -631,6 +629,8 @@ lsp.LocationLink navigationTargetToLocationLink(
   );
 }
 
+List<T> nullIfEmpty<T>(List<T> items) => items.isEmpty ? null : items;
+
 /// Returns the file system path for a TextDocumentIdentifier.
 ErrorOr<String> pathOfDoc(lsp.TextDocumentIdentifier doc) =>
     pathOfUri(Uri.tryParse(doc?.uri));
@@ -782,6 +782,8 @@ lsp.CompletionItemKind suggestionKindToCompletionItemKind(
         return const [lsp.CompletionItemKind.Variable];
       case server.CompletionSuggestionKind.PARAMETER:
         return const [lsp.CompletionItemKind.Value];
+      case server.CompletionSuggestionKind.PACKAGE_NAME:
+        return const [lsp.CompletionItemKind.Module];
       default:
         return const [];
     }
@@ -894,12 +896,10 @@ lsp.CompletionItem toCompletionItem(
   return lsp.CompletionItem(
     label: label,
     kind: completionKind,
-    tags: supportedTags.isNotEmpty
-        ? [
-            if (supportsDeprecatedTag && suggestion.isDeprecated)
-              lsp.CompletionItemTag.Deprecated
-          ]
-        : null,
+    tags: nullIfEmpty([
+      if (supportsDeprecatedTag && suggestion.isDeprecated)
+        lsp.CompletionItemTag.Deprecated
+    ]),
     commitCharacters:
         includeCommitCharacters ? dartCompletionCommitCharacters : null,
     data: resolutionData,

pkg/analysis_server/lib/src/services/completion/yaml/analysis_options_generator.dart

@@ -47,7 +47,7 @@ class AnalysisOptionsGenerator extends YamlCompletionGenerator {
   /// Initialize a newly created suggestion generator for analysis options
   /// files.
   AnalysisOptionsGenerator(ResourceProvider resourceProvider)
-      : super(resourceProvider);
+      : super(resourceProvider, null);
 
   @override
   Producer get topLevelProducer => analysisOptionsProducer;

pkg/analysis_server/lib/src/services/completion/yaml/fix_data_generator.dart

@@ -72,7 +72,8 @@ class FixDataGenerator extends YamlCompletionGenerator {
   }));
 
   /// Initialize a newly created suggestion generator for fix data files.
-  FixDataGenerator(ResourceProvider resourceProvider) : super(resourceProvider);
+  FixDataGenerator(ResourceProvider resourceProvider)
+      : super(resourceProvider, null);
 
   @override
   Producer get topLevelProducer => fixDataProducer;

pkg/analysis_server/lib/src/services/completion/yaml/producer.dart

@@ -3,6 +3,7 @@
 // BSD-style license that can be found in the LICENSE file.
 
 import 'package:analysis_server/src/protocol_server.dart';
+import 'package:analysis_server/src/services/pub/pub_package_service.dart';
 import 'package:analyzer/file_system/file_system.dart';
 import 'package:meta/meta.dart';
 import 'package:path/path.dart' as path;
@@ -179,6 +180,12 @@ abstract class Producer {
       CompletionSuggestion(CompletionSuggestionKind.IDENTIFIER, relevance,
           identifier, identifier.length, 0, false, false);
 
+  /// A utility method used to create a suggestion for the package [packageName].
+  CompletionSuggestion packageName(String packageName,
+          {int relevance = 1000}) =>
+      CompletionSuggestion(CompletionSuggestionKind.PACKAGE_NAME, relevance,
+          packageName, packageName.length, 0, false, false);
+
   /// Return the completion suggestions appropriate to this location.
   Iterable<CompletionSuggestion> suggestions(YamlCompletionRequest request);
 }
@@ -188,6 +195,9 @@ class YamlCompletionRequest {
   /// The resource provider used to access the file system.
   final ResourceProvider resourceProvider;
 
+  /// The Pub package service used for looking up package names/versions.
+  final PubPackageService pubPackageService;
+
   /// The absolute path of the file in which completions are being requested.
   final String filePath;
 
@@ -198,5 +208,6 @@ class YamlCompletionRequest {
   YamlCompletionRequest(
       {@required this.filePath,
       @required this.precedingText,
-      @required this.resourceProvider});
+      @required this.resourceProvider,
+      @required this.pubPackageService});
 }

pkg/analysis_server/lib/src/services/completion/yaml/pubspec_generator.dart

@@ -2,10 +2,26 @@
 // 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';
 import 'package:analysis_server/src/services/completion/yaml/producer.dart';
 import 'package:analysis_server/src/services/completion/yaml/yaml_completion_generator.dart';
+import 'package:analysis_server/src/services/pub/pub_package_service.dart';
 import 'package:analyzer/file_system/file_system.dart';
 
+/// An object that represents the location of a package name.
+class PubPackageNameProducer extends Producer {
+  const PubPackageNameProducer();
+
+  @override
+  Iterable<CompletionSuggestion> suggestions(
+      YamlCompletionRequest request) sync* {
+    final cachedPackages = request.pubPackageService.cachedPackages;
+    var relevance = cachedPackages.length;
+    yield* cachedPackages.map((package) =>
+        packageName('${package.packageName}: ', relevance: relevance--));
+  }
+}
+
 /// A completion generator that can produce completion suggestions for pubspec
 /// files.
 class PubspecGenerator extends YamlCompletionGenerator {
@@ -24,8 +40,8 @@ class PubspecGenerator extends YamlCompletionGenerator {
       'flutter': EmptyProducer(),
       'sdk': EmptyProducer(),
     }),
-    'dependencies': EmptyProducer(),
-    'dev_dependencies': EmptyProducer(),
+    'dependencies': PubPackageNameProducer(),
+    'dev_dependencies': PubPackageNameProducer(),
     // TODO(brianwilkerson) Suggest names already listed under 'dependencies'
     //  and 'dev_dependencies'.
     'dependency_overrides': EmptyProducer(),
@@ -78,7 +94,9 @@ class PubspecGenerator extends YamlCompletionGenerator {
   });
 
   /// Initialize a newly created suggestion generator for pubspec files.
-  PubspecGenerator(ResourceProvider resourceProvider) : super(resourceProvider);
+  PubspecGenerator(
+      ResourceProvider resourceProvider, PubPackageService pubPackageService)
+      : super(resourceProvider, pubPackageService);
 
   @override
   Producer get topLevelProducer => pubspecProducer;