@rails/actioncable 7.0.8 → 7.1.0-beta1

package/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
 

package/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") {

package/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) {

package/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") {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rails/actioncable",
-  "version": "7.0.8",
+  "version": "7.1.0-beta1",
   "description": "WebSocket framework for Ruby on Rails.",
   "module": "app/assets/javascripts/actioncable.esm.js",
   "main": "app/assets/javascripts/actioncable.js",

package/src/connection.js

@@ -33,9 +33,10 @@ 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
@@ -81,6 +82,10 @@ class Connection {
     return this.isState("open", "connecting")
   }
 
+  triedToReconnect() {
+    return this.monitor.reconnectAttempts > 0
+  }
+
   // Private
 
   isProtocolSupported() {
@@ -125,6 +130,9 @@ Connection.prototype.events = {
     const {identifier, message, reason, reconnect, type} = JSON.parse(event.data)
     switch (type) {
       case message_types.welcome:
+        if (this.triedToReconnect()) {
+          this.reconnectAttempted = true
+        }
         this.monitor.recordConnect()
         return this.subscriptions.reload()
       case message_types.disconnect:
@@ -134,7 +142,12 @@ Connection.prototype.events = {
         return this.monitor.recordPing()
       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)
       default:

package/src/consumer.js

@@ -32,6 +32,7 @@ export default class Consumer {
     this._url = url
     this.subscriptions = new Subscriptions(this)
     this.connection = new Connection(this)
+    this.subprotocols = []
   }
 
   get url() {
@@ -55,6 +56,10 @@ export default class Consumer {
       return this.connection.open()
     }
   }
+
+  addSubProtocol(subprotocol) {
+    this.subprotocols = [...this.subprotocols, subprotocol]
+  }
 }
 
 export function createWebSocketURL(url) {

package/src/internal.js

@@ -9,7 +9,8 @@ export default {
   "disconnect_reasons": {
     "unauthorized": "unauthorized",
     "invalid_request": "invalid_request",
-    "server_restart": "server_restart"
+    "server_restart": "server_restart",
+    "remote": "remote"
   },
   "default_mount_path": "/cable",
   "protocols": [