phpactorgh-2761: introduce tolerant code action provider (phpactor#2767)

if a single code action provider fails then show an error message to the
user and continue to process other code actions.

Author: dantleech

CHANGELOG.md

@@ -1,6 +1,12 @@
 Changelog
 =========
 
+## master
+
+Improvements:
+
+  - Tolerate code action provider failures #2761 @dantleech
+
 ## 2024-11-05
 
 Bug fixes:

lib/Extension/LanguageServer/CodeAction/TolerantCodeActionProvider.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace Phpactor\Extension\LanguageServer\CodeAction;
+
+use Amp\CancellationToken;
+use Amp\Promise;
+use Phpactor\LanguageServerProtocol\Range;
+use Phpactor\LanguageServerProtocol\TextDocumentItem;
+use Phpactor\LanguageServer\Core\CodeAction\CodeActionProvider;
+use Phpactor\LanguageServer\Core\Server\ClientApi;
+use function Amp\call;
+use Throwable;
+
+final class TolerantCodeActionProvider implements CodeActionProvider
+{
+    public function __construct(private CodeActionProvider $provider, private ClientApi $client)
+    {
+    }
+
+    public function provideActionsFor(TextDocumentItem $textDocument, Range $range, CancellationToken $cancel): Promise
+    {
+        return call(function () use ($textDocument, $range, $cancel) {
+            try {
+                return yield $this->provider->provideActionsFor($textDocument, $range, $cancel);
+            } catch (Throwable $error) {
+                $this->client->window()->showMessage()->error(sprintf(
+                    'Provider %s (%s) failed: %s',
+                    $this->provider::class,
+                    $this->provider->describe(),
+                    $error->getMessage(),
+                ));
+                return [];
+            }
+        });
+    }
+
+    public function kinds(): array
+    {
+        return $this->provider->kinds();
+    }
+
+    public function describe(): string
+    {
+        return $this->provider->describe();
+    }
+}

lib/Extension/LanguageServer/LanguageServerExtension.php

@@ -10,6 +10,7 @@
 use Phpactor\Extension\FilePathResolver\FilePathResolverExtension;
 use Phpactor\Extension\LanguageServerWorseReflection\Workspace\WorkspaceIndex;
 use Phpactor\Extension\LanguageServer\CodeAction\ProfilingCodeActionProvider;
+use Phpactor\Extension\LanguageServer\CodeAction\TolerantCodeActionProvider;
 use Phpactor\Extension\LanguageServer\Command\DiagnosticsCommand;
 use Phpactor\Extension\LanguageServer\DiagnosticProvider\OutsourcedDiagnosticsProvider;
 use Phpactor\Extension\LanguageServer\DiagnosticProvider\PathExcludingDiagnosticsProvider;
@@ -454,6 +455,9 @@ private function registerHandlers(ContainerBuilder $container): void
 
         $container->register(CodeActionHandler::class, function (Container $container) {
             $services = $this->taggedServices($container, self::TAG_CODE_ACTION_PROVIDER, CodeActionProvider::class);
+            $services = array_map(function (CodeActionProvider $provider) use ($container) {
+                return new TolerantCodeActionProvider($provider, $container->get(ClientApi::class));
+            }, $services);
             if ($container->parameter(self::PARAM_PROFILE)->bool()) {
                 $services = array_map(
                     fn (CodeActionProvider $provider) => new ProfilingCodeActionProvider(

lib/Extension/LanguageServer/Tests/Unit/DiagnosticsProvider/TolerantCodeActionProviderTest.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace Phpactor\Extension\LanguageServer\Tests\Unit\DiagnosticsProvider;
+
+use Amp\CancellationTokenSource;
+use PHPUnit\Framework\TestCase;
+use Phpactor\Extension\LanguageServer\CodeAction\TolerantCodeActionProvider;
+use Phpactor\LanguageServer\Core\CodeAction\CodeActionProvider;
+use Phpactor\LanguageServer\Core\Rpc\NotificationMessage;
+use Phpactor\LanguageServer\LanguageServerTesterBuilder;
+use Phpactor\LanguageServer\Test\ProtocolFactory;
+use Exception;
+
+class TolerantCodeActionProviderTest extends TestCase
+{
+    public function testShowErrorWhenProviderFails(): void
+    {
+        $provider = $this->createMock(CodeActionProvider::class);
+        $provider->method('provideActionsFor')->willThrowException(new Exception('Oh no!'));
+        $tester = LanguageServerTesterBuilder::create();
+        (new TolerantCodeActionProvider($provider, $tester->clientApi()))->provideActionsFor(
+            ProtocolFactory::textDocumentItem('', ''),
+            ProtocolFactory::range(1, 1, 1, 1),
+            (new CancellationTokenSource())->getToken(),
+        );
+        $message = $tester->transmitter()->shift();
+        self::assertInstanceOf(NotificationMessage::class, $message);
+        $message = $message->params['message'] ?? null;
+        self::assertIsString($message);
+        self::assertStringContainsString('failed: Oh no!', $message);
+    }
+}

lib/WorseReflection/Tests/Benchmarks/CarbonReflectBench.php

@@ -2,18 +2,14 @@
 
 namespace Phpactor\WorseReflection\Tests\Benchmarks;
 
-use PHPUnit\Framework\TestCase;
 use Phpactor\TextDocument\TextDocumentBuilder;
-use Phpactor\WorseReflection\Core\ClassName;
 
 /**
  * @Iterations(5)
  * @Revs(1)
  */
 class CarbonReflectBench extends BaseBenchCase
 {
-    /**
-     */
     public function benchCarbonReflection(): void
     {
         $classes = $this->getReflector()->reflectClassesIn(TextDocumentBuilder::fromUri(__DIR__ . '/fixtures/reflection/carbon.test')->build());