actioncable 5.0.1 → 6.1.3

data/lib/action_cable/connection.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActionCable
   module Connection
     extend ActiveSupport::Autoload
@@ -8,13 +10,12 @@ module ActionCable
       autoload :ClientSocket
       autoload :Identification
       autoload :InternalChannel
-      autoload :FayeClientSocket
-      autoload :FayeEventLoop
       autoload :MessageBuffer
       autoload :Stream
       autoload :StreamEventLoop
       autoload :Subscriptions
       autoload :TaggedLoggerProxy
+      autoload :TestCase
       autoload :WebSocket
     end
   end

data/lib/action_cable/connection/authorization.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
+
 module ActionCable
   module Connection
     module Authorization
       class UnauthorizedError < StandardError; end
 
-      private
-        def reject_unauthorized_connection
-          logger.error "An unauthorized connection attempt was rejected"
-          raise UnauthorizedError
-        end
+      # Closes the WebSocket connection if it is open and returns a 404 "File not Found" response.
+      def reject_unauthorized_connection
+        logger.error "An unauthorized connection attempt was rejected"
+        raise UnauthorizedError
+      end
     end
   end
-end
+end

data/lib/action_cable/connection/base.rb

@@ -1,8 +1,11 @@
-require 'action_dispatch'
+# frozen_string_literal: true
+
+require "action_dispatch"
+require "active_support/rescuable"
 
 module ActionCable
   module Connection
-    # For every WebSocket the Action Cable server accepts, a Connection object will be instantiated. This instance becomes the parent
+    # For every WebSocket connection the Action Cable server accepts, a Connection object will be instantiated. This instance becomes the parent
     # of all of the channel subscriptions that are created from there on. Incoming messages are then routed to these channel subscriptions
     # based on an identifier sent by the Action Cable consumer. The Connection itself does not deal with any specific application logic beyond
     # authentication and authorization.
@@ -22,13 +25,10 @@ module ActionCable
     #         # Any cleanup work needed when the cable connection is cut.
     #       end
     #
-    #       protected
+    #       private
     #         def find_verified_user
-    #           if current_user = User.find_by_identity cookies.signed[:identity_id]
-    #             current_user
-    #           else
+    #           User.find_by_identity(cookies.encrypted[:identity_id]) ||
     #             reject_unauthorized_connection
-    #           end
     #         end
     #     end
     #   end
@@ -47,6 +47,7 @@ module ActionCable
       include Identification
       include InternalChannel
       include Authorization
+      include ActiveSupport::Rescuable
 
       attr_reader :server, :env, :subscriptions, :logger, :worker_pool, :protocol
       delegate :event_loop, :pubsub, to: :server
@@ -57,7 +58,7 @@ module ActionCable
         @worker_pool = server.worker_pool
         @logger = new_tagged_logger
 
-        @websocket      = ActionCable::Connection::WebSocket.new(env, self, event_loop, server.config.client_socket_class)
+        @websocket      = ActionCable::Connection::WebSocket.new(env, self, event_loop)
         @subscriptions  = ActionCable::Connection::Subscriptions.new(self)
         @message_buffer = ActionCable::Connection::MessageBuffer.new(self)
 
@@ -96,7 +97,12 @@ module ActionCable
       end
 
       # Close the WebSocket connection.
-      def close
+      def close(reason: nil, reconnect: true)
+        transmit(
+          type: ActionCable::INTERNAL[:message_types][:disconnect],
+          reason: reason,
+          reconnect: reconnect
+        )
         websocket.close
       end
 
@@ -105,14 +111,14 @@ module ActionCable
         worker_pool.async_invoke(self, method, *arguments)
       end
 
-      # Return a basic hash of statistics for the connection keyed with `identifier`, `started_at`, and `subscriptions`.
+      # Return a basic hash of statistics for the connection keyed with <tt>identifier</tt>, <tt>started_at</tt>, <tt>subscriptions</tt>, and <tt>request_id</tt>.
       # This can be returned by a health check against the connection.
       def statistics
         {
           identifier: connection_identifier,
           started_at: @started_at,
           subscriptions: subscriptions.identifiers,
-          request_id: @env['action_dispatch.request_id']
+          request_id: @env["action_dispatch.request_id"]
         }
       end
 
@@ -129,16 +135,20 @@ module ActionCable
       end
 
       def on_error(message) # :nodoc:
-        # ignore
+        # log errors to make diagnosing socket errors easier
+        logger.error "WebSocket error occurred: #{message}"
       end
 
       def on_close(reason, code) # :nodoc:
         send_async :handle_close
       end
 
-      protected
+      private
+        attr_reader :websocket
+        attr_reader :message_buffer
+
         # The request that initiated the WebSocket connection is available here. This gives access to the environment, cookies, etc.
-        def request
+        def request # :doc:
           @request ||= begin
             environment = Rails.application.env_config.merge(env) if defined?(Rails.application) && Rails.application
             ActionDispatch::Request.new(environment || env)
@@ -146,14 +156,10 @@ module ActionCable
         end
 
         # The cookies of the request that initiated the WebSocket connection. Useful for performing authorization checks.
-        def cookies
+        def cookies # :doc:
           request.cookie_jar
         end
 
-        attr_reader :websocket
-        attr_reader :message_buffer
-
-      private
         def encode(cable_message)
           @coder.encode cable_message
         end
@@ -171,7 +177,7 @@ module ActionCable
           message_buffer.process!
           server.add_connection(self)
         rescue ActionCable::Connection::Authorization::UnauthorizedError
-          respond_to_invalid_request
+          close(reason: ActionCable::INTERNAL[:disconnect_reasons][:unauthorized], reconnect: false) if websocket.alive?
         end
 
         def handle_close
@@ -212,11 +218,11 @@ module ActionCable
         end
 
         def respond_to_invalid_request
-          close if websocket.alive?
+          close(reason: ActionCable::INTERNAL[:disconnect_reasons][:invalid_request]) if websocket.alive?
 
           logger.error invalid_request_message
           logger.info finished_request_message
-          [ 404, { 'Content-Type' => 'text/plain' }, [ 'Page not found' ] ]
+          [ 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.
@@ -229,7 +235,7 @@ module ActionCable
           'Started %s "%s"%s for %s at %s' % [
             request.request_method,
             request.filtered_path,
-            websocket.possible? ? ' [WebSocket]' : '[non-WebSocket]',
+            websocket.possible? ? " [WebSocket]" : "[non-WebSocket]",
             request.ip,
             Time.now.to_s ]
         end
@@ -237,22 +243,24 @@ module ActionCable
         def finished_request_message
           'Finished "%s"%s for %s at %s' % [
             request.filtered_path,
-            websocket.possible? ? ' [WebSocket]' : '[non-WebSocket]',
+            websocket.possible? ? " [WebSocket]" : "[non-WebSocket]",
             request.ip,
             Time.now.to_s ]
         end
 
         def invalid_request_message
-          'Failed to upgrade to WebSocket (REQUEST_METHOD: %s, HTTP_CONNECTION: %s, HTTP_UPGRADE: %s)' % [
+          "Failed to upgrade to WebSocket (REQUEST_METHOD: %s, HTTP_CONNECTION: %s, HTTP_UPGRADE: %s)" % [
             env["REQUEST_METHOD"], env["HTTP_CONNECTION"], env["HTTP_UPGRADE"]
           ]
         end
 
         def successful_request_message
-          'Successfully upgraded to WebSocket (REQUEST_METHOD: %s, HTTP_CONNECTION: %s, HTTP_UPGRADE: %s)' % [
+          "Successfully upgraded to WebSocket (REQUEST_METHOD: %s, HTTP_CONNECTION: %s, HTTP_UPGRADE: %s)" % [
             env["REQUEST_METHOD"], env["HTTP_CONNECTION"], env["HTTP_UPGRADE"]
           ]
         end
     end
   end
 end
+
+ActiveSupport.run_load_hooks(:action_cable_connection, ActionCable::Connection::Base)

data/lib/action_cable/connection/client_socket.rb

@@ -1,4 +1,6 @@
-require 'websocket/driver'
+# frozen_string_literal: true
+
+require "websocket/driver"
 
 module ActionCable
   module Connection
@@ -8,18 +10,18 @@ module ActionCable
     # Copyright (c) 2010-2015 James Coglan
     class ClientSocket # :nodoc:
       def self.determine_url(env)
-        scheme = secure_request?(env) ? 'wss:' : 'ws:'
+        scheme = secure_request?(env) ? "wss:" : "ws:"
         "#{ scheme }//#{ env['HTTP_HOST'] }#{ env['REQUEST_URI'] }"
       end
 
       def self.secure_request?(env)
-        return true if env['HTTPS'] == 'on'
-        return true if env['HTTP_X_FORWARDED_SSL'] == 'on'
-        return true if env['HTTP_X_FORWARDED_SCHEME'] == 'https'
-        return true if env['HTTP_X_FORWARDED_PROTO'] == 'https'
-        return true if env['rack.url_scheme'] == 'https'
+        return true if env["HTTPS"] == "on"
+        return true if env["HTTP_X_FORWARDED_SSL"] == "on"
+        return true if env["HTTP_X_FORWARDED_SCHEME"] == "https"
+        return true if env["HTTP_X_FORWARDED_PROTO"] == "https"
+        return true if env["rack.url_scheme"] == "https"
 
-        return false
+        false
       end
 
       CONNECTING = 0
@@ -37,7 +39,7 @@ module ActionCable
         @url = ClientSocket.determine_url(@env)
 
         @driver = @driver_started = nil
-        @close_params = ['', 1006]
+        @close_params = ["", 1006]
 
         @ready_state = CONNECTING
 
@@ -56,7 +58,7 @@ module ActionCable
         return if @driver.nil? || @driver_started
         @stream.hijack_rack_socket
 
-        if callback = @env['async.callback']
+        if callback = @env["async.callback"]
           callback.call([101, {}, @stream])
         end
 
@@ -78,20 +80,20 @@ module ActionCable
       def transmit(message)
         return false if @ready_state > OPEN
         case message
-          when Numeric then @driver.text(message.to_s)
-          when String  then @driver.text(message)
-          when Array   then @driver.binary(message)
-          else false
+        when Numeric then @driver.text(message.to_s)
+        when String  then @driver.text(message)
+        when Array   then @driver.binary(message)
+        else false
         end
       end
 
       def close(code = nil, reason = nil)
         code   ||= 1000
-        reason ||= ''
+        reason ||= ""
 
-        unless code == 1000 or (code >= 3000 and code <= 4999)
-          raise ArgumentError, "Failed to execute 'close' on WebSocket: " +
-                               "The code must be either 1000, or between 3000 and 4999. " +
+        unless code == 1000 || (code >= 3000 && code <= 4999)
+          raise ArgumentError, "Failed to execute 'close' on WebSocket: " \
+                               "The code must be either 1000, or between 3000 and 4999. " \
                                "#{code} is neither."
         end
 

data/lib/action_cable/connection/identification.rb

@@ -1,4 +1,6 @@
-require 'set'
+# frozen_string_literal: true
+
+require "set"
 
 module ActionCable
   module Connection
@@ -6,11 +8,10 @@ module ActionCable
       extend ActiveSupport::Concern
 
       included do
-        class_attribute :identifiers
-        self.identifiers = Set.new
+        class_attribute :identifiers, default: Set.new
       end
 
-      class_methods do
+      module ClassMethods
         # Mark a key as being a connection identifier index that can then be used to find the specific connection again later.
         # Common identifiers are current_user and current_account, but could be anything, really.
         #

data/lib/action_cable/connection/internal_channel.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActionCable
   module Connection
     # Makes it possible for the RemoteConnection to disconnect a specific connection.
@@ -27,8 +29,8 @@ module ActionCable
         end
 
         def process_internal_message(message)
-          case message['type']
-          when 'disconnect'
+          case message["type"]
+          when "disconnect"
             logger.info "Removing connection (#{connection_identifier})"
             websocket.close
           end

data/lib/action_cable/connection/message_buffer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActionCable
   module Connection
     # Allows us to buffer messages received from the WebSocket before the Connection has been fully initialized, and is ready to receive them.
@@ -28,11 +30,10 @@ module ActionCable
         receive_buffered_messages
       end
 
-      protected
+      private
         attr_reader :connection
         attr_reader :buffered_messages
 
-      private
         def valid?(message)
           message.is_a?(String)
         end

data/lib/action_cable/connection/stream.rb

@@ -1,4 +1,6 @@
-require 'thread'
+# frozen_string_literal: true
+
+require "thread"
 
 module ActionCable
   module Connection
@@ -10,7 +12,7 @@ module ActionCable
       def initialize(event_loop, socket)
         @event_loop    = event_loop
         @socket_object = socket
-        @stream_send   = socket.env['stream.send']
+        @stream_send   = socket.env["stream.send"]
 
         @rack_hijack_io = nil
         @write_lock = Mutex.new
@@ -94,10 +96,12 @@ module ActionCable
       end
 
       def hijack_rack_socket
-        return unless @socket_object.env['rack.hijack']
+        return unless @socket_object.env["rack.hijack"]
 
-        @socket_object.env['rack.hijack'].call
-        @rack_hijack_io = @socket_object.env['rack.hijack_io']
+        # This should return the underlying io according to the SPEC:
+        @rack_hijack_io = @socket_object.env["rack.hijack"].call
+        # Retain existing behaviour if required:
+        @rack_hijack_io ||= @socket_object.env["rack.hijack_io"]
 
         @event_loop.attach(@rack_hijack_io, self)
       end

data/lib/action_cable/connection/stream_event_loop.rb

@@ -1,5 +1,7 @@
-require 'nio'
-require 'thread'
+# frozen_string_literal: true
+
+require "nio"
+require "thread"
 
 module ActionCable
   module Connection

data/lib/action_cable/connection/subscriptions.rb

@@ -1,4 +1,6 @@
-require 'active_support/core_ext/hash/indifferent_access'
+# frozen_string_literal: true
+
+require "active_support/core_ext/hash/indifferent_access"
 
 module ActionCable
   module Connection
@@ -11,19 +13,20 @@ module ActionCable
       end
 
       def execute_command(data)
-        case data['command']
-        when 'subscribe'   then add data
-        when 'unsubscribe' then remove data
-        when 'message'     then perform_action data
+        case data["command"]
+        when "subscribe"   then add data
+        when "unsubscribe" then remove data
+        when "message"     then perform_action data
         else
           logger.error "Received unrecognized command in #{data.inspect}"
         end
       rescue Exception => e
-        logger.error "Could not execute command from #{data.inspect}) [#{e.class} - #{e.message}]: #{e.backtrace.first(5).join(" | ")}"
+        @connection.rescue_with_handler(e)
+        logger.error "Could not execute command from (#{data.inspect}) [#{e.class} - #{e.message}]: #{e.backtrace.first(5).join(" | ")}"
       end
 
       def add(data)
-        id_key = data['identifier']
+        id_key = data["identifier"]
         id_options = ActiveSupport::JSON.decode(id_key).with_indifferent_access
 
         return if subscriptions.key?(id_key)
@@ -41,7 +44,7 @@ module ActionCable
 
       def remove(data)
         logger.info "Unsubscribing from channel: #{data['identifier']}"
-        remove_subscription subscriptions[data['identifier']]
+        remove_subscription find(data)
       end
 
       def remove_subscription(subscription)
@@ -50,7 +53,7 @@ module ActionCable
       end
 
       def perform_action(data)
-        find(data).perform_action ActiveSupport::JSON.decode(data['data'])
+        find(data).perform_action ActiveSupport::JSON.decode(data["data"])
       end
 
       def identifiers
@@ -61,14 +64,12 @@ module ActionCable
         subscriptions.each { |id, channel| remove_subscription(channel) }
       end
 
-      protected
-        attr_reader :connection, :subscriptions
-
       private
+        attr_reader :connection, :subscriptions
         delegate :logger, to: :connection
 
         def find(data)
-          if subscription = subscriptions[data['identifier']]
+          if subscription = subscriptions[data["identifier"]]
             subscription
           else
             raise "Unable to find subscription with identifier: #{data['identifier']}"