Fixed LSP Linting Synchronization Issues (#14685)

niteskum · shubhsnov · commit d602c87cab20 · 2019-04-05T15:31:22.000+05:30
* Fixed LSP Linting Synchrnization Issues

* Addressed review comments

* Removing Linter Name as it is not required
diff --git a/src/extensions/default/PhpTooling/main.js b/src/extensions/default/PhpTooling/main.js
@@ -57,7 +57,11 @@ define(function (require, exports, module) {
         DEBUG_OPEN_PREFERENCES_IN_SPLIT_VIEW  = "debug.openPrefsInSplitView",
         phpServerRunning = false,
         serverCapabilities,
-        currentRootPath;
+        currentRootPath,
+        chProvider,
+        phProvider,
+        lProvider,
+        jdProvider;
 
     PreferencesManager.definePreference("php", "object", phpConfig, {
         description: Strings.DESCRIPTION_PHP_TOOLING_CONFIGURATION
@@ -66,6 +70,9 @@ define(function (require, exports, module) {
     PreferencesManager.on("change", "php", function () {
         var newPhpConfig = PreferencesManager.get("php");
 
+        if (lProvider && newPhpConfig["validateOnType"] !== phpConfig["validateOnType"]) {
+            lProvider._validateOnType = !(newPhpConfig["validateOnType"] === "false");
+        }
         if ((newPhpConfig["executablePath"] !== phpConfig["executablePath"])
                 || (newPhpConfig["enablePhpTooling"] !== phpConfig["enablePhpTooling"])) {
             phpConfig = newPhpConfig;
@@ -76,6 +83,7 @@ define(function (require, exports, module) {
     });
 
     var handleProjectOpen = function (event, directory) {
+        lProvider.clearExistingResults();
         if(serverCapabilities["workspace"] && serverCapabilities["workspace"]["workspaceFolders"]) {
             _client.notifyProjectRootsChanged({
                 foldersAdded: [directory.fullPath],
@@ -90,17 +98,17 @@ define(function (require, exports, module) {
     };
 
     function registerToolingProviders() {
-        var chProvider = new CodeHintsProvider(_client),
-            phProvider = new DefaultProviders.ParameterHintsProvider(_client),
-            lProvider = new DefaultProviders.LintingProvider(_client),
-            jdProvider = new DefaultProviders.JumpToDefProvider(_client);
+        chProvider = new CodeHintsProvider(_client),
+        phProvider = new DefaultProviders.ParameterHintsProvider(_client),
+        lProvider = new DefaultProviders.LintingProvider(_client),
+        jdProvider = new DefaultProviders.JumpToDefProvider(_client);
 
         JumpToDefManager.registerJumpToDefProvider(jdProvider, ["php"], 0);
         CodeHintManager.registerHintProvider(chProvider, ["php"], 0);
         ParameterHintManager.registerHintProvider(phProvider, ["php"], 0);
         CodeInspection.register(["php"], {
-            name: Strings.PHP_DIAGNOSTICS,
-            scanFile: lProvider.getInspectionResults.bind(lProvider)
+            name: "",
+            scanFileAsync: lProvider.getInspectionResultsAsync.bind(lProvider)
         });
 
         _client.addOnCodeInspection(lProvider.setInspectionResults.bind(lProvider));
@@ -114,9 +122,7 @@ define(function (require, exports, module) {
 
 
         if (phpConfig["validateOnType"] !== "false") {
-            _client.addOnDocumentChangeHandler(function () {
-                CodeInspection.requestRun(Strings.PHP_DIAGNOSTICS);
-            });
+            lProvider._validateOnType = true;
         }
 
         _client.addOnProjectOpenHandler(handleProjectOpen);
@@ -170,12 +176,8 @@ define(function (require, exports, module) {
             EditorManager.off("activeEditorChange.php");
             LanguageManager.off("languageModified.php");
         }
-
         evtHandler.handleActiveEditorChange(null, EditorManager.getActiveEditor());
         currentRootPath = ProjectManager.getProjectRoot()._path;
-        setTimeout(function () {
-            CodeInspection.requestRun(Strings.PHP_DIAGNOSTICS);
-        }, 1500);
     }
 
     function runPhpServer() {
diff --git a/src/languageTools/DefaultProviders.js b/src/languageTools/DefaultProviders.js
@@ -335,16 +335,20 @@ define(function (require, exports, module) {
 
     function LintingProvider() {
         this._results = new Map();
+        this._promiseMap = new Map();
+        this._validateOnType = false;
     }
 
     LintingProvider.prototype.clearExistingResults = function (filePath) {
         var filePathProvided = !!filePath;
 
         if (filePathProvided) {
             this._results.delete(filePath);
+            this._promiseMap.delete(filePath);
         } else {
             //clear all results
             this._results.clear();
+            this._promiseMap.clear();
         }
     };
 
@@ -371,6 +375,27 @@ define(function (require, exports, module) {
         this._results.set(filePath, {
             errors: errors
         });
+        if(this._promiseMap.get(filePath)) {
+           this._promiseMap.get(filePath).resolve(this._results.get(filePath));
+           this._promiseMap.delete(filePath);
+        }
+        if (this._validateOnType) {
+            var editor = EditorManager.getActiveEditor(),
+                docPath = editor ? editor.document.file._path : "";
+            if (filePath === docPath) {
+                CodeInspection.requestRun();
+            }
+        }
+    };
+
+    LintingProvider.prototype.getInspectionResultsAsync = function (fileText, filePath) {
+        var result = $.Deferred();
+
+        if (this._results.get(filePath)) {
+            return result.resolve(this._results.get(filePath));
+        }
+        this._promiseMap.set(filePath, result);
+        return result;
     };
 
     LintingProvider.prototype.getInspectionResults = function (fileText, filePath) {
diff --git a/src/nls/root/strings.js b/src/nls/root/strings.js
@@ -886,7 +886,6 @@ define({
     "PHP_SERVER_MEMORY_LIMIT_INVALID"                : "The memory limit you provided is invalid. Review the PHP preferences to set the correct value.",
     "DESCRIPTION_PHP_TOOLING_CONFIGURATION"          : "PHP Tooling default configuration settings",
     "OPEN_PREFERENNCES"                              : "Open Preferences",
-    "PHP_DIAGNOSTICS"                                : "Diagnostics",
 
     //Strings for LanguageTools Preferences
     LANGUAGE_TOOLS_PREFERENCES                       : "Preferences for Language Tools"
