anycable-rails 1.4.0 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da6dd37a3736867b489ceabcc4ed290550fe5736cbf10ad19d6b2e2b0721297d
-  data.tar.gz: d6b8401fc9938ba87d9e19e878dc58a618271f5bffd99da83398b3a5b1403e9e
+  metadata.gz: b9be01ceeb56d7e9c614212631608fe5bf344dcb383f94d87265d2f78c2d765b
+  data.tar.gz: 7d6224ccaad49d71ead36ad452028a9bfa2671a50fa7d88a6e6aecda8bf6dc95
 SHA512:
-  metadata.gz: 67891351a6bb37e4c69e4d81ca51a3cbafeb07ced7d7607c08691ddd33c4dbe4b2bf18231826db85632937313a2d76a35945c59cb2a94f68ad37ac88735dce78
-  data.tar.gz: ca63fd1ec1c346777882434870dc01e9ef35f9fe82ae428c23d4ad481b201eb4f0f726c1e5a50045ffbaf84b7fd94b1adbdcf4640f5e70b3d3b4d2ec8c1ed935
+  metadata.gz: 9880ec9c148ac54ba58f72d2b4a104c51101a47c3af99abfbbb359716ccb3a2ada229d7dec634806d1eaea68da44c017c3ca33899bdbeb2a738caaf39014ed03
+  data.tar.gz: f5e775c99020c9b2f3297b6ad3fb7a18f1d9de73ca6b500c6ef7ccac4b854796d12101b3c210c2b0154634f128a413dcd2a5db106066878a00a98c864071f702

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][])

metadata

@@ -1,45 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: anycable-rails
 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-08 00:00:00.000000000 Z
+date: 2023-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: anycable
+  name: anycable-rails-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: 1.4.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: 1.4.2
 - !ruby/object:Gem::Dependency
-  name: actioncable
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '6.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '6.0'
-- !ruby/object:Gem::Dependency
-  name: globalid
+  name: anycable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -164,7 +150,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Rails adapter for AnyCable
+description: AnyCable integration for Rails
 email:
 - dementiev.vm@gmail.com
 executables: []
@@ -174,40 +160,6 @@ files:
 - CHANGELOG.md
 - MIT-LICENSE
 - README.md
-- lib/action_cable/subscription_adapter/any_cable.rb
-- lib/action_cable/subscription_adapter/anycable.rb
-- lib/anycable-rails.rb
-- lib/anycable/rails.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
-- lib/anycable/rails/channel_state.rb
-- lib/anycable/rails/compatibility.rb
-- lib/anycable/rails/compatibility/rubocop.rb
-- lib/anycable/rails/compatibility/rubocop/config/default.yml
-- lib/anycable/rails/compatibility/rubocop/cops/anycable/instance_vars.rb
-- lib/anycable/rails/compatibility/rubocop/cops/anycable/periodical_timers.rb
-- lib/anycable/rails/compatibility/rubocop/cops/anycable/stream_from.rb
-- lib/anycable/rails/config.rb
-- lib/anycable/rails/connection.rb
-- lib/anycable/rails/connection_factory.rb
-- lib/anycable/rails/connections/persistent_session.rb
-- lib/anycable/rails/connections/serializable_identification.rb
-- lib/anycable/rails/connections/session_proxy.rb
-- lib/anycable/rails/middlewares/executor.rb
-- lib/anycable/rails/middlewares/log_tagging.rb
-- lib/anycable/rails/rack.rb
-- lib/anycable/rails/railtie.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/config/anycable.yml.tt
-- lib/generators/anycable/setup/templates/config/cable.yml.tt
-- lib/generators/anycable/setup/templates/config/initializers/anycable.rb.tt
-- lib/generators/anycable/with_os_helpers.rb
 homepage: http://github.com/anycable/anycable-rails
 licenses:
 - MIT
@@ -236,5 +188,5 @@ requirements: []
 rubygems_version: 3.4.8
 signing_key:
 specification_version: 4
-summary: Rails adapter for AnyCable
+summary: AnyCable integration for Rails
 test_files: []

data/lib/action_cable/subscription_adapter/any_cable.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-require "anycable-rails"
-
-module ActionCable
-  module SubscriptionAdapter
-    # AnyCable subscription adapter delegates broadcasts
-    # to AnyCable
-    class AnyCable < Base
-      ACTION_CABLE_SERVER_ERROR_MESSAGE = <<~STR
-        Looks like you're trying to connect to Rails Action Cable server, not an AnyCable one.
-
-        Please make sure your client is configured to connect to AnyCable server.
-
-        See https://docs.anycable.io/troubleshooting
-      STR
-
-      def initialize(*)
-      end
-
-      def broadcast(channel, payload)
-        ::AnyCable.broadcast(channel, payload)
-      end
-
-      def subscribe(*)
-        raise NotImplementedError, ACTION_CABLE_SERVER_ERROR_MESSAGE
-      end
-
-      def unsubscribe(*)
-        raise NotImplementedError, ACTION_CABLE_SERVER_ERROR_MESSAGE
-      end
-
-      def shutdown
-        # nothing to do
-        # we only need this method for development,
-        # 'cause code reloading triggers `server.restart` -> `pubsub.shutdown`
-      end
-    end
-  end
-end

data/lib/action_cable/subscription_adapter/anycable.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "any_cable"
-
-module ActionCable
-  module SubscriptionAdapter
-    # Aliasing adapter
-    Anycable = AnyCable
-  end
-end

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

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-require "action_cable"
-
-ActionCable::Channel::Base.prepend(Module.new do
-  def subscribe_to_channel
-    super unless anycabled? && !@__anycable_subscribing__
-  end
-
-  def handle_subscribe
-    @__anycable_subscribing__ = true
-    subscribe_to_channel
-  ensure
-    @__anycable_subscribing__ = false
-  end
-
-  def start_periodic_timers
-    super unless anycabled?
-  end
-
-  def stop_periodic_timers
-    super unless anycabled?
-  end
-
-  def stream_from(broadcasting, _callback = nil, **)
-    return super unless anycabled?
-
-    broadcasting = String(broadcasting)
-
-    connection.anycable_socket.subscribe identifier, broadcasting
-  end
-
-  def stop_stream_from(broadcasting)
-    return super unless anycabled?
-
-    connection.anycable_socket.unsubscribe identifier, broadcasting
-  end
-
-  def stop_all_streams
-    return super unless anycabled?
-
-    connection.anycable_socket.unsubscribe_from_all identifier
-  end
-
-  private
-
-  def anycabled?
-    # Use instance variable check here for testing compatibility
-    connection.instance_variable_defined?(:@anycable_socket)
-  end
-end)

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

@@ -1,90 +0,0 @@
-# frozen_string_literal: true
-
-require "action_cable"
-require "anycable/rails/connections/serializable_identification"
-
-ActionCable::Connection::Base.include(AnyCable::Rails::Connections::SerializableIdentification)
-ActionCable::Connection::Base.prepend(Module.new do
-  attr_reader :anycable_socket
-  attr_accessor :anycable_request_builder
-
-  # In AnyCable, we lazily populate env by passing it through the middleware chain,
-  # so we access it via #request
-  def env
-    return super unless anycabled?
-
-    request.env
-  end
-
-  def anycabled?
-    @anycable_socket
-  end
-
-  private
-
-  def request
-    return super unless anycabled?
-
-    @request ||= anycable_request_builder.build_rack_request(@env)
-  end
-end)
-
-# Backport command callbacks: https://github.com/rails/rails/pull/44696
-unless ActionCable::Connection::Base.respond_to?(:before_command)
-  ActionCable::Connection::Base.include ActiveSupport::Callbacks
-  ActionCable::Connection::Base.define_callbacks :command
-  ActionCable::Connection::Base.extend(Module.new do
-    def before_command(*methods, &block)
-      set_callback(:command, :before, *methods, &block)
-    end
-
-    def after_command(*methods, &block)
-      set_callback(:command, :after, *methods, &block)
-    end
-
-    def around_command(*methods, &block)
-      set_callback(:command, :around, *methods, &block)
-    end
-  end)
-
-  ActionCable::Connection::Base.prepend(Module.new do
-    def dispatch_websocket_message(websocket_message)
-      return super unless websocket.alive?
-
-      handle_channel_command(decode(websocket_message))
-    end
-
-    def handle_channel_command(payload)
-      run_callbacks :command do
-        subscriptions.execute_command payload
-      end
-    end
-  end)
-end
-
-# Trigger autoload
-test_case_defined = false
-
-begin
-  ActionCable::Connection::TestCase # rubocop:disable Lint/Void
-  test_case_defined = true
-rescue NameError
-end
-
-# Backport: https://github.com/rails/rails/pull/45445
-if test_case_defined && !ActionCable::Connection::TestConnection.method_defined?(:transmissions)
-  ActionCable::Connection::TestConnection.prepend(Module.new do
-    attr_reader :transmissions
-
-    def initialize(*)
-      super
-
-      @transmissions = []
-      @subscriptions = ActionCable::Connection::Subscriptions.new(self)
-    end
-
-    def transmit(cable_message)
-      transmissions << cable_message.with_indifferent_access
-    end
-  end)
-end

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

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-require "action_cable/remote_connections"
-
-ActionCable::RemoteConnections::RemoteConnection.include(AnyCable::Rails::Connections::SerializableIdentification)
-
-ActionCable::RemoteConnections::RemoteConnection.prepend(Module.new do
-  def disconnect(reconnect: true)
-    # Legacy Action Cable functionality if case we're not fully migrated yet
-    super() unless AnyCable::Rails.enabled?
-    ::AnyCable.broadcast_adapter.broadcast_command("disconnect", identifier: identifiers_json, reconnect: reconnect)
-  end
-end)

data/lib/anycable/rails/channel_state.rb

@@ -1,108 +0,0 @@
-# frozen_string_literal: true
-
-module AnyCable
-  module Rails
-    module ChannelState
-      module ClassMethods
-        def state_attr_accessor(*names)
-          names.each do |name|
-            channel_state_attributes << name
-            class_eval <<~RUBY, __FILE__, __LINE__ + 1
-              def #{name}
-                return @#{name} if instance_variable_defined?(:@#{name})
-                @#{name} = AnyCable::Rails.deserialize(__istate__["#{name}"], json: true) if anycabled?
-              end
-
-              def #{name}=(val)
-                __istate__["#{name}"] = AnyCable::Rails.serialize(val, json: true) if anycabled?
-                instance_variable_set(:@#{name}, val)
-              end
-            RUBY
-          end
-        end
-
-        def channel_state_attributes
-          return @channel_state_attributes if instance_variable_defined?(:@channel_state_attributes)
-
-          @channel_state_attributes =
-            if superclass.respond_to?(:channel_state_attributes)
-              superclass.channel_state_attributes.dup
-            else
-              []
-            end
-        end
-      end
-
-      def self.included(base)
-        base.extend ClassMethods
-      end
-
-      # Make it possible to provide istate explicitly for a channel instance
-      attr_writer :__istate__
-
-      def __istate__
-        @__istate__ ||= connection.anycable_socket.istate
-      end
-    end
-
-    module ConnectionState
-      module ClassMethods
-        def state_attr_accessor(*names)
-          names.each do |name|
-            connection_state_attributes << name
-            class_eval <<~RUBY, __FILE__, __LINE__ + 1
-              def #{name}
-                return @#{name} if instance_variable_defined?(:@#{name})
-                @#{name} = AnyCable::Rails.deserialize(__cstate__["#{name}"], json: true) if anycabled?
-              end
-
-              def #{name}=(val)
-                __cstate__["#{name}"] = AnyCable::Rails.serialize(val, json: true) if anycabled?
-                instance_variable_set(:@#{name}, val)
-              end
-            RUBY
-          end
-        end
-
-        def connection_state_attributes
-          return @connection_state_attributes if instance_variable_defined?(:@connection_state_attributes)
-
-          @connection_state_attributes =
-            if superclass.respond_to?(:connection_state_attributes)
-              superclass.connection_state_attributes.dup
-            else
-              []
-            end
-        end
-      end
-
-      def self.included(base)
-        base.extend ClassMethods
-      end
-
-      # Make it possible to provide istate explicitly for a connection instance
-      attr_writer :__cstate__
-
-      def __cstate__
-        @__cstate__ ||= anycable_socket.cstate
-      end
-    end
-  end
-end
-
-if ActiveSupport::VERSION::MAJOR < 6
-  # `state_attr_accessor` must be available in Action Cable
-  ActiveSupport.on_load(:action_cable) do
-    ::ActionCable::Connection::Base.include(AnyCable::Rails::ConnectionState)
-    ::ActionCable::Channel::Base.include(AnyCable::Rails::ChannelState)
-  end
-else
-  # `state_attr_accessor` must be available in Action Cable
-  ActiveSupport.on_load(:action_cable_connection) do
-    ::ActionCable::Connection::Base.include(AnyCable::Rails::ConnectionState)
-  end
-
-  ActiveSupport.on_load(:action_cable_channel) do
-    ::ActionCable::Channel::Base.include(AnyCable::Rails::ChannelState)
-  end
-end

data/lib/anycable/rails/compatibility/rubocop/config/default.yml

@@ -1,14 +0,0 @@
-AnyCable/InstanceVars:
-  Enabled: true
-  Include:
-    - "**/channels/**/*.rb"
-
-AnyCable/StreamFrom:
-  Enabled: true
-  Include:
-    - "**/channels/**/*.rb"
-
-AnyCable/PeriodicalTimers:
-  Enabled: true
-  Include:
-    - "**/channels/**/*.rb"

data/lib/anycable/rails/compatibility/rubocop/cops/anycable/instance_vars.rb

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-require "rubocop"
-
-module RuboCop
-  module Cop
-    module AnyCable
-      # Checks for instance variable usage inside subscriptions.
-      #
-      # @example
-      #   # bad
-      #   class MyChannel < ApplicationCable::Channel
-      #     def subscribed
-      #       @post = Post.find(params[:id])
-      #       stream_from @post
-      #     end
-      #   end
-      #
-      #   # good
-      #   class MyChannel < ApplicationCable::Channel
-      #     def subscribed
-      #       post = Post.find(params[:id])
-      #       stream_from post
-      #     end
-      #   end
-      #
-      class InstanceVars < RuboCop::Cop::Cop
-        MSG = "Channel instance variables are not supported in AnyCable. Use `state_attr_accessor` instead"
-
-        def on_class(node)
-          find_nested_ivars(node) do |nested_ivar|
-            add_offense(nested_ivar)
-          end
-        end
-
-        private
-
-        def find_nested_ivars(node, &block)
-          node.each_child_node do |child|
-            if child.ivasgn_type? || child.ivar_type?
-              yield(child)
-            elsif child.children.any?
-              find_nested_ivars(child, &block)
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/anycable/rails/compatibility/rubocop/cops/anycable/periodical_timers.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-require "rubocop"
-
-module RuboCop
-  module Cop
-    module AnyCable
-      # Checks for periodical timers usage.
-      #
-      # @example
-      #   # bad
-      #   class MyChannel < ApplicationCable::Channel
-      #     periodically(:do_something, every: 2.seconds)
-      #   end
-      #
-      class PeriodicalTimers < RuboCop::Cop::Cop
-        MSG = "Periodical Timers are not supported in AnyCable"
-
-        def_node_matcher :calls_periodically?, <<-PATTERN
-          (send _ :periodically ...)
-        PATTERN
-
-        def on_send(node)
-          add_offense(node) if calls_periodically?(node)
-        end
-      end
-    end
-  end
-end

data/lib/anycable/rails/compatibility/rubocop/cops/anycable/stream_from.rb

@@ -1,100 +0,0 @@
-# frozen_string_literal: true
-
-require "rubocop"
-
-module RuboCop
-  module Cop
-    module AnyCable
-      # Checks for #stream_from calls with custom callbacks or coders.
-      #
-      # @example
-      #   # bad
-      #   class MyChannel < ApplicationCable::Channel
-      #     def follow
-      #       stream_for(room) {}
-      #     end
-      #   end
-      #
-      #   class MyChannel < ApplicationCable::Channel
-      #     def follow
-      #       stream_from("all", -> {})
-      #     end
-      #   end
-      #
-      #   class MyChannel < ApplicationCable::Channel
-      #     def follow
-      #       stream_from("all", coder: SomeCoder)
-      #     end
-      #   end
-      #
-      #  # good
-      #   class MyChannel < ApplicationCable::Channel
-      #     def follow
-      #       stream_from "all"
-      #     end
-      #   end
-      #
-      class StreamFrom < RuboCop::Cop::Cop
-        def_node_matcher :stream_from_with_block?, <<-PATTERN
-          (block {(send _ :stream_from ...) (send _ :stream_for ...)} ...)
-        PATTERN
-
-        def_node_matcher :stream_from_with_callback?, <<-PATTERN
-          {(send _ :stream_from str_type? (block (send nil? :lambda) ...)) (send _ :stream_for ... (block (send nil? :lambda) ...))}
-        PATTERN
-
-        def_node_matcher :args_of_stream_from, <<-PATTERN
-          {(send _ :stream_from str_type? $...)  (send _ :stream_for $...)}
-        PATTERN
-
-        def_node_matcher :coder_symbol?, "(pair (sym :coder) ...)"
-
-        def_node_matcher :active_support_json?, <<-PATTERN
-          (pair _ (const (const nil? :ActiveSupport) :JSON))
-        PATTERN
-
-        def on_block(node)
-          add_callback_offense(node) if stream_from_with_block?(node)
-        end
-
-        def on_send(node)
-          if stream_from_with_callback?(node)
-            add_callback_offense(node)
-            return
-          end
-
-          args = args_of_stream_from(node)
-          find_coders(args) { |coder| add_custom_coder_offense(coder) }
-        end
-
-        private
-
-        def find_coders(args)
-          return if args.nil?
-
-          args.select(&:hash_type?).each do |arg|
-            arg.each_child_node do |pair|
-              yield(pair) if coder_symbol?(pair) && !active_support_json?(pair)
-            end
-          end
-        end
-
-        def add_callback_offense(node)
-          add_offense(
-            node,
-            location: :expression,
-            message: "Custom stream callbacks are not supported in AnyCable"
-          )
-        end
-
-        def add_custom_coder_offense(node)
-          add_offense(
-            node,
-            location: :expression,
-            message: "Custom coders are not supported in AnyCable"
-          )
-        end
-      end
-    end
-  end
-end

data/lib/anycable/rails/compatibility/rubocop.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-require "rubocop"
-require "pathname"
-
-require_relative "rubocop/cops/anycable/stream_from"
-require_relative "rubocop/cops/anycable/periodical_timers"
-require_relative "rubocop/cops/anycable/instance_vars"
-
-module RuboCop
-  module AnyCable # :nodoc:
-    CONFIG_DEFAULT = Pathname.new(__dir__).join("rubocop", "config", "default.yml").freeze
-
-    # Merge anycable config into default configuration
-    # See https://github.com/backus/rubocop-rspec/blob/master/lib/rubocop/rspec/inject.rb
-    def self.inject!
-      path = CONFIG_DEFAULT.to_s
-      puts "configuration from #{path}" if ConfigLoader.debug?
-      hash = ConfigLoader.send(:load_yaml_configuration, path)
-      config = Config.new(hash, path)
-      config = ConfigLoader.merge_with_default(config, path)
-      ConfigLoader.instance_variable_set(:@default_configuration, config)
-    end
-  end
-end
-
-RuboCop::AnyCable.inject!