anycable-rails-core 1.5.4 → 1.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ceb26b8e5c09c7bd5500007a29a79a2933cc38848a63da16af272a4a5d11771
-  data.tar.gz: 6db49c5ceca2e5b020fb7b225ebe2e1db63df8beb9858224502883ff35392529
+  metadata.gz: ae5f5e00ae334a317de5b59685ff57de668c2f102125f48bc8309a7330787950
+  data.tar.gz: f15f057412a3c0a0dbf759bd8c8d47abee1bee60a9b68ca62983ced577ea9397
 SHA512:
-  metadata.gz: d78c540124cec98c20e2004f49324580300a9be00eea194fa09200a8b30090b3448e3411dcba1a4002efa857997e0ed66da44a808efd17ceede3ce45fd97b751
-  data.tar.gz: 4e7916ccc0f8c18ed305eab329575c1bc840be9eeeb1534d4d3c661067a5f9a96ac761af3e8f2f9871a0f3bcbc7d30816e09a3e9998d7bffdf3555d36a88f515
+  metadata.gz: 8b780c7ca124e8f84d708e94ec78a27b50e9b36cbf524264cea3582bb171b037e40f4f92d8292f115810b988dfe93d45a942c779550943484bfad9810c1865f3
+  data.tar.gz: 916571c822234a92ec9bbb1839c06c8a0cc9a6f434c370c0b9bccd6486a450c2dc2ec88e27069d3b14bff093e245d0a83e6aed71fc7bcd1f20b298ae479edde7

data/CHANGELOG.md

@@ -1,6 +1,30 @@
 # Change log
 
-## master
+## main
+
+## 1.6.2 (2026-04-02)
+
+- Upgrade setup generator. ([@palkan][])
+
+## 1.6.1 (2025-12-18)
+
+- Ensure `bin/dist/anycable-go` has execution permission as part of `bin/anycable-go` ([@dmorgan-fa][])
+
+## 1.6.0 (2025-03-18)
+
+- 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).
+
+- Add Presence API. ([@palkan][])
+
+## 1.5.5 (2024-12-12)
+
+- Publish RuboCop cops as a separate gem (`rubocop-anycable-rails`). ([@palkan][])
+
+- Upgrade RuboCop cops. ([@palkan][])
 
 ## 1.5.4 (2024-10-08)
 

data/README.md

@@ -1,30 +1,18 @@
-[![Gem Version](https://badge.fury.io/rb/anycable-rails.svg)](https://rubygems.org/gems/anycable-rails)
+[![Gem Version](https://badge.fury.io/rb/anycable.svg)](https://rubygems.org/gems/anycable)
 [![Build](https://github.com/anycable/anycable-rails/workflows/Build/badge.svg)](https://github.com/anycable/anycable-rails/actions)
 [![Documentation](https://img.shields.io/badge/docs-link-brightgreen.svg)](https://docs.anycable.io/rails/getting_started)
 
-# AnyCable Rails
+# AnyCable SDK for Ruby on Rails
 
-AnyCable allows you to use any WebSocket server (written in any language) as a replacement for built-in Rails Action Cable server.
+<img align="right" height="150" width="129"
+     title="AnyCable logo" src="https://docs.anycable.io/assets/images/logo.svg">
 
-With AnyCable you can use channels, client-side JS, broadcasting - (almost) all that you can do with Action Cable.
+[AnyCable](https://github.com/anycable/anycable) is an open-source language-agnostic realtime server for reliable two-way communication over WebSockets and SSE.
+This repository contains code for AnyCable Rails SKD that allows you to use AnyCable as a drop-in replacement for Action Cable.
 
-💾 [Example Application](https://github.com/anycable/anycable_rails_demo)
+🌐 [Website](https://anycable.io) · 📚 [Documentation](https://docs.anycable.io/rails/getting_started) · 💾 [Example Rails Application](https://github.com/anycable/anycable_rails_demo)
 
-📑 [Documentation](https://docs.anycable.io/rails/getting_started).
-
-> [AnyCable Pro](https://docs.anycable.io/pro) has been launched 🚀
-
-<a href="https://evilmartians.com/">
-<img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54"></a>
-
-## Requirements
-
-- Ruby >= 3.1
-- Rails >= 6.0\*
-
-\* Recent `anycable-rails` versions only work with Rails 8+; older versions compatible with Rails 6 and Rails 7 still receive fixes and minor updates (patch releases).
-
-## Usage
+## Quick Start
 
 Add `anycable-rails` gem to your Gemfile:
 
@@ -32,62 +20,13 @@ Add `anycable-rails` gem to your Gemfile:
 gem "anycable-rails"
 ```
 
-### Interactive set up
-
-After the gem was installed, you can run an interactive wizard to configure your Rails application for using with AnyCable by running a generator:
+Then run our interactive setup command:
 
 ```sh
 bundle exec rails g anycable:setup
 ```
 
-### Manual set up
-
-Specify AnyCable subscription adapter for Action Cable:
-
-```yml
-# config/cable.yml
-development:
-  adapter: any_cable # or anycable
-
-production:
-  adapter: any_cable
-```
-
-and specify AnyCable WebSocket server URL:
-
-```ruby
-# For development it's likely the localhost
-
-# config/environments/development.rb
-config.action_cable.url = "ws://localhost:8080/cable"
-
-# For production it's likely to have a sub-domain and secure connection
-
-# config/environments/production.rb
-config.action_cable.url = "wss://ws.example.com/cable"
-```
-
-Then, run AnyCable RPC server:
-
-```sh
-$ bundle exec anycable
-
-# don't forget to provide Rails env
-
-$ RAILS_ENV=production bundle exec anycable
-```
-
-And, finally, run AnyCable WebSocket server, e.g. [anycable-go](https://docs.anycable.io/anycable-go/getting_started):
-
-```sh
-anycable-go --host=localhost --port=8080
-```
-
-See [documentation](https://docs.anycable.io/rails/getting_started) for more information on AnyCable + Rails usage.
-
-## Action Cable Compatibility
-
-See [documentation](https://docs.anycable.io/rails/compatibility).
+Learn more [here](https://docs.anycable.io/rails/getting_started).
 
 ## Contributing
 

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/action_cable_ext/remote_connections.rb

@@ -6,7 +6,7 @@ ActionCable::RemoteConnections::RemoteConnection.include(AnyCable::Rails::Connec
 ActionCable::RemoteConnections::RemoteConnection.prepend(Module.new do
   def disconnect(reconnect: true)
     # Legacy Action Cable functionality if case we're not fully migrated yet
-    super unless AnyCable::Rails.enabled?
+    return super unless AnyCable::Rails.enabled?
     ::AnyCable.broadcast_adapter.broadcast_command("disconnect", identifier: identifiers_json, reconnect: reconnect)
   end
 end)

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module AnyCable
+  module Rails
+    module Channel
+      # Presence API for Action Cable channels (backed by AnyCable)
+      module Presence
+        extend ActiveSupport::Concern
+
+        def join_presence(stream = nil, id: user_presence_id, info: user_presence_info)
+          return unless anycabled?
+
+          stream ||= connection.anycable_socket.streams[:start].first || raise(ArgumentError, "Provide a stream name for presence updates")
+
+          connection.anycable_socket.presence_join(stream, id.to_s, info)
+        end
+
+        def leave_presence(id = user_presence_id)
+          return unless anycabled?
+
+          connection.anycable_socket.presence_leave(id)
+        end
+
+        private
+
+        def user_presence_id
+          connection.connection_identifier
+        end
+
+        def user_presence_info
+          # nothing
+        end
+      end
+    end
+  end
+end

data/lib/anycable/rails/channel.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module AnyCable
+  module Rails
+    module Channel
+      autoload :Presence, "anycable/rails/channel/presence"
+    end
+  end
+end

data/lib/anycable/rails/compatibility/rubocop.rb

@@ -1,27 +1,4 @@
 # frozen_string_literal: true
 
-require "rubocop"
-require "pathname"
-
-require_relative "rubocop/cops/anycable/stream_from"
-require_relative "rubocop/cops/anycable/periodical_timers"
-require_relative "rubocop/cops/anycable/instance_vars"
-
-module RuboCop
-  module AnyCable # :nodoc:
-    CONFIG_DEFAULT = Pathname.new(__dir__).join("rubocop", "config", "default.yml").freeze
-
-    # Merge anycable config into default configuration
-    # See https://github.com/backus/rubocop-rspec/blob/master/lib/rubocop/rspec/inject.rb
-    def self.inject!
-      path = CONFIG_DEFAULT.to_s
-      puts "configuration from #{path}" if ConfigLoader.debug?
-      hash = ConfigLoader.send(:load_yaml_configuration, path)
-      config = Config.new(hash, path)
-      config = ConfigLoader.merge_with_default(config, path)
-      ConfigLoader.instance_variable_set(:@default_configuration, config)
-    end
-  end
-end
-
-RuboCop::AnyCable.inject!
+# For backwards compatibility
+require_relative "../rubocop"

data/lib/anycable/rails/compatibility.rb

@@ -9,6 +9,7 @@ module AnyCable
       @_streams
       @parameter_filter
       @whisper_stream
+      @__sid__
     ]
 
     ActionCable::Channel::Base.prepend(Module.new do

data/lib/anycable/rails/config.rb

@@ -9,6 +9,7 @@ require "anyway/rails"
 # - `access_logs_disabled` (defaults to true) — whether to print Started/Finished logs
 # - `persistent_session_enabled` (defaults to false) — whether to store session changes in the connection state
 # - `embedded` (defaults to false) — whether to run RPC server inside a Rails server process
+# - `http_rpc` (default to false) - whether to mount HTTP RPC server or not
 # - `http_rpc_mount_path` (defaults to nil) — path to mount HTTP RPC server
 # - `batch_broadcasts` (defaults to false) — whether to batch broadcasts automatically for code wrapped with Rails executor
 # - `jwt_param` (defaults to 'jid') — the name of the JWT authentication query paramter or header
@@ -18,6 +19,7 @@ AnyCable::Config.attr_config(
   persistent_session_enabled: false,
   embedded: false,
   jwt_param: "jid",
+  http_rpc: false,
   http_rpc_mount_path: nil,
   batch_broadcasts: false,
   socket_id_header: "X-Socket-ID",

data/lib/anycable/rails/connection.rb

@@ -31,15 +31,69 @@ 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"])
+
+          case data["command"]
+          when "unsubscribe"
+            remove data
+          when "message"
+            perform_action data
+          when "whisper"
+            whisper data
+          else
+            raise UnknownCommandError, data["command"]
+          end
 
-          unless subscriptions[identifier]
-            raise "Channel not found: #{ActiveSupport::JSON.decode(identifier).fetch("channel")}"
+          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]
 
-          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
+          if id_options[:channel] == "$pubsub"
+            PubSubChannel
+          else
+            id_options[:channel].safe_constantize
+          end
+        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 +128,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 +158,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/connections/serializable_identification.rb

@@ -6,6 +6,20 @@ module AnyCable
       module SerializableIdentification
         extend ActiveSupport::Concern
 
+        module ConnectionGID
+          def connection_identifier
+            unless defined? @connection_identifier
+              @connection_identifier = connection_gid identifiers.filter_map { |id| instance_variable_get(:"@#{id}") || __send__(id) }
+            end
+
+            @connection_identifier
+          end
+        end
+
+        included do
+          prepend ConnectionGID
+        end
+
         class_methods do
           def identified_by(*identifiers)
             super

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/railtie.rb

@@ -113,6 +113,7 @@ module AnyCable
       initializer "anycable.routes" do
         config.after_initialize do |app|
           config = AnyCable.config
+          config.http_rpc_mount_path ||= "/_anycable" if config.http_rpc?
           unless config.http_rpc_mount_path.nil?
             app.routes.prepend do
               mount AnyCable::HTTRPC::Server.new => config.http_rpc_mount_path, :internal => true
@@ -123,11 +124,12 @@ module AnyCable
 
       initializer "anycable.verify_pool_sizes" do
         next if AnyCable.config.disable_rpc_pool_size_warning?
-        # Skip if non-gRPC server is used
-        next unless AnyCable.config.respond_to?(:rpc_pool_size)
 
         # Log current db vs. gRPC pool sizes
         AnyCable.configure_server do
+          # Skip if non-gRPC server is used
+          next unless AnyCable.config.respond_to?(:rpc_pool_size)
+
           ActiveSupport.on_load(:active_record) do
             db_pool_size = ::ActiveRecord::Base.connection_pool.size
             rpc_pool_size = AnyCable.config.rpc_pool_size

data/lib/anycable/rails/{compatibility/rubocop → rubocop}/cops/anycable/instance_vars.rb

@@ -24,7 +24,7 @@ module RuboCop
       #     end
       #   end
       #
-      class InstanceVars < RuboCop::Cop::Cop
+      class InstanceVars < RuboCop::Cop::Base
         MSG = "Channel instance variables are not supported in AnyCable. Use `state_attr_accessor` instead"
 
         def on_class(node)

data/lib/anycable/rails/{compatibility/rubocop → rubocop}/cops/anycable/periodical_timers.rb

@@ -13,16 +13,11 @@ module RuboCop
       #     periodically(:do_something, every: 2.seconds)
       #   end
       #
-      class PeriodicalTimers < RuboCop::Cop::Cop
+      class PeriodicalTimers < RuboCop::Cop::Base
         MSG = "Periodical Timers are not supported in AnyCable"
+        RESTRICT_ON_SEND = %i[periodically].freeze
 
-        def_node_matcher :calls_periodically?, <<-PATTERN
-          (send _ :periodically ...)
-        PATTERN
-
-        def on_send(node)
-          add_offense(node) if calls_periodically?(node)
-        end
+        alias_method :on_send, :add_offense
       end
     end
   end

data/lib/anycable/rails/{compatibility/rubocop → rubocop}/cops/anycable/stream_from.rb

@@ -34,7 +34,7 @@ module RuboCop
       #     end
       #   end
       #
-      class StreamFrom < RuboCop::Cop::Cop
+      class StreamFrom < RuboCop::Cop::Base
         def_node_matcher :stream_from_with_block?, <<-PATTERN
           (block {(send _ :stream_from ...) (send _ :stream_for ...)} ...)
         PATTERN
@@ -81,16 +81,14 @@ module RuboCop
 
         def add_callback_offense(node)
           add_offense(
-            node,
-            location: :expression,
+            node.loc.expression,
             message: "Custom stream callbacks are not supported in AnyCable"
           )
         end
 
         def add_custom_coder_offense(node)
           add_offense(
-            node,
-            location: :expression,
+            node.loc.expression,
             message: "Custom coders are not supported in AnyCable"
           )
         end

data/lib/anycable/rails/rubocop.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "rubocop"
+require "pathname"
+
+require_relative "rubocop/cops/anycable/stream_from"
+require_relative "rubocop/cops/anycable/periodical_timers"
+require_relative "rubocop/cops/anycable/instance_vars"
+
+module RuboCop
+  module AnyCable # :nodoc:
+    CONFIG_DEFAULT = Pathname.new(__dir__).join("rubocop", "config", "default.yml").freeze
+
+    # Merge anycable config into default configuration
+    # See https://github.com/backus/rubocop-rspec/blob/master/lib/rubocop/rspec/inject.rb
+    def self.inject!
+      path = CONFIG_DEFAULT.to_s
+      puts "configuration from #{path}" if ConfigLoader.debug?
+      hash = ConfigLoader.send(:load_yaml_configuration, path)
+      config = Config.new(hash, path)
+      config = ConfigLoader.merge_with_default(config, path)
+      ConfigLoader.instance_variable_set(:@default_configuration, config)
+    end
+  end
+end
+
+RuboCop::AnyCable.inject!

data/lib/anycable/rails/socket_id_tracking.rb

@@ -11,8 +11,8 @@ module AnyCable
 
       private
 
-      def anycable_tracking_socket_id(&)
-        Rails.with_socket_id(request.headers[AnyCable.config.socket_id_header], &)
+      def anycable_tracking_socket_id(&block)
+        Rails.with_socket_id(request.headers[AnyCable.config.socket_id_header], &block)
       end
     end
 

data/lib/anycable/rails/version.rb

@@ -2,6 +2,6 @@
 
 module AnyCable
   module Rails
-    VERSION = "1.5.4"
+    VERSION = "1.6.2"
   end
 end

data/lib/anycable/rails.rb

@@ -9,6 +9,7 @@ require "globalid"
 require "active_support/core_ext/module/attribute_accessors_per_thread"
 
 require "anycable/rails/ext"
+require "anycable/rails/channel"
 
 module AnyCable
   # Rails handler for AnyCable
@@ -84,7 +85,7 @@ end
 
 # Warn if application has been already initialized.
 # AnyCable should be loaded before initialization in order to work correctly.
-if defined?(::Rails) && ::Rails.application && ::Rails.application.initialized?
+if defined?(::Rails) && ::Rails.application&.initialized?
   puts("\n**************************************************")
   puts(
     "⛔️  WARNING: AnyCable loaded after application initialization. Might not work correctly.\n" \

data/lib/generators/anycable/bin/templates/bin/anycable-go.tt

@@ -10,6 +10,11 @@ if [ ! -f ./bin/dist/anycable-go ]; then
   ./bin/rails g anycable:download --version=$version --bin-path=./bin/dist
 fi
 
+if [ -x ./bin/dist/anycable-go ]; then
+  echo "Setting execution permission for AnyCable server"
+  chmod +x ./bin/dist/anycable-go
+fi
+
 curVersion=$(./bin/dist/anycable-go -v)
 
 if [[ "$version" != "latest" ]]; then

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