anycable 0.6.0.rc1 → 1.0.0.preview1

data/lib/anycable/exceptions_handling.rb

@@ -4,25 +4,29 @@ module AnyCable
   module ExceptionsHandling # :nodoc:
     class << self
       def add_handler(block)
-        handlers << block
+        handlers << procify(block)
       end
 
       alias << add_handler
 
-      def notify(exp)
+      def notify(exp, method_name, message)
         handlers.each do |handler|
-          begin
-            handler.call(exp)
-          rescue StandardError => exp
-            AnyCable.logger.error "!!! EXCEPTION HANDLER THREW AN ERROR !!!"
-            AnyCable.logger.error exp
-            AnyCable.logger.error exp.backtrace.join("\n") unless exp.backtrace.nil?
-          end
+          handler.call(exp, method_name, message)
+        rescue => exp
+          AnyCable.logger.error "!!! EXCEPTION HANDLER THREW AN ERROR !!!"
+          AnyCable.logger.error exp
+          AnyCable.logger.error exp.backtrace.join("\n") unless exp.backtrace.nil?
         end
       end
 
       private
 
+      def procify(block)
+        return block unless block.lambda?
+
+        proc { |*args| block.call(*args.take(block.arity)) }
+      end
+
       def handlers
         @handlers ||= []
       end

data/lib/anycable/health_server.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require "webrick"
-require "anycable/server"
-
 module AnyCable
   # Server for HTTP healthchecks.
   #
@@ -54,6 +51,8 @@ module AnyCable
     attr_reader :logger
 
     def build_server
+      require "webrick"
+
       WEBrick::HTTPServer.new(
         Port: port,
         Logger: logger,

data/lib/anycable/middleware.rb

@@ -7,6 +7,9 @@ module AnyCable
   # for request/response calls
   class Middleware < GRPC::Interceptor
     def request_response(request: nil, call: nil, method: nil)
+      # Call middlewares only for AnyCable service
+      return yield unless method.receiver.is_a?(AnyCable::RPCHandler)
+
       call(request, call, method) do
         yield
       end

data/lib/anycable/middleware_chain.rb

@@ -48,8 +48,8 @@ module AnyCable
 
       unless middleware.is_a?(AnyCable::Middleware)
         raise ArgumentError,
-              "AnyCable middleware must be a subclass of AnyCable::Middleware, " \
-              "got #{middleware} instead"
+          "AnyCable middleware must be a subclass of AnyCable::Middleware, " \
+          "got #{middleware} instead"
       end
 
       middleware

data/lib/anycable/middlewares/check_version.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module AnyCable
+  module Middlewares
+    # Checks that RPC client version is compatibly with
+    # the current RPC proto version
+    class CheckVersion < Middleware
+      attr_reader :version
+
+      def initialize(version)
+        @version = version
+      end
+
+      def call(_request, call, _method)
+        supported_versions = call.metadata["protov"]&.split(",")
+        return yield if supported_versions&.include?(version)
+
+        raise GRPC::Internal,
+          "Incompatible AnyCable RPC client.\nCurrent server version: #{version}.\n" \
+          "Client supported versions: #{call.metadata["protov"] || "unknown"}."
+      end
+    end
+  end
+end

data/lib/anycable/rpc.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require "anycable/rpc/rpc_pb"
+require "anycable/rpc/rpc_services_pb"
+
+# Extend some PB auto-generated classes
+module AnyCable
+  # Current RPC proto version (used for compatibility checks)
+  PROTO_VERSION = "v1"
+  SESSION_KEY = "_s_"
+
+  # Add setters/getter for cstate field
+  module WithConnectionState
+    def initialize(session: nil, **other)
+      if session
+        other[:cstate] ||= {}
+        other[:cstate][SESSION_KEY] = session
+      end
+      super(**other)
+    end
+
+    def session=(val)
+      self.cstate = {} unless cstate
+      cstate[SESSION_KEY] = val
+    end
+
+    def session
+      cstate[SESSION_KEY]
+    end
+
+    def cstate
+      env.cstate
+    end
+
+    def cstate=(val)
+      env.cstate = val
+    end
+  end
+
+  # Status predicates
+  module StatusPredicates
+    def success?
+      status == :SUCCESS
+    end
+
+    def failure?
+      status == :FAILURE
+    end
+
+    def error?
+      status == :ERROR
+    end
+  end
+
+  class ConnectionResponse
+    prepend WithConnectionState
+    include StatusPredicates
+  end
+
+  class CommandMessage
+    prepend WithConnectionState
+  end
+
+  class CommandResponse
+    prepend WithConnectionState
+    include StatusPredicates
+  end
+
+  class DisconnectRequest
+    prepend WithConnectionState
+  end
+
+  class DisconnectResponse
+    include StatusPredicates
+  end
+end

data/lib/anycable/rpc/rpc_pb.rb

@@ -1,51 +1,66 @@
+# frozen_string_literal: true
+
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: rpc.proto
 
-require 'google/protobuf'
+require "google/protobuf"
 
 Google::Protobuf::DescriptorPool.generated_pool.build do
-  add_message "anycable.ConnectionRequest" do
-    optional :path, :string, 1
-    map :headers, :string, :string, 2
-  end
-  add_message "anycable.ConnectionResponse" do
-    optional :status, :enum, 1, "anycable.Status"
-    optional :identifiers, :string, 2
-    repeated :transmissions, :string, 3
-    optional :error_msg, :string, 4
-  end
-  add_message "anycable.CommandMessage" do
-    optional :command, :string, 1
-    optional :identifier, :string, 2
-    optional :connection_identifiers, :string, 3
-    optional :data, :string, 4
-  end
-  add_message "anycable.CommandResponse" do
-    optional :status, :enum, 1, "anycable.Status"
-    optional :disconnect, :bool, 2
-    optional :stop_streams, :bool, 3
-    repeated :streams, :string, 4
-    repeated :transmissions, :string, 5
-    optional :error_msg, :string, 6
-  end
-  add_message "anycable.DisconnectRequest" do
-    optional :identifiers, :string, 1
-    repeated :subscriptions, :string, 2
-    optional :path, :string, 3
-    map :headers, :string, :string, 4
-  end
-  add_message "anycable.DisconnectResponse" do
-    optional :status, :enum, 1, "anycable.Status"
-    optional :error_msg, :string, 2
-  end
-  add_enum "anycable.Status" do
-    value :ERROR, 0
-    value :SUCCESS, 1
-    value :FAILURE, 2
+  add_file("rpc.proto", syntax: :proto3) do
+    add_message "anycable.Env" do
+      optional :url, :string, 1
+      map :headers, :string, :string, 2
+      map :cstate, :string, :string, 3
+    end
+    add_message "anycable.EnvResponse" do
+      map :cstate, :string, :string, 1
+    end
+    add_message "anycable.ConnectionRequest" do
+      optional :env, :message, 3, "anycable.Env"
+    end
+    add_message "anycable.ConnectionResponse" do
+      optional :status, :enum, 1, "anycable.Status"
+      optional :identifiers, :string, 2
+      repeated :transmissions, :string, 3
+      optional :error_msg, :string, 4
+      optional :env, :message, 5, "anycable.EnvResponse"
+    end
+    add_message "anycable.CommandMessage" do
+      optional :command, :string, 1
+      optional :identifier, :string, 2
+      optional :connection_identifiers, :string, 3
+      optional :data, :string, 4
+      optional :env, :message, 5, "anycable.Env"
+    end
+    add_message "anycable.CommandResponse" do
+      optional :status, :enum, 1, "anycable.Status"
+      optional :disconnect, :bool, 2
+      optional :stop_streams, :bool, 3
+      repeated :streams, :string, 4
+      repeated :transmissions, :string, 5
+      optional :error_msg, :string, 6
+      optional :env, :message, 7, "anycable.EnvResponse"
+    end
+    add_message "anycable.DisconnectRequest" do
+      optional :identifiers, :string, 1
+      repeated :subscriptions, :string, 2
+      optional :env, :message, 5, "anycable.Env"
+    end
+    add_message "anycable.DisconnectResponse" do
+      optional :status, :enum, 1, "anycable.Status"
+      optional :error_msg, :string, 2
+    end
+    add_enum "anycable.Status" do
+      value :ERROR, 0
+      value :SUCCESS, 1
+      value :FAILURE, 2
+    end
   end
 end
 
 module AnyCable
+  Env = Google::Protobuf::DescriptorPool.generated_pool.lookup("anycable.Env").msgclass
+  EnvResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("anycable.EnvResponse").msgclass
   ConnectionRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("anycable.ConnectionRequest").msgclass
   ConnectionResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("anycable.ConnectionResponse").msgclass
   CommandMessage = Google::Protobuf::DescriptorPool.generated_pool.lookup("anycable.CommandMessage").msgclass

data/lib/anycable/rpc/rpc_services_pb.rb

@@ -1,17 +1,18 @@
+# frozen_string_literal: true
+
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # Source: rpc.proto for package 'anycable'
 
-require 'grpc'
+require "grpc"
 
 module AnyCable
   module RPC
     class Service
-
       include GRPC::GenericService
 
       self.marshal_class_method = :encode
       self.unmarshal_class_method = :decode
-      self.service_name = 'anycable.RPC'
+      self.service_name = "anycable.RPC"
 
       rpc :Connect, ConnectionRequest, ConnectionResponse
       rpc :Command, CommandMessage, CommandResponse

data/lib/anycable/rpc_handler.rb

@@ -1,43 +1,50 @@
 # frozen_string_literal: true
 
 require "anycable/socket"
-require "anycable/rpc/rpc_pb"
-require "anycable/rpc/rpc_services_pb"
-
-require "anycable/handler/capture_exceptions"
+require "anycable/rpc"
 
 # rubocop:disable Metrics/AbcSize
 # rubocop:disable Metrics/MethodLength
+# rubocop:disable Metrics/ClassLength
 module AnyCable
   # RPC service handler
   class RPCHandler < AnyCable::RPC::Service
-    prepend AnyCable::Handler::CaptureExceptions
-
     # Handle connection request from WebSocket server
     def connect(request, _unused_call)
       logger.debug("RPC Connect: #{request.inspect}")
 
-      socket = build_socket(env: rack_env(request))
+      socket = build_socket(env: rack_env(request.env))
 
       connection = factory.call(socket)
 
       connection.handle_open
 
       if socket.closed?
-        AnyCable::ConnectionResponse.new(status: AnyCable::Status::FAILURE)
+        AnyCable::ConnectionResponse.new(
+          status: AnyCable::Status::FAILURE,
+          transmissions: socket.transmissions
+        )
       else
         AnyCable::ConnectionResponse.new(
           status: AnyCable::Status::SUCCESS,
           identifiers: connection.identifiers_json,
-          transmissions: socket.transmissions
+          transmissions: socket.transmissions,
+          env: build_env_response(socket)
         )
       end
+    rescue => exp
+      notify_exception(exp, :connect, request)
+
+      AnyCable::ConnectionResponse.new(
+        status: AnyCable::Status::ERROR,
+        error_msg: exp.message
+      )
     end
 
     def disconnect(request, _unused_call)
       logger.debug("RPC Disconnect: #{request.inspect}")
 
-      socket = build_socket(env: rack_env(request))
+      socket = build_socket(env: rack_env(request.env))
 
       connection = factory.call(
         socket,
@@ -50,12 +57,19 @@ module AnyCable
       else
         AnyCable::DisconnectResponse.new(status: AnyCable::Status::FAILURE)
       end
+    rescue => exp
+      notify_exception(exp, :disconnect, request)
+
+      AnyCable::DisconnectResponse.new(
+        status: AnyCable::Status::ERROR,
+        error_msg: exp.message
+      )
     end
 
     def command(message, _unused_call)
       logger.debug("RPC Command: #{message.inspect}")
 
-      socket = build_socket
+      socket = build_socket(env: rack_env(message.env))
 
       connection = factory.call(
         socket,
@@ -73,30 +87,58 @@ module AnyCable
         disconnect: socket.closed?,
         stop_streams: socket.stop_streams?,
         streams: socket.streams,
-        transmissions: socket.transmissions
+        transmissions: socket.transmissions,
+        env: build_env_response(socket)
+      )
+    rescue => exp
+      notify_exception(exp, :command, message)
+
+      AnyCable::CommandResponse.new(
+        status: AnyCable::Status::ERROR,
+        error_msg: exp.message
       )
     end
 
     private
 
-    # Build env from path
-    def rack_env(request)
-      uri = URI.parse(request.path)
-      {
-        "QUERY_STRING" => uri.query,
-        "SCRIPT_NAME" => "",
+    # Build Rack env from request
+    def rack_env(request_env)
+      uri = URI.parse(request_env.url)
+
+      env = base_rack_env
+      env.merge!(
         "PATH_INFO" => uri.path,
+        "QUERY_STRING" => uri.query,
+        "SERVER_NAME" => uri.host,
         "SERVER_PORT" => uri.port.to_s,
         "HTTP_HOST" => uri.host,
-        # Hack to avoid Missing rack.input error
-        "rack.request.form_input" => "",
-        "rack.input" => "",
-        "rack.request.form_hash" => {}
-      }.merge(build_headers(request.headers))
+        "REMOTE_ADDR" => request_env.headers.delete("REMOTE_ADDR"),
+        "rack.url_scheme" => uri.scheme,
+        # AnyCable specific fields
+        "anycable.raw_cstate" => request_env.cstate&.to_h
+      )
+
+      env.merge!(build_headers(request_env.headers))
+    end
+
+    def base_rack_env
+      # Minimum required variables according to Rack Spec
+      # (not all of them though, just those enough for Action Cable to work)
+      # See https://rubydoc.info/github/rack/rack/master/file/SPEC
+      {
+        "REQUEST_METHOD" => "GET",
+        "SCRIPT_NAME" => "",
+        "PATH_INFO" => "/",
+        "QUERY_STRING" => "",
+        "SERVER_NAME" => "",
+        "SERVER_PORT" => "80",
+        "rack.url_scheme" => "http",
+        "rack.input" => ""
+      }
     end
 
     def build_socket(**options)
-      AnyCable::Socket.new(options)
+      AnyCable::Socket.new(**options)
     end
 
     def build_headers(headers)
@@ -107,6 +149,12 @@ module AnyCable
       end
     end
 
+    def build_env_response(socket)
+      AnyCable::EnvResponse.new(
+        cstate: socket.cstate.changed_fields
+      )
+    end
+
     def logger
       AnyCable.logger
     end
@@ -114,7 +162,12 @@ module AnyCable
     def factory
       AnyCable.connection_factory
     end
+
+    def notify_exception(exp, method_name, message)
+      AnyCable::ExceptionsHandling.notify(exp, method_name.to_s, message.to_h)
+    end
   end
 end
 # rubocop:enable Metrics/AbcSize
 # rubocop:enable Metrics/MethodLength
+# rubocop:enable Metrics/ClassLength