graphql-anycable 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f43d8941cd7af501d59ba278700ab982c8b7d261d4932d5ae09696533daeb9e
-  data.tar.gz: f4e95708adc2f337356dbad4529e5d0ae6230c46919ce22d06f6b6278f5575d1
+  metadata.gz: 79ed158f4e882659ca963af6a22fb66ce34dfa9a2e0f07de40f6331dd5865fb3
+  data.tar.gz: 47a9a999c879d9a143d48fea3275573f557e0b33615038b0b6940c7743338939
 SHA512:
-  metadata.gz: e32732357bcba4ce95912c3a81ee4b9c828049de6ec7b7f80174b173cc930ae1fa84bac1bf0259e2b1c8704e847790d6942c6b76a90c716fcf2026222a12d87b
-  data.tar.gz: 4d8a726b1844408dcc54d66748368f14e94ff3412eea30f768f56d076a78de73e6fcee84eb20b51175784a5eb13c806c666b50c39aca01f3d1a35c26d8c23646
+  metadata.gz: a960f6150eb79e81fe27c12a12d8fee66297aaac03184725df45f1c95abdc0274e211564cd4095c5e64a88ee8694ee7972f071834279022f1b779be9580ba7ec
+  data.tar.gz: e98df2b3bb0770a0531b982002a319637821cc842be29ea832e916ffafbaf827ec1d9c275604ce13ecdcb278213d8bc9b54013981406f0d23ef95399bb552001

data/.travis.yml

@@ -3,7 +3,8 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.5.3
-  - 2.4.5
-  - 2.3.8
-before_install: gem install bundler -v 1.17.1
+  - 2.7.0
+  - 2.6.5
+  - 2.5.7
+  - 2.4.9
+before_install: gem install bundler -v "~> 2.0"

data/README.md

@@ -104,7 +104,10 @@ Or install it yourself as:
 To avoid filling Redis storage with stale subscription data:
 
  1. Set `GRAPHQL_ANYCABLE_SUBSCRIPTION_EXPIRATION_SECONDS` environment variable to number of seconds (e.g. `604800` for 1 week). See [anyway_config] documentation to other ways of configuring this gem.
- 2. Execute `rake graphql:anycable:clean_expired_subscriptions` once in a while to clean up stale subscription data
+
+ 2. Execute `rake graphql:anycable:clean` once in a while to clean up stale subscription data.
+
+    Heroku users should set up `GRAPHQL_ANYCABLE_USE_REDIS_OBJECT_ON_CLEANUP` environment variable to `false` due to [limitations in Heroku Redis](https://devcenter.heroku.com/articles/heroku-redis#connection-permissions).
 
 ## Development
 

data/graphql-anycable.gemspec

@@ -26,12 +26,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "anycable",      "~> 0.6.0"
-  spec.add_dependency "anyway_config", "~> 1.3"
+  spec.add_dependency "anycable",      ">= 0.6.0", "< 2"
+  spec.add_dependency "anyway_config", ">= 1.3", "< 3"
   spec.add_dependency "graphql",       "~> 1.8"
 
-  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "fakeredis"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

data/lib/graphql/anycable/config.rb

@@ -9,6 +9,7 @@ module GraphQL
       env_prefix  :graphql_anycable
 
       attr_config subscription_expiration_seconds: nil
+      attr_config use_redis_object_on_cleanup: true
     end
   end
 end

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

@@ -4,39 +4,61 @@ require "graphql-anycable"
 
 namespace :graphql do
   namespace :anycable do
-    task :clean_expired_subscriptions do
-      config = GraphQL::Anycable::Config.new
-      unless config.subscription_expiration_seconds
-        warn "GraphQL::Anycable: No expiration set for subscriptions!"
-        next
-      end
+    desc "Clean up stale graphql channels, subscriptions, and events from redis"
+    task clean: %i[clean:channels clean:subscriptions clean:events]
+
+    # Old name that was used earlier
+    task clean_expired_subscriptions: :clean
+
+    namespace :clean do
+      KLASS = GraphQL::Subscriptions::AnyCableSubscriptions
+
+      # Clean up old channels
+      task :channels do
+        next unless config.subscription_expiration_seconds
+        next unless config.use_redis_object_on_cleanup
 
-      redis = GraphQL::Anycable.redis
-      klass = GraphQL::Subscriptions::AnyCableSubscriptions
+        redis.scan_each(match: "#{KLASS::CHANNEL_PREFIX}*") do |key|
+          idle = redis.object("IDLETIME", key)
+          next if idle&.<= config.subscription_expiration_seconds
 
-      # 1. Clean up old channels
-      redis.scan_each(match: "#{klass::CHANNEL_PREFIX}*") do |key|
-        idle = redis.object("IDLETIME", key)
-        next if idle&.<= config.subscription_expiration_seconds
-        redis.del(key)
+          redis.del(key)
+        end
       end
 
-      # 2. Clean up old subscriptions (they should have expired by themselves)
-      redis.scan_each(match: "#{klass::SUBSCRIPTION_PREFIX}*") do |key|
-        idle = redis.object("IDLETIME", key)
-        next if idle&.<= config.subscription_expiration_seconds
-        redis.del(key)
+      # Clean up old subscriptions (they should have expired by themselves)
+      task :subscriptions do
+        next unless config.subscription_expiration_seconds
+        next unless config.use_redis_object_on_cleanup
+
+        redis.scan_each(match: "#{KLASS::SUBSCRIPTION_PREFIX}*") do |key|
+          idle = redis.object("IDLETIME", key)
+          next if idle&.<= config.subscription_expiration_seconds
+
+          redis.del(key)
+        end
       end
 
-      # 3. Clean up subscription_ids from events for expired subscriptions
-      redis.scan_each(match: "#{klass::SUBSCRIPTION_EVENTS_PREFIX}*") do |key|
-        subscription_id = key.sub(/\A#{klass::SUBSCRIPTION_EVENTS_PREFIX}/, "")
-        next if redis.exists(klass::SUBSCRIPTION_PREFIX + subscription_id)
-        redis.smembers(key).each do |event_topic|
-          redis.srem(klass::EVENT_PREFIX + event_topic, subscription_id)
+      # Clean up subscription_ids from events for expired subscriptions
+      task :events do
+        redis.scan_each(match: "#{KLASS::SUBSCRIPTION_EVENTS_PREFIX}*") do |key|
+          subscription_id = key.sub(/\A#{KLASS::SUBSCRIPTION_EVENTS_PREFIX}/, "")
+          next if redis.exists(KLASS::SUBSCRIPTION_PREFIX + subscription_id)
+
+          redis.smembers(key).each do |event_topic|
+            redis.srem(KLASS::EVENT_PREFIX + event_topic, subscription_id)
+          end
+          redis.del(key)
         end
-        redis.del(key)
       end
     end
+
+    def config
+      @config ||= GraphQL::Anycable::Config.new
+    end
+
+    def redis
+      GraphQL::Anycable.redis
+    end
   end
 end

data/lib/graphql/anycable/version.rb

@@ -2,6 +2,6 @@
 
 module GraphQL
   module Anycable
-    VERSION = "0.3.1"
+    VERSION = "0.3.2"
   end
 end

metadata

@@ -1,43 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: graphql-anycable
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Andrey Novikov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-13 00:00:00.000000000 Z
+date: 2020-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: anycable
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.6.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.6.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: anyway_config
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: graphql
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +70,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: fakeredis
   requirement: !ruby/object:Gem::Requirement
@@ -84,16 +96,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement