[analysis_server] Check for applyEdit support before handling EditArguments

If we get an editArgument request (usually via DDS), we should verify the connected editor supports edits and return an explicit message if not.

Also adds a `setUp()` declaration to `SharedTestInterface` so shared tests can set client capabilities instead of them being duplicated in each test class (and moves the same for ApplyEdit tests to this).

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

Author: DanTup

pkg/analysis_server/lib/src/lsp/handlers/custom/editable_arguments/handler_edit_argument.dart

@@ -47,6 +47,13 @@ class EditArgumentHandler extends SharedMessageHandler<EditArgumentParams, Null>
       return serverNotInitializedError;
     }
 
+    if (!editorClientCapabilities.applyEdit) {
+      return error(
+        ErrorCodes.RequestFailed,
+        'The connected editor does not support applying edits',
+      );
+    }
+
     var textDocument = params.textDocument;
     var position = params.position;
 

pkg/analysis_server/test/lsp/edit_argument_test.dart

@@ -221,8 +221,8 @@ class EditArgumentTest extends SharedAbstractLspAnalysisServerTest
         with
         SharedEditArgumentTests {
   @override
-  void setUp() {
-    super.setUp();
+  Future<void> setUp() async {
+    await super.setUp();
 
     writeTestPackageConfig(flutter: true);
   }

pkg/analysis_server/test/lsp/workspace_apply_edit_test.dart

@@ -18,12 +18,4 @@ class WorkspaceApplyEditTest extends SharedAbstractLspAnalysisServerTest
     with
         // Tests are defined in SharedWorkspaceApplyEditTests because they
         // are shared and run for both LSP and Legacy servers.
-        SharedWorkspaceApplyEditTests {
-  @override
-  Future<void> setUp() async {
-    super.setUp();
-    setApplyEditSupport();
-    setFileCreateSupport();
-    setDocumentChangesSupport();
-  }
-}
+        SharedWorkspaceApplyEditTests {}

pkg/analysis_server/test/lsp_over_legacy/edit_argument_test.dart

@@ -2,6 +2,8 @@
 // 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 'dart:async';
+
 import 'package:test_reflective_loader/test_reflective_loader.dart';
 
 import '../shared/shared_edit_argument_tests.dart';
@@ -19,6 +21,12 @@ class EditArgumentTest extends SharedLspOverLegacyTest
         // Tests are defined in SharedEditArgumentTests because they
         // are shared and run for both LSP and Legacy servers.
         SharedEditArgumentTests {
+  @override
+  Future<void> initializeServer() async {
+    await super.initializeServer();
+    await sendClientCapabilities();
+  }
+
   @override
   Future<void> setUp() async {
     await super.setUp();

pkg/analysis_server/test/lsp_over_legacy/workspace_apply_edit_test.dart

@@ -24,12 +24,4 @@ class WorkspaceApplyEditTest extends SharedLspOverLegacyTest
     await super.initializeServer();
     await sendClientCapabilities();
   }
-
-  @override
-  Future<void> setUp() async {
-    await super.setUp();
-    setApplyEditSupport();
-    setFileCreateSupport();
-    setDocumentChangesSupport();
-  }
 }

pkg/analysis_server/test/shared/shared_edit_argument_tests.dart

@@ -2,21 +2,34 @@
 // 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 'dart:async';
+
 import 'package:analysis_server/lsp_protocol/protocol.dart';
 import 'package:analyzer/src/test_utilities/test_code_format.dart';
 import 'package:test/test.dart';
 
 import '../lsp/request_helpers_mixin.dart';
+import '../lsp/server_abstract.dart';
 import '../tool/lsp_spec/matchers.dart';
 import '../utils/test_code_extensions.dart';
 import 'shared_test_interface.dart';
 
 /// Shared edit argument tests that are used by both LSP + Legacy server
 /// tests.
 mixin SharedEditArgumentTests
-    on SharedTestInterface, LspRequestHelpersMixin, LspVerifyEditHelpersMixin {
+    on
+        SharedTestInterface,
+        LspRequestHelpersMixin,
+        LspVerifyEditHelpersMixin,
+        ClientCapabilitiesHelperMixin {
   late TestCode code;
 
+  @override
+  Future<void> setUp() async {
+    await super.setUp();
+    setApplyEditSupport();
+  }
+
   test_comma_addArg_addsIfExists() async {
     await _expectSimpleArgumentEdit(
       params: '({ int? x, int? y })',
@@ -627,6 +640,17 @@ const myConst = E.one;
     );
   }
 
+  test_unsupported_noApplyEditSupport() async {
+    setApplyEditSupport(false);
+
+    await _expectFailedEdit(
+      params: '({ required String x })',
+      originalArgs: "(x: 'a')",
+      edit: ArgumentEdit(name: 'x'),
+      message: 'The connected editor does not support applying edits',
+    );
+  }
+
   /// Initializes the server with [content] and tries to apply the argument
   /// [edit] at the marked location. Verifies the changes made match
   /// [expectedContent].

pkg/analysis_server/test/shared/shared_test_interface.dart

@@ -2,6 +2,8 @@
 // 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 'dart:async';
+
 /// A common interface that can be implemented by a set of base classes to
 /// allow tests to be written to run in different configurations
 /// (LSP and LSP-over-Legacy, and in-process and out-of-process).
@@ -49,4 +51,6 @@ abstract interface class SharedTestInterface {
   /// Tells the server that the file with [uri] has had it's content replaced
   /// with [content].
   Future<void> replaceFile(int newVersion, Uri uri, String content);
+
+  FutureOr<void> setUp();
 }

pkg/analysis_server/test/shared/shared_workspace_apply_edit_tests.dart

@@ -12,27 +12,30 @@ import 'package:test/test.dart';
 
 import '../lsp/change_verifier.dart';
 import '../lsp/request_helpers_mixin.dart';
+import '../lsp/server_abstract.dart';
+import 'shared_test_interface.dart';
 
 /// Shared `workspace/applyEdit` tests that are used by both LSP and legacy
 /// server tests.
 mixin SharedWorkspaceApplyEditTests
-    on LspRequestHelpersMixin, LspVerifyEditHelpersMixin {
-  /// Overridden by test subclasses to provide the path of a file for testing.
-  String get testFilePath;
-
-  /// The URI for [testFilePath].
-  Uri get testFileUri => Uri.file(testFilePath);
-
-  /// Overridden by test subclasses to create a new file.
-  void createFile(String path, String content);
-
-  /// Overridden by test subclasses to initialize the server.
-  Future<void> initializeServer();
-
+    on
+        SharedTestInterface,
+        LspRequestHelpersMixin,
+        LspVerifyEditHelpersMixin,
+        ClientCapabilitiesHelperMixin {
   /// Overridden by test subclasses to send LSP requests from the server to
   /// the client.
   Future<ResponseMessage> sendLspRequest(Method method, Object params);
 
+  /// Overridden by test subclasses to initialize the server.
+  @override
+  Future<void> setUp() async {
+    super.setUp();
+    setApplyEditSupport();
+    setFileCreateSupport();
+    setDocumentChangesSupport();
+  }
+
   test_applyEdit_existingFile() async {
     var code = TestCode.parse('''
 void f() {