actioncable-next 0.1.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b86ee72b0095c7a8ce99b0d354231b2ac29145e07a1482387fa9664f1c9a08b8
-  data.tar.gz: e72beed883e8789189fa6811d6fb70cdc4e9efbec2ad9b259648c8575196aca3
+  metadata.gz: a3500aff266cab716b9cc6ef36748f32ecd4e6b5e1d24a1c8ce462c0e3e2dd9d
+  data.tar.gz: 74123e275958e25046b8a3a10ac7a3c2b5fa8066c63209baf591f3623100e867
 SHA512:
-  metadata.gz: 955b568fb0d4e01d81ad6871292515c1a3d742eef03067c6322d68b7c6908eeac12947aaef91cb9d4fcbccf2e3790ff84c797ad30e462db15179b04ee6a2d8a3
-  data.tar.gz: 3cc6151d155e3719b008bad22ecf4fbf0a401a5858a7ef5bd75a941debca5b26ac9d06cb30d781929d6da10399c9f534d06aed6ac7afd2ea7a96490066dc6891
+  metadata.gz: e6662409e60c2c0a2ac869771d05df9c620529a0cc92642e6bc3b5c953e1f78e3d64460953ecee186d713c8079e0b296fc25a8faadca646128a4c6b28f01c175
+  data.tar.gz: 588b659b2eddf199182e25bd7bec23f386621f97abdb169d33c81ac8022556cfa2ad8275cbaad3cf420c8f89306974843f47f851d7db3db0d37363f352d6e120

data/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 ## main
 
+## 0.3.0
+
+- Sync with upstream (Rails 8.1.1).
+
+- Do not call `#subscribed` when subscription is rejected in a `before_subscribe` callback.
+
+## 0.2.0
+
+- Performance: store connections in a Hash, not an Array.
+
+- Add `Connection#broadcast` as an interface for broadcasting from channels.
+
+- Add `config.fastlane_broadcasts_enabled` to opt-in for optimized broadcasts (no double JSON encoding).
+
 ## 0.1.2
 
 - Added a hack to prevent third-party extensions from changing the methods visibility.

data/README.md

@@ -4,6 +4,8 @@ This gem provides the functionality of the _server adapterization_ PR: [rails/ra
 
 See the PR description for more information on the purpose of this refactoring.
 
+There are also some additional improvements added on top of the PR (see below).
+
 ## Usage
 
 Add this line to your application's Gemfile **before Rails or Action Cable**:
@@ -26,3 +28,23 @@ by adding the following line to your `spec/rails_helper.rb`:
 require "rspec/rails"
 require "action_cable/next/rspec"
 ```
+
+### New features
+
+#### `ActionCable.server.config.fastlane_broadcasts_enabled = true`
+
+This option allows you to enable the _fast lane_ for broadcasting messages. When enabled, messages sent via `ActionCable.server.broadcast` are only decoded-encoded from/to JSON once per channel identifier and not for every connected client. This significantly reduces the broadcasting latency (up to 2x faster).
+
+#### `Connection#broadcast`
+
+You can now broadcast message from connection or channel instances using the connection `#broadcast` method. For example:
+
+```ruby
+class TestChannel < ActionCable::Channel::Base
+  def notify_all(data)
+    connection.broadcast("testing-#{test_id}", data)
+  end
+end
+```
+
+The purpose of this interface is to avoid direct usage of `server` or `ActionCable.server` in channels code.

data/lib/action_cable/channel/base.rb

@@ -2,7 +2,6 @@
 
 # :markup: markdown
 
-require "set"
 require "active_support/rescuable"
 require "active_support/parameter_filter"
 
@@ -133,7 +132,10 @@ module ActionCable
               # Except for public instance methods of Base and its ancestors
               ActionCable::Channel::Base.public_instance_methods(true) +
               # Be sure to include shadowed public instance methods of this class
-              public_instance_methods(false)).uniq.map(&:to_s)
+              public_instance_methods(false) -
+              # Except the internal methods
+              internal_methods).uniq
+            methods.map!(&:name)
             methods.to_set
           end
         end
@@ -146,6 +148,10 @@ module ActionCable
             @action_methods = nil
           end
 
+          def internal_methods
+            super
+          end
+
           # Refresh the cached action_methods when a new action_method is added.
           def method_added(name) # :doc:
             super
@@ -166,6 +172,7 @@ module ActionCable
 
         @reject_subscription = nil
         @subscription_confirmation_sent = nil
+        @unsubscribed = false
 
         delegate_connection_identifiers
       end
@@ -190,7 +197,7 @@ module ActionCable
       # confirms or rejects the subscription.
       def subscribe_to_channel
         run_callbacks :subscribe do
-          subscribed
+          subscribed unless subscription_rejected?
         end
 
         reject_subscription if subscription_rejected?
@@ -201,11 +208,16 @@ module ActionCable
       # cleanup with callbacks. This method is not intended to be called directly by
       # the user. Instead, override the #unsubscribed callback.
       def unsubscribe_from_channel # :nodoc:
+        @unsubscribed = true
         run_callbacks :unsubscribe do
           unsubscribed
         end
       end
 
+      def unsubscribed? # :nodoc:
+        @unsubscribed
+      end
+
       private
         # Called once a consumer has become a subscriber of the channel. Usually the
         # place to set up any streams you want this channel to be sending to the

data/lib/action_cable/channel/broadcasting.rb

@@ -10,19 +10,19 @@ module ActionCable
       extend ActiveSupport::Concern
 
       module ClassMethods
-        # Broadcast a hash to a unique broadcasting for this `model` in this channel.
-        def broadcast_to(model, message)
-          ActionCable.server.broadcast(broadcasting_for(model), message)
+        # Broadcast a hash to a unique broadcasting for this array of `broadcastables` in this channel.
+        def broadcast_to(broadcastables, message)
+          ActionCable.server.broadcast(broadcasting_for(broadcastables), message)
         end
 
         # Returns a unique broadcasting identifier for this `model` in this channel:
         #
         #     CommentsChannel.broadcasting_for("all") # => "comments:all"
         #
-        # You can pass any object as a target (e.g. Active Record model), and it would
+        # You can pass an array of objects as a target (e.g. Active Record model), and it would
         # be serialized into a string under the hood.
-        def broadcasting_for(model)
-          serialize_broadcasting([ channel_name, model ])
+        def broadcasting_for(broadcastables)
+          serialize_broadcasting([ channel_name ] + Array(broadcastables))
         end
 
         private

data/lib/action_cable/channel/callbacks.rb

@@ -39,6 +39,8 @@ module ActionCable
       extend  ActiveSupport::Concern
       include ActiveSupport::Callbacks
 
+      INTERNAL_METHODS = [:_run_subscribe_callbacks, :_run_unsubscribe_callbacks] # :nodoc:
+
       included do
         define_callbacks :subscribe
         define_callbacks :unsubscribe
@@ -70,6 +72,11 @@ module ActionCable
           set_callback(:unsubscribe, :after, *methods, &block)
         end
         alias_method :on_unsubscribe, :after_unsubscribe
+
+        private
+          def internal_methods
+            INTERNAL_METHODS
+          end
       end
     end
   end

data/lib/action_cable/channel/streams.rb

@@ -88,6 +88,8 @@ module ActionCable
       # callback. Defaults to `coder: nil` which does no decoding, passes raw
       # messages.
       def stream_from(broadcasting, callback = nil, coder: nil, &block)
+        return if unsubscribed?
+
         broadcasting = String(broadcasting)
 
         # Don't send the confirmation until pubsub#subscribe is successful
@@ -104,15 +106,15 @@ module ActionCable
         end)
       end
 
-      # Start streaming the pubsub queue for the `model` in this channel. Optionally,
+      # Start streaming the pubsub queue for the `broadcastables` in this channel. Optionally,
       # you can pass a `callback` that'll be used instead of the default of just
       # transmitting the updates straight to the subscriber.
       #
       # Pass `coder: ActiveSupport::JSON` to decode messages as JSON before passing to
       # the callback. Defaults to `coder: nil` which does no decoding, passes raw
       # messages.
-      def stream_for(model, ...)
-        stream_from(broadcasting_for(model), ...)
+      def stream_for(broadcastables, ...)
+        stream_from(broadcasting_for(broadcastables), ...)
       end
 
       # Unsubscribes streams from the named `broadcasting`.
@@ -157,10 +159,21 @@ module ActionCable
         # Always wrap the outermost handler to invoke the user handler on the worker
         # pool rather than blocking the event loop.
         def worker_pool_stream_handler(broadcasting, user_handler, coder: nil)
+          if !user_handler && !coder && connection.config.fastlane_broadcasts_enabled
+            return opt_worker_pool_stream_handler(broadcasting)
+          end
+
           handler = stream_handler(broadcasting, user_handler, coder: coder)
 
           -> message do
-            connection.perform_work handler, :call, message
+            connection.perform_work handler, :call, message.data
+          end
+        end
+
+        # Optimized stream handler that avoids double JSON encoding/decoding on broadcast
+        def opt_worker_pool_stream_handler(broadcasting)
+          -> (message) do
+            connection.raw_transmit message.encoded_for(@identifier)
           end
         end
 

data/lib/action_cable/connection/base.rb

@@ -62,7 +62,7 @@ module ActionCable
       attr_reader :subscriptions, :logger
       private attr_reader :server, :socket
 
-      delegate :pubsub, :executor, :config, to: :server
+      delegate :pubsub, :executor, :config, :broadcast, to: :server
       delegate :env, :request, :protocol, :perform_work, to: :socket, allow_nil: true
 
       def initialize(server, socket)
@@ -117,6 +117,10 @@ module ActionCable
         socket.transmit(data)
       end
 
+      def raw_transmit(data) # :nodoc:
+        socket.raw_transmit(data)
+      end
+
       # Close the connection.
       def close(reason: nil, reconnect: true)
         transmit(

data/lib/action_cable/connection/identification.rb

@@ -2,8 +2,6 @@
 
 # :markup: markdown
 
-require "set"
-
 module ActionCable
   module Connection
     module Identification

data/lib/action_cable/connection/internal_channel.rb

@@ -18,7 +18,7 @@ module ActionCable
 
         def subscribe_to_internal_channel
           if connection_identifier.present?
-            callback = -> (message) { process_internal_message ActiveSupport::JSON.decode(message) }
+            callback = -> (message) { process_internal_message ActiveSupport::JSON.decode(message.data) }
             @_internal_subscriptions ||= []
             @_internal_subscriptions << [ internal_channel, callback ]
 

data/lib/action_cable/connection/subscriptions.rb

@@ -40,7 +40,7 @@ module ActionCable
 
       class UnknownSubscription < Error
         def initialize(identifier)
-          "Unable to find subscription with identifier: #{identifier}"
+          super "Unable to find subscription with identifier: #{identifier}"
         end
       end
 

data/lib/action_cable/connection/test_case.rb

@@ -142,11 +142,8 @@ module ActionCable
     #
     # ## Basic example
     #
-    # Unit tests are written as follows:
-    #
-    # 1.  Simulate a connection attempt by calling `connect`.
-    # 2.  Assert state, e.g. identifiers, has been assigned.
-    #
+    # Unit tests are written by first simulating a connection attempt by calling
+    # `connect` and then asserting state, e.g. identifiers, have been assigned.
     #
     #     class ApplicationCable::ConnectionTest < ActionCable::Connection::TestCase
     #       def test_connects_with_proper_cookie

data/lib/action_cable/gem_version.rb

@@ -10,9 +10,9 @@ module ActionCable
 
   module VERSION
     MAJOR = 8
-    MINOR = 0
-    TINY  = 0
-    PRE   = "alpha"
+    MINOR = 1
+    TINY  = 1
+    PRE   = nil
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
   end

data/lib/action_cable/server/base.rb

@@ -10,7 +10,7 @@ module ActionCable
     class ThreadedExecutor # :nodoc:
       def initialize(max_size: 10)
         @executor = Concurrent::ThreadPoolExecutor.new(
-          name: "ActionCable server",
+          name: "ActionCable-streamer",
           min_threads: 1,
           max_threads: max_size,
           max_queue: 0,

data/lib/action_cable/server/broadcasting.rb

@@ -21,10 +21,12 @@ module ActionCable
     #     ActionCable.server.broadcast \
     #       "web_notifications_1", { title: "New things!", body: "All that's fit for print" }
     #
-    #     # Client-side CoffeeScript, which assumes you've already requested the right to send web notifications:
-    #     App.cable.subscriptions.create "WebNotificationsChannel",
-    #       received: (data) ->
-    #         new Notification data['title'], body: data['body']
+    #     // Client-side JavaScript, which assumes you've already requested the right to send web notifications:
+    #     App.cable.subscriptions.create("WebNotificationsChannel", {
+    #       received: function(data) {
+    #         new Notification(data['title'], { body: data['body'] });
+    #       }
+    #     });
     module Broadcasting
       # Broadcast a hash directly to a named `broadcasting`. This will later be JSON
       # encoded.

data/lib/action_cable/server/configuration.rb

@@ -19,6 +19,7 @@ module ActionCable
       attr_accessor :precompile_assets
       attr_accessor :health_check_path, :health_check_application
       attr_writer :pubsub_adapter
+      attr_accessor :fastlane_broadcasts_enabled
 
       def initialize
         @log_tags = []
@@ -31,6 +32,8 @@ module ActionCable
         @allow_same_origin_as_host = true
         @filter_parameters = []
 
+        @fastlane_broadcasts_enabled = false
+
         @health_check_application = ->(env) {
           [200, { Rack::CONTENT_TYPE => "text/html", "date" => Time.now.httpdate }, []]
         }

data/lib/action_cable/server/connections.rb

@@ -13,16 +13,18 @@ module ActionCable
     module Connections # :nodoc:
       BEAT_INTERVAL = 3
 
-      def connections
-        @connections ||= []
+      def connections_map
+        @connections_map ||= {}
       end
 
+      def connections = connections_map.values
+
       def add_connection(connection)
-        connections << connection
+        connections_map[connection.object_id] = connection
       end
 
       def remove_connection(connection)
-        connections.delete connection
+        connections_map.delete connection.object_id
       end
 
       # WebSocket connection implementations differ on when they'll mark a connection
@@ -32,12 +34,12 @@ module ActionCable
       # disconnect.
       def setup_heartbeat_timer
         @heartbeat_timer ||= executor.timer(BEAT_INTERVAL) do
-          executor.post { connections.each(&:beat) }
+          executor.post { connections_map.each_value(&:beat) }
         end
       end
 
       def open_connections_statistics
-        connections.map(&:statistics)
+        connections_map.each_value.map(&:statistics)
       end
     end
   end

data/lib/action_cable/server/socket.rb

@@ -47,6 +47,12 @@ module ActionCable
         websocket.transmit encode(cable_message)
       end
 
+      def raw_transmit(message)
+        return unless websocket.alive?
+
+        websocket.transmit message
+      end
+
       # Close the WebSocket connection.
       def close(...)
         websocket.close(...) if websocket.alive?

data/lib/action_cable/server/worker.rb

@@ -20,7 +20,7 @@ module ActionCable
 
       def initialize(max_size: 5)
         @executor = Concurrent::ThreadPoolExecutor.new(
-          name: "ActionCable worker",
+          name: "ActionCable-server",
           min_threads: 1,
           max_threads: max_size,
           max_queue: 0,

data/lib/action_cable/subscription_adapter/base.rb

@@ -32,7 +32,8 @@ module ActionCable
       end
 
       def identifier
-        config.cable[:id] ||= "ActionCable-PID-#{$$}"
+        config.cable[:id] = "ActionCable-PID-#{$$}" unless config.cable.key?(:id)
+        config.cable[:id]
       end
     end
   end

data/lib/action_cable/subscription_adapter/postgresql.rb

@@ -36,18 +36,17 @@ module ActionCable
       end
 
       def with_subscriptions_connection(&block) # :nodoc:
-        ar_conn = ActiveRecord::Base.connection_pool.checkout.tap do |conn|
-          # Action Cable is taking ownership over this database connection, and will
-          # perform the necessary cleanup tasks
-          ActiveRecord::Base.connection_pool.remove(conn)
-        end
+        # Action Cable is taking ownership over this database connection, and will
+        # perform the necessary cleanup tasks.
+        # We purposedly avoid #checkout to not end up with a pinned connection
+        ar_conn = ActiveRecord::Base.connection_pool.new_connection
         pg_conn = ar_conn.raw_connection
 
         verify!(pg_conn)
         pg_conn.exec("SET application_name = #{pg_conn.escape_identifier(identifier)}")
         yield pg_conn
       ensure
-        ar_conn.disconnect!
+        ar_conn&.disconnect!
       end
 
       def with_broadcast_connection(&block) # :nodoc:

data/lib/action_cable/subscription_adapter/redis.rb

@@ -162,7 +162,7 @@ module ActionCable
                 begin
                   conn = @adapter.redis_connection_for_subscriptions
                   listen conn
-                rescue ConnectionError => e
+                rescue *CONNECTION_ERRORS => e
                   reset
                   if retry_connecting?
                     logger&.warn "Redis connection failed: #{e.message}. Trying to reconnect..."
@@ -211,7 +211,7 @@ module ActionCable
             end
 
             if ::Redis::VERSION < "5"
-              ConnectionError = ::Redis::BaseConnectionError
+              CONNECTION_ERRORS = [::Redis::BaseConnectionError].freeze
 
               class SubscribedClient
                 def initialize(raw_client)
@@ -245,7 +245,12 @@ module ActionCable
                 SubscribedClient.new(conn._client)
               end
             else
-              ConnectionError = RedisClient::ConnectionError
+              CONNECTION_ERRORS = [
+                ::Redis::BaseConnectionError,
+
+                # Some older versions of redis-rb sometime leak underlying exceptions
+                RedisClient::ConnectionError,
+              ].freeze
 
               def extract_subscribed_client(conn)
                 conn

data/lib/action_cable/subscription_adapter/subscriber_map.rb

@@ -5,6 +5,19 @@
 module ActionCable
   module SubscriptionAdapter
     class SubscriberMap
+      class Message < Struct.new(:data)
+        def initialize(...)
+          super
+          @cache = Concurrent::Map.new
+        end
+
+        def encoded_for(identifier)
+          @cache.compute_if_absent(identifier) do
+            ActiveSupport::JSON.encode({ identifier: identifier, message: ActiveSupport::JSON.decode(data) })
+          end
+        end
+      end
+
       def initialize
         @subscribers = Hash.new { |h, k| h[k] = [] }
         @sync = Mutex.new
@@ -41,8 +54,10 @@ module ActionCable
           @subscribers[channel].dup
         end
 
+        msg = Message.new(message)
+
         list.each do |subscriber|
-          invoke_callback(subscriber, message)
+          invoke_callback(subscriber, msg)
         end
       end
 

data/lib/action_cable.rb

@@ -23,6 +23,7 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
 
+require "logger"
 require "active_support"
 require "active_support/rails"
 require "zeitwerk"

data/lib/actioncable-next.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActionCableNext
-  VERSION = "0.1.2"
+  VERSION = "0.3.0"
 end

data/lib/rails/generators/channel/channel_generator.rb

@@ -59,17 +59,17 @@ module Rails
         def create_channel_javascript_file
           channel_js_path = File.join("app/javascript/channels", class_path, "#{file_name}_channel")
           js_template "javascript/channel", channel_js_path
-          gsub_file "#{channel_js_path}.js", /\.\/consumer/, "channels/consumer" unless using_js_runtime?
+          gsub_file "#{channel_js_path}.js", /\.\/consumer/, "channels/consumer" if using_importmap?
         end
 
         def import_channels_in_javascript_entrypoint
           append_to_file "app/javascript/application.js",
-            using_js_runtime? ? %(import "./channels"\n) : %(import "channels"\n)
+            using_importmap? ? %(import "channels"\n) : %(import "./channels"\n)
         end
 
         def import_channel_in_javascript_entrypoint
           append_to_file "app/javascript/channels/index.js",
-            using_js_runtime? ? %(import "./#{file_name}_channel"\n) : %(import "channels/#{file_name}_channel"\n)
+            using_importmap? ? %(import "channels/#{file_name}_channel"\n) : %(import "./#{file_name}_channel"\n)
         end
 
         def install_javascript_dependencies
@@ -105,7 +105,7 @@ pin_all_from "app/javascript/channels", under: "channels"
         end
 
         def using_bun?
-          # Cannot assume bun.lockb has been generated yet so we look for a file known to
+          # Cannot assume Bun lockfile has been generated yet so we look for a file known to
           # be generated by the jsbundling-rails gem
           @using_bun ||= using_js_runtime? && root.join("bun.config.js").exist?
         end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: actioncable-next
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Pratik Naik
 - David Heinemeier Hansson
 - Vladimir Dementyev
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-10 00:00:00.000000000 Z
+date: 2025-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -167,10 +167,10 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/anycable/actioncable-next
-  changelog_uri: https://github.com/anycable/actioncable-next/blob/v0.1.2/CHANGELOG.md
+  changelog_uri: https://github.com/anycable/actioncable-next/blob/v0.3.0/CHANGELOG.md
   source_code_uri: https://github.com/anycable/actioncable-next
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -178,7 +178,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -186,7 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.5.22
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Next-gen version of Action Cable
 test_files: []