RubyLsp::Requests::Request breaks the Ruby LSP extension on shopify-build

[zarifmahfuz]

Ruby version

3.1.2

Code snippet

No response

Description

I am seeing the following error when using Ruby LSP on https://github.com/Shopify/shopify-build:

Formatting error: undefined method `anything' for T:Module sig { abstract.returns(T.anything) } ^^^^^^^^^

I am guessing this is coming from the recently added RubyLsp::Requests::Request which is using T.anything:

ruby-lsp/lib/ruby_lsp/requests/request.rb

Line 13 in 4f1012e

sig { abstract.returns(T.anything) }

I think the reason we're seeing this is due to the fact that we're on a version of Sorbet (0.5.10326) that does not have the T.anything type. We use vendored gems on shopify-build and update gems once a year. T.anything was added to Sorbet in April, 2023: sorbet/sorbet@67c657a so we haven't updated our Sorbet to a version after that one yet.

Should this type make extension error out?

Expected output

T.anything should not cause Ruby LSP to fail

[st0012]

@zarifmahfuz Thank you for reporting this! I've opened #1302 to bump the sorbet-runtime requirement to avoid the error. After it's merged and released, bundler should pick ruby-lsp v0.13.2 for your project. So while you'd miss out a few bug fixes and enhancements, you can still use it.

Unfortunately, bundler would still pick 0.13.3 as it still has a looser requirement on sorbet-runtime. The way to workaround this is to add gem "ruby-lsp", "0.13.2" to the project's Gemfile.

That said, I strongly recommend upgrading the project's Sorbet a bit more frequently to get the most out of it and also reduce the upgrade cost. If you encountered any issue while upgrading it, please feel free to reach out in the #help-ruby-and-rails-infra channel on Slack :-)

[zarifmahfuz]

Thanks for fixing!

[zarifmahfuz]

@st0012 Since you've updated your comment after the issue was closed, is there any timeline on when this will be fixed? Or do we have to just use the workaround?

[st0012]

IMO, the proper fix is to upgrade Sorbet as the version your currently on is really old. But if your team doesn't have the bandwidth at the moment, pinning ruby-lsp version in the Gemfile is the way to go until that could happen.