actioncable-next 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b86ee72b0095c7a8ce99b0d354231b2ac29145e07a1482387fa9664f1c9a08b8
-  data.tar.gz: e72beed883e8789189fa6811d6fb70cdc4e9efbec2ad9b259648c8575196aca3
+  metadata.gz: f5831ed0f565c3bc58899a26ec3097bf47ea7cb518f380e0db05a8bad6fcc5dd
+  data.tar.gz: 92aae3e36883530c9b51ee7acdb0e7df231aed27d60b5f8a4d31426c7158822e
 SHA512:
-  metadata.gz: 955b568fb0d4e01d81ad6871292515c1a3d742eef03067c6322d68b7c6908eeac12947aaef91cb9d4fcbccf2e3790ff84c797ad30e462db15179b04ee6a2d8a3
-  data.tar.gz: 3cc6151d155e3719b008bad22ecf4fbf0a401a5858a7ef5bd75a941debca5b26ac9d06cb30d781929d6da10399c9f534d06aed6ac7afd2ea7a96490066dc6891
+  metadata.gz: ef8e96d02d595e9004acc936acc8c116d1ac846664dbdf3455b0cfb8f872ba3dbbecfd3dfb3772a53b796505c02a592947bf838690d9c5f0b2c844a40e70e7a4
+  data.tar.gz: bf36b4a97cd76f02d4162a70d27751ae15333d5c1c23654199bd59214dc061b0b779aa9dd28c73ca080f075fc5bc8972db86d6e98ce137c4b78f330bd3e5540c

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## main
 
+## 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/streams.rb

@@ -157,10 +157,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/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/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/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.2.0"
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: actioncable-next
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.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-02-04 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.2.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
@@ -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: []