anycable-rails-core 1.4.1 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d59e7b74ab037c4e2dfdf18b5fb289fad3f7eac9d1a08df798f656ed35dda95c
-  data.tar.gz: a1304fbd9db3f26c92ef5008b196135a2f09a5922bde5137d7e604e652250354
+  metadata.gz: 713258efa713cd94cb2aa57891bf52f2483732f6e84b918a90d77924bc9d78e2
+  data.tar.gz: 45151b26a79c7ab05ba42629fcbb2c64a147142a39fe8d9eaff54dbce3b905c6
 SHA512:
-  metadata.gz: 8a7eebcf805f8c72c300b734fe52a7ce952b60527b8644f004ca7bb3414cc04da49b8ee2ce36d84f6f7d8bf0438450dfdffb019610b091894c3dcf7e65ec4897
-  data.tar.gz: 488065254235777ef04b781ef98f1c20c8c12f2f6c268c6044fb683e4a9774f1ae5abbdcbec53199065e57ec8df1df15d13f85c152471a5a54ceb23e6ddbd832
+  metadata.gz: d98ee91a26f73b7e9ff7c60820211ddebf53566520903f6ca26be838f4c27fed6f0a2a36787fe3207b569f32881c83efd263517eaa71a5f74bdee00dd61c63ff
+  data.tar.gz: e0a86e5ccbef6d7735f71663a5a9511dc9dd3a7a7df8fa1ffd4e3cccbf653184c0048cbbd22007f21614f4d78f30ee5aa4bb55b275964f1b9b690e3927c27069

data/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 ## master
 
+## 1.4.2 (2023-10-15)
+
+- Print warning if the database pool size is less than RPC pool size. ([@palkan][])
+
+- Add support for broadcast options (e.g., `exclude_socket`) and `broadcast ..., to_others: true`. ([@palkan][])
+
+- Add `batch_broadcasts` option to automatically batch broadcasts for code wrapped in Rails executor. ([@palkan][])
+
+- Fix broadcast logging in Rails 7.1. ([@iuri-gg][])
+
 ## 1.4.1 (2023-09-27)
 
 - Fix compatibility with Rails 7.1. ([@palkan][])

data/lib/action_cable/subscription_adapter/any_cable.rb

@@ -18,8 +18,11 @@ module ActionCable
       def initialize(*)
       end
 
-      def broadcast(channel, payload)
-        ::AnyCable.broadcast(channel, payload)
+      def broadcast(channel, payload, **options)
+        options.merge!(::AnyCable::Rails.current_broadcast_options || {})
+        to_others = options.delete(:to_others)
+        options[:exclude_socket] ||= ::AnyCable::Rails.current_socket_id if to_others
+        ::AnyCable.broadcast(channel, payload, **options.compact)
       end
 
       def subscribe(*)

data/lib/anycable/rails/action_cable_ext/broadcast_options.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "action_cable"
+
+ActionCable::Server::Base.prepend(Module.new do
+  def broadcast(channel, payload, **options)
+    return super if options.empty?
+
+    AnyCable::Rails.with_broadcast_options(**options) do
+      super(channel, payload)
+    end
+  end
+end)
+
+ActionCable::Channel::Base.singleton_class.prepend(Module.new do
+  def broadcast_to(target, payload, **options)
+    return super if options.empty?
+
+    AnyCable::Rails.with_broadcast_options(**options) do
+      super(target, payload)
+    end
+  end
+end)

data/lib/anycable/rails/config.rb

@@ -10,10 +10,14 @@ require "anyway/rails"
 # - `persistent_session_enabled` (defaults to false) — whether to store session changes in the connection state
 # - `embedded` (defaults to false) — whether to run RPC server inside a Rails server process
 # - `http_rpc_mount_path` (default to nil) — path to mount HTTP RPC server
+# - `batch_broadcasts` (defaults to false) — whether to batch broadcasts automatically for code wrapped with Rails executor
 AnyCable::Config.attr_config(
   access_logs_disabled: true,
   persistent_session_enabled: false,
   embedded: false,
-  http_rpc_mount_path: nil
+  http_rpc_mount_path: nil,
+  batch_broadcasts: false,
+  socket_id_header: "X-Socket-ID",
+  disable_rpc_pool_size_warning: false
 )
 AnyCable::Config.ignore_options :access_logs_disabled, :persistent_session_enabled

data/lib/anycable/rails/middlewares/executor.rb

@@ -13,16 +13,16 @@ module AnyCable
         end
 
         def call(method, message, metadata)
+          sid = metadata["sid"]
+
           if ::Rails.respond_to?(:error)
             executor.wrap do
-              sid = metadata["sid"]
-
               ::Rails.error.record(context: {method: method, payload: message.to_h, sid: sid}) do
-                yield
+                Rails.with_socket_id(sid) { yield }
               end
             end
           else
-            executor.wrap { yield }
+            executor.wrap { Rails.with_socket_id(sid) { yield } }
           end
         end
       end

data/lib/anycable/rails/railtie.rb

@@ -3,6 +3,7 @@
 require "anycable/rails/action_cable_ext/connection"
 require "anycable/rails/action_cable_ext/channel"
 require "anycable/rails/action_cable_ext/remote_connections"
+require "anycable/rails/action_cable_ext/broadcast_options"
 
 require "anycable/rails/channel_state"
 require "anycable/rails/connection_factory"
@@ -30,8 +31,8 @@ module AnyCable
             console.level = ::Rails.logger.level if ::Rails.logger.respond_to?(:level)
 
             # Rails 7.1+
-            if defined?(ActiveSupport::BroadcastLogger)
-              AnyCable.logger = ActiveSupport::BroadcastLogger.new(AnyCable.logger, console)
+            if AnyCable.logger.respond_to?(:broadcast_to)
+              AnyCable.logger.broadcast_to(console)
             else
               AnyCable.logger.extend(ActiveSupport::Logger.broadcast(console))
             end
@@ -59,6 +60,27 @@ module AnyCable
             ::Rails.error.report(ex, handled: false, context: {method: method.to_sym, payload: message})
           end
         end
+
+        if AnyCable.config.batch_broadcasts?
+          if AnyCable.broadcast_adapter.respond_to?(:start_batching)
+            app.executor.to_run { AnyCable.broadcast_adapter.start_batching }
+            app.executor.to_complete { AnyCable.broadcast_adapter.finish_batching }
+          else
+            warn "[AnyCable] Auto-batching is enabled for broadcasts but your anycable version doesn't support it. Please, upgrade"
+          end
+        end
+      end
+
+      initializer "anycable.socket_id_tracking" do
+        ActiveSupport.on_load(:action_controller) do
+          require "anycable/rails/socket_id_tracking"
+          include AnyCable::Rails::SocketIdTrackingController
+        end
+
+        ActiveSupport.on_load(:active_job) do
+          require "anycable/rails/socket_id_tracking"
+          include AnyCable::Rails::SocketIdTrackingJob
+        end
       end
 
       initializer "anycable.connection_factory", after: "action_cable.set_configs" do |app|
@@ -86,6 +108,27 @@ module AnyCable
         end
       end
 
+      initializer "anycable.verify_pool_sizes" do
+        next if AnyCable.config.disable_rpc_pool_size_warning?
+        # Skip if non-gRPC server is used
+        next unless AnyCable.config.respond_to?(:rpc_pool_size)
+
+        # Log current db vs. gRPC pool sizes
+        AnyCable.configure_server do
+          ActiveSupport.on_load(:active_record) do
+            db_pool_size = ::ActiveRecord::Base.connection_pool.size
+            rpc_pool_size = AnyCable.config.rpc_pool_size
+
+            if rpc_pool_size > db_pool_size
+              ::Kernel.warn(
+                "\n⛔️ WARNING: AnyCable RPC pool size (#{rpc_pool_size}) is greater than DB pool size (#{db_pool_size})\n" \
+                "Please, consider adjusting the database pool size to avoid connection wait times and increase throughput of your RPC server\n\n"
+              )
+            end
+          end
+        end
+      end
+
       # Since Rails 6.1
       if respond_to?(:server)
         server do

data/lib/anycable/rails/socket_id_tracking.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module AnyCable
+  module Rails
+    module SocketIdTrackingController
+      extend ActiveSupport::Concern
+
+      included do
+        around_action :anycable_tracking_socket_id
+      end
+
+      private
+
+      def anycable_tracking_socket_id(&block)
+        Rails.with_socket_id(request.headers[AnyCable.config.socket_id_header], &block)
+      end
+    end
+
+    module SocketIdTrackingJob
+      extend ActiveSupport::Concern
+
+      attr_accessor :cable_socket_id
+
+      def serialize
+        return super unless Rails.current_socket_id
+
+        super.merge("cable_socket_id" => Rails.current_socket_id)
+      end
+
+      def deserialize(job_data)
+        super
+        self.cable_socket_id = job_data["cable_socket_id"]
+      end
+
+      included do
+        around_perform do |job, block|
+          Rails.with_socket_id(job.cable_socket_id, &block)
+        end
+      end
+    end
+  end
+end

data/lib/anycable/rails/version.rb

@@ -2,6 +2,6 @@
 
 module AnyCable
   module Rails
-    VERSION = "1.4.1"
+    VERSION = "1.4.2"
   end
 end

data/lib/anycable/rails.rb

@@ -6,6 +6,7 @@ require "anycable/rails/config"
 require "anycable/rails/rack"
 
 require "globalid"
+require "active_support/core_ext/module/attribute_accessors_per_thread"
 
 module AnyCable
   # Rails handler for AnyCable
@@ -14,6 +15,9 @@ module AnyCable
 
     ADAPTER_ALIASES = %w[any_cable anycable].freeze
 
+    thread_mattr_accessor :current_socket_id
+    thread_mattr_accessor :current_broadcast_options
+
     class << self
       def enabled?
         adapter = ::ActionCable.server.config.cable&.fetch("adapter", nil)
@@ -24,6 +28,29 @@ module AnyCable
         ADAPTER_ALIASES.include?(adapter)
       end
 
+      def with_socket_id(socket_id)
+        old_socket_id, self.current_socket_id = current_socket_id, socket_id
+        yield
+      ensure
+        self.current_socket_id = old_socket_id
+      end
+
+      def with_broadcast_options(**options)
+        old_options = current_broadcast_options
+        self.current_broadcast_options = options.reverse_merge(old_options || {})
+        yield
+      ensure
+        self.current_broadcast_options = old_options
+      end
+
+      def broadcasting_to_others(socket_id: nil, &block)
+        if socket_id
+          with_socket_id(socket_id) { with_broadcast_options(to_others: true, &block) }
+        else
+          with_broadcast_options(to_others: true, &block)
+        end
+      end
+
       # Serialize connection/channel state variable to string
       # using GlobalID where possible or JSON (if json: true)
       def serialize(obj, json: false)
@@ -50,9 +77,9 @@ module AnyCable
       end
 
       module Extension
-        def broadcast(channel, payload)
+        def broadcast(...)
           super
-          ::AnyCable.broadcast(channel, payload)
+          ::AnyCable.broadcast(...)
         end
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: anycable-rails-core
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.4.2
 platform: ruby
 authors:
 - palkan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-28 00:00:00.000000000 Z
+date: 2023-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: anycable-core
@@ -66,6 +66,7 @@ files:
 - lib/action_cable/subscription_adapter/anycable.rb
 - lib/anycable-rails.rb
 - lib/anycable/rails.rb
+- lib/anycable/rails/action_cable_ext/broadcast_options.rb
 - lib/anycable/rails/action_cable_ext/channel.rb
 - lib/anycable/rails/action_cable_ext/connection.rb
 - lib/anycable/rails/action_cable_ext/remote_connections.rb
@@ -86,6 +87,7 @@ files:
 - lib/anycable/rails/middlewares/log_tagging.rb
 - lib/anycable/rails/rack.rb
 - lib/anycable/rails/railtie.rb
+- lib/anycable/rails/socket_id_tracking.rb
 - lib/anycable/rails/version.rb
 - lib/generators/anycable/download/USAGE
 - lib/generators/anycable/download/download_generator.rb