anycable-rails 1.3.3 → 1.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 249493f023d0c0b2e8f85bba263132f7b8bb440073184f68949e83b5911b191a
-  data.tar.gz: 055c60c21507d7307f73121948e134087d624f907d4435ad1ac0526337158464
+  metadata.gz: 75584d70f4f8d966a74cfee8d0741bc5072aabcbab60a7fecc2c4532d7a9719c
+  data.tar.gz: a4efe6de0db26e8f91a896350a142aa483d9305798fafc3e758b29c522e7cf3a
 SHA512:
-  metadata.gz: 2aee411822afddc35aeecbf85490f413e2c6b899107b3a849e25a449cf19baf13885cad9e52bbc25ab85b08316b865ff60f0fc0f558f0ebffc0a175e5d983f30
-  data.tar.gz: e5933e165ca975e9ce32ec867b177583cc8e0718a9aa8f1f9435bbb515500a4f0de9e7cd82b34e7e0f9d1cf8db40114f0fedb49923ef63bfce418a9dd1cd7a76
+  metadata.gz: 64e79d37168a1d299d700cf86444e74e424a360b6d22fe6eb682ef0cba4ea648526a4ea603a5a032a709ed5308856df2d7cb8dedd634668afde239673ef89dd7
+  data.tar.gz: aabcd20cbc91c4733d4978c9c99cf5d0574775badf9ef67fffea8a4a9b825c3b6e6b76c3581a4a75a3058f7ce3fb762a2b69dea4a8b2be935f0b75ea7e09fa0d

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## master
 
+## 1.3.5 (2023-01-04)
+
+- Make misconfiguration error more informative. ([@palkan][])
+
+## 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][])

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2017-2022 palkan
+Copyright 2017-2023 palkan
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/action_cable/subscription_adapter/any_cable.rb

@@ -7,6 +7,14 @@ module ActionCable
     # 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
 
@@ -14,6 +22,14 @@ module ActionCable
         ::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,

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

@@ -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

@@ -110,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/version.rb

@@ -2,6 +2,6 @@
 
 module AnyCable
   module Rails
-    VERSION = "1.3.3"
+    VERSION = "1.3.5"
   end
 end

data/lib/anycable/rails.rb

@@ -68,8 +68,8 @@ end
 if defined?(::Rails) && ::Rails.application && ::Rails.application.initialized?
   puts("\n**************************************************")
   puts(
-    "⛔️  WARNING: AnyCable loaded after application initialization. Might not work correctly.\n"\
-    "Please, make sure to remove `require: false` in your Gemfile or "\
+    "⛔️  WARNING: AnyCable loaded after application initialization. Might not work correctly.\n" \
+    "Please, make sure to remove `require: false` in your Gemfile or " \
     "require manually in `environment.rb` before `Rails.application.initialize!`"
   )
   puts("**************************************************\n\n")

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.3
+  version: 1.3.5
 platform: ruby
 authors:
 - palkan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-20 00:00:00.000000000 Z
+date: 2023-01-04 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.3.7
+rubygems_version: 3.3.11
 signing_key:
 specification_version: 4
 summary: Rails adapter for AnyCable