anycable-core 1.4.2 → 1.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 391832d2af2280297419d7f62853313d8ac005e7ca826654d6669135748cb8e8
-  data.tar.gz: 229e4b51b7eaed689f0394445e86ba96cb08889391ae343b810439a727e30c0f
+  metadata.gz: 4a7b2ae33dc506f328c7ce62c3c4c80eabb17ed36ca4826808caeb0534a8b2ab
+  data.tar.gz: 2cfae2f0b55718269c33dfc5877d55a2d210d9fa99f0aca85c2899720c0cf350
 SHA512:
-  metadata.gz: c951c3a248b67b9d481865d4a7c1e3d75f76ca963a8f314c8a4889fe9ab1e28eb889ecd48094c96802a20c9196f0932051167c1bd32b54ebf7d7d95dce71620b
-  data.tar.gz: 630c505792b0f374dc6acf7ffa861fcde660687ed7ac8894a0275e9f8d707133dbb9c29c24ed7b0e1dd8650b428a421243d5d1179361421996c850bdc50d0128
+  metadata.gz: b10e485726fd3f48791883af759cfdbeb963a59798a3df7a5100e993891fdb8faff370d028f6b81010be79b2737405196e7f4988041c92896326b222eab4296a
+  data.tar.gz: a901c3958ed1d866a6d7d7f20fb7e8ede84bfabbba29136a022e8eaf3241d10aa437d02c163fa54d0fe7aad8fef701df2299968a20fc887b9348276bee11098a

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## master
 
+## 1.4.3 (2023-10-15)
+
+- Add broadcast options support. ([@palkan][])
+
+- Add batch-broadcasting support. ([@palkan][])
+
 ## 1.4.2 (2023-09-05)
 
 - Fix parsing sentinel configuration from YAML in Rails. ([@palkan][])

data/lib/anycable/broadcast_adapters/base.rb

@@ -7,8 +7,31 @@ module AnyCable
         raise NotImplementedError
       end
 
-      def broadcast(stream, payload)
-        raw_broadcast({stream: stream, data: payload}.to_json)
+      def batching(enabled = true)
+        self.batching_enabled = enabled
+        yield
+      ensure
+        maybe_flush_batch
+      end
+
+      def start_batching
+        self.batching_enabled = true
+      end
+
+      def finish_batching
+        maybe_flush_batch
+      end
+
+      def batching?
+        Thread.current[:anycable_batching]&.last
+      end
+
+      def broadcast(stream, payload, options = nil)
+        if batching?
+          current_batch << {stream: stream, data: payload, meta: options}.compact
+        else
+          raw_broadcast({stream: stream, data: payload, meta: options}.compact.to_json)
+        end
       end
 
       def broadcast_command(command, **payload)
@@ -21,6 +44,32 @@ module AnyCable
 
       private
 
+      def batching_enabled=(val)
+        # The stack must start with the true value,
+        # so we can check for emptiness to decide whether to flush
+        stack = batching_enabled_stack
+        stack << val if val || !stack.empty?
+      end
+
+      def batching_enabled_stack
+        Thread.current[:anycable_batching] ||= []
+      end
+
+      def current_batch
+        Thread.current[:anycable_batch] ||= []
+      end
+
+      def maybe_flush_batch
+        batching_enabled_stack.pop
+        return unless batching_enabled_stack.empty?
+
+        batch = current_batch
+        unless batch.empty?
+          raw_broadcast(batch.to_json)
+        end
+        current_batch.clear
+      end
+
       def logger
         AnyCable.logger
       end

data/lib/anycable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AnyCable
-  VERSION = "1.4.2"
+  VERSION = "1.4.3"
 end

data/lib/anycable.rb

@@ -92,8 +92,8 @@ module AnyCable
 
     # Raw broadcast message to the channel, sends only string!
     # To send hash or object use ActionCable.server.broadcast instead!
-    def broadcast(channel, payload)
-      broadcast_adapter.broadcast(channel, payload)
+    def broadcast(...)
+      broadcast_adapter.broadcast(...)
     end
 
     def rpc_handler

data/sig/anycable/broadcast_adapters/base.rbs

@@ -1,7 +1,13 @@
 module AnyCable
+  type broadcastOptions = {exclude_socket: String}
+
   interface _BroadcastAdapter
     def raw_broadcast: (String _data) -> void
-    def broadcast: (String stream, String payload) -> void
+    def batching: (?bool enabled) { () -> untyped } -> untyped
+    def start_batching: () -> void
+    def finish_batching: () -> void
+    def batching?: () -> (bool | NilClass)
+    def broadcast: (String stream, String payload, ?broadcastOptions options) -> void
     def broadcast_command: (String command, **untyped payload) -> void
     def announce!: () -> void
   end
@@ -13,6 +19,10 @@ module AnyCable
       private
 
       def logger: () -> Logger
+      def current_batch: () -> Array[untyped]
+      def maybe_flush_batch: () -> void
+      def batching_enabled_stack: () -> Array[bool]
+      def batching_enabled=: (bool) -> void
     end
   end
 end

data/sig/anycable.rbs

@@ -36,6 +36,6 @@ module AnyCable
   def self.server_callbacks: () -> Array[^() -> void]
   def self.broadcast_adapter: () -> _BroadcastAdapter
   def self.broadcast_adapter=: (untyped adapter) -> void
-  def self.broadcast: (String channel, String payload) -> void
+  def self.broadcast: (String channel, String payload, ?broadcastOptions options) -> void
   def self.rpc_handler: () -> RPC::Handler
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: anycable-core
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 1.4.3
 platform: ruby
 authors:
 - palkan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-06 00:00:00.000000000 Z
+date: 2023-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: anyway_config