Allow for broadcast methods to accept a renderable #364
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
|
I am currently using the workaround of message.broadcast_update_to(:messages, target: "message-count",
renderable: MessagesCountComponent.new(count: Message.count)
layout: false
)I added a PR to improve docs for |
|
Needs a rebase. Happy to see this changed. |
Rails supports [rendering of objects](https://edgeguides.rubyonrails.org/layouts_and_rendering.html#rendering-objects) such as [ViewComponents](https://github.com/github/view_component), but this support doesn't seem to be available in Turbo. This is just a stake in the sand for exploring the option to render a `renderable` in addition to `html` and `partial`. This should allow for the following API call: ```ruby message.broadcast_update_to(:messages, target: "message-count", renderable: MessagesCountComponent.new(count: Message.count)) ``` where `MessagesCountComponent` is a supported Rails rendering object such as a ViewComponent. It turns out that Rails does accept a long form argument for rendering objects: `renderable`. The only gotcha is that it [renders the layout by default](rails/rails#39869), causing the layout to be duplicated. This change explicitly prevents the layout from being rendered in the call to `ApplicationController.render` to prevent that duplication from happening.
jklina
force-pushed
the
add-support-for-renderable-rendering
branch
from
24de801
to
432b915
Compare
|
Should be caught up, thanks! |
dhh
reviewed
Jun 20, 2023
| @@ -83,6 +83,6 @@ def broadcast_stream_to(*streamables, content:) | |||
|
|
|||
| private | |||
| def render_format(format, **rendering) | |||
| ApplicationController.render(formats: [ format ], **rendering) | |||
| ApplicationController.render(layout: false, formats: [ format ], **rendering) | |||
There was a problem hiding this comment.
Why is this needed if we also set o[:layout] = false in broadcastable#368?
There was a problem hiding this comment.
Good call. It doesn't seem like its needed so I nixed it:
This isn't necessary since its set within: app/models/concerns/turbo/broadcastable.rb
|
Might be my setup but this fails when used with the order.broadcast_update_later(
target: "order_items",
renderable: FrontEnd::OrderItemsComponent.new(order:)
)
[ActiveJob] Failed enqueuing Turbo::Streams::ActionBroadcastJob to Sidekiq(default): ActiveJob::SerializationError (Unsupported argument type: FrontEnd::OrderItemsComponent)I'm using Phlex and ActiveJob with Sidekiq and We might need a follow-up PR to render the renderable before enqueueing it so that only a string is serialized? I can take a look later. |
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.
Rails supports rendering of objects such as ViewComponents, but this support doesn't seem to be available in Turbo. This is just a stake in the sand for exploring the option to render a
renderablein addition tohtmlandpartial.This should allow for the following API call:
where
MessagesCountComponentis a supported Rails rendering object such as a ViewComponent.It turns out that Rails does accept a long form argument for rendering objects:
renderable. The only gotcha is that it renders the layout by default, causing the layout to be duplicated. This change explicitly prevents the layout from being rendered in the call toApplicationController.renderto prevent that duplication from happening.This is a follow up to: #358