graphql-anycable 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '004247714780caa6cff73438d8cbb797c87aa7fd8136a302eb55ac0ce1ea8c69'
-  data.tar.gz: 121edfdd3dbe9c8fd2fc6ac943c5bd0516f11ff98ff3e1aca3168bba102ba07e
+  metadata.gz: 2a2206509c7d0e76ae86f48a40a2983f4519f71be6e7ce040be69ffebc899c91
+  data.tar.gz: 218a906bfa8bc0349870051252d49451d4f3f0fe2441c179f84082b88ddf0b21
 SHA512:
-  metadata.gz: b75a1491d23c2767ff6336db37613e54c056bbf8510b7ba08c7ccb988826ab28160d165a421821fb6e3da663d5341f4f86e40029c806658ac5941a897d19a326
-  data.tar.gz: 852bb3c618ad311b42be61254e54f178fd578a32c7ef52f5de309899cf010a58c22b2ddc445ff364f4af4bc3a890eede21458425e0436ebc5f141bdc7398d414
+  metadata.gz: f5bd487aceb0b69041d5e2a5357f3477917a88e50b7569cf4c21ce3def5cf1c812e28675769dcedd53905d14423b2ace1eb88352ded215cdaa56fa1f6f417f96
+  data.tar.gz: 8913553cb1eb8211cedb941d782df676b4821287684de6f2c0029738313aa2b502503b01f75b1f0faad7a5bc0927a2a7893efe407b65d88b7ec83581afd68b52

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,63 @@
+---
+name: Bug report
+about: Create a report to help us improve graphql-anycable
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**Versions**
+ruby:
+rails (or other framework):
+graphql:
+graphql-anycable:
+anycable:
+
+**GraphQL schema**
+Provide relevant details. Are you using [subscription classes](https://graphql-ruby.org/subscriptions/subscription_classes.html) or not (graphql-ruby behavior differs there)?
+
+```ruby
+class Product < GraphQL::Schema::Object
+  field :id, ID, null: false, hash_key: :id
+  field :title, String, null: true, hash_key: :title
+end
+
+class SubscriptionType < GraphQL::Schema::Object
+  field :product_created, Product, null: false
+  field :product_updated, Product, null: false
+
+  def product_created; end
+  def product_updated; end
+end
+
+class ApplicationSchema < GraphQL::Schema
+  subscription SubscriptionType
+end
+```
+
+**GraphQL query**
+
+How do you subscribe to subscriptions?
+
+```graphql
+subscription {
+  productCreated { id title }
+  productUpdated { id }
+}
+```
+
+**Steps to reproduce**
+Steps to reproduce the behavior
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Actual behavior**
+What specifically went wrong?
+
+**Additional context**
+Add any other context about the problem here. Tracebacks, your thoughts. anything that may be useful.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.travis.yml

@@ -10,6 +10,8 @@ rvm:
 gemfile:
   - gemfiles/graphql_1.9.gemfile
   - gemfiles/graphql_1.10.gemfile
+  - gemfiles/anycable_0.6.gemfile
+  - gemfiles/anycable_1.0.gemfile
 before_install: gem install bundler -v "~> 2.0"
 
 matrix:
@@ -17,3 +19,17 @@ matrix:
     # grpc gem isn't ready for ruby 2.7 yet: https://github.com/grpc/grpc/issues/21514
     # goole-protobuf gem isn't ready for ruby 2.7 yet: https://github.com/protocolbuffers/protobuf/issues/7070
     - rvm: 2.7.0
+    # Exclude new dependencies on old rubies to run less jobs
+    - rvm: 2.4.9
+      gemfile: gemfiles/anycable_1.0.gemfile
+    - rvm: 2.4.9
+      gemfile: gemfiles/graphql_1.10.gemfile
+    - rvm: 2.5.7
+      gemfile: gemfiles/anycable_1.0.gemfile
+    - rvm: 2.5.7
+      gemfile: gemfiles/graphql_1.10.gemfile
+    # Exclude old dependencies on new rubies to run less jobs
+    - rvm: 2.6.5
+      gemfile: gemfiles/anycable_0.6.gemfile
+    - rvm: 2.6.5
+      gemfile: gemfiles/graphql_1.9.gemfile

data/Appraisals

@@ -5,3 +5,11 @@ end
 appraise "graphql-1.10" do
   gem "graphql", "~> 1.10.0"
 end
+
+appraise "anycable-0.6" do
+  gem "anycable", "~> 0.6.0"
+end
+
+appraise "anycable-1.0" do
+  gem "anycable", "~> 1.0.0.preview1"
+end

data/CHANGELOG.md

@@ -0,0 +1,53 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## 0.4.0 - 2020-03-19
+
+### Added
+
+ - Ability to configure the gem via `configure` block, in addition to enironment variables and yaml files. [@gsamokovarov] ([#11](https://github.com/Envek/graphql-anycable/pull/11))
+ - Ability to run Redis cleaning operations outside of Rake. [@gsamokovarov] ([#11](https://github.com/Envek/graphql-anycable/pull/11))
+ - AnyCable 1.0 compatibility. [@bibendi], [@Envek] ([#10](https://github.com/Envek/graphql-anycable/pull/10))
+
+## 0.3.3 - 2020-03-03
+
+### Fixed
+
+ - Redis command error on subscription query with multiple fields. [@Envek] ([#9](https://github.com/Envek/graphql-anycable/issues/9))
+
+## 0.3.2 - 2020-03-02
+
+### Added
+
+ - Ability to skip some cleanup on restricted Redis instances (like Heroku). [@Envek] ([#8](https://github.com/Envek/graphql-anycable/issues/8))
+
+## 0.3.1 - 2019-06-13
+
+### Fixed
+
+ - Empty operation name handling. [@FX-HAO] ([#3](https://github.com/Envek/graphql-anycable/pull/3))
+
+## 0.3.0 - 2018-11-16
+
+### Added
+
+ - AnyCable 0.6 compatibility. [@Envek]
+
+## 0.2.0 - 2018-09-17
+
+### Added
+
+ - Subscription expiration and rake task for stale subscriptions cleanup. [@Envek]
+
+### 0.1.0 - 2018-08-26
+
+Initial version: store subscriptions on redis, re-execute queries in sync. [@Envek]
+
+[@gsamokovarov]: https://github.com/gsamokovarov "Genadi Samokovarov"
+[@bibendi]: https://github.com/bibendi "Misha Merkushin"
+[@FX-HAO]: https://github.com/FX-HAO "Fuxin Hao"
+[@Envek]: https://github.com/Envek "Andrey Novikov"

data/README.md

@@ -103,11 +103,41 @@ 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.
+ 1. Set `subscription_expiration_seconds` setting to number of seconds (e.g. `604800` for 1 week). See [configuration](#Configuration) section below for details.
 
  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).
+    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).
+
+## Configuration
+
+GraphQL-Anycable uses [anyway_config] to configure itself. There are several possibilities to configure this gem:
+
+ 1. Environment variables:
+
+    ```.env
+    GRAPHQL_ANYCABLE_SUBSCRIPTION_EXPIRATION_SECONDS=604800
+    GRAPHQL_ANYCABLE_USE_REDIS_OBJECT_ON_CLEANUP=true
+    ```
+
+ 2. YAML configuration files:
+
+    ```yaml
+    # config/graphql_anycable.yml
+    production:
+      subscription_expiration_seconds: 300 # 5 minutes
+      use_redis_object_on_cleanup: false # For restricted redis installations
+    ```
+
+ 3. Configuration from your application code:
+
+    ```ruby
+    GraphQL::Anycable.configure do |config|
+      config.subscription_expiration_seconds = 3600 # 1 hour
+    end
+    ```
+
+And any other way provided by [anyway_config]. Check its documentation!
 
 ## Development
 

data/gemfiles/anycable_0.6.gemfile

@@ -0,0 +1,14 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "anycable", "~> 0.6.0"
+
+group :development, :test do
+  gem "pry"
+  gem "pry-byebug", platform: :mri
+  gem "rubocop"
+  gem "rubocop-rspec"
+end
+
+gemspec path: "../"

data/gemfiles/anycable_1.0.gemfile

@@ -0,0 +1,14 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "anycable", "~> 1.0.0.preview1"
+
+group :development, :test do
+  gem "pry"
+  gem "pry-byebug", platform: :mri
+  gem "rubocop"
+  gem "rubocop-rspec"
+end
+
+gemspec path: "../"

data/lib/graphql-anycable.rb

@@ -3,6 +3,7 @@
 require "graphql"
 
 require_relative "graphql/anycable/version"
+require_relative "graphql/anycable/cleaner"
 require_relative "graphql/anycable/config"
 require_relative "graphql/anycable/railtie" if defined?(Rails)
 require_relative "graphql/subscriptions/anycable_subscriptions"
@@ -13,13 +14,21 @@ module GraphQL
 
     def redis
       @redis ||= begin
-        adapter = ::Anycable.broadcast_adapter
+        adapter = ::AnyCable.broadcast_adapter
         unless adapter.is_a?(::AnyCable::BroadcastAdapters::Redis)
           raise "Unsupported AnyCable adapter: #{adapter.class}. " \
                   "graphql-anycable works only with redis broadcast adapter."
         end
-        ::Anycable.broadcast_adapter.redis_conn
+        ::AnyCable.broadcast_adapter.redis_conn
       end
     end
+
+    def config
+      @config ||= GraphQL::Anycable::Config.new
+    end
+
+    def configure
+      yield(config) if block_given?
+    end
   end
 end

data/lib/graphql/anycable/cleaner.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module Anycable
+    module Cleaner
+      extend self
+
+      def clean
+        clean_channels
+        clean_subscriptions
+        clean_events
+      end
+
+      def clean_channels
+        return unless config.subscription_expiration_seconds
+        return unless config.use_redis_object_on_cleanup
+
+        redis.scan_each(match: "#{adapter::CHANNEL_PREFIX}*") do |key|
+          idle = redis.object("IDLETIME", key)
+          next if idle&.<= config.subscription_expiration_seconds
+
+          redis.del(key)
+        end
+      end
+
+      def clean_subscriptions
+        return unless config.subscription_expiration_seconds
+        return unless config.use_redis_object_on_cleanup
+
+        redis.scan_each(match: "#{adapter::SUBSCRIPTION_PREFIX}*") do |key|
+          idle = redis.object("IDLETIME", key)
+          next if idle&.<= config.subscription_expiration_seconds
+
+          redis.del(key)
+        end
+      end
+
+      def clean_events
+        redis.scan_each(match: "#{adapter::SUBSCRIPTION_EVENTS_PREFIX}*") do |key|
+          subscription_id = key.sub(/\A#{adapter::SUBSCRIPTION_EVENTS_PREFIX}/, "")
+          next if redis.exists(adapter::SUBSCRIPTION_PREFIX + subscription_id)
+
+          redis.smembers(key).each do |event_topic|
+            redis.srem(adapter::EVENT_PREFIX + event_topic, subscription_id)
+          end
+
+          redis.del(key)
+        end
+      end
+
+      private
+
+      def adapter
+        GraphQL::Subscriptions::AnyCableSubscriptions
+      end
+
+      def redis
+        GraphQL::Anycable.redis
+      end
+
+      def config
+        GraphQL::Anycable.config
+      end
+    end
+  end
+end

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

@@ -1,7 +1,7 @@
-require "graphql-anycable"
-
 # frozen_string_literal: true
 
+require "graphql-anycable"
+
 namespace :graphql do
   namespace :anycable do
     desc "Clean up stale graphql channels, subscriptions, and events from redis"
@@ -11,54 +11,20 @@ namespace :graphql do
     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.scan_each(match: "#{KLASS::CHANNEL_PREFIX}*") do |key|
-          idle = redis.object("IDLETIME", key)
-          next if idle&.<= config.subscription_expiration_seconds
-
-          redis.del(key)
-        end
+        GraphQL::Anycable::Cleaner.clean_channels
       end
 
       # 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
+        GraphQL::Anycable::Cleaner.clean_subscriptions
       end
 
       # 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
+        GraphQL::Anycable::Cleaner.clean_events
       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.3"
+    VERSION = "0.4.0"
   end
 end

data/lib/graphql/subscriptions/anycable_subscriptions.rb

@@ -54,7 +54,7 @@ module GraphQL
     class AnyCableSubscriptions < GraphQL::Subscriptions
       extend Forwardable
 
-      def_delegators :"GraphQL::Anycable", :redis
+      def_delegators :"GraphQL::Anycable", :redis, :config
 
       SUBSCRIPTION_PREFIX = "graphql-subscription:"
       SUBSCRIPTION_EVENTS_PREFIX = "graphql-subscription-events:"
@@ -79,7 +79,7 @@ module GraphQL
       # This subscription was re-evaluated.
       # Send it to the specific stream where this client was waiting.
       def deliver(subscription_id, result)
-        payload = { result: result.to_h, more: true }
+        payload = {result: result.to_h, more: true}
         anycable.broadcast(SUBSCRIPTION_PREFIX + subscription_id, payload.to_json)
       end
 
@@ -95,7 +95,7 @@ module GraphQL
           query_string: query.query_string,
           variables: query.provided_variables.to_json,
           context: @serializer.dump(context.to_h),
-          operation_name: query.operation_name,
+          operation_name: query.operation_name
         }
 
         redis.multi do
@@ -115,9 +115,9 @@ module GraphQL
       def read_subscription(subscription_id)
         redis.mapped_hmget(
           "#{SUBSCRIPTION_PREFIX}#{subscription_id}",
-          :query_string, :variables, :context, :operation_name,
+          :query_string, :variables, :context, :operation_name
         ).tap do |subscription|
-          subscription[:context]   = @serializer.load(subscription[:context])
+          subscription[:context] = @serializer.load(subscription[:context])
           subscription[:variables] = JSON.parse(subscription[:variables])
           subscription[:operation_name] = nil if subscription[:operation_name].strip == ""
         end
@@ -145,11 +145,7 @@ module GraphQL
       private
 
       def anycable
-        @anycable ||= ::Anycable.broadcast_adapter
-      end
-
-      def config
-        @config ||= GraphQL::Anycable::Config.new
+        @anycable ||= ::AnyCable.broadcast_adapter
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-anycable
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Andrey Novikov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-03 00:00:00.000000000 Z
+date: 2020-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: anycable
@@ -141,11 +141,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
 - Appraisals
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -153,12 +156,15 @@ files:
 - bin/console
 - bin/setup
 - gemfiles/.bundle/config
+- gemfiles/anycable_0.6.gemfile
+- gemfiles/anycable_1.0.gemfile
 - gemfiles/graphql_1.10.gemfile
 - gemfiles/graphql_1.9.gemfile
 - graphql-anycable.gemspec
 - lib/Rakefile
 - lib/graphql-anycable.rb
 - lib/graphql/anycable.rb
+- lib/graphql/anycable/cleaner.rb
 - lib/graphql/anycable/config.rb
 - lib/graphql/anycable/railtie.rb
 - lib/graphql/anycable/tasks/clean_expired_subscriptions.rake