graphql-result_cache 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba79fe918d359fba4d366fd3becfd4779860b3af1c4083c634578bba7258fbf9
-  data.tar.gz: 814addd76ffa4ccb92a4641d27c58d71d0359005eff4e1bc9145cd6d47cf2b0b
+  metadata.gz: a82a463a163e049de4904d6c8ccc2dcd434ba9f2d9b8cc290a607691b7444086
+  data.tar.gz: a1614159c06e2924a3a11c082bae2668da3acd315ddc881ed70d01a9889ef6a5
 SHA512:
-  metadata.gz: 7a8cb8d375f740c870acd94feaafded3d38e911acafa73573748ff63c49c9134e844488308a054ab601daafe56fa6af23a71bb9b7e4a68c7b3e27975d9a1a5f0
-  data.tar.gz: 59ca4da7a641b8c66f8de5452c647cf56301a37ce5a62e0b0de4a02165d90749f594c5ad6b139fef361f18e7a2dd63f0bb2b2e1eea13590d5a77a99bcdd0e3e5
+  metadata.gz: f5437965558d61fbb534ac2cef46c51b70f9a1ba08550dc3aece6b474bb3501b7fbcd53a386f999f5efbe776c0e41fb56bef632c3a5c238687bd516fb6503a46
+  data.tar.gz: bf03d88d2fa2a4fab03522f1b14321ddf35076ae3781a4e545c0f683d25b5d1c5d03f25364fa74deb2c350f5becb9ba0b1c4cabf452b9a602cbb41b93cee640d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    graphql-result_cache (0.1.0)
+    graphql-result_cache (0.1.2)
       graphql (~> 1.9)
 
 GEM

data/README.md

@@ -82,6 +82,18 @@ field :theme, Types::ThemeType, null: false, result_cache: { key: :theme_cache_k
 ```
 The `key` can be either a Symbol or a Proc.
 
+### Callback after cached result applied
+
+An `after_process` callback can be provided, eg. when some dynamic values need to be amended after cached result applied.
+
+```ruby
+field :theme, Types::ThemeType, null: false, result_cache: { after_process: :amend_dynamic_attributes }
+
+def amend_dynamic_attributes(theme_node)
+  theme_node.merge! used_count: object.theme.used_count
+end
+```
+
 ## Global Configuration
 
 `GraphQL::ResultCache` can be configured in initializer.
@@ -98,6 +110,18 @@ GraphQL::ResultCache.configure do |config|
 end
 ```
 
+When the query is an introspection, you can set the value to avoid getting the nullable type for a non-null type.
+```ruby
+class GraphqlController < ApplicationController
+  def execute
+    # ...
+    GraphQL::ResultCache.introspection = params[:query].include? '__schema'
+    result = MySchema.execute(params[:query], variables: ensure_hash(params[:variables]), context: context, operation_name: params[:operationName])  
+    render json: GraphQL::ResultCache::Result.new(result)
+  end
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/graphql/result_cache/callback.rb

@@ -0,0 +1,22 @@
+module GraphQL
+  module ResultCache
+    class Callback
+      def initialize obj:, args:, ctx:, value:
+        @obj = obj
+        @args = args
+        @ctx = ctx
+        @value = value
+      end
+
+      def call result_hash
+        case @value
+          when Symbol
+            @obj.public_send(@value, result_hash)
+          when Proc
+            @value.call(result_hash, @obj, @args, @ctx)
+        end
+        ::GraphQL::ResultCache.logger&.debug "GraphQL result cache callback called for #{@ctx.path.join('.')}"
+      end
+    end
+  end
+end

data/lib/graphql/result_cache/context_config.rb

@@ -8,11 +8,16 @@ module GraphQL
         @value = {}
       end
 
-      def add context:, key:
+      def add context:, key:, after_process: nil
         @value[context.query] ||= []
         cached = cache.exist? key
         logger&.info "GraphQL result cache key #{cached ? 'hit' : 'miss'}: #{key}"
-        @value[context.query] << { path: context.path, key: key, result: cached ? cache.read(key) : nil }
+        config_value = { path: context.path, key: key }
+        if cached
+          config_value[:result] = cache.read(key)
+          config_value[:after_process] = after_process if after_process
+        end
+        @value[context.query] << config_value
         cached
       end
 
@@ -37,7 +42,9 @@ module GraphQL
             cache.write config[:key], result.dig('data', *config[:path]), expires_in: expires_in
           else
             # result already got from cache, need to amend to response
-            deep_merge! result.to_h, 'data' => config[:path].reverse.inject(config[:result]) { |a, n| {n => a} }
+            result_hash = result.to_h
+            deep_merge! result_hash, 'data' => config[:path].reverse.inject(config[:result]) { |a, n| {n => a} }
+            config[:after_process]&.call(result_hash.dig('data', *config[:path]))
           end
         end
         result

data/lib/graphql/result_cache/field_instrument.rb

@@ -1,6 +1,7 @@
 require 'graphql/result_cache/condition'
 require 'graphql/result_cache/context_config'
 require 'graphql/result_cache/key'
+require 'graphql/result_cache/callback'
 
 module GraphQL
   module ResultCache
@@ -11,8 +12,7 @@ module GraphQL
         cached_resolve_proc = cached_resolve(field)
         field.redefine do
           resolve(cached_resolve_proc)
-          # for cacheable field, change type to be nullable
-          type(field.type.of_type) if field.type.non_null?
+          type(field.type.of_type) if !::GraphQL::ResultCache.introspection? && field.type.non_null?
         end
       end
 
@@ -26,7 +26,8 @@ module GraphQL
           if Condition.new(cache_config, obj: obj, args: args, ctx: ctx).true?
             ctx[:result_cache] ||= ContextConfig.new
             cache_key = Key.new(obj: obj, args: args, ctx: ctx, key: cache_config[:key])
-            cached = ctx[:result_cache].add context: ctx, key: cache_key.to_s
+            after_process = Callback.new(obj: obj, args: args, ctx: ctx, value: cache_config[:after_process]) if cache_config[:after_process]
+            cached = ctx[:result_cache].add context: ctx, key: cache_key.to_s, after_process: after_process
           end
           old_resolve_proc.call(obj, args, ctx) unless cached
         end

data/lib/graphql/result_cache/key.rb

@@ -21,7 +21,7 @@ module GraphQL
       private
 
       def path_clause
-        @ctx.path.join('/')
+        @ctx.path.join('.')
       end
 
       def args_clause

data/lib/graphql/result_cache/version.rb

@@ -1,5 +1,5 @@
 module GraphQL
   module ResultCache
-    VERSION = '0.1.1'
+    VERSION = '0.1.2'
   end
 end

data/lib/graphql/result_cache.rb

@@ -16,6 +16,9 @@ module GraphQL
       # c.client_hash = -> { Rails.cache.read(:deploy_version) }
       attr_accessor :client_hash
 
+      attr_accessor :introspection
+      alias introspection? introspection
+
       # ```
       # GraphQL::ResultCache.configure do |c|
       #   c.namespace = "GraphQL:Result"
@@ -31,6 +34,7 @@ module GraphQL
     # Default configuration
     @expires_in = 3600              # 1.hour
     @namespace = 'GraphQL:Result'
+    @introspection = false
 
     def self.use(schema_def, options: {})
       schema_def.instrument(:field, ::GraphQL::ResultCache::FieldInstrument.new)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-result_cache
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Ying Fu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-17 00:00:00.000000000 Z
+date: 2019-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -85,6 +85,7 @@ files:
 - bin/setup
 - graphql-result_cache.gemspec
 - lib/graphql/result_cache.rb
+- lib/graphql/result_cache/callback.rb
 - lib/graphql/result_cache/condition.rb
 - lib/graphql/result_cache/context_config.rb
 - lib/graphql/result_cache/field.rb