anycable-core 1.1.0.pre1

data/lib/anycable/version.rb

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

data/sig/anycable.rbs

@@ -0,0 +1,37 @@
+module AnyCable
+  interface _Server
+    def start: () -> void
+    def wait_till_terminated: () -> void
+    def stop: () -> void
+    def running?: () -> bool
+    def stopped?: () -> bool
+  end
+
+  interface _Connection
+    def handle_open: () -> void
+    def handle_close: () -> void
+    def handle_channel_command: (String identifier, String command, String data) -> void
+    def identifiers_json: () -> String
+  end
+
+  type rackEnv = Hash[String, untyped]
+
+  type serverBuilder = ^(Config) -> _Server
+
+  attr_accessor self.connection_factory: ^(Socket, ?identifiers: String, ?subscriptions: Array[String]) -> _Connection
+  attr_accessor self.server_builder: serverBuilder
+  attr_writer self.logger: Logger
+  attr_writer self.rpc_handler: RPC::Handler
+  attr_accessor self.middleware: MiddlewareChain
+
+  def self.logger: () -> Logger
+  def self.config: () -> Config
+  def self.configure: () { (Config) -> void } -> void
+  def self.capture_exception: () { (StandardError) -> void } -> void
+  def self.configure_server: () { () -> void } -> void
+  def self.server_callbacks: () -> Array[^() -> void]
+  def self.broadcast_adapter: () -> _BroadcastAdapter
+  def self.broadcast_adapter=: (untyped adapter) -> void
+  def self.broadcast: (String channel, String payload) -> void
+  def self.rpc_handler: () -> RPC::Handler
+end

data/sig/anycable/broadcast_adapters.rbs

@@ -0,0 +1,5 @@
+module AnyCable
+  module BroadcastAdapters
+    def self?.lookup_adapter: (untyped args) -> untyped
+  end
+end

data/sig/anycable/cli.rbs

@@ -0,0 +1,40 @@
+module AnyCable
+  class CLI
+    APP_CANDIDATES: Array[String]
+    WAIT_PROCESS: Integer
+    attr_reader server: _Server
+    attr_reader health_server: HealthServer
+    attr_reader embedded: bool
+
+    alias embedded? embedded
+
+    def initialize: (?embedded: bool embedded) -> void
+    def run: (?untyped args) -> void
+    def shutdown: () -> void
+
+    private
+
+    attr_reader boot_file: String?
+    attr_reader server_command: String?
+
+    def config: () -> Config
+    def logger: () -> Logger
+    def at_stop: () { () -> void } -> Array[^() -> void]
+    def wait_till_terminated: () -> void
+    def setup_signals: () -> void
+    def print_version!: () -> void
+    def boot_app!: () -> void
+    def try_detect_app: () -> String?
+    def configure_server!: () -> void
+    def start_health_server!: () -> void
+    def start_pubsub!: () -> void
+    def run_custom_server_command!: () -> void
+    def log_errors!: () -> void
+    def verify_connection_factory!: () -> void
+    def verify_server_builder!: () -> void
+    def parse_gem_options!: (untyped args) -> void
+    def parse_cli_options!: (untyped args) -> void
+    def build_cli_parser: () -> untyped
+    def usage: () -> String
+  end
+end

data/sig/anycable/config.rbs

@@ -0,0 +1,46 @@
+module AnyCable
+  interface _Config
+    def broadcast_adapter: () -> Symbol
+    def broadcast_adapter=: (Symbol) -> void
+    def redis_url: () -> String
+    def redis_url=: (String) -> void
+    def redis_sentinels: () -> Array[String | Hash[untyped, untyped]]?
+    def redis_sentinels=: (Array[String]) -> void
+    def redis_channel: () -> String
+    def redis_channel=: (String) -> void
+    def http_broadcast_url: () -> String
+    def http_broadcast_url=: (String) -> void
+    def http_broadcast_secret: () -> String?
+    def http_broadcast_secret=: (String) -> void
+    def log_file: () -> String?
+    def log_file=: (String) -> void
+    def log_level: () -> String
+    def log_level=: (String) -> void
+    def debug: () -> bool
+    def debug=: (bool) -> void
+    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
+  end
+
+  class Config < Anyway::Config
+    def self.usage: (String txt) -> void
+    def self.usages: () -> Array[String]
+
+    include _Config
+
+    alias debug? debug
+    alias version_check_enabled? version_check_enabled
+
+    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 }
+
+    private
+
+    def parse_sentinel: ((String | Hash[untyped, untyped]) sentinel) -> Hash[Symbol, untyped]
+  end
+end

data/sig/anycable/exceptions_handling.rbs

@@ -0,0 +1,14 @@
+module AnyCable
+  module ExceptionsHandling
+    def self.add_handler: (untyped block) -> untyped
+
+    alias self.<< self.add_handler
+
+    def self.notify: (untyped exp, untyped method_name, untyped message) -> untyped
+
+    private
+
+    def self.procify: (untyped block) -> untyped
+    def self.handlers: () -> untyped
+  end
+end

data/sig/anycable/health_server.rbs

@@ -0,0 +1,21 @@
+module AnyCable
+  class HealthServer
+    SUCCESS_RESPONSE: Array[Integer | String]
+    FAILURE_RESPONSE: Array[Integer | String]
+
+    attr_reader server: _Server
+    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 start: () -> void
+    def stop: () -> void
+    def running?: () -> bool
+
+    private
+
+    def logger: () -> Logger
+    def build_server: () -> untyped
+  end
+end

data/sig/anycable/middleware.rbs

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

data/sig/anycable/middleware_chain.rbs

@@ -0,0 +1,22 @@
+module AnyCable
+  class MiddlewareChain
+    type rpcHandlerBlock = ^(Symbol, rpcRequest) -> 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
+
+    private
+
+    def execute_next_middleware: (Integer ind, Symbol, rpcRequest, rpcHandlerBlock block) -> rpcResponse
+
+    attr_reader mu: untyped
+    attr_reader registry: Array[Middleware]
+
+    def sync: () { () -> untyped } -> untyped
+    def check_frozen!: () -> untyped
+    def build_middleware: (untyped middleware) -> untyped
+  end
+end

data/sig/anycable/rpc.rbs

@@ -0,0 +1,143 @@
+module AnyCable
+  PROTO_VERSION: ::String
+  SESSION_KEY: ::String
+
+  type rpcStatus = 0 | 1 | 2
+  type protoMap = Hash[String, String]
+
+  interface _WithEnvState
+    def cstate: () -> protoMap?
+    def cstate=: (protoMap) -> void
+    def istate: () -> protoMap?
+    def istate=: (protoMap) -> void
+  end
+
+  class Env
+    include _WithEnvState
+
+    attr_accessor url: String
+    attr_accessor headers: protoMap
+
+    def initialize: (?url: String, ?headers: protoMap, ?cstate: protoMap, ?istate: protoMap) -> void
+  end
+
+  class EnvResponse
+    include _WithEnvState
+
+    def initialize: (?cstate: protoMap, ?istate: protoMap) -> void
+  end
+
+  interface _ProtoMessage
+    def initialize: (**untyped) -> void
+  end
+
+  interface _WithEnv
+    def env: () -> Env
+    def env=: (Env) -> void
+  end
+
+  module WithConnectionState : _WithEnv, _ProtoMessage
+    def initialize: (?session: untyped? session, **untyped other) -> untyped
+
+    def session=: (untyped val) -> untyped
+    def session: () -> untyped
+
+    def cstate: () -> protoMap?
+    def cstate=: (protoMap val) -> protoMap
+
+    def istate: () -> protoMap?
+    def istate=: (protoMap val) -> protoMap
+  end
+
+  module StatusPredicates
+    def status: () -> rpcStatus
+    def success?: () -> bool
+    def failure?: () -> bool
+    def error?: () -> bool
+  end
+
+  class ConnectionRequest
+    include _WithEnv
+
+    def initialize: (?env: Env) -> void
+  end
+
+  class ConnectionResponse
+    include StatusPredicates
+
+    attr_accessor status: rpcStatus
+    attr_accessor identifiers: String
+    attr_accessor transmissions: Array[String]
+    attr_accessor error_msg: String?
+    attr_accessor env: EnvResponse
+
+    def initialize: (
+      status: rpcStatus,
+      ?identifiers: String,
+      ?transmissions: Array[String],
+      ?error_msg: String,
+      ?env: EnvResponse
+    ) -> void
+  end
+
+  class CommandMessage
+    include _WithEnv
+
+    attr_accessor command: String
+    attr_accessor identifier: String
+    attr_accessor connection_identifiers: String
+    attr_accessor data: String
+
+    def initialize: (
+      command: String,
+      identifier: String,
+      ?connection_identifiers: String,
+      ?env: Env
+    ) -> void
+  end
+
+  class CommandResponse
+    include StatusPredicates
+
+    attr_accessor status: rpcStatus
+    attr_accessor disconnect: bool
+    attr_accessor stop_streams: bool
+    attr_accessor streams: Array[String]
+    attr_accessor transmissions: Array[String]
+    attr_accessor error_msg: String?
+    attr_accessor env: EnvResponse
+    attr_accessor stopped_streams: Array[String]
+
+    def initialize: (
+      status: rpcStatus,
+      ?disconnect: bool,
+      ?stop_streams: bool,
+      ?streams: Array[String],
+      ?stopped_streams: Array[String],
+      ?transmissions: Array[String],
+      ?error_msg: String,
+      ?env: EnvResponse
+    ) -> void
+  end
+
+  class DisconnectRequest
+    include _WithEnv
+
+    attr_accessor identifiers: String
+    attr_accessor subscriptions: Array[String]
+
+    def initialize: (identifiers: String, ?subscriptions: Array[String], ?env: Env) -> void
+  end
+
+  class DisconnectResponse
+    include StatusPredicates
+
+    attr_accessor status: rpcStatus
+    attr_accessor error_msg: String?
+
+    def initialize: (status: rpcStatus, ?error_msg: String) -> void
+  end
+
+  type rpcRequest = ConnectionRequest | DisconnectRequest | CommandMessage
+  type rpcResponse = ConnectionResponse | DisconnectResponse | CommandResponse
+end

data/sig/anycable/socket.rbs

@@ -0,0 +1,40 @@
+module AnyCable
+  class Socket
+    class State
+      attr_reader dirty_keys: Array[String]?
+      attr_reader source: protoMap
+
+      def initialize: (protoMap) -> void
+      def read: (String key) -> untyped
+      def write: (String key, String val) -> void
+      def changed_fields: () -> protoMap?
+
+      alias [] read
+      alias []= write
+    end
+
+    attr_reader transmissions: Array[String]
+    attr_reader request_env: Env
+
+    def initialize: (env: Env) -> void
+    def transmit: (String) -> void
+    def subscribe: (String, String) -> void
+    def unsubscribe: (String, String) -> void
+    def unsubscribe_from_all: (String) -> void
+    def streams: () -> { start: Array[String], stop: Array[String] }
+    def close: () -> void
+    def closed?: () -> bool
+    def stop_streams?: () -> bool
+    def session: () -> untyped
+    def session=: (untyped val) -> untyped
+    def env: () -> Hash[String, untyped]
+    def cstate: () -> State
+    def istate: () -> State
+
+    private
+
+    def build_rack_env: () -> rackEnv
+    def base_rack_env: () -> rackEnv
+    def build_headers: (untyped headers) -> Hash[String, String]
+  end
+end

data/sig/anycable/version.rbs

@@ -0,0 +1,3 @@
+module AnyCable
+  VERSION: String
+end

metadata

@@ -0,0 +1,237 @@
+--- !ruby/object:Gem::Specification
+name: anycable-core
+version: !ruby/object:Gem::Version
+  version: 1.1.0.pre1
+platform: ruby
+authors:
+- palkan
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-04-28 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
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: google-protobuf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.13'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: webrick
+  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: 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:
+- dementiev.vm@gmail.com
+executables:
+- anycable
+- anycabled
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- MIT-LICENSE
+- README.md
+- bin/anycable
+- bin/anycabled
+- bin/console
+- bin/setup
+- lib/anycable.rb
+- lib/anycable/broadcast_adapters.rb
+- lib/anycable/broadcast_adapters/base.rb
+- lib/anycable/broadcast_adapters/http.rb
+- lib/anycable/broadcast_adapters/redis.rb
+- lib/anycable/cli.rb
+- 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
+- lib/anycable/grpc/server.rb
+- lib/anycable/health_server.rb
+- lib/anycable/middleware.rb
+- lib/anycable/middleware_chain.rb
+- lib/anycable/middlewares/exceptions.rb
+- lib/anycable/protos/rpc_pb.rb
+- lib/anycable/rpc.rb
+- lib/anycable/rpc/handler.rb
+- lib/anycable/rpc/handlers/command.rb
+- lib/anycable/rpc/handlers/connect.rb
+- lib/anycable/rpc/handlers/disconnect.rb
+- lib/anycable/rspec.rb
+- lib/anycable/rspec/rpc_command_context.rb
+- lib/anycable/socket.rb
+- lib/anycable/version.rb
+- sig/anycable.rbs
+- sig/anycable/broadcast_adapters.rbs
+- sig/anycable/cli.rbs
+- sig/anycable/config.rbs
+- sig/anycable/exceptions_handling.rbs
+- sig/anycable/health_server.rbs
+- sig/anycable/middleware.rbs
+- sig/anycable/middleware_chain.rbs
+- sig/anycable/rpc.rbs
+- sig/anycable/socket.rbs
+- sig/anycable/version.rbs
+homepage: http://github.com/anycable/anycable
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: http://github.com/anycable/anycable/issues
+  changelog_uri: https://github.com/anycable/anycable/blob/master/CHANGELOG.md
+  documentation_uri: https://docs.anycable.io/
+  homepage_uri: https://anycable.io/
+  source_code_uri: http://github.com/anycable/anycable
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: AnyCable core RPC implementation
+test_files: []