Fix double registration of :turbo_stream Renderer #562
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
This is more reflective of real world applications and allows us to more easily simulate how the presence of certains Gems/Frameworks affect behavior.
When an application loads both `ActionController::Base` and `ActionController::API`, the `:action_controller` load hook gets called twice (once for each of them). Since the `:turbo_stream` Renderer is registered in this load hook, it ends up getting registered twice and prints a warning for method redefinition. To demonstrate the warning in the `turbo-rails` tests, an `Api::ApplicationController` was added to the dummy app so that both base controller classes get loaded: ``` $ CI=true bundle exec rake test /home/hartley/.cache/asdf/installs/ruby/3.3.0/lib/ruby/gems/3.3.0/gems/actionpack-7.1.3/lib/action_controller/metal/renderers.rb:75: warning: method redefined; discarding old _render_with_renderer_turbo_stream /home/hartley/src/github.com/skipkayhil/turbo-rails/lib/turbo/engine.rb:67: warning: previous definition of _render_with_renderer_turbo_stream was here ``` This commit fixes the issue by not using the `:action_controller` load hook to register the `:turbo_stream` Renderer. Adding a Renderer should not require a lazy load hook because `ActionController::Renderers` does not load any other classes.
seanpdoyle
approved these changes
Jan 23, 2024
seanpdoyle
reviewed
Jan 23, 2024
There was a problem hiding this comment.
Is the removal of the Mailboxes related to engine changes?
There was a problem hiding this comment.
It was to enable eager_load since neither the Action Mailbox nor the Action Mailer railties are required in config/application.rb. I think eager_load has merits on its own, but it also makes it easier to demonstrate the issue in this PR because we don't have to use the Api::ApplicationController in a test.
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.
When an application loads both
ActionController::BaseandActionController::API, the:action_controllerload hook gets calledtwice (once for each of them). Since the
:turbo_streamRenderer isregistered in this load hook, it ends up getting registered twice and
prints a warning for method redefinition.
To demonstrate the warning in the
turbo-railstests, anApi::ApplicationControllerwas added to the dummy app so that bothbase controller classes get loaded:
This commit fixes the issue by not using the
:action_controllerloadhook to register the
:turbo_streamRenderer. Adding a Renderer shouldnot require a lazy load hook because
ActionController::Renderersdoesnot load any other classes.