graphql-persisted_queries 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f36403d19c66dd6b6627c571cd87744b7da8a1d27f47bbf1f1dd5f32357ae4b1
-  data.tar.gz: 3f47b64e03c5bba2f498455e53aa136e20955ef7b4045a4088b0c19903ebde43
+  metadata.gz: 12531a6f0099e3220f5ea0bf400b1ccd23f2e6f3161d91d54c05ae404d3e1532
+  data.tar.gz: 4660b422f801db343ce2f8e04ea21576ae500d7d9519f87399300e957f555160
 SHA512:
-  metadata.gz: 50c222c3023ed556d6c3d46d49c2495e676c149fb8a887b623d76beb04b805dcb53bfb23dd1ed151675e7f2216282c99903b784161f13d7ff65de5837240fdc6
-  data.tar.gz: d9e359c4258a466bbd71fc8aa9873d0a100e878fba185b213e1305fc950c21ea75133e04104822a2f24f828ada9b4982e17f5ed4b068fdcfef055bc4098ac2b5
+  metadata.gz: c2d317723d55e67aebc607624e32e7052c53f378e8dd4584d161102167f5f44c221580518ab912a88db3e8b82381455ba77b20aefce5904602159c33bd23b88c
+  data.tar.gz: b831aeb69392cdd662fcf285cc8f48051feb3cd3703db862bd4434cfdbb67acd4b85cf70ae64cbcee61f7df969cbd913c152517af4a7da2b7121ae99fd0282a4

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## master
 
+## 0.4.0 (2020-02-26)
+
+- [PR#26](https://github.com/DmitryTsepelev/graphql-ruby-persisted_queries/pull/26) Add Memcached store ([@JanStevens][])
+
 ## 0.3.0 (2020-02-21)
 
 - [PR#24](https://github.com/DmitryTsepelev/graphql-ruby-persisted_queries/pull/24) Add multiplex support ([@DmitryTsepelev][])
@@ -30,3 +34,4 @@
 
 [@DmitryTsepelev]: https://github.com/DmitryTsepelev
 [@bmorton]: https://github.com/bmorton
+[@JanStevens]: https://github.com/JanStevens

data/README.md

@@ -59,11 +59,12 @@ GraphqlSchema.execute(
 
 ## Usage with BatchLink
 
-It's possible to group queries using [batch-link](https://www.apollographql.com/docs/link/links/batch-http/) and send them as a single HTTP request. In this case you need to use `GraphqlSchema.multiplex(queries)` instead of `#execute`. The gem supports it too, no action required!
+It's possible to group queries using [batch-link](https://www.apollographql.com/docs/link/links/batch-http/) and send them as a single HTTP request. 
+In this case you need to use `GraphqlSchema.multiplex(queries)` instead of `#execute`. The gem supports it too, no action required!
 
 ## Alternative stores
 
-All the queries are stored in memory by default, but you can easily switch to _redis_:
+All the queries are stored in memory by default, but you can easily switch to _redis_ or _memcached_:
 
 ```ruby
 class GraphqlSchema < GraphQL::Schema
@@ -71,7 +72,10 @@ class GraphqlSchema < GraphQL::Schema
 end
 ```
 
-If you have `ENV["REDIS_URL"]` configured – you don't need to pass it explicitly. Also, you can pass `:redis_host`, `:redis_port` and `:redis_db_name` inside the `:redis_client` hash to build the URL from scratch or pass the configured `Redis` or `ConnectionPool` object:
+### Redis
+
+If you have `ENV["REDIS_URL"]` configured – you don't need to pass it explicitly. Also, you can pass `:redis_host`, `:redis_port` and `:redis_db_name` 
+inside the `:redis_client` hash to build the URL from scratch or pass the configured `Redis` or `ConnectionPool` object:
 
 ```ruby
 class GraphqlSchema < GraphQL::Schema
@@ -101,6 +105,45 @@ class GraphqlSchema < GraphQL::Schema
 end
 ```
 
+### Memcached
+
+If you have `ENV["MEMCACHE_SERVERS"]` configured - you don't need to pass it explicitly. Also, you can pass `:memcached_host` and `:memcached_port` 
+inside the `:dalli_client` hash to build the server name from scratch or pass the configured `Dalli::Client` object:
+
+```ruby
+class GraphqlSchema < GraphQL::Schema
+  use GraphQL::PersistedQueries,
+      store: :memcached,
+      dalli_client: { memcached_host: "127.0.0.2", memcached_port: "11211" }
+  # or
+  use GraphQL::PersistedQueries,
+      store: :memcached,
+      dalli_client: Dalli::Client.new("127.0.0.2:11211")
+  # or
+  use GraphQL::PersistedQueries,
+      store: :memcached,
+      dalli_client: { memcached_url: "127.0.0.2:11211" }
+end
+```
+
+You can also pass options for `expiration` and `namespace` to override the defaults. 
+Any additional argument inside `dalli_client` will be forwarded to `Dalli::Client.new`. 
+Following example configures Dalli `pool_size` and `compress` options:
+
+```ruby
+class GraphqlSchema < GraphQL::Schema
+  use GraphQL::PersistedQueries,
+      store: :memcached,
+      dalli_client: { 
+        memcached_url: "127.0.0.2:11211", 
+        pool_size: 5,
+        compress: true
+      },
+      expiration: 172800, # optional, default is 24 hours
+      namespace: "my-custom-namespace" # optional, default is "graphql-persisted-query"
+end
+```
+
 ### Supported stores
 
 We currently support a few different stores that can be configured out of the box:
@@ -108,6 +151,7 @@ We currently support a few different stores that can be configured out of the bo
 - `:memory`: This is the default in-memory store and is great for getting started, but will require each instance to cache results independently which can result in lots of ["new query path"](https://blog.apollographql.com/improve-graphql-performance-with-automatic-persisted-queries-c31d27b8e6ea) requests.
 - `:redis`: This store will allow you to share a Redis cache across all instances of your GraphQL application so that each instance doesn't have to ask the client for the query again if it hasn't seen it yet.
 - `:redis_with_local_cache`: This store combines both the `:memory` and `:redis` approaches so that we can reduce the number of network requests we make while mitigating the independent cache issue.  This adapter is configured identically to the `:redis` store.
+- `:memcached`: This store will allow you to share a Memcached cache across all instances of your GraphQL application. The client is implemented with the Dalli gem.
 
 ## Alternative hash functions
 

data/graphql-persisted_queries.gemspec

@@ -28,5 +28,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", ">= 10.0"
   spec.add_development_dependency "rubocop", "0.75"
   spec.add_development_dependency "redis"
+  spec.add_development_dependency "dalli"
   spec.add_development_dependency "connection_pool"
 end

data/lib/graphql/persisted_queries/store_adapters.rb

@@ -4,6 +4,7 @@ require "graphql/persisted_queries/store_adapters/base_store_adapter"
 require "graphql/persisted_queries/store_adapters/memory_store_adapter"
 require "graphql/persisted_queries/store_adapters/redis_store_adapter"
 require "graphql/persisted_queries/store_adapters/redis_with_local_cache_store_adapter"
+require "graphql/persisted_queries/store_adapters/memcached_store_adapter"
 
 module GraphQL
   module PersistedQueries

data/lib/graphql/persisted_queries/store_adapters/memcached_client_builder.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module PersistedQueries
+    module StoreAdapters
+      # Builds Redis object instance based on passed hash
+      class MemcachedClientBuilder
+        def initialize(memcached_url: nil, memcached_host: nil, memcached_port: nil, **dalli_args)
+          require "dalli"
+
+          @memcached_url = memcached_url
+          @memcached_host = memcached_host
+          @memcached_port = memcached_port
+          @dalli_args = dalli_args
+        rescue LoadError => e
+          msg = "Could not load the 'dalli' gem, please add it to your gemfile or " \
+                "configure a different adapter, e.g. use GraphQL::PersistedQueries, store: :memory"
+          raise e.class, msg, e.backtrace
+        end
+
+        def build
+          if @memcached_url && (@memcached_host || @memcached_port)
+            raise ArgumentError, "memcached_url cannot be passed along with memcached_host or " \
+                                 "memcached_port options"
+          end
+
+          ::Dalli::Client.new(@memcached_url || build_memcached_url, **@dalli_args)
+        end
+
+        private
+
+        def build_memcached_url
+          "#{@memcached_host}:#{@memcached_port}"
+        end
+      end
+    end
+  end
+end

data/lib/graphql/persisted_queries/store_adapters/memcached_store_adapter.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "graphql/persisted_queries/store_adapters/memcached_client_builder"
+
+module GraphQL
+  module PersistedQueries
+    module StoreAdapters
+      # Redis adapter for storing persisted queries
+      class MemcachedStoreAdapter < BaseStoreAdapter
+        DEFAULT_EXPIRATION = 24 * 60 * 60
+        DEFAULT_NAMESPACE = "graphql-persisted-query"
+
+        def initialize(dalli_client:, expiration: nil, namespace: nil)
+          @dalli_proc = build_dalli_proc(dalli_client)
+          @expiration = expiration || DEFAULT_EXPIRATION
+          @namespace = namespace || DEFAULT_NAMESPACE
+        end
+
+        def fetch_query(hash)
+          @dalli_proc.call { |dalli| dalli.get(key_for(hash)) }
+        end
+
+        def save_query(hash, query)
+          @dalli_proc.call { |dalli| dalli.set(key_for(hash), query, @expiration) }
+        end
+
+        private
+
+        def key_for(hash)
+          "#{@namespace}:#{hash}"
+        end
+
+        def build_dalli_proc(dalli_client)
+          if dalli_client.is_a?(Hash)
+            build_dalli_proc(MemcachedClientBuilder.new(dalli_client).build)
+          elsif dalli_client.is_a?(Proc)
+            dalli_client
+          elsif defined?(::Dalli::Client) && dalli_client.is_a?(::Dalli::Client)
+            proc { |&b| b.call(dalli_client) }
+          else
+            raise ArgumentError, ":dalli_client accepts Dalli::Client, Hash or Proc only"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/graphql/persisted_queries/version.rb

@@ -2,6 +2,6 @@
 
 module GraphQL
   module PersistedQueries
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-persisted_queries
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - DmitryTsepelev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-21 00:00:00.000000000 Z
+date: 2020-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: dalli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: connection_pool
   requirement: !ruby/object:Gem::Requirement
@@ -128,6 +142,8 @@ files:
 - lib/graphql/persisted_queries/schema_patch.rb
 - lib/graphql/persisted_queries/store_adapters.rb
 - lib/graphql/persisted_queries/store_adapters/base_store_adapter.rb
+- lib/graphql/persisted_queries/store_adapters/memcached_client_builder.rb
+- lib/graphql/persisted_queries/store_adapters/memcached_store_adapter.rb
 - lib/graphql/persisted_queries/store_adapters/memory_store_adapter.rb
 - lib/graphql/persisted_queries/store_adapters/redis_client_builder.rb
 - lib/graphql/persisted_queries/store_adapters/redis_store_adapter.rb