Switch to storing URIs in entries instead of file paths #2341
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
vinistock
added
enhancement
vinistock
force-pushed
the
vs/use_uris_in_entries
branch
from
9391c9e
to
0d47a2d
Compare
vinistock
force-pushed
the
vs/use_uris_in_entries
branch
from
0d47a2d
to
ce52fcd
Compare
st0012
approved these changes
Jul 23, 2024
|
🤔 Will this have any impact on addons? |
andyw8
reviewed
Jul 23, 2024
| @@ -2,6 +2,8 @@ | |||
| # frozen_string_literal: true | |||
|
|
|||
| module RubyIndexer | |||
| # Represents a file system path that can be indexed. This class should only be used for files in the file system and | |||
| # not for other URIs that may be indexed, such as unsaved file URIs using the `untitled` scheme | |||
There was a problem hiding this comment.
Can we not enforce this by using URI::File instead of URI::Generic?
andyw8
reviewed
Jul 23, 2024
| # } | ||
| @files_to_entries = T.let({}, T::Hash[String, T::Array[Entry]]) | ||
| @uris_to_entries = T.let({}, T::Hash[String, T::Array[Entry]]) |
There was a problem hiding this comment.
Should we change this to use the URI as the key?
andyw8
approved these changes
Jul 23, 2024
|
This pull request is being marked as stale because there was no activity in the last 2 months |
|
Closing this for now. We need to re-think the approach. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
First step towards #2340 and #1908
Currently, we save the file paths for entries in the index. This decision is incompatible with how language servers work, because you can have files that exist in different URI schemes (such as the one for unsaved files like
untitled:Untitled-1).In general, we should always strive to use URIs everywhere and only get the file paths when we want to return something or when we're reading from disk.
This PR changes our entries to store the URIs where they were declared, rather than tying ourselves with file paths. This change is necessary in order to fix #1908, because if we index files before they are saved, there's no file path associated to the declarations being made in the unsaved file.
Implementation
The change is essentially switching from
file_pathto URI pretty much everywhere.As an added benefit, we now no longer need to build the URI when serving features, because that's already available directly in the entries - which is another indication that standardizing on URIs is likely the best choice.
Automated Tests
Adapted existing tests.