anycable-rails-core 1.6.0.rc.1 → 1.6.0.rc.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 395f76c02adbd3f4878b55bb21bf4bd00969e4394e824fb7a23f086d8b221b1c
-  data.tar.gz: b300f5b2ab64aa893d462a22045587f65531bbaea8dce3a920c1fb1df67b211e
+  metadata.gz: 734dca7d3a224a971ba2e4979e0a33337fa4551ff07cb86acd3c6cc546eea974
+  data.tar.gz: 88d96b3f0c85a2259c29cb0f863cdcee92584b801309202cab4a9d03c8152710
 SHA512:
-  metadata.gz: f0a2f228649539c86b8e3f1a96f0c456b6ed0f933552fb93c90ef2d4a5c49261fdbdf9f3e7b650cd69b00ca38bddcf202bb6f1d730aa92ad07ec3f8504128904
-  data.tar.gz: dfce4029440d91a5a7f07abccca089b6b0bb759d152aa2fadad9ccb12ca0533a5d10cba6e200f398ce58c54c76c5b0fa5903c48aeacba2354dc8b5f9ad37d10f
+  metadata.gz: 5b0d2f5faf24b406264326771b00b23aadc88cb6b20d62a9055857e31c5e99d6cc770dc835dfabfff66c65aa26768062197c8d67d1e357749f0563d214d2cc30
+  data.tar.gz: 2793659e6c349ef838a84e57b4d42b3ddcff7aeabfb9024207e1e8a08b09e85ff28e68aaa1693b4e174512a03ddd0c7cc11450a988470846add034d31742f0b4

data/CHANGELOG.md

@@ -1,6 +1,18 @@
 # Change log
 
-## master
+## main
+
+## 1.6.0.rc.3 (2025-02-20)
+
+- Update `anycable:download` generator to support v1.6+. ([@palkan][])
+
+- Add `#anycable_token_meta_tag` helper. ([@palkan][])
+
+  It generates a meta tag with the AnyCable JWT token (w/o the URL).
+
+## 1.6.0.rc.2 (2025-02-10)
+
+- Add Presence API. ([@palkan][])
 
 ## 1.5.5 (2024-12-12)
 

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

@@ -3,17 +3,6 @@
 require "action_cable"
 
 ActionCable::Channel::Base.prepend(Module.new do
-  def subscribe_to_channel
-    super unless anycabled? && !@__anycable_subscribing__
-  end
-
-  def handle_subscribe
-    @__anycable_subscribing__ = true
-    subscribe_to_channel
-  ensure
-    @__anycable_subscribing__ = false
-  end
-
   def start_periodic_timers
     super unless anycabled?
   end

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

@@ -12,7 +12,7 @@ module AnyCable
 
           stream ||= connection.anycable_socket.streams[:start].first || raise(ArgumentError, "Provide a stream name for presence updates")
 
-          connection.anycable_socket.presence_join(stream, id, info)
+          connection.anycable_socket.presence_join(stream, id.to_s, info)
         end
 
         def leave_presence(id = user_presence_id)

data/lib/anycable/rails/connection.rb

@@ -31,15 +31,65 @@ module AnyCable
       end
 
       refine ActionCable::Connection::Subscriptions do
-        # Find or add a subscription to the list
-        def fetch(identifier)
-          add("identifier" => identifier) unless subscriptions[identifier]
+        # Override the original #execute_command to pre-initialize the channel for unsubscribe/message and
+        # return true/false to indicate successful/unsuccessful subscription.
+        # We also must not lose any exceptions raised in the process.
+        def execute_rpc_command(data)
+          # First, verify the channel name
+          raise "Channel not found: #{ActiveSupport::JSON.decode(data["identifier"]).fetch("channel")}" unless subscription_class_from_identifier(data["identifier"])
+
+          if data["command"] == "subscribe"
+            add data
+            subscription = subscriptions[data["identifier"]]
+            return !(subscription.nil? || subscription.rejected?)
+          end
+
+          load(data["identifier"])
 
-          unless subscriptions[identifier]
-            raise "Channel not found: #{ActiveSupport::JSON.decode(identifier).fetch("channel")}"
+          case data["command"]
+          when "unsubscribe"
+            remove data
+          when "message"
+            perform_action data
+          when "whisper"
+            whisper data
+          else
+            raise UnknownCommandError, data["command"]
           end
 
-          subscriptions[identifier]
+          true
+        end
+
+        # Restore channels from the list of identifiers and the state
+        def restore(subscriptions, istate)
+          subscriptions.each do |id|
+            channel = load(id)
+            channel.__istate__ = ActiveSupport::JSON.decode(istate[id]) if istate[id]
+          end
+        end
+
+        # Find or create a channel for a given identifier
+        def load(identifier)
+          return subscriptions[identifier] if subscriptions[identifier]
+
+          subscription = subscription_from_identifier(identifier)
+          raise "Channel not found: #{ActiveSupport::JSON.decode(identifier).fetch("channel")}" unless subscription
+
+          subscriptions[identifier] = subscription
+        end
+
+        def subscription_class_from_identifier(id_key)
+          id_options = ActiveSupport::JSON.decode(id_key).with_indifferent_access
+          id_options[:channel].safe_constantize
+        end
+
+        def subscription_from_identifier(id_key)
+          subscription_klass = subscription_class_from_identifier(id_key)
+
+          if subscription_klass && subscription_klass < ActionCable::Channel::Base
+            id_options = ActiveSupport::JSON.decode(id_key).with_indifferent_access
+            subscription_klass.new(connection, id_key, id_options)
+          end
         end
       end
     end)
@@ -74,15 +124,8 @@ module AnyCable
         conn.cached_ids = {}
         conn.anycable_request_builder = self
 
-        return unless subscriptions
-
         # Pre-initialize channels (for disconnect)
-        subscriptions.each do |id|
-          channel = conn.subscriptions.fetch(id)
-          next unless socket.istate[id]
-
-          channel.__istate__ = ActiveSupport::JSON.decode(socket.istate[id])
-        end
+        conn.subscriptions.restore(subscriptions, socket.istate) if subscriptions
       end
 
       def handle_open
@@ -111,26 +154,8 @@ module AnyCable
 
       def handle_channel_command(identifier, command, data)
         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
+          conn.subscriptions.execute_rpc_command({"command" => command, "identifier" => identifier, "data" => data})
         end
-      # Support rescue_from
-      # https://github.com/rails/rails/commit/d2571e560c62116f60429c933d0c41a0e249b58b
       rescue Exception => e # rubocop:disable Lint/RescueException
         rescue_with_handler(e) || raise
         false

data/lib/anycable/rails/helper.rb

@@ -22,10 +22,10 @@ module AnyCable
         tag "meta", name: "action-cable-url", content: url
       end
 
-      def any_cable_jwt_meta_tag(**identifiers)
+      def anycable_token_meta_tag(**identifiers)
         token = JWT.encode(identifiers)
 
-        tag "meta", name: "any-cable-jwt", content: token
+        tag "meta", name: "cable-token", content: token
       end
 
       def signed_stream_name(streamables)

data/lib/anycable/rails/version.rb

@@ -2,6 +2,6 @@
 
 module AnyCable
   module Rails
-    VERSION = "1.6.0.rc.1"
+    VERSION = "1.6.0.rc.3"
   end
 end

data/lib/generators/anycable/download/download_generator.rb

@@ -37,24 +37,35 @@ module AnyCableRailsGenerators
       return latest_release_url(version) if version == "latest"
 
       if Gem::Version.new(version).segments.first >= 1
-        new_release_url("v#{version}")
+        new_release_url(version)
       else
-        legacy_release_url("v#{version}")
+        legacy_release_url(version)
+      end
+    end
+
+    def repository_name(version)
+      return "anycable/anycable" if version == "latest"
+
+      major, minor, = Gem::Version.new(version).segments
+      if (major >= 1 && minor >= 6) || (major > 1)
+        "anycable/anycable"
+      else
+        "anycable/anycable-go"
       end
     end
 
     def legacy_release_url(version)
-      "https://github.com/anycable/anycable-go/releases/download/#{version}/" \
+      "https://github.com/#{repository_name(version)}/releases/download/v#{version}/" \
         "anycable-go-v#{version}-#{os_name}-#{cpu_name}"
     end
 
     def new_release_url(version)
-      "https://github.com/anycable/anycable-go/releases/download/#{version}/" \
+      "https://github.com/#{repository_name(version)}/releases/download/v#{version}/" \
         "anycable-go-#{os_name}-#{cpu_name}"
     end
 
     def latest_release_url(version)
-      "https://github.com/anycable/anycable-go/releases/latest/download/" \
+      "https://github.com/#{repository_name(version)}/releases/latest/download/" \
         "anycable-go-#{os_name}-#{cpu_name}"
     end
 

data/lib/generators/anycable/setup/setup_generator.rb

@@ -88,6 +88,13 @@ module AnyCableRailsGenerators
                         "`action_cable_meta_tag` or `action_cable_with_jwt_meta_tag` included in your HTML layout"
     end
 
+    def cable_engine_warning
+      return unless application_rb
+      return if application_rb.match?(/^require\s+['"](action_cable\/engine|rails\/all)['"]/)
+
+      say_status :help, "⚠️  Ensure Action Cable is loaded.\nAdd `require \"action_cable/engine\"` to your `config/application.rb`."
+    end
+
     def deployment_method
       say_status :info, "🚢  See our deployment guide to learn how to run AnyCable in production 👉 #{DOCS_ROOT}/deployment"
 
@@ -139,6 +146,17 @@ module AnyCableRailsGenerators
       end
     end
 
+    def application_rb
+      @application_rb ||= begin
+        res = nil
+        in_root do
+          next unless File.file?("config/application.rb")
+          res = File.read("config/application.rb")
+        end
+        res
+      end
+    end
+
     def install_for_docker
       say_status :help, "️️⚠️  Docker development configuration could vary", :yellow
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: anycable-rails-core
 version: !ruby/object:Gem::Version
-  version: 1.6.0.rc.1
+  version: 1.6.0.rc.3
 platform: ruby
 authors:
 - palkan
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-04 00:00:00.000000000 Z
+date: 2025-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: anycable-core
@@ -139,7 +139,7 @@ metadata:
   homepage_uri: https://anycable.io/
   source_code_uri: http://github.com/anycable/anycable-rails
   funding_uri: https://github.com/sponsors/anycable
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -155,7 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubygems_version: 3.4.19
-signing_key: 
+signing_key:
 specification_version: 4
 summary: AnyCable integration for Rails (w/o RPC dependencies)
 test_files: []