[analysis_server] Fix missing code actions for pubspec+analysis_options

Although the server supported fixes in `pubspec.yaml` and `analysis_options.yaml`, they were not listed in the server capabilities, so VS Code would never actually request them.

Fixes Dart-Code/Dart-Code#5781

Change-Id: Ie9520a3363902751e773f471ce2d0fc023c27a0f
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/459800
Reviewed-by: Samuel Rawlins <srawlins@google.com>
Reviewed-by: Brian Wilkerson <brianwilkerson@google.com>
Commit-Queue: Samuel Rawlins <srawlins@google.com>

Author: DanTup

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

@@ -74,7 +74,7 @@ class CodeActionRegistrations extends FeatureRegistration
 
   @override
   ToJsonable? get options => CodeActionRegistrationOptions(
-    documentSelector: fullySupportedTypes,
+    documentSelector: supportedTypes,
     codeActionKinds: DartCodeActionKind.serverSupportedKinds,
   );
 
@@ -94,6 +94,22 @@ class CodeActionRegistrations extends FeatureRegistration
         )
       : Either2.t1(true);
 
+  /// Types of documents for which code actions are provided.
+  ///
+  /// Includes Dart files, plugin types, pubspec.yaml, and analysis_options.yaml.
+  List<TextDocumentFilterScheme> get supportedTypes {
+    return
+    // Join in a Set because fullSupportedTypes includes plugin registrations
+    // and might overlap.
+    {
+      ...fullySupportedTypes,
+      // We support code actions in pubspec+analysis_options even though they're
+      // not "fully supported" (most handlers do not support them).
+      pubspecFile,
+      analysisOptionsFile,
+    }.toList();
+  }
+
   @override
   bool get supportsDynamic => clientDynamic.codeActions;
 }

pkg/analysis_server/test/lsp/initialization_test.dart

@@ -32,6 +32,25 @@ class InitializationTest extends AbstractLspAnalysisServerTest {
   final allowOverlappingHandlersDefault =
       MessageScheduler.allowOverlappingHandlers;
 
+  var isAnalysisOptionsSelector = TypeMatcher<TextDocumentFilterScheme>()
+      .having(
+        (selector) => selector.pattern,
+        'pattern',
+        '**/analysis_options.yaml',
+      );
+
+  var isDartSelector = TypeMatcher<TextDocumentFilterScheme>().having(
+    (selector) => selector.language,
+    'language',
+    'dart',
+  );
+
+  var isPubspecSelector = TypeMatcher<TextDocumentFilterScheme>().having(
+    (selector) => selector.pattern,
+    'pattern',
+    '**/pubspec.yaml',
+  );
+
   /// Waits for any in-progress analysis context rebuild.
   ///
   /// Pumps the event queue before and after, to ensure any server code that
@@ -416,13 +435,14 @@ class InitializationTest extends AbstractLspAnalysisServerTest {
   Future<void> test_dynamicRegistration_containsAppropriateSettings() async {
     // Support file operations.
     setFileOperationDynamicRegistration();
-    // Support dynamic registration for both text sync + hovers.
+    // Support dynamic registration for text sync, hovers, and code actions.
     setTextSyncDynamicRegistration();
     setHoverDynamicRegistration();
+    setTextDocumentDynamicRegistration('codeAction');
 
     // Basic check that the server responds with the capabilities we'd expect,
-    // for ex including analysis_options.yaml in text synchronization but not
-    // for hovers.
+    // for ex including analysis_options.yaml in text synchronization (and code
+    // actions) but not for hovers.
     var registrations = <Registration>[];
     var initResponse = await monitorDynamicRegistrations(
       registrations,
@@ -440,8 +460,9 @@ class InitializationTest extends AbstractLspAnalysisServerTest {
     expect(initResult.capabilities, isNotNull);
     expect(initResult.capabilities.textDocumentSync, isNull);
 
-    // Should contain Hover, DidOpen, DidClose, DidChange, WillRenameFiles.
-    expect(registrations, hasLength(5));
+    // Should contain Hover, DidOpen, DidClose, DidChange, CodeAction,
+    // WillRenameFiles.
+    expect(registrations, hasLength(6));
     var hover = registrationOptionsFor(
       registrations,
       Method.textDocument_hover,
@@ -450,6 +471,10 @@ class InitializationTest extends AbstractLspAnalysisServerTest {
       registrations,
       Method.textDocument_didChange,
     );
+    var codeAction = registrationOptionsFor(
+      registrations,
+      Method.textDocument_codeAction,
+    );
     var rename = FileOperationRegistrationOptions.fromJson(
       registrationFor(
             registrations,
@@ -469,21 +494,30 @@ class InitializationTest extends AbstractLspAnalysisServerTest {
     // The hover capability should only specific Dart.
     expect(hover, isNotNull);
     expect(hover.documentSelector, hasLength(1));
-    expect(hover.documentSelector!.single.language, equals('dart'));
+    expect(hover.documentSelector!.single, isDartSelector);
 
     // didChange should also include pubspec + analysis_options.
     expect(change, isNotNull);
     expect(change.documentSelector, hasLength(greaterThanOrEqualTo(3)));
-    expect(change.documentSelector!.any((ds) => ds.language == 'dart'), isTrue);
     expect(
-      change.documentSelector!.any((ds) => ds.pattern == '**/pubspec.yaml'),
-      isTrue,
+      change.documentSelector,
+      containsAll([
+        isDartSelector,
+        isPubspecSelector,
+        isAnalysisOptionsSelector,
+      ]),
     );
+
+    // codeAction should also include pubspec + analysis_options.
+    expect(codeAction, isNotNull);
+    expect(codeAction.documentSelector, hasLength(greaterThanOrEqualTo(3)));
     expect(
-      change.documentSelector!.any(
-        (ds) => ds.pattern == '**/analysis_options.yaml',
-      ),
-      isTrue,
+      change.documentSelector,
+      containsAll([
+        isDartSelector,
+        isPubspecSelector,
+        isAnalysisOptionsSelector,
+      ]),
     );
 
     expect(rename, equals(fileOperationRegistrationOptions));