graphql-fragment_cache 1.0.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12ad57aeb345c05f3025f6cc232ec06b16afc603d4330451682f526c6516db71
-  data.tar.gz: e486c3090b73fbe3f372cf1a7557c9df9753c3ddcddd720d97d02f3294625dbe
+  metadata.gz: b8dcfa21629a163b02f1097275602c294eb6e6cad5be237a11f5567c3fedce8c
+  data.tar.gz: 812fde3ac50fcb43ebb5e00c8291817c876a9bb0c7ccaa5544319dd01fb7a143
 SHA512:
-  metadata.gz: d4a05c0bdc3aae4783cf6d0417feb70e3b56fe31f1c80a16fcf8b6cb9bf6da21e882be7a3458defc8d28fe8797f204852193356fe951891b3861bae88cbaed47
-  data.tar.gz: cdd254f8c323d82c63a9c15bd4c767ca96feee841c4a1f7f5a9059eb0fc166ef52878a68e2170239dd8e0d3b152646d111800ad08beedadeb4080fc2f542a694
+  metadata.gz: da34c5a7e12669352a0a095338bd52895414a49628d758cf0df6d698fc342f6b94032fdce6bf8df70b866ea6ddf2a5d6666ab7dd7b70050ab0b058448b8dcfca
+  data.tar.gz: 937fa344650d90187acc5985c86b4f3320ed276a03aaf02531484596e1a0b20b09cc2fdb2d4596c8150d3992fdef9c48085623ff1030e16135da7f019b255e46

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## master
 
+## 1.1.0 (2020-10-26)
+
+- [PR#38](https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache/pull/38) Support caching from other places than field or resolver  ([@DmitryTsepelev][])
+
 ## 1.0.5 (2020-10-13)
 
 - [PR#35](https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache/pull/35) Prefer using `#write_multi` on cache store when possible ([@DmitryTsepelev][])

data/README.md

@@ -38,6 +38,14 @@ class BaseType < GraphQL::Schema::Object
 end
 ```
 
+If you're using [resolvers](https://graphql-ruby.org/fields/resolvers.html) — include the module into the base resolver as well:
+
+```ruby
+class Resolvers::BaseResolver < GraphQL::Schema::Resolver
+  include GraphQL::FragmentCache::ObjectHelpers
+end
+```
+
 Now you can add `cache_fragment:` option to your fields to turn caching on:
 
 ```ruby
@@ -47,7 +55,7 @@ class PostType < BaseObject
 end
 ```
 
-Alternatively, you can use `cache_fragment` method inside resolvers:
+Alternatively, you can use `cache_fragment` method inside resolver methods:
 
 ```ruby
 class QueryType < BaseObject
@@ -275,6 +283,35 @@ class QueryType < BaseObject
 end
 ```
 
+## How to use `#cache_fragment` in extensions (and other places where context is not available)
+
+If you want to call `#cache_fragment` from places other that fields or resolvers, you'll need to pass `context` explicitly and turn on `raw_value` support. For instance, let's take a look at this extension:
+
+```ruby
+class Types::QueryType < Types::BaseObject
+  class CurrentMomentExtension < GraphQL::Schema::FieldExtension
+    # turning on cache_fragment support
+    include GraphQL::FragmentCache::ObjectHelpers
+
+    def resolve(object:, arguments:, context:)
+      # context is passed explicitly
+      cache_fragment(context: context) do
+        result = yield(object, arguments)
+        "#{result} (at #{Time.now})"
+      end
+    end
+  end
+
+  field :event, String, null: false, extensions: [CurrentMomentExtension]
+
+  def event
+    "something happened"
+  end
+end
+```
+
+With this approach you can use `#cache_fragment` in any place you have an access to the `context`. When context is not available, the error `cannot find context, please pass it explicitly` will be thrown.
+
 ## Limitations
 
 Caching does not work for Union types, because of the `Lookahead` implementation: it requires the exact type to be passed to the `selection` method (you can find the [discussion](https://github.com/rmosolgo/graphql-ruby/pull/3007) here). This method is used for cache key building, and I haven't found a workaround yet ([PR in progress](https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache/pull/30)). If you get `Failed to look ahead the field` error — please pass `query_cache_key` explicitly:

data/lib/graphql/fragment_cache/object_helpers.rb

@@ -10,6 +10,12 @@ module GraphQL
     module ObjectHelpers
       extend Forwardable
 
+      def self.included(base)
+        return if base < GraphQL::Execution::Interpreter::HandlesRawValue
+
+        base.include(GraphQL::Execution::Interpreter::HandlesRawValue)
+      end
+
       NO_OBJECT = Object.new
 
       def cache_fragment(object_to_cache = NO_OBJECT, **options, &block)
@@ -17,14 +23,18 @@ module GraphQL
 
         options[:object] = object_to_cache if object_to_cache != NO_OBJECT
 
-        fragment = Fragment.new(context, options)
+        context_to_use = options.delete(:context)
+        context_to_use = context if context_to_use.nil? && respond_to?(:context)
+        raise ArgumentError, "cannot find context, please pass it explicitly" unless context_to_use
+
+        fragment = Fragment.new(context_to_use, options)
 
         if (cached = fragment.read)
           return cached == Fragment::NIL_IN_CACHE ? nil : raw_value(cached)
         end
 
         (block_given? ? block.call : object_to_cache).tap do |resolved_value|
-          context.fragments << fragment
+          context_to_use.fragments << fragment
         end
       end
     end

data/lib/graphql/fragment_cache/version.rb

@@ -2,6 +2,6 @@
 
 module GraphQL
   module FragmentCache
-    VERSION = "1.0.5"
+    VERSION = "1.1.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-fragment_cache
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.0
 platform: ruby
 authors:
 - DmitryTsepelev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-13 00:00:00.000000000 Z
+date: 2020-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql