graphql-fragment_cache 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8454e3e398cc31081e2b17fb4a9b9e971cfbd1da05bce06149e419bb0e6b6b36
-  data.tar.gz: f654d30606764307daad38b45921533edba92fa2cd95a75556488985bd78a590
+  metadata.gz: dab2cb1f4c27251da27c938bd8a0392f3ad0edcb5c54ba1d7d83d9e2f9c4b12b
+  data.tar.gz: 8e5323ed6bf476d185c993b8165e292d4d7e70df56fa1ae1ad32da2ae7bc0880
 SHA512:
-  metadata.gz: 3a573a48cfe5b5d1beebd665c09b8adc4fe7d7a4bb08b29cc923c2434d921c0e9eb2c46b317d4d44367e46d0afafd2a686a0186cfb68f50459eaad2707f3da72
-  data.tar.gz: 2db445bfbf4ef1cd56d715e586a6c0b748695e022ac55d94bc8bd52171221902fa562426c8a53cadb2e7d0ee7667dd866f27106fb3901247932e1b1a2e3320b6
+  metadata.gz: 90eebb6973db225980926d330d93ca70a50768279bb727cf702f1bd905628cf7969e1af5025a6fefb1f9785d1fc008fd560d236fbe6315821a6dd2f92243ef56
+  data.tar.gz: b26090f37a4b20ce45a256880b708c17a77871d8e8f5d95c1b34f171062306332f1bf9a549ab92bce5a326a2327d5b8a4f8106e2b2b4ac338bbd257cec8e6a21

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## master
 
+## 1.4.0 (2020-12-03)
+
+- [PR#41](https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache/pull/41) Add `keep_in_context` option ([@DmitryTsepelev][])
+
 ## 1.3.0 (2020-11-25)
 
 - [PR#39](https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache/pull/39) Implement `path_cache_key` option ([@DmitryTsepelev][])

data/README.md

@@ -314,6 +314,24 @@ 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.
 
+## In–memory fragments
+
+If you have a fragment that accessed from multiple times (e.g., if you have a list of items that belong to the same owner, and owner is cached), you can avoid multiple cache reads by using `:keep_in_context` option:
+
+```ruby
+class QueryType < BaseObject
+  field :post, PostType, null: true do
+    argument :id, ID, required: true
+  end
+
+  def post(id:)
+    cache_fragment(keep_in_context: true, expires_in: 5.minutes) { Post.find(id) }
+  end
+end
+```
+
+This can reduce a number of cache calls but _increase_ memory usage, because the value returned from cache will be kept in the GraphQL context until the query is fully resolved.
+
 ## 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/ext/context_fragments.rb

@@ -13,6 +13,10 @@ module GraphQL
         def fragments
           namespace(:fragment_cache)[:fragments] ||= []
         end
+
+        def loaded_fragments
+          namespace(:fragment_cache)[:loaded] ||= {}
+        end
       end
     end
   end

data/lib/graphql/fragment_cache/field_extension.rb

@@ -49,7 +49,7 @@ module GraphQL
 
         cache_fragment_options = @cache_options.merge(object: object_for_key)
 
-        object.cache_fragment(cache_fragment_options) do
+        object.cache_fragment(**cache_fragment_options) do
           resolved_value == NOT_RESOLVED ? yield(object, arguments) : resolved_value
         end
       end

data/lib/graphql/fragment_cache/fragment.rb

@@ -4,6 +4,8 @@ require "graphql/fragment_cache/cache_key_builder"
 
 module GraphQL
   module FragmentCache
+    using Ext
+
     # Represents a single fragment to cache
     class Fragment
       attr_reader :options, :path, :context
@@ -16,10 +18,10 @@ module GraphQL
 
       NIL_IN_CACHE = Object.new
 
-      def read
-        FragmentCache.cache_store.read(cache_key).tap do |cached|
-          return NIL_IN_CACHE if cached.nil? && FragmentCache.cache_store.exist?(cache_key)
-        end
+      def read(keep_in_context = false)
+        return read_from_context { value_from_cache } if keep_in_context
+
+        value_from_cache
       end
 
       def cache_key
@@ -32,6 +34,20 @@ module GraphQL
 
       private
 
+      def read_from_context
+        if (loaded_value = context.loaded_fragments[cache_key])
+          return loaded_value
+        end
+
+        yield.tap { |value| context.loaded_fragments[cache_key] = value }
+      end
+
+      def value_from_cache
+        FragmentCache.cache_store.read(cache_key).tap do |cached|
+          return NIL_IN_CACHE if cached.nil? && FragmentCache.cache_store.exist?(cache_key)
+        end
+      end
+
       def interpreter_context
         context.namespace(:interpreter)
       end

data/lib/graphql/fragment_cache/object_helpers.rb

@@ -27,9 +27,10 @@ module GraphQL
         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)
+        fragment = Fragment.new(context_to_use, **options)
 
-        if (cached = fragment.read)
+        keep_in_context = options.delete(:keep_in_context)
+        if (cached = fragment.read(keep_in_context))
           return cached == Fragment::NIL_IN_CACHE ? nil : raw_value(cached)
         end
 

data/lib/graphql/fragment_cache/version.rb

@@ -2,6 +2,6 @@
 
 module GraphQL
   module FragmentCache
-    VERSION = "1.3.0"
+    VERSION = "1.4.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-fragment_cache
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - DmitryTsepelev
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-25 00:00:00.000000000 Z
+date: 2020-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -190,7 +190,7 @@ metadata:
   homepage_uri: https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache
   source_code_uri: https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache
   changelog_uri: https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -205,8 +205,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Fragment cache for graphql-ruby
 test_files: []