actioncable 7.0.8.7 → 7.2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa0a11a4b00865a2e2481e468e1f1a56b8b99c832346140a858f2b62ba11623c
-  data.tar.gz: 01a1a32f910f093d4ee8c89342f99fae7b9fbdf8a20cb6ef17fe591976d46113
+  metadata.gz: 720238323d1411f0913bcc9b65ac89d955c4fc4e708bbab5b5dd1c0c47c4cf00
+  data.tar.gz: 10a5cd05102adeda05b151a39c40183bc55c2c55c2c63dca5a13d642fcf49f58
 SHA512:
-  metadata.gz: b61ba77c56d8a85549ae61dbe2d696494aa9f45fe1a4444a4060285c773b6b6287ca2624451f79196145ec0180fa7814ec3ec4b378f02f5721255486e1c4db86
-  data.tar.gz: d8b27954d769da5af3ab1eb6d6f19712df5efa35838d64e6a42d5f6bc9e1993bd14cc80bdfeb7bf9353b1d7437c53a8975b9c320f9117ffe71125f70284806c3
+  metadata.gz: '0639a73b1efc8078fe167814911d5694e76781f618ac7fe5bb34ae8448ab495b60f598a76c6a0e8d7c9f45d9674d19564ad14eaae0ccaaf1f75b441d1318d7c8'
+  data.tar.gz: 4988a92b2c683bc86c28d60be1d2f92d1efe36bc5d33f814da55ac7328af60597fb0313321aa663b6d5632ecd565661725d12bf1238fa48a153b18d538e6e08e

data/CHANGELOG.md

@@ -1,214 +1,68 @@
-## Rails 7.0.8.7 (December 10, 2024) ##
+## Rails 7.2.2.1 (December 10, 2024) ##
 
 *   No changes.
 
 
-## Rails 7.0.8.6 (October 23, 2024) ##
+## Rails 7.2.2 (October 30, 2024) ##
 
 *   No changes.
 
 
-## Rails 7.0.8.5 (October 15, 2024) ##
+## Rails 7.2.1.2 (October 23, 2024) ##
 
 *   No changes.
 
 
-## Rails 7.0.8.4 (June 04, 2024) ##
+## Rails 7.2.1.1 (October 15, 2024) ##
 
 *   No changes.
 
 
-## Rails 7.0.8.3 (May 17, 2024) ##
+## Rails 7.2.1 (August 22, 2024) ##
 
 *   No changes.
 
 
-## Rails 7.0.8.2 (May 16, 2024) ##
+## Rails 7.2.0 (August 09, 2024) ##
 
-*   No changes.
-
-
-## Rails 7.0.8.1 (February 21, 2024) ##
-
-*   No changes.
-
-
-## Rails 7.0.8 (September 09, 2023) ##
-
-*   No changes.
-
-
-## Rails 7.0.7.2 (August 22, 2023) ##
-
-*   No changes.
-
-
-## Rails 7.0.7.1 (August 22, 2023) ##
-
-*   No changes.
-
-
-## Rails 7.0.7 (August 09, 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) ##
-
-*   No changes.
-
-
-## Rails 7.0.5 (May 24, 2023) ##
-
-*   Restore Action Cable Redis pub/sub listener on connection failure.
-
-    *Vladimir Dementyev*
-
-
-## Rails 7.0.4.3 (March 13, 2023) ##
-
-*   No changes.
-
-
-## Rails 7.0.4.2 (January 24, 2023) ##
-
-*   No changes.
-
-
-## Rails 7.0.4.1 (January 17, 2023) ##
-
-*   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.
-
-    *Alex Ghiculescu*
-
-
-## 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.
-
-
-## Rails 7.0.2.1 (February 11, 2022) ##
-
-*   No changes.
-
-
-## Rails 7.0.2 (February 08, 2022) ##
-
-*   No changes.
-
-
-## Rails 7.0.1 (January 06, 2022) ##
-
-*   No changes.
-
-
-## 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.
-
-
-## Rails 7.0.0.alpha1 (September 15, 2021) ##
-
-*   Compile ESM package that can be used directly in the browser as actioncable.esm.js.
-
-    *DHH*
+*   Bring `ActionCable::Connection::TestCookieJar` in alignment with `ActionDispatch::Cookies::CookieJar` in regards to setting the cookie value.
 
-*   Move action_cable.js to actioncable.js to match naming convention used for other Rails frameworks, and use JS console to communicate the deprecation.
+    Before:
 
-    *DHH*
+    ```ruby
+    cookies[:foo] = { value: "bar" }
+    puts cookies[:foo] # => { value: "bar" }
+    ```
 
-*   Stop transpiling the UMD package generated as actioncable.js and drop the IE11 testing that relied on that.
+    After:
 
-    *DHH*
+    ```ruby
+    cookies[:foo] = { value: "bar" }
+    puts cookies[:foo] # => "bar"
+    ```
 
-*   Truncate broadcast logging messages.
+    *Justin Ko*
 
-    *J Smith*
+*   Record ping on every Action Cable message.
 
-*   OpenSSL constants are now used for Digest computations.
+    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.
 
-    *Dirkjan Bussink*
+    *yauhenininjia*
 
-*   The Action Cable client now includes safeguards to prevent a "thundering
-    herd" of client reconnects after server connectivity loss:
+*   Add two new assertion methods for Action Cable test cases: `assert_has_no_stream`
+    and `assert_has_no_stream_for`.
 
-    * 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.
+    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.
 
-    *Jonathan Hefner*
+    ```ruby
+    assert_has_no_stream "messages"
+    assert_has_no_stream_for User.find(42)
+    ```
 
+    *Sebastian Pöll*, *Junichi Sato*
 
-Please check [6-1-stable](https://github.com/rails/rails/blob/6-1-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/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

@@ -4,8 +4,8 @@
 })(this, (function(exports) {
   "use strict";
   var adapters = {
-    logger: self.console,
-    WebSocket: self.WebSocket
+    logger: typeof console !== "undefined" ? console : undefined,
+    WebSocket: typeof WebSocket !== "undefined" ? WebSocket : undefined
   };
   var logger = {
     log(...messages) {
@@ -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");
     }
@@ -121,7 +120,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 +150,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 +197,9 @@
     isActive() {
       return this.isState("open", "connecting");
     }
+    triedToReconnect() {
+      return this.monitor.reconnectAttempts > 0;
+    }
     isProtocolSupported() {
       return indexOf.call(supportedProtocols, this.getProtocol()) >= 0;
     }
@@ -231,8 +235,12 @@
         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()) {
+          this.reconnectAttempted = true;
+        }
         this.monitor.recordConnect();
         return this.subscriptions.reload();
 
@@ -243,11 +251,20 @@
         });
 
        case message_types.ping:
-        return this.monitor.recordPing();
+        return null;
 
        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

@@ -1,6 +1,6 @@
 var adapters = {
-  logger: self.console,
-  WebSocket: self.WebSocket
+  logger: typeof console !== "undefined" ? console : undefined,
+  WebSocket: typeof WebSocket !== "undefined" ? WebSocket : undefined
 };
 
 var logger = {
@@ -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");
   }
@@ -123,7 +122,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 +156,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 +203,9 @@ class Connection {
   isActive() {
     return this.isState("open", "connecting");
   }
+  triedToReconnect() {
+    return this.monitor.reconnectAttempts > 0;
+  }
   isProtocolSupported() {
     return indexOf.call(supportedProtocols, this.getProtocol()) >= 0;
   }
@@ -239,8 +243,12 @@ 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()) {
+        this.reconnectAttempted = true;
+      }
       this.monitor.recordConnect();
       return this.subscriptions.reload();
 
@@ -251,11 +259,20 @@ Connection.prototype.events = {
       });
 
      case message_types.ping:
-      return this.monitor.recordPing();
+      return null;
 
      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

@@ -4,8 +4,8 @@
 })(this, (function(exports) {
   "use strict";
   var adapters = {
-    logger: self.console,
-    WebSocket: self.WebSocket
+    logger: typeof console !== "undefined" ? console : undefined,
+    WebSocket: typeof WebSocket !== "undefined" ? WebSocket : undefined
   };
   var logger = {
     log(...messages) {
@@ -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");
     }
@@ -121,7 +120,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 +150,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 +197,9 @@
     isActive() {
       return this.isState("open", "connecting");
     }
+    triedToReconnect() {
+      return this.monitor.reconnectAttempts > 0;
+    }
     isProtocolSupported() {
       return indexOf.call(supportedProtocols, this.getProtocol()) >= 0;
     }
@@ -231,8 +235,12 @@
         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()) {
+          this.reconnectAttempted = true;
+        }
         this.monitor.recordConnect();
         return this.subscriptions.reload();
 
@@ -243,11 +251,20 @@
         });
 
        case message_types.ping:
-        return this.monitor.recordPing();
+        return null;
 
        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") {