[Analyzer] Add support to LSP server for updating imports on file renames

Fixes Dart-Code/Dart-Code#2761.

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

Author: DanTup

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

@@ -32,6 +32,7 @@ import 'package:analysis_server/src/lsp/handlers/handler_rename.dart';
 import 'package:analysis_server/src/lsp/handlers/handler_shutdown.dart';
 import 'package:analysis_server/src/lsp/handlers/handler_signature_help.dart';
 import 'package:analysis_server/src/lsp/handlers/handler_text_document_changes.dart';
+import 'package:analysis_server/src/lsp/handlers/handler_will_rename_files.dart';
 import 'package:analysis_server/src/lsp/handlers/handler_workspace_configuration.dart';
 import 'package:analysis_server/src/lsp/handlers/handler_workspace_symbols.dart';
 import 'package:analysis_server/src/lsp/handlers/handlers.dart';
@@ -100,6 +101,7 @@ class InitializedStateMessageHandler extends ServerStateMessageHandler {
     registerHandler(WorkspaceSymbolHandler(server));
     registerHandler(WorkspaceDidChangeConfigurationMessageHandler(server));
     registerHandler(ReanalyzeHandler(server));
+    registerHandler(WillRenameFilesHandler(server));
   }
 }
 

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

@@ -0,0 +1,60 @@
+// Copyright (c) 2020, 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_generated.dart';
+import 'package:analysis_server/lsp_protocol/protocol_special.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/services/refactoring/refactoring.dart';
+
+class WillRenameFilesHandler extends MessageHandler<RenameFilesParams, void> {
+  WillRenameFilesHandler(LspAnalysisServer server) : super(server);
+  @override
+  Method get handlesMessage => Method.workspace_willRenameFiles;
+
+  @override
+  LspJsonHandler<RenameFilesParams> get jsonHandler =>
+      RenameFilesParams.jsonHandler;
+
+  @override
+  Future<ErrorOr<WorkspaceEdit>> handle(
+      RenameFilesParams params, CancellationToken token) async {
+    final files = params?.files ?? [];
+    // For performance reasons, only single-file rename/moves are currently supported.
+    if (files.length > 1 || files.any((f) => !f.oldUri.endsWith('.dart'))) {
+      return success(null);
+    }
+
+    final file = files.single;
+    final oldPath = pathOfUri(Uri.tryParse(file.oldUri));
+    final newPath = pathOfUri(Uri.tryParse(file.newUri));
+    return oldPath.mapResult((oldPath) =>
+        newPath.mapResult((newPath) => _renameFile(oldPath, newPath)));
+  }
+
+  Future<ErrorOr<WorkspaceEdit>> _renameFile(
+      String oldPath, String newPath) async {
+    final resolvedUnit = await server.getResolvedUnit(oldPath);
+    if (resolvedUnit == null) {
+      return success(null);
+    }
+
+    final refactoring = MoveFileRefactoring(server.resourceProvider,
+        server.refactoringWorkspace, resolvedUnit, oldPath)
+      ..newFile = newPath;
+
+    // If we're unable to update imports for a rename, we should silently do
+    // nothing rather than interrupt the users file rename with an error.
+    final results = await refactoring.checkAllConditions();
+    if (results.hasFatalError) {
+      return success(null);
+    }
+
+    final change = await refactoring.createChange();
+    final edit = createWorkspaceEdit(server, change.edits);
+
+    return success(edit);
+  }
+}

pkg/analysis_server/lib/src/lsp/server_capabilities_computer.dart

@@ -35,6 +35,9 @@ class ClientDynamicRegistrations {
     Method.textDocument_codeAction,
     Method.textDocument_rename,
     Method.textDocument_foldingRange,
+    // workspace.fileOperations covers all file operation methods but we only
+    // support this one.
+    Method.workspace_willRenameFiles,
   ];
   final ClientCapabilities _capabilities;
 
@@ -60,6 +63,9 @@ class ClientDynamicRegistrations {
   bool get documentSymbol =>
       _capabilities.textDocument?.documentSymbol?.dynamicRegistration ?? false;
 
+  bool get fileOperations =>
+      _capabilities.workspace?.fileOperations?.dynamicRegistration ?? false;
+
   bool get folding =>
       _capabilities.textDocument?.foldingRange?.dynamicRegistration ?? false;
 
@@ -93,6 +99,19 @@ class ClientDynamicRegistrations {
 }
 
 class ServerCapabilitiesComputer {
+  static final fileOperationRegistrationOptions =
+      FileOperationRegistrationOptions(
+    filters: [
+      FileOperationFilter(
+        scheme: 'file',
+        pattern: FileOperationPattern(
+          glob: '**/*.dart',
+          matches: FileOperationPatternKind.file,
+        ),
+      )
+    ],
+  );
+
   final LspAnalysisServer _server;
 
   /// Map from method name to current registration data.
@@ -213,10 +232,16 @@ class ServerCapabilitiesComputer {
       ),
       workspaceSymbolProvider: Either2<bool, WorkspaceSymbolOptions>.t1(true),
       workspace: ServerCapabilitiesWorkspace(
-          workspaceFolders: WorkspaceFoldersServerCapabilities(
-        supported: true,
-        changeNotifications: Either2<String, bool>.t2(true),
-      )),
+        workspaceFolders: WorkspaceFoldersServerCapabilities(
+          supported: true,
+          changeNotifications: Either2<String, bool>.t2(true),
+        ),
+        fileOperations: dynamicRegistrations.fileOperations
+            ? null
+            : ServerCapabilitiesFileOperations(
+                willRename: fileOperationRegistrationOptions,
+              ),
+      ),
     );
   }
 
@@ -393,6 +418,11 @@ class ServerCapabilitiesComputer {
       Method.textDocument_foldingRange,
       TextDocumentRegistrationOptions(documentSelector: fullySupportedTypes),
     );
+    register(
+      dynamicRegistrations.fileOperations,
+      Method.workspace_willRenameFiles,
+      fileOperationRegistrationOptions,
+    );
     register(
       dynamicRegistrations.didChangeConfiguration,
       Method.workspace_didChangeConfiguration,

pkg/analysis_server/test/lsp/completion_dart_test.dart

@@ -34,8 +34,9 @@ class CompletionTest extends AbstractLspAnalysisServerTest {
   Future<void> test_commitCharacter_completionItem() async {
     await provideConfig(
       () => initialize(
-        textDocumentCapabilities: withAllSupportedDynamicRegistrations(
-            emptyTextDocumentClientCapabilities),
+        textDocumentCapabilities:
+            withAllSupportedTextDocumentDynamicRegistrations(
+                emptyTextDocumentClientCapabilities),
         workspaceCapabilities:
             withConfigurationSupport(emptyWorkspaceClientCapabilities),
       ),
@@ -63,8 +64,9 @@ main() {
       () => monitorDynamicRegistrations(
         registrations,
         () => initialize(
-            textDocumentCapabilities: withAllSupportedDynamicRegistrations(
-                emptyTextDocumentClientCapabilities),
+            textDocumentCapabilities:
+                withAllSupportedTextDocumentDynamicRegistrations(
+                    emptyTextDocumentClientCapabilities),
             workspaceCapabilities:
                 withDidChangeConfigurationDynamicRegistration(
                     withConfigurationSupport(

pkg/analysis_server/test/lsp/initialization_test.dart

@@ -38,10 +38,13 @@ class InitializationTest extends AbstractLspAnalysisServerTest {
     final initResponse = await monitorDynamicRegistrations(
       registrations,
       () => initialize(
-          // Support dynamic registration for both text sync + hovers.
-          textDocumentCapabilities: withTextSyncDynamicRegistration(
-              withHoverDynamicRegistration(
-                  emptyTextDocumentClientCapabilities))),
+        // Support dynamic registration for both text sync + hovers.
+        textDocumentCapabilities: withTextSyncDynamicRegistration(
+            withHoverDynamicRegistration(emptyTextDocumentClientCapabilities)),
+        // And also file operations.
+        workspaceCapabilities: withFileOperationDynamicRegistration(
+            emptyWorkspaceClientCapabilities),
+      ),
     );
 
     // Because we support dynamic registration for synchronization, we won't send
@@ -53,12 +56,15 @@ class InitializationTest extends AbstractLspAnalysisServerTest {
     expect(initResult.capabilities, isNotNull);
     expect(initResult.capabilities.textDocumentSync, isNull);
 
-    // Should contain Hover, DidOpen, DidClose, DidChange.
-    expect(registrations, hasLength(4));
+    // Should contain Hover, DidOpen, DidClose, DidChange, WillRenameFiles.
+    expect(registrations, hasLength(5));
     final hover =
         registrationOptionsFor(registrations, Method.textDocument_hover);
     final change =
         registrationOptionsFor(registrations, Method.textDocument_didChange);
+    final rename = FileOperationRegistrationOptions.fromJson(
+        registrationFor(registrations, Method.workspace_willRenameFiles)
+            ?.registerOptions);
     expect(registrationOptionsFor(registrations, Method.textDocument_didOpen),
         isNotNull);
     expect(registrationOptionsFor(registrations, Method.textDocument_didClose),
@@ -79,6 +85,9 @@ class InitializationTest extends AbstractLspAnalysisServerTest {
         change.documentSelector
             .any((ds) => ds.pattern == '**/analysis_options.yaml'),
         isTrue);
+
+    expect(rename,
+        equals(ServerCapabilitiesComputer.fileOperationRegistrationOptions));
   }
 
   Future<void> test_dynamicRegistration_notSupportedByClient() async {
@@ -120,6 +129,8 @@ class InitializationTest extends AbstractLspAnalysisServerTest {
     expect(initResult.capabilities.codeActionProvider, isNotNull);
     expect(initResult.capabilities.renameProvider, isNotNull);
     expect(initResult.capabilities.foldingRangeProvider, isNotNull);
+    expect(initResult.capabilities.workspace.fileOperations.willRename,
+        equals(ServerCapabilitiesComputer.fileOperationRegistrationOptions));
 
     expect(didGetRegisterCapabilityRequest, isFalse);
   }
@@ -147,9 +158,13 @@ class InitializationTest extends AbstractLspAnalysisServerTest {
     final initResponse = await monitorDynamicRegistrations(
       registrations,
       () => initialize(
-          // Support dynamic registration for everything we support.
-          textDocumentCapabilities: withAllSupportedDynamicRegistrations(
-              emptyTextDocumentClientCapabilities)),
+        // Support dynamic registration for everything we support.
+        textDocumentCapabilities:
+            withAllSupportedTextDocumentDynamicRegistrations(
+                emptyTextDocumentClientCapabilities),
+        workspaceCapabilities: withAllSupportedWorkspaceDynamicRegistrations(
+            emptyWorkspaceClientCapabilities),
+      ),
     );
 
     final initResult = InitializeResult.fromJson(initResponse.result);
@@ -170,6 +185,7 @@ class InitializationTest extends AbstractLspAnalysisServerTest {
     expect(initResult.capabilities.codeActionProvider, isNull);
     expect(initResult.capabilities.renameProvider, isNull);
     expect(initResult.capabilities.foldingRangeProvider, isNull);
+    expect(initResult.capabilities.workspace.fileOperations, isNull);
 
     // Ensure all expected dynamic registrations.
     for (final expectedRegistration in ClientDynamicRegistrations.supported) {
@@ -186,8 +202,9 @@ class InitializationTest extends AbstractLspAnalysisServerTest {
     await monitorDynamicRegistrations(
       registrations,
       () => initialize(
-          textDocumentCapabilities: withAllSupportedDynamicRegistrations(
-              emptyTextDocumentClientCapabilities)),
+          textDocumentCapabilities:
+              withAllSupportedTextDocumentDynamicRegistrations(
+                  emptyTextDocumentClientCapabilities)),
     );
 
     final unregisterRequest =

pkg/analysis_server/test/lsp/server_abstract.dart

@@ -199,11 +199,12 @@ mixin ClientCapabilitiesHelperMixin {
     return ClientCapabilitiesWorkspace.fromJson(json);
   }
 
-  TextDocumentClientCapabilities withAllSupportedDynamicRegistrations(
+  TextDocumentClientCapabilities
+      withAllSupportedTextDocumentDynamicRegistrations(
     TextDocumentClientCapabilities source,
   ) {
-    // This list should match all of the fields listed in
-    // `ClientDynamicRegistrations.supported`.
+    // This list (when combined with the workspace list) should match all of
+    // the fields listed in `ClientDynamicRegistrations.supported`.
     return extendTextDocumentCapabilities(source, {
       'synchronization': {'dynamicRegistration': true},
       'completion': {'dynamicRegistration': true},
@@ -224,6 +225,16 @@ mixin ClientCapabilitiesHelperMixin {
     });
   }
 
+  ClientCapabilitiesWorkspace withAllSupportedWorkspaceDynamicRegistrations(
+    ClientCapabilitiesWorkspace source,
+  ) {
+    // This list (when combined with the textDocument list) should match all of
+    // the fields listed in `ClientDynamicRegistrations.supported`.
+    return extendWorkspaceCapabilities(source, {
+      'fileOperations': {'dynamicRegistration': true},
+    });
+  }
+
   ClientCapabilitiesWorkspace withApplyEditSupport(
     ClientCapabilitiesWorkspace source,
   ) {
@@ -343,6 +354,14 @@ mixin ClientCapabilitiesHelperMixin {
     });
   }
 
+  ClientCapabilitiesWorkspace withFileOperationDynamicRegistration(
+    ClientCapabilitiesWorkspace source,
+  ) {
+    return extendWorkspaceCapabilities(source, {
+      'fileOperations': {'dynamicRegistration': true}
+    });
+  }
+
   TextDocumentClientCapabilities withHierarchicalDocumentSymbolSupport(
     TextDocumentClientCapabilities source,
   ) {
@@ -1219,6 +1238,14 @@ mixin LspAnalysisServerTestMixin implements ClientCapabilitiesHelperMixin {
     );
   }
 
+  Future<WorkspaceEdit> onWillRename(List<FileRename> renames) {
+    final request = makeRequest(
+      Method.workspace_willRenameFiles,
+      RenameFilesParams(files: renames),
+    );
+    return expectSuccessfulResponseTo(request, WorkspaceEdit.fromJson);
+  }
+
   Future openFile(Uri uri, String content, {num version = 1}) async {
     var notification = makeNotification(
       Method.textDocument_didOpen,

pkg/analysis_server/test/lsp/test_all.dart

@@ -37,6 +37,7 @@ import 'rename_test.dart' as rename;
 import 'server_test.dart' as server;
 import 'signature_help_test.dart' as signature_help;
 import 'super_test.dart' as get_super;
+import 'will_rename_files_test.dart' as will_rename_files;
 import 'workspace_symbols_test.dart' as workspace_symbols;
 
 void main() {
@@ -74,6 +75,7 @@ void main() {
     rename.main();
     server.main();
     signature_help.main();
+    will_rename_files.main();
     workspace_symbols.main();
   }, name: 'lsp');
 }