actioncable 5.0.7.2 → 5.1.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 1ee3d1102059bedcc5ad921ef625016fad5415c99cefbec0eced71935b94c282
-  data.tar.gz: e79965fac70838822e54e60768b0daf3f846582574f213b36c6e2cf2a44d4564
+SHA1:
+  metadata.gz: e6a1923cc070932c10fd67f43091b790c221df82
+  data.tar.gz: 4f8a716a47aeb4fcd7557e8fb9efd3f2629394a6
 SHA512:
-  metadata.gz: bb979e416083f480d596d0946252af8b444c6a5aaedd927ba5b339408ea1ae9eca28f858b0539696b39467d0f38dfc34959b3d5f0b079747c1aa75b6e838cbd9
-  data.tar.gz: 38fd77b3eed559c9ceed9699c58c0d0fdcd07cd86315e5d0932eaa7d712fbbb7794b30a2ae51b6c31c912e4dbbe76726513c2a9805637cdd1e5fad561a6b9f45
+  metadata.gz: f46c1ea1a1d68ce4b833fa58c287be8b658e0e599c2507e68c216a403f4e19a831a5e50a37dcb5c9f0125d5e545641ac9fa19feceeaeb4d3e3e53a459d8029d0
+  data.tar.gz: 1495844434cdb511bec8e32976eced1a9c8c7657c6c6a6509ac9c6e8215294d1b850a08d00bca5c3ab83423ae0b34359bb137acea9c067c6d842b045c42ba59f

data/CHANGELOG.md

@@ -1,89 +1,18 @@
-## Rails 5.0.7.2 (March 11, 2019) ##
+## Rails 5.1.0.beta1 (February 23, 2017) ##
 
-*   No changes.
+*   Redis subscription adapters now support `channel_prefix` option in `cable.yml`
 
+    Avoids channel name collisions when multiple apps use the same Redis server.
 
-## Rails 5.0.7.1 (November 27, 2018) ##
-
-*   No changes.
-
-
-## Rails 5.0.7 (March 29, 2018) ##
-
-*   No changes.
-
-
-## Rails 5.0.6 (September 07, 2017) ##
-
-*   No changes.
-
-
-## Rails 5.0.6.rc1 (August 24, 2017) ##
-
-*   No changes.
-
-
-## Rails 5.0.5 (July 31, 2017) ##
-
-*   No changes.
-
-
-## Rails 5.0.5.rc2 (July 25, 2017) ##
-
-*   No changes.
-
-
-## Rails 5.0.5.rc1 (July 19, 2017) ##
-
-*   No changes.
-
-
-## Rails 5.0.4 (June 19, 2017) ##
-
-*   No changes.
-
-
-## Rails 5.0.3 (May 12, 2017) ##
-
-*   No changes.
-
-
-## Rails 5.0.2 (March 01, 2017) ##
-
-*   No changes.
-
-
-## Rails 5.0.1 (December 21, 2016) ##
-
-*   No changes.
-
-
-## Rails 5.0.1.rc2 (December 10, 2016) ##
-
-*   No changes.
-
-
-## Rails 5.0.1.rc1 (December 01, 2016) ##
+    *Chad Ingram*
 
 *   Permit same-origin connections by default.
 
-    New option `config.action_cable.allow_same_origin_as_host = false`
-    to disable.
+    Added new option `config.action_cable.allow_same_origin_as_host = false`
+    to disable this behaviour.
 
     *Dávid Halász*, *Matthew Draper*
 
-*   Fixed and added a workaround to avoid race condition, when one
-    thread closed the IO, when an another thread was still trying read
-    from IO on a connection.
-
-    *Matthew Draper*
-
-*   Shutdown pubsub connection before classes are reloaded, to avoid
-    hangups caused by pubsub still holding reference to Active Record
-    connection from the pool, and Active Record trying to cleanup the pool.
-
-    *Jon Moss*
-
 *   Prevent race where the client could receive and act upon a
     subscription confirmation before the channel's `subscribed` method
     completed.
@@ -92,110 +21,25 @@
 
     *Vladimir Dementyev*
 
-*   Buffer writes to websocket connections, to avoid blocking threads
+*   Buffer now writes to WebSocket connections, to avoid blocking threads
     that could be doing more useful things.
 
     *Matthew Draper*, *Tinco Andringa*
 
-*   Invocation of channel action is now prevented, if subscription
-    connection was rejected.
-
-    Fixes #23757.
-
-    *Jon Moss*
-
-*   Protect against concurrent writes to a websocket connection from
+*   Protect against concurrent writes to a WebSocket connection from
     multiple threads; the underlying OS write is not always threadsafe.
 
     *Tinco Andringa*
 
-*   Close hijacked socket when connection is shut down.
-
-    Fixes #25613.
-
-    *Tinco Andringa*
-
-
-## Rails 5.0.0 (June 30, 2016) ##
-
-*   Fix development reloading support: new cable connections are now correctly
-    dispatched to the reloaded channel class, instead of using a cached reference
-    to the originally-loaded version.
-
-    *Matthew Draper*
-
-*   WebSocket protocol negotiation.
-
-    Introduces an Action Cable protocol version that moves independently
-    of and, hopefully, more slowly than Action Cable itself. Client sockets
-    negotiate a protocol with the Cable server using WebSockets' native
-    subprotocol support:
-      * https://tools.ietf.org/html/rfc6455#section-1.9
-      * https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API/Writing_WebSocket_servers#Subprotocols
-
-    If they can't negotiate a compatible protocol (usually due to upgrading
-    the Cable server with a browser still running old JavaScript) then the
-    client knows to disconnect, cease retrying, and tell the app that it hit
-    a protocol mismatch.
-
-    This allows us to evolve the Action Cable message format, handshaking,
-    pings, acknowledgements, and more without breaking older clients'
-    expectations of server behavior.
-
-    *Daniel Rhodes*
-
-*   Pubsub: automatic stream decoding.
-
-        stream_for @room, coder: ActiveSupport::JSON do |message|
-          # `message` is a Ruby hash here instead of a JSON string
-
-    The `coder` must respond to `#decode`. Defaults to `coder: nil`
-    which skips decoding entirely.
-
-    *Jeremy Daer*
-
-*   Add ActiveSupport::Notifications to ActionCable::Channel.
+*   Add `ActiveSupport::Notifications` hook to `Broadcaster#broadcast`.
 
     *Matthew Wear*
 
-*   Safely support autoloading and class unloading, by preventing concurrent
-    loads, and disconnecting all cables during reload.
-
-    *Matthew Draper*
-
-*   Ensure ActionCable behaves correctly for non-string queue names.
-
-    *Jay Hayes*
-
-*   Added `em_redis_connector` and `redis_connector` to
-   `ActionCable::SubscriptionAdapter::EventedRedis` and added `redis_connector`
-    to `ActionCable::SubscriptionAdapter::Redis`, so you can overwrite with your
-    own initializers. This is used when you want to use different-than-standard
-    Redis adapters, like for Makara distributed Redis.
-
-    *DHH*
-
-*   Support PostgreSQL pubsub adapter.
-
-    *Jon Moss*
-
-*   Remove EventMachine dependency.
-
-    *Matthew Draper*
-
-*   Remove Celluloid dependency.
-
-    *Mike Perham*
+*   Close hijacked socket when connection is shut down.
 
-*   Create notion of an `ActionCable::SubscriptionAdapter`.
-    Separate out Redis functionality into
-    `ActionCable::SubscriptionAdapter::Redis`, and add a
-    PostgreSQL adapter as well. Configuration file for
-    ActionCable was changed from`config/redis/cable.yml` to
-    `config/cable.yml`.
+    Fixes #25613.
 
-    *Jon Moss*
+    *Tinco Andringa*
 
-*   Added to Rails!
 
-    *DHH*
+Please check [5-0-stable](https://github.com/rails/rails/blob/5-0-stable/actioncable/CHANGELOG.md) for previous changes.

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2015-2016 Basecamp, LLC
+Copyright (c) 2015-2017 Basecamp, 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

@@ -7,7 +7,6 @@ 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.
 
-
 ## Terminology
 
 A single Action Cable server can handle multiple connection instances. It has one
@@ -52,7 +51,7 @@ module ApplicationCable
       self.current_user = find_verified_user
     end
 
-    protected
+    private
       def find_verified_user
         if current_user = User.find_by(id: cookies.signed[:user_id])
           current_user
@@ -86,12 +85,17 @@ end
 
 The client-side needs to setup a consumer instance of this connection. That's done like so:
 
-```coffeescript
-# app/assets/javascripts/cable.coffee
-#= require action_cable
+```js
+// app/assets/javascripts/cable.js
+//= require action_cable
+//= require_self
+//= require_tree ./channels
 
-@App = {}
-App.cable = ActionCable.createConsumer("ws://cable.example.com")
+(function() {
+  this.App || (this.App = {});
+
+  App.cable = ActionCable.createConsumer("ws://cable.example.com");
+}).call(this);
 ```
 
 The `ws://cable.example.com` address must point to your Action Cable server(s), and it
@@ -163,7 +167,7 @@ App.cable.subscriptions.create "AppearanceChannel",
   buttonSelector = "[data-behavior~=appear_away]"
 
   install: ->
-    $(document).on "page:change.appearance", =>
+    $(document).on "turbolinks:load.appearance", =>
       @appear()
 
     $(document).on "click.appearance", buttonSelector, =>
@@ -293,8 +297,7 @@ The rebroadcast will be received by all connected clients, _including_ the clien
 
 ### More complete examples
 
-See the [rails/actioncable-examples](http://github.com/rails/actioncable-examples) repository for a full example of how to setup Action Cable in a Rails app, and how to add channels.
-
+See the [rails/actioncable-examples](https://github.com/rails/actioncable-examples) repository for a full example of how to setup Action Cable in a Rails app, and how to add channels.
 
 ## Configuration
 
@@ -383,11 +386,11 @@ App.cable = ActionCable.createConsumer()
 
 ### Other Configurations
 
-The other common option to configure is the log tags applied to the per-connection logger. Here's close to what we're using in Basecamp:
+The other common option to configure is the log tags applied to the per-connection logger. Here's an example that uses the user account id if available, else "no-account" while tagging:
 
 ```ruby
-Rails.application.config.action_cable.log_tags = [
-  -> request { request.env['bc.account_id'] || "no-account" },
+config.action_cable.log_tags = [
+  -> request { request.env['user_account_id'] || "no-account" },
   :action_cable,
   -> request { request.uuid }
 ]
@@ -413,7 +416,7 @@ run ActionCable.server
 ```
 
 Then you start the server using a binstub in bin/cable ala:
-```
+```sh
 #!/bin/bash
 bundle exec puma -p 28080 cable/config.ru
 ```
@@ -435,7 +438,7 @@ For every instance of your server you create and for every worker your server sp
 
 ### Notes
 
-Beware that currently the cable server will _not_ auto-reload any changes in the framework. As we've discussed, long-running cable connections mean long-running objects. We don't yet have a way of reloading the classes of those objects in a safe manner. So when you change your channels, or the model your channels use, you must restart the cable server.
+Beware that currently, the cable server will _not_ auto-reload any changes in the framework. As we've discussed, long-running cable connections mean long-running objects. We don't yet have a way of reloading the classes of those objects in a safe manner. So when you change your channels, or the model your channels use, you must restart the cable server.
 
 We'll get all this abstracted properly when the framework is integrated into Rails.
 

data/lib/action_cable.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2015-2016 Basecamp, LLC
+# Copyright (c) 2015-2017 Basecamp, LLC
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -21,21 +21,21 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
 
-require 'active_support'
-require 'active_support/rails'
-require 'action_cable/version'
+require "active_support"
+require "active_support/rails"
+require "action_cable/version"
 
 module ActionCable
   extend ActiveSupport::Autoload
 
   INTERNAL = {
     message_types: {
-      welcome: 'welcome'.freeze,
-      ping: 'ping'.freeze,
-      confirmation: 'confirm_subscription'.freeze,
-      rejection: 'reject_subscription'.freeze
+      welcome: "welcome".freeze,
+      ping: "ping".freeze,
+      confirmation: "confirm_subscription".freeze,
+      rejection: "reject_subscription".freeze
     },
-    default_mount_path: '/cable'.freeze,
+    default_mount_path: "/cable".freeze,
     protocols: ["actioncable-v1-json".freeze, "actioncable-unsupported".freeze].freeze
   }
 

data/lib/action_cable/channel/base.rb

@@ -1,4 +1,4 @@
-require 'set'
+require "set"
 
 module ActionCable
   module Channel
@@ -122,16 +122,16 @@ module ActionCable
           end
         end
 
-        protected
+        private
           # action_methods are cached and there is sometimes need to refresh
           # them. ::clear_action_methods! allows you to do that, so next time
           # you run action_methods, they will be recalculated.
-          def clear_action_methods!
+          def clear_action_methods! # :doc:
             @action_methods = nil
           end
 
           # Refresh the cached action_methods when a new action_method is added.
-          def method_added(name)
+          def method_added(name) # :doc:
             super
             clear_action_methods!
           end
@@ -189,24 +189,23 @@ module ActionCable
         end
       end
 
-
-      protected
+      private
         # Called once a consumer has become a subscriber of the channel. Usually the place to setup any streams
         # you want this channel to be sending to the subscriber.
-        def subscribed
+        def subscribed # :doc:
           # Override in subclasses
         end
 
         # Called once a consumer has cut its cable connection. Can be used for cleaning up connections or marking
         # users as offline or the like.
-        def unsubscribed
+        def unsubscribed # :doc:
           # Override in subclasses
         end
 
         # Transmit a hash of data to the subscriber. The hash will automatically be wrapped in a JSON envelope with
         # the proper channel identifier marked as the recipient.
-        def transmit(data, via: nil)
-          logger.info "#{self.class.name} transmitting #{data.inspect.truncate(300)}".tap { |m| m << " (via #{via})" if via }
+        def transmit(data, via: nil) # :doc:
+          logger.debug "#{self.class.name} transmitting #{data.inspect.truncate(300)}".tap { |m| m << " (via #{via})" if via }
 
           payload = { channel_class: self.class.name, data: data, via: via }
           ActiveSupport::Notifications.instrument("transmit.action_cable", payload) do
@@ -214,33 +213,32 @@ module ActionCable
           end
         end
 
-        def ensure_confirmation_sent
+        def ensure_confirmation_sent # :doc:
           return if subscription_rejected?
           @defer_subscription_confirmation_counter.decrement
           transmit_subscription_confirmation unless defer_subscription_confirmation?
         end
 
-        def defer_subscription_confirmation!
+        def defer_subscription_confirmation! # :doc:
           @defer_subscription_confirmation_counter.increment
         end
 
-        def defer_subscription_confirmation?
+        def defer_subscription_confirmation? # :doc:
           @defer_subscription_confirmation_counter.value > 0
         end
 
-        def subscription_confirmation_sent?
+        def subscription_confirmation_sent? # :doc:
           @subscription_confirmation_sent
         end
 
-        def reject
+        def reject # :doc:
           @reject_subscription = true
         end
 
-        def subscription_rejected?
+        def subscription_rejected? # :doc:
           @reject_subscription
         end
 
-      private
         def delegate_connection_identifiers
           connection.identifiers.each do |identifier|
             define_singleton_method(identifier) do
@@ -250,7 +248,7 @@ module ActionCable
         end
 
         def extract_action(data)
-          (data['action'].presence || :receive).to_sym
+          (data["action"].presence || :receive).to_sym
         end
 
         def processable_action?(action)
@@ -269,7 +267,7 @@ module ActionCable
 
         def action_signature(action, data)
           "#{self.class.name}##{action}".tap do |signature|
-            if (arguments = data.except('action')).any?
+            if (arguments = data.except("action")).any?
               signature << "(#{arguments.inspect})"
             end
           end