actioncable 7.0.7.2 → 7.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0b157e84c123c5c09c4d01ae257a2be69f755aa995a4fc124be0ff78d51c3f2
-  data.tar.gz: fad558caa312b76636d2bc9fe58dfe59a6cd233b83a5e59884c3a146b2a67627
+  metadata.gz: aa223855ae2af9c70e27271ec03c83d04e21c180c062f471d7bc388636e7e90a
+  data.tar.gz: f0188f07302139302eafc4cb12f2e7dd79d9391cde0079f6192dbed309278f07
 SHA512:
-  metadata.gz: f331494a48497d24d09b299bae351fc4d43b433c8a5a7453ac52be0ea26440172173b2a9c96189558058f5181d8b4093deac7b87f873cb64c7f1eb19d32cb8c2
-  data.tar.gz: 98c7611eac2cec92bf2e6e2dd1b03794d5a136c5b45d74472abe3b0b93132e93c519ada3dd8d7e0de3d740dd8e100500367abf769c27ab08859cc2be936f5ca9
+  metadata.gz: 1c2d900a7b3a882b196b3b4ae2b490d4ab2335add9f250b869201bcff68adebd0dbc5bd8e63d437be9db7844dd0b866ce803774ff2592b87282018dd9faedfe2
+  data.tar.gz: be12b84cff9a8e0b089e75a97071a8e030ca10cd00fbe7d5f77e22824a583109f3ccf9ec77474cbd81fe33b5ae2c91541185657ac810e041590eaef3e40cc5cc

data/CHANGELOG.md

@@ -1,174 +1,121 @@
-## Rails 7.0.7.2 (August 22, 2023) ##
+## Rails 7.1.1 (October 11, 2023) ##
 
 *   No changes.
 
 
-## Rails 7.0.7.1 (August 22, 2023) ##
+## Rails 7.1.0 (October 05, 2023) ##
 
 *   No changes.
 
 
-## Rails 7.0.7 (August 09, 2023) ##
+## Rails 7.1.0.rc2 (October 01, 2023) ##
 
 *   No changes.
 
 
-## Rails 7.0.6 (June 29, 2023) ##
-
-*   Fix Action Cable Redis configuration with sentinels.
-
-    *Dmitriy Ivliev*
-
-
-## Rails 7.0.5.1 (June 26, 2023) ##
+## Rails 7.1.0.rc1 (September 27, 2023) ##
 
 *   No changes.
 
 
-## Rails 7.0.5 (May 24, 2023) ##
-
-*   Restore Action Cable Redis pub/sub listener on connection failure.
-
-    *Vladimir Dementyev*
+## Rails 7.1.0.beta1 (September 13, 2023) ##
 
+*   Add a `@server` instance variable referencing the `ActionCable.server`
+    singleton to `ActionCable::Channel::ConnectionStub`
 
-## Rails 7.0.4.3 (March 13, 2023) ##
+    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`).
 
-*   No changes.
+    *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.
 
-## Rails 7.0.4.2 (January 24, 2023) ##
-
-*   No changes.
+    *Joé Dupuis*
 
+*   Introduce the `capture_broadcasts` test helper.
 
-## Rails 7.0.4.1 (January 17, 2023) ##
+    Returns all messages broadcast in a block.
 
-*   No changes.
-
-
-## Rails 7.0.4 (September 09, 2022) ##
-
-*   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.
+    ```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`
 
-## Rails 7.0.3.1 (July 12, 2022) ##
-
-*   No changes.
-
-
-## Rails 7.0.3 (May 09, 2022) ##
-
-*   No changes.
-
-
-## Rails 7.0.2.4 (April 26, 2022) ##
-
-*   No changes.
-
-
-## Rails 7.0.2.3 (March 08, 2022) ##
-
-*   No changes.
-
-
-## Rails 7.0.2.2 (February 11, 2022) ##
-
-*   No changes.
-
+    *Stéphane Robino*
 
-## Rails 7.0.2.1 (February 11, 2022) ##
-
-*   No changes.
+*   The Action Cable client now supports subprotocols to allow passing arbitrary data
+    to the server.
 
+    ```js
+    const consumer = ActionCable.createConsumer()
 
-## Rails 7.0.2 (February 08, 2022) ##
+    consumer.addSubProtocol('custom-protocol')
 
-*   No changes.
+    consumer.connect()
+    ```
 
+    See also:
 
-## Rails 7.0.1 (January 06, 2022) ##
-
-*   No changes.
+    * https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API/Writing_WebSocket_servers#subprotocols
 
+    *Guillaume Hain*
 
-## Rails 7.0.0 (December 15, 2021) ##
-
-*   No changes.
-
-
-## Rails 7.0.0.rc3 (December 14, 2021) ##
-
-*   No changes.
-
-
-## Rails 7.0.0.rc2 (December 14, 2021) ##
-
-*   No changes.
-
-## Rails 7.0.0.rc1 (December 06, 2021) ##
-
-*   The Action Cable client now ensures successful channel subscriptions:
-
-    * The client maintains a set of pending subscriptions until either
-      the server confirms the subscription or the channel is torn down.
-    * Rectifies the race condition where an unsubscribe is rapidly followed
-      by a subscribe (on the same channel identifier) and the requests are
-      handled out of order by the ActionCable server, thereby ignoring the
-      subscribe command.
-
-    *Daniel Spinosa*
-
-
-## Rails 7.0.0.alpha2 (September 15, 2021) ##
-
-*   No changes.
+*   Redis pub/sub adapter now automatically reconnects when Redis connection is lost.
 
+    *Vladimir Dementyev*
 
-## Rails 7.0.0.alpha1 (September 15, 2021) ##
+*   The `connected()` callback can now take a `{reconnected}` parameter to differentiate
+    connections from reconnections.
 
-*   Compile ESM package that can be used directly in the browser as actioncable.esm.js.
+    ```js
+    import consumer from "./consumer"
 
-    *DHH*
+    consumer.subscriptions.create("ExampleChannel", {
+      connected({reconnected}) {
+        if (reconnected) {
+          ...
+        } else {
+          ...
+        }
+      }
+    })
+    ```
 
-*   Move action_cable.js to actioncable.js to match naming convention used for other Rails frameworks, and use JS console to communicate the deprecation.
+    *Mansa Keïta*
 
-    *DHH*
+*   The Redis adapter is now compatible with redis-rb 5.0
 
-*   Stop transpiling the UMD package generated as actioncable.js and drop the IE11 testing that relied on that.
+    Compatibility with redis-rb 3.x was dropped.
 
-    *DHH*
+    *Jean Boussier*
 
-*   Truncate broadcast logging messages.
+*   The Action Cable server is now mounted with `anchor: true`.
 
-    *J Smith*
+    This means that routes that also start with `/cable` will no longer clash with Action Cable.
 
-*   OpenSSL constants are now used for Digest computations.
+    *Alex Ghiculescu*
 
-    *Dirkjan Bussink*
+*   `ActionCable.server.remote_connections.where(...).disconnect` now sends `disconnect` message
+    before closing the connection with the reconnection strategy specified (defaults to `true`).
 
-*   The Action Cable client now includes safeguards to prevent a "thundering
-    herd" of client reconnects after server connectivity loss:
+    *Vladimir Dementyev*
 
-    * The client will wait a random amount between 1x and 3x of the stale
-      threshold after the server's last ping before making the first
-      reconnection attempt.
-    * Subsequent reconnection attempts now use exponential backoff instead of
-      logarithmic backoff.  To allow the delay between reconnection attempts to
-      increase slowly at first, the default exponentiation base is < 2.
-    * Random jitter is applied to each delay between reconnection attempts.
+*   Added command callbacks to `ActionCable::Connection::Base`.
 
-    *Jonathan Hefner*
+    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*
 
-Please check [6-1-stable](https://github.com/rails/rails/blob/6-1-stable/actioncable/CHANGELOG.md) for previous changes.
+Please check [7-0-stable](https://github.com/rails/rails/blob/7-0-stable/actioncable/CHANGELOG.md) for previous changes.

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2015-2022 Basecamp, LLC
+Copyright (c) 37signals LLC
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,13 +1,13 @@
-# Action Cable – Integrated WebSockets for Rails
+# Action Cable – Integrated WebSockets for \Rails
 
-Action Cable seamlessly integrates WebSockets with the rest of your Rails application.
+Action Cable seamlessly integrates WebSockets with the rest of your \Rails application.
 It allows for real-time features to be written in Ruby in the same style
-and form as the rest of your Rails application, while still being performant
+and form as the rest of your \Rails application, while still being performant
 and scalable. It's a full-stack offering that provides both a client-side
 JavaScript framework and a server-side Ruby framework. You have access to your full
 domain model written with Active Record or your ORM of choice.
 
-You can read more about Action Cable in the [Action Cable Overview](https://edgeguides.rubyonrails.org/action_cable_overview.html) guide.
+You can read more about Action Cable in the [Action Cable Overview](https://guides.rubyonrails.org/action_cable_overview.html) guide.
 
 ## Support
 

data/app/assets/javascripts/action_cable.js

@@ -121,7 +121,8 @@
     disconnect_reasons: {
       unauthorized: "unauthorized",
       invalid_request: "invalid_request",
-      server_restart: "server_restart"
+      server_restart: "server_restart",
+      remote: "remote"
     },
     default_mount_path: "/cable",
     protocols: [ "actioncable-v1-json", "actioncable-unsupported" ]
@@ -150,11 +151,12 @@
         logger.log(`Attempted to open WebSocket, but existing socket is ${this.getState()}`);
         return false;
       } else {
-        logger.log(`Opening WebSocket, current state is ${this.getState()}, subprotocols: ${protocols}`);
+        const socketProtocols = [ ...protocols, ...this.consumer.subprotocols || [] ];
+        logger.log(`Opening WebSocket, current state is ${this.getState()}, subprotocols: ${socketProtocols}`);
         if (this.webSocket) {
           this.uninstallEventHandlers();
         }
-        this.webSocket = new adapters.WebSocket(this.consumer.url, protocols);
+        this.webSocket = new adapters.WebSocket(this.consumer.url, socketProtocols);
         this.installEventHandlers();
         this.monitor.start();
         return true;
@@ -196,6 +198,9 @@
     isActive() {
       return this.isState("open", "connecting");
     }
+    triedToReconnect() {
+      return this.monitor.reconnectAttempts > 0;
+    }
     isProtocolSupported() {
       return indexOf.call(supportedProtocols, this.getProtocol()) >= 0;
     }
@@ -233,6 +238,9 @@
       const {identifier: identifier, message: message, reason: reason, reconnect: reconnect, type: type} = JSON.parse(event.data);
       switch (type) {
        case message_types.welcome:
+        if (this.triedToReconnect()) {
+          this.reconnectAttempted = true;
+        }
         this.monitor.recordConnect();
         return this.subscriptions.reload();
 
@@ -247,7 +255,16 @@
 
        case message_types.confirmation:
         this.subscriptions.confirmSubscription(identifier);
-        return this.subscriptions.notify(identifier, "connected");
+        if (this.reconnectAttempted) {
+          this.reconnectAttempted = false;
+          return this.subscriptions.notify(identifier, "connected", {
+            reconnected: true
+          });
+        } else {
+          return this.subscriptions.notify(identifier, "connected", {
+            reconnected: false
+          });
+        }
 
        case message_types.rejection:
         return this.subscriptions.reject(identifier);
@@ -427,6 +444,7 @@
       this._url = url;
       this.subscriptions = new Subscriptions(this);
       this.connection = new Connection(this);
+      this.subprotocols = [];
     }
     get url() {
       return createWebSocketURL(this._url);
@@ -447,6 +465,9 @@
         return this.connection.open();
       }
     }
+    addSubProtocol(subprotocol) {
+      this.subprotocols = [ ...this.subprotocols, subprotocol ];
+    }
   }
   function createWebSocketURL(url) {
     if (typeof url === "function") {

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

@@ -123,7 +123,8 @@ var INTERNAL = {
   disconnect_reasons: {
     unauthorized: "unauthorized",
     invalid_request: "invalid_request",
-    server_restart: "server_restart"
+    server_restart: "server_restart",
+    remote: "remote"
   },
   default_mount_path: "/cable",
   protocols: [ "actioncable-v1-json", "actioncable-unsupported" ]
@@ -156,11 +157,12 @@ class Connection {
       logger.log(`Attempted to open WebSocket, but existing socket is ${this.getState()}`);
       return false;
     } else {
-      logger.log(`Opening WebSocket, current state is ${this.getState()}, subprotocols: ${protocols}`);
+      const socketProtocols = [ ...protocols, ...this.consumer.subprotocols || [] ];
+      logger.log(`Opening WebSocket, current state is ${this.getState()}, subprotocols: ${socketProtocols}`);
       if (this.webSocket) {
         this.uninstallEventHandlers();
       }
-      this.webSocket = new adapters.WebSocket(this.consumer.url, protocols);
+      this.webSocket = new adapters.WebSocket(this.consumer.url, socketProtocols);
       this.installEventHandlers();
       this.monitor.start();
       return true;
@@ -202,6 +204,9 @@ class Connection {
   isActive() {
     return this.isState("open", "connecting");
   }
+  triedToReconnect() {
+    return this.monitor.reconnectAttempts > 0;
+  }
   isProtocolSupported() {
     return indexOf.call(supportedProtocols, this.getProtocol()) >= 0;
   }
@@ -241,6 +246,9 @@ Connection.prototype.events = {
     const {identifier: identifier, message: message, reason: reason, reconnect: reconnect, type: type} = JSON.parse(event.data);
     switch (type) {
      case message_types.welcome:
+      if (this.triedToReconnect()) {
+        this.reconnectAttempted = true;
+      }
       this.monitor.recordConnect();
       return this.subscriptions.reload();
 
@@ -255,7 +263,16 @@ Connection.prototype.events = {
 
      case message_types.confirmation:
       this.subscriptions.confirmSubscription(identifier);
-      return this.subscriptions.notify(identifier, "connected");
+      if (this.reconnectAttempted) {
+        this.reconnectAttempted = false;
+        return this.subscriptions.notify(identifier, "connected", {
+          reconnected: true
+        });
+      } else {
+        return this.subscriptions.notify(identifier, "connected", {
+          reconnected: false
+        });
+      }
 
      case message_types.rejection:
       return this.subscriptions.reject(identifier);
@@ -440,6 +457,7 @@ class Consumer {
     this._url = url;
     this.subscriptions = new Subscriptions(this);
     this.connection = new Connection(this);
+    this.subprotocols = [];
   }
   get url() {
     return createWebSocketURL(this._url);
@@ -460,6 +478,9 @@ class Consumer {
       return this.connection.open();
     }
   }
+  addSubProtocol(subprotocol) {
+    this.subprotocols = [ ...this.subprotocols, subprotocol ];
+  }
 }
 
 function createWebSocketURL(url) {

data/app/assets/javascripts/actioncable.js

@@ -121,7 +121,8 @@
     disconnect_reasons: {
       unauthorized: "unauthorized",
       invalid_request: "invalid_request",
-      server_restart: "server_restart"
+      server_restart: "server_restart",
+      remote: "remote"
     },
     default_mount_path: "/cable",
     protocols: [ "actioncable-v1-json", "actioncable-unsupported" ]
@@ -150,11 +151,12 @@
         logger.log(`Attempted to open WebSocket, but existing socket is ${this.getState()}`);
         return false;
       } else {
-        logger.log(`Opening WebSocket, current state is ${this.getState()}, subprotocols: ${protocols}`);
+        const socketProtocols = [ ...protocols, ...this.consumer.subprotocols || [] ];
+        logger.log(`Opening WebSocket, current state is ${this.getState()}, subprotocols: ${socketProtocols}`);
         if (this.webSocket) {
           this.uninstallEventHandlers();
         }
-        this.webSocket = new adapters.WebSocket(this.consumer.url, protocols);
+        this.webSocket = new adapters.WebSocket(this.consumer.url, socketProtocols);
         this.installEventHandlers();
         this.monitor.start();
         return true;
@@ -196,6 +198,9 @@
     isActive() {
       return this.isState("open", "connecting");
     }
+    triedToReconnect() {
+      return this.monitor.reconnectAttempts > 0;
+    }
     isProtocolSupported() {
       return indexOf.call(supportedProtocols, this.getProtocol()) >= 0;
     }
@@ -233,6 +238,9 @@
       const {identifier: identifier, message: message, reason: reason, reconnect: reconnect, type: type} = JSON.parse(event.data);
       switch (type) {
        case message_types.welcome:
+        if (this.triedToReconnect()) {
+          this.reconnectAttempted = true;
+        }
         this.monitor.recordConnect();
         return this.subscriptions.reload();
 
@@ -247,7 +255,16 @@
 
        case message_types.confirmation:
         this.subscriptions.confirmSubscription(identifier);
-        return this.subscriptions.notify(identifier, "connected");
+        if (this.reconnectAttempted) {
+          this.reconnectAttempted = false;
+          return this.subscriptions.notify(identifier, "connected", {
+            reconnected: true
+          });
+        } else {
+          return this.subscriptions.notify(identifier, "connected", {
+            reconnected: false
+          });
+        }
 
        case message_types.rejection:
         return this.subscriptions.reject(identifier);
@@ -427,6 +444,7 @@
       this._url = url;
       this.subscriptions = new Subscriptions(this);
       this.connection = new Connection(this);
+      this.subprotocols = [];
     }
     get url() {
       return createWebSocketURL(this._url);
@@ -447,6 +465,9 @@
         return this.connection.open();
       }
     }
+    addSubProtocol(subprotocol) {
+      this.subprotocols = [ ...this.subprotocols, subprotocol ];
+    }
   }
   function createWebSocketURL(url) {
     if (typeof url === "function") {

data/lib/action_cable/channel/base.rb

@@ -2,9 +2,12 @@
 
 require "set"
 require "active_support/rescuable"
+require "active_support/parameter_filter"
 
 module ActionCable
   module Channel
+    # = 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.
@@ -209,9 +212,11 @@ module ActionCable
         # 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:
-          status = "#{self.class.name} transmitting #{data.inspect.truncate(300)}"
-          status += " (via #{via})" if via
-          logger.debug(status)
+          logger.debug do
+            status = "#{self.class.name} transmitting #{data.inspect.truncate(300)}"
+            status += " (via #{via})" if via
+            status
+          end
 
           payload = { channel_class: self.class.name, data: data, via: via }
           ActiveSupport::Notifications.instrument("transmit.action_cable", payload) do
@@ -262,7 +267,7 @@ module ActionCable
         end
 
         def dispatch_action(action, data)
-          logger.info action_signature(action, data)
+          logger.debug action_signature(action, data)
 
           if method(action).arity == 1
             public_send action, data
@@ -275,12 +280,19 @@ module ActionCable
 
         def action_signature(action, data)
           (+"#{self.class.name}##{action}").tap do |signature|
-            if (arguments = data.except("action")).any?
+            arguments = data.except("action")
+
+            if arguments.any?
+              arguments = parameter_filter.filter(arguments)
               signature << "(#{arguments.inspect})"
             end
           end
         end
 
+        def parameter_filter
+          @parameter_filter ||= ActiveSupport::ParameterFilter.new(connection.config.filter_parameters)
+        end
+
         def transmit_subscription_confirmation
           unless subscription_confirmation_sent?
             logger.debug "#{self.class.name} is transmitting the subscription confirmation"

data/lib/action_cable/channel/broadcasting.rb

@@ -7,7 +7,9 @@ module ActionCable
     module Broadcasting
       extend ActiveSupport::Concern
 
-      delegate :broadcasting_for, :broadcast_to, to: :class
+      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.

data/lib/action_cable/channel/callbacks.rb

@@ -4,6 +4,34 @@ require "active_support/callbacks"
 
 module ActionCable
   module Channel
+    # = Action Cable \Channel \Callbacks
+    #
+    # Action Cable Channel provides callback hooks that are invoked during the
+    # life cycle of a channel:
+    #
+    # * {before_subscribe}[rdoc-ref:ClassMethods#before_subscribe]
+    # * {after_subscribe}[rdoc-ref:ClassMethods#after_subscribe] (aliased as
+    #   {on_subscribe}[rdoc-ref:ClassMethods#on_subscribe])
+    # * {before_unsubscribe}[rdoc-ref:ClassMethods#before_unsubscribe]
+    # * {after_unsubscribe}[rdoc-ref:ClassMethods#after_unsubscribe] (aliased as
+    #   {on_unsubscribe}[rdoc-ref:ClassMethods#on_unsubscribe])
+    #
+    # ==== Example
+    #
+    #   class ChatChannel < ApplicationCable::Channel
+    #     after_subscribe :send_welcome_message, unless: :subscription_rejected?
+    #     after_subscribe :track_subscription
+    #
+    #     private
+    #       def send_welcome_message
+    #         broadcast_to(...)
+    #       end
+    #
+    #       def track_subscription
+    #         # ...
+    #       end
+    #   end
+    #
     module Callbacks
       extend  ActiveSupport::Concern
       include ActiveSupport::Callbacks
@@ -18,6 +46,15 @@ module ActionCable
           set_callback(:subscribe, :before, *methods, &block)
         end
 
+        # This callback will be triggered after the Base#subscribed method is
+        # called, even if the subscription was rejected with the Base#reject
+        # method.
+        #
+        # To trigger the callback only on successful subscriptions, use the
+        # Base#subscription_rejected? method:
+        #
+        #   after_subscribe :my_method, unless: :subscription_rejected?
+        #
         def after_subscribe(*methods, &block)
           set_callback(:subscribe, :after, *methods, &block)
         end

data/lib/action_cable/channel/naming.rb

@@ -18,8 +18,10 @@ module ActionCable
         end
       end
 
-      # Delegates to the class's ::channel_name.
-      delegate :channel_name, to: :class
+      included do
+        # Delegates to the class's ::channel_name.
+        delegate :channel_name, to: :class
+      end
     end
   end
 end

data/lib/action_cable/channel/streams.rb

@@ -2,6 +2,8 @@
 
 module ActionCable
   module Channel
+    # = Action Cable \Channel \Streams
+    #
     # Streams allow channels to route broadcastings to the subscriber. A broadcasting is, as discussed elsewhere, a pubsub queue where any data
     # placed into it is automatically sent to the clients that are connected at that time. It's purely an online queue, though. If you're not
     # streaming a broadcasting at the very moment it sends out an update, you will not get that update, even if you connect after it has been sent.