fix completion result isComplete

Author: camilledejoye

lib/LanguageServerCompletion/Handler/CompletionHandler.php

@@ -98,6 +98,7 @@ public function completion(CompletionParams $params, CancellationToken $token):
             );
 
             $items = [];
+            $isIncomplete = false;
             foreach ($suggestions as $suggestion) {
                 $name = $this->suggestionNameFormatter->format($suggestion);
                 $insertText = $name;
@@ -125,12 +126,15 @@ public function completion(CompletionParams $params, CancellationToken $token):
                 try {
                     $token->throwIfRequested();
                 } catch (CancelledException $cancellation) {
+                    $isIncomplete = true;
                     break;
                 }
                 yield new Delayed(0);
             }
 
-            return new CompletionList(true, $items);
+            $isIncomplete = $isIncomplete || !$suggestions->getReturn();
+
+            return new CompletionList($isIncomplete, $items);
         });
     }
 

tests/LanguageServerCompletion/Unit/Handler/CompletionHandlerTest.php

@@ -40,9 +40,10 @@ public function testHandleNoSuggestions(): void
         );
         $this->assertInstanceOf(CompletionList::class, $response->result);
         $this->assertEquals([], $response->result->items);
+        $this->assertFalse($response->result->isIncomplete);
     }
 
-    public function testHandleSuggestions(): void
+    public function testHandleACompleteListOfSuggestions(): void
     {
         $tester = $this->create([
             Suggestion::create('hello'),
@@ -60,6 +61,28 @@ public function testHandleSuggestions(): void
             self::completionItem('hello', null),
             self::completionItem('goodbye', null),
         ], $response->result->items);
+        $this->assertFalse($response->result->isIncomplete);
+    }
+
+    public function testHandleAnIncompleteListOfSuggestions()
+    {
+        $tester = $this->create([
+            Suggestion::create('hello'),
+            Suggestion::create('goodbye'),
+        ], true, true);
+        $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->assertTrue($response->result->isIncomplete);
     }
 
     public function testHandleSuggestionsWithRange()
@@ -80,6 +103,7 @@ public function testHandleSuggestionsWithRange()
                 'hello'
             )])
         ], $response->result->items);
+        $this->assertFalse($response->result->isIncomplete);
     }
 
     public function testCancelReturnsPartialResults()
@@ -106,6 +130,7 @@ public function testCancelReturnsPartialResults()
         ]));
 
         $this->assertGreaterThan(1, count($responses[0]->result->items));
+        $this->assertTrue($responses[0]->result->isIncomplete);
     }
 
     public function testHandleSuggestionsWithSnippets()
@@ -135,6 +160,7 @@ public function testHandleSuggestionsWithSnippets()
             self::completionItem('goodbye', 2, ['insertText' => 'goodbye()', 'insertTextFormat' => 2]),
             self::completionItem('var', 6),
         ], $response->result->items);
+        $this->assertFalse($response->result->isIncomplete);
     }
 
     public function testHandleSuggestionsWithSnippetsWhenClientDoesNotSupportIt()
@@ -164,6 +190,7 @@ public function testHandleSuggestionsWithSnippetsWhenClientDoesNotSupportIt()
             self::completionItem('goodbye', 2),
             self::completionItem('var', 6),
         ], $response->result->items);
+        $this->assertFalse($response->result->isIncomplete);
     }
 
     private static function completionItem(
@@ -181,9 +208,9 @@ private static function completionItem(
         ], $data));
     }
 
-    private function create(array $suggestions, bool $supportSnippets = true): LanguageServerTester
+    private function create(array $suggestions, bool $supportSnippets = true, bool $isIncomplete = false): LanguageServerTester
     {
-        $completor = $this->createCompletor($suggestions);
+        $completor = $this->createCompletor($suggestions, $isIncomplete);
         $registry = new TypedCompletorRegistry([
             'php' => $completor,
         ]);
@@ -200,13 +227,15 @@ private function create(array $suggestions, bool $supportSnippets = true): Langu
         return $tester;
     }
 
-    private function createCompletor(array $suggestions): Completor
+    private function createCompletor(array $suggestions, bool $isIncomplete = false): Completor
     {
-        return new class($suggestions) implements Completor {
+        return new class($suggestions, $isIncomplete) implements Completor {
             private $suggestions;
-            public function __construct(array $suggestions)
+            private $isIncomplete;
+            public function __construct(array $suggestions, bool $isIncomplete)
             {
                 $this->suggestions = $suggestions;
+                $this->isIncomplete = $isIncomplete;
             }
 
             public function complete(TextDocument $source, ByteOffset $offset): Generator
@@ -217,6 +246,8 @@ public function complete(TextDocument $source, ByteOffset $offset): Generator
                     // simulate work
                     usleep(100);
                 }
+
+                return !$this->isIncomplete;
             }
         };
     }