live_cable 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a08ab617cc974271c9f4b2784bb52ca53d1430942fd72e761fe52cd650a86141
-  data.tar.gz: abd1b26ca97b149de015b9fb7b9b457ff6b6f21e224a61318788876115fcd9d9
+  metadata.gz: 9328496395172b7689b680c9fc54f222f26da2cc2d5a1cd25683fbcbdbe3c2bf
+  data.tar.gz: c824da0a8a7cc10f3ca84a2965d264d88b879944b108d57e37599b0865b07b9d
 SHA512:
-  metadata.gz: e3b932fcbdfcf3fb5d6b939320798eb151c82d0e6bc85c61c2452ff729233855b477752e10465c8098f4601651d04f9e67449293b9635cde3eefa47bde08733c
-  data.tar.gz: 6476ba238c1960655922da93588b175ed0468294364dd1252b05ad044eb26cb0d94360254581cb791ddc6def81155940c82d310835398b7c791b8cb3daf6884c
+  metadata.gz: ed7c3db367dea001f0d50cfd0d05dd5c7ba837800438924e944c7a92041dd0b252293682792b17bb8730934a659ba2839a1c6ad283469fdacc00bfa4771f4a79
+  data.tar.gz: a97bb8a0096edb1a4daa016b59051aef62a1d93eb1e8635d4a5462b5b6444ae5bdf28ae997b141f0e3ff0dfafde71fdcb08d98d322921c4e527e8e2c3ed416b6

data/CHANGELOG.md

@@ -6,6 +6,42 @@ The Ruby gem (`live_cable`) and the npm package (`@isometriks/live_cable`) are
 released together and share a single version number. Entries below note which
 side of the pair a change affects when it isn't both.
 
+## 0.2.1 - 2026-08-13
+
+### Removed
+
+- `Component#channel_name` and `Connection#channel_name`. A component no longer
+  subscribes to a stream of its own now that payloads are written straight to its
+  channel, so the name identified a stream nothing published to or read from.
+  Subscribing to external streams with `stream_from` is unaffected (gem).
+
+### Fixed
+
+- **The opening payload from `LiveChannel#subscribed` could be dropped.**
+  Payloads were published through the pubsub adapter, but ActionCable registers
+  `stream_from` asynchronously — so the initial render could be published before
+  the subscription it targets existed, and pubsub delivers only to subscribers
+  present at that moment, with no buffering or retry. The component was left
+  showing `data-live-status-value="disconnected"`, with no cached render on the
+  client for a Turbo reattach to replay, until some later action happened to
+  produce a refresh. When a subscribe render raised, the `_error` payload was
+  lost outright and the failure never surfaced in the browser at all. A
+  component's stream belongs to exactly one connection, so payloads are now
+  written straight to that connection rather than published, which removes the
+  race along with a pubsub round trip (gem).
+- **Components not reattaching after a Turbo Drive navigation.** Navigating to a
+  page containing a component that is already subscribed deliberately keeps the
+  existing subscription, so `LiveChannel#subscribed` does not run again and the
+  server sends nothing. The newly rendered element was left with its
+  server-rendered status of `disconnected` and never received the component's
+  current state. A reconnecting controller now re-syncs the subscription's status
+  and replays the last render into the new element (npm).
+- Building DOM from a server render used iterator helpers
+  (`childNodes.values().find(...)`), an ES2025 feature, which raised
+  `TypeError: ... .find is not a function` on runtimes that do not implement them
+  — Node 20 and earlier, and browsers older than Chrome 122 / Firefox 131 /
+  Safari 18.4. Rewritten with `Array.from` (npm).
+
 ## 0.2.0
 
 The gem and npm package versions are realigned in this release. The npm package

data/app/assets/javascript/subscriptions.js

@@ -34,8 +34,7 @@ function createDOMFromHTML(html) {
   template.innerHTML = html
 
   // Find a node that isn't a comment
-  const node = template.content.childNodes
-    .values()
+  const node = Array.from(template.content.childNodes)
     .find(n => n.nodeName !== '#comment')
 
   if (node) {
@@ -230,6 +229,15 @@ class ComponentState {
     return this.#element
   }
 
+  /**
+   * Whether a render has been received and cached, and can therefore be
+   * replayed into a freshly attached element.
+   * @returns {boolean}
+   */
+  get hasRender() {
+    return this.#lastTemplate !== null && Boolean(this.#partsByTemplate[this.#lastTemplate])
+  }
+
   /**
    * Create a DOM element from stored state.
    * @param {Object} refresh - Optional refresh data to update state
@@ -345,12 +353,44 @@ class Subscription {
 
   /**
    * Update the controller reference.
-   * Called when a Stimulus controller reconnects to an existing subscription.
+   * Called when a Stimulus controller reconnects to an existing subscription —
+   * most importantly after a Turbo Drive navigation to a page that contains the
+   * same component, where prune() deliberately keeps the subscription alive.
+   *
+   * In that case the ActionCable subscription is never recreated, so
+   * LiveChannel#subscribed does not run again and the server sends nothing.
+   * Without re-syncing here, the newly rendered element keeps the
+   * server-rendered status of "disconnected" forever and never receives the
+   * component's current state.
    *
    * @param {Object} controller - Stimulus controller instance
    */
   set controller(controller) {
+    const previous = this.#controller
+
     this.#controller = controller
+    this.#componentState.element = controller.element
+
+    if (previous && previous !== controller) {
+      this.#reattach()
+    }
+  }
+
+  /**
+   * Bring a freshly connected controller up to date with state this
+   * subscription already holds.
+   * @private
+   */
+  #reattach() {
+    if (this.#currentStatus) {
+      this.#controller.statusValue = this.#currentStatus
+    }
+
+    // Replay the last render into the new element. The server-side component
+    // is the same instance, so the cached parts are its current state.
+    if (this.#componentState.hasRender) {
+      this.#handleRefresh(null)
+    }
   }
 
   /**

data/app/channels/live_channel.rb

@@ -41,6 +41,11 @@ class LiveChannel < ActionCable::Channel::Base
     @component = nil
   end
 
+  # Exposes #transmit, which ActionCable keeps private to the channel.
+  def broadcast(data)
+    transmit(data)
+  end
+
   private
 
   # @return [LiveCable::Component, nil]

data/lib/live_cable/component/broadcasting.rb

@@ -5,8 +5,10 @@ module LiveCable
     module Broadcasting
       extend ActiveSupport::Concern
 
+      # Nil until the component's own controller subscribes; children rendered
+      # by a parent have no channel to deliver to yet.
       def broadcast(data)
-        ActionCable.server.broadcast(channel_name, data)
+        channel&.broadcast(data)
       end
 
       def broadcast_subscribe

data/lib/live_cable/component/identification.rb

@@ -22,10 +22,6 @@ module LiveCable
       def live_id
         self.class.component_id(id)
       end
-
-      def channel_name
-        "#{live_connection.channel_name}/#{live_id}"
-      end
     end
   end
 end

data/lib/live_cable/component/lifecycle.rb

@@ -23,7 +23,6 @@ module LiveCable
       def connect(channel)
         run_callbacks :connect do
           @channel = channel
-          start_stream
           @subscribed = true
         end
       end

data/lib/live_cable/component/streaming.rb

@@ -7,14 +7,7 @@ module LiveCable
 
       private
 
-      def start_stream
-        channel.stream_from(channel_name)
-      end
-
       def stop_stream
-        channel.stop_stream_from(channel_name)
-
-        # Stop all additional streams started via stream_from
         additional_streams.each do |stream_name|
           channel.stop_stream_from(stream_name)
         end

data/lib/live_cable/connection.rb

@@ -3,7 +3,6 @@
 module LiveCable
   class Connection
     include ComponentManagement
-    include ChannelManagement
     include StateManagement
     include Messaging
     include Broadcasting
@@ -13,17 +12,12 @@ module LiveCable
 
     def initialize(request)
       @request = request
-      @session_id = SecureRandom.uuid
       @containers = Hash.new { |hash, key| hash[key] = Container.new }
       @components = {}
-      @channels = {}
     end
 
     private
 
-    # @return [String]
-    attr_reader :session_id
-
     # @return [ActionDispatch::Request]
     attr_reader :request
 

data/lib/live_cable/testing/test_channel.rb

@@ -3,19 +3,28 @@
 module LiveCable
   module Testing
     # Stand-in for an ActionCable channel. Records streams started via
-    # stream_from so tests can trigger their callbacks with receive_stream.
+    # stream_from so tests can trigger their callbacks with receive_stream,
+    # and payloads sent by components.
     class TestChannel
       # @return [Hash<String, Hash>] Stream name => { coder:, callback: }
       attr_reader :streams
 
+      # @return [Array<Hash>] Payloads sent by components through this channel
+      attr_reader :transmissions
+
       # @return [LiveCable::Testing::TestCableConnection]
       attr_reader :connection
 
       def initialize(identifiers = {})
         @streams = {}
+        @transmissions = []
         @connection = TestCableConnection.new(identifiers)
       end
 
+      def broadcast(data)
+        @transmissions << data
+      end
+
       def stream_from(name, coder: nil, &block)
         @streams[name] = { coder:, callback: block }
       end

data/lib/live_cable/testing/test_component.rb

@@ -18,9 +18,6 @@ module LiveCable
         super(component)
         @connection = connection
         @channel = channel
-        @broadcasts = []
-
-        capture_broadcasts(component)
       end
 
       # @return [LiveCable::Component] The underlying component instance
@@ -74,15 +71,15 @@ module LiveCable
       #   (e.g. :_refresh, :_ack, :_error, :_status)
       # @return [Array<Hash>]
       def broadcasts(key = nil)
-        return @broadcasts.dup unless key
+        return channel.transmissions.dup unless key
 
-        @broadcasts.select { |broadcast| broadcast.key?(key) }
+        channel.transmissions.select { |broadcast| broadcast.key?(key) }
       end
 
       # Forget previously captured broadcasts. Useful after mounting, to
       # assert on the effects of a single action.
       def clear_broadcasts
-        @broadcasts.clear
+        channel.transmissions.clear
       end
 
       # All events the component has dispatched via dispatch_event, in
@@ -134,14 +131,6 @@ module LiveCable
       def receive_message(message)
         connection.receive(component, { 'messages' => [message] })
       end
-
-      def capture_broadcasts(component)
-        captured = @broadcasts
-
-        component.define_singleton_method(:broadcast) do |data|
-          captured << data
-        end
-      end
     end
   end
 end

data/lib/live_cable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LiveCable
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: live_cable
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Craig Blanchette
@@ -145,7 +145,6 @@ files:
 - lib/live_cable/configuration.rb
 - lib/live_cable/connection.rb
 - lib/live_cable/connection/broadcasting.rb
-- lib/live_cable/connection/channel_management.rb
 - lib/live_cable/connection/component_management.rb
 - lib/live_cable/connection/error_handling.rb
 - lib/live_cable/connection/messaging.rb

data/lib/live_cable/connection/channel_management.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module LiveCable
-  class Connection
-    module ChannelManagement
-      extend ActiveSupport::Concern
-
-      def channel_name
-        "live_#{session_id}"
-      end
-    end
-  end
-end