@rails/actioncable 6.0.4 → 6.1.1

package/CHANGELOG.md

@@ -1,239 +1,45 @@
-## Rails 6.0.4 (June 15, 2021) ##
+## Rails 6.1.1 (January 07, 2021) ##
 
 *   No changes.
 
 
-## Rails 6.0.3.7 (May 05, 2021) ##
-
-*   No changes.
-
-
-## Rails 6.0.3.6 (May 04, 2021) ##
-
-*   No changes.
-
-
-## Rails 6.0.3.6 (March 26, 2021) ##
-
-*   No changes.
-
-
-## Rails 6.0.3.5 (February 10, 2021) ##
-
-*   No changes.
-
-
-## Rails 6.0.3.4 (October 07, 2020) ##
-
-*   No changes.
-
-
-## Rails 6.0.3.3 (September 09, 2020) ##
-
-*   No changes.
-
-
-## Rails 6.0.3.2 (June 17, 2020) ##
-
-*   No changes.
-
-
-## Rails 6.0.3.1 (May 18, 2020) ##
-
-*   No changes.
-
-
-## Rails 6.0.3 (May 06, 2020) ##
-
-*   No changes.
-
-
-## Rails 6.0.2.2 (March 19, 2020) ##
-
-*   No changes.
-
-
-## Rails 6.0.2.1 (December 18, 2019) ##
-
-*   No changes.
-
-
-## 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.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.
 
-## Rails 6.0.0.rc2 (July 22, 2019) ##
+    *Justin Talbott*
 
-*   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
-    ```
+*   Add `ActionCable::Channel#stream_or_reject_for` to stream if record is present, otherwise reject the connection
 
-    *Vladimir Dementyev*
+    *Atul Bhosale*
 
-*   Add `Channel::Base#broadcast_to`.
+*   Add `ActionCable::Channel#stop_stream_from` and `#stop_stream_for` to unsubscribe from a specific stream.
 
-    You can now call `broadcast_to` within a channel action, which equals to
-    the `self.class.broadcast_to`.
+    *Zhang Kang*
 
-    *Vladimir Dementyev*
+*   Add PostgreSQL subscription connection identificator.
 
-*   Make `Channel::Base.broadcasting_for` a public API.
+    Now you can distinguish Action Cable PostgreSQL subscription connections among others.
+    Also, you can set custom `id` in `cable.yml` configuration.
 
-    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 ...
+    ```sql
+    SELECT application_name FROM pg_stat_activity;
+    /*
+        application_name
+    ------------------------
+    psql
+    ActionCable-PID-42
+    (2 rows)
+    */
     ```
 
-    *Ilia Kasianenko*
+    *Sergey Ponomarev*
 
-*   Rails 6 requires Ruby 2.5.0 or newer.
+*   Subscription confirmations and rejections are now logged at the `DEBUG` level instead of `INFO`.
 
-    *Jeremy Daer*, *Kasper Timm Hansen*
+    *DHH*
 
 
-Please check [5-2-stable](https://github.com/rails/rails/blob/5-2-stable/actioncable/CHANGELOG.md) for previous changes.
+Please check [6-0-stable](https://github.com/rails/rails/blob/6-0-stable/actioncable/CHANGELOG.md) for previous changes.

package/app/assets/javascripts/action_cable.js

@@ -135,7 +135,7 @@
       if (document.visibilityState === "visible") {
         setTimeout(function() {
           if (_this2.connectionIsStale() || !_this2.connection.isOpen()) {
-            logger.log("ConnectionMonitor reopening stale connection on visibilitychange. visbilityState = " + document.visibilityState);
+            logger.log("ConnectionMonitor reopening stale connection on visibilitychange. visibilityState = " + document.visibilityState);
             _this2.connection.reopen();
           }
         }, 200);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rails/actioncable",
-  "version": "6.0.4",
+  "version": "6.1.1",
   "description": "WebSocket framework for Ruby on Rails.",
   "main": "app/assets/javascripts/action_cable.js",
   "files": [
@@ -21,7 +21,7 @@
   "bugs": {
     "url": "https://github.com/rails/rails/issues"
   },
-  "homepage": "http://rubyonrails.org/",
+  "homepage": "https://rubyonrails.org/",
   "devDependencies": {
     "babel-core": "^6.25.0",
     "babel-plugin-external-helpers": "^6.22.0",

package/src/connection_monitor.js

@@ -105,7 +105,7 @@ class ConnectionMonitor {
     if (document.visibilityState === "visible") {
       setTimeout(() => {
         if (this.connectionIsStale() || !this.connection.isOpen()) {
-          logger.log(`ConnectionMonitor reopening stale connection on visibilitychange. visbilityState = ${document.visibilityState}`)
+          logger.log(`ConnectionMonitor reopening stale connection on visibilitychange. visibilityState = ${document.visibilityState}`)
           this.connection.reopen()
         }
       }

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")

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/subscriptions.js

@@ -1,7 +1,8 @@
 import Subscription from "./subscription"
 
-// 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")