anycable-rails 1.3.2 → 1.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dab047473c94bb62b658e08d1aa99a4d64d9b0ab3fad5b7e335e19398a9d8c21
-  data.tar.gz: 6ad5f84e8a4af9ee01f1e277c6c235b7c8d2d313ef369b54739051d499980360
+  metadata.gz: 6200d2863868ed23ac3bcc19478e4310bc4097bfff5884eb5c427ef9c41ec6be
+  data.tar.gz: a33f42cd90e362301dc90f5957b77787cec29e28c3aeee9782d3d81c582301f4
 SHA512:
-  metadata.gz: 3cadd3ebe73ebbd8ce2c2854cd663407a86195cb05ec2d9f4d85a512465ea0b6cba28e70b6eb49ca0b114be18943d67bee465ce795496f44bd84ed3f996dfc6a
-  data.tar.gz: d07f875b9508e296188420166f9a1071a3fdec4a1cd5766c8ccc9cc277f49a25cd6eb3b3045b8ff59fc3057c2bb2d083a417f2c6641cbfe8929bfabe61be51bd
+  metadata.gz: 2f89b8b32dca31e58df2ad57f926b6ef7f2619dd5286d630e393cd7e306fd247cba46e4aa1ce76304bb75486ba52127b0d819dae10093e0a835a5e11c9b02ece
+  data.tar.gz: 5fc0c51cb4eb86c5c8bbbbae0c896af8440ec765370ff0c4a69aaa146e3d2465f1b28993f8f213cd7f8d956d684251aecb7eeda8951db14b0dbbc4c035b45507

data/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 ## master
 
+## 1.3.4 (2022-06-28)
+
+- Add support and backport for Connection command callbacks. ([@palkan][])
+
+## 1.3.3 (2022-04-20)
+
+- Added `sid` (unique connection identifier) field to the `welcome` message if present. ([@palkan][])
+
+- Fixed handling Ruby Logger incompatible loggers. ([@palkan][])
+
 ## 1.3.2 (2022-03-04)
 
 - Allow Ruby 2.6.

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "action_cable/channel"
+require "action_cable"
 
 ActionCable::Channel::Base.prepend(Module.new do
   def subscribe_to_channel

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "action_cable/connection"
+require "action_cable"
 require "anycable/rails/connections/serializable_identification"
 
 ActionCable::Connection::Base.include(AnyCable::Rails::Connections::SerializableIdentification)
@@ -28,3 +28,63 @@ ActionCable::Connection::Base.prepend(Module.new do
     @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/connection.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-require "action_cable/connection"
-require "action_cable/channel"
+require "action_cable"
 
 module AnyCable
   module Rails
@@ -13,8 +12,11 @@ module AnyCable
           :anycable_socket
 
         # Using public :send_welcome_message causes stack level too deep 🤷🏻‍♂️
-        def public_send_welcome_message
-          send_welcome_message
+        def send_welcome_message
+          transmit({
+            type: ActionCable::INTERNAL[:message_types][:welcome],
+            sid: env["anycable.sid"]
+          }.compact)
         end
 
         def public_request
@@ -92,7 +94,7 @@ module AnyCable
 
         socket.cstate.write(LOG_TAGS_IDENTIFIER, logger.tags.to_json) unless logger.tags.empty?
 
-        conn.public_send_welcome_message
+        conn.send_welcome_message
       rescue ::ActionCable::Connection::Authorization::UnauthorizedError
         reject_request(
           ActionCable::INTERNAL[:disconnect_reasons]&.[](:unauthorized) || "unauthorized"
@@ -108,22 +110,24 @@ module AnyCable
       end
 
       def handle_channel_command(identifier, command, data)
-        # We cannot use subscriptions#execute_command here,
-        # since we MUST return true of false, depending on the status
-        # of execution
-        channel = conn.subscriptions.fetch(identifier)
-        case command
-        when "subscribe"
-          channel.handle_subscribe
-          !channel.rejected?
-        when "unsubscribe"
-          conn.subscriptions.remove_subscription(channel)
-          true
-        when "message"
-          channel.perform_action ActiveSupport::JSON.decode(data)
-          true
-        else
-          false
+        conn.run_callbacks :command do
+          # We cannot use subscriptions#execute_command here,
+          # since we MUST return true of false, depending on the status
+          # of execution
+          channel = conn.subscriptions.fetch(identifier)
+          case command
+          when "subscribe"
+            channel.handle_subscribe
+            !channel.rejected?
+          when "unsubscribe"
+            conn.subscriptions.remove_subscription(channel)
+            true
+          when "message"
+            channel.perform_action ActiveSupport::JSON.decode(data)
+            true
+          else
+            false
+          end
         end
       # Support rescue_from
       # https://github.com/rails/rails/commit/d2571e560c62116f60429c933d0c41a0e249b58b

data/lib/anycable/rails/railtie.rb

@@ -20,13 +20,14 @@ module AnyCable
         AnyCable.logger = ::ActionCable.server.config.logger
 
         AnyCable.configure_server do
-          AnyCable.logger = ActiveSupport::TaggedLogging.new(::ActionCable.server.config.logger)
+          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
-            console.level = ::Rails.logger.level
+            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))
           end
         end

data/lib/anycable/rails/version.rb

@@ -2,6 +2,6 @@
 
 module AnyCable
   module Rails
-    VERSION = "1.3.2"
+    VERSION = "1.3.4"
   end
 end

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

@@ -28,7 +28,7 @@ default: &default
   broadcast_adapter: http
   <%- end -%>
   # Use the same channel name for WebSocket server, e.g.:
-  #   $ anycable-go --redis-channel="__anycable__"
+  #   $ anycable-go --redis_channel="__anycable__"
   redis_channel: "__anycable__"
   <%- if redis? -%>
   # You can use REDIS_URL env var to configure Redis URL.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: anycable-rails
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.3.4
 platform: ruby
 authors:
 - palkan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-04 00:00:00.000000000 Z
+date: 2022-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: anycable
@@ -205,7 +205,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Rails adapter for AnyCable