Add GotoRelevantFile functionality #2985

jenny-codes · 2024-12-13T19:47:42Z

Motivation

A stab at #2966. We can now click the "Goto Test" and "Goto Source" from the commands menu and from the explorer view.

Instruction here for those that want to use in in neovim

In the LspAttach event callback, add the following

    vim.api.nvim_create_autocmd('LspAttach', {
      callback = function(event)
        local client = vim.lsp.get_client_by_id(event.data.client_id)

        -- Check that the current server has the goto_relevant_file capability
        if client and client.server_capabilities.experimental and client.server_capabilities.experimental['goto_relevant_file'] then
          local goto_relevant_file = function()
            local params = vim.lsp.util.make_position_params()
            -- Make the goto_relevant_file request to the lsp server 
            client.request('experimental/gotoRelevantFile', params, function(err, result)
              if err then
                vim.notify('Error in GotoRelevantFile: ' .. err.message, vim.log.levels.ERROR)
                return
              end

              if not result or vim.tbl_isempty(result) or #result.locations == 0 then
                vim.notify('No relevant file found', vim.log.levels.INFO)
                return
              end

              -- Goto the file location if only one location is returned
              if #result.locations == 1 then
                vim.cmd('edit ' .. result.locations[1])
                return
              end

              -- If more than one locations are returned, open a selection menu 
              -- If not using fzf, change to telescope or vim.ui.select  
              require('fzf-lua').files {
                cwd = vim.fn.getcwd(),
                cmd = "echo '" .. table.concat(result.locations, '\n') .. "'",
              }
            end)
          end
        end
      end,
    })

and then you can bind goto_relevant_file() to a keymap

Implementation

Implementing it as a custom request for now until vscode starts supporting it officially.

I've studied a few different implementations and after some internet browsing decided to use the Jacaard similarity here to find the most likely path to the desired filename.

Some future opportunities–

Right now only the locations with the highest similarity score are returned, but we can perhaps adjust it so we return all the results that has passed a certain threshold (with this particular algorithm the coefficient is between 0 and 1, with 1 meaning the two paths are identical)
Right now the only relevant file that we try to find is test file <> source file, but in the future we can perhaps extend it so it returns other kinds of relevant files as well.

Automated Tests

Included

Manual Tests

goto-relevant-file-demo.mp4

vscode/package.json

lib/ruby_lsp/internal.rb

lib/ruby_lsp/requests/goto_relevant_file.rb

lib/ruby_lsp/server.rb

st0012 · 2025-02-07T15:54:04Z

lib/ruby_lsp/requests/goto_relevant_file.rb

+        super()
+
+        @workspace_path = T.let(Dir.pwd, String)
+        @path = T.let(path.delete_prefix(@workspace_path), String)


@vinistock I think it may be convenient to have a URI#to_workspace_relative_path that matches VS Code's Copy Relative Path value. WDYT?

lib/ruby_lsp/requests/goto_relevant_file.rb

st0012 · 2025-02-07T16:57:20Z

Sorry for the delay in reviewing. Can you rebase this against the main branch?

jenny-codes · 2025-02-07T17:32:29Z

@st0012 @andyw8 thanks for the feedback!
@st0012 yes of course I will rebase. No need to apologize–I have not marked it as ready for review (still writing some tests)

Define and implement the experimental/gotoRelevantFile lsp method. This request takes in a textDcoument param, and retusn an array of locations that are related to the input file path. Currently, the related file paths are - test files, if the input file is a source file - source files, if the input file is a test file Basically it goes between source file <> test file. This is implemented as a experimental method until something more official comes along.

andyw8 · 2025-02-19T16:27:08Z

test/requests/goto_relevant_file_test.rb

+
+class GotoRelevantFileTest < Minitest::Test
+  def setup
+    Dir.stubs(:pwd).returns("/workspace")


I'm a little wary of stubbing pwd since if some test helper, or minitest itself, uses it then it may break.

Can you expand on that?

andyw8 · 2025-02-19T16:57:52Z

I tried tophatting on code-db for the file shopify_slack_bot/client.rb and it didn't seem to be working.

andyw8 · 2025-02-19T17:09:08Z

For the CI spelling failures, you can add those terms to project-words.

lib/ruby_lsp/requests/goto_relevant_file.rb

jenny-codes · 2025-02-19T17:28:02Z

I tried tophatting on code-db for the file shopify_slack_bot/client.rb and it didn't seem to be working.

@andyw8 can you share your tophatting steps? I tried it on both vscode and nvim and both work as expected. For what's worth I've also been using it on shopify/shopify for a while now and have not encountered issues.

andyw8 · 2025-02-19T18:46:36Z

@andyw8 can you share your tophatting steps? I tried it on both vscode and nvim and both work as expected. For what's worth I've also been using it on shopify/shopify for a while now and has not encountered issues.

Just tried again and it's working, I must have missed something before.

st0012 · 2025-02-19T19:37:06Z

lib/ruby_lsp/requests/goto_relevant_file.rb

+
+        test_prefix_pattern = /^(#{TEST_KEYWORDS.join("_|")}_)/
+        test_suffix_pattern = /(_#{TEST_KEYWORDS.join("|_")})$/
+        test_pattern = /#{test_prefix_pattern}|#{test_suffix_pattern}/


Maybe we can store these patterns in constants too? Do we need to recompute them for each request?

st0012 · 2025-02-19T19:37:15Z

lib/ruby_lsp/requests/goto_relevant_file.rb

+            input_basename.gsub(test_pattern, "")
+          else
+            test_prefix_glob = "#{TEST_KEYWORDS.join("_,")}_"
+            test_suffix_glob = "_#{TEST_KEYWORDS.join(",_")}"


Same as the above.

st0012 · 2025-02-19T19:38:17Z

lib/ruby_lsp/requests/goto_relevant_file.rb

+      end
+
+      sig { params(path: String, candidates: T::Array[String]).returns(T::Array[String]) }
+      def find_most_similar_with_jacaard(path, candidates)


I'd appreciate a comment explaining what jacaard means 😂

st0012 · 2025-02-19T19:41:52Z

lib/ruby_lsp/requests/goto_relevant_file.rb

+
+      sig { returns(T::Array[String]) }
+      def find_relevant_paths
+        workspace_path = Dir.pwd


Let's take in GlobalState and use its workspace_path method to get this value. I think Requests::Rename is a good reference.

st0012 · 2025-02-19T19:42:42Z

lib/ruby_lsp/requests/goto_relevant_file.rb

+      def initialize(path)
+        super()
+
+        @workspace_path = T.let(Dir.pwd, String)


Let's use GlobalState#workspace_path instead.

st0012 · 2025-02-19T19:43:20Z

lib/ruby_lsp/requests/goto_relevant_file.rb

+      sig { returns(T::Array[String]) }
+      def find_relevant_paths
+        workspace_path = Dir.pwd
+        relative_path = @path.delete_prefix(workspace_path)


Isn't @path already the value without workspace path prefix?

jenny-codes self-assigned this Dec 13, 2024

jenny-codes force-pushed the goto-test branch 5 times, most recently from ce2a926 to fb30abd Compare January 27, 2025 23:45

jenny-codes added the enhancement New feature or request label Jan 27, 2025

jenny-codes changed the title ~~Add GotoTest and GotoSource functionality~~ Add GotoRelevantFile functionality Jan 27, 2025

andyw8 reviewed Feb 7, 2025

View reviewed changes

vscode/package.json Outdated Show resolved Hide resolved

vscode/package.json Outdated Show resolved Hide resolved

lib/ruby_lsp/internal.rb Outdated Show resolved Hide resolved

andyw8 reviewed Feb 7, 2025

View reviewed changes

lib/ruby_lsp/requests/goto_relevant_file.rb Outdated Show resolved Hide resolved

andyw8 reviewed Feb 7, 2025

View reviewed changes

lib/ruby_lsp/requests/goto_relevant_file.rb Outdated Show resolved Hide resolved

st0012 reviewed Feb 7, 2025

View reviewed changes

jenny-codes force-pushed the goto-test branch from fb30abd to 9b39633 Compare February 19, 2025 03:42

jenny-codes marked this pull request as ready for review February 19, 2025 03:48

jenny-codes requested a review from a team as a code owner February 19, 2025 03:48

jenny-codes requested review from andyw8 and st0012 February 19, 2025 03:48

jenny-codes force-pushed the goto-test branch from 9b39633 to 02e94b1 Compare February 19, 2025 03:55

Add vscode support for gotoRelevantFile

e23d525

jenny-codes force-pushed the goto-test branch from 02e94b1 to e23d525 Compare February 19, 2025 04:20

andyw8 reviewed Feb 19, 2025

View reviewed changes

lib/ruby_lsp/requests/goto_relevant_file.rb Outdated Show resolved Hide resolved

jenny-codes added vscode This pull request should be included in the VS Code extension's release notes server This pull request should be included in the server gem's release notes labels Feb 19, 2025

fixup! Add experimental/gotoRelevantFile lsp method

359baea

st0012 reviewed Feb 19, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add GotoRelevantFile functionality #2985

Add GotoRelevantFile functionality #2985

jenny-codes commented Dec 13, 2024 •

edited

Loading

st0012 Feb 7, 2025

st0012 commented Feb 7, 2025

jenny-codes commented Feb 7, 2025

andyw8 Feb 19, 2025 •

edited

Loading

jenny-codes Feb 19, 2025

andyw8 commented Feb 19, 2025

andyw8 commented Feb 19, 2025

jenny-codes commented Feb 19, 2025 •

edited

Loading

andyw8 commented Feb 19, 2025

st0012 Feb 19, 2025

st0012 Feb 19, 2025

st0012 Feb 19, 2025

st0012 Feb 19, 2025

st0012 Feb 19, 2025

st0012 Feb 19, 2025

Add GotoRelevantFile functionality #2985

Are you sure you want to change the base?

Add GotoRelevantFile functionality #2985

Conversation

jenny-codes commented Dec 13, 2024 • edited Loading

Motivation

Implementation

Automated Tests

Manual Tests

Choose a reason for hiding this comment

st0012 commented Feb 7, 2025

jenny-codes commented Feb 7, 2025

andyw8 Feb 19, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

andyw8 commented Feb 19, 2025

andyw8 commented Feb 19, 2025

jenny-codes commented Feb 19, 2025 • edited Loading

andyw8 commented Feb 19, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jenny-codes commented Dec 13, 2024 •

edited

Loading

andyw8 Feb 19, 2025 •

edited

Loading

jenny-codes commented Feb 19, 2025 •

edited

Loading