also yield URIs to save memory

Author: nicolasmure

src/Index/AbstractAggregateIndex.php

@@ -160,19 +160,17 @@ public function getDefinition(string $fqn, bool $globalFallback = false)
     }
 
     /**
-     * Returns all URIs in this index that reference a symbol
+     * Returns a Generator providing all URIs in this index that reference a symbol
      *
      * @param string $fqn The fully qualified name of the symbol
-     * @return string[]
+     * @return \Generator providing string[]
      */
-    public function getReferenceUris(string $fqn): array
+    public function getReferenceUris(string $fqn): \Generator
     {
-        $refs = [];
         foreach ($this->getIndexes() as $index) {
-            foreach ($index->getReferenceUris($fqn) as $ref) {
-                $refs[] = $ref;
+            foreach ($index->getReferenceUris($fqn) as $uri) {
+                yield $uri;
             }
         }
-        return $refs;
     }
 }

src/Index/Index.php

@@ -197,14 +197,21 @@ public function removeDefinition(string $fqn)
     }
 
     /**
-     * Returns all URIs in this index that reference a symbol
+     * Returns a Generator providing all URIs in this index that reference a symbol
      *
      * @param string $fqn The fully qualified name of the symbol
-     * @return string[]
+     * @return \Generator providing string[]
      */
-    public function getReferenceUris(string $fqn): array
+    public function getReferenceUris(string $fqn): \Generator
     {
-        return $this->references[$fqn] ?? [];
+        $uris = isset($this->references[$fqn])
+            ? $this->references[$fqn]
+            : []
+        ;
+
+        foreach ($uris as $uri) {
+            yield $uri;
+        }
     }
 
     /**

src/Index/ReadableIndex.php

@@ -63,10 +63,10 @@ public function getDefinitionsForNamespace(string $namespace): \Generator;
     public function getDefinition(string $fqn, bool $globalFallback = false);
 
     /**
-     * Returns all URIs in this index that reference a symbol
+     * Returns a Generator providing all URIs in this index that reference a symbol
      *
      * @param string $fqn The fully qualified name of the symbol
-     * @return string[]
+     * @return \Generator providing string[]
      */
-    public function getReferenceUris(string $fqn): array;
+    public function getReferenceUris(string $fqn): \Generator;
 }

src/Server/TextDocument.php

@@ -219,10 +219,9 @@ public function references(
                         return [];
                     }
                 }
-                $refDocuments = yield Promise\all(array_map(
-                    [$this->documentLoader, 'getOrLoad'],
-                    $this->index->getReferenceUris($fqn)
-                ));
+                $refDocuments = yield Promise\all(iterator_to_array(
+                    $this->getOrLoadReferences($fqn))
+                );
                 foreach ($refDocuments as $document) {
                     $refs = $document->getReferenceNodesByFqn($fqn);
                     if ($refs !== null) {
@@ -397,4 +396,17 @@ public function xdefinition(TextDocumentIdentifier $textDocument, Position $posi
             return [new SymbolLocationInformation($descriptor, $def->symbolInformation->location)];
         });
     }
+
+    /**
+     * Gets or loads the documents referencing the given FQN.
+     *
+     * @param string $fqn
+     * @return \Generator providing Promise
+     */
+    private function getOrLoadReferences(string $fqn): \Generator
+    {
+        foreach ($this->index->getReferenceUris($fqn) as $ref) {
+            yield $this->documentLoader->getOrLoad($ref);
+        }
+    }
 }