Hack fix for Sorbet hidden definitions update failing on Ruby 3 #16281
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
apainintheneck
approved these changes
Dec 3, 2023
There was a problem hiding this comment.
LGTM! Should the move to use Tapioca be added as a follow-up to the Ruby 3 epic or would it make more sense to create a new issue for that?
It looks like I misunderstood. The issue was more Tapioca dropping support for Ruby 2.6 so that should be solved automatically by the Ruby 3.x upgrade. Maybe an issue for phasing out hidden-definitions would make sense though.
Yeah it's something I need to see first what the steps required are. Quite a bit has changed in Tapioca in the past while so I need to catch up. Updating all gems will happen towards the end of the Ruby 3 process, which will include Tapioca. |
MikeMcQuaid
reviewed
Dec 4, 2023
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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 error seen in #16279.
The hidden definition finder goes through requires all of Homebrew's code and its dependencies. This includes section of the code that autoloads rdoc (via yard). When the hidden definition finder goes through all defined constants to see what it doesn't know about, it hits the autoload on
RDoc::Servletwhich unfortunately causes it to abort the process entirely asrdoc/servletusesabortrather than letting standard LoadError happen: https://github.com/ruby/ruby/blob/v3_1_4/lib/rdoc/servlet.rb#L10. We workaround this by providing a stubbedwebrick.We will probably eventually phase out
hidden-definitionsbut that won't be done until well after the Ruby 3 migration is complete - we'll want an updated Tapioca etc first.