actioncable 7.2.2.1 → 8.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 720238323d1411f0913bcc9b65ac89d955c4fc4e708bbab5b5dd1c0c47c4cf00
-  data.tar.gz: 10a5cd05102adeda05b151a39c40183bc55c2c55c2c63dca5a13d642fcf49f58
+  metadata.gz: d8d20cfcdba9f7fb62b19e8fe87bd76f7bec5926eb555dbec20770c07cda1f69
+  data.tar.gz: b973eb7f4378d5545d691929ce532497a5c1bf9b51b750e2829ef4d27001b5ca
 SHA512:
-  metadata.gz: '0639a73b1efc8078fe167814911d5694e76781f618ac7fe5bb34ae8448ab495b60f598a76c6a0e8d7c9f45d9674d19564ad14eaae0ccaaf1f75b441d1318d7c8'
-  data.tar.gz: 4988a92b2c683bc86c28d60be1d2f92d1efe36bc5d33f814da55ac7328af60597fb0313321aa663b6d5632ecd565661725d12bf1238fa48a153b18d538e6e08e
+  metadata.gz: 8ab7982858d2e56416eeebe5cee0802931e4e22229b5f60532932b0da160fbd70b1ca49800628570dc24603fb9f677885ae6aed3d8588e2450935c426b153065
+  data.tar.gz: a3277654e245484ddf50c17fe71034ae1811fd1e2520d1cc9fea1c19c12edf5ca5eb016b67ee37bc3a0064b9f33248bd36f2ea9bd790beb19ea6f92548df1139

data/CHANGELOG.md

@@ -1,68 +1,21 @@
-## Rails 7.2.2.1 (December 10, 2024) ##
+## Rails 8.1.2 (January 08, 2026) ##
 
 *   No changes.
 
 
-## Rails 7.2.2 (October 30, 2024) ##
+## Rails 8.1.1 (October 28, 2025) ##
 
 *   No changes.
 
 
-## Rails 7.2.1.2 (October 23, 2024) ##
+## Rails 8.1.0 (October 22, 2025) ##
 
-*   No changes.
-
-
-## Rails 7.2.1.1 (October 15, 2024) ##
-
-*   No changes.
-
-
-## Rails 7.2.1 (August 22, 2024) ##
-
-*   No changes.
-
-
-## Rails 7.2.0 (August 09, 2024) ##
-
-*   Bring `ActionCable::Connection::TestCookieJar` in alignment with `ActionDispatch::Cookies::CookieJar` in regards to setting the cookie value.
-
-    Before:
-
-    ```ruby
-    cookies[:foo] = { value: "bar" }
-    puts cookies[:foo] # => { value: "bar" }
-    ```
-
-    After:
-
-    ```ruby
-    cookies[:foo] = { value: "bar" }
-    puts cookies[:foo] # => "bar"
-    ```
-
-    *Justin Ko*
-
-*   Record ping on every Action Cable message.
-
-    Previously only `ping` and `welcome` message types were keeping the connection active.
-    Now every Action Cable message updates the `pingedAt` value, preventing the connection
-    from being marked as stale.
-
-    *yauhenininjia*
-
-*   Add two new assertion methods for Action Cable test cases: `assert_has_no_stream`
-    and `assert_has_no_stream_for`.
+*   Allow passing composite channels to `ActionCable::Channel#stream_for` – e.g. `stream_for [ group, group.owner ]`
 
-    These methods can be used to assert that a stream has been stopped, e.g. via
-    `stop_stream` or `stop_stream_for`. They complement the already existing
-    `assert_has_stream` and `assert_has_stream_for` methods.
+    *hey-leon*
 
-    ```ruby
-    assert_has_no_stream "messages"
-    assert_has_no_stream_for User.find(42)
-    ```
+*   Allow setting nil as subscription connection identifier for Redis.
 
-    *Sebastian Pöll*, *Junichi Sato*
+    *Nguyen Nguyen*
 
-Please check [7-1-stable](https://github.com/rails/rails/blob/7-1-stable/actioncable/CHANGELOG.md) for previous changes.
+Please check [8-0-stable](https://github.com/rails/rails/blob/8-0-stable/actioncable/CHANGELOG.md) for previous changes.

data/README.md

@@ -19,6 +19,6 @@ Bug reports for the Ruby on \Rails project can be filed here:
 
 * https://github.com/rails/rails/issues
 
-Feature requests should be discussed on the rails-core mailing list here:
+Feature requests should be discussed on the rubyonrails-core forum here:
 
 * https://discuss.rubyonrails.org/c/rubyonrails-core

data/lib/action_cable/channel/base.rb

@@ -2,7 +2,6 @@
 
 # :markup: markdown
 
-require "set"
 require "active_support/rescuable"
 require "active_support/parameter_filter"
 
@@ -133,7 +132,11 @@ module ActionCable
               # Except for public instance methods of Base and its ancestors
               ActionCable::Channel::Base.public_instance_methods(true) +
               # Be sure to include shadowed public instance methods of this class
-              public_instance_methods(false)).uniq.map(&:to_s)
+              public_instance_methods(false) -
+              # Except the internal methods
+              internal_methods).uniq
+
+            methods.map!(&:name)
             methods.to_set
           end
         end
@@ -151,6 +154,10 @@ module ActionCable
             super
             clear_action_methods!
           end
+
+          def internal_methods
+            super
+          end
       end
 
       def initialize(connection, identifier, params = {})
@@ -166,6 +173,7 @@ module ActionCable
 
         @reject_subscription = nil
         @subscription_confirmation_sent = nil
+        @unsubscribed = false
 
         delegate_connection_identifiers
       end
@@ -201,11 +209,16 @@ module ActionCable
       # cleanup with callbacks. This method is not intended to be called directly by
       # the user. Instead, override the #unsubscribed callback.
       def unsubscribe_from_channel # :nodoc:
+        @unsubscribed = true
         run_callbacks :unsubscribe do
           unsubscribed
         end
       end
 
+      def unsubscribed? # :nodoc:
+        @unsubscribed
+      end
+
       private
         # Called once a consumer has become a subscriber of the channel. Usually the
         # place to set up any streams you want this channel to be sending to the
@@ -309,7 +322,7 @@ module ActionCable
           unless subscription_confirmation_sent?
             logger.debug "#{self.class.name} is transmitting the subscription confirmation"
 
-            ActiveSupport::Notifications.instrument("transmit_subscription_confirmation.action_cable", channel_class: self.class.name) do
+            ActiveSupport::Notifications.instrument("transmit_subscription_confirmation.action_cable", channel_class: self.class.name, identifier: @identifier) do
               connection.transmit identifier: @identifier, type: ActionCable::INTERNAL[:message_types][:confirmation]
               @subscription_confirmation_sent = true
             end
@@ -324,7 +337,7 @@ module ActionCable
         def transmit_subscription_rejection
           logger.debug "#{self.class.name} is transmitting the subscription rejection"
 
-          ActiveSupport::Notifications.instrument("transmit_subscription_rejection.action_cable", channel_class: self.class.name) do
+          ActiveSupport::Notifications.instrument("transmit_subscription_rejection.action_cable", channel_class: self.class.name, identifier: @identifier) do
             connection.transmit identifier: @identifier, type: ActionCable::INTERNAL[:message_types][:rejection]
           end
         end

data/lib/action_cable/channel/broadcasting.rb

@@ -10,19 +10,19 @@ module ActionCable
       extend ActiveSupport::Concern
 
       module ClassMethods
-        # Broadcast a hash to a unique broadcasting for this `model` in this channel.
-        def broadcast_to(model, message)
-          ActionCable.server.broadcast(broadcasting_for(model), message)
+        # Broadcast a hash to a unique broadcasting for this array of `broadcastables` in this channel.
+        def broadcast_to(broadcastables, message)
+          ActionCable.server.broadcast(broadcasting_for(broadcastables), message)
         end
 
         # Returns a unique broadcasting identifier for this `model` in this channel:
         #
         #     CommentsChannel.broadcasting_for("all") # => "comments:all"
         #
-        # You can pass any object as a target (e.g. Active Record model), and it would
+        # You can pass an array of objects as a target (e.g. Active Record model), and it would
         # be serialized into a string under the hood.
-        def broadcasting_for(model)
-          serialize_broadcasting([ channel_name, model ])
+        def broadcasting_for(broadcastables)
+          serialize_broadcasting([ channel_name ] + Array(broadcastables))
         end
 
         private

data/lib/action_cable/channel/callbacks.rb

@@ -39,6 +39,8 @@ module ActionCable
       extend  ActiveSupport::Concern
       include ActiveSupport::Callbacks
 
+      INTERNAL_METHODS = [:_run_subscribe_callbacks, :_run_unsubscribe_callbacks] # :nodoc:
+
       included do
         define_callbacks :subscribe
         define_callbacks :unsubscribe
@@ -70,6 +72,11 @@ module ActionCable
           set_callback(:unsubscribe, :after, *methods, &block)
         end
         alias_method :on_unsubscribe, :after_unsubscribe
+
+        private
+          def internal_methods
+            INTERNAL_METHODS
+          end
       end
     end
   end

data/lib/action_cable/channel/streams.rb

@@ -88,6 +88,8 @@ module ActionCable
       # callback. Defaults to `coder: nil` which does no decoding, passes raw
       # messages.
       def stream_from(broadcasting, callback = nil, coder: nil, &block)
+        return if unsubscribed?
+
         broadcasting = String(broadcasting)
 
         # Don't send the confirmation until pubsub#subscribe is successful
@@ -106,15 +108,15 @@ module ActionCable
         end
       end
 
-      # Start streaming the pubsub queue for the `model` in this channel. Optionally,
+      # Start streaming the pubsub queue for the `broadcastables` in this channel. Optionally,
       # you can pass a `callback` that'll be used instead of the default of just
       # transmitting the updates straight to the subscriber.
       #
       # Pass `coder: ActiveSupport::JSON` to decode messages as JSON before passing to
       # the callback. Defaults to `coder: nil` which does no decoding, passes raw
       # messages.
-      def stream_for(model, callback = nil, coder: nil, &block)
-        stream_from(broadcasting_for(model), callback || block, coder: coder)
+      def stream_for(broadcastables, callback = nil, coder: nil, &block)
+        stream_from(broadcasting_for(broadcastables), callback || block, coder: coder)
       end
 
       # Unsubscribes streams from the named `broadcasting`.

data/lib/action_cable/connection/identification.rb

@@ -2,8 +2,6 @@
 
 # :markup: markdown
 
-require "set"
-
 module ActionCable
   module Connection
     module Identification

data/lib/action_cable/connection/stream_event_loop.rb

@@ -68,6 +68,7 @@ module ActionCable
             @nio ||= NIO::Selector.new
 
             @executor ||= Concurrent::ThreadPoolExecutor.new(
+              name: "ActionCable-streamer",
               min_threads: 1,
               max_threads: 10,
               max_queue: 0,

data/lib/action_cable/connection/test_case.rb

@@ -75,11 +75,8 @@ module ActionCable
     #
     # ## Basic example
     #
-    # Unit tests are written as follows:
-    #
-    # 1.  Simulate a connection attempt by calling `connect`.
-    # 2.  Assert state, e.g. identifiers, has been assigned.
-    #
+    # Unit tests are written by first simulating a connection attempt by calling
+    # `connect` and then asserting state, e.g. identifiers, have been assigned.
     #
     #     class ApplicationCable::ConnectionTest < ActionCable::Connection::TestCase
     #       def test_connects_with_proper_cookie

data/lib/action_cable/gem_version.rb

@@ -9,10 +9,10 @@ module ActionCable
   end
 
   module VERSION
-    MAJOR = 7
-    MINOR = 2
+    MAJOR = 8
+    MINOR = 1
     TINY  = 2
-    PRE   = "1"
+    PRE   = nil
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
   end

data/lib/action_cable/remote_connections.rb

@@ -39,45 +39,44 @@ module ActionCable
       RemoteConnection.new(server, identifier)
     end
 
-    private
-      # # Action Cable Remote Connection
-      #
-      # Represents a single remote connection found via
-      # `ActionCable.server.remote_connections.where(*)`. Exists solely for the
-      # purpose of calling #disconnect on that connection.
-      class RemoteConnection
-        class InvalidIdentifiersError < StandardError; end
+    # # Action Cable Remote Connection
+    #
+    # Represents a single remote connection found via
+    # `ActionCable.server.remote_connections.where(*)`. Exists solely for the
+    # purpose of calling #disconnect on that connection.
+    class RemoteConnection
+      class InvalidIdentifiersError < StandardError; end
 
-        include Connection::Identification, Connection::InternalChannel
+      include Connection::Identification, Connection::InternalChannel
 
-        def initialize(server, ids)
-          @server = server
-          set_identifier_instance_vars(ids)
-        end
+      def initialize(server, ids)
+        @server = server
+        set_identifier_instance_vars(ids)
+      end
 
-        # Uses the internal channel to disconnect the connection.
-        def disconnect(reconnect: true)
-          server.broadcast internal_channel, { type: "disconnect", reconnect: reconnect }
-        end
+      # Uses the internal channel to disconnect the connection.
+      def disconnect(reconnect: true)
+        server.broadcast internal_channel, { type: "disconnect", reconnect: reconnect }
+      end
 
-        # Returns all the identifiers that were applied to this connection.
-        redefine_method :identifiers do
-          server.connection_identifiers
-        end
+      # Returns all the identifiers that were applied to this connection.
+      redefine_method :identifiers do
+        server.connection_identifiers
+      end
 
-        protected
-          attr_reader :server
+      protected
+        attr_reader :server
 
-        private
-          def set_identifier_instance_vars(ids)
-            raise InvalidIdentifiersError unless valid_identifiers?(ids)
-            ids.each { |k, v| instance_variable_set("@#{k}", v) }
-          end
+      private
+        def set_identifier_instance_vars(ids)
+          raise InvalidIdentifiersError unless valid_identifiers?(ids)
+          ids.each { |k, v| instance_variable_set("@#{k}", v) }
+        end
 
-          def valid_identifiers?(ids)
-            keys = ids.keys
-            identifiers.all? { |id| keys.include?(id) }
-          end
-      end
+        def valid_identifiers?(ids)
+          keys = ids.keys
+          identifiers.all? { |id| keys.include?(id) }
+        end
+    end
   end
 end

data/lib/action_cable/server/broadcasting.rb

@@ -21,10 +21,12 @@ module ActionCable
     #     ActionCable.server.broadcast \
     #       "web_notifications_1", { title: "New things!", body: "All that's fit for print" }
     #
-    #     # Client-side CoffeeScript, which assumes you've already requested the right to send web notifications:
-    #     App.cable.subscriptions.create "WebNotificationsChannel",
-    #       received: (data) ->
-    #         new Notification data['title'], body: data['body']
+    #     # Client-side JavaScript, which assumes you've already requested the right to send web notifications:
+    #     App.cable.subscriptions.create("WebNotificationsChannel", {
+    #       received: function(data) {
+    #         new Notification(data['title'], { body: data['body'] })
+    #       }
+    #     })
     module Broadcasting
       # Broadcast a hash directly to a named `broadcasting`. This will later be JSON
       # encoded.

data/lib/action_cable/server/worker.rb

@@ -20,7 +20,7 @@ module ActionCable
 
       def initialize(max_size: 5)
         @executor = Concurrent::ThreadPoolExecutor.new(
-          name: "ActionCable",
+          name: "ActionCable-server",
           min_threads: 1,
           max_threads: max_size,
           max_queue: 0,

data/lib/action_cable/subscription_adapter/base.rb

@@ -29,7 +29,8 @@ module ActionCable
       end
 
       def identifier
-        @server.config.cable[:id] ||= "ActionCable-PID-#{$$}"
+        @server.config.cable[:id] = "ActionCable-PID-#{$$}" unless @server.config.cable.key?(:id)
+        @server.config.cable[:id]
       end
     end
   end

data/lib/action_cable/subscription_adapter/postgresql.rb

@@ -35,18 +35,17 @@ module ActionCable
       end
 
       def with_subscriptions_connection(&block) # :nodoc:
-        ar_conn = ActiveRecord::Base.connection_pool.checkout.tap do |conn|
-          # Action Cable is taking ownership over this database connection, and will
-          # perform the necessary cleanup tasks
-          ActiveRecord::Base.connection_pool.remove(conn)
-        end
+        # Action Cable is taking ownership over this database connection, and will
+        # perform the necessary cleanup tasks.
+        # We purposedly avoid #checkout to not end up with a pinned connection
+        ar_conn = ActiveRecord::Base.connection_pool.new_connection
         pg_conn = ar_conn.raw_connection
 
         verify!(pg_conn)
         pg_conn.exec("SET application_name = #{pg_conn.escape_identifier(identifier)}")
         yield pg_conn
       ensure
-        ar_conn.disconnect!
+        ar_conn&.disconnect!
       end
 
       def with_broadcast_connection(&block) # :nodoc:

data/lib/action_cable/subscription_adapter/redis.rb

@@ -164,7 +164,7 @@ module ActionCable
                 begin
                   conn = @adapter.redis_connection_for_subscriptions
                   listen conn
-                rescue ConnectionError
+                rescue *CONNECTION_ERRORS
                   reset
                   if retry_connecting?
                     when_connected { resubscribe }
@@ -210,7 +210,7 @@ module ActionCable
             end
 
             if ::Redis::VERSION < "5"
-              ConnectionError = ::Redis::BaseConnectionError
+              CONNECTION_ERRORS = [::Redis::BaseConnectionError].freeze
 
               class SubscribedClient
                 def initialize(raw_client)
@@ -244,7 +244,12 @@ module ActionCable
                 SubscribedClient.new(conn._client)
               end
             else
-              ConnectionError = RedisClient::ConnectionError
+              CONNECTION_ERRORS = [
+                ::Redis::BaseConnectionError,
+
+                # Some older versions of redis-rb sometime leak underlying exceptions
+                RedisClient::ConnectionError,
+              ].freeze
 
               def extract_subscribed_client(conn)
                 conn

data/lib/rails/generators/channel/channel_generator.rb

@@ -59,17 +59,17 @@ module Rails
         def create_channel_javascript_file
           channel_js_path = File.join("app/javascript/channels", class_path, "#{file_name}_channel")
           js_template "javascript/channel", channel_js_path
-          gsub_file "#{channel_js_path}.js", /\.\/consumer/, "channels/consumer" unless using_js_runtime?
+          gsub_file "#{channel_js_path}.js", /\.\/consumer/, "channels/consumer" if using_importmap?
         end
 
         def import_channels_in_javascript_entrypoint
           append_to_file "app/javascript/application.js",
-            using_js_runtime? ? %(import "./channels"\n) : %(import "channels"\n)
+            using_importmap? ? %(import "channels"\n) : %(import "./channels"\n)
         end
 
         def import_channel_in_javascript_entrypoint
           append_to_file "app/javascript/channels/index.js",
-            using_js_runtime? ? %(import "./#{file_name}_channel"\n) : %(import "channels/#{file_name}_channel"\n)
+            using_importmap? ? %(import "channels/#{file_name}_channel"\n) : %(import "./#{file_name}_channel"\n)
         end
 
         def install_javascript_dependencies
@@ -105,7 +105,7 @@ pin_all_from "app/javascript/channels", under: "channels"
         end
 
         def using_bun?
-          # Cannot assume bun.lockb has been generated yet so we look for a file known to
+          # Cannot assume Bun lockfile has been generated yet so we look for a file known to
           # be generated by the jsbundling-rails gem
           @using_bun ||= using_js_runtime? && root.join("bun.config.js").exist?
         end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: actioncable
 version: !ruby/object:Gem::Version
-  version: 7.2.2.1
+  version: 8.1.2
 platform: ruby
 authors:
 - Pratik Naik
 - David Heinemeier Hansson
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-12-10 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -17,28 +16,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 7.2.2.1
+        version: 8.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 7.2.2.1
+        version: 8.1.2
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 7.2.2.1
+        version: 8.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 7.2.2.1
+        version: 8.1.2
 - !ruby/object:Gem::Dependency
   name: nio4r
   requirement: !ruby/object:Gem::Requirement
@@ -154,12 +153,11 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/rails/rails/issues
-  changelog_uri: https://github.com/rails/rails/blob/v7.2.2.1/actioncable/CHANGELOG.md
-  documentation_uri: https://api.rubyonrails.org/v7.2.2.1/
+  changelog_uri: https://github.com/rails/rails/blob/v8.1.2/actioncable/CHANGELOG.md
+  documentation_uri: https://api.rubyonrails.org/v8.1.2/
   mailing_list_uri: https://discuss.rubyonrails.org/c/rubyonrails-talk
-  source_code_uri: https://github.com/rails/rails/tree/v7.2.2.1/actioncable
+  source_code_uri: https://github.com/rails/rails/tree/v8.1.2/actioncable
   rubygems_mfa_required: 'true'
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -167,15 +165,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key: 
+rubygems_version: 4.0.3
 specification_version: 4
 summary: WebSocket framework for Rails.
 test_files: []