Allow to disable selected capabilities by the client

.php_cs.dist → .php-cs-fixer.dist.php

@@ -8,7 +8,7 @@
     ])
 ;
 
-return PhpCsFixer\Config::create()
+return (new PhpCsFixer\Config())
     ->setRiskyAllowed(true)
     ->setRules([
         '@PSR2' => true,
@@ -22,4 +22,3 @@
     ])
     ->setFinder($finder)
 ;
-

lib/LanguageServerCompletion/Handler/CompletionHandler.php

@@ -9,6 +9,7 @@
 use Phpactor\Extension\LanguageServerBridge\Converter\PositionConverter;
 use Phpactor\Extension\LanguageServerCodeTransform\Model\NameImport\NameImporter;
 use Phpactor\Extension\LanguageServerCodeTransform\Model\NameImport\NameImporterResult;
+use Phpactor\LanguageServerProtocol\ClientCapabilities;
 use Phpactor\LanguageServerProtocol\CompletionItem;
 use Phpactor\LanguageServerProtocol\CompletionList;
 use Phpactor\LanguageServerProtocol\CompletionOptions;
@@ -51,29 +52,29 @@ class CompletionHandler implements Handler, CanRegisterCapabilities
     private $workspace;
 
     /**
-     * @var bool
+     * @var NameImporter
      */
-    private $supportSnippets;
+    private $nameImporter;
 
     /**
-     * @var NameImporter
+     * @var ClientCapabilities
      */
-    private $nameImporter;
+    private ClientCapabilities $clientCapabilities;
 
     public function __construct(
         Workspace $workspace,
         TypedCompletorRegistry $registry,
         SuggestionNameFormatter $suggestionNameFormatter,
         NameImporter $nameImporter,
-        bool $supportSnippets,
+        ClientCapabilities $clientCapabilities,
         bool $provideTextEdit = false
     ) {
         $this->registry = $registry;
         $this->provideTextEdit = $provideTextEdit;
         $this->workspace = $workspace;
         $this->suggestionNameFormatter = $suggestionNameFormatter;
         $this->nameImporter = $nameImporter;
-        $this->supportSnippets = $supportSnippets;
+        $this->clientCapabilities = $clientCapabilities;
     }
 
     public function methods(): array
@@ -142,8 +143,12 @@ public function completion(CompletionParams $params, CancellationToken $token):
 
     public function registerCapabiltiies(ServerCapabilities $capabilities): void
     {
-        $capabilities->completionProvider = new CompletionOptions([':', '>', '$']);
-        $capabilities->signatureHelpProvider = new SignatureHelpOptions(['(', ',']);
+        $capabilities->completionProvider = (null !== $this->clientCapabilities->textDocument->completion)
+            ? new CompletionOptions([':', '>', '$'])
+            : null;
+        $capabilities->signatureHelpProvider = (null !== $this->clientCapabilities->textDocument->signatureHelp)
+            ? new SignatureHelpOptions(['(', ','])
+            : null;
     }
 
     private function determineInsertTextAndFormat(
@@ -154,7 +159,7 @@ private function determineInsertTextAndFormat(
         $insertText = $name;
         $insertTextFormat = InsertTextFormat::PLAIN_TEXT;
 
-        if ($this->supportSnippets) {
+        if ($this->supportSnippets()) {
             $insertText = $suggestion->snippet() ?: $name;
             $insertTextFormat = $suggestion->snippet()
                 ? InsertTextFormat::SNIPPET
@@ -170,6 +175,11 @@ private function determineInsertTextAndFormat(
         return [$insertText, $insertTextFormat];
     }
 
+    private function supportSnippets(): bool
+    {
+        return $this->clientCapabilities->textDocument->completion->completionItem['snippetSupport'] ?? false;
+    }
+
     private function importClassOrFunctionName(
         Suggestion $suggestion,
         CompletionParams $params

lib/LanguageServerCompletion/Handler/SignatureHelpHandler.php

@@ -4,6 +4,7 @@
 
 use Amp\Promise;
 use Phpactor\Extension\LanguageServerBridge\Converter\PositionConverter;
+use Phpactor\LanguageServerProtocol\ClientCapabilities;
 use Phpactor\LanguageServerProtocol\Position;
 use Phpactor\LanguageServerProtocol\ServerCapabilities;
 use Phpactor\LanguageServerProtocol\SignatureHelp;
@@ -29,10 +30,16 @@ class SignatureHelpHandler implements Handler, CanRegisterCapabilities
      */
     private $helper;
 
-    public function __construct(Workspace $workspace, SignatureHelper $helper)
+    /**
+     * @var ClientCapabilities
+     */
+    private ClientCapabilities $clientCapabilities;
+
+    public function __construct(Workspace $workspace, SignatureHelper $helper, ClientCapabilities $clientCapabilities)
     {
         $this->workspace = $workspace;
         $this->helper = $helper;
+        $this->clientCapabilities = $clientCapabilities;
     }
 
     /**
@@ -67,8 +74,8 @@ public function signatureHelp(
 
     public function registerCapabiltiies(ServerCapabilities $capabilities): void
     {
-        $options = new SignatureHelpOptions();
-        $options->triggerCharacters = [ '(', ',' ];
-        $capabilities->signatureHelpProvider = $options;
+        $capabilities->signatureHelpProvider = (null !== $this->clientCapabilities->textDocument->signatureHelp)
+            ? new SignatureHelpOptions(['(', ','])
+            : null;
     }
 }

lib/LanguageServerCompletion/LanguageServerCompletionExtension.php

@@ -47,7 +47,7 @@ private function registerHandlers(ContainerBuilder $container): void
                 $container->get(CompletionExtension::SERVICE_REGISTRY),
                 $container->get(SuggestionNameFormatter::class),
                 $container->get(NameImporter::class),
-                $this->clientCapabilities($container)->textDocument->completion->completionItem['snippetSupport'] ?? false
+                $this->clientCapabilities($container)
             );
         }, [ LanguageServerExtension::TAG_METHOD_HANDLER => [
             'methods' => [
@@ -62,7 +62,8 @@ private function registerHandlers(ContainerBuilder $container): void
         $container->register('language_server_completion.handler.signature_help', function (Container $container) {
             return new SignatureHelpHandler(
                 $container->get(LanguageServerExtension::SERVICE_SESSION_WORKSPACE),
-                $container->get(CompletionExtension::SERVICE_SIGNATURE_HELPER)
+                $container->get(CompletionExtension::SERVICE_SIGNATURE_HELPER),
+                $this->clientCapabilities($container)
             );
         }, [ LanguageServerExtension::TAG_METHOD_HANDLER => [] ]);
     }

tests/LanguageServerCompletion/Unit/Handler/CompletionHandlerTest.php

@@ -8,10 +8,13 @@
 use Phpactor\CodeTransform\Domain\Refactor\ImportClass\NameImport;
 use Phpactor\Extension\LanguageServerCodeTransform\Model\NameImport\NameImporter;
 use Phpactor\Extension\LanguageServerCodeTransform\Model\NameImport\NameImporterResult;
+use Phpactor\LanguageServerProtocol\ClientCapabilities;
+use Phpactor\LanguageServerProtocol\CompletionClientCapabilities;
 use Phpactor\LanguageServerProtocol\CompletionItem;
 use Phpactor\LanguageServerProtocol\CompletionList;
 use Phpactor\LanguageServerProtocol\Position;
 use Phpactor\LanguageServerProtocol\Range;
+use Phpactor\LanguageServerProtocol\TextDocumentClientCapabilities;
 use Phpactor\LanguageServerProtocol\TextEdit;
 use PHPUnit\Framework\TestCase;
 use Phpactor\Completion\Core\Completor;
@@ -46,6 +49,34 @@ public function testHandleNoSuggestions(): void
         $this->assertFalse($response->result->isIncomplete);
     }
 
+    public function testHandleWithDisabledCapability(): void
+    {
+        $tester = $this->create(
+            [
+                Suggestion::create('hello'),
+                Suggestion::create('goodbye'),
+            ],
+            true,
+            false,
+            [],
+            [],
+            false
+        );
+        $response = $tester->requestAndWait(
+            'textDocument/completion',
+            [
+                'textDocument' => ProtocolFactory::textDocumentIdentifier(self::EXAMPLE_URI),
+                'position' => ProtocolFactory::position(0, 0)
+            ]
+        );
+        $this->assertInstanceOf(CompletionList::class, $response->result);
+        $this->assertEquals([
+            self::completionItem('hello', null),
+            self::completionItem('goodbye', null),
+        ], $response->result->items);
+        $this->assertFalse($response->result->isIncomplete);
+    }
+
     public function testHandleACompleteListOfSuggestions(): void
     {
         $tester = $this->create([
@@ -377,7 +408,8 @@ private function create(
         bool $supportSnippets = true,
         bool $isIncomplete = false,
         array $importNameTextEdits = [],
-        array $aliases = []
+        array $aliases = [],
+        bool $supportCompletion = true
     ): LanguageServerTester {
         $completor = $this->createCompletor($suggestions, $isIncomplete);
         $registry = new TypedCompletorRegistry([
@@ -389,14 +421,36 @@ private function create(
             $registry,
             new SuggestionNameFormatter(true),
             $this->createNameImporter($suggestions, $aliases, $importNameTextEdits),
-            $supportSnippets,
+            $this->createClientCapabilities($supportCompletion, $supportSnippets),
             true
         ))->build();
         $tester->textDocument()->open(self::EXAMPLE_URI, self::EXAMPLE_TEXT);
 
         return $tester;
     }
 
+    private function createClientCapabilities(
+        bool $completion = true,
+        bool $supportSnippets = true,
+    ): ClientCapabilities {
+        $capabilities = new ClientCapabilities();
+        $capabilities->textDocument = new TextDocumentClientCapabilities();
+
+        if (false === $completion) {
+            return $capabilities;
+        }
+
+        $completionCapabilities = new CompletionClientCapabilities();
+
+        if ($supportSnippets) {
+            $completionCapabilities->completionItem['snippetSupport'] = true;
+        }
+
+        $capabilities->textDocument->completion = $completionCapabilities;
+
+        return $capabilities;
+    }
+
     /**
      * @param array<Suggestion> $suggestions
      * @param array<string|null> $aliases

tests/LanguageServerCompletion/Unit/Handler/SignatureHelpHandlerTest.php

@@ -2,7 +2,10 @@
 
 namespace Phpactor\Extension\LanguageServerCompletion\Tests\Unit\Handler;
 
+use Phpactor\LanguageServerProtocol\ClientCapabilities;
 use Phpactor\LanguageServerProtocol\SignatureHelp as LspSignatureHelp;
+use Phpactor\LanguageServerProtocol\SignatureHelpClientCapabilities;
+use Phpactor\LanguageServerProtocol\TextDocumentClientCapabilities;
 use Phpactor\LanguageServerProtocol\TextDocumentIdentifier;
 use PHPUnit\Framework\TestCase;
 use Phpactor\Completion\Core\SignatureHelp;
@@ -38,10 +41,27 @@ private function create(array $suggestions): LanguageServerTester
         $builder = LanguageServerTesterBuilder::create();
         return $builder->addHandler(new SignatureHelpHandler(
             $builder->workspace(),
-            $this->createHelper()
+            $this->createHelper(),
+            $this->createClientCapabilities(true)
         ))->build();
     }
 
+    private function createClientCapabilities(
+        bool $supportSignatureHelp = true
+    ): ClientCapabilities {
+        $capabilities = new ClientCapabilities();
+        $capabilities->textDocument = new TextDocumentClientCapabilities();
+
+        if (false === $supportSignatureHelp) {
+            return $capabilities;
+        }
+
+        $signatureHelpCapabilities = new SignatureHelpClientCapabilities();
+        $capabilities->textDocument->signatureHelp = $signatureHelpCapabilities;
+
+        return $capabilities;
+    }
+
     private function createHelper(): SignatureHelper
     {
         return new class() implements SignatureHelper {