fix: Emit reference relationships for constant aliases - #225
Merged
Merged
Conversation
varungandhi-src
added a commit
that referenced
this pull request
Oct 28, 2024
When you have "constant aliases" of the form: module A X = 10 end module B Y = X end It would be nice to merge code navigation results for X and Y so that when you do Find references across either of them, you see all references for either X or Y. Part of the logic for this lives in the Sourcegraph backend, and that needs some fixes in terms of building an extra inverted index etc. So with this patch, current versions of Sourcegraph (as of Oct 28 2024) will show merged references when doing Find references on Y (but not X). However, this fixes the indexer side of the logic by emitting Relationships with `is_reference` set, so that the backend can utilize it.
This file contains hidden or 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
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.
Fixes GRAPH-979.
When you have "constant aliases" of the form:
It would be nice to merge code navigation results for X and Y so
that when you do Find references across either of them, you see
all references for either X or Y.
Part of the logic for this lives in the Sourcegraph backend,
and that needs some fixes in terms of building an extra
inverted index etc. So with this patch, current versions of
Sourcegraph (as of Oct 28 2024) will show merged
references when doing Find references on Y (but not X).
However, this fixes the indexer side of the logic by emitting
Relationships with
is_referenceset, so that the backendcan utilize it.
When testing against the shopify-api-ruby repo, I get the following
additional relationships.
{ "symbol": "scip-ruby gem shopify_api 14.6.0 ShopifyAPI#LATEST_SUPPORTED_ADMIN_VERSION.", "documentation": [ "```ruby\nLATEST_SUPPORTED_ADMIN_VERSION (String)\n```" ], "relationships": [ { "symbol": "scip-ruby gem shopify_api 14.6.0 ShopifyAPI#AdminVersions#LATEST_SUPPORTED_ADMIN_VERSION.", "isReference": true } ] }, { "symbol": "scip-ruby gem shopify_api 14.6.0 ShopifyAPI#SUPPORTED_ADMIN_VERSIONS.", "documentation": [ "```ruby\nSUPPORTED_ADMIN_VERSIONS (T::Array[String])\n```" ], "relationships": [ { "symbol": "scip-ruby gem shopify_api 14.6.0 ShopifyAPI#AdminVersions#SUPPORTED_ADMIN_VERSIONS.", "isReference": true } ] }Test plan
See included automated tests.