@rails/actioncable 6.0.2 → 7.1.2

package/src/consumer.js

@@ -6,7 +6,7 @@ import Subscriptions from "./subscriptions"
 // The Consumer instance is also the gateway to establishing subscriptions to desired channels through the #createSubscription
 // method.
 //
-// The following example shows how this can be setup:
+// The following example shows how this can be set up:
 //
 //   App = {}
 //   App.cable = ActionCable.createConsumer("ws://example.com/accounts/1")
@@ -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/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/index_with_name_deprecation.js

@@ -0,0 +1,2 @@
+export * from "./index"
+console.log("DEPRECATION: action_cable.js has been renamed to actioncable.js – please update your reference before Rails 8")

package/src/internal.js

@@ -0,0 +1,20 @@
+export default {
+  "message_types": {
+    "welcome": "welcome",
+    "disconnect": "disconnect",
+    "ping": "ping",
+    "confirmation": "confirm_subscription",
+    "rejection": "reject_subscription"
+  },
+  "disconnect_reasons": {
+    "unauthorized": "unauthorized",
+    "invalid_request": "invalid_request",
+    "server_restart": "server_restart",
+    "remote": "remote"
+  },
+  "default_mount_path": "/cable",
+  "protocols": [
+    "actioncable-v1-json",
+    "actioncable-unsupported"
+  ]
+}

package/src/logger.js

@@ -1,5 +1,17 @@
 import adapters from "./adapters"
 
+// The logger is disabled by default. You can enable it with:
+//
+//   ActionCable.logger.enabled = true
+//
+//   Example:
+//
+//   import * as ActionCable from '@rails/actioncable'
+//
+//   ActionCable.logger.enabled = true
+//   ActionCable.logger.log('Connection Established.')
+//
+
 export default {
   log(...messages) {
     if (this.enabled) {

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,7 +1,10 @@
 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
-// us ActionCable.Subscriptions#create, and it should be called through the consumer like so:
+// Collection class for creating (and internally managing) channel subscriptions.
+// The only method intended to be triggered by the user is ActionCable.Subscriptions#create,
+// and it should be called through the consumer like so:
 //
 //   App = {}
 //   App.cable = ActionCable.createConsumer("ws://example.com/accounts/1")
@@ -12,6 +15,7 @@ import Subscription from "./subscription"
 export default class Subscriptions {
   constructor(consumer) {
     this.consumer = consumer
+    this.guarantor = new SubscriptionGuarantor(this)
     this.subscriptions = []
   }
 
@@ -28,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
   }
 
@@ -49,6 +53,7 @@ export default class Subscriptions {
   }
 
   forget(subscription) {
+    this.guarantor.forget(subscription)
     this.subscriptions = (this.subscriptions.filter((s) => s !== subscription))
     return subscription
   }
@@ -59,7 +64,7 @@ export default class Subscriptions {
 
   reload() {
     return this.subscriptions.map((subscription) =>
-      this.sendCommand(subscription, "subscribe"))
+      this.subscribe(subscription))
   }
 
   notifyAll(callbackName, ...args) {
@@ -79,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,179 +0,0 @@
-## Rails 6.0.2 (December 13, 2019) ##
-
-*   No changes.
-
-
-## Rails 6.0.1 (November 5, 2019) ##
-
-*   No changes.
-
-
-## Rails 6.0.0 (August 16, 2019) ##
-
-*   No changes.
-
-
-## Rails 6.0.0.rc2 (July 22, 2019) ##
-
-*   No changes.
-
-
-## Rails 6.0.0.rc1 (April 24, 2019) ##
-
-*   No changes.
-
-
-## Rails 6.0.0.beta3 (March 11, 2019) ##
-
-*   No changes.
-
-
-## Rails 6.0.0.beta2 (February 25, 2019) ##
-
-*   PostgreSQL subscription adapters now support `channel_prefix` option in cable.yml
-
-    Avoids channel name collisions when multiple apps use the same database for Action Cable.
-
-    *Vladimir Dementyev*
-
-*   Allow passing custom configuration to `ActionCable::Server::Base`.
-
-    You can now create a standalone Action Cable server with a custom configuration
-    (e.g. to run it in isolation from the default one):
-
-    ```ruby
-    config = ActionCable::Server::Configuration.new
-    config.cable = { adapter: "redis", channel_prefix: "custom_" }
-
-    CUSTOM_CABLE = ActionCable::Server::Base.new(config: config)
-    ```
-
-    Then you can mount it in the `routes.rb` file:
-
-    ```ruby
-    Rails.application.routes.draw do
-      mount CUSTOM_CABLE => "/custom_cable"
-      # ...
-    end
-    ```
-
-    *Vladimir Dementyev*
-
-*   Add `:action_cable_connection` and `:action_cable_channel` load hooks.
-
-    You can use them to extend `ActionCable::Connection::Base` and `ActionCable::Channel::Base`
-    functionality:
-
-    ```ruby
-    ActiveSupport.on_load(:action_cable_channel) do
-      # do something in the context of ActionCable::Channel::Base
-    end
-    ```
-
-    *Vladimir Dementyev*
-
-*   Add `Channel::Base#broadcast_to`.
-
-    You can now call `broadcast_to` within a channel action, which equals to
-    the `self.class.broadcast_to`.
-
-    *Vladimir Dementyev*
-
-*   Make `Channel::Base.broadcasting_for` a public API.
-
-    You can use `.broadcasting_for` to generate a unique stream identifier within
-    a channel for the specified target (e.g. Active Record model):
-
-    ```ruby
-    ChatChannel.broadcasting_for(model) # => "chat:<model.to_gid_param>"
-    ```
-
-    *Vladimir Dementyev*
-
-
-## Rails 6.0.0.beta1 (January 18, 2019) ##
-
-*   [Rename npm package](https://github.com/rails/rails/pull/34905) from
-    [`actioncable`](https://www.npmjs.com/package/actioncable) to
-    [`@rails/actioncable`](https://www.npmjs.com/package/@rails/actioncable).
-
-    *Javan Makhmali*
-
-*   Merge [`action-cable-testing`](https://github.com/palkan/action-cable-testing) to Rails.
-
-    *Vladimir Dementyev*
-
-*   The JavaScript WebSocket client will no longer try to reconnect
-    when you call `reject_unauthorized_connection` on the connection.
-
-    *Mick Staugaard*
-
-*   `ActionCable.Connection#getState` now references the configurable
-    `ActionCable.adapters.WebSocket` property rather than the `WebSocket` global
-    variable, matching the behavior of `ActionCable.Connection#open`.
-
-    *Richard Macklin*
-
-*   The ActionCable javascript package has been converted from CoffeeScript
-    to ES2015, and we now publish the source code in the npm distribution.
-
-    This allows ActionCable users to depend on the javascript source code
-    rather than the compiled code, which can produce smaller javascript bundles.
-
-    This change includes some breaking changes to optional parts of the
-    ActionCable javascript API:
-
-    - Configuration of the WebSocket adapter and logger adapter have been moved
-      from properties of `ActionCable` to properties of `ActionCable.adapters`.
-      If you are currently configuring these adapters you will need to make
-      these changes when upgrading:
-
-      ```diff
-      -    ActionCable.WebSocket = MyWebSocket
-      +    ActionCable.adapters.WebSocket = MyWebSocket
-      ```
-      ```diff
-      -    ActionCable.logger = myLogger
-      +    ActionCable.adapters.logger = myLogger
-      ```
-
-    - The `ActionCable.startDebugging()` and `ActionCable.stopDebugging()`
-      methods have been removed and replaced with the property
-      `ActionCable.logger.enabled`. If you are currently using these methods you
-      will need to make these changes when upgrading:
-
-      ```diff
-      -    ActionCable.startDebugging()
-      +    ActionCable.logger.enabled = true
-      ```
-      ```diff
-      -    ActionCable.stopDebugging()
-      +    ActionCable.logger.enabled = false
-      ```
-
-    *Richard Macklin*
-
-*   Add `id` option to redis adapter so now you can distinguish
-    ActionCable's redis connections among others. Also, you can set
-    custom id in options.
-
-    Before:
-    ```
-    $ redis-cli client list
-    id=669 addr=127.0.0.1:46442 fd=8 name= age=18 ...
-    ```
-
-    After:
-    ```
-    $ redis-cli client list
-    id=673 addr=127.0.0.1:46516 fd=8 name=ActionCable-PID-19413 age=2 ...
-    ```
-
-    *Ilia Kasianenko*
-
-*   Rails 6 requires Ruby 2.5.0 or newer.
-
-    *Jeremy Daer*, *Kasper Timm Hansen*
-
-
-Please check [5-2-stable](https://github.com/rails/rails/blob/5-2-stable/actioncable/CHANGELOG.md) for previous changes.