LSP Find References Feature (#14693)

niteskum · shubhsnov · commit 317992fa672c · 2019-04-15T16:12:35.000+05:30
* LSP Find References Feature

* Addressed bugs

* Addressed review comments

* Addressed review comments

* Changes to send data only once per 24 hours

* Adding Unit Test cases and supporting files

* changed string

* fixed review comments

* Addressed review comments

* Changed Shortcut to Ctrl-M

* Changed the Shortcut to Shift-F12
diff --git a/src/base-config/keyboard.json b/src/base-config/keyboard.json
@@ -162,6 +162,9 @@
     "cmd.findInFiles":  [
         "Ctrl-Shift-F"
     ],
+    "cmd.findAllReferences":  [
+        "Shift-F12"
+    ],
     "cmd.replaceInFiles":  [
         {
             "key": "Ctrl-Shift-H"
diff --git a/src/brackets.js b/src/brackets.js
@@ -141,6 +141,7 @@ define(function (require, exports, module) {
     //load language features
     require("features/ParameterHintsManager");
     require("features/JumpToDefManager");
+    require("features/FindReferencesManager");
 
     // Load modules that self-register and just need to get included in the main project
     require("command/DefaultMenus");
diff --git a/src/command/Commands.js b/src/command/Commands.js
@@ -97,6 +97,7 @@ define(function (require, exports, module) {
     exports.CMD_REPLACE                 = "cmd.replace";                // FindReplace.js               _replace()
     exports.CMD_REPLACE_IN_FILES        = "cmd.replaceInFiles";         // FindInFilesUI.js             _showReplaceBar()
     exports.CMD_REPLACE_IN_SUBTREE      = "cmd.replaceInSubtree";       // FindInFilesUI.js             _showReplaceBarForSubtree()
+    exports.CMD_FIND_ALL_REFERENCES     = "cmd.findAllReferences";      // findReferencesManager.js     _openReferencesPanel()
 
     // VIEW
     exports.CMD_THEMES_OPEN_SETTINGS    = "view.themesOpenSetting";     // MenuCommands.js              Settings.open()
diff --git a/src/command/DefaultMenus.js b/src/command/DefaultMenus.js
@@ -136,6 +136,7 @@ define(function (require, exports, module) {
         menu.addMenuItem(Commands.CMD_SKIP_CURRENT_MATCH);
         menu.addMenuDivider();
         menu.addMenuItem(Commands.CMD_FIND_IN_FILES);
+        menu.addMenuItem(Commands.CMD_FIND_ALL_REFERENCES);
         menu.addMenuDivider();
         menu.addMenuItem(Commands.CMD_REPLACE);
         menu.addMenuItem(Commands.CMD_REPLACE_IN_FILES);
@@ -283,6 +284,7 @@ define(function (require, exports, module) {
         // editor_cmenu.addMenuItem(Commands.NAVIGATE_JUMPTO_DEFINITION);
         editor_cmenu.addMenuItem(Commands.TOGGLE_QUICK_EDIT);
         editor_cmenu.addMenuItem(Commands.TOGGLE_QUICK_DOCS);
+        editor_cmenu.addMenuItem(Commands.CMD_FIND_ALL_REFERENCES);
         editor_cmenu.addMenuDivider();
         editor_cmenu.addMenuItem(Commands.EDIT_CUT);
         editor_cmenu.addMenuItem(Commands.EDIT_COPY);
diff --git a/src/extensions/default/PhpTooling/main.js b/src/extensions/default/PhpTooling/main.js
@@ -33,6 +33,7 @@ define(function (require, exports, module) {
         QuickOpen = brackets.getModule("search/QuickOpen"),
         ParameterHintManager = brackets.getModule("features/ParameterHintsManager"),
         JumpToDefManager = brackets.getModule("features/JumpToDefManager"),
+        FindReferencesManager = brackets.getModule("features/FindReferencesManager"),
         CodeInspection = brackets.getModule("language/CodeInspection"),
         DefaultProviders = brackets.getModule("languageTools/DefaultProviders"),
         CodeHintsProvider = require("CodeHintsProvider").CodeHintsProvider,
@@ -65,7 +66,8 @@ define(function (require, exports, module) {
         lProvider,
         jdProvider,
         dSymProvider,
-        pSymProvider;
+        pSymProvider,
+        refProvider;
 
     PreferencesManager.definePreference("php", "object", phpConfig, {
         description: Strings.DESCRIPTION_PHP_TOOLING_CONFIGURATION
@@ -108,10 +110,12 @@ define(function (require, exports, module) {
         jdProvider = new DefaultProviders.JumpToDefProvider(_client);
         dSymProvider = new SymbolProviders.DocumentSymbolsProvider(_client);
         pSymProvider = new SymbolProviders.ProjectSymbolsProvider(_client);
+        refProvider = new DefaultProviders.ReferencesProvider(_client);
 
         JumpToDefManager.registerJumpToDefProvider(jdProvider, ["php"], 0);
         CodeHintManager.registerHintProvider(chProvider, ["php"], 0);
         ParameterHintManager.registerHintProvider(phProvider, ["php"], 0);
+        FindReferencesManager.registerFindReferencesProvider(refProvider, ["php"], 0);
         CodeInspection.register(["php"], {
             name: "",
             scanFileAsync: lProvider.getInspectionResultsAsync.bind(lProvider)
diff --git a/src/extensions/default/PhpTooling/unittest-files/test/test2.php b/src/extensions/default/PhpTooling/unittest-files/test/test2.php
@@ -26,5 +26,22 @@ function watchparameterhint() {
 $A11()
 fopen("",)
 watchparameterhint()
+    
+
+function watchReferences() {
+    echo "Hello World!";
+}
+
+watchReferences();
+
+watchReferences();
+
+
+function ReferencesInMultipleFile() {
+    echo "Hello World!";
+}
+
+ReferencesInMultipleFile();
 
+ReferencesInMultipleFile();
 ?>
diff --git a/src/extensions/default/PhpTooling/unittest-files/test/test3.php b/src/extensions/default/PhpTooling/unittest-files/test/test3.php
@@ -7,4 +7,6 @@ class testA
     protected $B = [
         'A1', 'A2'
     ];
-}
+}
+
+ReferencesInMultipleFile();
diff --git a/src/extensions/default/PhpTooling/unittests.js b/src/extensions/default/PhpTooling/unittests.js
@@ -398,6 +398,40 @@ define(function (require, exports, module) {
 
         }
 
+        function expectReferences(referencesExpected) {
+            var refPromise,
+                results = null,
+                complete = false;
+            runs(function () {
+                refPromise = (new DefaultProviders.ReferencesProvider(phpToolingExtension.getClient())).getReferences();
+                refPromise.done(function (resp) {
+                    complete = true;
+                    results = resp;
+                }).fail(function(){
+                    complete = true;
+                });
+            });
+
+            waitsFor(function () {
+                return complete;
+            }, "Expected Reference Promise did not resolve", 3000);
+
+            if(referencesExpected === null) {
+                expect(results).toBeNull();
+                return;
+            }
+
+            runs(function() {
+                expect(results.numFiles).toBe(referencesExpected.numFiles);
+                expect(results.numMatches).toBe(referencesExpected.numMatches);
+                expect(results.allResultsAvailable).toBe(referencesExpected.allResultsAvailable);
+                expect(results.results).not.toBeNull();
+                for(var key in results.keys) {
+                    expect(results.results.key).toBe(referencesExpected.results.key);
+                }
+            });
+        }
+
         /**
          * Check the presence of Error Prompt on Brackets Window
          */
@@ -533,6 +567,112 @@ define(function (require, exports, module) {
             });
         });
 
+        it("should not show any references", function () {
+            var start = { line: 6, ch: 4 };
+
+            runs(function () {
+                testEditor = EditorManager.getActiveEditor();
+                testEditor.setCursorPos(start);
+                expectReferences(null);
+            });
+        });
+
+        it("should  show  reference present in single file", function () {
+            var start = { line: 22, ch: 18 },
+                results = {};
+
+            runs(function () {
+                testEditor = EditorManager.getActiveEditor();
+                testEditor.setCursorPos(start);
+                results[testFolder + "test/test2.php"] = {matches: [
+                    {
+                        start: {line: 27, ch: 0},
+                        end: {line: 27, ch: 18},
+                        line: "watchparameterhint()"
+                    }
+                ]
+                };
+                expectReferences({
+                    numFiles: 1,
+                    numMatches: 1,
+                    allResultsAvailable: true,
+                    queryInfo: "watchparameterhint",
+                    keys: [testFolder + "test/test2.php"],
+                    results: results
+                });
+            });
+        });
+
+        it("should  show  references present in single file", function () {
+            var start = { line: 34, ch: 8 },
+                results = {};
+
+            runs(function () {
+                testEditor = EditorManager.getActiveEditor();
+                testEditor.setCursorPos(start);
+                results[testFolder + "test/test2.php"] = {matches: [
+                    {
+                        start: {line: 34, ch: 0},
+                        end: {line: 34, ch: 17},
+                        line: "watchReferences();"
+                    },
+                    {
+                        start: {line: 36, ch: 0},
+                        end: {line: 36, ch: 17},
+                        line: "watchReferences();"
+                    }
+                ]
+                };
+                expectReferences({
+                    numFiles: 1,
+                    numMatches: 2,
+                    allResultsAvailable: true,
+                    queryInfo: "watchparameterhint",
+                    keys: [testFolder + "test/test2.php"],
+                    results: results
+                });
+            });
+        });
+
+        it("should  show  references present in multiple files", function () {
+            var start = { line: 39, ch: 21 },
+                results = {};
+
+            runs(function () {
+                testEditor = EditorManager.getActiveEditor();
+                testEditor.setCursorPos(start);
+                results[testFolder + "test/test2.php"] = {matches: [
+                    {
+                        start: {line: 34, ch: 0},
+                        end: {line: 34, ch: 26},
+                        line: "watchReferences();"
+                    },
+                    {
+                        start: {line: 36, ch: 0},
+                        end: {line: 36, ch: 26},
+                        line: "watchReferences();"
+                    }
+                ]
+                };
+                results[testFolder + "test/test3.php"] = {matches: [
+                    {
+                        start: {line: 11, ch: 0},
+                        end: {line: 11, ch: 26},
+                        line: "watchReferences();"
+                    }
+                ]
+                };
+                expectReferences({
+                    numFiles: 2,
+                    numMatches: 3,
+                    allResultsAvailable: true,
+                    queryInfo: "watchparameterhint",
+                    keys: [testFolder + "test/test2.php", testFolder + "test/test3.php"],
+                    results: results
+                });
+            });
+        });
+
         it("should jump to earlier defined variable", function () {
             var start = { line: 4, ch: 2 };
 
diff --git a/src/features/FindReferencesManager.js b/src/features/FindReferencesManager.js
diff --git a/src/languageTools/DefaultProviders.js b/src/languageTools/DefaultProviders.js
diff --git a/src/nls/root/strings.js b/src/nls/root/strings.js
diff --git a/src/search/SearchResultsView.js b/src/search/SearchResultsView.js
