Add support for dynamic registration for LSP

Change-Id: I55c7b2f7d683acab0f6aa4bdbcba3b155d2de32c


Change-Id: I6a0b13856053bd86e77637b9664c7fe41194c5f3


Change-Id: I7472cf93efc29585ccbcbd1e6c7b9f703872b3c5
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/103532
Reviewed-by: Brian Wilkerson <[email protected]>
Commit-Queue: Danny Tuppeny <[email protected]>

Author: DanTup

pkg/analysis_server/lib/lsp_protocol/protocol_generated.dart

@@ -8415,7 +8415,9 @@ class TextDocumentChangeRegistrationOptions
   }
   static TextDocumentChangeRegistrationOptions fromJson(
       Map<String, dynamic> json) {
-    final syncKind = json['syncKind'];
+    final syncKind = json['syncKind'] != null
+        ? TextDocumentSyncKind.fromJson(json['syncKind'])
+        : null;
     final documentSelector = json['documentSelector']
         ?.map((item) => item != null ? DocumentFilter.fromJson(item) : null)
         ?.cast<DocumentFilter>()
@@ -8430,7 +8432,7 @@ class TextDocumentChangeRegistrationOptions
 
   /// How documents are synced to the server. See TextDocumentSyncKind.Full and
   /// TextDocumentSyncKind.Incremental.
-  final num syncKind;
+  final TextDocumentSyncKind syncKind;
 
   Map<String, dynamic> toJson() {
     Map<String, dynamic> __result = {};
@@ -8443,7 +8445,7 @@ class TextDocumentChangeRegistrationOptions
   static bool canParse(Object obj) {
     return obj is Map<String, dynamic> &&
         obj.containsKey('syncKind') &&
-        obj['syncKind'] is num &&
+        TextDocumentSyncKind.canParse(obj['syncKind']) &&
         obj.containsKey('documentSelector') &&
         (obj['documentSelector'] == null ||
             (obj['documentSelector'] is List &&

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

@@ -4,6 +4,36 @@
 
 import 'package:analysis_server/lsp_protocol/protocol_generated.dart';
 
+/// Set the characters that will cause the editor to automatically
+/// trigger completion.
+/// TODO(dantup): There are several characters that we want to conditionally
+/// allow to trigger completion, but they can only be added when the completion
+/// provider is able to handle them in context:
+///
+///    {   trigger if being typed in a string immediately after a $
+///    '   trigger if the opening quote for an import/export
+///    "   trigger if the opening quote for an import/export
+///    /   trigger if as part of a path in an import/export
+///    \   trigger if as part of a path in an import/export
+///    :   don't trigger when typing case expressions (`case x:`)
+///
+/// Additionally, we need to prefix `filterText` on completion items
+/// with spaces for those that can follow whitespace (eg. `foo` in
+/// `myArg: foo`) to ensure they're not filtered away when the user
+/// types space.
+///
+/// See https://github.com/Dart-Code/Dart-Code/blob/68d1cd271e88a785570257d487adbdec17abd6a3/src/providers/dart_completion_item_provider.ts#L36-L64
+/// for the VS Code implementation of this.
+const dartCompletionTriggerCharacters = ['.', '=', '(', r'$'];
+
+/// TODO(dantup): Signature help triggering is even more sensitive to
+/// bad chars, so we'll need to implement the logic described here:
+/// https://github.com/dart-lang/sdk/issues/34241
+const dartSignatureHelpTriggerCharacters = <String>[];
+
+/// Characters to trigger formatting when format-on-type is enabled.
+const dartTypeFormattingCharacters = ['}', ';'];
+
 /// Constants for command IDs that are exchanged between LSP client/server.
 abstract class Commands {
   /// A list of all commands IDs that can be sent to the client to inform which
@@ -19,6 +49,11 @@ abstract class Commands {
   static const sendWorkspaceEdit = 'edit.sendWorkspaceEdit';
 }
 
+abstract class CustomMethods {
+  static const DiagnosticServer = const Method('dart/diagnosticServer');
+  static const AnalyzerStatus = const Method(r'$/analyzerStatus');
+}
+
 /// CodeActionKinds supported by the server that are not declared in the LSP spec.
 abstract class DartCodeActionKind {
   /// A list of all supported CodeAction kinds, supplied to the client during
@@ -61,8 +96,3 @@ abstract class ServerErrorCodes {
   ///   if it crashes 5 times in the last 180 seconds."
   static const ClientServerInconsistentState = const ErrorCodes(-32010);
 }
-
-abstract class CustomMethods {
-  static const DiagnosticServer = const Method('dart/diagnosticServer');
-  static const AnalyzerStatus = const Method(r'$/analyzerStatus');
-}

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

@@ -69,6 +69,12 @@ class InitializeMessageHandler
     final renameOptionsSupport =
         params.capabilities.textDocument?.rename?.prepareSupport ?? false;
 
+    // When adding new capabilities to the server that may apply to specific file
+    // types, it's important to update
+    // [IntializedMessageHandler._performDynamicRegistration()] to notify
+    // supporting clients of this. This avoids clients needing to hard-code the
+    // list of what files types we support (and allows them to avoid sending
+    // requests where we have only partial support for some types).
     server.capabilities = new ServerCapabilities(
         Either2<TextDocumentSyncOptions, num>.t1(new TextDocumentSyncOptions(
           true,
@@ -80,33 +86,10 @@ class InitializeMessageHandler
         true, // hoverProvider
         new CompletionOptions(
           true, // resolveProvider
-          // Set the characters that will cause the editor to automatically
-          // trigger completion.
-          // TODO(dantup): There are several characters that we want to conditionally
-          // allow to trigger completion, but they can only be added when the completion
-          // provider is able to handle them in context:
-          //
-          //    {   trigger if being typed in a string immediately after a $
-          //    '   trigger if the opening quote for an import/export
-          //    "   trigger if the opening quote for an import/export
-          //    /   trigger if as part of a path in an import/export
-          //    \   trigger if as part of a path in an import/export
-          //    :   don't trigger when typing case expressions (`case x:`)
-          //
-          // Additionally, we need to prefix `filterText` on completion items
-          // with spaces for those that can follow whitespace (eg. `foo` in
-          // `myArg: foo`) to ensure they're not filtered away when the user
-          // types space.
-          //
-          // See https://github.com/Dart-Code/Dart-Code/blob/68d1cd271e88a785570257d487adbdec17abd6a3/src/providers/dart_completion_item_provider.ts#L36-L64
-          // for the VS Code implementation of this.
-          r'''.=($'''.split(''),
+          dartCompletionTriggerCharacters,
         ),
         new SignatureHelpOptions(
-          // TODO(dantup): Signature help triggering is even more sensitive to
-          // bad chars, so we'll need to implement the logic described here:
-          // https://github.com/dart-lang/sdk/issues/34241
-          [],
+          dartSignatureHelpTriggerCharacters,
         ),
         true, // definitionProvider
         null,
@@ -125,7 +108,8 @@ class InitializeMessageHandler
         null,
         true, // documentFormattingProvider
         false, // documentRangeFormattingProvider
-        new DocumentOnTypeFormattingOptions('}', [';']),
+        new DocumentOnTypeFormattingOptions(dartTypeFormattingCharacters.first,
+            dartTypeFormattingCharacters.skip(1).toList()),
         renameOptionsSupport
             ? Either2<bool, RenameOptions>.t2(new RenameOptions(true))
             : Either2<bool, RenameOptions>.t1(true),

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

@@ -4,6 +4,7 @@
 
 import 'package:analysis_server/lsp_protocol/protocol_generated.dart';
 import 'package:analysis_server/lsp_protocol/protocol_special.dart';
+import 'package:analysis_server/src/lsp/constants.dart';
 import 'package:analysis_server/src/lsp/handlers/handler_states.dart';
 import 'package:analysis_server/src/lsp/handlers/handlers.dart';
 import 'package:analysis_server/src/lsp/lsp_analysis_server.dart';
@@ -30,10 +31,154 @@ class IntializedMessageHandler extends MessageHandler<InitializedParams, void> {
       suggestFromUnimportedLibraries,
     );
 
+    _performDynamicRegistration();
+
     if (!onlyAnalyzeProjectsWithOpenFiles) {
       server.setAnalysisRoots(openWorkspacePaths);
     }
 
     return success();
   }
+
+  /// If the client supports dynamic registrations we can tell it what methods
+  /// we support for which documents. For example, this allows us to ask for
+  /// file edits for .dart as well as pubspec.yaml but only get hover/completion
+  /// calls for .dart. This functionality may not be supported by the client, in
+  /// which case they will use the ServerCapabilities to know which methods we
+  /// support and it will be up to them to decide which file types they will
+  /// send requests for.
+  Future<void> _performDynamicRegistration() async {
+    final dartFiles = DocumentFilter('dart', 'file', null);
+    final pubspecFile = DocumentFilter('yaml', 'file', '**/pubspec.yaml');
+    final analysisOptionsFile =
+        DocumentFilter('yaml', 'file', '**/analysis_options.yaml');
+    final allTypes = [dartFiles, pubspecFile, analysisOptionsFile];
+
+    // TODO(dantup): When we support plugins, we will need to collect their
+    // requirements too. For example, the Angular plugin might wish to add HTML
+    // `DocumentFilter('html', 'file', null)` to many of these requests.
+
+    int _lastRegistrationId = 1;
+    final registrations = <Registration>[];
+
+    /// Helper for creating registrations with IDs.
+    void register(bool condition, Method method, [ToJsonable options]) {
+      if (condition == true) {
+        registrations.add(Registration(
+            (_lastRegistrationId++).toString(), method.toJson(), options));
+      }
+    }
+
+    final textCapabilities = server.clientCapabilities?.textDocument;
+
+    register(
+      textCapabilities?.synchronization?.dynamicRegistration,
+      Method.textDocument_didOpen,
+      TextDocumentRegistrationOptions(allTypes),
+    );
+    register(
+      textCapabilities?.synchronization?.dynamicRegistration,
+      Method.textDocument_didClose,
+      TextDocumentRegistrationOptions(allTypes),
+    );
+    register(
+      textCapabilities?.synchronization?.dynamicRegistration,
+      Method.textDocument_didChange,
+      TextDocumentChangeRegistrationOptions(
+          TextDocumentSyncKind.Incremental, allTypes),
+    );
+    register(
+      server.clientCapabilities?.textDocument?.completion?.dynamicRegistration,
+      Method.textDocument_completion,
+      CompletionRegistrationOptions(
+        dartCompletionTriggerCharacters,
+        null,
+        true,
+        [dartFiles],
+      ),
+    );
+    register(
+      textCapabilities?.hover?.dynamicRegistration,
+      Method.textDocument_hover,
+      TextDocumentRegistrationOptions([dartFiles]),
+    );
+    register(
+      textCapabilities?.signatureHelp?.dynamicRegistration,
+      Method.textDocument_signatureHelp,
+      SignatureHelpRegistrationOptions(
+          dartSignatureHelpTriggerCharacters, [dartFiles]),
+    );
+    register(
+      server.clientCapabilities?.textDocument?.references?.dynamicRegistration,
+      Method.textDocument_references,
+      TextDocumentRegistrationOptions([dartFiles]),
+    );
+    register(
+      textCapabilities?.documentHighlight?.dynamicRegistration,
+      Method.textDocument_documentHighlight,
+      TextDocumentRegistrationOptions([dartFiles]),
+    );
+    register(
+      textCapabilities?.documentSymbol?.dynamicRegistration,
+      Method.textDocument_documentSymbol,
+      TextDocumentRegistrationOptions([dartFiles]),
+    );
+    register(
+      server.clientCapabilities?.textDocument?.formatting?.dynamicRegistration,
+      Method.textDocument_formatting,
+      TextDocumentRegistrationOptions([dartFiles]),
+    );
+    register(
+      textCapabilities?.onTypeFormatting?.dynamicRegistration,
+      Method.textDocument_onTypeFormatting,
+      DocumentOnTypeFormattingRegistrationOptions(
+        dartTypeFormattingCharacters.first,
+        dartTypeFormattingCharacters.skip(1).toList(),
+        [dartFiles],
+      ),
+    );
+    register(
+      server.clientCapabilities?.textDocument?.definition?.dynamicRegistration,
+      Method.textDocument_definition,
+      TextDocumentRegistrationOptions([dartFiles]),
+    );
+    register(
+      textCapabilities?.implementation?.dynamicRegistration,
+      Method.textDocument_implementation,
+      TextDocumentRegistrationOptions([dartFiles]),
+    );
+    register(
+      server.clientCapabilities?.textDocument?.codeAction?.dynamicRegistration,
+      Method.textDocument_codeAction,
+      CodeActionRegistrationOptions(
+          [dartFiles], DartCodeActionKind.serverSupportedKinds),
+    );
+    register(
+      textCapabilities?.rename?.dynamicRegistration,
+      Method.textDocument_rename,
+      RenameRegistrationOptions(true, [dartFiles]),
+    );
+    register(
+      textCapabilities?.foldingRange?.dynamicRegistration,
+      Method.textDocument_foldingRange,
+      TextDocumentRegistrationOptions([dartFiles]),
+    );
+
+    // Only send the registration request if we have at least one (since
+    // otherwise we don't know that the client supports registerCapability).
+    if (registrations.isNotEmpty) {
+      final registrationResponse = await server.sendRequest(
+        Method.client_registerCapability,
+        RegistrationParams(registrations),
+      );
+
+      if (registrationResponse.error != null) {
+        server.logErrorToClient(
+          'Failed to register capabilities with client: '
+          '(${registrationResponse.error.code}) '
+          '${registrationResponse.error.message}',
+        );
+      }
+    }
+  }
 }