Make workspace/willRenameFiles working

lib/Extension/LanguageServerRename/Handler/FileRenameHandler.php

@@ -4,13 +4,14 @@
 
 use Amp\Promise;
 use Phpactor\LanguageServerProtocol\FileOperationOptions;
+use Phpactor\LanguageServer\Core\Server\ClientApi;
+use Phpactor\Rename\Model\Exception\CouldNotRename;
 use Phpactor\Rename\Model\FileRenamer;
 use Phpactor\Rename\Model\LocatedTextEditsMap;
-use Phpactor\Extension\LanguageServerRename\Util\LocatedTextEditConverter;
+use Phpactor\Extension\LanguageServerRename\Util\WorkspaceRenameEditsConverter;
 use Phpactor\LanguageServerProtocol\FileOperationFilter;
 use Phpactor\LanguageServerProtocol\FileOperationPattern;
 use Phpactor\LanguageServerProtocol\FileOperationRegistrationOptions;
-use Phpactor\LanguageServerProtocol\FileRename;
 use Phpactor\LanguageServerProtocol\RenameFilesParams;
 use Phpactor\LanguageServerProtocol\ServerCapabilities;
 use Phpactor\LanguageServerProtocol\WorkspaceEdit;
@@ -21,8 +22,11 @@
 
 class FileRenameHandler implements Handler, CanRegisterCapabilities
 {
-    public function __construct(private FileRenamer $renamer, private LocatedTextEditConverter $converter)
-    {
+    public function __construct(
+        private FileRenamer $renamer,
+        private WorkspaceRenameEditsConverter $converter,
+        private ClientApi $clientApi,
+    ) {
     }
 
 
@@ -39,14 +43,34 @@ public function methods(): array
     public function willRenameFiles(RenameFilesParams $params): Promise
     {
         return call(function () use ($params) {
-            $workspaceEdits = LocatedTextEditsMap::create();
-            foreach ($params->files as $rename) {
-                assert($rename instanceof FileRename);
+            $count = 0;
+            $documentChanges = [];
+            try {
+                foreach ($params->files as $rename) {
+                    $locatedEditMap = LocatedTextEditsMap::create();
 
-                $workspaceEdits = $workspaceEdits->merge(yield $this->renamer->renameFile(TextDocumentUri::fromString($rename->oldUri), TextDocumentUri::fromString($rename->newUri)));
-            }
+                    $renameEdit = yield $this->renamer->renameFile(
+                        TextDocumentUri::fromString($rename->oldUri),
+                        TextDocumentUri::fromString($rename->newUri)
+                    );
+
+                    $workspaceEdit = $this->converter->toWorkspaceEdit($renameEdit);
+
+                    foreach ($workspaceEdit->documentChanges ?? [] as $change) {
+                        $documentChanges[] = $change;
+                    }
+                }
 
-            return $this->converter->toWorkspaceEdit($workspaceEdits);
+                return new WorkspaceEdit(documentChanges: $documentChanges);
+            } catch (CouldNotRename $error) {
+                $previous = $error->getPrevious();
+
+                $this->clientApi->window()->showMessage()->error(sprintf(
+                    $error->getMessage() . ($previous?->getTraceAsString() ?? '')
+                ));
+
+                return new WorkspaceEdit(null, []);
+            }
         });
     }
 

lib/Extension/LanguageServerRename/Handler/RenameHandler.php

@@ -8,9 +8,10 @@
 use Phpactor\Rename\Model\Exception\CouldNotRename;
 use Phpactor\Rename\Model\LocatedTextEdit;
 use Phpactor\Rename\Model\LocatedTextEditsMap;
+use Phpactor\Rename\Model\WorkspaceRenameEdits;
 use Phpactor\Rename\Model\RenameResult;
 use Phpactor\Rename\Model\Renamer;
-use Phpactor\Extension\LanguageServerRename\Util\LocatedTextEditConverter;
+use Phpactor\Extension\LanguageServerRename\Util\WorkspaceRenameEditsConverter;
 use Phpactor\LanguageServerProtocol\PrepareRenameParams;
 use Phpactor\LanguageServerProtocol\PrepareRenameRequest;
 use Phpactor\LanguageServerProtocol\Range;
@@ -30,7 +31,7 @@
 class RenameHandler implements Handler, CanRegisterCapabilities
 {
     public function __construct(
-        private LocatedTextEditConverter $converter,
+        private WorkspaceRenameEditsConverter $converter,
         private TextDocumentLocator $documentLocator,
         private Renamer $renamer,
         private ClientApi $clientApi
@@ -119,9 +120,9 @@ public function registerCapabiltiies(ServerCapabilities $capabilities): void
      */
     private function resultToWorkspaceEdit(array $locatedEdits, ?RenameResult $renameResult): WorkspaceEdit
     {
-        return $this->converter->toWorkspaceEdit(
+        return $this->converter->toWorkspaceEdit(new WorkspaceRenameEdits(array_filter([
             LocatedTextEditsMap::fromLocatedEdits($locatedEdits),
-            $renameResult
-        );
+            $renameResult,
+        ])));
     }
 }

lib/Extension/LanguageServerRename/LanguageServerRenameExtension.php

@@ -10,7 +10,7 @@
 use Phpactor\Rename\Model\Renamer\ChainRenamer;
 use Phpactor\Extension\LanguageServerRename\Handler\RenameHandler;
 use Phpactor\Rename\Model\Renamer;
-use Phpactor\Extension\LanguageServerRename\Util\LocatedTextEditConverter;
+use Phpactor\Extension\LanguageServerRename\Util\WorkspaceRenameEditsConverter;
 use Phpactor\Extension\LanguageServer\LanguageServerExtension;
 use Phpactor\LanguageServer\Core\Server\ClientApi;
 use Phpactor\MapResolver\Resolver;
@@ -31,7 +31,7 @@ public function load(ContainerBuilder $container): void
 
         $container->register(RenameHandler::class, function (Container $container) {
             return new RenameHandler(
-                $container->get(LocatedTextEditConverter::class),
+                $container->get(WorkspaceRenameEditsConverter::class),
                 $container->get(TextDocumentLocator::class),
                 $container->get(Renamer::class),
                 $container->get(ClientApi::class)
@@ -43,14 +43,15 @@ public function load(ContainerBuilder $container): void
         $container->register(FileRenameHandler::class, function (Container $container) {
             return new FileRenameHandler(
                 $container->get(FileRenamer::class),
-                $container->get(LocatedTextEditConverter::class),
+                $container->get(WorkspaceRenameEditsConverter::class),
+                $container->get(ClientApi::class)
             );
         }, [
             LanguageServerExtension::TAG_METHOD_HANDLER => []
         ]);
 
-        $container->register(LocatedTextEditConverter::class, function (Container $container) {
-            return new LocatedTextEditConverter(
+        $container->register(WorkspaceRenameEditsConverter::class, function (Container $container) {
+            return new WorkspaceRenameEditsConverter(
                 $container->get(LanguageServerExtension::SERVICE_SESSION_WORKSPACE),
                 $container->get(TextDocumentLocator::class),
             );

lib/Extension/LanguageServerRename/LanguageServerRenameWorseExtension.php

@@ -75,7 +75,7 @@ public function load(ContainerBuilder $container): void
         ]);
 
         $container->register(DefinitionAndReferenceFinder::class, function (Container $container) {
-            // wrap the definiton and reference finder to update the index with the current workspace
+            // wrap the definition and reference finder to update the index with the current workspace
             return new WorkspaceUpdateReferenceFinder(
                 $container->get(LanguageServerExtension::SERVICE_SESSION_WORKSPACE),
                 $container->get(Indexer::class),
@@ -91,7 +91,7 @@ public function load(ContainerBuilder $container): void
                 new ClassToFileUriToNameConverter($container->get(ClassToFileExtension::SERVICE_CONVERTER)),
                 $container->get(TextDocumentLocator::class),
                 $container->get(QueryClient::class),
-                $container->get(ClassMover::class)
+                $container->get(ClassMover::class),
             );
             return new LoggingFileRenamer(
                 $renamer,

lib/Extension/LanguageServerRename/Tests/Unit/Handler/FileRenameHandlerTest.php

@@ -4,17 +4,22 @@
 
 use Phpactor\Extension\LanguageServerBridge\TextDocument\WorkspaceTextDocumentLocator;
 use Phpactor\Extension\LanguageServerRename\Handler\FileRenameHandler;
+use Phpactor\Extension\LanguageServerRename\Util\WorkspaceRenameEditsConverter;
+use Phpactor\LanguageServer\Core\Server\ClientApi;
+use Phpactor\LanguageServer\Core\Server\RpcClient;
 use Phpactor\Rename\Model\FileRenamer\TestFileRenamer;
 use Phpactor\Rename\Model\LocatedTextEditsMap;
 use Phpactor\Extension\LanguageServerRename\Tests\IntegrationTestCase;
-use Phpactor\Extension\LanguageServerRename\Util\LocatedTextEditConverter;
 use Phpactor\LanguageServerProtocol\FileOperationRegistrationOptions;
 use Phpactor\LanguageServerProtocol\FileRename;
 use Phpactor\LanguageServerProtocol\RenameFilesParams;
 use Phpactor\LanguageServerProtocol\WorkspaceEdit;
 use Phpactor\LanguageServer\Core\Rpc\ResponseMessage;
 use Phpactor\LanguageServer\LanguageServerTesterBuilder;
 use Phpactor\LanguageServer\Test\LanguageServerTester;
+use Phpactor\Rename\Model\WorkspaceRenameEdits;
+use Phpactor\Rename\Model\RenameResult;
+use Phpactor\TextDocument\TextDocumentUri;
 use Phpactor\TextDocument\TextEdit;
 use Phpactor\TextDocument\TextEdits;
 use function Amp\Promise\wait;
@@ -43,10 +48,18 @@ public function testMoveFileNoEdits(): void
 
     public function testMoveFileEdits(): void
     {
-        $server = $this->createServer(false, [
-            'file:///file1' => TextEdits::one(TextEdit::create(0, 0, 'Hello')),
-            'file:///file2' => TextEdits::one(TextEdit::create(0, 0, 'Hello')),
-        ]);
+        $server = $this->createServer(
+            false,
+            [
+                'file:///file1' => TextEdits::one(TextEdit::create(0, 0, 'Hello')),
+                'file:///file2' => TextEdits::one(TextEdit::create(0, 0, 'Hello')),
+            ],
+            new RenameResult(
+                TextDocumentUri::fromString('file:///file1'),
+                TextDocumentUri::fromString('file:///file2'),
+            ),
+        );
+
         $server->initialize();
 
         $response = wait($server->request('workspace/willRenameFiles', new RenameFilesParams([
@@ -58,28 +71,44 @@ public function testMoveFileEdits(): void
         $edits = $response->result;
         self::assertInstanceOf(WorkspaceEdit::class, $edits);
         assert($edits instanceof WorkspaceEdit);
-        self::assertCount(2, $edits->documentChanges);
+        self::assertIsArray($edits->documentChanges);
+        self::assertCount(3, $edits->documentChanges);
     }
 
-    private function createServer(bool $willFail = false, array $workspaceEdits = []): LanguageServerTester
-    {
+    private function createServer(
+        bool $willFail = false,
+        array $workspaceEdits = [],
+        ?RenameResult $renameResult = null,
+    ): LanguageServerTester {
         $builder = LanguageServerTesterBuilder::createBare()
             ->enableTextDocuments()
             ->enableFileEvents();
-        $builder->addHandler($this->createHandler($builder, $willFail, $workspaceEdits));
+        $builder->addHandler($this->createHandler($builder, $willFail, $renameResult, $workspaceEdits));
         $server = $builder->build();
 
         foreach ($workspaceEdits as $path => $_) {
             $server->textDocument()->open($path, '');
         }
+
         return $server;
     }
 
-    private function createHandler(LanguageServerTesterBuilder $builder, bool $willError = false, array $workspaceEdits = []): FileRenameHandler
-    {
+    private function createHandler(
+        LanguageServerTesterBuilder $builder,
+        bool $willError = false,
+        ?RenameResult $renameResult = null,
+        array $workspaceEdits = [],
+    ): FileRenameHandler {
         return new FileRenameHandler(
-            new TestFileRenamer($willError, new LocatedTextEditsMap($workspaceEdits)),
-            new LocatedTextEditConverter($builder->workspace(), new WorkspaceTextDocumentLocator($builder->workspace()))
+            new TestFileRenamer(
+                $willError,
+                new WorkspaceRenameEdits(array_filter([
+                    new LocatedTextEditsMap($workspaceEdits),
+                    $renameResult,
+                ])),
+            ),
+            new WorkspaceRenameEditsConverter($builder->workspace(), new WorkspaceTextDocumentLocator($builder->workspace())),
+            new ClientApi($this->createMock(RpcClient::class)),
         );
     }
 }

lib/Extension/LanguageServerRename/Util/LocatedTextEditConverter.php → lib/Extension/LanguageServerRename/Util/WorkspaceRenameEditsConverter.php

@@ -5,20 +5,46 @@
 use Phpactor\Extension\LanguageServerBridge\Converter\TextEditConverter;
 use Phpactor\LanguageServerProtocol\OptionalVersionedTextDocumentIdentifier;
 use Phpactor\Rename\Model\LocatedTextEditsMap;
+use Phpactor\Rename\Model\WorkspaceRenameEdits;
 use Phpactor\Rename\Model\RenameResult;
 use Phpactor\LanguageServerProtocol\RenameFile;
 use Phpactor\LanguageServerProtocol\TextDocumentEdit;
 use Phpactor\LanguageServerProtocol\WorkspaceEdit;
 use Phpactor\LanguageServer\Core\Workspace\Workspace;
 use Phpactor\TextDocument\TextDocumentLocator;
 
-final class LocatedTextEditConverter
+final class WorkspaceRenameEditsConverter
 {
     public function __construct(private Workspace $workspace, private TextDocumentLocator $locator)
     {
     }
 
-    public function toWorkspaceEdit(LocatedTextEditsMap $map, ?RenameResult $renameResult = null): WorkspaceEdit
+    public function toWorkspaceEdit(WorkspaceRenameEdits $edits): WorkspaceEdit
+    {
+        $documentEdits = [];
+
+        foreach ($edits as $edit) {
+            if ($edit instanceof RenameResult) {
+                $documentEdits[] = new RenameFile(
+                    'rename',
+                    $edit->oldUri(),
+                    $edit->newUri(),
+                );
+            }
+            if ($edit instanceof LocatedTextEditsMap) {
+                foreach ($this->prepareDocumentEdits($edit) as $textEdit) {
+                    $documentEdits[] = $textEdit;
+                }
+            }
+        }
+
+        return new WorkspaceEdit(null, $documentEdits);
+    }
+
+    /**
+     * @return TextDocumentEdit[]
+     */
+    private function prepareDocumentEdits(LocatedTextEditsMap $map): array
     {
         $documentEdits = [];
         foreach ($map->toLocatedTextEdits() as $result) {
@@ -37,29 +63,22 @@ public function toWorkspaceEdit(LocatedTextEditsMap $map, ?RenameResult $renameR
 
         // deduplicate the edits: with renaming we currently have multiple
         // references to the declaration.
-        $documentEdits = array_map(function (TextDocumentEdit $documentEdit) {
-            $new = [];
-            foreach ($documentEdit->edits as $edit) {
-                $new[sprintf(
-                    '%s-%s-%s',
-                    $edit->range->start->line,
-                    $edit->range->start->character,
-                    $edit->newText
-                )] = $edit;
-            }
-            $documentEdit->edits = array_values($new);
-            return $documentEdit;
-        }, $documentEdits);
-
-        if (null !== $renameResult) {
-            $documentEdits[] = new RenameFile(
-                'rename',
-                $renameResult->oldUri(),
-                $renameResult->newUri(),
-            );
-        }
-
-        return new WorkspaceEdit(null, $documentEdits);
+        return array_map(
+            function (TextDocumentEdit $documentEdit) {
+                $new = [];
+                foreach ($documentEdit->edits as $edit) {
+                    $new[sprintf(
+                        '%s-%s-%s',
+                        $edit->range->start->line,
+                        $edit->range->start->character,
+                        $edit->newText
+                    )] = $edit;
+                }
+                $documentEdit->edits = array_values($new);
+                return $documentEdit;
+            },
+            $documentEdits
+        );
     }
 
     private function getDocumentVersion(string $uri): int