Allow configurable file extension for indexing

src/Index/AbstractAggregateIndex.php

@@ -42,9 +42,6 @@ protected function registerIndex(ReadableIndex $index)
         $index->on('definition-added', function () {
             $this->emit('definition-added');
         });
-        $index->on('wipe', function() {
-            $this->emit('wipe');
-        });
     }
 
     /**

src/Index/Index.php

@@ -218,7 +218,5 @@ public function wipe()
         $this->references = [];
         $this->complete = false;
         $this->staticComplete = false;
-
-        $this->emit('wipe');
     }
 }

src/Options.php

@@ -11,11 +11,6 @@ class Options
      */
     public $fileTypes = ['.php'];
 
-    /**
-     * List of options that affect the indexer
-     */
-    private $indexerOptions = ['fileTypes'];
-
     /**
      * Validate/Filter input and set options for file types
      *
@@ -31,16 +26,6 @@ public function setFileTypes(array $fileTypes)
         $this->fileTypes = !empty($fileTypes) ? $fileTypes : $this->fileTypes;
     }
 
-    /**
-     * Get list with options that affect the indexer
-     *
-     * @return array
-     */
-    public function getIndexerOptions(): array
-    {
-        return $this->indexerOptions;
-    }
-
     /**
      * Filter valid file type
      *

src/Server/Workspace.php

@@ -216,28 +216,55 @@ public function xdependencies(): array
     }
 
     /**
-     * @param Options|null $settings
+     * Fires when client changes settings in the client
+     *
+     * The default paramter type is Options but it also accepts different types
+     * which will be transformed on demand.
+     *
+     * Currently only the vscode format is supported
+     *
+     * @param mixed|null $settings
+     * @return bool
+     * @throws \Exception Settings format not valid
      */
-    public function didChangeConfiguration(Options $settings = null)
+    public function didChangeConfiguration($settings = null): bool
     {
+        // List of options that affect the indexer
+        $indexerOptions = ['fileTypes'];
+
         if ($settings === null) {
-            return;
+            return false;
+        }
+
+        // VSC sends the settings with the config section as main key
+        if ($settings instanceof \stdClass && $settings->phpIntelliSense) {
+            $mapper = new \JsonMapper();
+            $settings = $mapper->map($settings->phpIntelliSense, new Options);
+        }
+
+        if (!($settings instanceof Options)) {
+            throw new \Exception('Settings format not valid.');
         }
 
         $changedOptions = $this->getChangedOptions($settings);
-        $this->options = $settings;
 
-        if (!empty(array_intersect($changedOptions, $this->options->getIndexerOptions()))) {
+        if (empty($changedOptions)) {
+            return false;
+        }
+
+        foreach (get_object_vars($settings) as $prop => $val) {
+            $this->options->$prop = $val;
+        }
+
+        if ($this->indexer && !empty(array_intersect($changedOptions, $indexerOptions))) {
             // check list of options that changed since last time against the list of valid indexer options
 
-            // start wiping from the main index
+            // wipe main index and start reindexing
             $this->index->wipe();
-
-            // check for existing indexer and start indexing
-            if ($this->indexer) {
-                $this->indexer->index()->otherwise('\\LanguageServer\\crash');
-            }
+            $this->indexer->index()->otherwise('\\LanguageServer\\crash');
         }
+
+        return true;
     }
 
     /**
@@ -248,10 +275,14 @@ public function didChangeConfiguration(Options $settings = null)
      */
     private function getChangedOptions(Options $settings): array
     {
-        // squash nested array for comparing changed options
-        $old = array_map('json_encode', get_object_vars($this->options));
-        $new = array_map('json_encode', get_object_vars($settings));
+        $old = get_object_vars($this->options);
+        $new = get_object_vars($settings);
+        $changed = array_udiff($old, $new, function ($a, $b) {
+            // custom callback since array_diff uses strings for comparison
+
+            return $a <=> $b;
+        });
 
-        return array_keys(array_diff($old, $new));
+        return array_keys($changed);
     }
 }

tests/Server/ServerTestCase.php

@@ -31,10 +31,6 @@ abstract class ServerTestCase extends TestCase
      */
     protected $documentLoader;
 
-    protected $projectIndex;
-    protected $input;
-    protected $output;
-
     /**
      * Map from FQN to Location of definition
      *
@@ -53,23 +49,20 @@ public function setUp()
     {
         $sourceIndex        = new Index;
         $dependenciesIndex  = new DependenciesIndex;
-        $this->projectIndex = new ProjectIndex($sourceIndex, $dependenciesIndex);
-        $this->projectIndex->setComplete();
+        $projectIndex = new ProjectIndex($sourceIndex, $dependenciesIndex);
+        $projectIndex->setComplete();
 
         $rootPath    = realpath(__DIR__ . '/../../fixtures/');
         $options     = new Options;
         $filesFinder = new FileSystemFilesFinder;
         $cache       = new FileSystemCache;
 
-        $this->input  = new MockProtocolStream;
-        $this->output = new MockProtocolStream;
-
-        $definitionResolver   = new DefinitionResolver($this->projectIndex);
-        $client               = new LanguageClient($this->input, $this->output);
-        $this->documentLoader = new PhpDocumentLoader(new FileSystemContentRetriever, $this->projectIndex, $definitionResolver);
-        $this->textDocument   = new Server\TextDocument($this->documentLoader, $definitionResolver, $client, $this->projectIndex);
+        $definitionResolver   = new DefinitionResolver($projectIndex);
+        $client               = new LanguageClient(new MockProtocolStream, new MockProtocolStream);
+        $this->documentLoader = new PhpDocumentLoader(new FileSystemContentRetriever, $projectIndex, $definitionResolver);
+        $this->textDocument   = new Server\TextDocument($this->documentLoader, $definitionResolver, $client, $projectIndex);
         $indexer              = new Indexer($filesFinder, $rootPath, $client, $cache, $dependenciesIndex, $sourceIndex, $this->documentLoader, null, null, $options);
-        $this->workspace      = new Server\Workspace($client, $this->projectIndex, $dependenciesIndex, $sourceIndex, null, $this->documentLoader, null, $indexer, $options);
+        $this->workspace      = new Server\Workspace($client, $projectIndex, $dependenciesIndex, $sourceIndex, null, $this->documentLoader, null, $indexer, $options);
 
         $globalSymbolsUri    = pathToUri(realpath(__DIR__ . '/../../fixtures/global_symbols.php'));
         $globalReferencesUri = pathToUri(realpath(__DIR__ . '/../../fixtures/global_references.php'));

tests/Server/Workspace/DidChangeConfigurationTest.php

@@ -3,55 +3,139 @@
 
 namespace LanguageServer\Tests\Server\Workspace;
 
-use LanguageServer\Tests\MockProtocolStream;
 use LanguageServer\Tests\Server\ServerTestCase;
-use LanguageServer\{Server, Client, LanguageClient, Project, PhpDocument, Options};
-use LanguageServer\Protocol\{
-    Message,
-    MessageType,
-    TextDocumentItem,
-    TextDocumentIdentifier,
-    SymbolInformation,
-    SymbolKind,
-    DiagnosticSeverity,
-    FormattingOptions,
-    Location,
-    Range,
-    Position
-};
-use AdvancedJsonRpc\{Request as RequestBody, Response as ResponseBody};
-use function LanguageServer\pathToUri;
+use LanguageServer\Tests\MockProtocolStream;
+use LanguageServer\{Server, LanguageClient, PhpDocumentLoader, DefinitionResolver, Options, Indexer};
+use LanguageServer\Index\{ProjectIndex, StubsIndex, GlobalIndex, DependenciesIndex, Index};
+use LanguageServer\ContentRetriever\FileSystemContentRetriever;
+use LanguageServer\Protocol\{Position, Location, Range, ClientCapabilities, Message, MessageType};
+use LanguageServer\FilesFinder\FileSystemFilesFinder;
+use LanguageServer\Cache\FileSystemCache;
+use LanguageServer\Server\Workspace;
 use Sabre\Event\Promise;
 use Exception;
 
 class DidChangeConfigurationTest extends ServerTestCase
 {
-    public function testWipingIndex()
+    /**
+     * didChangeConfiguration does not need to do anything when no options/settings are passed
+     */
+    public function testNoOptionPassed()
     {
-        $promise = new Promise;
+        $client = new LanguageClient(new MockProtocolStream(), $writer = new MockProtocolStream());
+        $projectIndex = new ProjectIndex($sourceIndex = new Index(), $dependenciesIndex = new DependenciesIndex());
+        $definitionResolver = new DefinitionResolver($projectIndex);
+        $loader = new PhpDocumentLoader(new FileSystemContentRetriever(), $projectIndex, $definitionResolver);
+        $workspace = new Server\Workspace($client, $projectIndex, $dependenciesIndex, $sourceIndex, null, $loader, null);
+
+        $result = $workspace->didChangeConfiguration();
+        $this->assertFalse($result);
+    }
+
+    /**
+     * When the passed options/settings do not differ from the previous, it has nothing to do
+     */
+    public function testFailsWithInvalidOptionsTypeOrFormat()
+    {
+        $options = new Options;
+        $client = new LanguageClient(new MockProtocolStream(), $writer = new MockProtocolStream());
+        $projectIndex = new ProjectIndex($sourceIndex = new Index(), $dependenciesIndex = new DependenciesIndex());
+        $definitionResolver = new DefinitionResolver($projectIndex);
+        $loader = new PhpDocumentLoader(new FileSystemContentRetriever(), $projectIndex, $definitionResolver);
+        $workspace = new Server\Workspace($client, $projectIndex, $dependenciesIndex, $sourceIndex, null, $loader, null, null, null, null, $options);
+
+        $this->expectException(\Exception::class);
+        $this->workspace->didChangeConfiguration(['invalid' => 'options format']);
+    }
+
+    /**
+     * When the passed options/settings do not differ from the previous, it has nothing to do
+     */
+    public function testNoChangedOptions()
+    {
+        $options = new Options;
+        $client = new LanguageClient(new MockProtocolStream(), $writer = new MockProtocolStream());
+        $projectIndex = new ProjectIndex($sourceIndex = new Index(), $dependenciesIndex = new DependenciesIndex());
+        $definitionResolver = new DefinitionResolver($projectIndex);
+        $loader = new PhpDocumentLoader(new FileSystemContentRetriever(), $projectIndex, $definitionResolver);
+        $workspace = new Server\Workspace($client, $projectIndex, $dependenciesIndex, $sourceIndex, null, $loader, null, null, null, null, $options);
+
+        $result = $this->workspace->didChangeConfiguration($options);
+        $this->assertFalse($result);
+    }
+
+    /**
+     * Verify that the required methods for a reindex are called
+     */
+    public function testFileTypesOptionTriggersAReindex()
+    {
+        $sourceIndex = new Index;
+        $dependenciesIndex = new DependenciesIndex;
+        $projectIndex = $this->getMockBuilder('LanguageServer\Index\ProjectIndex')
+                                ->setConstructorArgs([$sourceIndex, $dependenciesIndex])
+                                ->setMethods(['wipe'])
+                                ->getMock();
+        $projectIndex->setComplete();
+
+        $rootPath = realpath(__DIR__ . '/../../../fixtures/');
+        $filesFinder = new FileSystemFilesFinder;
+        $cache = new FileSystemCache;
+
+        $definitionResolver = new DefinitionResolver($projectIndex);
+        $client = new LanguageClient(new MockProtocolStream, new MockProtocolStream);
+        $documentLoader = new PhpDocumentLoader(new FileSystemContentRetriever, $projectIndex, $definitionResolver);
+        $textDocument = new Server\TextDocument($documentLoader, $definitionResolver, $client, $projectIndex);
+        $indexer = $this->getMockBuilder('LanguageServer\Indexer')
+                        ->setConstructorArgs([$filesFinder, $rootPath, $client, $cache, $dependenciesIndex, $sourceIndex, $documentLoader, null, null, new Options])
+                        ->setMethods(['index'])
+                        ->getMock();
+        $workspace = new Server\Workspace($client, $projectIndex, $dependenciesIndex, $sourceIndex, null, $documentLoader, null, $indexer, new Options);
 
-        $this->projectIndex->on('wipe', function() use ($promise) {
-            $promise->fulfill();
-        });
 
         $options = new Options;
         $options->fileTypes = [
             '.inc'
         ];
 
-        $this->workspace->didChangeConfiguration($options);
-        $promise->wait();
+        $projectIndex->expects($this->once())->method('wipe');
+        $indexer->expects($this->once())->method('index');
+
+        // invoke event
+        $result = $workspace->didChangeConfiguration($options);
+        $this->assertTrue($result);
     }
 
-    public function testReindexingAfterWipe()
+    /**
+     * Be sure that the indexer gets the new options/settings and uses them
+     */
+    public function testIndexerUsesNewOptions()
     {
         $promise = new Promise;
+        $sourceIndex = new Index;
+        $dependenciesIndex = new DependenciesIndex;
+        $projectIndex = new ProjectIndex($sourceIndex, $dependenciesIndex);
+        $projectIndex->setComplete();
+
+        $rootPath = realpath(__DIR__ . '/../../../fixtures/');
+        $filesFinder = new FileSystemFilesFinder;
+        $cache = new FileSystemCache;
+        $initialOptions = new Options;
+
+        $input = new MockProtocolStream;
+        $output = new MockProtocolStream;
+
+        $definitionResolver = new DefinitionResolver($projectIndex);
+        $client = new LanguageClient($input, $output);
+        $documentLoader = new PhpDocumentLoader(new FileSystemContentRetriever, $projectIndex, $definitionResolver);
+        $textDocument = new Server\TextDocument($documentLoader, $definitionResolver, $client, $projectIndex);
+        $indexer = new Indexer($filesFinder, $rootPath, $client, $cache, $dependenciesIndex, $sourceIndex, $documentLoader, null, null, $initialOptions);
+        $workspace = new Server\Workspace($client, $projectIndex, $dependenciesIndex, $sourceIndex, null, $documentLoader, null, $indexer, $initialOptions);
 
-        $this->output->on('message', function (Message $msg) use ($promise) {
+        $output->on('message', function (Message $msg) use ($promise) {
             if ($msg->body->method === 'window/logMessage' && $promise->state === Promise::PENDING) {
                 if ($msg->body->params->type === MessageType::ERROR) {
                     $promise->reject(new Exception($msg->body->params->message));
-                } elseif (strpos($msg->body->params->message, 'All 0 PHP files parsed') !== false) {
+                } elseif (strpos($msg->body->params->message, 'All 1 PHP files parsed') !== false) {
                     $promise->fulfill();
                 }
             }
@@ -62,11 +146,8 @@ public function testReindexingAfterWipe()
             '.inc'
         ];
 
-        $this->workspace->didChangeConfiguration($options);
+        $result = $workspace->didChangeConfiguration($options);
+        $this->assertTrue($result);
         $promise->wait();
     }
-
-    public function testGetChangedOptions()
-    {
-    }
 }