anycable-core 1.2.5 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e9ba8037b7cbd766d021b4e88d49101b6dc3e9a5a6b355929bf9aaa8494f33a
-  data.tar.gz: 71cd40b2380601f322a335d774cfb41e39f8de6ac29f4b5201a825119bff1031
+  metadata.gz: 5eaf888f4c9312a81bbadf980e5279efa1a0403760569b0465a537e6bd2ed291
+  data.tar.gz: 85206aa6fb8aac5faa0641c889deb9f4c61d40a27211feffb20ab23590313469
 SHA512:
-  metadata.gz: f1a372e6d70eb1db64054aeafcc3baccd674d679652309526fbcfe9329799383b671d532cd16a52dd53b00b4a1658100d000f4564f2cbaac00502e02da00b668
-  data.tar.gz: 5d9434268c8d7b3903544ab357caadcb69150be82d921c2de2916f4191b1280c0c3b981de285425d969bd1693b02974be4a844447576e3975ed0280c877be3c0
+  metadata.gz: 8eb1685bd731c6904126e0ea75a5f4489f268e97f080df60a6eec9ce3ae79cf7c3477ff5cf4add6541a7b09c21455c1d97ababcc1ad818f119e79ac6faf97e56
+  data.tar.gz: 9d5c9882b1eb73901e253f64915c3647c38453357560d9ec836a29163aa3b6f24a10b485b1007751e3600f81a4e4a9cb8eb0a37204af35d87cc216934b7530c2

data/CHANGELOG.md

@@ -2,6 +2,34 @@
 
 ## master
 
+## 1.3.1 (2023-05-12)
+
+- Fix gRPC health check response for an empty service. ([@palkan][])
+
+As per [docs](https://github.com/grpc/grpc/blob/master/doc/health-checking.md), an empty service is used as the key for server's overall health status. So, if we serve any services, we should return `SERVING` status.
+
+- Add gRPC health check when using grpc_kit. ([@palkan][])
+
+## 1.3.0 (2023-02-28)
+
+- Add configuration presets. ([@palkan][])
+
+Provide sensible defaults matching current platform (e.g., Fly.io).
+
+- Require Ruby 2.7+ and Anyway Config 2.2+.
+
+- Add `rpc_max_connection_age` option (if favour of `rpc_server_args.max_connection_age_ms`) and configured its **default value to be 300 (5 minutes)**. ([@palkan][])
+
+- (_Experimental_) Add support for [grpc_kit](https://github.com/cookpad/grpc_kit) as an alternative gRPC implementation. ([@palkan][], [@cylon-v][])
+
+Add `grpc_kit` to your Gemfile and specify `ANYCABLE_GRPC_IMPL=grpc_kit` env var to use it.
+
+- Setting the redis driver to ruby specified. ([@smasry][])
+
+- Add mutual TLS support for connections to Redis. ([@Envek][])
+
+  `ANYCABLE_REDIS_TLS_CLIENT_CERT_PATH` and `ANYCABLE_REDIS_TLS_CLIENT_KEY_PATH` settings to specify client certificate and key when connecting to Redis server that requires clients to authenticate themselves.
+
 ## 1.2.5 (2022-12-01)
 
 - Add `ANYCABLE_REDIS_TLS_VERIFY` setting to disable validation of Redis server TLS certificate. ([@Envek][])
@@ -132,7 +160,6 @@ See [#71](https://github.com/anycable/anycable/pull/71).
 See [Changelog](https://github.com/anycable/anycable/blob/0-6-stable/CHANGELOG.md) for versions <1.0.0.
 
 [@palkan]: https://github.com/palkan
-[@sponomarev]: https://github.com/sponomarev
-[@bibendi]: https://github.com/bibendi
 [@smasry]: https://github.com/smasry
 [@Envek]: https://github.com/Envek
+[@cylon-v]: https://github.com/cylon-v

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2017-2022 Vladimir Dementyev
+Copyright 2017-2023 Vladimir Dementyev
 
 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,5 +1,6 @@
 [![Gem Version](https://badge.fury.io/rb/anycable.svg)](https://rubygems.org/gems/anycable)
 [![Build](https://github.com/anycable/anycable/workflows/Build/badge.svg)](https://github.com/anycable/anycable/actions)
+[![Coverage Status](https://coveralls.io/repos/github/anycable/anycable/badge.svg?branch=master)](https://coveralls.io/github/anycable/anycable?branch=master)
 [![Documentation](https://img.shields.io/badge/docs-link-brightgreen.svg)](https://docs.anycable.io/v1)
 
 # AnyCable
@@ -18,8 +19,8 @@ AnyCable uses the same protocol as ActionCable, so you can use its [JavaScript c
 
 ## Requirements
 
-- Ruby >= 2.6
-- Redis (for broadcasting **in production**, [discuss other options](https://github.com/anycable/anycable/issues/2) with us!)
+- Ruby >= 2.7
+- Redis or NATS (for broadcasting **in production**, [discuss other options](https://github.com/anycable/anycable/issues/2) with us!)
 
 ## Usage
 
@@ -27,6 +28,8 @@ Check out our 📑 [Documentation](https://docs.anycable.io/v1).
 
 ## Links
 
+- [AnyCable off Rails: connecting Twilio streams with Hanami](https://evilmartians.com/chronicles/anycable-goes-off-rails-connecting-twilio-streams-with-hanami)
+
 - [AnyCable 1.0: Four years of real-time web with Ruby and Go](https://evilmartians.com/chronicles/anycable-1-0-four-years-of-real-time-web-with-ruby-and-go)
 
 - [AnyCable: Action Cable on steroids!](https://evilmartians.com/chronicles/anycable-actioncable-on-steroids)

data/lib/anycable/broadcast_adapters/http.rb

@@ -118,7 +118,7 @@ module AnyCable
           yield http
         rescue Timeout::Error, *RECOVERABLE_EXCEPTIONS => e
           retry_count += 1
-          if MAX_ATTEMPTS < retry_count
+          if retry_count > MAX_ATTEMPTS
             logger.error("Broadcast request failed: #{e.message}")
             return
           end

data/lib/anycable/broadcast_adapters/nats.rb

@@ -31,6 +31,7 @@ module AnyCable
       )
         options = AnyCable.config.to_nats_params.merge(options)
         @nats_conn = ::NATS.connect(nil, options)
+        setup_listeners(nats_conn)
         @channel = channel
       end
 
@@ -41,6 +42,19 @@ module AnyCable
       def announce!
         logger.info "Broadcasting NATS channel: #{channel}"
       end
+
+      private
+
+      def setup_listeners(nats_client)
+        nats_client.on_disconnect { logger.info "NATS client disconnected" }
+        nats_client.on_reconnect do
+          info = nats_client.server_info
+          logger.info "NATS client reconnected: host=#{info[:host]}:#{info[:port]} cluster=#{info[:cluster]}"
+        end
+        nats_client.on_error do |err|
+          logger.warn "NATS client error: #{err.message}"
+        end
+      end
     end
   end
 end

data/lib/anycable/broadcast_adapters/redis.rb

@@ -21,7 +21,7 @@ module AnyCable
     #
     # You can override these params:
     #
-    #   AnyCable.broadcast_adapter = :redis, url: "redis://my_redis", channel: "_any_cable_"
+    #   AnyCable.broadcast_adapter = :redis, { url: "redis://my_redis", channel: "_any_cable_" }
     class Redis < Base
       attr_reader :redis_conn, :channel
 
@@ -30,7 +30,7 @@ module AnyCable
         **options
       )
         options = AnyCable.config.to_redis_params.merge(options)
-        options[:driver] = :ruby
+        options[:driver] ||= :ruby
         @redis_conn = ::Redis.new(**options)
         @channel = channel
       end

data/lib/anycable/broadcast_adapters.rb

@@ -3,7 +3,7 @@
 require "anycable/broadcast_adapters/base"
 
 module AnyCable
-  module BroadcastAdapters # :nodoc:
+  module BroadcastAdapters
     module_function
 
     def lookup_adapter(args)

data/lib/anycable/cli.rb

@@ -333,7 +333,7 @@ module AnyCable
             $ anycable [options]
 
           CLI
-              -r, --require=path                Location of application file to require, default: "config/environment.rb"
+              -r, --require=path                Location of application file to require, default candidates: #{APP_CANDIDATES.join(", ")}
               --server-command=command          Command to run WebSocket server
               -v, --version                     Print version and exit
               -h, --help                        Show this help

data/lib/anycable/config.rb

@@ -21,6 +21,8 @@ module AnyCable
     config_name :anycable
 
     attr_config(
+      presets: "",
+
       ## PubSub
       broadcast_adapter: :redis,
 
@@ -29,6 +31,8 @@ module AnyCable
       redis_sentinels: nil,
       redis_channel: "__anycable__",
       redis_tls_verify: false,
+      redis_tls_client_cert_path: nil,
+      redis_tls_client_key_path: nil,
 
       ### NATS options
       nats_servers: "nats://localhost:4222",
@@ -54,23 +58,21 @@ module AnyCable
       sid_header_enabled: true
     )
 
-    if respond_to?(:coerce_types)
-      coerce_types(
-        redis_sentinels: {type: nil, array: true},
-        nats_servers: {type: nil, array: true},
-        redis_tls_verify: :boolean,
-        nats_dont_randomize_servers: :boolean,
-        debug: :boolean,
-        version_check_enabled: :boolean
-      )
-    end
+    coerce_types(
+      presets: {type: nil, array: true},
+      redis_sentinels: {type: nil, array: true},
+      nats_servers: {type: nil, array: true},
+      redis_tls_verify: :boolean,
+      nats_dont_randomize_servers: :boolean,
+      debug: :boolean,
+      version_check_enabled: :boolean
+    )
 
     flag_options :debug, :nats_dont_randomize_servers
     ignore_options :nats_options
 
-    on_load do
-      # @type self : AnyCable::Config
-      self.debug = debug != false
+    def load(*)
+      super.tap { load_presets }
     end
 
     def log_level
@@ -97,6 +99,8 @@ module AnyCable
           --redis-channel=name              Redis channel for broadcasting, default: "__anycable__"
           --redis-sentinels=<...hosts>      Redis Sentinel followers addresses (as a comma-separated list), default: nil
           --redis-tls-verify=yes|no         Whether to perform server certificate check in case of rediss:// protocol. Default: yes
+          --redis-tls-client_cert-path=path Default: nil
+          --redis-tls-client_key-path=path  Default: nil
 
       NATS PUB/SUB
           --nats-servers=<...addresses>     NATS servers for pub/sub, default: "nats://localhost:4222"
@@ -122,9 +126,23 @@ module AnyCable
 
         params[:sentinels] = sentinels.map { |sentinel| parse_sentinel(sentinel) }
       end.tap do |params|
-        next unless redis_url.match?(/rediss:\/\//) && !redis_tls_verify?
-
-        params[:ssl_params] = {verify_mode: OpenSSL::SSL::VERIFY_NONE}
+        next unless redis_url.match?(/rediss:\/\//)
+
+        if !!redis_tls_client_cert_path ^ !!redis_tls_client_key_path
+          raise_validation_error "Both Redis TLS client certificate and private key must be specified (or none of them)"
+        end
+
+        if !redis_tls_verify?
+          params[:ssl_params] = {verify_mode: OpenSSL::SSL::VERIFY_NONE}
+        else
+          cert_path, key_path = redis_tls_client_cert_path, redis_tls_client_key_path
+          if cert_path && key_path
+            params[:ssl_params] = {
+              cert: OpenSSL::X509::Certificate.new(File.read(cert_path)),
+              key: OpenSSL::PKey.read(File.read(key_path))
+            }
+          end
+        end
       end
     end
 
@@ -155,5 +173,42 @@ module AnyCable
         opts[:password] = uri.password if uri.password
       end
     end
+
+    def load_presets
+      if presets.nil? || presets.empty?
+        self.presets = detect_presets
+        __trace__&.record_value(presets, :presets, type: :env)
+      end
+
+      return if presets.empty?
+
+      presets.each { send(:"load_#{_1}_presets") if respond_to?(:"load_#{_1}_presets", true) }
+    end
+
+    def detect_presets
+      [].tap do
+        _1 << "fly" if ENV.key?("FLY_APP_NAME") && ENV.key?("FLY_ALLOC_ID") && ENV.key?("FLY_REGION")
+      end
+    end
+
+    def load_fly_presets
+      write_preset(:rpc_host, "0.0.0.0:50051", preset: "fly")
+
+      ws_app_name = ENV["ANYCABLE_FLY_WS_APP_NAME"]
+      return unless ws_app_name
+
+      region = ENV.fetch("FLY_REGION")
+
+      write_preset(:http_broadcast_url, "http://#{region}.#{ws_app_name}.internal:8090/_broadcast", preset: "fly")
+      write_preset(:nats_servers, "nats://#{region}.#{ws_app_name}.internal:4222", preset: "fly")
+    end
+
+    def write_preset(key, value, preset:)
+      # do not override explicitly provided values
+      return unless __trace__&.dig(key.to_s)&.source&.dig(:type) == :defaults
+
+      write_config_attr(key, value)
+      __trace__&.record_value(value, key, type: :preset, preset: preset)
+    end
   end
 end

data/lib/anycable/grpc/config.rb

@@ -3,13 +3,12 @@
 AnyCable::Config.attr_config(
   ### gRPC options
   rpc_host: "127.0.0.1:50051",
-  # For defaults see https://github.com/grpc/grpc/blob/51f0d35509bcdaba572d422c4f856208162022de/src/ruby/lib/grpc/generic/rpc_server.rb#L186-L216
-  rpc_pool_size: ::GRPC::RpcServer::DEFAULT_POOL_SIZE,
-  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,
-  # https://github.com/grpc/grpc/blob/f526602bff029b8db50a8d57134d72da33d8a752/include/grpc/impl/codegen/grpc_types.h#L141-L351
+  rpc_pool_size: 30,
+  rpc_max_waiting_requests: 20,
+  rpc_poll_period: 1,
+  rpc_pool_keep_alive: 0.25,
   rpc_server_args: {},
+  rpc_max_connection_age: 300,
   log_grpc: false
 )
 
@@ -33,7 +32,7 @@ module AnyCable
           max_waiting_requests: rpc_max_waiting_requests,
           poll_period: rpc_poll_period,
           pool_keep_alive: rpc_pool_keep_alive,
-          server_args: normalized_grpc_server_args
+          server_args: enhance_grpc_server_args(normalized_grpc_server_args)
         }
       end
 
@@ -46,6 +45,14 @@ module AnyCable
           skey.start_with?("grpc.") ? skey : "grpc.#{skey}"
         end
       end
+
+      def enhance_grpc_server_args(opts)
+        return opts if opts.key?("grpc.max_connection_age_ms")
+        return opts unless rpc_max_connection_age.to_i > 0
+
+        opts["grpc.max_connection_age_ms"] = rpc_max_connection_age.to_i * 1000
+        opts
+      end
     end
   end
 end

data/lib/anycable/grpc/server.rb

@@ -98,7 +98,7 @@ module AnyCable
         )
         health_checker.add_status(
           "",
-          Grpc::Health::V1::HealthCheckResponse::ServingStatus::NOT_SERVING
+          Grpc::Health::V1::HealthCheckResponse::ServingStatus::SERVING
         )
         health_checker
       end

data/lib/anycable/grpc_kit/health_checker.rb

@@ -0,0 +1,72 @@
+# Copyright 2015 gRPC authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Grpc
+  # Health contains classes and modules that support providing a health check
+  # service.
+  module Health
+    # Checker is implementation of the schema-specified health checking service.
+    class Checker < V1::Health::Service
+      StatusCodes = GRPC::Core::StatusCodes
+      HealthCheckResponse = V1::HealthCheckResponse
+
+      # Initializes the statuses of participating services
+      def initialize
+        @statuses = {}
+        @status_mutex = Mutex.new  # guards access to @statuses
+      end
+
+      # Implements the rpc IDL API method
+      def check(req, _call)
+        status = nil
+        @status_mutex.synchronize do
+          status = @statuses["#{req.service}"]
+        end
+        if status.nil?
+          fail GRPC::NotFound.new("Service is not found: #{req.service}")
+        end
+        HealthCheckResponse.new(status: status)
+      end
+
+      # Adds the health status for a given service.
+      def add_status(service, status)
+        @status_mutex.synchronize { @statuses["#{service}"] = status }
+      end
+
+      # Adds given health status for all given services
+      def set_status_for_services(status, *services)
+        @status_mutex.synchronize do
+          services.each { |service| @statuses["#{service}"] = status }
+        end
+      end
+
+      # Adds health status for each service given within hash
+      def add_statuses(service_statuses = {})
+        @status_mutex.synchronize do
+          service_statuses.each_pair { |service, status| @statuses["#{service}"] = status }
+        end
+      end
+
+      # Clears the status for the given service.
+      def clear_status(service)
+        @status_mutex.synchronize { @statuses.delete("#{service}") }
+      end
+
+      # Clears alls the statuses.
+      def clear_all
+        @status_mutex.synchronize { @statuses = {} }
+      end
+    end
+  end
+end

data/lib/anycable/grpc_kit/health_pb.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: grpc/health/v1/health.proto
+
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "grpc.health.v1.HealthCheckRequest" do
+    optional :service, :string, 1
+  end
+  add_message "grpc.health.v1.HealthCheckResponse" do
+    optional :status, :enum, 1, "grpc.health.v1.HealthCheckResponse.ServingStatus"
+  end
+  add_enum "grpc.health.v1.HealthCheckResponse.ServingStatus" do
+    value :UNKNOWN, 0
+    value :SERVING, 1
+    value :NOT_SERVING, 2
+  end
+end
+
+module Grpc
+  module Health
+    module V1
+      HealthCheckRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("grpc.health.v1.HealthCheckRequest").msgclass
+      HealthCheckResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("grpc.health.v1.HealthCheckResponse").msgclass
+      HealthCheckResponse::ServingStatus = Google::Protobuf::DescriptorPool.generated_pool.lookup("grpc.health.v1.HealthCheckResponse.ServingStatus").enummodule
+    end
+  end
+end

data/lib/anycable/grpc_kit/health_services_pb.rb

@@ -0,0 +1,41 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: grpc/health/v1/health.proto for package 'grpc.health.v1'
+# Original file comments:
+# Copyright 2015 The gRPC Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# The canonical version of this proto can be found at
+# https://github.com/grpc/grpc-proto/blob/master/grpc/health/v1/health.proto
+#
+
+module Grpc
+  module Health
+    module V1
+      module Health
+        class Service
+
+          include GRPC::GenericService
+
+          self.marshal_class_method = :encode
+          self.unmarshal_class_method = :decode
+          self.service_name = 'grpc.health.v1.Health'
+
+          rpc :Check, HealthCheckRequest, HealthCheckResponse
+        end
+
+        Stub = Service.rpc_stub_class
+      end
+    end
+  end
+end

data/lib/anycable/grpc_kit/server.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+require "anycable/grpc/handler"
+
+require_relative "./health_pb"
+require_relative "./health_services_pb"
+require_relative "./health_checker"
+
+module AnyCable
+  module GRPC
+    raise LoadError, "AnyCable::GRPC::Server has been already loaded!" if defined?(AnyCable::GRPC::Server)
+
+    using(Module.new do
+      refine ::GrpcKit::Server do
+        attr_reader :max_pool_size
+
+        def stopped?
+          @stopping
+        end
+      end
+    end)
+
+    # Wrapper over gRPC kit server.
+    #
+    # Basic example:
+    #
+    #   # create new server listening on the loopback interface with 50051 port
+    #   server = AnyCable::GrpcKit::Server.new(host: "127.0.0.1:50051")
+    #
+    #   # run gRPC server in bakground
+    #   server.start
+    #
+    #   # stop server
+    #   server.stop
+    class Server
+      attr_reader :grpc_server, :host, :hostname, :port, :sock
+
+      def initialize(host:, logger: nil, **options)
+        @logger = logger
+        @host = host
+
+        host_parts = host.match(/\A(?<hostname>.+):(?<port>\d{2,5})\z/)
+
+        @hostname = host_parts[:hostname]
+        @port = host_parts[:port].to_i
+
+        @grpc_server = build_server(**options)
+      end
+
+      # Start gRPC server in background and
+      # wait untill it ready to accept connections
+      def start
+        return if running?
+
+        raise "Cannot re-start stopped server" if stopped?
+
+        logger.info "RPC server (grpc_kit) is starting..."
+
+        @sock = TCPServer.new(hostname, port)
+
+        server = grpc_server
+
+        @start_thread = Thread.new do
+          loop do
+            conn = @sock.accept
+            server.run(conn)
+          rescue IOError
+            # ignore broken connections
+          end
+        end
+
+        wait_till_running
+
+        logger.info "RPC server is listening on #{host} (workers_num: #{grpc_server.max_pool_size})"
+      end
+
+      def wait_till_running
+        raise "Server is not running" unless running?
+
+        timeout = 5
+
+        loop do
+          sock = TCPSocket.new(hostname, port, connect_timeout: 1)
+          stub = ::Grpc::Health::V1::Health::Stub.new(sock)
+          stub.check(::Grpc::Health::V1::HealthCheckRequest.new)
+          sock.close
+          break
+        rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH, SocketError
+          timeout -= 1
+          raise "Server is not responding" if timeout.zero?
+        end
+      end
+
+      def wait_till_terminated
+        raise "Server is not running" unless running?
+
+        start_thread.join
+      end
+
+      # Stop gRPC server if it's running
+      def stop
+        return unless running?
+
+        return if stopped?
+
+        grpc_server.graceful_shutdown
+        sock.close
+
+        logger.info "RPC server stopped"
+      end
+
+      def running?
+        !!sock
+      end
+
+      def stopped?
+        grpc_server.stopped?
+      end
+
+      private
+
+      attr_reader :start_thread
+
+      def logger
+        @logger ||= AnyCable.logger
+      end
+
+      def build_server(**options)
+        pool_size = options[:pool_size]
+
+        ::GrpcKit::Server.new(min_pool_size: pool_size, max_pool_size: pool_size).tap do |server|
+          server.handle(AnyCable::GRPC::Handler)
+          server.handle(build_health_checker)
+        end
+      end
+
+      def build_health_checker
+        health_checker = ::Grpc::Health::Checker.new
+        health_checker.add_status(
+          "anycable.RPC",
+          ::Grpc::Health::V1::HealthCheckResponse::ServingStatus::SERVING
+        )
+        health_checker.add_status(
+          "",
+          ::Grpc::Health::V1::HealthCheckResponse::ServingStatus::SERVING
+        )
+        health_checker
+      end
+    end
+  end
+end

data/lib/anycable/grpc_kit.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "grpc_kit"
+
+module AnyCable
+  module GRPC
+  end
+end
+
+require "anycable/grpc/config"
+require "anycable/grpc_kit/server"
+
+AnyCable.server_builder = ->(config) {
+  AnyCable.logger.info "gRPC Kit version: #{::GrpcKit::VERSION}"
+
+  ::GrpcKit.loglevel = :fatal
+  ::GrpcKit.logger = AnyCable.logger if config.log_grpc?
+
+  params = config.to_grpc_params
+
+  AnyCable::GRPC::Server.new(**params, host: config.rpc_host)
+}

data/lib/anycable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AnyCable
-  VERSION = "1.2.5"
+  VERSION = "1.3.1"
 end

data/lib/anycable.rb

@@ -109,11 +109,23 @@ module AnyCable
   end
 end
 
-# gRPC is the default for now, so, let's try to load it.
-begin
-  require "anycable/grpc"
-rescue LoadError => e
-  # Re-raise an exception if we failed to load grpc .so files
-  # (e.g., on Alpine Linux)
-  raise if /(error loading shared library|incompatible architecture)/i.match?(e.message)
+# Try loading a gRPC implementation
+impl = ENV.fetch("ANYCABLE_GRPC_IMPL", "grpc")
+
+case impl
+when "grpc"
+  begin
+    require "grpc/version"
+    require "anycable/grpc"
+  rescue LoadError => e
+    # Re-raise an exception if we failed to load grpc .so files
+    # (e.g., on Alpine Linux)
+    raise if /(error loading shared library|incompatible architecture)/i.match?(e.message)
+  end
+when "grpc_kit"
+  begin
+    require "grpc_kit/version"
+    require "anycable/grpc_kit"
+  rescue LoadError
+  end
 end

data/sig/anycable/broadcast_adapters/nats.rbs

@@ -5,6 +5,10 @@ module AnyCable
       attr_reader channel: String
 
       def initialize: (?channel: String channel, **untyped options) -> void
+
+      private
+
+      def setup_listeners: (untyped nats_conn) -> void
     end
   end
 end

data/sig/anycable/config.rbs

@@ -1,5 +1,7 @@
 module AnyCable
   interface _Config
+    def presets: () -> Array[String]
+    def presets=: (Array[String]) -> void
     def broadcast_adapter: () -> Symbol
     def broadcast_adapter=: (Symbol) -> void
     def redis_url: () -> String
@@ -9,14 +11,19 @@ module AnyCable
     def redis_channel: () -> String
     def redis_channel=: (String) -> void
     def redis_tls_verify: () -> bool
-    def redis_tls_verify?: () -> bool
     def redis_tls_verify=: (bool) -> void
+    def redis_tls_verify?: () -> bool
+    def redis_tls_client_cert_path: () -> String?
+    def redis_tls_client_cert_path=: (String) -> void
+    def redis_tls_client_key_path: () -> String?
+    def redis_tls_client_key_path=: (String) -> void
     def nats_servers: () -> Array[String]
     def nats_servers=: (Array[String]) -> void
     def nats_channel: () -> String
     def nats_channel=: (String) -> void
     def nats_dont_randomize_servers: () -> bool
     def nats_dont_randomize_servers=: (bool) -> void
+    def nats_dont_randomize_servers?: () -> bool
     def nats_options: () -> Hash[untyped, untyped]
     def nats_options=: (Hash[untyped, untyped]) -> void
     def http_broadcast_url: () -> String
@@ -29,12 +36,17 @@ module AnyCable
     def log_level=: (String) -> void
     def debug: () -> bool
     def debug=: (bool) -> void
+    def debug?: () -> bool
     def http_health_port: () -> Integer?
     def http_health_port=: (Integer) -> void
     def http_health_path: () -> String
     def http_health_path=: (String) -> void
     def version_check_enabled: () -> bool
     def version_check_enabled=: (bool) -> void
+    def version_check_enabled?: () -> bool
+    def sid_header_enabled: () -> bool
+    def sid_header_enabled=: (bool) -> void
+    def sid_header_enabled?: () -> bool
   end
 
   class Config < Anyway::Config
@@ -46,6 +58,7 @@ module AnyCable
     alias debug? debug
     alias version_check_enabled? version_check_enabled
 
+    def load: (*untyped) -> void
     def http_health_port_provided?: () -> bool
     def to_redis_params: () -> { url: String, sentinels: Array[untyped]?, ssl_params: Hash[Symbol, untyped]? }
     def to_http_health_params: () -> { port: Integer?, path: String }
@@ -54,5 +67,10 @@ module AnyCable
     private
 
     def parse_sentinel: ((String | Hash[untyped, untyped]) sentinel) -> Hash[Symbol, untyped]
+    def load_presets: () -> void
+    def detect_presets: () -> Array[String]
+    def write_preset: (Symbol, untyped, preset: String) -> void
+    def write_config_attr: (Symbol, untyped) -> void
+    def __trace__: () -> untyped
   end
 end

data/sig/anycable/grpc/config.rbs

@@ -7,30 +7,38 @@ module AnyCable
       def rpc_pool_size=: (Integer) -> void
       def rpc_max_waiting_requests: () -> Integer
       def rpc_max_waiting_requests=: (Integer) -> void
-      def rpc_poll_period: () -> Integer
-      def rpc_poll_period=: (Integer) -> void
-      def rpc_pool_keep_alive: () -> Integer
-      def rpc_pool_keep_alive=: (Integer) -> void
+      def rpc_poll_period: () -> Numeric
+      def rpc_poll_period=: (Numeric) -> void
+      def rpc_pool_keep_alive: () -> Numeric
+      def rpc_pool_keep_alive=: (Numeric) -> void
+      def rpc_max_connection_age: () -> Integer
+      def rpc_max_connection_age=: (Integer) -> void
       def rpc_server_args: () -> Hash[Symbol | String, untyped]?
       def rpc_server_args=: (Hash[Symbol | String, untyped]) -> void
       def log_grpc: () -> bool
       def log_grpc=: (bool) -> void
+      def log_grpc?: () -> bool
     end
 
-    module Config : AnyCable::Config
+    module Config : AnyCable::_Config
       include _Config
 
-      alias log_grpc? log_grpc
-
       def to_grpc_params: () -> {
         pool_size: Integer,
         max_waiting_requests: Integer,
-        poll_period: Integer,
-        pool_keep_alive: Integer,
+        poll_period: Numeric,
+        pool_keep_alive: Numeric,
         server_args: Hash[String, untyped]
       }
 
       def normalized_grpc_server_args: () -> Hash[String, untyped]
+      def enhance_grpc_server_args: (Hash[String, untyped]) -> Hash[String, untyped]
     end
   end
 end
+
+module AnyCable
+  class Config
+    include GRPC::Config
+  end
+end

data/sig/anycable/grpc/server.rbs

@@ -6,7 +6,7 @@ module AnyCable
       attr_reader grpc_server: untyped
       attr_reader host: String
 
-      def initialize: (host: String, ?logger: Logger, **untyped options) -> void
+      def initialize: (host: String, ?logger: Logger?, **untyped options) -> void
 
       private
 

data/sig/anycable/health_server.rbs

@@ -12,7 +12,7 @@ module AnyCable
     attr_reader path: String
     attr_reader http_server: untyped
 
-    def initialize: (_Runnable server, port: Integer port, ?logger: Logger logger, ?path: String path) -> void
+    def initialize: (_Runnable server, port: Integer port, ?logger: Logger? logger, ?path: String path) -> void
     def start: () -> void
     def stop: () -> void
     def running?: () -> bool

data/sig/anycable/middleware.rbs

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

data/sig/anycable/rpc.rbs

@@ -12,6 +12,12 @@ module AnyCable
   type protoMap = _ProtobufMap
   type rpcMetadata = Hash[String, String]
 
+  module Status
+    SUCCESS: 0
+    FAILURE: 1
+    ERROR: 2
+  end
+
   interface _WithEnvState
     def cstate: () -> protoMap?
     def cstate=: (protoMap) -> void

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: anycable-core
 version: !ruby/object:Gem::Version
-  version: 1.2.5
+  version: 1.3.1
 platform: ruby
 authors:
 - palkan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-01 00:00:00.000000000 Z
+date: 2023-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: anyway_config
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: google-protobuf
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +122,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov-lcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -181,6 +209,11 @@ files:
 - lib/anycable/grpc/handler.rb
 - lib/anycable/grpc/rpc_services_pb.rb
 - lib/anycable/grpc/server.rb
+- lib/anycable/grpc_kit.rb
+- lib/anycable/grpc_kit/health_checker.rb
+- lib/anycable/grpc_kit/health_pb.rb
+- lib/anycable/grpc_kit/health_services_pb.rb
+- lib/anycable/grpc_kit/server.rb
 - lib/anycable/health_server.rb
 - lib/anycable/middleware.rb
 - lib/anycable/middleware_chain.rb
@@ -241,14 +274,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.11
+rubygems_version: 3.4.8
 signing_key:
 specification_version: 4
 summary: AnyCable core RPC implementation