actioncable 7.1.4 → 7.2.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bcb9c7c9a5656d7542bcd83654111600cbf90500a20ebf26264983038398ef85
-  data.tar.gz: 0f5b700f5ec9ad8f8a50652e8964749eb95c873dc6bcb7c6c29758e712cea8ab
+  metadata.gz: 0ef0b15a8ba035bb74d223a307b5582d7127717f3d63bc720832ed7f7e26232e
+  data.tar.gz: 6098f911679d8d5ecc08308c034c0034483178924920ece25c1ebb9b7ed6f9a7
 SHA512:
-  metadata.gz: 6a75b8e647d3777b8d121a3c87555471d779a87e12b9a4f76509cb67fb19de9f4140dd531ce21bc6ec8213a20d80a2205988108fb94f70e81bc956d90c683806
-  data.tar.gz: f750ec3c1f36d6ea9667fc5100f53d82e85a1b4db2cfe7b0a9e5ffdd0a87c6297a95a12c0dc981301b8a7c2cbeabdbd1565614c526f0c3b162778464a179bbb3
+  metadata.gz: ddef615b9413742c7c59ef63e04060f63df5c2509305ff8e8a69d26580145d52317b992fc0f3f0c47489e96a373f63fb0ab854356fb582fa9643112a5875d384
+  data.tar.gz: 7f14595ad0b02f979a36a287ebed53f4c52a9e162679f5ab748d687e87d66374bf8ebb43a1fddc30bdcf8876519d68f0a5539ab97c65d352db14abf30623c412

data/CHANGELOG.md

@@ -1,156 +1,25 @@
-## Rails 7.1.4 (August 22, 2024) ##
+## Rails 7.2.0.beta1 (May 29, 2024) ##
 
-*   No changes.
+*   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.
 
-## Rails 7.1.3.4 (June 04, 2024) ##
+    *yauhenininjia*
 
-*   No changes.
+*   Add two new assertion methods for Action Cable test cases: `assert_has_no_stream`
+    and `assert_has_no_stream_for`.
 
-
-## Rails 7.1.3.3 (May 16, 2024) ##
-
-*   No changes.
-
-
-## Rails 7.1.3.2 (February 21, 2024) ##
-
-*   No changes.
-
-
-## Rails 7.1.3.1 (February 21, 2024) ##
-
-*   No changes.
-
-
-## Rails 7.1.3 (January 16, 2024) ##
-
-*   No changes.
-
-
-## Rails 7.1.2 (November 10, 2023) ##
-
-*   No changes.
-
-
-## Rails 7.1.1 (October 11, 2023) ##
-
-*   No changes.
-
-
-## Rails 7.1.0 (October 05, 2023) ##
-
-*   No changes.
-
-
-## Rails 7.1.0.rc2 (October 01, 2023) ##
-
-*   No changes.
-
-
-## Rails 7.1.0.rc1 (September 27, 2023) ##
-
-*   No changes.
-
-
-## Rails 7.1.0.beta1 (September 13, 2023) ##
-
-*   Add a `@server` instance variable referencing the `ActionCable.server`
-    singleton to `ActionCable::Channel::ConnectionStub`
-
-    This lets us delegate the `pubsub` and `config` method calls
-    to the server. This fixes `NoMethodError` errors when testing
-    channel logic that call `pubsub` (e.g. `stop_stream_for`).
-
-    *Julian Foo*
-
-*   Added `health_check_path` and `health_check_application` config to
-    mount a given health check rack app on a given path.
-    Useful when mounting Action Cable standalone.
-
-    *Joé Dupuis*
-
-*   Introduce the `capture_broadcasts` test helper.
-
-    Returns all messages broadcast in a block.
+    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.
 
     ```ruby
-    messages = capture_broadcasts("test") do
-      ActionCable.server.broadcast "test", { message: "one" }
-      ActionCable.server.broadcast "test", { message: "two" }
-    end
-    assert_equal 2, messages.length
-    assert_equal({ "message" => "one" }, messages.first)
-    assert_equal({ "message" => "two" }, messages.last)
-    ```
-
-    *Alex Ghiculescu*
-
-*   Display broadcasted messages on error message when using `assert_broadcast_on`
-
-    *Stéphane Robino*
-
-*   The Action Cable client now supports subprotocols to allow passing arbitrary data
-    to the server.
-
-    ```js
-    const consumer = ActionCable.createConsumer()
-
-    consumer.addSubProtocol('custom-protocol')
-
-    consumer.connect()
+    assert_has_no_stream "messages"
+    assert_has_no_stream_for User.find(42)
     ```
 
-    See also:
-
-    * https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API/Writing_WebSocket_servers#subprotocols
-
-    *Guillaume Hain*
-
-*   Redis pub/sub adapter now automatically reconnects when Redis connection is lost.
-
-    *Vladimir Dementyev*
-
-*   The `connected()` callback can now take a `{reconnected}` parameter to differentiate
-    connections from reconnections.
-
-    ```js
-    import consumer from "./consumer"
-
-    consumer.subscriptions.create("ExampleChannel", {
-      connected({reconnected}) {
-        if (reconnected) {
-          ...
-        } else {
-          ...
-        }
-      }
-    })
-    ```
-
-    *Mansa Keïta*
-
-*   The Redis adapter is now compatible with redis-rb 5.0
-
-    Compatibility with redis-rb 3.x was dropped.
-
-    *Jean Boussier*
-
-*   The Action Cable server is now mounted with `anchor: true`.
-
-    This means that routes that also start with `/cable` will no longer clash with Action Cable.
-
-    *Alex Ghiculescu*
-
-*   `ActionCable.server.remote_connections.where(...).disconnect` now sends `disconnect` message
-    before closing the connection with the reconnection strategy specified (defaults to `true`).
-
-    *Vladimir Dementyev*
-
-*   Added command callbacks to `ActionCable::Connection::Base`.
-
-    Now you can define `before_command`, `after_command`, and `around_command` to be invoked before, after or around any command received by a client respectively.
-
-    *Vladimir Dementyev*
+    *Sebastian Pöll*, *Junichi Sato*
 
-Please check [7-0-stable](https://github.com/rails/rails/blob/7-0-stable/actioncable/CHANGELOG.md) for previous changes.
+Please check [7-1-stable](https://github.com/rails/rails/blob/7-1-stable/actioncable/CHANGELOG.md) for previous changes.

data/app/assets/javascripts/action_cable.js

@@ -43,12 +43,11 @@
     isRunning() {
       return this.startedAt && !this.stoppedAt;
     }
-    recordPing() {
+    recordMessage() {
       this.pingedAt = now();
     }
     recordConnect() {
       this.reconnectAttempts = 0;
-      this.recordPing();
       delete this.disconnectedAt;
       logger.log("ConnectionMonitor recorded connect");
     }
@@ -236,6 +235,7 @@
         return;
       }
       const {identifier: identifier, message: message, reason: reason, reconnect: reconnect, type: type} = JSON.parse(event.data);
+      this.monitor.recordMessage();
       switch (type) {
        case message_types.welcome:
         if (this.triedToReconnect()) {
@@ -251,7 +251,7 @@
         });
 
        case message_types.ping:
-        return this.monitor.recordPing();
+        return null;
 
        case message_types.confirmation:
         this.subscriptions.confirmSubscription(identifier);

data/app/assets/javascripts/actioncable.esm.js

@@ -42,12 +42,11 @@ class ConnectionMonitor {
   isRunning() {
     return this.startedAt && !this.stoppedAt;
   }
-  recordPing() {
+  recordMessage() {
     this.pingedAt = now();
   }
   recordConnect() {
     this.reconnectAttempts = 0;
-    this.recordPing();
     delete this.disconnectedAt;
     logger.log("ConnectionMonitor recorded connect");
   }
@@ -244,6 +243,7 @@ Connection.prototype.events = {
       return;
     }
     const {identifier: identifier, message: message, reason: reason, reconnect: reconnect, type: type} = JSON.parse(event.data);
+    this.monitor.recordMessage();
     switch (type) {
      case message_types.welcome:
       if (this.triedToReconnect()) {
@@ -259,7 +259,7 @@ Connection.prototype.events = {
       });
 
      case message_types.ping:
-      return this.monitor.recordPing();
+      return null;
 
      case message_types.confirmation:
       this.subscriptions.confirmSubscription(identifier);

data/app/assets/javascripts/actioncable.js

@@ -43,12 +43,11 @@
     isRunning() {
       return this.startedAt && !this.stoppedAt;
     }
-    recordPing() {
+    recordMessage() {
       this.pingedAt = now();
     }
     recordConnect() {
       this.reconnectAttempts = 0;
-      this.recordPing();
       delete this.disconnectedAt;
       logger.log("ConnectionMonitor recorded connect");
     }
@@ -236,6 +235,7 @@
         return;
       }
       const {identifier: identifier, message: message, reason: reason, reconnect: reconnect, type: type} = JSON.parse(event.data);
+      this.monitor.recordMessage();
       switch (type) {
        case message_types.welcome:
         if (this.triedToReconnect()) {
@@ -251,7 +251,7 @@
         });
 
        case message_types.ping:
-        return this.monitor.recordPing();
+        return null;
 
        case message_types.confirmation:
         this.subscriptions.confirmSubscription(identifier);

data/lib/action_cable/channel/base.rb

@@ -1,102 +1,112 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 require "set"
 require "active_support/rescuable"
 require "active_support/parameter_filter"
 
 module ActionCable
   module Channel
-    # = Action Cable \Channel \Base
+    # # Action Cable Channel Base
     #
-    # The channel provides the basic structure of grouping behavior into logical units when communicating over the WebSocket connection.
-    # You can think of a channel like a form of controller, but one that's capable of pushing content to the subscriber in addition to simply
-    # responding to the subscriber's direct requests.
+    # The channel provides the basic structure of grouping behavior into logical
+    # units when communicating over the WebSocket connection. You can think of a
+    # channel like a form of controller, but one that's capable of pushing content
+    # to the subscriber in addition to simply responding to the subscriber's direct
+    # requests.
     #
-    # Channel instances are long-lived. A channel object will be instantiated when the cable consumer becomes a subscriber, and then
-    # lives until the consumer disconnects. This may be seconds, minutes, hours, or even days. That means you have to take special care
-    # not to do anything silly in a channel that would balloon its memory footprint or whatever. The references are forever, so they won't be released
-    # as is normally the case with a controller instance that gets thrown away after every request.
+    # Channel instances are long-lived. A channel object will be instantiated when
+    # the cable consumer becomes a subscriber, and then lives until the consumer
+    # disconnects. This may be seconds, minutes, hours, or even days. That means you
+    # have to take special care not to do anything silly in a channel that would
+    # balloon its memory footprint or whatever. The references are forever, so they
+    # won't be released as is normally the case with a controller instance that gets
+    # thrown away after every request.
     #
-    # Long-lived channels (and connections) also mean you're responsible for ensuring that the data is fresh. If you hold a reference to a user
-    # record, but the name is changed while that reference is held, you may be sending stale data if you don't take precautions to avoid it.
+    # Long-lived channels (and connections) also mean you're responsible for
+    # ensuring that the data is fresh. If you hold a reference to a user record, but
+    # the name is changed while that reference is held, you may be sending stale
+    # data if you don't take precautions to avoid it.
     #
-    # The upside of long-lived channel instances is that you can use instance variables to keep reference to objects that future subscriber requests
-    # can interact with. Here's a quick example:
+    # The upside of long-lived channel instances is that you can use instance
+    # variables to keep reference to objects that future subscriber requests can
+    # interact with. Here's a quick example:
     #
-    #   class ChatChannel < ApplicationCable::Channel
-    #     def subscribed
-    #       @room = Chat::Room[params[:room_number]]
-    #     end
+    #     class ChatChannel < ApplicationCable::Channel
+    #       def subscribed
+    #         @room = Chat::Room[params[:room_number]]
+    #       end
     #
-    #     def speak(data)
-    #       @room.speak data, user: current_user
+    #       def speak(data)
+    #         @room.speak data, user: current_user
+    #       end
     #     end
-    #   end
     #
-    # The #speak action simply uses the Chat::Room object that was created when the channel was first subscribed to by the consumer when that
-    # subscriber wants to say something in the room.
+    # The #speak action simply uses the Chat::Room object that was created when the
+    # channel was first subscribed to by the consumer when that subscriber wants to
+    # say something in the room.
     #
-    # == Action processing
+    # ## Action processing
     #
     # Unlike subclasses of ActionController::Base, channels do not follow a RESTful
     # constraint form for their actions. Instead, Action Cable operates through a
-    # remote-procedure call model. You can declare any public method on the
-    # channel (optionally taking a <tt>data</tt> argument), and this method is
-    # automatically exposed as callable to the client.
+    # remote-procedure call model. You can declare any public method on the channel
+    # (optionally taking a `data` argument), and this method is automatically
+    # exposed as callable to the client.
     #
     # Example:
     #
-    #   class AppearanceChannel < ApplicationCable::Channel
-    #     def subscribed
-    #       @connection_token = generate_connection_token
-    #     end
-    #
-    #     def unsubscribed
-    #       current_user.disappear @connection_token
-    #     end
+    #     class AppearanceChannel < ApplicationCable::Channel
+    #       def subscribed
+    #         @connection_token = generate_connection_token
+    #       end
     #
-    #     def appear(data)
-    #       current_user.appear @connection_token, on: data['appearing_on']
-    #     end
+    #       def unsubscribed
+    #         current_user.disappear @connection_token
+    #       end
     #
-    #     def away
-    #       current_user.away @connection_token
-    #     end
+    #       def appear(data)
+    #         current_user.appear @connection_token, on: data['appearing_on']
+    #       end
     #
-    #     private
-    #       def generate_connection_token
-    #         SecureRandom.hex(36)
+    #       def away
+    #         current_user.away @connection_token
     #       end
-    #   end
     #
-    # In this example, the subscribed and unsubscribed methods are not callable methods, as they
-    # were already declared in ActionCable::Channel::Base, but <tt>#appear</tt>
-    # and <tt>#away</tt> are. <tt>#generate_connection_token</tt> is also not
-    # callable, since it's a private method. You'll see that appear accepts a data
-    # parameter, which it then uses as part of its model call. <tt>#away</tt>
-    # does not, since it's simply a trigger action.
+    #       private
+    #         def generate_connection_token
+    #           SecureRandom.hex(36)
+    #         end
+    #     end
+    #
+    # In this example, the subscribed and unsubscribed methods are not callable
+    # methods, as they were already declared in ActionCable::Channel::Base, but
+    # `#appear` and `#away` are. `#generate_connection_token` is also not callable,
+    # since it's a private method. You'll see that appear accepts a data parameter,
+    # which it then uses as part of its model call. `#away` does not, since it's
+    # simply a trigger action.
     #
-    # Also note that in this example, <tt>current_user</tt> is available because
-    # it was marked as an identifying attribute on the connection. All such
-    # identifiers will automatically create a delegation method of the same name
-    # on the channel instance.
+    # Also note that in this example, `current_user` is available because it was
+    # marked as an identifying attribute on the connection. All such identifiers
+    # will automatically create a delegation method of the same name on the channel
+    # instance.
     #
-    # == Rejecting subscription requests
+    # ## Rejecting subscription requests
     #
     # A channel can reject a subscription request in the #subscribed callback by
     # invoking the #reject method:
     #
-    #   class ChatChannel < ApplicationCable::Channel
-    #     def subscribed
-    #       @room = Chat::Room[params[:room_number]]
-    #       reject unless current_user.can_access?(@room)
+    #     class ChatChannel < ApplicationCable::Channel
+    #       def subscribed
+    #         @room = Chat::Room[params[:room_number]]
+    #         reject unless current_user.can_access?(@room)
+    #       end
     #     end
-    #   end
     #
-    # In this example, the subscription will be rejected if the
-    # <tt>current_user</tt> does not have access to the chat room. On the
-    # client-side, the <tt>Channel#rejected</tt> callback will get invoked when
-    # the server rejects the subscription request.
+    # In this example, the subscription will be rejected if the `current_user` does
+    # not have access to the chat room. On the client-side, the `Channel#rejected`
+    # callback will get invoked when the server rejects the subscription request.
     class Base
       include Callbacks
       include PeriodicTimers
@@ -109,14 +119,13 @@ module ActionCable
       delegate :logger, to: :connection
 
       class << self
-        # A list of method names that should be considered actions. This
-        # includes all public instance methods on a channel, less
-        # any internal methods (defined on Base), adding back in
-        # any methods that are internal, but still exist on the class
-        # itself.
+        # A list of method names that should be considered actions. This includes all
+        # public instance methods on a channel, less any internal methods (defined on
+        # Base), adding back in any methods that are internal, but still exist on the
+        # class itself.
         #
-        # ==== Returns
-        # * <tt>Set</tt> - A set of all methods that should be considered actions.
+        # #### Returns
+        # *   `Set` - A set of all methods that should be considered actions.
         def action_methods
           @action_methods ||= begin
             # All public instance methods of this class, including ancestors
@@ -130,9 +139,9 @@ module ActionCable
         end
 
         private
-          # action_methods are cached and there is sometimes need to refresh
-          # them. ::clear_action_methods! allows you to do that, so next time
-          # you run action_methods, they will be recalculated.
+          # action_methods are cached and there is sometimes need to refresh them.
+          # ::clear_action_methods! allows you to do that, so next time you run
+          # action_methods, they will be recalculated.
           def clear_action_methods! # :doc:
             @action_methods = nil
           end
@@ -161,9 +170,9 @@ module ActionCable
         delegate_connection_identifiers
       end
 
-      # Extract the action name from the passed data and process it via the channel. The process will ensure
-      # that the action requested is a public method on the channel declared by the user (so not one of the callbacks
-      # like #subscribed).
+      # Extract the action name from the passed data and process it via the channel.
+      # The process will ensure that the action requested is a public method on the
+      # channel declared by the user (so not one of the callbacks like #subscribed).
       def perform_action(data)
         action = extract_action(data)
 
@@ -177,8 +186,8 @@ module ActionCable
         end
       end
 
-      # This method is called after subscription has been added to the connection
-      # and confirms or rejects the subscription.
+      # This method is called after subscription has been added to the connection and
+      # confirms or rejects the subscription.
       def subscribe_to_channel
         run_callbacks :subscribe do
           subscribed
@@ -188,8 +197,9 @@ module ActionCable
         ensure_confirmation_sent
       end
 
-      # Called by the cable connection when it's cut, so the channel has a chance to cleanup with callbacks.
-      # This method is not intended to be called directly by the user. Instead, override the #unsubscribed callback.
+      # Called by the cable connection when it's cut, so the channel has a chance to
+      # 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:
         run_callbacks :unsubscribe do
           unsubscribed
@@ -197,20 +207,22 @@ module ActionCable
       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 subscriber.
+        # 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
+        # subscriber.
         def subscribed # :doc:
           # Override in subclasses
         end
 
-        # Called once a consumer has cut its cable connection. Can be used for cleaning up connections or marking
-        # users as offline or the like.
+        # Called once a consumer has cut its cable connection. Can be used for cleaning
+        # up connections or marking users as offline or the like.
         def unsubscribed # :doc:
           # Override in subclasses
         end
 
-        # Transmit a hash of data to the subscriber. The hash will automatically be wrapped in a JSON envelope with
-        # the proper channel identifier marked as the recipient.
+        # Transmit a hash of data to the subscriber. The hash will automatically be
+        # wrapped in a JSON envelope with the proper channel identifier marked as the
+        # recipient.
         def transmit(data, via: nil) # :doc:
           logger.debug do
             status = "#{self.class.name} transmitting #{data.inspect.truncate(300)}"

data/lib/action_cable/channel/broadcasting.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 require "active_support/core_ext/object/to_param"
 
 module ActionCable
@@ -7,36 +9,41 @@ module ActionCable
     module Broadcasting
       extend ActiveSupport::Concern
 
-      included do
-        delegate :broadcasting_for, :broadcast_to, to: :class
-      end
-
       module ClassMethods
-        # Broadcast a hash to a unique broadcasting for this <tt>model</tt> in this channel.
+        # 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)
         end
 
-        # Returns a unique broadcasting identifier for this <tt>model</tt> in this channel:
+        # Returns a unique broadcasting identifier for this `model` in this channel:
         #
-        #    CommentsChannel.broadcasting_for("all") # => "comments:all"
+        #     CommentsChannel.broadcasting_for("all") # => "comments:all"
         #
-        # You can pass any object as a target (e.g. Active Record model), and it
-        # would be serialized into a string under the hood.
+        # You can pass any object 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 ])
         end
 
-        def serialize_broadcasting(object) # :nodoc:
-          case
-          when object.is_a?(Array)
-            object.map { |m| serialize_broadcasting(m) }.join(":")
-          when object.respond_to?(:to_gid_param)
-            object.to_gid_param
-          else
-            object.to_param
+        private
+          def serialize_broadcasting(object) # :nodoc:
+            case
+            when object.is_a?(Array)
+              object.map { |m| serialize_broadcasting(m) }.join(":")
+            when object.respond_to?(:to_gid_param)
+              object.to_gid_param
+            else
+              object.to_param
+            end
           end
-        end
+      end
+
+      def broadcasting_for(model)
+        self.class.broadcasting_for(model)
+      end
+
+      def broadcast_to(model, message)
+        self.class.broadcast_to(model, message)
       end
     end
   end