[analysis_server] Enable textDocument/codeActions and related refactor commands for LSP-over-Legacy

This moves the codeAction handler and the refactor commands to be shared (and therefor work for either base server kind). It also adds LSP-over-Legacy test classes that use the shared mixins so that all relevant tests run in both modes.

It does _not_ yet enable this functionality for DTD (though this is a requirement to do so in a way that will work for either IDE/server).

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

Author: DanTup

pkg/analysis_server/lib/src/lsp/handlers/commands/abstract_refactor.dart

@@ -5,12 +5,12 @@
 import 'dart:async';
 
 import 'package:analysis_server/lsp_protocol/protocol.dart';
+import 'package:analysis_server/src/analysis_server.dart';
 import 'package:analysis_server/src/lsp/client_capabilities.dart';
 import 'package:analysis_server/src/lsp/constants.dart';
 import 'package:analysis_server/src/lsp/error_or.dart';
 import 'package:analysis_server/src/lsp/handlers/commands/simple_edit_handler.dart';
 import 'package:analysis_server/src/lsp/handlers/handlers.dart';
-import 'package:analysis_server/src/lsp/lsp_analysis_server.dart';
 import 'package:analysis_server/src/lsp/progress.dart';
 import 'package:analysis_server/src/protocol_server.dart';
 import 'package:analysis_server/src/services/refactoring/legacy/refactoring.dart';
@@ -23,7 +23,7 @@ final _manager = LspRefactorManager._();
 /// A base class for refactoring commands that need to create Refactorings from
 /// client-supplied arguments.
 abstract class AbstractRefactorCommandHandler
-    extends SimpleEditCommandHandler<LspAnalysisServer>
+    extends SimpleEditCommandHandler<AnalysisServer>
     with PositionalArgCommandHandler {
   AbstractRefactorCommandHandler(super.server);
 

pkg/analysis_server/lib/src/lsp/handlers/commands/perform_refactor.dart

@@ -8,6 +8,7 @@ import 'package:analysis_server/src/lsp/client_capabilities.dart';
 import 'package:analysis_server/src/lsp/error_or.dart';
 import 'package:analysis_server/src/lsp/handlers/commands/abstract_refactor.dart';
 import 'package:analysis_server/src/lsp/handlers/handlers.dart';
+import 'package:analysis_server/src/lsp/lsp_analysis_server.dart';
 import 'package:analysis_server/src/lsp/mapping.dart';
 import 'package:analysis_server/src/lsp/progress.dart';
 import 'package:analysis_server/src/protocol_server.dart';
@@ -74,7 +75,10 @@ class PerformRefactorCommandHandler extends AbstractRefactorCommandHandler {
             // Show the error to the user but don't fail the request, as the
             // LSP Client may show a failed request in a way that looks like a
             // server error.
-            server.showErrorMessageToUser(status.message!);
+            if (server case LspAnalysisServer server) {
+              // Error notifications are not supported for LSP-over-Legacy.
+              server.showErrorMessageToUser(status.message!);
+            }
             return success(null);
           }
 

pkg/analysis_server/lib/src/lsp/handlers/commands/refactor_command_handler.dart

@@ -3,12 +3,12 @@
 // BSD-style license that can be found in the LICENSE file.
 
 import 'package:analysis_server/lsp_protocol/protocol.dart';
+import 'package:analysis_server/src/analysis_server.dart';
 import 'package:analysis_server/src/lsp/client_capabilities.dart';
 import 'package:analysis_server/src/lsp/constants.dart';
 import 'package:analysis_server/src/lsp/error_or.dart';
 import 'package:analysis_server/src/lsp/handlers/commands/simple_edit_handler.dart';
 import 'package:analysis_server/src/lsp/handlers/handlers.dart';
-import 'package:analysis_server/src/lsp/lsp_analysis_server.dart';
 import 'package:analysis_server/src/lsp/mapping.dart';
 import 'package:analysis_server/src/lsp/progress.dart';
 import 'package:analysis_server/src/lsp/source_edits.dart';
@@ -19,8 +19,7 @@ import 'package:analyzer/dart/analysis/results.dart';
 import 'package:analyzer_plugin/utilities/change_builder/change_builder_core.dart';
 
 /// A command handler for any of the commands used to implement refactorings.
-class RefactorCommandHandler
-    extends SimpleEditCommandHandler<LspAnalysisServer> {
+class RefactorCommandHandler extends SimpleEditCommandHandler<AnalysisServer> {
   @override
   final String commandName;
 

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

@@ -14,7 +14,8 @@ import 'package:analysis_server/src/lsp/registration/feature_registration.dart';
 typedef StaticOptions = Either2<bool, CodeActionOptions>;
 
 class CodeActionHandler
-    extends LspMessageHandler<CodeActionParams, TextDocumentCodeActionResult> {
+    extends
+        SharedMessageHandler<CodeActionParams, TextDocumentCodeActionResult> {
   CodeActionHandler(super.server);
 
   @override
@@ -24,6 +25,9 @@ class CodeActionHandler
   LspJsonHandler<CodeActionParams> get jsonHandler =>
       CodeActionParams.jsonHandler;
 
+  @override
+  bool get requiresTrustedCaller => false;
+
   @override
   Future<ErrorOr<TextDocumentCodeActionResult>> handle(
     CodeActionParams params,

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

@@ -40,18 +40,18 @@ class ExecuteCommandHandler
         Commands.sendWorkspaceEdit: SendWorkspaceEditCommandHandler(server),
         Commands.logAction: LogActionCommandHandler(server),
         Commands.applyCodeAction: ApplyCodeActionCommandHandler(server),
+        Commands.performRefactor: PerformRefactorCommandHandler(server),
+        Commands.validateRefactor: ValidateRefactorCommandHandler(server),
+        // Add commands for each of the refactorings.
+        for (var entry in RefactoringProcessor.generators.entries)
+          entry.key: RefactorCommandHandler(server, entry.key, entry.value),
 
         // Commands that currently require an underlying LSP server.
         if (server is LspAnalysisServer) ...{
           Commands.fixAll: FixAllCommandHandler(server),
           Commands.fixAllInWorkspace: FixAllInWorkspaceCommandHandler(server),
           Commands.previewFixAllInWorkspace:
               PreviewFixAllInWorkspaceCommandHandler(server),
-          Commands.performRefactor: PerformRefactorCommandHandler(server),
-          Commands.validateRefactor: ValidateRefactorCommandHandler(server),
-          // Add commands for each of the refactorings.
-          for (var entry in RefactoringProcessor.generators.entries)
-            entry.key: RefactorCommandHandler(server, entry.key, entry.value),
         },
       } {
     server.executeCommandHandler = this;

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

@@ -91,7 +91,6 @@ class InitializedLspStateMessageHandler extends InitializedStateMessageHandler {
         DefinitionHandler.new,
         DocumentLinkHandler.new,
         ReferencesHandler.new,
-        CodeActionHandler.new,
         ChangeWorkspaceFoldersHandler.new,
         PrepareRenameHandler.new,
         RenameHandler.new,
@@ -123,6 +122,7 @@ class InitializedStateMessageHandler extends ServerStateMessageHandler {
       <_RequestHandlerGenerator<AnalysisServer>>[
         AugmentationHandler.new,
         AugmentedHandler.new,
+        CodeActionHandler.new,
         CodeLensHandler.new,
         ConnectToDtdHandler.new,
         DartTextDocumentContentProviderHandler.new,

pkg/analysis_server/test/lsp_over_legacy/abstract_code_actions.dart

@@ -0,0 +1,18 @@
+// Copyright (c) 2025, 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 '../lsp/code_actions_mixin.dart';
+import 'abstract_lsp_over_legacy.dart';
+
+class AbstractCodeActionsTest extends SharedLspOverLegacyTest
+    with CodeActionsTestMixin {
+  @override
+  Future<void> initializeServer() async {
+    await super.initializeServer();
+
+    // Most CodeActions tests set LSP capabilities so automatically send these
+    // to the legacy server as part of initialization.
+    await sendClientCapabilities();
+  }
+}

pkg/analysis_server/test/lsp_over_legacy/abstract_lsp_over_legacy.dart

@@ -422,12 +422,22 @@ abstract class SharedLspOverLegacyTest extends LspOverLegacyTest
   // TODO(dantup): Support this for LSP-over-Legacy shared tests.
   var failTestOnErrorDiagnostic = false;
 
+  /// The current set of priority files. This is the same as the set of
+  /// currently-open files (see [openFile]/[closeFile]).
+  final Set<String> _priorityFiles = {};
+
   @override
   Future<void> get currentAnalysis => waitForTasksFinished();
 
   @override
   Future<void> closeFile(Uri uri) async {
-    await removeOverlay(fromUri(uri));
+    // closeFile should both remove the overlay and remove from priority files,
+    // since that's equivalent of what the LSP document handlers do and shared
+    // tests need to have the same behaviour.
+    var filePath = fromUri(uri);
+    await removeOverlay(filePath);
+    _priorityFiles.remove(filePath);
+    _updatePriorityFiles();
   }
 
   @override
@@ -442,7 +452,13 @@ abstract class SharedLspOverLegacyTest extends LspOverLegacyTest
 
   @override
   Future<void> openFile(Uri uri, String content, {int version = 1}) async {
-    await addOverlay(fromUri(uri), content, version);
+    // closeFile should both add an overlay and add to priority files,
+    // since that's equivalent of what the LSP document handlers do and shared
+    // tests need to have the same behaviour.
+    var filePath = fromUri(uri);
+    await addOverlay(filePath, content, version);
+    _priorityFiles.add(filePath);
+    _updatePriorityFiles();
   }
 
   /// Opens a file content without providing a version number.
@@ -469,4 +485,8 @@ abstract class SharedLspOverLegacyTest extends LspOverLegacyTest
     // For legacy, we can use addOverlay to replace the whole file.
     await addOverlay(fromUri(uri), content);
   }
+
+  void _updatePriorityFiles() {
+    setPriorityFiles(_priorityFiles.map(getFile).toList());
+  }
 }

pkg/analysis_server/test/lsp_over_legacy/code_action_assists_test.dart

@@ -0,0 +1,20 @@
+// Copyright (c) 2025, 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:test_reflective_loader/test_reflective_loader.dart';
+
+import '../shared/shared_code_actions_assists_tests.dart';
+import 'abstract_code_actions.dart';
+
+void main() {
+  defineReflectiveSuite(() {
+    defineReflectiveTests(CodeActionAssistsTest);
+  });
+}
+
+@reflectiveTest
+class CodeActionAssistsTest extends AbstractCodeActionsTest
+    with
+        // Tests are defined in a shared mixin.
+        SharedAssistsCodeActionsTests {}

pkg/analysis_server/test/lsp_over_legacy/code_action_fixes_test.dart

@@ -0,0 +1,20 @@
+// Copyright (c) 2025, 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:test_reflective_loader/test_reflective_loader.dart';
+
+import '../shared/shared_code_actions_fixes_tests.dart';
+import 'abstract_code_actions.dart';
+
+void main() {
+  defineReflectiveSuite(() {
+    defineReflectiveTests(CodeActionFixesTest);
+  });
+}
+
+@reflectiveTest
+class CodeActionFixesTest extends AbstractCodeActionsTest
+    with
+        // Tests are defined in a shared mixin.
+        SharedFixesCodeActionsTests {}