[analysis_server] Add a CodeAction typedef for CodeActionLiteral | Command

Following on from a previous change to use the term `CodeAction` (an item returned from a `textDocument/codeAction` request) to mean either a `CodeActionLiteral` (which contains inline edits and/or a command) or a base `Command`, this adds a typedef describing the same and updates all code that used `Either2<CodeActionLiteral, Command>` to instead use the typedef.

It also renames a few additional methods/functions to be more consistent with these terms and adds a `CodeActionExtension` to simplify extracting fields like `command` and `title` from either kind of code action.

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

Author: DanTup

pkg/analysis_server/lib/src/lsp/handlers/code_actions/abstract_code_actions_producer.dart

@@ -180,11 +180,11 @@ abstract class AbstractCodeActionsProducer
     OperationPerformance? performance,
   );
 
-  Future<List<Either2<CodeActionLiteral, Command>>> getRefactorActions(
+  Future<List<CodeAction>> getRefactorActions(
     OperationPerformance? performance,
   );
 
-  Future<List<Either2<CodeActionLiteral, Command>>> getSourceActions();
+  Future<List<CodeAction>> getSourceActions();
 
   /// Return the contents of the [file], or `null` if the file does not exist or
   /// cannot be read.

pkg/analysis_server/lib/src/lsp/handlers/code_actions/analysis_options.dart

@@ -111,13 +111,12 @@ class AnalysisOptionsCodeActionsProducer extends AbstractCodeActionsProducer {
   }
 
   @override
-  Future<List<Either2<CodeActionLiteral, Command>>> getRefactorActions(
+  Future<List<CodeAction>> getRefactorActions(
     OperationPerformance? performance,
   ) async => [];
 
   @override
-  Future<List<Either2<CodeActionLiteral, Command>>> getSourceActions() async =>
-      [];
+  Future<List<CodeAction>> getSourceActions() async => [];
 
   YamlMap? _getOptions(SourceFactory sourceFactory, String content) {
     var optionsProvider = AnalysisOptionsProvider(sourceFactory);

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

@@ -58,9 +58,9 @@ class DartCodeActionsProducer extends AbstractCodeActionsProducer {
   @override
   String get name => 'ServerDartActionsComputer';
 
-  /// Helper to create a [CodeActionLiteral] or [Command] for the given arguments in
-  /// the current file based on client capabilities.
-  Either2<CodeActionLiteral, Command> createCommand(
+  /// Helper to create a [CodeAction] for the given arguments in the current
+  /// file based on client capabilities.
+  CodeAction createAction(
     CodeActionKind actionKind,
     String title,
     String command,
@@ -69,7 +69,7 @@ class DartCodeActionsProducer extends AbstractCodeActionsProducer {
       (() => Commands.serverSupportedCommands.contains(command))(),
       'serverSupportedCommands did not contain $command',
     );
-    return _commandOrCodeAction(
+    return _commandOrCodeActionLiteral(
       actionKind,
       Command(
         title: title,
@@ -87,7 +87,7 @@ class DartCodeActionsProducer extends AbstractCodeActionsProducer {
 
   /// Helper to create refactors that execute commands provided with
   /// the current file, location and document version.
-  Either2<CodeActionLiteral, Command> createRefactor(
+  CodeAction createRefactor(
     CodeActionKind actionKind,
     String name,
     RefactoringKind refactorKind, [
@@ -99,7 +99,7 @@ class DartCodeActionsProducer extends AbstractCodeActionsProducer {
       'serverSupportedCommands did not contain $command',
     );
 
-    return _commandOrCodeAction(
+    return _commandOrCodeActionLiteral(
       actionKind,
       Command(
         title: name,
@@ -263,7 +263,7 @@ class DartCodeActionsProducer extends AbstractCodeActionsProducer {
   }
 
   @override
-  Future<List<Either2<CodeActionLiteral, Command>>> getRefactorActions(
+  Future<List<CodeAction>> getRefactorActions(
     OperationPerformance? performance,
   ) async {
     // If the client does not support workspace/applyEdit, we won't be able to
@@ -272,7 +272,7 @@ class DartCodeActionsProducer extends AbstractCodeActionsProducer {
       return const [];
     }
 
-    var refactorActions = <Either2<CodeActionLiteral, Command>>[];
+    var refactorActions = <CodeAction>[];
     var performanceTracker = RefactoringPerformance();
 
     try {
@@ -293,9 +293,7 @@ class DartCodeActionsProducer extends AbstractCodeActionsProducer {
         performance: performanceTracker,
       );
       var actions = await processor.compute();
-      refactorActions.addAll(
-        actions.map(Either2<CodeActionLiteral, Command>.t1),
-      );
+      refactorActions.addAll(actions.map(CodeAction.t1));
 
       // Extracts
       if (shouldIncludeKind(CodeActionKind.RefactorExtract)) {
@@ -471,7 +469,7 @@ class DartCodeActionsProducer extends AbstractCodeActionsProducer {
   /// Gets "Source" CodeActions, which are actions that apply to whole files of
   /// source such as Sort Members and Organise Imports.
   @override
-  Future<List<Either2<CodeActionLiteral, Command>>> getSourceActions() async {
+  Future<List<CodeAction>> getSourceActions() async {
     // If the client does not support workspace/applyEdit, we won't be able to
     // run any of these.
     if (!supportsApplyEdit) {
@@ -480,33 +478,30 @@ class DartCodeActionsProducer extends AbstractCodeActionsProducer {
 
     return [
       if (shouldIncludeKind(DartCodeActionKind.SortMembers))
-        createCommand(
+        createAction(
           DartCodeActionKind.SortMembers,
           'Sort Members',
           Commands.sortMembers,
         ),
       if (shouldIncludeKind(CodeActionKind.SourceOrganizeImports))
-        createCommand(
+        createAction(
           CodeActionKind.SourceOrganizeImports,
           'Organize Imports',
           Commands.organizeImports,
         ),
       if (shouldIncludeKind(DartCodeActionKind.FixAll))
-        createCommand(DartCodeActionKind.FixAll, 'Fix All', Commands.fixAll),
+        createAction(DartCodeActionKind.FixAll, 'Fix All', Commands.fixAll),
     ];
   }
 
   /// Wraps a command in a CodeAction if the client supports it so that a
   /// CodeActionKind can be supplied.
-  Either2<CodeActionLiteral, Command> _commandOrCodeAction(
-    CodeActionKind kind,
-    Command command,
-  ) {
+  CodeAction _commandOrCodeActionLiteral(CodeActionKind kind, Command command) {
     return supportsLiterals
-        ? Either2<CodeActionLiteral, Command>.t1(
+        ? CodeAction.t1(
           CodeActionLiteral(title: command.title, kind: kind, command: command),
         )
-        : Either2<CodeActionLiteral, Command>.t2(command);
+        : CodeAction.t2(command);
   }
 }
 

pkg/analysis_server/lib/src/lsp/handlers/code_actions/plugins.dart

@@ -71,13 +71,12 @@ class PluginCodeActionsProducer extends AbstractCodeActionsProducer {
   }
 
   @override
-  Future<List<Either2<CodeActionLiteral, Command>>> getRefactorActions(
+  Future<List<CodeAction>> getRefactorActions(
     OperationPerformance? performance,
   ) async => [];
 
   @override
-  Future<List<Either2<CodeActionLiteral, Command>>> getSourceActions() async =>
-      [];
+  Future<List<CodeAction>> getSourceActions() async => [];
 
   CodeActionWithPriority _convertAssist(plugin.PrioritizedSourceChange assist) {
     return (

pkg/analysis_server/lib/src/lsp/handlers/code_actions/pubspec.dart

@@ -97,11 +97,10 @@ class PubspecCodeActionsProducer extends AbstractCodeActionsProducer {
   }
 
   @override
-  Future<List<Either2<CodeActionLiteral, Command>>> getRefactorActions(
+  Future<List<CodeAction>> getRefactorActions(
     OperationPerformance? performance,
   ) async => [];
 
   @override
-  Future<List<Either2<CodeActionLiteral, Command>>> getSourceActions() async =>
-      [];
+  Future<List<CodeAction>> getSourceActions() async => [];
 }

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

@@ -219,7 +219,7 @@ class CodeActionHandler
         ];
         var sorter = _CodeActionSorter(params.range, shouldIncludeKind);
 
-        var allActions = <Either2<CodeActionLiteral, Command>>[
+        var allActions = <CodeAction>[
           // Like-kinded actions are grouped (and prioritized) together
           // regardless of which producer they came from.
 
@@ -306,9 +306,7 @@ class _CodeActionSorter {
 
   _CodeActionSorter(this.range, this.shouldIncludeKind);
 
-  List<Either2<CodeActionLiteral, Command>> sort(
-    List<CodeActionWithPriority> actions,
-  ) {
+  List<CodeAction> sort(List<CodeActionWithPriority> actions) {
     var dedupedActions = _dedupeActions(actions, range.start);
 
     // Add each index so we can do a stable sort on priority.
@@ -325,7 +323,7 @@ class _CodeActionSorter {
 
     return dedupedActionsWithIndex
         .where((action) => shouldIncludeKind(action.action.kind))
-        .map((action) => Either2<CodeActionLiteral, Command>.t1(action.action))
+        .map((action) => CodeAction.t1(action.action))
         .toList();
   }
 

pkg/analysis_server/test/integration/server/message_scheduler_test.dart

@@ -118,10 +118,7 @@ void f() {
 ''';
 
     newFile(mainFilePath, content);
-    // await initialize();
-    // var code = TestCode.parse(content);
-    // await openFile(mainFileUri, code.code);
-    var codeAction = await expectAction(
+    var codeAction = await expectCodeActionLiteral(
       content,
       command: Commands.performRefactor,
       title: extractMethodTitle,
@@ -308,7 +305,7 @@ void f() {
 }
 ''';
 
-    var codeAction = await expectAction(
+    var codeAction = await expectCodeActionLiteral(
       content,
       command: Commands.performRefactor,
       title: extractMethodTitle,

pkg/analysis_server/test/lsp/code_actions_abstract.dart

@@ -3,20 +3,22 @@
 // BSD-style license that can be found in the LICENSE file.
 
 import 'package:analysis_server/lsp_protocol/protocol.dart';
+import 'package:analysis_server/src/lsp/constants.dart';
 import 'package:analysis_server/src/services/correction/assist_internal.dart';
 import 'package:analysis_server/src/services/correction/fix_internal.dart';
 import 'package:analyzer/src/test_utilities/test_code_format.dart';
 import 'package:collection/collection.dart';
 import 'package:test/test.dart';
 
+import '../utils/lsp_protocol_extensions.dart';
 import '../utils/test_code_extensions.dart';
 import 'change_verifier.dart';
 import 'server_abstract.dart';
 
 abstract class AbstractCodeActionsTest extends AbstractLspAnalysisServerTest {
   /// Initializes the server with some basic configuration and expects to find
-  /// a [CodeActionLiteral] with [kind]/[command]/[title].
-  Future<CodeActionLiteral> expectAction(
+  /// a [CodeAction] with [kind]/[command]/[title].
+  Future<CodeActionLiteral> expectCodeActionLiteral(
     String content, {
     CodeActionKind? kind,
     String? command,
@@ -44,7 +46,7 @@ abstract class AbstractCodeActionsTest extends AbstractLspAnalysisServerTest {
       triggerKind: triggerKind,
     );
 
-    var action = findAction(
+    var action = findCodeActionLiteral(
       codeActions,
       kind: kind,
       command: command,
@@ -95,25 +97,31 @@ abstract class AbstractCodeActionsTest extends AbstractLspAnalysisServerTest {
     );
 
     expect(
-      findAction(codeActions, kind: kind, command: command, title: title),
+      findCodeActionLiteral(
+        codeActions,
+        kind: kind,
+        command: command,
+        title: title,
+      ),
       isNull,
     );
   }
 
-  /// Finds the single action matching [title], [kind] and [command].
+  /// Finds the single [CodeActionLiteral] matching [title], [kind] and
+  /// [command].
   ///
-  /// If [command] and/or [commandArgs] are supplied, ensures the action has
-  /// a matching command/args.
+  /// If [command] and/or [commandArgs] are supplied, ensures the result is
+  /// either that command, or a literal code action with that command.
   ///
-  /// Throws if zero or more than one actions match.
-  CodeActionLiteral? findAction(
-    List<Either2<CodeActionLiteral, Command>> actions, {
+  /// Returns `null` if there is not exactly one match.
+  CodeActionLiteral? findCodeActionLiteral(
+    List<CodeAction> actions, {
     String? title,
     CodeActionKind? kind,
     String? command,
     List<Object>? commandArgs,
   }) {
-    return findActions(
+    return findCodeActionLiterals(
       actions,
       title: title,
       kind: kind,
@@ -122,7 +130,7 @@ abstract class AbstractCodeActionsTest extends AbstractLspAnalysisServerTest {
     ).singleOrNull;
   }
 
-  List<CodeActionLiteral> findActions(
+  List<CodeActionLiteral> findCodeActionLiterals(
     List<Either2<CodeActionLiteral, Command>> actions, {
     String? title,
     CodeActionKind? kind,
@@ -165,17 +173,14 @@ abstract class AbstractCodeActionsTest extends AbstractLspAnalysisServerTest {
         .toList();
   }
 
-  Either2<CodeActionLiteral, Command>? findCommand(
-    List<Either2<CodeActionLiteral, Command>> actions,
+  CodeAction? findCommand(
+    List<CodeAction> actions,
     String commandID, [
     String? wantedTitle,
   ]) {
     for (var codeAction in actions) {
-      var id = codeAction.map(
-        (action) => action.command?.command,
-        (cmd) => cmd.command,
-      );
-      var title = codeAction.map((cmd) => cmd.title, (action) => action.title);
+      var id = codeAction.command?.command;
+      var title = codeAction.title;
       if (id == commandID && (wantedTitle == null || wantedTitle == title)) {
         return codeAction;
       }
@@ -201,7 +206,7 @@ abstract class AbstractCodeActionsTest extends AbstractLspAnalysisServerTest {
   /// Initializes the server with some basic configuration and expects to find
   /// a [CodeActionLiteral] with [kind]/[title] that applies edits resulting in
   /// [expected].
-  Future<LspChangeVerifier> verifyActionEdits(
+  Future<LspChangeVerifier> verifyCodeActionLiteralEdits(
     String content,
     String expected, {
     String? filePath,
@@ -222,7 +227,7 @@ ${LspChangeVerifier.editMarkerStart} ${relativePath(filePath)}
 $expected''';
     }
 
-    var action = await expectAction(
+    var action = await expectCodeActionLiteral(
       filePath: filePath,
       content,
       kind: kind,
@@ -236,7 +241,7 @@ $expected''';
     // the edits attached directly to the code action.
     // Don't try to execute 'dart.logAction' because it will never produce
     // edits.
-    if (command != null && command != 'dart.logAction') {
+    if (command != null && command != Commands.logAction) {
       return await verifyCommandEdits(
         action.command!,
         expected,