anycable 0.6.3 → 1.0.0.rc1

data/lib/anycable/rpc.rb

@@ -0,0 +1,84 @@
+# 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
+
+    def istate
+      env.istate
+    end
+
+    def istate=(val)
+      env.istate = 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,69 @@
+# 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
+      map :istate, :string, :string, 4
+    end
+    add_message "anycable.EnvResponse" do
+      map :cstate, :string, :string, 1
+      map :istate, :string, :string, 2
+    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"
+      repeated :stopped_streams, :string, 8
+    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,8 +1,7 @@
 # frozen_string_literal: true
 
 require "anycable/socket"
-require "anycable/rpc/rpc_pb"
-require "anycable/rpc/rpc_services_pb"
+require "anycable/rpc"
 
 # rubocop:disable Metrics/AbcSize
 # rubocop:disable Metrics/MethodLength
@@ -14,22 +13,26 @@ module AnyCable
     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 StandardError => exp
+    rescue => exp
       notify_exception(exp, :connect, request)
 
       AnyCable::ConnectionResponse.new(
@@ -41,7 +44,7 @@ module AnyCable
     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,
@@ -54,7 +57,7 @@ module AnyCable
       else
         AnyCable::DisconnectResponse.new(status: AnyCable::Status::FAILURE)
       end
-    rescue StandardError => exp
+    rescue => exp
       notify_exception(exp, :disconnect, request)
 
       AnyCable::DisconnectResponse.new(
@@ -66,7 +69,7 @@ module AnyCable
     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,
@@ -83,10 +86,12 @@ module AnyCable
         status: result ? AnyCable::Status::SUCCESS : AnyCable::Status::FAILURE,
         disconnect: socket.closed?,
         stop_streams: socket.stop_streams?,
-        streams: socket.streams,
-        transmissions: socket.transmissions
+        streams: socket.streams[:start],
+        stopped_streams: socket.streams[:stop],
+        transmissions: socket.transmissions,
+        env: build_env_response(socket)
       )
-    rescue StandardError => exp
+    rescue => exp
       notify_exception(exp, :command, message)
 
       AnyCable::CommandResponse.new(
@@ -97,24 +102,52 @@ module AnyCable
 
     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,
-        "SERVER_PORT" => uri.port.to_s,
+        "QUERY_STRING" => uri.query,
+        "SERVER_NAME" => uri.host,
+        "SERVER_PORT" => uri.port,
         "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&.sub(/^ws/, "http"),
+        # AnyCable specific fields
+        "anycable.raw_cstate" => request_env.cstate&.to_h,
+        "anycable.raw_istate" => request_env.istate&.to_h
+      }.delete_if { |_k, v| v.nil? })
+
+      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
+      # and https://github.com/rack/rack/blob/master/lib/rack/lint.rb
+      {
+        "REQUEST_METHOD" => "GET",
+        "SCRIPT_NAME" => "",
+        "PATH_INFO" => "/",
+        "QUERY_STRING" => "",
+        "SERVER_NAME" => "",
+        "SERVER_PORT" => "80",
+        "rack.url_scheme" => "http",
+        "rack.input" => StringIO.new("", "r").tap { |io| io.set_encoding(Encoding::ASCII_8BIT) },
+        "rack.version" => Rack::VERSION,
+        "rack.errors" => StringIO.new("").tap { |io| io.set_encoding(Encoding::ASCII_8BIT) },
+        "rack.multithread" => true,
+        "rack.multiprocess" => false,
+        "rack.run_once" => false,
+        "rack.hijack?" => false
+      }
     end
 
     def build_socket(**options)
-      AnyCable::Socket.new(options)
+      AnyCable::Socket.new(**options)
     end
 
     def build_headers(headers)
@@ -125,6 +158,13 @@ module AnyCable
       end
     end
 
+    def build_env_response(socket)
+      AnyCable::EnvResponse.new(
+        cstate: socket.cstate.changed_fields,
+        istate: socket.istate.changed_fields
+      )
+    end
+
     def logger
       AnyCable.logger
     end

data/lib/anycable/rspec.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# Utils for testing AnyCable and its plugins
+require "anycable/rspec/rpc_stub_context"
+require "anycable/rspec/rpc_command_context"
+require "anycable/rspec/with_grpc_server"

data/lib/anycable/rspec/rpc_command_context.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+RSpec.shared_context "anycable:rpc:command" do
+  include_context "anycable:rpc:stub"
+
+  let(:command) { "" }
+  let(:channel_id) { "" }
+  let(:identifiers) { {} }
+  let(:data) { {} }
+
+  let(:request) do
+    AnyCable::CommandMessage.new(
+      command: command,
+      identifier: channel_id,
+      connection_identifiers: identifiers.to_json,
+      data: data.to_json,
+      env: env
+    )
+  end
+end

data/lib/anycable/rspec/rpc_stub_context.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+RSpec.shared_context "anycable:rpc:stub" do
+  before(:all) do
+    @service = AnyCable::RPC::Stub.new(AnyCable.config.rpc_host, :this_channel_is_insecure)
+  end
+
+  let(:service) { @service }
+
+  let(:url) { "ws://example.anycable.com/cable" }
+  let(:headers) { {} }
+  let(:env) { AnyCable::Env.new(url: url, headers: headers) }
+end

data/lib/anycable/rspec/with_grpc_server.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+RSpec.shared_context "anycable:rpc:server" do
+  before(:all) do
+    @server = AnyCable::Server.new(
+      host: AnyCable.config.rpc_host,
+      **AnyCable.config.to_grpc_params,
+      interceptors: AnyCable.middleware.to_a
+    )
+
+    @server.start
+  end
+
+  after(:all) { @server.stop }
+end

data/lib/anycable/server.rb

@@ -21,51 +21,9 @@ module AnyCable
   #   # stop server
   #   server.stop
   class Server
-    class << self
-      # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-      def start(**options)
-        warn <<~DEPRECATION
-          DEPRECATION WARNING: Using AnyCable::Server.start is deprecated!
-          Please, use anycable CLI instead.
-
-          See https://docs.anycable.io/#upgrade_to_0_6_0
-        DEPRECATION
-
-        AnyCable.server_callbacks.each(&:call)
-
-        server = new(
-          host: AnyCable.config.rpc_host,
-          **AnyCable.config.to_grpc_params,
-          interceptors: AnyCable.middleware.to_a,
-          **options
-        )
-
-        AnyCable.middleware.freeze
-
-        if AnyCable.config.http_health_port_provided?
-          health_server = AnyCable::HealthServer.new(
-            server,
-            **AnyCable.config.to_http_health_params
-          )
-          health_server.start
-        end
-
-        at_exit do
-          server.stop
-          health_server&.stop
-        end
-
-        AnyCable.logger.info "Broadcasting Redis channel: #{AnyCable.config.redis_channel}"
-
-        server.start
-        server.wait_till_terminated
-      end
-      # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
-    end
-
     attr_reader :grpc_server, :host
 
-    def initialize(host:, logger: AnyCable.logger, **options)
+    def initialize(host:, logger: nil, **options)
       @logger = logger
       @host = host
       @grpc_server = build_server(options)
@@ -78,8 +36,6 @@ module AnyCable
 
       raise "Cannot re-start stopped server" if stopped?
 
-      check_default_host
-
       logger.info "RPC server is starting..."
 
       @start_thread = Thread.new { grpc_server.run }
@@ -114,10 +70,14 @@ module AnyCable
 
     private
 
-    attr_reader :logger, :start_thread
+    attr_reader :start_thread
+
+    def logger
+      @logger ||= AnyCable.logger
+    end
 
     def build_server(options)
-      GRPC::RpcServer.new(options).tap do |server|
+      GRPC::RpcServer.new(**options).tap do |server|
         server.add_http2_port(host, :this_port_is_insecure)
         server.handle(AnyCable::RPCHandler)
         server.handle(build_health_checker)
@@ -132,21 +92,5 @@ module AnyCable
       )
       health_checker
     end
-
-    def check_default_host
-      return unless host.is_a?(Anycable::Config::DefaultHostWrapper)
-
-      warn <<~DEPRECATION
-        DEPRECATION WARNING: You're using default rpc_host configuration which starts AnyCable RPC
-        server on all available interfaces including external IPv4 and IPv6.
-        This is about to be changed to loopback interface only in future versions.
-
-        Please, consider switching to the loopback interface or set "[::]:50051"
-        explicitly in your configuration, if you want to continue with the current
-        behavior and supress this message.
-
-        See https://docs.anycable.io/#/configuration
-      DEPRECATION
-    end
   end
 end