@rails/actioncable 6.1.4 → 6.1.5

package/app/assets/javascripts/action_cable.js

@@ -291,6 +291,7 @@
         return this.monitor.recordPing();
 
        case message_types.confirmation:
+        this.subscriptions.confirmSubscription(identifier);
         return this.subscriptions.notify(identifier, "connected");
 
        case message_types.rejection:
@@ -360,10 +361,52 @@
     };
     return Subscription;
   }();
+  var SubscriptionGuarantor = function() {
+    function SubscriptionGuarantor(subscriptions) {
+      classCallCheck(this, SubscriptionGuarantor);
+      this.subscriptions = subscriptions;
+      this.pendingSubscriptions = [];
+    }
+    SubscriptionGuarantor.prototype.guarantee = function guarantee(subscription) {
+      if (this.pendingSubscriptions.indexOf(subscription) == -1) {
+        logger.log("SubscriptionGuarantor guaranteeing " + subscription.identifier);
+        this.pendingSubscriptions.push(subscription);
+      } else {
+        logger.log("SubscriptionGuarantor already guaranteeing " + subscription.identifier);
+      }
+      this.startGuaranteeing();
+    };
+    SubscriptionGuarantor.prototype.forget = function forget(subscription) {
+      logger.log("SubscriptionGuarantor forgetting " + subscription.identifier);
+      this.pendingSubscriptions = this.pendingSubscriptions.filter(function(s) {
+        return s !== subscription;
+      });
+    };
+    SubscriptionGuarantor.prototype.startGuaranteeing = function startGuaranteeing() {
+      this.stopGuaranteeing();
+      this.retrySubscribing();
+    };
+    SubscriptionGuarantor.prototype.stopGuaranteeing = function stopGuaranteeing() {
+      clearTimeout(this.retryTimeout);
+    };
+    SubscriptionGuarantor.prototype.retrySubscribing = function retrySubscribing() {
+      var _this = this;
+      this.retryTimeout = setTimeout(function() {
+        if (_this.subscriptions && typeof _this.subscriptions.subscribe === "function") {
+          _this.pendingSubscriptions.map(function(subscription) {
+            logger.log("SubscriptionGuarantor resubscribing " + subscription.identifier);
+            _this.subscriptions.subscribe(subscription);
+          });
+        }
+      }, 500);
+    };
+    return SubscriptionGuarantor;
+  }();
   var Subscriptions = function() {
     function Subscriptions(consumer) {
       classCallCheck(this, Subscriptions);
       this.consumer = consumer;
+      this.guarantor = new SubscriptionGuarantor(this);
       this.subscriptions = [];
     }
     Subscriptions.prototype.create = function create(channelName, mixin) {
@@ -378,7 +421,7 @@
       this.subscriptions.push(subscription);
       this.consumer.ensureActiveConnection();
       this.notify(subscription, "initialized");
-      this.sendCommand(subscription, "subscribe");
+      this.subscribe(subscription);
       return subscription;
     };
     Subscriptions.prototype.remove = function remove(subscription) {
@@ -397,6 +440,7 @@
       });
     };
     Subscriptions.prototype.forget = function forget(subscription) {
+      this.guarantor.forget(subscription);
       this.subscriptions = this.subscriptions.filter(function(s) {
         return s !== subscription;
       });
@@ -410,7 +454,7 @@
     Subscriptions.prototype.reload = function reload() {
       var _this2 = this;
       return this.subscriptions.map(function(subscription) {
-        return _this2.sendCommand(subscription, "subscribe");
+        return _this2.subscribe(subscription);
       });
     };
     Subscriptions.prototype.notifyAll = function notifyAll(callbackName) {
@@ -436,6 +480,18 @@
         return typeof subscription[callbackName] === "function" ? subscription[callbackName].apply(subscription, args) : undefined;
       });
     };
+    Subscriptions.prototype.subscribe = function subscribe(subscription) {
+      if (this.sendCommand(subscription, "subscribe")) {
+        this.guarantor.guarantee(subscription);
+      }
+    };
+    Subscriptions.prototype.confirmSubscription = function confirmSubscription(identifier) {
+      var _this4 = this;
+      logger.log("Subscription confirmed " + identifier);
+      this.findAll(identifier).map(function(subscription) {
+        return _this4.guarantor.forget(subscription);
+      });
+    };
     Subscriptions.prototype.sendCommand = function sendCommand(subscription, command) {
       var identifier = subscription.identifier;
       return this.consumer.send({
@@ -506,6 +562,7 @@
   exports.INTERNAL = INTERNAL;
   exports.Subscription = Subscription;
   exports.Subscriptions = Subscriptions;
+  exports.SubscriptionGuarantor = SubscriptionGuarantor;
   exports.adapters = adapters;
   exports.createWebSocketURL = createWebSocketURL;
   exports.logger = logger;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rails/actioncable",
-  "version": "6.1.4",
+  "version": "6.1.5",
   "description": "WebSocket framework for Ruby on Rails.",
   "main": "app/assets/javascripts/action_cable.js",
   "files": [

package/src/connection.js

@@ -132,6 +132,7 @@ Connection.prototype.events = {
       case message_types.ping:
         return this.monitor.recordPing()
       case message_types.confirmation:
+        this.subscriptions.confirmSubscription(identifier)
         return this.subscriptions.notify(identifier, "connected")
       case message_types.rejection:
         return this.subscriptions.reject(identifier)

package/src/index.js

@@ -4,6 +4,7 @@ import Consumer, { createWebSocketURL } from "./consumer"
 import INTERNAL from "./internal"
 import Subscription from "./subscription"
 import Subscriptions from "./subscriptions"
+import SubscriptionGuarantor from "./subscription_guarantor"
 import adapters from "./adapters"
 import logger from "./logger"
 
@@ -14,6 +15,7 @@ export {
   INTERNAL,
   Subscription,
   Subscriptions,
+  SubscriptionGuarantor,
   adapters,
   createWebSocketURL,
   logger,

package/src/subscription_guarantor.js

@@ -0,0 +1,50 @@
+import logger from "./logger"
+
+// Responsible for ensuring channel subscribe command is confirmed, retrying until confirmation is received.
+// Internal class, not intended for direct user manipulation.
+
+class SubscriptionGuarantor {
+  constructor(subscriptions) {
+    this.subscriptions = subscriptions
+    this.pendingSubscriptions = []
+  }
+
+  guarantee(subscription) {
+    if(this.pendingSubscriptions.indexOf(subscription) == -1){ 
+      logger.log(`SubscriptionGuarantor guaranteeing ${subscription.identifier}`)
+      this.pendingSubscriptions.push(subscription) 
+    }
+    else {
+      logger.log(`SubscriptionGuarantor already guaranteeing ${subscription.identifier}`)
+    }
+    this.startGuaranteeing()
+  }
+
+  forget(subscription) {
+    logger.log(`SubscriptionGuarantor forgetting ${subscription.identifier}`)
+    this.pendingSubscriptions = (this.pendingSubscriptions.filter((s) => s !== subscription))
+  }
+
+  startGuaranteeing() {
+    this.stopGuaranteeing()
+    this.retrySubscribing()
+  }
+  
+  stopGuaranteeing() {
+    clearTimeout(this.retryTimeout)
+  }
+
+  retrySubscribing() {
+    this.retryTimeout = setTimeout(() => {
+      if (this.subscriptions && typeof(this.subscriptions.subscribe) === "function") {
+        this.pendingSubscriptions.map((subscription) => {
+          logger.log(`SubscriptionGuarantor resubscribing ${subscription.identifier}`)
+          this.subscriptions.subscribe(subscription)
+        })
+      }
+    }
+    , 500)
+  }
+}
+
+export default SubscriptionGuarantor

package/src/subscriptions.js

@@ -1,4 +1,6 @@
 import Subscription from "./subscription"
+import SubscriptionGuarantor from "./subscription_guarantor"
+import logger from "./logger"
 
 // Collection class for creating (and internally managing) channel subscriptions.
 // The only method intended to be triggered by the user is ActionCable.Subscriptions#create,
@@ -13,6 +15,7 @@ import Subscription from "./subscription"
 export default class Subscriptions {
   constructor(consumer) {
     this.consumer = consumer
+    this.guarantor = new SubscriptionGuarantor(this)
     this.subscriptions = []
   }
 
@@ -29,7 +32,7 @@ export default class Subscriptions {
     this.subscriptions.push(subscription)
     this.consumer.ensureActiveConnection()
     this.notify(subscription, "initialized")
-    this.sendCommand(subscription, "subscribe")
+    this.subscribe(subscription)
     return subscription
   }
 
@@ -50,6 +53,7 @@ export default class Subscriptions {
   }
 
   forget(subscription) {
+    this.guarantor.forget(subscription)
     this.subscriptions = (this.subscriptions.filter((s) => s !== subscription))
     return subscription
   }
@@ -60,7 +64,7 @@ export default class Subscriptions {
 
   reload() {
     return this.subscriptions.map((subscription) =>
-      this.sendCommand(subscription, "subscribe"))
+      this.subscribe(subscription))
   }
 
   notifyAll(callbackName, ...args) {
@@ -80,6 +84,18 @@ export default class Subscriptions {
       (typeof subscription[callbackName] === "function" ? subscription[callbackName](...args) : undefined))
   }
 
+  subscribe(subscription) {
+    if (this.sendCommand(subscription, "subscribe")) {
+      this.guarantor.guarantee(subscription)
+    }
+  }
+
+  confirmSubscription(identifier) {
+    logger.log(`Subscription confirmed ${identifier}`)
+    this.findAll(identifier).map((subscription) =>
+      this.guarantor.forget(subscription))
+  }
+
   sendCommand(subscription, command) {
     const {identifier} = subscription
     return this.consumer.send({command, identifier})

package/CHANGELOG.md

@@ -1,77 +0,0 @@
-## Rails 6.1.4 (June 24, 2021) ##
-
-*   Fix `ArgumentError` with ruby 3.0 on `RemoteConnection#disconnect`.
-
-    *Vladislav*
-
-
-## Rails 6.1.3.2 (May 05, 2021) ##
-
-*   No changes.
-
-
-## Rails 6.1.3.1 (March 26, 2021) ##
-
-*   No changes.
-
-
-## Rails 6.1.3 (February 17, 2021) ##
-
-*   No changes.
-
-
-## Rails 6.1.2.1 (February 10, 2021) ##
-
-*   No changes.
-
-
-## Rails 6.1.2 (February 09, 2021) ##
-
-*   No changes.
-
-
-## Rails 6.1.1 (January 07, 2021) ##
-
-*   No changes.
-
-
-## Rails 6.1.0 (December 09, 2020) ##
-
-*   `ActionCable::Connection::Base` now allows intercepting unhandled exceptions
-    with `rescue_from` before they are logged, which is useful for error reporting
-    tools and other integrations.
-
-    *Justin Talbott*
-
-*   Add `ActionCable::Channel#stream_or_reject_for` to stream if record is present, otherwise reject the connection
-
-    *Atul Bhosale*
-
-*   Add `ActionCable::Channel#stop_stream_from` and `#stop_stream_for` to unsubscribe from a specific stream.
-
-    *Zhang Kang*
-
-*   Add PostgreSQL subscription connection identificator.
-
-    Now you can distinguish Action Cable PostgreSQL subscription connections among others.
-    Also, you can set custom `id` in `cable.yml` configuration.
-
-    ```sql
-    SELECT application_name FROM pg_stat_activity;
-    /*
-        application_name
-    ------------------------
-    psql
-    ActionCable-PID-42
-    (2 rows)
-    */
-    ```
-
-    *Sergey Ponomarev*
-
-*   Subscription confirmations and rejections are now logged at the `DEBUG` level instead of `INFO`.
-
-    *DHH*
-
-
-Please check [6-0-stable](https://github.com/rails/rails/blob/6-0-stable/actioncable/CHANGELOG.md) for previous changes.