anycable-rails-core 1.4.0 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7bc0b1eac8c453d0054d508826fd33e58b32684c89694fbbc393d2796db8f0c1
-  data.tar.gz: 82ff10fabf21471a9fdcc14e6d76d294902b89372002734538b66e1e7569ab1d
+  metadata.gz: 713258efa713cd94cb2aa57891bf52f2483732f6e84b918a90d77924bc9d78e2
+  data.tar.gz: 45151b26a79c7ab05ba42629fcbb2c64a147142a39fe8d9eaff54dbce3b905c6
 SHA512:
-  metadata.gz: 53cda30136d94edc95e319a0e80bed3ce19716d15dd0e69eae0fc14ffb0c45d58ec0fb466bece171736f4821a7aeeba6ec774c228e8915deb7b2eea01fed1565
-  data.tar.gz: 2787f8c23179f2283fe9b68982f0e3f0ea8fde5222ef97dba7294464523d8968f57f1c71f166f0d44583047747bbd40433e7603afb07c45f3b58eac98bba3cf4
+  metadata.gz: d98ee91a26f73b7e9ff7c60820211ddebf53566520903f6ca26be838f4c27fed6f0a2a36787fe3207b569f32881c83efd263517eaa71a5f74bdee00dd61c63ff
+  data.tar.gz: e0a86e5ccbef6d7735f71663a5a9511dc9dd3a7a7df8fa1ffd4e3cccbf653184c0048cbbd22007f21614f4d78f30ee5aa4bb55b275964f1b9b690e3927c27069

data/CHANGELOG.md

@@ -2,6 +2,24 @@
 
 ## 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][])
+
+- Upgrade `anycable:setup` generator to support v1.4 features. ([@palkan][])
+
+Add `bin/anycable-go` to use `anycable-go` locally. Add `--rpc=http` to configure for using AnyCable with HTTP RPC.
+
 ## 1.4.0 (2023-07-07)
 
 - Add HTTP RPC integration. ([@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"
@@ -21,15 +22,23 @@ module AnyCable
 
         AnyCable.configure_server do
           server_logger = AnyCable.logger = ::ActionCable.server.config.logger
-          AnyCable.logger = ActiveSupport::TaggedLogging.new(server_logger) if server_logger.is_a?(::Logger)
+
           # Broadcast server logs to STDOUT in development
           if ::Rails.env.development? &&
               !ActiveSupport::Logger.logger_outputs_to?(::Rails.logger, $stdout)
             console = ActiveSupport::Logger.new($stdout)
             console.formatter = ::Rails.logger.formatter if ::Rails.logger.respond_to?(:formatter)
             console.level = ::Rails.logger.level if ::Rails.logger.respond_to?(:level)
-            AnyCable.logger.extend(ActiveSupport::Logger.broadcast(console))
+
+            # Rails 7.1+
+            if AnyCable.logger.respond_to?(:broadcast_to)
+              AnyCable.logger.broadcast_to(console)
+            else
+              AnyCable.logger.extend(ActiveSupport::Logger.broadcast(console))
+            end
           end
+
+          AnyCable.logger = ActiveSupport::TaggedLogging.new(AnyCable.logger) if server_logger.is_a?(::Logger)
         end
 
         # Add tagging middleware
@@ -51,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|
@@ -78,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.0"
+    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
 

data/lib/generators/anycable/setup/USAGE

@@ -1,2 +1,11 @@
 Description:
     Configures your application to work with AnyCable interactively.
+
+Example:
+    rails generate anycable:setup
+
+    # You can opt-in to use HTTP RPC
+    rails generate anycable:setup --rpc=http
+
+    # You can specify which version of anycable-go to use
+    rails generate anycable:setup --version=1.4

data/lib/generators/anycable/setup/setup_generator.rb

@@ -10,14 +10,15 @@ module AnyCableRailsGenerators
 
     DOCS_ROOT = "https://docs.anycable.io"
     DEVELOPMENT_METHODS = %w[skip local docker].freeze
-    SERVER_SOURCES = %w[skip brew binary].freeze
+    RPC_IMPL = %w[grpc http].freeze
 
     class_option :devenv,
       type: :string,
       desc: "Select your development environment (options: #{DEVELOPMENT_METHODS.join(", ")})"
-    class_option :source,
+    class_option :rpc,
       type: :string,
-      desc: "Choose a way of installing AnyCable-Go server (options: #{SERVER_SOURCES.join(", ")})"
+      desc: "Select RPC implementation (options: #{RPC_IMPL.join(", ")})",
+      default: "grpc"
     class_option :skip_heroku,
       type: :boolean,
       desc: "Do not copy Heroku configs"
@@ -30,12 +31,6 @@ module AnyCableRailsGenerators
     class_option :skip_install,
       type: :boolean,
       desc: "Do not run bundle install when adding new gems"
-
-    include WithOSHelpers
-
-    class_option :bin_path,
-      type: :string,
-      desc: "Where to download AnyCable-Go server binary (default: #{DEFAULT_BIN_PATH})"
     class_option :version,
       type: :string,
       desc: "Specify the AnyCable-Go version (defaults to latest release)"
@@ -99,6 +94,7 @@ module AnyCableRailsGenerators
 
       in_root do
         next unless File.file?("Procfile")
+        next if http_rpc?
 
         contents = File.read("Procfile")
         contents.sub!(/^web: (.*)$/, %q(web: [[ "$ANYCABLE_DEPLOYMENT" == "true" ]] && bundle exec anycable --server-command="anycable-go" || \1))
@@ -171,6 +167,10 @@ module AnyCableRailsGenerators
       !!gemfile_lock&.match?(/^\s+rubocop\b/)
     end
 
+    def http_rpc?
+      options[:rpc] == "http"
+    end
+
     def gemfile_lock
       @gemfile_lock ||= begin
         res = nil
@@ -192,7 +192,7 @@ module AnyCableRailsGenerators
       say <<~YML
         ─────────────────────────────────────────
         ws:
-          image: anycable/anycable-go:1.2
+          image: anycable/anycable-go:1.4
           ports:
             - '8080:8080'
           environment:
@@ -223,33 +223,25 @@ module AnyCableRailsGenerators
     end
 
     def install_for_local
-      install_server
-      template_proc_files
-    end
-
-    def install_server
-      answer = SERVER_SOURCES.index(options[:source]) || 99
-
-      until SERVER_SOURCES[answer.to_i]
-        answer = ask "How do you want to install AnyCable-Go WebSocket server? (1) Homebrew, (2) Download binary, (0) Skip"
+      inside("bin") do
+        template "anycable-go", chmod: 0o755
       end
 
-      case answer.to_i
-      when 0
-        say_status :help, "⚠️  Please, read this guide on how to install AnyCable-Go server 👉 #{DOCS_ROOT}/anycable-go/getting_started", :yellow
-        return
-      else
-        return unless send("install_from_#{SERVER_SOURCES[answer.to_i]}")
+      if file_exists?(".gitignore")
+        append_file ".gitignore", "bin/dist\n"
       end
 
-      say_status :info, "✅ AnyCable-Go WebSocket server has been successfully installed"
+      template_proc_files
     end
 
     def template_proc_files
       file_name = "Procfile.dev"
 
       if file_exists?(file_name)
-        append_file file_name, "anycable: bundle exec anycable\nws: anycable-go#{anycable_go_options}", force: true
+        unless http_rpc?
+          append_file file_name, "anycable: bundle exec anycable\n", force: true
+        end
+        append_file file_name, "ws: bin/anycable-go #{anycable_go_options}", force: true
       else
         say_status :help, "💡 We recommend using Hivemind to manage multiple processes in development 👉 https://github.com/DarthSim/hivemind", :yellow
 
@@ -263,32 +255,11 @@ module AnyCableRailsGenerators
       end
     end
 
-    def install_from_brew
-      run "brew install anycable-go", abort_on_failure: true
-      run "anycable-go -v", abort_on_failure: true
-    end
-
-    def install_from_binary
-      bin_path ||= DEFAULT_BIN_PATH if options[:devenv] # User don't want interactive mode
-      bin_path ||= ask "Please, enter the path to download the AnyCable-Go binary to", default: DEFAULT_BIN_PATH, path: true
-
-      generate "anycable:download", download_options(bin_path: bin_path)
-
-      true
-    end
-
-    def download_options(**params)
-      opts = options.merge(params)
-      [].tap do |args|
-        args << "--os #{opts[:os]}" if opts[:os]
-        args << "--cpu #{opts[:cpu]}" if opts[:cpu]
-        args << "--bin-path=#{opts[:bin_path]}" if opts[:bin_path]
-        args << "--version #{opts[:version]}" if opts[:version]
-      end.join(" ")
-    end
-
     def anycable_go_options
-      redis? ? " --port=8080" : " --port=8080 --broadcast_adapter=http"
+      opts = ["--port=8080"]
+      opts << "--broadcast_adapter=http" unless redis?
+      opts << "--rpc_impl=http --rpc_host=http://localhost:3000/_anycable" if http_rpc?
+      opts.join(" ")
     end
 
     def file_exists?(name)
@@ -296,5 +267,18 @@ module AnyCableRailsGenerators
         return File.file?(name)
       end
     end
+
+    def anycable_go_version
+      @anycable_go_version ||= (normalize_version(options[:version]) || "latest")
+    end
+
+    def normalize_version(version)
+      return unless version
+
+      # We need a full version for bin/anycable-go script
+      segments = Gem::Version.new(version).segments
+      segments << 0 until segments.size >= 3
+      segments.join(".")
+    end
   end
 end

data/lib/generators/anycable/setup/templates/Procfile.dev.tt

@@ -1,6 +1,5 @@
-server: bundle exec rails s
-<%- if webpacker? -%>
-assets: bundle exec bin/webpack-dev-server
-<%- end -%>
+web: bin/rails s
+<%- unless http_rpc? -%>
 anycable: bundle exec anycable
-ws: anycable-go<%= anycable_go_options %>
+<%- end -%>
+ws: bin/anycable-go <%= anycable_go_options %>

data/lib/generators/anycable/setup/templates/bin/anycable-go.tt

@@ -0,0 +1,22 @@
+#!/bin/bash
+
+cd $(dirname $0)/..
+
+# It's recommended to use the exact version of AnyCable-Go here
+version="<%= anycable_go_version %>"
+
+if [ ! -f ./bin/dist/anycable-go ]; then
+  echo "AnyCable-go is not installed, downloading..."
+  ./bin/rails g anycable:download --version=$version --bin-path=./bin/dist
+fi
+
+curVersion=$(./bin/dist/anycable-go -v)
+
+if [[ "$version" != "latest" ]]; then
+  if [[ "$curVersion" != "$version"* ]]; then
+    echo "AnyCable-go version is not $version, downloading a new one..."
+    ./bin/rails g anycable:download --version=$version --bin-path=./bin/dist
+  fi
+fi
+
+./bin/dist/anycable-go $@

data/lib/generators/anycable/setup/templates/config/anycable.yml.tt

@@ -32,6 +32,9 @@ default: &default
   # Localhost is used by default.
   # redis_url: "redis://localhost:6379/1"
   <%- end -%>
+  <%- if http_rpc? -%>
+  http_rpc_mount_path: "/_anycable"
+  <%- end -%>
 
 development:
   <<: *default
@@ -41,8 +44,3 @@ test:
 
 production:
   <<: *default
-  <%- if !redis? && !nats? -%>
-  # Use Redis or NATS in production
-  broadcast_adapter: redis
-  # broadcast_adapter: nats
-  <%- end -%>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: anycable-rails-core
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.2
 platform: ruby
 authors:
 - palkan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-12 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,12 +87,14 @@ 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
 - lib/generators/anycable/setup/USAGE
 - lib/generators/anycable/setup/setup_generator.rb
 - lib/generators/anycable/setup/templates/Procfile.dev.tt
+- lib/generators/anycable/setup/templates/bin/anycable-go.tt
 - lib/generators/anycable/setup/templates/config/anycable.yml.tt
 - lib/generators/anycable/setup/templates/config/cable.yml.tt
 - lib/generators/anycable/setup/templates/config/initializers/anycable.rb.tt