[analysis_server] Extract LSP registration options from ServerCapabilitiesComputer

This is a non-functional refactor that extracts the growing set of capabilities and options from ServerCapabilitiesComputer into files alongside the handlers they relate to.

The motivation for this is that for LSP-over-Legacy we'll need to accept client capabilities (and return server capabilities). The server capabilities will be different to the standard LSP ones (they will be a subset, and we might not support dynamic registration - at least initially). However the features we do support will have the same registration options, so to avoid duplicating them this moves the registration options away from the creation of the ServerCapabilities.

In future, we might consider further wrapping up a "feature" (which consists of these registration options, and the related handlers), but this change is already quite large and I just wanted to progress capabilities for LSP-over-Legacy so we can handle things like Code Actions (which require executeCommand and possible reverse-requests for applyEdit).

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

Author: DanTup

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

@@ -45,11 +45,48 @@ const dartSignatureHelpTriggerCharacters = <String>['('];
 /// Characters to trigger formatting when format-on-type is enabled.
 const dartTypeFormattingCharacters = ['}', ';'];
 
+/// A [TextDocumentFilterWithScheme] for Analysis Options files.
+final analysisOptionsFile = TextDocumentFilterWithScheme(
+    language: 'yaml', scheme: 'file', pattern: '**/analysis_options.yaml');
+
 /// A [ProgressToken] used for reporting progress while the server is analyzing.
 final analyzingProgressToken = ProgressToken.t2('ANALYZING');
 
+/// A [TextDocumentFilterWithScheme] for Dart file.
+final dartFiles =
+    TextDocumentFilterWithScheme(language: 'dart', scheme: 'file');
+
 final emptyWorkspaceEdit = WorkspaceEdit();
 
+final fileOperationRegistrationOptions = FileOperationRegistrationOptions(
+  filters: [
+    FileOperationFilter(
+      scheme: 'file',
+      pattern: FileOperationPattern(
+        glob: '**/*.dart',
+        matches: FileOperationPatternKind.file,
+      ),
+    ),
+    FileOperationFilter(
+      scheme: 'file',
+      pattern: FileOperationPattern(
+        glob: '**/',
+        matches: FileOperationPatternKind.folder,
+      ),
+    )
+  ],
+);
+
+/// A [TextDocumentFilterWithScheme] for Fix Data files.
+final fixDataFile = TextDocumentFilterWithScheme(
+    language: 'yaml',
+    scheme: 'file',
+    pattern: '**/lib/{fix_data.yaml,fix_data/**.yaml}');
+
+/// A [TextDocumentFilterWithScheme] for Pubspec files.
+final pubspecFile = TextDocumentFilterWithScheme(
+    language: 'yaml', scheme: 'file', pattern: '**/pubspec.yaml');
+
 /// 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

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

@@ -9,13 +9,36 @@ import 'package:analysis_server/lsp_protocol/protocol_special.dart';
 import 'package:analysis_server/src/analysis_server.dart';
 import 'package:analysis_server/src/computer/computer_call_hierarchy.dart'
     as call_hierarchy;
+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:analysis_server/src/lsp/registration/feature_registration.dart';
 import 'package:analyzer/dart/analysis/results.dart';
 import 'package:analyzer/dart/analysis/session.dart';
 import 'package:analyzer/source/line_info.dart';
 import 'package:analyzer/source/source_range.dart';
 
+typedef StaticOptions
+    = Either3<bool, CallHierarchyOptions, CallHierarchyRegistrationOptions>;
+
+class CallHierarchyRegistrations extends FeatureRegistration
+    with SingleDynamicRegistration, StaticRegistration<StaticOptions> {
+  CallHierarchyRegistrations(super.info);
+
+  @override
+  ToJsonable? get options =>
+      CallHierarchyRegistrationOptions(documentSelector: [dartFiles]);
+
+  @override
+  Method get registrationMethod => Method.textDocument_prepareCallHierarchy;
+
+  @override
+  StaticOptions get staticOptions => Either3.t1(true);
+
+  @override
+  bool get supportsDynamic => clientDynamic.callHierarchy;
+}
+
 /// A handler for `callHierarchy/incoming` that returns the incoming calls for
 /// the target supplied by the client.
 class IncomingCallHierarchyHandler extends _AbstractCallHierarchyCallsHandler<

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

@@ -4,13 +4,16 @@
 
 import 'package:analysis_server/lsp_protocol/protocol.dart';
 import 'package:analysis_server/src/lsp/handlers/handlers.dart';
+import 'package:analysis_server/src/lsp/registration/feature_registration.dart';
 
-class WorkspaceFoldersHandler
+typedef StaticOptions = Either2<bool, String>;
+
+class ChangeWorkspaceFoldersHandler
     extends LspMessageHandler<DidChangeWorkspaceFoldersParams, void> {
   // Whether to update analysis roots based on the open workspace folders.
   bool updateAnalysisRoots;
 
-  WorkspaceFoldersHandler(super.server)
+  ChangeWorkspaceFoldersHandler(super.server)
       : updateAnalysisRoots =
             !server.initializationOptions.onlyAnalyzeProjectsWithOpenFiles;
 
@@ -46,3 +49,17 @@ class WorkspaceFoldersHandler
     return folders.map((wf) => pathContext.fromUri(wf.uri)).toList();
   }
 }
+
+class ChangeWorkspaceFoldersRegistrations extends FeatureRegistration
+    with StaticRegistration<StaticOptions> {
+  ChangeWorkspaceFoldersRegistrations(super.info);
+
+  @override
+  List<LspDynamicRegistration> get dynamicRegistrations => [];
+
+  @override
+  StaticOptions get staticOptions => Either2.t1(true);
+
+  @override
+  bool get supportsDynamic => false;
+}

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

@@ -5,16 +5,20 @@
 import 'dart:async';
 
 import 'package:analysis_server/lsp_protocol/protocol.dart';
+import 'package:analysis_server/src/lsp/constants.dart';
 import 'package:analysis_server/src/lsp/handlers/code_actions/abstract_code_actions_producer.dart';
 import 'package:analysis_server/src/lsp/handlers/code_actions/analysis_options.dart';
 import 'package:analysis_server/src/lsp/handlers/code_actions/dart.dart';
 import 'package:analysis_server/src/lsp/handlers/code_actions/plugins.dart';
 import 'package:analysis_server/src/lsp/handlers/code_actions/pubspec.dart';
 import 'package:analysis_server/src/lsp/handlers/handlers.dart';
 import 'package:analysis_server/src/lsp/mapping.dart';
+import 'package:analysis_server/src/lsp/registration/feature_registration.dart';
 import 'package:analyzer/src/util/file_paths.dart' as file_paths;
 import 'package:collection/collection.dart' show groupBy;
 
+typedef StaticOptions = Either2<bool, CodeActionOptions>;
+
 class CodeActionHandler
     extends LspMessageHandler<CodeActionParams, TextDocumentCodeActionResult> {
   CodeActionHandler(super.server);
@@ -220,6 +224,36 @@ class CodeActionHandler
   }
 }
 
+class CodeActionRegistrations extends FeatureRegistration
+    with SingleDynamicRegistration, StaticRegistration<StaticOptions> {
+  CodeActionRegistrations(super.info);
+
+  bool get codeActionLiteralSupport => clientCapabilities.literalCodeActions;
+
+  @override
+  ToJsonable? get options => CodeActionRegistrationOptions(
+        documentSelector: fullySupportedTypes,
+        codeActionKinds: DartCodeActionKind.serverSupportedKinds,
+      );
+
+  @override
+  Method get registrationMethod => Method.textDocument_codeAction;
+
+  @override
+  StaticOptions get staticOptions =>
+      // "The `CodeActionOptions` return type is only valid if the client
+      // signals code action literal support via the property
+      // `textDocument.codeAction.codeActionLiteralSupport`."
+      codeActionLiteralSupport
+          ? Either2.t2(CodeActionOptions(
+              codeActionKinds: DartCodeActionKind.serverSupportedKinds,
+            ))
+          : Either2.t1(true);
+
+  @override
+  bool get supportsDynamic => clientDynamic.codeActions;
+}
+
 /// Sorts [CodeActionWithPriority]s by priority, and removes duplicates keeping
 /// the one nearest [range].
 class _CodeActionSorter {

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

@@ -7,8 +7,10 @@ import 'dart:math' as math;
 import 'package:analysis_server/lsp_protocol/protocol.dart' hide Declaration;
 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:analysis_server/src/lsp/registration/feature_registration.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';
@@ -790,6 +792,66 @@ class CompletionHandler
   }
 }
 
+class CompletionRegistrations extends FeatureRegistration
+    with StaticRegistration<CompletionOptions> {
+  CompletionRegistrations(super.info);
+
+  @override
+  List<LspDynamicRegistration> get dynamicRegistrations {
+    return [
+      // Trigger and commit characters are specific to Dart, so register them
+      // separately to the others.
+      (
+        Method.textDocument_completion,
+        CompletionRegistrationOptions(
+          documentSelector: [dartFiles],
+          triggerCharacters: dartCompletionTriggerCharacters,
+          allCommitCharacters:
+              previewCommitCharacters ? dartCompletionCommitCharacters : null,
+          resolveProvider: true,
+        ),
+      ),
+      (
+        Method.textDocument_completion,
+        CompletionRegistrationOptions(
+          documentSelector: nonDartCompletionTypes,
+          resolveProvider: true,
+        ),
+      ),
+    ];
+  }
+
+  /// Types of documents we support completion for that are not Dart.
+  ///
+  /// We use two dynamic registrations because for Dart we support trigger
+  /// characters but for other kinds of files we do not.
+  List<TextDocumentFilterWithScheme> get nonDartCompletionTypes {
+    final pluginTypesExcludingDart =
+        pluginTypes.where((filter) => filter.pattern != '**/*.dart');
+
+    return {
+      ...pluginTypesExcludingDart,
+      pubspecFile,
+      analysisOptionsFile,
+      fixDataFile,
+    }.toList();
+  }
+
+  bool get previewCommitCharacters =>
+      clientConfiguration.global.previewCommitCharacters;
+
+  @override
+  CompletionOptions get staticOptions => CompletionOptions(
+        triggerCharacters: dartCompletionTriggerCharacters,
+        allCommitCharacters:
+            previewCommitCharacters ? dartCompletionCommitCharacters : null,
+        resolveProvider: true,
+      );
+
+  @override
+  bool get supportsDynamic => clientDynamic.completion;
+}
+
 /// A set of completion items split into ranked and unranked items.
 class _CompletionResults {
   /// Items that can be ranked using their relevance/sortText.

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

@@ -7,6 +7,7 @@ import 'package:analysis_server/protocol/protocol_generated.dart'
     hide AnalysisGetNavigationParams;
 import 'package:analysis_server/src/lsp/handlers/handlers.dart';
 import 'package:analysis_server/src/lsp/mapping.dart';
+import 'package:analysis_server/src/lsp/registration/feature_registration.dart';
 import 'package:analysis_server/src/plugin/result_merger.dart';
 import 'package:analysis_server/src/protocol_server.dart' show NavigationTarget;
 import 'package:analyzer/dart/analysis/results.dart';
@@ -21,6 +22,8 @@ import 'package:analyzer_plugin/utilities/analyzer_converter.dart';
 import 'package:analyzer_plugin/utilities/navigation/navigation_dart.dart';
 import 'package:collection/collection.dart';
 
+typedef StaticOptions = Either2<bool, DefinitionOptions>;
+
 class DefinitionHandler extends LspMessageHandler<TextDocumentPositionParams,
     TextDocumentDefinitionResult> with LspPluginRequestHandlerMixin {
   DefinitionHandler(super.server);
@@ -269,3 +272,21 @@ class DefinitionHandler extends LspMessageHandler<TextDocumentPositionParams,
     return parsedLibrary.getElementDeclaration(element);
   }
 }
+
+class DefinitionRegistrations extends FeatureRegistration
+    with SingleDynamicRegistration, StaticRegistration<StaticOptions> {
+  DefinitionRegistrations(super.info);
+
+  @override
+  ToJsonable? get options =>
+      TextDocumentRegistrationOptions(documentSelector: fullySupportedTypes);
+
+  @override
+  Method get registrationMethod => Method.textDocument_definition;
+
+  @override
+  StaticOptions get staticOptions => Either2.t1(true);
+
+  @override
+  bool get supportsDynamic => clientDynamic.definition;
+}

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

@@ -5,10 +5,15 @@
 import 'package:analysis_server/lsp_protocol/protocol.dart';
 import 'package:analysis_server/src/computer/computer_color.dart'
     show ColorComputer, ColorReference;
+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:analysis_server/src/lsp/registration/feature_registration.dart';
 import 'package:analyzer/dart/analysis/results.dart';
 
+typedef StaticOptions
+    = Either3<bool, DocumentColorOptions, DocumentColorRegistrationOptions>;
+
 /// Handles textDocument/documentColor requests.
 ///
 /// This request is sent by the client to the server to request the locations
@@ -58,3 +63,21 @@ class DocumentColorHandler
     return success(colors.map(toColorInformation).toList());
   }
 }
+
+class DocumentColorRegistrations extends FeatureRegistration
+    with SingleDynamicRegistration, StaticRegistration<StaticOptions> {
+  DocumentColorRegistrations(super.info);
+
+  @override
+  DocumentColorRegistrationOptions get options =>
+      DocumentColorRegistrationOptions(documentSelector: [dartFiles]);
+
+  @override
+  Method get registrationMethod => Method.textDocument_documentColor;
+
+  @override
+  StaticOptions get staticOptions => Either3.t3(options);
+
+  @override
+  bool get supportsDynamic => clientDynamic.colorProvider;
+}

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

@@ -7,6 +7,9 @@ import 'package:analysis_server/src/domains/analysis/occurrences.dart';
 import 'package:analysis_server/src/domains/analysis/occurrences_dart.dart';
 import 'package:analysis_server/src/lsp/handlers/handlers.dart';
 import 'package:analysis_server/src/lsp/mapping.dart';
+import 'package:analysis_server/src/lsp/registration/feature_registration.dart';
+
+typedef StaticOptions = Either2<bool, DocumentHighlightOptions>;
 
 class DocumentHighlightsHandler extends SharedMessageHandler<
     TextDocumentPositionParams, List<DocumentHighlight>?> {
@@ -53,3 +56,21 @@ class DocumentHighlightsHandler extends SharedMessageHandler<
     });
   }
 }
+
+class DocumentHighlightsRegistrations extends FeatureRegistration
+    with SingleDynamicRegistration, StaticRegistration<StaticOptions> {
+  DocumentHighlightsRegistrations(super.info);
+
+  @override
+  ToJsonable? get options =>
+      TextDocumentRegistrationOptions(documentSelector: fullySupportedTypes);
+
+  @override
+  Method get registrationMethod => Method.textDocument_documentHighlight;
+
+  @override
+  StaticOptions get staticOptions => Either2.t1(true);
+
+  @override
+  bool get supportsDynamic => clientDynamic.documentHighlights;
+}