anycable-core 1.2.1 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f387a5b5a0a7535f698339c719f4f7f8debd3c799f5e69b7b54b46b599d3830
-  data.tar.gz: 558f452d571cd33557836861083539fa130c266d5ded16764f0137a9494c39d2
+  metadata.gz: 43353c30169b14234846a634a2f6e2cf9b8c205725752fcc9de78ed088e2432a
+  data.tar.gz: aa0b65f611dd8598b230d152f4b51ddfbdbd92c020081d957ab3f18179c6623f
 SHA512:
-  metadata.gz: 819b9da9e51dae8e6feca6be71550c72e3aaee4358e8245c95235a030f9ee130d3b49d48590eb3d4abc8275a7918c71130b48fd63e3b4b9a5fd46d34520942c7
-  data.tar.gz: c3409d81a2b9c66593384de64d0cc66ac1c31d915d58a836af1c222438d152f18ca86830a86c7867b784ba2159aa80787a5abd5ea3b50d8edd99b835d572bbe8
+  metadata.gz: 6fc3a9531075ec9da6ba4c7dc0e2e00f863829930f80a8b794e40aad13215db134c6195619d272188032502c6ae123f3567d781168580e1eb718d200042910b3
+  data.tar.gz: b7d91672f1976952a40315d92956f0d5970947e89d85e6e94a31240e3428e63c56093c173236ef46f25f5da47d5030cfd5576cdce8c248600a9959ceaa5e8145

data/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 ## master
 
+## 1.2.4 (2022-08-10)
+
+- Add NATS pub/sub adapter. ([@palkan][])
+
+- Setting the redis adapter to use the ruby driver. ([@smasry][])
+
+## 1.2.3 (2022-04-20)
+
+- Pass unique connection id (_session id_) in the `anycable.sid` Rack env field. ([@palkan][])
+
+## 1.2.2 (2022-03-04)
+
+- Allow Ruby 2.6.
+
 ## 1.2.1 (2022-02-21)
 
 - Fix RBS signature. ([@palkan][])
@@ -116,3 +130,4 @@ See [Changelog](https://github.com/anycable/anycable/blob/0-6-stable/CHANGELOG.m
 [@palkan]: https://github.com/palkan
 [@sponomarev]: https://github.com/sponomarev
 [@bibendi]: https://github.com/bibendi
+[@smasry]: https://github.com/smasry

data/lib/anycable/broadcast_adapters/http.rb

@@ -10,7 +10,7 @@ module AnyCable
     #
     # Example:
     #
-    #   AnyCable.broadast_adapter = :http
+    #   AnyCable.broadcast_adapter = :http
     #
     # It uses configuration from global AnyCable config
     # by default.

data/lib/anycable/broadcast_adapters/nats.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+begin
+  require "nats/client"
+rescue LoadError
+  raise "Please, install the nats-pure gem to use NATS broadcast adapter"
+end
+
+require "json"
+
+module AnyCable
+  module BroadcastAdapters
+    # NATS adapter for broadcasting.
+    #
+    # Example:
+    #
+    #   AnyCable.broadcast_adapter = :nats
+    #
+    # It uses NATS configuration from global AnyCable config
+    # by default.
+    #
+    # You can override these params:
+    #
+    #   AnyCable.broadcast_adapter = :nats, servers: "nats://my_nats:4242", channel: "_any_cable_"
+    class Nats < Base
+      attr_reader :nats_conn, :channel
+
+      def initialize(
+        channel: AnyCable.config.nats_channel,
+        **options
+      )
+        options = AnyCable.config.to_nats_params.merge(options)
+        @nats_conn = ::NATS.connect(nil, options)
+        @channel = channel
+      end
+
+      def raw_broadcast(payload)
+        nats_conn.publish(channel, payload)
+      end
+
+      def announce!
+        logger.info "Broadcasting NATS channel: #{channel}"
+      end
+    end
+  end
+end

data/lib/anycable/broadcast_adapters/redis.rb

@@ -3,7 +3,7 @@
 begin
   require "redis"
 rescue LoadError
-  raise "Please, install redis gem to use Redis broadcast adapter"
+  raise "Please, install the redis gem to use Redis broadcast adapter"
 end
 
 require "json"
@@ -14,7 +14,7 @@ module AnyCable
     #
     # Example:
     #
-    #   AnyCable.broadast_adapter = :redis
+    #   AnyCable.broadcast_adapter = :redis
     #
     # It uses Redis configuration from global AnyCable config
     # by default.
@@ -30,6 +30,7 @@ module AnyCable
         **options
       )
         options = AnyCable.config.to_redis_params.merge(options)
+        options[:driver] = :ruby
         @redis_conn = ::Redis.new(**options)
         @channel = channel
       end

data/lib/anycable/cli.rb

@@ -65,6 +65,8 @@ module AnyCable
 
       check_version!
 
+      configure_middleware!
+
       @server = AnyCable.server_builder.call(config)
 
       # Make sure middlewares are not adding after server has started
@@ -119,7 +121,7 @@ module AnyCable
     def wait_till_terminated
       self_read = setup_signals
 
-      while readable_io = IO.select([self_read]) # rubocop:disable Lint/AssignmentInCondition,Lint/IncompatibleIoSelectWithFiberScheduler
+      while readable_io = IO.select([self_read]) # rubocop:disable Lint/AssignmentInCondition
         signal = readable_io.first[0].gets.strip
         raise Interrupt, "SIG#{signal} received"
       end
@@ -265,6 +267,12 @@ module AnyCable
       )
     end
 
+    def configure_middleware!
+      if config.sid_header_enabled?
+        AnyCable.middleware.use(AnyCable::Middlewares::EnvSid)
+      end
+    end
+
     def parse_gem_options!(args)
       config.parse_options!(args)
     rescue OptionParser::InvalidOption => e

data/lib/anycable/config.rb

@@ -29,6 +29,12 @@ module AnyCable
       redis_sentinels: nil,
       redis_channel: "__anycable__",
 
+      ### NATS options
+      nats_servers: "nats://localhost:4222",
+      nats_channel: "__anycable__",
+      nats_dont_randomize_servers: false,
+      nats_options: {},
+
       ### HTTP broadcasting options
       http_broadcast_url: "http://localhost:8090/_broadcast",
       http_broadcast_secret: nil,
@@ -43,14 +49,22 @@ module AnyCable
       http_health_path: "/health",
 
       ### Misc options
-      version_check_enabled: true
+      version_check_enabled: true,
+      sid_header_enabled: true
     )
 
     if respond_to?(:coerce_types)
-      coerce_types redis_sentinels: {type: nil, array: true}, debug: :boolean, version_check_enabled: :boolean
+      coerce_types(
+        redis_sentinels: {type: nil, array: true},
+        nats_servers: {type: nil, array: true},
+        nats_dont_randomize_servers: :boolean,
+        debug: :boolean,
+        version_check_enabled: :boolean
+      )
     end
 
-    flag_options :debug
+    flag_options :debug, :nats_dont_randomize_servers
+    ignore_options :nats_options
 
     on_load do
       # @type self : AnyCable::Config
@@ -81,6 +95,11 @@ 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
 
+      NATS PUB/SUB
+          --nats-servers=<...addresses>     NATS servers for pub/sub, default: "nats://localhost:4222"
+          --nats-channel=name               NATS channel for broadcasting, default: "__anycable__"
+          --nats-dont-randomize-servers     Pass this option to disable NATS servers randomization during (re-)connect
+
       HTTP PUB/SUB
           --http-broadcast-url              HTTP pub/sub endpoint URL, default: "http://localhost:8090/_broadcast"
           --http-broadcast-secret           HTTP pub/sub authorization secret, default: <none> (disabled)
@@ -106,6 +125,14 @@ module AnyCable
       end
     end
 
+    # Build options for NATS.connect
+    def to_nats_params
+      {
+        servers: Array(nats_servers),
+        dont_randomize_servers: nats_dont_randomize_servers
+      }.merge(nats_options)
+    end
+
     # Build HTTP health server parameters
     def to_http_health_params
       {

data/lib/anycable/middlewares/env_sid.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module AnyCable
+  module Middlewares
+    # Set sid for request.env from metadata
+    class EnvSid < AnyCable::Middleware
+      def call(_method, request, meta)
+        return yield unless meta["sid"]
+        request.env.sid = meta["sid"]
+
+        yield
+      end
+    end
+  end
+end

data/lib/anycable/rpc.rb

@@ -88,4 +88,11 @@ module AnyCable
   class DisconnectResponse
     include StatusPredicates
   end
+
+  # TODO: Move sid to env in the future version of RPC proto
+  unless Env.instance_methods(false).include?(:sid)
+    class Env
+      attr_accessor :sid
+    end
+  end
 end

data/lib/anycable/socket.rb

@@ -129,7 +129,8 @@ module AnyCable
         "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
+        "anycable.raw_istate" => request_env.istate&.to_h,
+        "anycable.sid" => request_env.sid
       }.delete_if { |_k, v| v.nil? })
 
       env.merge!(build_headers(headers))

data/lib/anycable/version.rb

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

data/lib/anycable.rb

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

data/sig/anycable/broadcast_adapters/nats.rbs

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

data/sig/anycable/config.rbs

@@ -8,6 +8,14 @@ module AnyCable
     def redis_sentinels=: (Array[String]) -> void
     def redis_channel: () -> String
     def redis_channel=: (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_options: () -> Hash[untyped, untyped]
+    def nats_options=: (Hash[untyped, untyped]) -> void
     def http_broadcast_url: () -> String
     def http_broadcast_url=: (String) -> void
     def http_broadcast_secret: () -> String?
@@ -38,6 +46,7 @@ module AnyCable
     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 }
+    def to_nats_params: () -> Hash[Symbol, untyped]
 
     private
 

data/sig/anycable/middlewares/env_sid.rbs

@@ -0,0 +1,6 @@
+module AnyCable
+  module Middlewares
+    class EnvSid < AnyCable::Middleware
+    end
+  end
+end

data/sig/anycable/rpc.rbs

@@ -24,6 +24,7 @@ module AnyCable
 
     attr_accessor url: String
     attr_accessor headers: protoMap
+    attr_accessor sid: String?
 
     def initialize: (?url: String, ?headers: protoMap, ?cstate: protoMap?, ?istate: protoMap?) -> void
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: anycable-core
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.4
 platform: ruby
 authors:
 - palkan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-21 00:00:00.000000000 Z
+date: 2022-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: anyway_config
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: nats-pure
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -157,6 +171,7 @@ files:
 - lib/anycable/broadcast_adapters.rb
 - lib/anycable/broadcast_adapters/base.rb
 - lib/anycable/broadcast_adapters/http.rb
+- lib/anycable/broadcast_adapters/nats.rb
 - lib/anycable/broadcast_adapters/redis.rb
 - lib/anycable/cli.rb
 - lib/anycable/config.rb
@@ -170,6 +185,7 @@ files:
 - lib/anycable/middleware.rb
 - lib/anycable/middleware_chain.rb
 - lib/anycable/middlewares/check_version.rb
+- lib/anycable/middlewares/env_sid.rb
 - lib/anycable/middlewares/exceptions.rb
 - lib/anycable/protos/rpc_pb.rb
 - lib/anycable/rpc.rb
@@ -185,6 +201,7 @@ files:
 - sig/anycable/broadcast_adapters.rbs
 - sig/anycable/broadcast_adapters/base.rbs
 - sig/anycable/broadcast_adapters/http.rbs
+- sig/anycable/broadcast_adapters/nats.rbs
 - sig/anycable/broadcast_adapters/redis.rbs
 - sig/anycable/cli.rbs
 - sig/anycable/config.rbs
@@ -197,6 +214,7 @@ files:
 - sig/anycable/middleware.rbs
 - sig/anycable/middleware_chain.rbs
 - sig/anycable/middlewares/check_version.rbs
+- sig/anycable/middlewares/env_sid.rbs
 - sig/anycable/middlewares/exceptions.rbs
 - sig/anycable/rpc.rbs
 - sig/anycable/rpc/handler.rbs
@@ -223,14 +241,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.11
 signing_key:
 specification_version: 4
 summary: AnyCable core RPC implementation