Disable ruby-lsp-rspec's definition listener outside test files

[MaicolBen]

Here is what happens when I add the addon

[MaicolBen]

This breaks tests that use tempfiles, do you know how can I make tempfiles use spec.rb files? Or do you know any other way to check it's an rspec. I have seen used node.receiver && node.receiver&.slice != "RSpec" but it doesn't work always.

[st0012]

I roughly understand the issue but it can not be caused by the listener you're trying to patch because it only returns definitions that are also from the same file (condition).
This means the duplicated definition you see is returned by ruby-lsp's own definition listener. And since it only happens when you install ruby-lsp-rspec, I guess it's because you have a let(:sync_with_intercom) or subject(:sync_with_intercom) in your spec files?

[MaicolBen]

Thank you for replying so quickly!

I roughly understand the issue but it can not be caused by the listener you're trying to patch because it only returns definitions that are also from the same file (condition).

Yes, so both core and LSP rspec return definitions

I guess it's because you have a let(:sync_with_intercom) or subject(:sync_with_intercom) in your spec files?

That doesn't exist at all, this happens with every definition of every file (not if the definition is in another file). Also, how can you explain that if I remove my new check, the test returns 2 definitions instead of 1?

I'm curious about your setup, since I cannot get working this addon without including in the gemfile.

[st0012]

It took me a while to find a reproduceable case in my projects but I can confirm that it is the listener's fault 👍
But I think we can simply not initializing this listener in non-spec files. So the solution would be more like this:

diff --git a/lib/ruby_lsp/ruby_lsp_rspec/addon.rb b/lib/ruby_lsp/ruby_lsp_rspec/addon.rb
index 98d13ff..3cde027 100644
--- a/lib/ruby_lsp/ruby_lsp_rspec/addon.rb
+++ b/lib/ruby_lsp/ruby_lsp_rspec/addon.rb
@@ -64,6 +64,8 @@ module RubyLsp
         ).void
       end
       def create_definition_listener(response_builder, uri, node_context, dispatcher)
+        return unless uri.to_standardized_path&.end_with?("_test.rb") || uri.to_standardized_path&.end_with?("_spec.rb")
+
         Definition.new(response_builder, uri, node_context, T.must(@index), dispatcher)
       end

[MaicolBen]

Nice! Thank you, it's because I don't know much how the LSP addon system works. This solution has the same issue with specs than mine, any ideas?

[st0012]

On my side the test failed without the change and passed when the above diff is applied. Can you first push the lib code and we can see what's failing on CI?

[st0012]

Ah ok I get what you mean now. It's other tests that are failing.

You can do this to create tempfiles that end with specific postfix: Tempfile.new(["", "_fake_spec.rb"])

[MaicolBen]

Nice! Thank you!

[st0012]

Thank you so much for reporting the issue and the PR 😄

[st0012]

I've cut a release for this: https://github.com/st0012/ruby-lsp-rspec/releases/tag/v0.1.17

[MaicolBen]

That was really fast, thank to you for the help!