anycable-core 1.1.0.pre1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f3906d5bd75c90a70af60b0ce10ab49c5940bc7818aa90f4e2af61831b9d5f2
-  data.tar.gz: 3a5b9eea11ea0769d5dcfebd8721c3cf0d6925b470d636f895c37e8da82818a4
+  metadata.gz: 113cfc3490f5829915e8e46026b1c7de0672bb8dc5b388a91a1d0c773688aea5
+  data.tar.gz: 877b8c1672dd37169787dd04bdec610810eab8b27084d8bebf16e3a1b3de98f7
 SHA512:
-  metadata.gz: 116b8c9a943c5785773f4286115cb01955e188bcc45e9583986db08cbbc7c945817280217df07956d2ca3bc739ad95a1120b7f1bf7a19655b19c1cccd49d290a
-  data.tar.gz: aacd6b3e0dda79471150f6305dde49ec1efafdc05fae3c4e9da7ccaf1fa9dfb9c1d7554ac3154e74104b99807f2400f0da465f53da2dcd283870715609384e3f
+  metadata.gz: c6f636686bba507d3b88c83541ba2189637ddb6ef2074d635715d4a533fca4480c37b1131db83a9c6e32ad5e2e166316e7c2747b4aca23a9b2620910bedc0774
+  data.tar.gz: 5d32ecbb7ed802e7d153f4aef170b7df5eca8bc8b4d609a725e9853dc7a4d6eb183abeb9a0ffe1615c33d5272c7cb415b86bd621aaccd5a4ea22c892df3a12c6

data/CHANGELOG.md

@@ -2,7 +2,23 @@
 
 ## master
 
-## 1.1.0-dev
+## 1.1.2 (2021-09-10) 🤵👰
+
+- Improved gRPC server args support. ([@palkan][])
+
+Add ability to declare gRPC server args without namespacing (i.e., `"max_connection_age_ms"` instead of `"grpc.max_connection_age_ms"`). That makes it possible to use ENV vars to provide the gRPC configuration.
+
+## 1.1.1 (2021-06-05)
+
+- Fixed error message when RPC implementation is missing. ([@palkan][])
+
+We haven't extracted `anycable-grpc` yet.
+
+## 1.1.0 🚸 (2021-06-01)
+
+- No changes since 1.1.0.rc1.
+
+## 1.1.0.rc1 (2021-05-12)
 
 - **BREAKING** Move middlewares from gRPC interceptors to custom implementation. ([@palkan][])
 
@@ -12,7 +28,7 @@ The API changed a bit:
 ```diff
  class SomeMiddleware < AnyCable::Middleware
 -  def call(request, rpc_call, rpc_handler)
-+  def call(rpc_method_name, request)
++  def call(rpc_method_name, request, metadata)
      yield
    end
  end

data/README.md

@@ -12,6 +12,8 @@ AnyCable allows you to use any WebSocket server (written in any language) as a r
 
 AnyCable uses the same protocol as ActionCable, so you can use its [JavaScript client](https://www.npmjs.com/package/actioncable) without any monkey-patching.
 
+> [AnyCable Pro](https://docs.anycable.io/pro) has been launched 🚀
+
 <a href="https://evilmartians.com/">
 <img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54"></a>
 

data/lib/anycable/cli.rb

@@ -19,6 +19,14 @@ module AnyCable
     # Wait for external process termination (s)
     WAIT_PROCESS = 2
 
+    # Run CLI inside the current process and shutdown at exit
+    def self.embed!(args = [])
+      new(embedded: true).tap do |cli|
+        cli.run(args)
+        at_exit { cli.shutdown }
+      end
+    end
+
     attr_reader :server, :health_server, :embedded
     alias_method :embedded?, :embedded
 
@@ -55,6 +63,8 @@ module AnyCable
 
       verify_server_builder!
 
+      check_version!
+
       @server = AnyCable.server_builder.call(config)
 
       # Make sure middlewares are not adding after server has started
@@ -242,11 +252,19 @@ module AnyCable
       return if AnyCable.server_builder
 
       logger.error "AnyCable server builder must be configured. " \
-                   "Make sure you've required a gem (e.g. `anycable-grpc`) or " \
+                   "Make sure you've required a gem (e.g. `grpc`) or " \
                    "configured `AnyCable.server_builder` yourself"
       exit(1)
     end
 
+    def check_version!
+      return unless config.version_check_enabled?
+
+      AnyCable.middleware.use(
+        AnyCable::Middlewares::CheckVersion.new(AnyCable::PROTO_VERSION)
+      )
+    end
+
     def parse_gem_options!(args)
       config.parse_options!(args)
     rescue OptionParser::InvalidOption => e

data/lib/anycable/grpc/config.rb

@@ -8,7 +8,7 @@ AnyCable::Config.attr_config(
   rpc_max_waiting_requests: ::GRPC::RpcServer::DEFAULT_MAX_WAITING_REQUESTS,
   rpc_poll_period: ::GRPC::RpcServer::DEFAULT_POLL_PERIOD,
   rpc_pool_keep_alive: ::GRPC::Pool::DEFAULT_KEEP_ALIVE,
-  # See https://github.com/grpc/grpc/blob/f526602bff029b8db50a8d57134d72da33d8a752/include/grpc/impl/codegen/grpc_types.h#L292-L315
+  # https://github.com/grpc/grpc/blob/f526602bff029b8db50a8d57134d72da33d8a752/include/grpc/impl/codegen/grpc_types.h#L141-L351
   rpc_server_args: {},
   log_grpc: false
 )
@@ -33,9 +33,19 @@ module AnyCable
           max_waiting_requests: rpc_max_waiting_requests,
           poll_period: rpc_poll_period,
           pool_keep_alive: rpc_pool_keep_alive,
-          server_args: rpc_server_args
+          server_args: normalized_grpc_server_args
         }
       end
+
+      def normalized_grpc_server_args
+        val = rpc_server_args
+        return {} unless val.is_a?(Hash)
+
+        val.transform_keys do |key|
+          skey = key.to_s
+          skey.start_with?("grpc.") ? skey : "grpc.#{skey}"
+        end
+      end
     end
   end
 end

data/lib/anycable/grpc/handler.rb

@@ -9,16 +9,16 @@ module AnyCable
     # RPC service handler
     class Handler < AnyCable::GRPC::Service
       # Handle connection request from WebSocket server
-      def connect(request, _unused_call)
-        AnyCable.rpc_handler.handle(:connect, request)
+      def connect(request, call)
+        AnyCable.rpc_handler.handle(:connect, request, call.metadata)
       end
 
-      def disconnect(request, _unused_call)
-        AnyCable.rpc_handler.handle(:disconnect, request)
+      def disconnect(request, call)
+        AnyCable.rpc_handler.handle(:disconnect, request, call.metadata)
       end
 
-      def command(request, _unused_call)
-        AnyCable.rpc_handler.handle(:command, request)
+      def command(request, call)
+        AnyCable.rpc_handler.handle(:command, request, call.metadata)
       end
     end
   end

data/lib/anycable/grpc.rb

@@ -9,22 +9,14 @@ end
 
 require "anycable/grpc/config"
 require "anycable/grpc/server"
-require "anycable/grpc/check_version"
 
 AnyCable.server_builder = ->(config) {
   AnyCable.logger.info "gRPC version: #{::GRPC::VERSION}"
 
   ::GRPC.define_singleton_method(:logger) { AnyCable.logger } if config.log_grpc?
 
-  interceptors = []
-
-  if config.version_check_enabled?
-    interceptors << AnyCable::GRPC::CheckVersion.new(AnyCable::PROTO_VERSION)
-  end
-
   params = config.to_grpc_params
   params[:host] = config.rpc_host
-  params[:interceptors] = interceptors
 
   AnyCable::GRPC::Server.new(**params)
 }

data/lib/anycable/middleware.rb

@@ -3,7 +3,7 @@
 module AnyCable
   # Middleware is an analague of Rack middlewares but for AnyCable RPC calls
   class Middleware
-    def call(_method_name, _request)
+    def call(_method_name, _request, _meta)
       raise NotImplementedError
     end
   end

data/lib/anycable/middleware_chain.rb

@@ -30,19 +30,19 @@ module AnyCable
       registry
     end
 
-    def call(method_name, request, &block)
-      return yield(method_name, request) if registry.none?
+    def call(method_name, request, meta = {}, &block)
+      return yield(method_name, request, meta) if registry.none?
 
-      execute_next_middleware(0, method_name, request, block)
+      execute_next_middleware(0, method_name, request, meta, block)
     end
 
     private
 
-    def execute_next_middleware(ind, method_name, request, block)
-      return block.call(method_name, request) if ind >= registry.size
+    def execute_next_middleware(ind, method_name, request, meta, block)
+      return block.call(method_name, request, meta) if ind >= registry.size
 
-      registry[ind].call(method_name, request) do
-        execute_next_middleware(ind + 1, method_name, request, block)
+      registry[ind].call(method_name, request, meta) do
+        execute_next_middleware(ind + 1, method_name, request, meta, block)
       end
     end
 

data/lib/anycable/middlewares/check_version.rb

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

data/lib/anycable/middlewares/exceptions.rb

@@ -3,7 +3,7 @@
 module AnyCable
   module Middlewares
     class Exceptions < AnyCable::Middleware
-      def call(method_name, request)
+      def call(method_name, request, _meta)
         yield
       rescue => exp
         notify_exception(exp, method_name, request)
@@ -16,8 +16,8 @@ module AnyCable
 
       private
 
-      def notify_exception(exp, method_name, message)
-        AnyCable::ExceptionsHandling.notify(exp, method_name.to_s, message.to_h)
+      def notify_exception(exp, method_name, request)
+        AnyCable::ExceptionsHandling.notify(exp, method_name.to_s, request.to_h)
       end
 
       def response_class(method_name)

data/lib/anycable/rpc/handler.rb

@@ -17,8 +17,8 @@ module AnyCable
         @commands = {}
       end
 
-      def handle(cmd, data)
-        middleware.call(cmd, data) do
+      def handle(cmd, data, meta = {})
+        middleware.call(cmd, data, meta) do
           send(cmd, data)
         end
       end

data/lib/anycable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AnyCable
-  VERSION = "1.1.0.pre1"
+  VERSION = "1.1.2"
 end

data/lib/anycable.rb

@@ -9,6 +9,7 @@ require "anycable/broadcast_adapters"
 
 require "anycable/middleware_chain"
 require "anycable/middlewares/exceptions"
+require "anycable/middlewares/check_version"
 
 require "anycable/socket"
 require "anycable/rpc"

data/sig/anycable/cli.rbs

@@ -8,6 +8,7 @@ module AnyCable
 
     alias embedded? embedded
 
+    def self.embed!: (Array[String]?) -> void
     def initialize: (?embedded: bool embedded) -> void
     def run: (?untyped args) -> void
     def shutdown: () -> void

data/sig/anycable/middleware.rbs

@@ -1,5 +1,5 @@
 module AnyCable
   class Middleware
-    def call: (Symbol, rpcRequest) { (Symbol, rpcRequest) -> rpcResponse } -> rpcResponse
+    def call: (Symbol, rpcRequest, rpcMetadata) { (Symbol, rpcRequest, rpcMetadata) -> rpcResponse } -> rpcResponse
   end
 end

data/sig/anycable/middleware_chain.rbs

@@ -1,16 +1,16 @@
 module AnyCable
   class MiddlewareChain
-    type rpcHandlerBlock = ^(Symbol, rpcRequest) -> rpcResponse
+    type rpcHandlerBlock = ^(Symbol, rpcRequest, rpcMetadata) -> rpcResponse
 
     def initialize: () -> void
     def use: (singleton(Middleware) | Middleware middleware) -> void
     def freeze: () -> void
     def to_a: () -> Array[Middleware]
-    def call: (Symbol, rpcRequest) { (Symbol, rpcRequest) -> rpcResponse } -> rpcResponse
+    def call: (Symbol, rpcRequest, ?rpcMetadata) { (Symbol, rpcRequest, rpcMetadata) -> rpcResponse } -> rpcResponse
 
     private
 
-    def execute_next_middleware: (Integer ind, Symbol, rpcRequest, rpcHandlerBlock block) -> rpcResponse
+    def execute_next_middleware: (Integer ind, Symbol, rpcRequest, rpcMetadata, rpcHandlerBlock block) -> rpcResponse
 
     attr_reader mu: untyped
     attr_reader registry: Array[Middleware]

data/sig/anycable/rpc.rbs

@@ -4,6 +4,7 @@ module AnyCable
 
   type rpcStatus = 0 | 1 | 2
   type protoMap = Hash[String, String]
+  type rpcMetadata = Hash[String, String]
 
   interface _WithEnvState
     def cstate: () -> protoMap?
@@ -60,6 +61,7 @@ module AnyCable
     include _WithEnv
 
     def initialize: (?env: Env) -> void
+    def to_h: () -> Hash[String, untyped]
   end
 
   class ConnectionResponse
@@ -78,6 +80,8 @@ module AnyCable
       ?error_msg: String,
       ?env: EnvResponse
     ) -> void
+
+    def to_h: () -> Hash[String, untyped]
   end
 
   class CommandMessage
@@ -94,6 +98,8 @@ module AnyCable
       ?connection_identifiers: String,
       ?env: Env
     ) -> void
+
+    def to_h: () -> Hash[String, untyped]
   end
 
   class CommandResponse
@@ -118,6 +124,8 @@ module AnyCable
       ?error_msg: String,
       ?env: EnvResponse
     ) -> void
+
+    def to_h: () -> Hash[String, untyped]
   end
 
   class DisconnectRequest
@@ -127,6 +135,7 @@ module AnyCable
     attr_accessor subscriptions: Array[String]
 
     def initialize: (identifiers: String, ?subscriptions: Array[String], ?env: Env) -> void
+    def to_h: () -> Hash[String, untyped]
   end
 
   class DisconnectResponse
@@ -136,6 +145,7 @@ module AnyCable
     attr_accessor error_msg: String?
 
     def initialize: (status: rpcStatus, ?error_msg: String) -> void
+    def to_h: () -> Hash[String, untyped]
   end
 
   type rpcRequest = ConnectionRequest | DisconnectRequest | CommandMessage

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: anycable-core
 version: !ruby/object:Gem::Version
-  version: 1.1.0.pre1
+  version: 1.1.2
 platform: ruby
 authors:
 - palkan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-28 00:00:00.000000000 Z
+date: 2021-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: anyway_config
@@ -176,7 +176,6 @@ files:
 - lib/anycable/config.rb
 - lib/anycable/exceptions_handling.rb
 - lib/anycable/grpc.rb
-- lib/anycable/grpc/check_version.rb
 - lib/anycable/grpc/config.rb
 - lib/anycable/grpc/handler.rb
 - lib/anycable/grpc/rpc_services_pb.rb
@@ -184,6 +183,7 @@ files:
 - lib/anycable/health_server.rb
 - lib/anycable/middleware.rb
 - lib/anycable/middleware_chain.rb
+- lib/anycable/middlewares/check_version.rb
 - lib/anycable/middlewares/exceptions.rb
 - lib/anycable/protos/rpc_pb.rb
 - lib/anycable/rpc.rb
@@ -215,6 +215,7 @@ metadata:
   documentation_uri: https://docs.anycable.io/
   homepage_uri: https://anycable.io/
   source_code_uri: http://github.com/anycable/anycable
+  funding_uri: https://github.com/sponsors/anycable
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -226,9 +227,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.2.15
 signing_key:

data/lib/anycable/grpc/check_version.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-module AnyCable
-  module GRPC
-    # Checks that gRPC client version is compatible with
-    # the current RPC proto version
-    class CheckVersion < ::GRPC::ServerInterceptor
-      attr_reader :version
-
-      def initialize(version)
-        @version = version
-      end
-
-      def request_response(request: nil, call: nil, method: nil)
-        # Call only for AnyCable service
-        return yield unless method.receiver.is_a?(AnyCable::GRPC::Handler)
-
-        check_version(call) do
-          yield
-        end
-      end
-
-      def check_version(call)
-        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