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

// Copyright (c) 2018, 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:analysis_server/lsp_protocol/protocol.dart';
import 'package:analysis_server/src/analysis_server.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/apply_code_action.dart';
import 'package:analysis_server/src/lsp/handlers/commands/fix_all.dart';
import 'package:analysis_server/src/lsp/handlers/commands/fix_all_in_workspace.dart';
import 'package:analysis_server/src/lsp/handlers/commands/log_action.dart';
import 'package:analysis_server/src/lsp/handlers/commands/organize_imports.dart';
import 'package:analysis_server/src/lsp/handlers/commands/perform_refactor.dart';
import 'package:analysis_server/src/lsp/handlers/commands/refactor_command_handler.dart';
import 'package:analysis_server/src/lsp/handlers/commands/send_workspace_edit.dart';
import 'package:analysis_server/src/lsp/handlers/commands/sort_members.dart';
import 'package:analysis_server/src/lsp/handlers/commands/validate_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/progress.dart';
import 'package:analysis_server/src/lsp/registration/feature_registration.dart';
import 'package:analysis_server/src/services/refactoring/framework/refactoring_processor.dart';

/// Handles workspace/executeCommand messages by delegating to a specific
/// handler based on the command.
class ExecuteCommandHandler
    extends SharedMessageHandler<ExecuteCommandParams, Object?> {
  final Map<
    String,
    CommandHandler<ExecuteCommandParams, Object, AnalysisServer>
  >
  commandHandlers;

  ExecuteCommandHandler(super.server)
    : commandHandlers = {
        // Commands that can run for any underlying server type.
        Commands.sortMembers: SortMembersCommandHandler(server),
        Commands.organizeImports: OrganizeImportsCommandHandler(server),
        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),
        },
      } {
    server.executeCommandHandler = this;
  }

  @override
  Method get handlesMessage => Method.workspace_executeCommand;

  @override
  LspJsonHandler<ExecuteCommandParams> get jsonHandler =>
      ExecuteCommandParams.jsonHandler;

  @override
  // TODO(dantup): This will need to be relaxed to support calling over DTD,
  //  but at that point we must also add this flag to Commands so that we can
  //  control which commands require trusted callers.
  bool get requiresTrustedCaller => true;

  @override
  Future<ErrorOr<Object?>> handle(
    ExecuteCommandParams params,
    MessageInfo message,
    CancellationToken token,
  ) async {
    var handler = commandHandlers[params.command];
    if (handler == null) {
      return error(
        ServerErrorCodes.UnknownCommand,
        '${params.command} is not a valid command identifier',
      );
    }

    if (!handler.recordsOwnAnalytics) {
      server.analyticsManager.executedCommand(params.command);
    }
    var workDoneToken = params.workDoneToken;
    ProgressReporter progress = ProgressReporter.noop;
    if (server case LspAnalysisServer server) {
      progress =
          workDoneToken != null
              ? ProgressReporter.clientProvided(server, workDoneToken)
              // Use editor client capabilities, as that's who gets progress
              // notifications, not the caller.
              : server.editorClientCapabilities?.workDoneProgress ?? false
              ? ProgressReporter.serverCreated(server)
              : ProgressReporter.noop;
    }

    // To make passing arguments easier in commands, instead of a
    // `List<Object?>` we now use `Map<String, Object?>`.
    //
    // However, some handlers still support the list for compatibility so we
    // must allow them to convert a `List` to a `Map`.
    var arguments = params.arguments ?? const [];
    Map<String, Object?> commandParams;
    if (handler case PositionalArgCommandHandler argHandler) {
      commandParams = argHandler.parseArgList(arguments);
    } else if (arguments.isEmpty) {
      commandParams = {};
    } else if (arguments.length == 1 && arguments[0] is Map<String, Object?>) {
      commandParams = arguments.single as Map<String, Object?>;
    } else {
      return ErrorOr.error(
        ResponseError(
          code: ServerErrorCodes.InvalidCommandArguments,
          message: '${params.command} requires a single Map argument',
        ),
      );
    }

    return handler.handle(message, commandParams, progress, token);
  }
}

class ExecuteCommandRegistrations extends FeatureRegistration
    with StaticRegistration<ExecuteCommandOptions> {
  ExecuteCommandRegistrations(super.info);

  @override
  List<LspDynamicRegistration> get dynamicRegistrations => [];

  @override
  ExecuteCommandOptions get staticOptions => ExecuteCommandOptions(
    commands: Commands.serverSupportedCommands,
    workDoneProgress: true,
  );

  @override
  bool get supportsDynamic => false;
}