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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06a551d757afa07138babbf351024554d52b667ab35893bc995cc1fb56edd8af
-  data.tar.gz: c630ecf586cfd0068b0d248c00dc1372ffd7d83a3abf0e76dc9ecd52ae960a7c
+  metadata.gz: 395f76c02adbd3f4878b55bb21bf4bd00969e4394e824fb7a23f086d8b221b1c
+  data.tar.gz: b300f5b2ab64aa893d462a22045587f65531bbaea8dce3a920c1fb1df67b211e
 SHA512:
-  metadata.gz: 2d46a5b21269ef7cb9cfc562ecee2cfd9830e055dd18fb20bce468409f0a84bc3ca3dc1ba56d9d340202039de3ab93aeba2e600388b7130b99bff101cbf00448
-  data.tar.gz: 64a083bf7d4046b5a1bfa57058f0aa1cedded844067b15f5f9ea660a8d5291bbe2c8f6db6c4a63768f2d17f67d40bb920f4abe8e55b9fbc9241f72c4a4d9c587
+  metadata.gz: f0a2f228649539c86b8e3f1a96f0c456b6ed0f933552fb93c90ef2d4a5c49261fdbdf9f3e7b650cd69b00ca38bddcf202bb6f1d730aa92ad07ec3f8504128904
+  data.tar.gz: dfce4029440d91a5a7f07abccca089b6b0bb759d152aa2fadad9ccb12ca0533a5d10cba6e200f398ce58c54c76c5b0fa5903c48aeacba2354dc8b5f9ad37d10f

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,6 +3,17 @@
 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

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

@@ -31,65 +31,15 @@ module AnyCable
       end
 
       refine ActionCable::Connection::Subscriptions do
-        # 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"])
+        # Find or add a subscription to the list
+        def fetch(identifier)
+          add("identifier" => identifier) unless subscriptions[identifier]
 
-          case data["command"]
-          when "unsubscribe"
-            remove data
-          when "message"
-            perform_action data
-          when "whisper"
-            whisper data
-          else
-            raise UnknownCommandError, data["command"]
+          unless subscriptions[identifier]
+            raise "Channel not found: #{ActiveSupport::JSON.decode(identifier).fetch("channel")}"
           end
 
-          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
+          subscriptions[identifier]
         end
       end
     end)
@@ -124,8 +74,15 @@ module AnyCable
         conn.cached_ids = {}
         conn.anycable_request_builder = self
 
+        return unless subscriptions
+
         # Pre-initialize channels (for disconnect)
-        conn.subscriptions.restore(subscriptions, socket.istate) if subscriptions
+        subscriptions.each do |id|
+          channel = conn.subscriptions.fetch(id)
+          next unless socket.istate[id]
+
+          channel.__istate__ = ActiveSupport::JSON.decode(socket.istate[id])
+        end
       end
 
       def handle_open
@@ -154,8 +111,26 @@ module AnyCable
 
       def handle_channel_command(identifier, command, data)
         conn.run_callbacks :command do
-          conn.subscriptions.execute_rpc_command({"command" => command, "identifier" => identifier, "data" => 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
+          end
         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/railtie.rb

@@ -123,11 +123,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/version.rb

@@ -2,6 +2,6 @@
 
 module AnyCable
   module Rails
-    VERSION = "1.5.6"
+    VERSION = "1.6.0.rc.1"
   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

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: anycable-rails-core
 version: !ruby/object:Gem::Version
-  version: 1.5.6
+  version: 1.6.0.rc.1
 platform: ruby
 authors:
 - palkan
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-01-15 00:00:00.000000000 Z
+date: 2025-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: anycable-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.0.rc.1
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.6.0.rc.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.7.0
 - !ruby/object:Gem::Dependency
   name: actioncable
   requirement: !ruby/object:Gem::Requirement
@@ -77,6 +83,8 @@ files:
 - lib/anycable/rails/action_cable_ext/channel.rb
 - lib/anycable/rails/action_cable_ext/connection.rb
 - lib/anycable/rails/action_cable_ext/remote_connections.rb
+- lib/anycable/rails/channel.rb
+- lib/anycable/rails/channel/presence.rb
 - lib/anycable/rails/channel_state.rb
 - lib/anycable/rails/compatibility.rb
 - lib/anycable/rails/compatibility/rubocop.rb
@@ -131,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
@@ -142,12 +150,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      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: []