Fix HelperMethods definitions #1611
Merged
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
Helpers methods are generated for abstract controllers, and then are inherted by children, so we should be gathering them. In the added test the generated RBI for UserController references ::ApplicationController::HelperMethods.
Since Rails 6.1, when a controller has identical helpers to its superclass Rails will not generate a new HelperMethods modules (which saves significant memory). We should do the same to avoid declaring modules which don't actually exist in reality, this also avoids a lot of unnecesary generated RBI files which use helper/helper_methods appropriately sparingly.
|
I have signed the CLA! |
paracycle
approved these changes
Aug 17, 2023
KaanOzkan
approved these changes
Aug 17, 2023
There was a problem hiding this comment.
Lgtm. Did a quick test on our monolith with @bitwise-aiden.
Co-authored-by: Ufuk Kayserilioglu <[email protected]>
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.
This fixes two problems with the ActionControllerHelpers compiler:
First is that this previously didn't gather abstract controllers. This broke for us because we have an abstract ApplicationController, and subclasses of that (all of our controllers) may then generate
include ApplicationController::HelperMethodswhich sorbet then can't find. This PR re-includes abstract controllers, I don't see any reason not to include them, but maybe I've missed something.Second this avoids generating
HelperMethodsfor controllers which are only inheriting. Since Rails 6.1, when a controller has identical helpers to its superclass Rails will not generate a new HelperMethods module. We should do the same to avoid defining modules which do not actually exist, both because it's incorrect (pretty mildly incorrect, it pretends a constant exists where one doesn't, but the same constant with the same values exists in the superclass) but also it generates a lot of unnecessary files (which I think is the same motivation as #1299).I'm new to tapioca/sorbet so please let me know if I've missed something 😅.