actioncable 5.0.0.beta1.1 → 5.0.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1aad5170db2b6b99a079c3e32f144cfdd03f6f76
-  data.tar.gz: bf24e304789dc7b982eb8c5dcc126dc0c90db47f
+  metadata.gz: 666a8feb5df8f5f6a523f81a826c1a2fbd23a1c3
+  data.tar.gz: 85b3d45b716f55eed7b2b8aad82e69dd7f00c1e7
 SHA512:
-  metadata.gz: 096e4a23394e14f19d9a874f2cc34e8dc675b333fa38db1ab1db019c912532218ec051bac8e30e5d255496c14f1fb4dffe26a949c7ce066f90eb84b9103f15eb
-  data.tar.gz: b8961ebcd43134b02d0d4e0f5a1a5df8d4f8b7f27abc153360255a5cada9ecbc601c57c714d84fd9e29d85bb2f17d44f8f75ddfc389ace460ce16e8babcfac25
+  metadata.gz: be0531d119c3792067b0cc54609830700ea1eacb28dd6199775e13b3914a83a90cdbc6e44d10d434a14dabc159e7dc2d7df0b984e3a3e748b4e8ec42ea554def
+  data.tar.gz: 75e01690a3a351949df277f14492b79f050518a9c8f5e5a72a68df0f83595df635b9bfedea7f53e9882e0d0bac302fed69c5f79ce535ae765d22da607dc65fce

data/CHANGELOG.md

@@ -1,8 +1,28 @@
-## Rails 5.0.0.beta1 (December 18, 2015) ##
+## Rails 5.0.0.beta2 (February 01, 2016) ##
+
+*   Support PostgreSQL pubsub adapter.
+
+    *Jon Moss*
+
+*   Remove EventMachine dependency.
+
+    *Matthew Draper*
 
-*   No changes.
+*   Remove Celluloid dependency.
 
+    *Mike Perham*
+
+*   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`.
+
+   *Jon Moss*
+
+## Rails 5.0.0.beta1 (December 18, 2015) ##
 
 *   Added to Rails!
 
-    *DHH*
+    *DHH*

data/MIT-LICENSE

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

@@ -1,4 +1,4 @@
-# Action Cable –- Integrated WebSockets for Rails
+# Action Cable – Integrated WebSockets for Rails
 
 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
@@ -16,7 +16,7 @@ WebSockets open to your application if they use multiple browser tabs or devices
 The client of a WebSocket connection is called the consumer.
 
 Each consumer can in turn subscribe to multiple cable channels. Each channel encapsulates
-a logical unit of work, similar to what a controller does in a regular MVC setup. For example, 
+a logical unit of work, similar to what a controller does in a regular MVC setup. For example,
 you could have a `ChatChannel` and a `AppearancesChannel`, and a consumer could be subscribed to either
 or to both of these channels. At the very least, a consumer should be subscribed to one channel.
 
@@ -66,6 +66,13 @@ end
 Here `identified_by` is a connection identifier that can be used to find the specific connection again or later.
 Note that anything marked as an identifier will automatically create a delegate by the same name on any channel instances created off the connection.
 
+This relies on the fact that you will already have handled authentication of the user, and
+that a successful authentication sets a signed cookie with the `user_id`. This cookie is then
+automatically sent to the connection instance when a new connection is attempted, and you
+use that to set the `current_user`. By identifying the connection by this same current_user,
+you're also ensuring that you can later retrieve all open connections by a given user (and
+potentially disconnect them all if the user is deleted or deauthorized).
+
 Then you should define your `ApplicationCable::Channel` class in Ruby. This is the place where you put
 shared logic between your channels.
 
@@ -77,13 +84,6 @@ module ApplicationCable
 end
 ```
 
-This relies on the fact that you will already have handled authentication of the user, and
-that a successful authentication sets a signed cookie with the `user_id`. This cookie is then
-automatically sent to the connection instance when a new connection is attempted, and you
-use that to set the `current_user`. By identifying the connection by this same current_user,
-you're also ensuring that you can later retrieve all open connections by a given user (and
-potentially disconnect them all if the user is deleted or deauthorized).
-
 The client-side needs to setup a consumer instance of this connection. That's done like so:
 
 ```coffeescript
@@ -91,7 +91,7 @@ The client-side needs to setup a consumer instance of this connection. That's do
 #= require action_cable
 
 @App = {}
-App.cable = Cable.createConsumer("ws://cable.example.com")
+App.cable = ActionCable.createConsumer("ws://cable.example.com")
 ```
 
 The ws://cable.example.com address must point to your set of Action Cable servers, and it
@@ -298,11 +298,12 @@ See the [rails/actioncable-examples](http://github.com/rails/actioncable-example
 
 ## Configuration
 
-Action Cable has two required configurations: the Redis connection and specifying allowed request origins.
+Action Cable has three required configurations: the Redis connection, allowed request origins, and the cable server url (which can optionally be set on the client side).
 
 ### Redis
 
-By default, `ActionCable::Server::Base` will look for a configuration file in `Rails.root.join('config/redis/cable.yml')`. The file must follow the following format:
+By default, `ActionCable::Server::Base` will look for a configuration file in `Rails.root.join('config/cable.yml')`.
+This file must specify a Redis url for each Rails environment. It may use the following format:
 
 ```yaml
 production: &production
@@ -312,11 +313,10 @@ development: &development
 test: *development
 ```
 
-This format allows you to specify one configuration per Rails environment. You can also change the location of the Redis config file in
-a Rails initializer with something like:
+You can also change the location of the Redis config file in a Rails initializer with something like:
 
 ```ruby
-Rails.application.paths.add "config/redis/cable", with: "somewhere/else/cable.yml"
+Rails.application.paths.add "config/cable", with: "somewhere/else/cable.yml"
 ```
 
 ### Allowed Request Origins
@@ -327,29 +327,31 @@ Action Cable will only accept requests from specified origins, which are passed
 ActionCable.server.config.allowed_request_origins = ['http://rubyonrails.com', /http:\/\/ruby.*/]
 ```
 
+When running in the development environment, this defaults to "http://localhost:3000".
+
 To disable and allow requests from any origin:
 
 ```ruby
 ActionCable.server.config.disable_request_forgery_protection = true
 ```
 
-By default, Action Cable allows all requests from localhost:3000 when running in the development environment.
+### Consumer Configuration
 
-### Other Configurations
+Once you have decided how to run your cable server (see below), you must provide the server url (or path) to your client-side setup.
+There are two ways you can do this.
 
-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 first is to simply pass it in when creating your consumer. For a standalone server,
+this would be something like: `App.cable = ActionCable.createConsumer("ws://example.com:28080")`, and for an in-app server,
+something like: `App.cable = ActionCable.createConsumer("/cable")`.
 
-```ruby
-ActionCable.server.config.log_tags = [
-  -> request { request.env['bc.account_id'] || "no-account" },
-  :action_cable,
-  -> request { request.uuid }
-]
-```
+The second option is to pass the server url through the `action_cable_meta_tag` in your layout.
+This uses a url or path typically set via `config.action_cable.url` in the environment configuration files, or defaults to "/cable".
 
-Your websocket url might change between environments. If you host your production server via https, you will need to use the wss scheme
+This method is especially useful if your websocket url might change between environments. If you host your production server via https, you will need to use the wss scheme
 for your ActionCable server, but development might remain http and use the ws scheme. You might use localhost in development and your
-domain in production. In any case, to vary the websocket url between environments, add the following configuration to each environment:
+domain in production.
+
+In any case, to vary the websocket url between environments, add the following configuration to each environment:
 
 ```ruby
 config.action_cable.url = "ws://example.com:28080"
@@ -364,7 +366,19 @@ Then add the following line to your layout before your JavaScript tag:
 And finally, create your consumer like so:
 
 ```coffeescript
-App.cable = Cable.createConsumer()
+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:
+
+```ruby
+ActionCable.server.config.log_tags = [
+  -> request { request.env['bc.account_id'] || "no-account" },
+  :action_cable,
+  -> request { request.uuid }
+]
 ```
 
 For a full list of all configuration options, see the `ActionCable::Server::Configuration` class.
@@ -383,8 +397,6 @@ application. The recommended basic setup is as follows:
 require ::File.expand_path('../../config/environment', __FILE__)
 Rails.application.eager_load!
 
-require 'action_cable/process/logging'
-
 run ActionCable.server
 ```
 
@@ -394,22 +406,19 @@ Then you start the server using a binstub in bin/cable ala:
 bundle exec puma -p 28080 cable/config.ru
 ```
 
-The above will start a cable server on port 28080. Remember to point your client-side setup against that using something like:
-`App.cable = Cable.createConsumer("ws://basecamp.dev:28080")`.
+The above will start a cable server on port 28080.
 
 ### In app
 
-If you are using a threaded server like Puma or Thin, the current implementation of ActionCable can run side-along with your Rails application. For example, to listen for WebSocket requests on `/websocket`, match requests on that path:
+If you are using a threaded server like Puma or Thin, the current implementation of ActionCable can run side-along with your Rails application. For example, to listen for WebSocket requests on `/cable`, mount the server at that path:
 
 ```ruby
 # config/routes.rb
 Example::Application.routes.draw do
-  match "/websocket", :to => ActionCable.server, via: [:get, :post]
+  mount ActionCable.server => '/cable'
 end
 ```
 
-You can use `App.cable = Cable.createConsumer("/websocket")` to connect to the cable server.
-
 For every instance of your server you create and for every worker your server spawns, you will also have a new instance of ActionCable, but the use of Redis keeps messages synced across connections.
 
 ### Notes
@@ -427,16 +436,15 @@ messages back and forth over the WebSocket cable connection. This dependency may
 be alleviated in the future, but for the moment that's what it is. So be sure to have
 Redis installed and running.
 
-The Ruby side of things is built on top of [faye-websocket](https://github.com/faye/faye-websocket-ruby) and [celluloid](https://github.com/celluloid/celluloid).
+The Ruby side of things is built on top of [faye-websocket](https://github.com/faye/faye-websocket-ruby) and [concurrent-ruby](https://github.com/ruby-concurrency/concurrent-ruby).
 
 
 ## Deployment
 
-Action Cable is powered by a combination of EventMachine and threads. The
-framework plumbing needed for connection handling is handled in the
-EventMachine loop, but the actual channel, user-specified, work is handled
-in a normal Ruby thread. This means you can use all your regular Rails models
-with no problem, as long as you haven't committed any thread-safety sins.
+Action Cable is powered by a combination of websockets and threads. All of the
+connection management is handled internally by utilizing Ruby’s native thread
+support, which means you can use all your regular Rails models with no problems
+as long as you haven’t committed any thread-safety sins.
 
 But this also means that Action Cable needs to run in its own server process.
 So you'll have one set of server processes for your normal web work, and another
@@ -452,6 +460,14 @@ Action Cable is released under the MIT license:
 
 ## Support
 
-Bug reports can be filed for the alpha development project here:
+API documentation is at:
+
+* http://api.rubyonrails.org
+
+Bug reports can be filed for the Ruby on Rails project here:
+
+* https://github.com/rails/rails/issues
+
+Feature requests should be discussed on the rails-core mailing list here:
 
-* https://github.com/rails/actioncable/issues
+* https://groups.google.com/forum/?fromgroups#!forum/rubyonrails-core

data/lib/action_cable.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2015 Basecamp, LLC
+# Copyright (c) 2015-2016 Basecamp, LLC
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -47,4 +47,5 @@ module ActionCable
   autoload :Connection
   autoload :Channel
   autoload :RemoteConnections
+  autoload :SubscriptionAdapter
 end

data/lib/action_cable/channel/base.rb

@@ -133,8 +133,8 @@ module ActionCable
         @identifier = identifier
         @params     = params
 
-        # When a channel is streaming via redis pubsub, we want to delay the confirmation
-        # transmission until redis pubsub subscription is confirmed.
+        # When a channel is streaming via pubsub, we want to delay the confirmation
+        # transmission until pubsub subscription is confirmed.
         @defer_subscription_confirmation = false
 
         @reject_subscription = nil

data/lib/action_cable/channel/periodic_timers.rb

@@ -27,14 +27,14 @@ module ActionCable
 
         def start_periodic_timers
           self.class.periodic_timers.each do |callback, options|
-            active_periodic_timers << EventMachine::PeriodicTimer.new(options[:every]) do
-              connection.worker_pool.async.run_periodic_timer(self, callback)
+            active_periodic_timers << Concurrent::TimerTask.new(execution_interval: options[:every]) do
+              connection.worker_pool.async_run_periodic_timer(self, callback)
             end
           end
         end
 
         def stop_periodic_timers
-          active_periodic_timers.each { |timer| timer.cancel }
+          active_periodic_timers.each { |timer| timer.shutdown }
         end
     end
   end

data/lib/action_cable/channel/streams.rb

@@ -75,11 +75,11 @@ module ActionCable
         callback ||= default_stream_callback(broadcasting)
         streams << [ broadcasting, callback ]
 
-        EM.next_tick do
-          pubsub.subscribe(broadcasting, &callback).callback do |reply|
+        Concurrent.global_io_executor.post do
+          pubsub.subscribe(broadcasting, callback, lambda do
             transmit_subscription_confirmation
             logger.info "#{self.class.name} is streaming from #{broadcasting}"
-          end
+          end)
         end
       end
 
@@ -92,7 +92,7 @@ module ActionCable
 
       def stop_all_streams
         streams.each do |broadcasting, callback|
-          pubsub.unsubscribe_proc broadcasting, callback
+          pubsub.unsubscribe broadcasting, callback
           logger.info "#{self.class.name} stopped streaming from #{broadcasting}"
         end.clear
       end

data/lib/action_cable/connection.rb

@@ -5,12 +5,15 @@ module ActionCable
     eager_autoload do
       autoload :Authorization
       autoload :Base
+      autoload :ClientSocket
       autoload :Identification
       autoload :InternalChannel
       autoload :MessageBuffer
-      autoload :WebSocket
+      autoload :Stream
+      autoload :StreamEventLoop
       autoload :Subscriptions
       autoload :TaggedLoggerProxy
+      autoload :WebSocket
     end
   end
 end

data/lib/action_cable/connection/base.rb

@@ -48,21 +48,19 @@ module ActionCable
       include InternalChannel
       include Authorization
 
-      attr_reader :server, :env, :subscriptions
-      delegate :worker_pool, :pubsub, to: :server
-
-      attr_reader :logger
+      attr_reader :server, :env, :subscriptions, :logger
+      delegate :stream_event_loop, :worker_pool, :pubsub, to: :server
 
       def initialize(server, env)
         @server, @env = server, env
 
         @logger = new_tagged_logger
 
-        @websocket      = ActionCable::Connection::WebSocket.new(env)
+        @websocket      = ActionCable::Connection::WebSocket.new(env, self, stream_event_loop)
         @subscriptions  = ActionCable::Connection::Subscriptions.new(self)
         @message_buffer = ActionCable::Connection::MessageBuffer.new(self)
 
-        @_internal_redis_subscriptions = nil
+        @_internal_subscriptions = nil
         @started_at = Time.now
       end
 
@@ -72,10 +70,6 @@ module ActionCable
         logger.info started_request_message
 
         if websocket.possible? && allow_request_origin?
-          websocket.on(:open)    { |event| send_async :on_open   }
-          websocket.on(:message) { |event| on_message event.data }
-          websocket.on(:close)   { |event| send_async :on_close  }
-
           respond_to_successful_request
         else
           respond_to_invalid_request
@@ -105,7 +99,7 @@ module ActionCable
 
       # Invoke a method on the connection asynchronously through the pool of thread workers.
       def send_async(method, *arguments)
-        worker_pool.async.invoke(self, method, *arguments)
+        worker_pool.async_invoke(self, method, *arguments)
       end
 
       # Return a basic hash of statistics for the connection keyed with `identifier`, `started_at`, and `subscriptions`.
@@ -123,6 +117,21 @@ module ActionCable
         transmit ActiveSupport::JSON.encode(identifier: ActionCable::INTERNAL[:identifiers][:ping], message: Time.now.to_i)
       end
 
+      def on_open # :nodoc:
+        send_async :handle_open
+      end
+
+      def on_message(message) # :nodoc:
+        message_buffer.append message
+      end
+
+      def on_error(message) # :nodoc:
+        # ignore
+      end
+
+      def on_close(reason, code) # :nodoc:
+        send_async :handle_close
+      end
 
       protected
         # The request that initiated the WebSocket connection is available here. This gives access to the environment, cookies, etc.
@@ -138,13 +147,11 @@ module ActionCable
           request.cookie_jar
         end
 
-
-     protected
         attr_reader :websocket
         attr_reader :message_buffer
 
       private
-        def on_open
+        def handle_open
           connect if respond_to?(:connect)
           subscribe_to_internal_channel
           beat
@@ -155,11 +162,7 @@ module ActionCable
           respond_to_invalid_request
         end
 
-        def on_message(message)
-          message_buffer.append message
-        end
-
-        def on_close
+        def handle_close
           logger.info finished_request_message
 
           server.remove_connection(self)
@@ -170,7 +173,6 @@ module ActionCable
           disconnect if respond_to?(:disconnect)
         end
 
-
         def allow_request_origin?
           return true if server.config.disable_request_forgery_protection
 
@@ -193,7 +195,6 @@ module ActionCable
           [ 404, { 'Content-Type' => 'text/plain' }, [ 'Page not found' ] ]
         end
 
-
         # Tags are declared in the server but computed in the connection. This allows us per-connection tailored tags.
         def new_tagged_logger
           TaggedLoggerProxy.new server.logger,