graphql-cache 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb2192273e278a5586abc0e640ef6057f28e072f38b46740a5e0ebf6364f7be1
-  data.tar.gz: 59d4fd50a85cbc58a6109373f4fb4dca69aa54548960e7be62af5cb98b4cf6cd
+  metadata.gz: 90827abbbae2111c06ea2a0afc7f9daea103098064949eba4bbd84cd791c2fdb
+  data.tar.gz: 2efebce54277a3fef786d189b9c9bcb9a46dfa22c412a9b51f29f6652e3031c6
 SHA512:
-  metadata.gz: 06c5fe310bf069f2017be61070b3eb809edf006473ef0f4c3e9eb27fda37278cb683a95cffceef3bd74fade59a9b76560bb7234bdfc09adc788b734667ebd110
-  data.tar.gz: dd2f2eed8a84be514eb760a98c62040f2854cc1d98c6ccb4790fe314d50b0ea75015b1ef0600e0239b080701619b0ed5496b6f305847855f2fadfa91adf4c943
+  metadata.gz: d85a82ed4c3dae977475ad723fd6a2c61c676f3e887db196ef1aaa5100c81c2a54a5fc3874ae427baa023a2d00b8e9446a16536cef656c7c7c623b670118032a
+  data.tar.gz: b0abbd392cc526d552dc5a1296187f053e1a1d66d6f7127eb779602bdbb74b9dec6848308e6d6d94bb199ef94a8b4071def6126a262d6e90b8c8048a3a124a67

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    graphql-cache (0.2.5)
+    graphql-cache (0.4.0)
       graphql (~> 1.8.0)
 
 GEM
@@ -16,7 +16,7 @@ GEM
     coderay (1.1.2)
     diff-lcs (1.3)
     docile (1.3.0)
-    graphql (1.8.4)
+    graphql (1.8.6)
     json (2.1.0)
     method_source (0.9.0)
     mini_cache (1.1.0)
@@ -63,4 +63,4 @@ DEPENDENCIES
   sqlite3
 
 BUNDLED WITH
-   1.16.2
+   1.16.3

data/README.md

@@ -3,7 +3,7 @@
 # GraphQL Cache
 [![Gem Version](https://badge.fury.io/rb/graphql-cache.svg)](https://badge.fury.io/rb/graphql-cache) [![Build Status](https://travis-ci.org/stackshareio/graphql-cache.svg?branch=master)](https://travis-ci.org/stackshareio/graphql-cache) [![Test Coverage](https://api.codeclimate.com/v1/badges/524c0f23ed1dbf0f9338/test_coverage)](https://codeclimate.com/github/stackshareio/graphql-cache/test_coverage) [![Maintainability](https://api.codeclimate.com/v1/badges/524c0f23ed1dbf0f9338/maintainability)](https://codeclimate.com/github/stackshareio/graphql-cache/maintainability)
 
-A custom middleware for [graphql-ruby](https://github.com/rmosolgo/graphql-ruby)
+A custom caching plugin for [graphql-ruby](https://github.com/rmosolgo/graphql-ruby)
 
 ## Goals
 
@@ -79,17 +79,33 @@ Any object, list, or connection field can be cached by simply adding `cache: tru
 field :calculated_field, Int, cache: true
 ```
 
+### Custom Expirations
+
 By default all keys will have an expiration of `GraphQL::Cache.expiry` which defaults to 90 minutes.  If you want to set a field-specific expiration time pass a hash to the `cache` parameter like this:
 
 ```ruby
 field :calculated_field, Int, cache: { expiry: 10800 } # expires key after 180 minutes
 ```
 
-When passing a hash in the `cache` parameter the possible options are:
+### Custom cache keys
+
+GraphQL Cache generates a cache key using the context of a query during execution. A custom key can be included to implement versioned caching as well. By providing a `:key` value to the cache config hash on a field definition.  For example, to use a custom method that returns the cache key for an object use:
+
+```ruby
+field :calculated_field, Int, cache: { key: :custom_cache_key }
+```
+
+With this configuration the cache key used for this resolved value will use the result of the method `custom_cache_key` called on the parent object.
+
+### Forcing the cache
+
+It is possible to force graphql-cache to resolve and write all cached fields to cache regardless of the presence of a given key in the cache store.  This will effectively "renew" any existing cached expirations and warm any that don't exist. To use forced caching, add a value to `:force_cache` in the query context:
+
+```ruby
+MySchema.execute('{ company(id: 123) { cachedField }}', context: { force_cache: true })
+```
 
-- `expiry`: expiration time for this field's key in seconds (default: 5400)
-- `force`: for cache misses on this field (default: false)
-- `prefix`: cache key prefix (appended after GraphQL::Cache.namespace)
+This will resolve all cached fields using the field's resolver and write them to cache without first reading the value at their respective cache keys.  This is useful for structured cache warming strategies where the cache expiration needs to be updated when a warming query is made.
 
 ## Development
 

data/lib/graphql/cache.rb

@@ -17,10 +17,6 @@ module GraphQL
       # @return [Integer] Default: 5400 (90 minutes)
       attr_accessor :expiry
 
-      # When truthy, override all caching (force evalutaion of resolvers)
-      # @return [Boolean] Default: false
-      attr_accessor :force
-
       # Logger instance to use when logging cache hits/misses.
       # @return [Logger]
       attr_accessor :logger
@@ -43,7 +39,6 @@ module GraphQL
 
     # Default configuration
     @expiry    = 5400
-    @force     = false
     @namespace = 'graphql'
 
     # Called by plugin framework in graphql-ruby to

data/lib/graphql/cache/fetcher.rb

@@ -2,28 +2,31 @@ module GraphQL
   module Cache
     class Fetcher
       def instrument(type, field)
-        old_resolve_proc = field.resolve_proc
+        return field unless field.metadata[:cache]
 
-        new_resolve_proc = lambda do |obj, args, ctx|
-          unless field.metadata[:cache]
-            return old_resolve_proc.call(obj, args, ctx)
-          end
-
-          key = cache_key(obj, args, type, field)
-
-          Marshal[key].read(field.metadata[:cache]) do
-            old_resolve_proc.call(obj, args, ctx)
-          end
-        end
+        cached_resolve_proc = cached_resolve(type, field)
 
         # Return a copy of `field`, with the new resolve proc
-        field.redefine { resolve(new_resolve_proc) }
+        field.redefine { resolve(cached_resolve_proc) }
       end
 
       # @private
       def cache_key(obj, args, type, field)
         Key.new(obj, args, type, field).to_s
       end
+
+      # @private
+      def cached_resolve(type, field)
+        old_resolve_proc = field.resolve_proc
+
+        lambda do |obj, args, ctx|
+          key = cache_key(obj, args, type, field)
+
+          Marshal[key].read(field.metadata[:cache], force: ctx[:force_cache]) do
+            old_resolve_proc.call(obj, args, ctx)
+          end
+        end
+      end
     end
   end
 end

data/lib/graphql/cache/marshal.rb

@@ -29,7 +29,10 @@ module GraphQL
       #
       # @param config [Hash] The object passed to `cache:` on the field definition
       # @return [Object]
-      def read(config, &block)
+      def read(config, force: false, &block)
+        # write new data from resolver if forced
+        return write(config, &block) if force
+
         cached = cache.read(key)
 
         if cached.nil?

data/lib/graphql/cache/version.rb

@@ -2,6 +2,6 @@
 
 module GraphQL
   module Cache
-    VERSION = '0.3.0'
+    VERSION = '0.4.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-cache
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Michael Kelly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-27 00:00:00.000000000 Z
+date: 2018-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal