anycable-core 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4c85f8eab809e414507ed9e35da7381b9ca2626ad4c9e2e4f84a5ee8dda2d09
-  data.tar.gz: 37edd04f4c524384c989a774f94e7a8ede624f7fe95e3a6f1a864f2c11f03b4e
+  metadata.gz: 5f387a5b5a0a7535f698339c719f4f7f8debd3c799f5e69b7b54b46b599d3830
+  data.tar.gz: 558f452d571cd33557836861083539fa130c266d5ded16764f0137a9494c39d2
 SHA512:
-  metadata.gz: 15602cd4712a4a451e41c03035b176d0fc276593852ab93f386e588d297f7a3e7be8284e8feb952fb19b8a0918973edb48c6a9ce2bd0fb8a63a0ceb068c12730
-  data.tar.gz: a8453ffddde915bd88e2c5fd8cad6178194c8ca7ad3193f617157c6a92b5504022d4a11572e7bb61cc9157897857ab00b7dbab609961ee9ad7d9b55321f66ea9
+  metadata.gz: 819b9da9e51dae8e6feca6be71550c72e3aaee4358e8245c95235a030f9ee130d3b49d48590eb3d4abc8275a7918c71130b48fd63e3b4b9a5fd46d34520942c7
+  data.tar.gz: c3409d81a2b9c66593384de64d0cc66ac1c31d915d58a836af1c222438d152f18ca86830a86c7867b784ba2159aa80787a5abd5ea3b50d8edd99b835d572bbe8

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## master
 
+## 1.2.1 (2022-02-21)
+
+- Fix RBS signature. ([@palkan][])
+
+- Add empty (`''`) service to gRPC health check as "NOT_SERVING". ([@palkan][])
+
 ## 1.2.0 (2021-12-21) 🎄
 
 - Drop Ruby 2.6 support.

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2017-2021 Vladimir Dementyev
+Copyright 2017-2022 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,6 +1,5 @@
 [![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)
-[![Gitter](https://img.shields.io/badge/gitter-join%20chat%20%E2%86%92-brightgreen.svg)](https://gitter.im/anycable/Lobby)
 [![Documentation](https://img.shields.io/badge/docs-link-brightgreen.svg)](https://docs.anycable.io/v1)
 
 # AnyCable

data/lib/anycable/broadcast_adapters/redis.rb

@@ -30,7 +30,7 @@ module AnyCable
         **options
       )
         options = AnyCable.config.to_redis_params.merge(options)
-        @redis_conn = ::Redis.new(options)
+        @redis_conn = ::Redis.new(**options)
         @channel = channel
       end
 

data/lib/anycable/cli.rb

@@ -119,7 +119,7 @@ module AnyCable
     def wait_till_terminated
       self_read = setup_signals
 
-      while readable_io = IO.select([self_read]) # rubocop:disable Lint/AssignmentInCondition
+      while readable_io = IO.select([self_read]) # rubocop:disable Lint/AssignmentInCondition,Lint/IncompatibleIoSelectWithFiberScheduler
         signal = readable_io.first[0].gets.strip
         raise Interrupt, "SIG#{signal} received"
       end

data/lib/anycable/config.rb

@@ -74,7 +74,7 @@ module AnyCable
 
       HTTP HEALTH CHECKER
           --http-health-port=port           Port to run HTTP health server on, default: <none> (disabled)
-          --http-health-path=path           Endpoint to server health cheks, default: "/health"
+          --http-health-path=path           Endpoint to serve health checks, default: "/health"
 
       REDIS PUB/SUB
           --redis-url=url                   Redis URL for pub/sub, default: REDIS_URL or "redis://localhost:6379/5"

data/lib/anycable/grpc/server.rb

@@ -96,6 +96,10 @@ module AnyCable
           "anycable.RPC",
           Grpc::Health::V1::HealthCheckResponse::ServingStatus::SERVING
         )
+        health_checker.add_status(
+          "",
+          Grpc::Health::V1::HealthCheckResponse::ServingStatus::NOT_SERVING
+        )
         health_checker
       end
     end

data/lib/anycable/health_server.rb

@@ -65,7 +65,15 @@ module AnyCable
         AccessLog: []
       ).tap do |http_server|
         http_server.mount_proc path do |_, res|
-          res.status, res.body = server.running? ? SUCCESS_RESPONSE : FAILURE_RESPONSE
+          # Replace with mass assignment as soon as Steep added support
+          # https://github.com/soutaro/steep/issues/424
+          if server.running?
+            res.status = SUCCESS_RESPONSE.first
+            res.body = SUCCESS_RESPONSE.last
+          else
+            res.status = FAILURE_RESPONSE.first
+            res.body = FAILURE_RESPONSE.last
+          end
         end
       end
     end

data/lib/anycable/socket.rb

@@ -116,22 +116,23 @@ module AnyCable
     # Build Rack env from request
     def build_rack_env
       uri = URI.parse(request_env.url)
+      headers = request_env.headers.to_h
 
       env = base_rack_env
       env.merge!({
         "PATH_INFO" => uri.path,
         "QUERY_STRING" => uri.query,
         "SERVER_NAME" => uri.host,
-        "SERVER_PORT" => uri.port,
+        "SERVER_PORT" => uri.port&.to_s,
         "HTTP_HOST" => uri.host,
-        "REMOTE_ADDR" => request_env.headers.delete("REMOTE_ADDR"),
+        "REMOTE_ADDR" => 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))
+      env.merge!(build_headers(headers))
     end
 
     def base_rack_env

data/lib/anycable/version.rb

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

data/lib/anycable.rb

@@ -114,5 +114,5 @@ begin
 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/.match?(e.message)
+  raise if /(error loading shared library|incompatible architecture)/i.match?(e.message)
 end

data/sig/anycable/broadcast_adapters/base.rbs

@@ -0,0 +1,18 @@
+module AnyCable
+  interface _BroadcastAdapter
+    def raw_broadcast: (String _data) -> void
+    def broadcast: (String stream, String payload) -> void
+    def broadcast_command: (String command, **untyped payload) -> void
+    def announce!: () -> void
+  end
+
+  module BroadcastAdapters
+    class Base
+      include _BroadcastAdapter
+
+      private
+
+      def logger: () -> Logger
+    end
+  end
+end

data/sig/anycable/broadcast_adapters/http.rbs

@@ -0,0 +1,31 @@
+module AnyCable
+  module BroadcastAdapters
+    class Http < Base
+      RECOVERABLE_EXCEPTIONS: Array[singleton(Class)]
+      OPEN_TIMEOUT: Integer
+      READ_TIMEOUT: Integer
+      MAX_ATTEMPTS: Integer
+      DELAY: Integer
+
+      attr_reader url: String
+      attr_reader headers: Hash[String, String]
+      attr_reader authorized: bool
+
+      alias authorized? authorized
+
+      def initialize: (?url: String url, ?secret: String secret) -> void
+      def shutdown: () -> void
+
+      private
+
+      attr_reader uri: URI::Generic
+      attr_reader queue: Thread::Queue
+      attr_reader thread: Thread?
+
+      def ensure_thread_is_alive: () -> void
+      def perform_request: (String payload) -> untyped
+      def handle_response: (untyped response) -> void
+      def build_http: () { (untyped) -> untyped } -> untyped
+    end
+  end
+end

data/sig/anycable/broadcast_adapters/redis.rbs

@@ -0,0 +1,10 @@
+module AnyCable
+  module BroadcastAdapters
+    class Redis < Base
+      attr_reader redis_conn: untyped
+      attr_reader channel: String
+
+      def initialize: (?channel: String channel, **untyped options) -> void
+    end
+  end
+end

data/sig/anycable/grpc/config.rbs

@@ -0,0 +1,36 @@
+module AnyCable
+  module GRPC
+    interface _Config
+      def rpc_host: () -> String
+      def rpc_host=: (String) -> void
+      def rpc_pool_size: () -> Integer
+      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_server_args: () -> Hash[Symbol | String, untyped]?
+      def rpc_server_args=: (Hash[Symbol | String, untyped]) -> void
+      def log_grpc: () -> bool
+      def log_grpc=: (bool) -> void
+    end
+
+    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,
+        server_args: Hash[String, untyped]
+      }
+
+      def normalized_grpc_server_args: () -> Hash[String, untyped]
+    end
+  end
+end

data/sig/anycable/grpc/handler.rbs

@@ -0,0 +1,11 @@
+module AnyCable
+  module GRPC
+    # RPC service handler
+    class Handler < AnyCable::GRPC::Service
+      # Handle connection request from WebSocket server
+      def connect: (untyped request, untyped _unused_call) -> untyped
+      def disconnect: (untyped request, untyped _unused_call) -> untyped
+      def command: (untyped request, untyped _unused_call) -> untyped
+    end
+  end
+end

data/sig/anycable/grpc/rpc_services_pb.rbs

@@ -0,0 +1,8 @@
+module AnyCable
+  module GRPC
+    class Service
+    end
+
+    Stub: untyped
+  end
+end

data/sig/anycable/grpc/server.rbs

@@ -0,0 +1,20 @@
+module AnyCable
+  module GRPC
+    class Server
+      include _Server
+
+      attr_reader grpc_server: untyped
+      attr_reader host: String
+
+      def initialize: (host: String, ?logger: Logger, **untyped options) -> void
+
+      private
+
+      attr_reader start_thread: Thread
+
+      def logger: () -> Logger
+      def build_server: (**untyped options) -> untyped
+      def build_health_checker: () -> untyped
+    end
+  end
+end

data/sig/anycable/health_server.rbs

@@ -1,14 +1,18 @@
 module AnyCable
   class HealthServer
+    interface _Runnable
+      def running?: () -> bool
+    end
+
     SUCCESS_RESPONSE: Array[Integer | String]
     FAILURE_RESPONSE: Array[Integer | String]
 
-    attr_reader server: _Server
+    attr_reader server: _Runnable
     attr_reader port: Integer
     attr_reader path: String
     attr_reader http_server: untyped
 
-    def initialize: (_Server 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/middlewares/check_version.rbs

@@ -0,0 +1,10 @@
+module AnyCable
+  module Middlewares
+    class CheckVersion < AnyCable::Middleware
+      attr_reader version: String
+
+      def initialize: (String version) -> void
+      def check_version: (rpcMetadata) { () -> untyped } -> untyped
+    end
+  end
+end

data/sig/anycable/middlewares/exceptions.rbs

@@ -0,0 +1,10 @@
+module AnyCable
+  module Middlewares
+    class Exceptions < AnyCable::Middleware
+      private
+
+      def notify_exception: (StandardError exp, Symbol method_name, rpcRequest request) -> void
+      def response_class: (Symbol method_name) -> untyped
+    end
+  end
+end

data/sig/anycable/rpc/handler.rbs

@@ -0,0 +1,24 @@
+module AnyCable
+  module RPC
+    interface _Handler
+      def build_socket: (env: Env) -> Socket
+      def build_env_response: (Socket socket) -> EnvResponse
+      def logger: () -> Logger
+      def factory: () -> _ConnectionFactory
+    end
+
+    class Handler
+      include _Handler
+      include Handlers::Connect
+      include Handlers::Disconnect
+      include Handlers::Command
+
+      def initialize: (?middleware: MiddlewareChain) -> void
+      def handle: (Symbol cmd, rpcRequest data, ?rpcMetadata meta) -> rpcResponse
+
+      private
+
+      attr_reader middleware: MiddlewareChain
+    end
+  end
+end

data/sig/anycable/rpc/handlers/command.rbs

@@ -0,0 +1,9 @@
+module AnyCable
+  module RPC
+    module Handlers
+      module Command : _Handler
+        def command: (CommandMessage message) -> CommandResponse
+      end
+    end
+  end
+end

data/sig/anycable/rpc/handlers/connect.rbs

@@ -0,0 +1,9 @@
+module AnyCable
+  module RPC
+    module Handlers
+      module Connect : _Handler
+        def connect: (ConnectionRequest request) -> ConnectionResponse
+      end
+    end
+  end
+end

data/sig/anycable/rpc/handlers/disconnect.rbs

@@ -0,0 +1,9 @@
+module AnyCable
+  module RPC
+    module Handlers
+      module Disconnect : _Handler
+        def disconnect: (DisconnectRequest request) -> DisconnectResponse
+      end
+    end
+  end
+end

data/sig/anycable/rpc.rbs

@@ -2,8 +2,14 @@ module AnyCable
   PROTO_VERSION: ::String
   SESSION_KEY: ::String
 
+  interface _ProtobufMap
+    def []: (String key) -> String
+    def []=: (String key, String val) -> String
+    def to_h: () -> Hash[String, String]
+  end
+
   type rpcStatus = 0 | 1 | 2
-  type protoMap = Hash[String, String]
+  type protoMap = _ProtobufMap
   type rpcMetadata = Hash[String, String]
 
   interface _WithEnvState
@@ -38,7 +44,7 @@ module AnyCable
   end
 
   module WithConnectionState : _WithEnv, _ProtoMessage
-    def initialize: (?session: untyped? session, **untyped other) -> untyped
+    %a{rbs:test:skip} def initialize: (?session: untyped? session, **untyped other) -> untyped
 
     def session=: (untyped val) -> untyped
     def session: () -> untyped
@@ -60,8 +66,8 @@ module AnyCable
   class ConnectionRequest
     include _WithEnv
 
-    def initialize: (?env: Env) -> void
-    def to_h: () -> Hash[String, untyped]
+    %a{rbs:test:skip} def initialize: (?env: Env) -> void
+    def to_h: () -> Hash[Symbol, untyped]
   end
 
   class ConnectionResponse
@@ -73,7 +79,7 @@ module AnyCable
     attr_accessor error_msg: String?
     attr_accessor env: EnvResponse
 
-    def initialize: (
+    %a{rbs:test:skip} def initialize: (
       status: rpcStatus,
       ?identifiers: String,
       ?transmissions: Array[String],
@@ -81,7 +87,7 @@ module AnyCable
       ?env: EnvResponse
     ) -> void
 
-    def to_h: () -> Hash[String, untyped]
+    def to_h: () -> Hash[Symbol, untyped]
   end
 
   class CommandMessage
@@ -92,14 +98,14 @@ module AnyCable
     attr_accessor connection_identifiers: String
     attr_accessor data: String
 
-    def initialize: (
+    %a{rbs:test:skip} def initialize: (
       command: String,
       identifier: String,
       ?connection_identifiers: String,
       ?env: Env
     ) -> void
 
-    def to_h: () -> Hash[String, untyped]
+    def to_h: () -> Hash[Symbol, untyped]
   end
 
   class CommandResponse
@@ -114,7 +120,7 @@ module AnyCable
     attr_accessor env: EnvResponse
     attr_accessor stopped_streams: Array[String]
 
-    def initialize: (
+    %a{rbs:test:skip} def initialize: (
       status: rpcStatus,
       ?disconnect: bool,
       ?stop_streams: bool,
@@ -125,7 +131,7 @@ module AnyCable
       ?env: EnvResponse
     ) -> void
 
-    def to_h: () -> Hash[String, untyped]
+    def to_h: () -> Hash[Symbol, untyped]
   end
 
   class DisconnectRequest
@@ -134,8 +140,8 @@ module AnyCable
     attr_accessor identifiers: String
     attr_accessor subscriptions: Array[String]
 
-    def initialize: (identifiers: String, ?subscriptions: Array[String], ?env: Env) -> void
-    def to_h: () -> Hash[String, untyped]
+    %a{rbs:test:skip} def initialize: (identifiers: String, ?subscriptions: Array[String], ?env: Env) -> void
+    def to_h: () -> Hash[Symbol, untyped]
   end
 
   class DisconnectResponse
@@ -144,8 +150,8 @@ module AnyCable
     attr_accessor status: rpcStatus
     attr_accessor error_msg: String?
 
-    def initialize: (status: rpcStatus, ?error_msg: String) -> void
-    def to_h: () -> Hash[String, untyped]
+    %a{rbs:test:skip} def initialize: (status: rpcStatus, ?error_msg: String) -> void
+    def to_h: () -> Hash[Symbol, untyped]
   end
 
   type rpcRequest = ConnectionRequest | DisconnectRequest | CommandMessage

data/sig/anycable/socket.rbs

@@ -2,12 +2,12 @@ module AnyCable
   class Socket
     class State
       attr_reader dirty_keys: Array[String]?
-      attr_reader source: protoMap
+      attr_reader source: Hash[String, String]
 
-      def initialize: (protoMap) -> void
+      def initialize: (Hash[String, String]) -> void
       def read: (String key) -> untyped
       def write: (String key, String val) -> void
-      def changed_fields: () -> protoMap?
+      def changed_fields: () -> Hash[String, String]?
 
       alias [] read
       alias []= write

data/sig/anycable.rbs

@@ -18,7 +18,11 @@ module AnyCable
 
   type serverBuilder = ^(Config) -> _Server
 
-  attr_accessor self.connection_factory: ^(Socket, ?identifiers: String, ?subscriptions: Array[String]) -> _Connection
+  interface _ConnectionFactory
+    def call: (Socket, ?identifiers: String, ?subscriptions: Array[String]) -> _Connection
+  end
+
+  attr_accessor self.connection_factory: _ConnectionFactory
   attr_accessor self.server_builder: serverBuilder
   attr_writer self.logger: Logger
   attr_writer self.rpc_handler: RPC::Handler

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: anycable-core
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - palkan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-21 00:00:00.000000000 Z
+date: 2022-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: anyway_config
@@ -136,20 +136,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: steep
-  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'
 description: AnyCable core RPC implementation not depenending on a particular server
   type (e.g., gRPC or whatever)
 email:
@@ -197,13 +183,26 @@ files:
 - lib/anycable/version.rb
 - sig/anycable.rbs
 - sig/anycable/broadcast_adapters.rbs
+- sig/anycable/broadcast_adapters/base.rbs
+- sig/anycable/broadcast_adapters/http.rbs
+- sig/anycable/broadcast_adapters/redis.rbs
 - sig/anycable/cli.rbs
 - sig/anycable/config.rbs
 - sig/anycable/exceptions_handling.rbs
+- sig/anycable/grpc/config.rbs
+- sig/anycable/grpc/handler.rbs
+- sig/anycable/grpc/rpc_services_pb.rbs
+- sig/anycable/grpc/server.rbs
 - sig/anycable/health_server.rbs
 - sig/anycable/middleware.rbs
 - sig/anycable/middleware_chain.rbs
+- sig/anycable/middlewares/check_version.rbs
+- sig/anycable/middlewares/exceptions.rbs
 - sig/anycable/rpc.rbs
+- sig/anycable/rpc/handler.rbs
+- sig/anycable/rpc/handlers/command.rbs
+- sig/anycable/rpc/handlers/connect.rbs
+- sig/anycable/rpc/handlers/disconnect.rbs
 - sig/anycable/socket.rbs
 - sig/anycable/version.rbs
 homepage: http://github.com/anycable/anycable