Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Alter Action Cable Element to be morph-compatible #650

Merged
merged 1 commit into from
Sep 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions app/assets/javascripts/turbo.js
Original file line number Diff line number Diff line change
Expand Up @@ -5330,6 +5330,7 @@ function walk(obj) {
}

class TurboCableStreamSourceElement extends HTMLElement {
static observedAttributes=[ "channel", "signed-stream-name" ];
async connectedCallback() {
connectStreamSource(this);
this.subscription = await subscribeTo(this.channel, {
Expand All @@ -5341,6 +5342,13 @@ class TurboCableStreamSourceElement extends HTMLElement {
disconnectedCallback() {
disconnectStreamSource(this);
if (this.subscription) this.subscription.unsubscribe();
this.subscriptionDisconnected();
}
attributeChangedCallback() {
if (this.subscription) {
this.disconnectedCallback();
this.connectedCallback();
}
}
dispatchMessageEvent(data) {
const event = new MessageEvent("message", {
Expand Down
2 changes: 1 addition & 1 deletion app/assets/javascripts/turbo.min.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion app/assets/javascripts/turbo.min.js.map

Large diffs are not rendered by default.

10 changes: 10 additions & 0 deletions app/javascript/turbo/cable_stream_source_element.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ import { subscribeTo } from "./cable"
import snakeize from "./snakeize"

class TurboCableStreamSourceElement extends HTMLElement {
static observedAttributes = ["channel", "signed-stream-name"]

async connectedCallback() {
connectStreamSource(this)
this.subscription = await subscribeTo(this.channel, {
Expand All @@ -15,6 +17,14 @@ class TurboCableStreamSourceElement extends HTMLElement {
disconnectedCallback() {
disconnectStreamSource(this)
if (this.subscription) this.subscription.unsubscribe()
this.subscriptionDisconnected()
}

attributeChangedCallback() {
if (this.subscription) {
this.disconnectedCallback()
this.connectedCallback()
}
}

dispatchMessageEvent(data) {
Expand Down
6 changes: 5 additions & 1 deletion test/dummy/app/controllers/messages_controller.rb
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
class MessagesController < ApplicationController
def show
@message = Message.new(id: 1, content: "My message")
@message = Message.find(params[:id])

if (other_id = params[:other_message])
@other_message = Message.find(other_id)
end
end

def index
Expand Down
4 changes: 4 additions & 0 deletions test/dummy/app/views/messages/show.html.erb
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<h1>Message #<%= @message.id %></h1>

<%= turbo_stream_from @message %>

<div id="<%= dom_id @message %>">
<%= render @message %>
</div>
12 changes: 6 additions & 6 deletions test/dummy/app/views/messages/show.turbo_stream.erb
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<%= turbo_stream.remove @message %>
<%= turbo_stream.replace @message %>
<%= turbo_stream.replace @message, "Something else" %>
<%= turbo_stream.replace "message_5", "Something fifth" %>
<%= turbo_stream.replace "message_5", "Something fifth", method: :morph %>
<%= turbo_stream.update "message_5", "Something fifth", method: :morph %>
<%= turbo_stream.replace "message_5", partial: "messages/message", locals: { message: Message.new(id: 5, content: "OLLA!") } %>
<%= turbo_stream.replace @other_message, "Something fifth" %>
<%= turbo_stream.replace @other_message, "Something fifth", method: :morph %>
<%= turbo_stream.update @other_message, "Something fifth", method: :morph %>
<%= turbo_stream.replace @other_message, partial: "messages/message", locals: { message: @other_message } %>
<%= turbo_stream.append "messages", @message %>
<%= turbo_stream.append "messages", partial: "messages/message", locals: { message: Message.new(id: 5, content: "OLLA!") } %>
<%= turbo_stream.append "messages", partial: "messages/message", locals: { message: @other_message } %>
<%= turbo_stream.prepend "messages", @message %>
<%= turbo_stream.prepend "messages", partial: "messages/message", locals: { message: Message.new(id: 5, content: "OLLA!") } %>
<%= turbo_stream.prepend "messages", partial: "messages/message", locals: { message: @other_message } %>
2 changes: 1 addition & 1 deletion test/dummy/config/environments/test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
config.action_controller.perform_caching = false

# Raise exceptions instead of rendering exception templates.
config.action_dispatch.show_exceptions = false
config.action_dispatch.show_exceptions = :none

# Disable request forgery protection in test environment.
config.action_controller.allow_forgery_protection = false
Expand Down
5 changes: 2 additions & 3 deletions test/streams/streams_controller_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,9 @@ class Turbo::StreamsControllerTest < ActionDispatch::IntegrationTest
end

test "show all turbo actions" do
message_1 = Message.new(id: 1, content: "My message")
message_5 = Message.new(id: 5, content: "OLLA!")
message_1, message_5 = Message.create!([{ id: 1, content: "My message" }, { id: 5, content: "OLLA!" }])

get message_path(id: 1), as: :turbo_stream
get message_path(message_1, other_message: message_5), as: :turbo_stream

assert_dom_equal <<~HTML, @response.body
<turbo-stream action="remove" target="message_1"></turbo-stream>
Expand Down
4 changes: 2 additions & 2 deletions test/system/assertions_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

class AssertionsTest < ApplicationSystemTestCase
test "#assert_turbo_cable_stream_source treats the locator as :signed_stream_name filter" do
message = Message.new(id: 1)
message = Message.create!

visit message_path(message)

Expand All @@ -22,7 +22,7 @@ class AssertionsTest < ApplicationSystemTestCase
end

test "#assert_turbo_cable_stream_source supports record filters" do
message = Message.new(id: 1)
message = Message.create!

visit message_path(message)

Expand Down
22 changes: 22 additions & 0 deletions test/system/broadcasts_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

class BroadcastsTest < ApplicationSystemTestCase
include ActiveJob::TestHelper
extend Turbo::Streams::StreamName

test "Message broadcasts Turbo Streams" do
visit messages_path
Expand Down Expand Up @@ -106,8 +107,29 @@ class BroadcastsTest < ApplicationSystemTestCase
end
end

test "the turbo-cable-stream-source observes attribute changes" do
original, broadcasted = Message.create! [{ content: "original content" }, { content: "broadcasted content" }]

visit message_path(original)
reconnect_cable_stream_source from: original, to: broadcasted

assert_text original.content
assert_broadcasts_text broadcasted.content, to: dom_id(original) do
broadcasted.broadcast_update target: dom_id(original)
end
assert_no_text original.content
end

private

def reconnect_cable_stream_source(from:, to:)
cable_stream_source = find("turbo-cable-stream-source[signed-stream-name=#{signed_stream_name(from)}]")

cable_stream_source.execute_script <<~JS, signed_stream_name(to)
this.setAttribute("signed-stream-name", arguments[0])
JS
end

def assert_broadcasts_text(text, to:, &block)
within(:element, id: to) { assert_no_text text }

Expand Down
Loading