Skip to content

Commit

Permalink
fix: Correctly emit refs for entities in the Opus namespace (#223)
Browse files Browse the repository at this point in the history 
Fixes https://linear.app/sourcegraph/issue/GRAPH-857

### Motivation

I think I added a workaround here originally as it wasn't super clear
if the extra entities for `encrypted_prop:` would be useful.

But the problem is that the workaround would stop code nav for
other things inside the Opus namespace in other contexts.

Let's fix the immediate issue for now, I've filed a follow-up issue
for synthetic references from rewrites here.

https://linear.app/sourcegraph/issue/GRAPH-928
  • Loading branch information
@varungandhi-src
varungandhi-src authored Oct 1, 2024
1 parent 189e47e commit 0070514
Show file tree
Hide file tree
Showing 4 changed files with 93 additions and 6 deletions.
9 changes: 3 additions & 6 deletions scip_indexer/SCIPSymbolRef.cc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@

#include "common/FileSystem.h"
#include "common/sort/sort.h"
#include "core/source_generator/source_generator.h"
#include "core/Loc.h"
#include "core/source_generator/source_generator.h"
#include "main/lsp/LSPLoop.h"

#include "scip_indexer/Debug.h"
Expand Down Expand Up @@ -184,10 +184,6 @@ bool GenericSymbolRef::isSorbetInternal(const core::GlobalState &gs, core::Symbo
if (klass == core::Symbols::Sorbet_Private() || klass == core::Symbols::T() || klass == classT) {
return true;
}
auto name = klass.data(gs)->name;
if (name == core::Names::Constants::Opus()) {
return true;
}
}
visited.insert(sym);
sym = sym.owner(gs);
Expand Down Expand Up @@ -228,7 +224,8 @@ void GenericSymbolRef::saveDocStrings(const core::GlobalState &gs, core::TypePtr
auto ref = this->selfOrOwner.asMethodRef();
auto recvType = ref.data(gs)->owner.data(gs)->resultType;
checkType(recvType, fmt::format("receiver type for {}", ref.showFullName(gs)));
markdown = core::source_generator::prettyTypeForMethod(gs, ref, recvType, nullptr, nullptr, core::ShowOptions());
markdown =
core::source_generator::prettyTypeForMethod(gs, ref, recvType, nullptr, nullptr, core::ShowOptions());
// FIXME(varun): For some reason, it looks like a bunch of public methods
// get marked as private here. Avoid printing misleading info until we fix that.
// https://github.com/sourcegraph/scip-ruby/issues/33
Expand Down
12 changes: 12 additions & 0 deletions test/scip/testdata/encrypted_prop.snapshot.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,23 @@ def self.encrypted_prop(opts={}); end
# ^^^^^^^^^^^^^^ definition [..] `<Class:EncryptedProp>`#encrypted_prop().
encrypted_prop :foo
# ^^^^^^^^^^^^^^^^^^^ reference [..] String#
# ^^^^^^^^^^^^^^^^^^^ reference [..] Opus#DB#
# ^^^^^^^^^^^^^^^^^^^ reference [..] Opus#DB#Model#
# ^^^^^^^^^^^^^^^^^^^ reference [..] Opus#DB#Model#Mixins#
# ^^^^^^^^^^^^^^^^^^^ reference [..] Opus#DB#Model#Mixins#Encryptable#
# ^^^^^^^^^^^^^^^^^^^ reference [..] Opus#DB#Model#Mixins#Encryptable#EncryptedValue#
# ^^^^^^^^^^^^^^^^^^^ reference [..] Opus#
# ^^^ definition [..] EncryptedProp#`encrypted_foo=`().
# ^^^ definition [..] EncryptedProp#`foo=`().
# ^^^ definition [..] EncryptedProp#encrypted_foo().
# ^^^ definition [..] EncryptedProp#foo().
encrypted_prop :bar, migrating: true, immutable: true
# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] Opus#DB#Model#Mixins#Encryptable#
# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] Opus#DB#
# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] Opus#DB#Model#
# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] Opus#DB#Model#Mixins#
# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] Opus#
# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] Opus#DB#Model#Mixins#Encryptable#EncryptedValue#
# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ reference [..] String#
# ^^^ definition [..] EncryptedProp#bar().
# ^^^ definition [..] EncryptedProp#encrypted_bar().
Expand Down
17 changes: 17 additions & 0 deletions test/scip/testdata/opus.rb
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# typed: true

class Opus::Base
end

class Opus::Derived < Opus::Base
end

TYPES = T.let({ derived: -> { Opus::Derived } }, T::Hash[Symbol, T.proc.returns(T.class_of(Opus::Base))])

module ABC
TYPES_IN_MODULE = T.let({ derived: -> { Opus::Derived } }, T::Hash[Symbol, T.proc.returns(T.class_of(Opus::Base))])
end

class Other
TYPES_IN_CLASS = T.let({ derived: -> { Opus::Derived } }, T::Hash[Symbol, T.proc.returns(T.class_of(Opus::Base))])
end
61 changes: 61 additions & 0 deletions test/scip/testdata/opus.snapshot.rb
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# typed: true

class Opus::Base
# ^^^^ reference [..] Opus#
# ^^^^ definition [..] Opus#Base#
end

class Opus::Derived < Opus::Base
# ^^^^ reference [..] Opus#
# ^^^^^^^ definition [..] Opus#Derived#
# ^^^^ reference [..] Opus#
# ^^^^ reference [..] Opus#Base#
end

TYPES = T.let({ derived: -> { Opus::Derived } }, T::Hash[Symbol, T.proc.returns(T.class_of(Opus::Base))])
#^^^^^ definition [..] TYPES.
# ^^ reference [..] Kernel#
# ^^ reference [..] Kernel#lambda().
# ^^^^ reference [..] Opus#
# ^^^^^^^ reference [..] Opus#Derived#
# ^ reference [..] T#
# ^^^^ reference [..] T#Hash#
# ^^^^^^ reference [..] Symbol#
# ^ reference [..] T#
# ^^^^ reference [..] `<Class:T>`#proc().
# ^ reference [..] T#
# ^^^^^^^^ reference [..] `<Class:T>`#class_of().
# ^^^^ reference [..] Opus#
# ^^^^ reference [..] Opus#Base#
# ^^^^^^^ definition local 4~#119448696
# ^^^^^^^^ reference [..] TYPES.

module ABC
# ^^^ definition [..] ABC#
TYPES_IN_MODULE = T.let({ derived: -> { Opus::Derived } }, T::Hash[Symbol, T.proc.returns(T.class_of(Opus::Base))])
# ^^^^^^^^^^^^^^^ definition [..] ABC#TYPES_IN_MODULE.
# ^^ reference [..] Kernel#
# ^^ reference [..] Kernel#lambda().
# ^^^^ reference [..] Opus#
# ^^^^^^^ reference [..] Opus#Derived#
# ^^^^^^ reference [..] Symbol#
# ^^^^ reference [..] Opus#
# ^^^^ reference [..] Opus#Base#
# ^^^^^^^ definition local 4~#119448696
# ^^^^^^^^ reference [..] ABC#TYPES_IN_MODULE.
end

class Other
# ^^^^^ definition [..] Other#
TYPES_IN_CLASS = T.let({ derived: -> { Opus::Derived } }, T::Hash[Symbol, T.proc.returns(T.class_of(Opus::Base))])
# ^^^^^^^^^^^^^^ definition [..] Other#TYPES_IN_CLASS.
# ^^ reference [..] Kernel#
# ^^ reference [..] Kernel#lambda().
# ^^^^ reference [..] Opus#
# ^^^^^^^ reference [..] Opus#Derived#
# ^^^^^^ reference [..] Symbol#
# ^^^^ reference [..] Opus#
# ^^^^ reference [..] Opus#Base#
# ^^^^^^^ definition local 4~#119448696
# ^^^^^^^^ reference [..] Other#TYPES_IN_CLASS.
end

0 comments on commit 0070514

Please sign in to comment.