graphql-anycable 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c494ac593becba11ed50d2ffe1af1c16afa91e4dec8393b59a4d3e17fedaf926
-  data.tar.gz: 15682a1ca82073419efb27600383443f0db2bbf2288b3b494d77512eace7096e
+  metadata.gz: cc4ead83b0cc39fdf211c97e4664932a6125ca48b6e30ea889ab4692c075bb23
+  data.tar.gz: 89ff31b340ed13fbe0493245556a587692f3f6211a72422c0dbee750c8e48135
 SHA512:
-  metadata.gz: b630183f77e927586116388aa8c975bbb04242ca956a8dfcb10453afa7c6d1ba324a3eaca85cb6237d855dab4fd612ae269d380ecc0a5c3e786186c1836b0067
-  data.tar.gz: b35bd5536f6d6460aa97af5d69aa0fab63962111a53854f429796e70d8b5b9831a550f9d19698853e4bd7b551096d90a653bd616a3f6100a7b54bc592126adee
+  metadata.gz: d705c044762c1bbf2baa763ac8fcfee2a45f3bfbe0c9ec7ab8a94710af255769793eb9e2932b84edc800ee00fbcaf37ecf3b4acba1e6d475b172d5773c2b4ae0
+  data.tar.gz: be40d20ca4ce9b35f37501646029c8bceafba7617a8d236ac66aa963f4b4f22196ea753597bfae124f357a91441ed937016766b454cc56ff649c6dbb25a40fe6

data/README.md

@@ -97,6 +97,13 @@ Or install it yourself as:
     MySchema.subscriptions.trigger(:product_updated, {}, Product.first!, scope: account.id)
     ```
 
+## Operations
+
+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
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -114,3 +121,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 [graphql gem]: https://github.com/rmosolgo/graphql-ruby "Ruby implementation of GraphQL"
 [AnyCable]: https://github.com/anycable/anycable "Polyglot replacement for Ruby WebSocket servers with Action Cable protocol"
 [LiteCable]: https://github.com/palkan/litecable "Lightweight Action Cable implementation (Rails-free)"
+[anyway_config]: https://github.com/palkan/anyway_config "Ruby libraries and applications configuration on steroids!"

data/graphql-anycable.gemspec

@@ -26,8 +26,9 @@ 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.5"
-  spec.add_dependency "graphql",  "~> 1.8"
+  spec.add_dependency "anycable",      "~> 0.5"
+  spec.add_dependency "anyway_config", "~> 1.3"
+  spec.add_dependency "graphql",       "~> 1.8"
 
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "fakeredis"

data/lib/Rakefile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require "graphql-anycable"
+
+Dir.glob("#{File.expand_path(__dir__)}/tasks/**/*.rake").each { |f| import f }

data/lib/graphql/anycable/config.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "anyway"
+
+module Graphql
+  module Anycable
+    class Config < Anyway::Config
+      config_name :graphql_anycable
+      env_prefix  :graphql_anycable
+
+      attr_config subscription_expiration_seconds: nil
+    end
+  end
+end

data/lib/graphql/anycable/railtie.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "rails"
+
+module Graphql
+  module Anycable
+    class Railtie < ::Rails::Railtie
+      rake_tasks do
+        path = File.expand_path(__dir__)
+        Dir.glob("#{path}/tasks/**/*.rake").each { |f| load f }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+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
+
+      redis = Anycable::PubSub.new.redis_conn
+      klass = GraphQL::Subscriptions::AnyCableSubscriptions
+
+      # 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)
+      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)
+      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)
+        end
+        redis.del(key)
+      end
+    end
+  end
+end

data/lib/graphql/anycable/version.rb

@@ -2,6 +2,6 @@
 
 module Graphql
   module Anycable
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/graphql/subscriptions/anycable_subscriptions.rb

@@ -53,6 +53,7 @@ module GraphQL
   class Subscriptions
     class AnyCableSubscriptions < GraphQL::Subscriptions
       SUBSCRIPTION_PREFIX = "graphql-subscription:"
+      SUBSCRIPTION_EVENTS_PREFIX = "graphql-subscription-events:"
       EVENT_PREFIX = "graphql-event:"
       CHANNEL_PREFIX = "graphql-channel:"
 
@@ -66,6 +67,7 @@ module GraphQL
       # Re-evaluate all subscribed queries and push the data over ActionCable.
       def execute_all(event, object)
         redis.smembers(EVENT_PREFIX + event.topic).each do |subscription_id|
+          next unless redis.exists(SUBSCRIPTION_PREFIX + subscription_id)
           execute(subscription_id, event, object)
         end
       end
@@ -90,15 +92,18 @@ module GraphQL
           variables: query.provided_variables.to_json,
           context: @serializer.dump(context.to_h),
           operation_name: query.operation_name,
-          events: events.map(&:topic).to_json,
         }
 
         redis.multi do
           redis.sadd(CHANNEL_PREFIX + channel.params["channelId"], subscription_id)
           redis.mapped_hmset(SUBSCRIPTION_PREFIX + subscription_id, data)
+          redis.sadd(SUBSCRIPTION_EVENTS_PREFIX + subscription_id, *events.map(&:topic))
           events.each do |event|
             redis.sadd(EVENT_PREFIX + event.topic, subscription_id)
           end
+          next unless config.subscription_expiration_seconds
+          redis.expire(CHANNEL_PREFIX + channel.params["channelId"], config.subscription_expiration_seconds)
+          redis.expire(SUBSCRIPTION_PREFIX + subscription_id, config.subscription_expiration_seconds)
         end
       end
 
@@ -116,11 +121,12 @@ module GraphQL
       # The channel was closed, forget about it.
       def delete_subscription(subscription_id)
         # Remove subscription ids from all events
-        events_data = redis.hget(SUBSCRIPTION_PREFIX + subscription_id, :events)
-        events_data && JSON.parse(events_data).each do |event_topic|
+        events = redis.smembers(SUBSCRIPTION_EVENTS_PREFIX + subscription_id)
+        events.each do |event_topic|
           redis.srem(EVENT_PREFIX + event_topic, subscription_id)
         end
         # Delete subscription itself
+        redis.del(SUBSCRIPTION_EVENTS_PREFIX + subscription_id)
         redis.del(SUBSCRIPTION_PREFIX + subscription_id)
       end
 
@@ -140,6 +146,10 @@ module GraphQL
       def redis
         @redis ||= anycable.redis_conn
       end
+
+      def config
+        @config ||= Graphql::Anycable::Config.new
+      end
     end
   end
 end

data/lib/graphql-anycable.rb

@@ -3,6 +3,8 @@
 require "graphql"
 
 require_relative "graphql/anycable/version"
+require_relative "graphql/anycable/config"
+require_relative "graphql/anycable/railtie" if defined?(Rails)
 require_relative "graphql/subscriptions/anycable_subscriptions"
 
 module Graphql

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-anycable
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrey Novikov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-25 00:00:00.000000000 Z
+date: 2018-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: anycable
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: anyway_config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: graphql
   requirement: !ruby/object:Gem::Requirement
@@ -112,8 +126,12 @@ files:
 - bin/console
 - bin/setup
 - graphql-anycable.gemspec
+- lib/Rakefile
 - lib/graphql-anycable.rb
 - lib/graphql/anycable.rb
+- lib/graphql/anycable/config.rb
+- lib/graphql/anycable/railtie.rb
+- lib/graphql/anycable/tasks/clean_expired_subscriptions.rake
 - lib/graphql/anycable/version.rb
 - lib/graphql/subscriptions/anycable_subscriptions.rb
 homepage: https://github.com/Envek/graphql-anycable