Allow configurable file extension for indexing

fixtures/different_extension.inc

@@ -0,0 +1 @@
+<?php

src/Index/AbstractAggregateIndex.php

@@ -147,4 +147,14 @@ public function getReferenceUris(string $fqn): array
         }
         return $refs;
     }
+
+    /**
+     * Wipe all indexes for a reindex
+     */
+    public function wipe()
+    {
+        foreach ($this->getIndexes() as $index) {
+            $index->wipe();
+        }
+    }
 }

src/Index/Index.php

@@ -211,4 +211,12 @@ public function serialize()
             'staticComplete' => $this->staticComplete
         ]);
     }
+
+    public function wipe()
+    {
+        $this->definitions = [];
+        $this->references = [];
+        $this->complete = false;
+        $this->staticComplete = false;
+    }
 }

src/Indexer.php

@@ -65,14 +65,20 @@ class Indexer
     private $composerJson;
 
     /**
-     * @param FilesFinder       $filesFinder
-     * @param string            $rootPath
-     * @param LanguageClient    $client
-     * @param Cache             $cache
-     * @param DependenciesIndex $dependenciesIndex
-     * @param Index             $sourceIndex
-     * @param PhpDocumentLoader $documentLoader
-     * @param \stdClass|null    $composerLock
+     * @var Options
+     */
+    private $options;
+
+    /**
+     * @param FilesFinder            $filesFinder
+     * @param string                 $rootPath
+     * @param LanguageClient         $client
+     * @param Cache                  $cache
+     * @param DependenciesIndex      $dependenciesIndex
+     * @param Index                  $sourceIndex
+     * @param PhpDocumentLoader      $documentLoader
+     * @param \stdClass|null         $composerLock
+     * @param Options|null           $options
      */
     public function __construct(
         FilesFinder $filesFinder,
@@ -83,7 +89,8 @@ public function __construct(
         Index $sourceIndex,
         PhpDocumentLoader $documentLoader,
         \stdClass $composerLock = null,
-        \stdClass $composerJson = null
+        \stdClass $composerJson = null,
+        Options $options = null
     ) {
         $this->filesFinder = $filesFinder;
         $this->rootPath = $rootPath;
@@ -94,6 +101,7 @@ public function __construct(
         $this->documentLoader = $documentLoader;
         $this->composerLock = $composerLock;
         $this->composerJson = $composerJson;
+        $this->options = $options;
     }
 
     /**
@@ -104,8 +112,8 @@ public function __construct(
     public function index(): Promise
     {
         return coroutine(function () {
-
-            $pattern = Path::makeAbsolute('**/*.php', $this->rootPath);
+            $fileTypes = implode(',', $this->options->fileTypes);
+            $pattern = Path::makeAbsolute('**/*{' . $fileTypes . '}', $this->rootPath);
             $uris = yield $this->filesFinder->find($pattern);
 
             $count = count($uris);

src/LanguageServer.php

@@ -167,11 +167,12 @@ public function __construct(ProtocolReader $reader, ProtocolWriter $writer)
      * @param ClientCapabilities $capabilities The capabilities provided by the client (editor)
      * @param string|null $rootPath The rootPath of the workspace. Is null if no folder is open.
      * @param int|null $processId The process Id of the parent process that started the server. Is null if the process has not been started by another process. If the parent process is not alive then the server should exit (see exit notification) its process.
+     * @param Options $initializationOptions The options send from client to initialize the server
      * @return Promise <InitializeResult>
      */
-    public function initialize(ClientCapabilities $capabilities, string $rootPath = null, int $processId = null): Promise
+    public function initialize(ClientCapabilities $capabilities, string $rootPath = null, int $processId = null, Options $initializationOptions = null): Promise
     {
-        return coroutine(function () use ($capabilities, $rootPath, $processId) {
+        return coroutine(function () use ($capabilities, $rootPath, $processId, $initializationOptions) {
 
             if ($capabilities->xfilesProvider) {
                 $this->filesFinder = new ClientFilesFinder($this->client);
@@ -190,6 +191,7 @@ public function initialize(ClientCapabilities $capabilities, string $rootPath =
             $this->projectIndex = new ProjectIndex($sourceIndex, $dependenciesIndex, $this->composerJson);
             $stubsIndex = StubsIndex::read();
             $this->globalIndex = new GlobalIndex($stubsIndex, $this->projectIndex);
+            $initializationOptions = $initializationOptions ?? new Options;
 
             // The DefinitionResolver should look in stubs, the project source and dependencies
             $this->definitionResolver = new DefinitionResolver($this->globalIndex);
@@ -235,7 +237,8 @@ public function initialize(ClientCapabilities $capabilities, string $rootPath =
                     $sourceIndex,
                     $this->documentLoader,
                     $this->composerLock,
-                    $this->composerJson
+                    $this->composerJson,
+                    $initializationOptions
                 );
                 $indexer->index()->otherwise('\\LanguageServer\\crash');
             }
@@ -259,7 +262,9 @@ public function initialize(ClientCapabilities $capabilities, string $rootPath =
                     $sourceIndex,
                     $this->composerLock,
                     $this->documentLoader,
-                    $this->composerJson
+                    $this->composerJson,
+                    $indexer,
+                    $initializationOptions
                 );
             }
 

src/Options.php

@@ -0,0 +1,64 @@
+<?php
+
+namespace LanguageServer;
+
+class Options
+{
+    /**
+     * Filetypes the indexer should process
+     *
+     * @var string[]
+     */
+    public $fileTypes = ['.php'];
+
+    /**
+     * List of options that affect the indexer
+     */
+    private $indexerOptions = ['fileTypes'];
+
+    /**
+     * Validate/Filter input and set options for file types
+     *
+     * @param array $fileTypes List of file types
+     */
+    public function setFileTypes(array $fileTypes)
+    {
+        $fileTypes = filter_var_array($fileTypes, FILTER_SANITIZE_STRING);
+        $fileTypes =  filter_var($fileTypes, FILTER_CALLBACK, ['options' => [$this, 'filterFileTypes']]); // validate file type format
+        $fileTypes = array_filter($fileTypes, 'strlen'); // filter empty items
+        $fileTypes = array_values($fileTypes); //rebase indexes
+
+        $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
+     *
+     * @param string $fileType The file type to filter
+     * @return string|bool If valid it returns the file type, otherwise false
+     */
+    private function filterFileTypes(string $fileType)
+    {
+        $fileType = trim($fileType);
+
+        if (empty($fileType)) {
+            return $fileType;
+        }
+
+        if (substr($fileType, 0, 1) !== '.') {
+            return false;
+        }
+
+        return $fileType;
+    }
+}

src/Server/Workspace.php

@@ -3,7 +3,7 @@
 
 namespace LanguageServer\Server;
 
-use LanguageServer\{LanguageClient, Project, PhpDocumentLoader};
+use LanguageServer\{LanguageClient, Project, PhpDocumentLoader, Options, Indexer};
 use LanguageServer\Index\{ProjectIndex, DependenciesIndex, Index};
 use LanguageServer\Protocol\{
     FileChangeType,
@@ -45,6 +45,16 @@ class Workspace
      */
     private $sourceIndex;
 
+    /**
+     * @var Options
+     */
+    private $options;
+
+    /**
+     * @var Indexer
+     */
+    private $indexer;
+
     /**
      * @var \stdClass
      */
@@ -62,8 +72,10 @@ class Workspace
      * @param DependenciesIndex $sourceIndex       Index that is used on a workspace/xreferences request
      * @param \stdClass         $composerLock      The parsed composer.lock of the project, if any
      * @param PhpDocumentLoader $documentLoader    PhpDocumentLoader instance to load documents
+     * @param Indexer           $indexer
+     * @param Options            $options
      */
-    public function __construct(LanguageClient $client, ProjectIndex $index, DependenciesIndex $dependenciesIndex, Index $sourceIndex, \stdClass $composerLock = null, PhpDocumentLoader $documentLoader, \stdClass $composerJson = null)
+    public function __construct(LanguageClient $client, ProjectIndex $index, DependenciesIndex $dependenciesIndex, Index $sourceIndex, \stdClass $composerLock = null, PhpDocumentLoader $documentLoader, \stdClass $composerJson = null, Indexer $indexer = null, Options $options = null)
     {
         $this->client = $client;
         $this->sourceIndex = $sourceIndex;
@@ -72,6 +84,8 @@ public function __construct(LanguageClient $client, ProjectIndex $index, Depende
         $this->composerLock = $composerLock;
         $this->documentLoader = $documentLoader;
         $this->composerJson = $composerJson;
+        $this->indexer = $indexer;
+        $this->options = $options;
     }
 
     /**
@@ -200,4 +214,69 @@ public function xdependencies(): array
         }
         return $dependencyReferences;
     }
+
+    /**
+     * 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 void
+     */
+    public function didChangeConfiguration($settings = null)
+    {
+        if ($settings === null) {
+            return;
+        }
+
+        // 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)) {
+            return;
+        }
+
+        $changedOptions = $this->getChangedOptions($settings);
+
+        if (empty($changedOptions)) {
+            return;
+        }
+
+        foreach (get_object_vars($settings) as $prop => $val) {
+            $this->options->$prop = $val;
+        }
+
+        if ($this->indexer && !empty(array_intersect($changedOptions, $this->options->getIndexerOptions()))) {
+            // check list of options that changed since last time against the list of valid indexer options
+
+            // wipe main index and start reindexing
+            $this->index->wipe();
+            $this->indexer->index()->otherwise('\\LanguageServer\\crash');
+        }
+    }
+
+    /**
+     * Get a list with all options that changed since last time
+     *
+     * @param Options $settings
+     * @return array List with changed options
+     */
+    private function getChangedOptions(Options $settings): array
+    {
+        $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($changed);
+    }
 }

tests/LanguageServerTest.php

@@ -5,6 +5,7 @@
 
 use PHPUnit\Framework\TestCase;
 use LanguageServer\LanguageServer;
+use LanguageServer\Options;
 use LanguageServer\Protocol\{
     Message,
     ClientCapabilities,
@@ -117,4 +118,31 @@ public function testIndexingWithFilesAndContentRequests()
         $this->assertTrue($filesCalled);
         $this->assertTrue($contentCalled);
     }
+
+    public function testIndexingMultipleFileTypes()
+    {
+        $promise = new Promise;
+        $input = new MockProtocolStream;
+        $output = new MockProtocolStream;
+        $options = new Options;
+
+        $options->setFileTypes([
+            '.php',
+            '.inc'
+        ]);
+
+        $output->on('message', function (Message $msg) use ($promise, &$foundFiles) {
+            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));
+                } else if (strpos($msg->body->params->message, 'All 27 PHP files parsed') !== false) {
+                    $promise->fulfill();
+                }
+            }
+        });
+        $server = new LanguageServer($input, $output);
+        $capabilities = new ClientCapabilities;
+        $server->initialize($capabilities, realpath(__DIR__ . '/../fixtures'), getmypid(), $options);
+        $promise->wait();
+    }
 }

tests/OptionsTest.php

@@ -0,0 +1,28 @@
+<?php
+declare(strict_types = 1);
+
+namespace LanguageServer\Tests;
+
+use PHPUnit\Framework\TestCase;
+use LanguageServer\Options;
+
+class OptionsTest extends TestCase
+{
+    public function testFileTypesOption()
+    {
+        $expected = [
+            '.php',
+            '.valid'
+        ];
+
+        $options = new Options;
+        $options->setFileTypes([
+            '.php',
+            false,
+            12345,
+            '.valid'
+        ]);
+
+        $this->assertSame($expected, $options->fileTypes);
+    }
+}