feat: add find references feature (#40)

- fixed a bug which caused prefix-ed fields to be renames as well.

Author: coder3101

Cargo.lock

@@ -1,7 +1,7 @@
 [package]
 name = "protols"
 description = "Language server for proto3 files"
-version = "0.7.1"
+version = "0.8.0"
 edition = "2021"
 license = "MIT"
 homepage = "https://github.com/coder3101/protols"

Cargo.toml

@@ -16,6 +16,7 @@
 - ✅ Go to Definition
 - ✅ Hover Information
 - ✅ Rename Symbols
+- ✅ Find references
 
 ## 🚀 Getting Started
 
@@ -71,6 +72,10 @@ Displays comments and documentation for protobuf symbols on hover. Works seamles
 
 Allows renaming of symbols like messages and enums, along with all their usages across packages. Currently, renaming fields within symbols is not supported directly.
 
+### Find References
+
+Allows user defined types like messages and enums can be checked for references. Nested fields are completely supported.
+
 ---
 
 Protols is designed to supercharge your workflow with **proto** files. We welcome contributions and feedback from the community! Feel free to check out the [repository](https://github.com/coder3101/protols) and join in on improving this tool! 🎉

README.md

@@ -6,7 +6,19 @@ use std::thread;
 use tracing::{error, info};
 
 use async_lsp::lsp_types::{
-    CompletionItem, CompletionItemKind, CompletionOptions, CompletionParams, CompletionResponse, CreateFilesParams, DeleteFilesParams, DidChangeConfigurationParams, DidChangeTextDocumentParams, DidCloseTextDocumentParams, DidOpenTextDocumentParams, DidSaveTextDocumentParams, DocumentFormattingParams, DocumentRangeFormattingParams, DocumentSymbolParams, DocumentSymbolResponse, FileOperationFilter, FileOperationPattern, FileOperationPatternKind, FileOperationRegistrationOptions, GotoDefinitionParams, GotoDefinitionResponse, Hover, HoverContents, HoverParams, HoverProviderCapability, InitializeParams, InitializeResult, OneOf, PrepareRenameResponse, ProgressParams, RenameFilesParams, RenameOptions, RenameParams, ServerCapabilities, ServerInfo, TextDocumentPositionParams, TextDocumentSyncCapability, TextDocumentSyncKind, TextEdit, Url, WorkspaceEdit, WorkspaceFileOperationsServerCapabilities, WorkspaceFoldersServerCapabilities, WorkspaceServerCapabilities
+    CompletionItem, CompletionItemKind, CompletionOptions, CompletionParams, CompletionResponse,
+    CreateFilesParams, DeleteFilesParams, DidChangeConfigurationParams,
+    DidChangeTextDocumentParams, DidCloseTextDocumentParams, DidOpenTextDocumentParams,
+    DidSaveTextDocumentParams, DocumentFormattingParams, DocumentRangeFormattingParams,
+    DocumentSymbolParams, DocumentSymbolResponse, FileOperationFilter, FileOperationPattern,
+    FileOperationPatternKind, FileOperationRegistrationOptions, GotoDefinitionParams,
+    GotoDefinitionResponse, Hover, HoverContents, HoverParams, HoverProviderCapability,
+    InitializeParams, InitializeResult, Location, OneOf, PrepareRenameResponse, ProgressParams,
+    ReferenceParams, RenameFilesParams, RenameOptions, RenameParams, ServerCapabilities,
+    ServerInfo, TextDocumentPositionParams, TextDocumentSyncCapability,
+    TextDocumentSyncKind, TextEdit, Url, WorkspaceEdit,
+    WorkspaceFileOperationsServerCapabilities, WorkspaceFoldersServerCapabilities,
+    WorkspaceServerCapabilities,
 };
 use async_lsp::{LanguageClient, LanguageServer, ResponseError};
 use futures::future::BoxFuture;
@@ -69,7 +81,8 @@ impl LanguageServer for ProtoLanguageServer {
         let mut formatter_provider = None;
         let mut formatter_range_provider = None;
         if let Some(folders) = params.workspace_folders {
-            if let Ok(f) = ClangFormatter::new("clang-format", folders.first().map(|f| f.uri.path()))
+            if let Ok(f) =
+                ClangFormatter::new("clang-format", folders.first().map(|f| f.uri.path()))
             {
                 self.state.add_formatter(f);
                 formatter_provider = Some(OneOf::Left(true));
@@ -124,6 +137,7 @@ impl LanguageServer for ProtoLanguageServer {
                 rename_provider: Some(rename_provider),
                 document_formatting_provider: formatter_provider,
                 document_range_formatting_provider: formatter_range_provider,
+                references_provider: Some(OneOf::Left(true)),
 
                 ..ServerCapabilities::default()
             },
@@ -265,6 +279,43 @@ impl LanguageServer for ProtoLanguageServer {
         Box::pin(async move { Ok(response) })
     }
 
+    fn references(
+        &mut self,
+        param: ReferenceParams,
+    ) -> BoxFuture<'static, Result<Option<Vec<Location>>, ResponseError>> {
+        let uri = param.text_document_position.text_document.uri;
+        let pos = param.text_document_position.position;
+
+        let Some(tree) = self.state.get_tree(&uri) else {
+            error!(uri=%uri, "failed to get tree");
+            return Box::pin(async move { Ok(None) });
+        };
+
+        let content = self.state.get_content(&uri);
+
+        let Some(current_package) = tree.get_package_name(content.as_bytes()) else {
+            error!(uri=%uri, "failed to get package name");
+            return Box::pin(async move { Ok(None) });
+        };
+
+        let Some((mut refs, otext)) = tree.reference_tree(&pos, content.as_bytes()) else {
+            error!(uri=%uri, "failed to find references in a tree");
+            return Box::pin(async move { Ok(None) });
+        };
+
+        if let Some(v) = self.state.reference_fields(current_package, &otext) {
+            refs.extend(v);
+        }
+
+        Box::pin(async move {
+            if refs.is_empty() {
+                Ok(None)
+            } else {
+                Ok(Some(refs))
+            }
+        })
+    }
+
     fn definition(
         &mut self,
         param: GotoDefinitionParams,

src/lsp.rs

@@ -0,0 +1,31 @@
+syntax = "proto3";
+
+package com.parser;
+
+// A Book is book
+message Book {
+
+  // This is represents author
+  // A author is a someone who writes books
+  //
+  // Author has a name and a country where they were born
+  message Author {
+    string name = 1;
+    string country = 2;
+  };
+  Author author = 1;
+  int price_usd = 2;
+}
+
+message BookShelf {}
+
+message Library {
+  repeated Book books = 1;
+  Book.Author collection = 2;
+  BookShelf shelf = 3;
+}
+
+service Myservice {
+  rpc GetBook(Empty) returns (Book);
+  rpc GetAuthor(Empty) returns (Book.Author)
+}

src/parser/input/test_reference.proto

@@ -17,9 +17,12 @@ message Book {
     int price_usd = 2;
 }
 
+message BookShelf {}
+
 message Library {
     repeated Book books = 1;
     Book.Author collection = 2;
+    BookShelf shelf = 3;
 }
 
 service Myservice {

src/parser/input/test_rename.proto

@@ -1,4 +1,4 @@
-use async_lsp::lsp_types::{Position, Range, TextEdit};
+use async_lsp::lsp_types::{Location, Position, Range, TextEdit};
 use tree_sitter::Node;
 
 use crate::{nodekind::NodeKind, utils::ts_to_lsp_position};
@@ -21,28 +21,52 @@ impl ParsedTree {
             })
     }
 
-    fn rename_within(
+    fn nodes_within<'a>(
         &self,
-        n: Node<'_>,
+        n: Node<'a>,
         identifier: &str,
-        new_identifier: &str,
         content: impl AsRef<[u8]>,
-    ) -> Option<Vec<TextEdit>> {
+    ) -> Option<Vec<Node<'a>>> {
         n.parent().map(|p| {
             self.filter_nodes_from(p, NodeKind::is_field_name)
                 .into_iter()
                 .filter(|i| i.utf8_text(content.as_ref()).expect("utf-8 parse error") == identifier)
-                .map(|i| TextEdit {
-                    range: Range {
-                        start: ts_to_lsp_position(&i.start_position()),
-                        end: ts_to_lsp_position(&i.end_position()),
-                    },
-                    new_text: new_identifier.to_string(),
-                })
                 .collect()
         })
     }
 
+    pub fn reference_tree(
+        &self,
+        pos: &Position,
+        content: impl AsRef<[u8]>,
+    ) -> Option<(Vec<Location>, String)> {
+        let rename_range = self.can_rename(pos)?;
+
+        let mut res = vec![Location {
+            uri: self.uri.clone(),
+            range: rename_range,
+        }];
+
+        let nodes = self.get_ancestor_nodes_at_position(pos);
+        let mut i = 1;
+        let mut otext = nodes.first()?.utf8_text(content.as_ref()).ok()?.to_owned();
+        while nodes.len() > i {
+            let id = nodes[i].utf8_text(content.as_ref()).ok()?;
+            if let Some(inodes) = self.nodes_within(nodes[i], &otext, content.as_ref()) {
+                res.extend(inodes.into_iter().map(|n| Location {
+                    uri: self.uri.clone(),
+                    range: Range {
+                        start: ts_to_lsp_position(&n.start_position()),
+                        end: ts_to_lsp_position(&n.end_position()),
+                    },
+                }))
+            }
+            otext = format!("{id}.{otext}");
+            i += 1
+        }
+        Some((res, otext))
+    }
+
     pub fn rename_tree(
         &self,
         pos: &Position,
@@ -65,8 +89,14 @@ impl ParsedTree {
         while nodes.len() > i {
             let id = nodes[i].utf8_text(content.as_ref()).ok()?;
 
-            if let Some(edit) = self.rename_within(nodes[i], &otext, &ntext, content.as_ref()) {
-                v.extend(edit);
+            if let Some(inodes) = self.nodes_within(nodes[i], &otext, content.as_ref()) {
+                v.extend(inodes.into_iter().map(|n| TextEdit {
+                    range: Range {
+                        start: ts_to_lsp_position(&n.start_position()),
+                        end: ts_to_lsp_position(&n.end_position()),
+                    },
+                    new_text: ntext.to_owned(),
+                }));
             }
 
             otext = format!("{id}.{otext}");
@@ -87,9 +117,9 @@ impl ParsedTree {
         self.filter_nodes(NodeKind::is_field_name)
             .into_iter()
             .filter(|n| {
-                n.utf8_text(content.as_ref())
-                    .expect("utf-8 parse error")
-                    .starts_with(old_identifier)
+                let ntext = n.utf8_text(content.as_ref()).expect("utf-8 parse error");
+                let sc = format!("{old_identifier}.");
+                return ntext == old_identifier || ntext.starts_with(&sc);
             })
             .map(|n| {
                 let text = n.utf8_text(content.as_ref()).expect("utf-8 parse error");
@@ -103,6 +133,20 @@ impl ParsedTree {
             })
             .collect()
     }
+
+    pub fn reference_field(&self, id: &str, content: impl AsRef<[u8]>) -> Vec<Location> {
+        self.filter_nodes(NodeKind::is_field_name)
+            .into_iter()
+            .filter(|n| n.utf8_text(content.as_ref()).expect("utf-8 parse error") == id)
+            .map(|n| Location {
+                uri: self.uri.clone(),
+                range: Range {
+                    start: ts_to_lsp_position(&n.start_position()),
+                    end: ts_to_lsp_position(&n.end_position()),
+                },
+            })
+            .collect()
+    }
 }
 
 #[cfg(test)]
@@ -148,6 +192,42 @@ mod test {
         assert_yaml_snapshot!(rename_fn("xyx", &pos_non_rename));
     }
 
+    #[test]
+    fn test_reference() {
+        let uri: Url = "file://foo/bar.proto".parse().unwrap();
+        let pos_book = Position {
+            line: 5,
+            character: 9,
+        };
+        let pos_author = Position {
+            line: 11,
+            character: 14,
+        };
+        let pos_non_ref = Position {
+            line: 21,
+            character: 5,
+        };
+        let contents = include_str!("input/test_reference.proto");
+
+        let parsed = ProtoParser::new().parse(uri.clone(), contents);
+        assert!(parsed.is_some());
+        let tree = parsed.unwrap();
+
+        let reference_fn = |pos: &Position| {
+            if let Some(k) = tree.reference_tree(pos, contents) {
+                let mut v = tree.reference_field(&k.1, contents);
+                v.extend(k.0);
+                v
+            } else {
+                vec![]
+            }
+        };
+
+        assert_yaml_snapshot!(reference_fn(&pos_book));
+        assert_yaml_snapshot!(reference_fn(&pos_author));
+        assert_yaml_snapshot!(reference_fn(&pos_non_ref));
+    }
+
     #[test]
     fn test_can_rename() {
         let uri: Url = "file://foo/bar/test.proto".parse().unwrap();

src/parser/rename.rs

@@ -0,0 +1,36 @@
+---
+source: src/parser/rename.rs
+expression: reference_fn(&pos_author)
+---
+- uri: "file://foo/bar.proto"
+  range:
+    start:
+      line: 23
+      character: 2
+    end:
+      line: 23
+      character: 13
+- uri: "file://foo/bar.proto"
+  range:
+    start:
+      line: 29
+      character: 32
+    end:
+      line: 29
+      character: 43
+- uri: "file://foo/bar.proto"
+  range:
+    start:
+      line: 11
+      character: 10
+    end:
+      line: 11
+      character: 16
+- uri: "file://foo/bar.proto"
+  range:
+    start:
+      line: 15
+      character: 2
+    end:
+      line: 15
+      character: 8

src/parser/snapshots/protols__parser__rename__test__reference-2.snap

@@ -0,0 +1,5 @@
+---
+source: src/parser/rename.rs
+expression: reference_fn(&pos_non_ref)
+---
+[]