anycable-core 1.2.3 → 1.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ae8ddced1365e350a744545ed12da6e42fffbaa3f58d40b0f9d83598077a88a
-  data.tar.gz: 6637778d168c99c19a760a635455496ee121dfbbe0fd2472a3a29c4311ce3f7d
+  metadata.gz: 5e9ba8037b7cbd766d021b4e88d49101b6dc3e9a5a6b355929bf9aaa8494f33a
+  data.tar.gz: 71cd40b2380601f322a335d774cfb41e39f8de6ac29f4b5201a825119bff1031
 SHA512:
-  metadata.gz: 3446218216fc8c7b76a0ddd249a8976afe8f9ddf83cdd4714bc29a94a2037caa066c5cae02bcb4a8109fd64555f80b871a4c718d059ec6382e814e9b7cc11ff0
-  data.tar.gz: 3711df758ce8d1963f158371f5c80a06757ffd3b392acf28cbec79652abe6d61e821800ddd6f2054310d2082a651263bcbe56bfb56a5af11dfc1bbdbe40044e8
+  metadata.gz: f1a372e6d70eb1db64054aeafcc3baccd674d679652309526fbcfe9329799383b671d532cd16a52dd53b00b4a1658100d000f4564f2cbaac00502e02da00b668
+  data.tar.gz: 5d9434268c8d7b3903544ab357caadcb69150be82d921c2de2916f4191b1280c0c3b981de285425d969bd1693b02974be4a844447576e3975ed0280c877be3c0

data/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 ## master
 
+## 1.2.5 (2022-12-01)
+
+- Add `ANYCABLE_REDIS_TLS_VERIFY` setting to disable validation of Redis server TLS certificate. ([@Envek][])
+
+## 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][])
@@ -124,3 +134,5 @@ 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
+[@Envek]: https://github.com/Envek

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

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

@@ -121,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

data/lib/anycable/config.rb

@@ -28,6 +28,13 @@ module AnyCable
       redis_url: ENV.fetch("REDIS_URL", "redis://localhost:6379/5"),
       redis_sentinels: nil,
       redis_channel: "__anycable__",
+      redis_tls_verify: false,
+
+      ### 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",
@@ -48,10 +55,18 @@ module AnyCable
     )
 
     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},
+        redis_tls_verify: :boolean,
+        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 +96,12 @@ module AnyCable
           --redis-url=url                   Redis URL for pub/sub, default: REDIS_URL or "redis://localhost:6379/5"
           --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
+
+      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"
@@ -101,12 +122,20 @@ module AnyCable
 
         params[:sentinels] = sentinels.map { |sentinel| parse_sentinel(sentinel) }
       end.tap do |params|
-        next unless redis_url.match?(/rediss:\/\//)
+        next unless redis_url.match?(/rediss:\/\//) && !redis_tls_verify?
 
         params[:ssl_params] = {verify_mode: OpenSSL::SSL::VERIFY_NONE}
       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/version.rb

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

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,17 @@ module AnyCable
     def redis_sentinels=: (Array[String]) -> void
     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 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 +49,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
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: anycable-core
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.2.5
 platform: ruby
 authors:
 - palkan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-20 00:00:00.000000000 Z
+date: 2022-12-01 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
@@ -186,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
@@ -232,7 +248,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.11
 signing_key:
 specification_version: 4
 summary: AnyCable core RPC implementation