graphql-fragment_cache 1.14.0 → 1.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44be1de2fded16cfd021afebe96ce647616225fdbe5de8b140099d2c1bb16f94
-  data.tar.gz: 94fb9a82b527c9786d81fed29e821416038c0b20a63f33fe765fc76abf0a9c24
+  metadata.gz: 3bcaf1bb938f830b5ae34b7b034e2ccbf8ce139e5da10db08e8ca52b658c0ed3
+  data.tar.gz: 5842f5166dc9cf69a276b3dee9836a43b757485ffe46f54031ce42341dfe797a
 SHA512:
-  metadata.gz: c10be9f09dcddd09f175452f86071330fe3cb72e9d5875169e20c000372a88ec44e9c9830154e5d2016af177e55852ccf3ae2594e5069e939be4ab0a43676a24
-  data.tar.gz: 5ded87b46c9757d28ac95028d16f2e2e71c3ed3d5252285898cc033dff835e61bff6aa7777633b8798eed6fb9dcecacf78d0e0623f1952f74139be8b66a9beee
+  metadata.gz: e218c2d46cb5cc545d0374c86c64f46380b82a4c31dd67d0dcb06890e23c4156ed16cef838d3965ae54283e28ea7ba155d965920dbc1c9a722a64fff7c174b69
+  data.tar.gz: caa35cd10a7c657b838088b0ffd449b981ee3565483691619af1c839a184febccacf19620c31bfee26f434929218e2ecd4478a6edbca7bf97ae3a68245bbe316

data/CHANGELOG.md

@@ -2,6 +2,17 @@
 
 ## master
 
+## 1.16.0 (2022-11-06)
+
+- [PR#42](https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache/pull/42) Raise helpful errors when write or write_multi fails  ([@DmitryTsepelev][])
+- [PR#86](https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache/pull/86) Support passing Procs to `cache_key:` ([@jeromedalbert][])
+- [PR#90](https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache/pull/90) Add option to disable the cache ([@jeromedalbert][])
+- [PR#89](https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache/pull/89) Use a "graphql" cache namespace by default ([@jeromedalbert][])
+
+## 1.15.0 (2022-10-27)
+
+- [PR#43](https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache/pull/43) Implement `skip_cache_when_query_has_errors` option to skip caching when query was resolved with errors ([@DmitryTsepelev][])
+
 ## 1.14.0 (2022-10-26)
 
 - [PR#85](https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache/pull/85) Support passing Symbols to `if:` and `unless:` ([@palkan][])

data/README.md

@@ -72,10 +72,10 @@ Cache keys consist of the following parts: namespace, implicit key, and explicit
 
 ### Cache namespace
 
-You can optionally define a namespace that will be prefixed to every cache key:
+The namespace is prefixed to every cached key. The default namespace is `graphql`, which is configurable:
 
 ```ruby
-GraphQL::FragmentCache.namespace = "my-prefix"
+GraphQL::FragmentCache.namespace = "graphql"
 ```
 
 ### Implicit cache key
@@ -237,6 +237,14 @@ def post(id:)
 end
 ```
 
+If you need more control, you can set `cache_key:` to any custom code:
+
+```ruby
+field :posts,
+  Types::Objects::PostType.connection_type,
+  cache_fragment: {cache_key: -> { object.posts.maximum(:created_at) }}
+```
+
 The way cache key part is generated for the passed argument is the following:
 
 - Use `object_cache_key: "some_cache_key"` if passed to `cache_fragment`
@@ -424,6 +432,24 @@ 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.
 
+## Execution errors and caching
+
+Sometimes errors happen during query resolving and it might make sense to skip caching for such queries (for instance, imagine a situation when client has no access to the requested field and the backend returns `{ data: {}, errors: ["you need a permission to fetch orders"] }`). This is how this behavior can be turned on (_it's off by default!_):
+
+```ruby
+GraphQL::FragmentCache.skip_cache_when_query_has_errors = true
+```
+
+As a result, caching will be skipped when `errors` array is not empty.
+
+## Disabling the cache
+
+Cache processing can be disabled if needed. For example:
+
+```ruby
+GraphQL::FragmentCache.enabled = false if Rails.env.test?
+```
+
 ## Limitations
 
 1. `Schema#execute`, [graphql-batch](https://github.com/Shopify/graphql-batch) and _graphql-ruby-fragment_cache_ do not [play well](https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache/issues/45) together. The problem appears when `cache_fragment` is _inside_ the `.then` block:

data/lib/graphql/fragment_cache/cacher.rb

@@ -4,6 +4,29 @@ module GraphQL
   module FragmentCache
     using Ext
 
+    class WriteError < StandardError
+      attr_reader :key, :value, :original_error
+
+      def initialize(original_error, key, value)
+        @original_error = original_error
+        @key = key
+        @value = value
+
+        super(original_error.message)
+      end
+    end
+
+    class WriteMultiError < StandardError
+      attr_reader :values, :original_error
+
+      def initialize(original_error, values)
+        @original_error = original_error
+        @values = values
+
+        super(original_error.message)
+      end
+    end
+
     # Saves resolved fragment values to cache store
     module Cacher
       class << self
@@ -22,13 +45,20 @@ module GraphQL
         def batched_persist(query)
           select_valid_fragments(query).group_by(&:options).each do |options, group|
             hash = group.map { |fragment| [fragment.cache_key, fragment.value] }.to_h
-            FragmentCache.cache_store.write_multi(hash, **options)
+
+            begin
+              FragmentCache.cache_store.write_multi(hash, **options)
+            rescue => e
+              raise WriteMultiError.new(e, hash)
+            end
           end
         end
 
         def persist(query)
           select_valid_fragments(query).each do |fragment|
             FragmentCache.cache_store.write(fragment.cache_key, fragment.value, **fragment.options)
+          rescue => e
+            raise WriteError.new(e, fragment.cache_key, fragment.value)
           end
         end
 

data/lib/graphql/fragment_cache/field_extension.rb

@@ -70,6 +70,8 @@ module GraphQL
           object.object
         elsif @cache_key == :value
           resolved_value = yield(object, arguments)
+        elsif @cache_key.is_a?(Proc)
+          object.instance_exec(&@cache_key)
         end
 
         cache_fragment_options = @cache_options.merge(object: object_for_key)

data/lib/graphql/fragment_cache/object_helpers.rb

@@ -25,6 +25,9 @@ module GraphQL
 
       def cache_fragment(object_to_cache = NO_OBJECT, **options, &block)
         raise ArgumentError, "Block or argument must be provided" unless block_given? || object_to_cache != NO_OBJECT
+        unless GraphQL::FragmentCache.enabled
+          return block_given? ? block.call : object_to_cache
+        end
 
         unless options.delete(:default_options_merged)
           options = GraphQL::FragmentCache.default_options.merge(options)

data/lib/graphql/fragment_cache/schema/instrumentation.rb

@@ -13,10 +13,15 @@ module GraphQL
         end
 
         def after_query(query)
-          return unless query.valid?
+          return if skip_caching?(query)
 
           Cacher.call(query)
         end
+
+        def skip_caching?(query)
+          !query.valid? ||
+            GraphQL::FragmentCache.skip_cache_when_query_has_errors? && query.context.errors.any?
+        end
       end
     end
   end

data/lib/graphql/fragment_cache/version.rb

@@ -2,6 +2,6 @@
 
 module GraphQL
   module FragmentCache
-    VERSION = "1.14.0"
+    VERSION = "1.16.0"
   end
 end

data/lib/graphql/fragment_cache.rb

@@ -22,9 +22,12 @@ module GraphQL
   module FragmentCache
     class << self
       attr_reader :cache_store
+      attr_accessor :enabled
       attr_accessor :namespace
       attr_accessor :default_options
 
+      attr_accessor :skip_cache_when_query_has_errors
+
       def use(schema_defn, options = {})
         verify_interpreter_and_analysis!(schema_defn)
 
@@ -52,6 +55,8 @@ module GraphQL
         @cache_store = store
       end
 
+      alias skip_cache_when_query_has_errors? skip_cache_when_query_has_errors
+
       def graphql_ruby_before_2_0?
         check_graphql_version "< 2.0.0"
       end
@@ -83,7 +88,10 @@ module GraphQL
     end
 
     self.cache_store = MemoryStore.new
+    self.enabled = true
+    self.namespace = "graphql"
     self.default_options = {}
+    self.skip_cache_when_query_has_errors = false
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-fragment_cache
 version: !ruby/object:Gem::Version
-  version: 1.14.0
+  version: 1.16.0
 platform: ruby
 authors:
 - DmitryTsepelev
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-26 00:00:00.000000000 Z
+date: 2022-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -220,7 +220,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
@@ -235,8 +235,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.2.33
+signing_key:
 specification_version: 4
 summary: Fragment cache for graphql-ruby
 test_files: []