graphql-anycable 1.3.0 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d85da4ea44364a70b75af1157b5dd613e22eddea2b8ca8c0b20fb06041d9618
-  data.tar.gz: 915f82f6e2e746b968638454d5bf4adccf8a5c783a1203131e83fec6b0d28f5c
+  metadata.gz: 14133c519749fc9821bc5e9af2c28978b620afe77a7ec03cb26a51f41ef56c66
+  data.tar.gz: c8f8ee0f3c378bc72b80f4df1623e2ab402dc379097af315422b742abe09e17b
 SHA512:
-  metadata.gz: 01d1d65ae70213dbc9ce22334174fb2ea0f703da7cfa824f0409d39f24ce79993c360833dd67c1e18471668b83c43bdcf86b1bcbe699547ef5a8e0bfacdffebf
-  data.tar.gz: 99c5f3fc3ee7ad597dc3ee870e55cee7ca775df9fa0bb58f3babcbed0097d36ff2857349b3177cf13e3323013ca6b5304cb1a16a7240883847ed7b40a2c93323
+  metadata.gz: 667c1ecce687b40287dbd930144480cc7a14e4e663ca2ab7cd29538b586d4b2e3d4fdae38a0d3b4f37187ef7d2d25aa7b1f6112d89d79db481efc79f46d49c01
+  data.tar.gz: fc431ad886ce163e17bd1d257491f7964fd1140ebe89365ecdca7c7f5d66c661408c51bea51a3e36bc26c1b380d421b5d7d8ab0814fb6a94bd1a0ead45bad595

data/.github/workflows/lint.yml

@@ -24,10 +24,10 @@ jobs:
     env:
       BUNDLE_GEMFILE: "gemfiles/rubocop.gemfile"
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
     - uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 3.1
+        ruby-version: 3.4
         bundler-cache: true
     - name: Lint Ruby code with RuboCop
       run: |

data/.github/workflows/release.yml

@@ -13,7 +13,7 @@ jobs:
       id-token: write
       packages: write
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
         with:
           fetch-depth: 0 # Fetch current tag as annotated. See https://github.com/actions/checkout/issues/290
       - uses: ruby/setup-ruby@v1

data/.github/workflows/test.yml

@@ -18,6 +18,10 @@ jobs:
       fail-fast: false
       matrix:
         include:
+          - ruby: "4.0"
+            graphql: '~> 2.3'
+            anycable: '~> 1.6'
+            redis_version: latest
           - ruby: "3.3"
             graphql: '~> 2.3'
             anycable: '~> 1.5'
@@ -52,7 +56,7 @@ jobs:
         ports:
           - 6379:6379
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}

data/.rubocop/rspec.yml

@@ -1,4 +1,4 @@
-require:
+plugins:
   - rubocop-rspec
 
 # Disable all cops by default,

data/.rubocop.yml

@@ -2,8 +2,7 @@ inherit_mode:
   merge:
     - Exclude
 
-require:
-  - standard
+plugins:
   - standard-custom
   - standard-performance
   - rubocop-performance

data/CHANGELOG.md

@@ -7,6 +7,18 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## Unreleased
 
+## 1.3.2 - 2026-08-05
+
+### Fixed
+
+- Cleanup tasks are much faster and use bounded memory: `SCAN`/`SSCAN`/`ZSCAN` are called with a configurable `COUNT` (new `redis_scan_count` setting, default `1000`) instead of Redis' default of 10, members are read incrementally with `SSCAN`/`ZSCAN` instead of `SMEMBERS`/`ZRANGE` (which materialized entire sets in the rake process), and the per-member `EXISTS`, `OBJECT IDLETIME`, `SREM`, `ZREM` and `DEL` calls are pipelined in batches instead of being issued one round trip at a time. [@jjb] ([#56](https://github.com/anycable/graphql-anycable/pull/56))
+
+## 1.3.1 - 2025-03-29
+
+### Fixed
+
+- Remove `clean:events` from `clean_expired_subscriptions.rake`. [@Geesu] ([#46](https://github.com/anycable/graphql-anycable/pull/46))
+
 ## 1.3.0 - 2024-08-13
 
 ### Changed
@@ -211,6 +223,7 @@ Technical release to test publishing via GitHub Actions.
 
 Initial version: store subscriptions on redis, re-execute queries in sync. [@Envek]
 
+[@jjb]: https://github.com/jjb "John Bachir"
 [@prog-supdex]: https://github.com/prog-supdex "Igor Platonov"
 [@ilyasgaraev]: https://github.com/ilyasgaraev "Ilyas Garaev"
 [@smasry]: https://github.com/smasry "Samer Masry"

data/README.md

@@ -5,9 +5,9 @@ A (mostly) drop-in replacement for default ActionCable subscriptions adapter shi
 [![Gem Version](https://badge.fury.io/rb/graphql-anycable.svg)](https://badge.fury.io/rb/graphql-anycable)
 [![Tests](https://github.com/anycable/graphql-anycable/actions/workflows/test.yml/badge.svg)](https://github.com/anycable/graphql-anycable/actions/workflows/test.yml)
 
-<a href="https://evilmartians.com/?utm_source=graphql-anycable&utm_campaign=project_page">
-<img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54">
-</a>
+<br/>
+
+<img src="https://cdn.evilmartians.com/badges/logo-no-label.svg" alt="Evil Martians logo" width="22" height="16" /> <b>GraphQL-AnyCable</b> is built by <b><a href="https://evilmartians.com/">Evil Martians</a></b>, an American design and engineering consultancy for <b>developer tools, AI, and cybersecurity startups</b>.
 
 ## Why?
 
@@ -134,6 +134,10 @@ To avoid filling Redis storage with stale subscription data:
 
     Heroku users should set up `use_redis_object_on_cleanup` setting to `false` due to [limitations in Heroku Redis](https://devcenter.heroku.com/articles/heroku-redis#connection-permissions).
 
+    The task is also available as granular sub-tasks, so you can run only some of them, or run them on different schedules: `rake graphql:anycable:clean:channels`, `rake graphql:anycable:clean:subscriptions`, `rake graphql:anycable:clean:fingerprint_subscriptions`, `rake graphql:anycable:clean:topic_fingerprints`.
+
+    Cleanup iterates over Redis with the `SCAN` family of commands and pipelines the checks it performs on each batch. Use the `redis_scan_count` setting to tune the batch size: larger values mean fewer round trips (so faster cleanup), at the cost of doing more work per Redis call.
+
 ## Configuration
 
 GraphQL-AnyCable uses [anyway_config] to configure itself. There are several possibilities to configure this gem:
@@ -144,6 +148,7 @@ GraphQL-AnyCable uses [anyway_config] to configure itself. There are several pos
     GRAPHQL_ANYCABLE_SUBSCRIPTION_EXPIRATION_SECONDS=604800
     GRAPHQL_ANYCABLE_USE_REDIS_OBJECT_ON_CLEANUP=true
     GRAPHQL_ANYCABLE_REDIS_PREFIX=graphql
+    GRAPHQL_ANYCABLE_REDIS_SCAN_COUNT=1000
     ```
 
  2. YAML configuration files (note that this is `config/graphql_anycable.yml`, *not* `config/anycable.yml`):
@@ -154,6 +159,7 @@ GraphQL-AnyCable uses [anyway_config] to configure itself. There are several pos
       subscription_expiration_seconds: 300 # 5 minutes
       use_redis_object_on_cleanup: false # For restricted redis installations
       redis_prefix: graphql # You can configure redis_prefix for anycable-graphql subscription prefixes. Default value "graphql"
+      redis_scan_count: 1000 # Batch size used by the cleanup rake tasks. Default value 1000
     ```
 
  3. Configuration from your application code:

data/gemfiles/rubocop.gemfile

@@ -1,5 +1,4 @@
-source "https://rubygems.org" do
-  gem "standard", "~> 1.28"
+source "https://rubygems.org"
 
-  gem "rubocop-rspec"
-end
+gem "standard"
+gem "rubocop-rspec"

data/graphql-anycable.gemspec

@@ -17,6 +17,10 @@ Gem::Specification.new do |spec|
   spec.homepage = "https://github.com/Envek/graphql-anycable"
   spec.license = "MIT"
 
+  spec.metadata = {
+    "rubygems_mfa_required" => "true"
+  }
+
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
@@ -34,7 +38,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "redis", ">= 4.2.0"
 
   spec.add_development_dependency "anycable-rails"
-  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "bundler", ">= 2.0"
   spec.add_development_dependency "rack"
   spec.add_development_dependency "railties"
   spec.add_development_dependency "rake", ">= 12.3.3"

data/lib/graphql/anycable/cleaner.rb

@@ -16,61 +16,88 @@ module GraphQL
         return unless config.subscription_expiration_seconds
         return unless config.use_redis_object_on_cleanup
 
-        redis.scan_each(match: "#{redis_key(adapter::CHANNEL_PREFIX)}*") do |key|
-          idle = redis.object("IDLETIME", key)
-          next if idle&.<= config.subscription_expiration_seconds
-
-          redis.del(key)
-        end
+        clean_idle_keys(adapter::CHANNEL_PREFIX)
       end
 
       def clean_subscriptions
         return unless config.subscription_expiration_seconds
         return unless config.use_redis_object_on_cleanup
 
-        redis.scan_each(match: "#{redis_key(adapter::SUBSCRIPTION_PREFIX)}*") do |key|
-          idle = redis.object("IDLETIME", key)
-          next if idle&.<= config.subscription_expiration_seconds
-
-          redis.del(key)
-        end
+        clean_idle_keys(adapter::SUBSCRIPTION_PREFIX)
       end
 
       def clean_fingerprint_subscriptions
-        redis.scan_each(match: "#{redis_key(adapter::SUBSCRIPTIONS_PREFIX)}*") do |key|
-          redis.smembers(key).each do |subscription_id|
-            next if redis.exists?(redis_key(adapter::SUBSCRIPTION_PREFIX) + subscription_id)
-
-            redis.srem(key, subscription_id)
+        AnyCable.with_redis do |redis|
+          each_key(redis, adapter::SUBSCRIPTIONS_PREFIX) do |key|
+            each_batch(redis.sscan_each(key, count: redis_scan_count)) do |subscription_ids|
+              stale = missing_key_ids(redis, adapter::SUBSCRIPTION_PREFIX, subscription_ids)
+              redis.srem(key, stale) unless stale.empty?
+            end
           end
         end
       end
 
       def clean_topic_fingerprints
-        redis.scan_each(match: "#{redis_key(adapter::FINGERPRINTS_PREFIX)}*") do |key|
-          redis.zremrangebyscore(key, "-inf", "0")
-          redis.zrange(key, 0, -1).each do |fingerprint|
-            next if redis.exists?(redis_key(adapter::SUBSCRIPTIONS_PREFIX) + fingerprint)
-
-            redis.zrem(key, fingerprint)
+        AnyCable.with_redis do |redis|
+          each_key(redis, adapter::FINGERPRINTS_PREFIX) do |key|
+            redis.zremrangebyscore(key, "-inf", "0")
+
+            each_batch(redis.zscan_each(key, count: redis_scan_count)) do |members|
+              fingerprints = members.map(&:first)
+              stale = missing_key_ids(redis, adapter::SUBSCRIPTIONS_PREFIX, fingerprints)
+              redis.zrem(key, stale) unless stale.empty?
+            end
           end
         end
       end
 
       private
 
-      def adapter
-        GraphQL::Subscriptions::AnyCableSubscriptions
+      def clean_idle_keys(prefix)
+        AnyCable.with_redis do |redis|
+          each_batch(redis.scan_each(match: "#{redis_key(prefix)}*", count: redis_scan_count)) do |keys|
+            idle_times = redis.pipelined do |pipeline|
+              keys.each { |key| pipeline.object("IDLETIME", key) }
+            end
+
+            expired = keys.reject.with_index { |_key, index| idle_times[index]&.<= config.subscription_expiration_seconds }
+            redis.del(*expired) unless expired.empty?
+          end
+        end
       end
 
-      def redis
-        GraphQL::AnyCable.redis
+      # Iterates over the keys matching the given prefix, one key at a time.
+      def each_key(redis, prefix, &block)
+        redis.scan_each(match: "#{redis_key(prefix)}*", count: redis_scan_count, &block)
+      end
+
+      # Consumes a lazy enumerator (SCAN family) in batches to keep memory usage bounded.
+      def each_batch(enumerator, &block)
+        enumerator.each_slice(redis_scan_count, &block)
+      end
+
+      # Returns the ids which have no corresponding key in redis anymore, checking them in a single round trip.
+      def missing_key_ids(redis, prefix, ids)
+        exists = redis.pipelined do |pipeline|
+          ids.each { |id| pipeline.exists?(redis_key(prefix) + id) }
+        end
+
+        # Reject ids that has corresponding key in Redis in `exists` array of pipelined responses.
+        ids.reject.with_index { |_id, index| exists[index] }
+      end
+
+      def adapter
+        GraphQL::Subscriptions::AnyCableSubscriptions
       end
 
       def config
         GraphQL::AnyCable.config
       end
 
+      def redis_scan_count
+        config.redis_scan_count.to_i
+      end
+
       def redis_key(prefix)
         "#{config.redis_prefix}-#{prefix}"
       end

data/lib/graphql/anycable/config.rb

@@ -11,6 +11,7 @@ module GraphQL
       attr_config subscription_expiration_seconds: nil
       attr_config use_redis_object_on_cleanup: true
       attr_config redis_prefix: "graphql" # Here, we set clear redis_prefix without any hyphen. The hyphen is added at the end of this value on our side.
+      attr_config redis_scan_count: 1_000 # COUNT for SCAN commands and batch size for pipelined commands during cleanup.
     end
   end
 end

data/lib/graphql/anycable/tasks/clean_expired_subscriptions.rake

@@ -5,7 +5,7 @@ require "graphql-anycable"
 namespace :graphql do
   namespace :anycable do
     desc "Clean up stale graphql channels, subscriptions, and events from redis"
-    task clean: %i[clean:channels clean:subscriptions clean:events clean:fingerprint_subscriptions clean:topic_fingerprints]
+    task clean: %i[clean:channels clean:subscriptions clean:fingerprint_subscriptions clean:topic_fingerprints]
 
     namespace :clean do
       # Clean up old channels

data/lib/graphql/anycable/version.rb

@@ -2,6 +2,6 @@
 
 module GraphQL
   module AnyCable
-    VERSION = "1.3.0"
+    VERSION = "1.3.2"
   end
 end

data/lib/graphql/subscriptions/anycable_subscriptions.rb

@@ -4,8 +4,6 @@ require "anycable"
 require "graphql/subscriptions"
 require "graphql/anycable/errors"
 
-# rubocop: disable Metrics/AbcSize, Metrics/LineLength, Metrics/MethodLength
-
 # A subscriptions implementation that sends data as AnyCable broadcastings.
 #
 # Since AnyCable is aimed to be compatible with ActionCable, this adapter
@@ -249,4 +247,3 @@ module GraphQL
     end
   end
 end
-# rubocop: enable Metrics/AbcSize, Metrics/LineLength, Metrics/MethodLength

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-anycable
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.2
 platform: ruby
 authors:
 - Andrey Novikov
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-13 00:00:00.000000000 Z
+date: 2026-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: anycable-core
@@ -96,14 +96,14 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
@@ -162,7 +162,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: 
+description:
 email:
 - envek@envek.name
 executables: []
@@ -202,8 +202,9 @@ files:
 homepage: https://github.com/Envek/graphql-anycable
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -218,8 +219,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key: 
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: A drop-in replacement for GraphQL ActionCable subscriptions for AnyCable.
 test_files: []