graphql-fragment_cache 1.14.0 → 1.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44be1de2fded16cfd021afebe96ce647616225fdbe5de8b140099d2c1bb16f94
-  data.tar.gz: 94fb9a82b527c9786d81fed29e821416038c0b20a63f33fe765fc76abf0a9c24
+  metadata.gz: ba042028d0f9a6b8baebcfd86fcfddf9eb571014967498e1f0f609ad6445da18
+  data.tar.gz: ccf1d4764c9178faceac2ef63dbeb30ba7b1a303dbfc5e299289be3ec56a9ddd
 SHA512:
-  metadata.gz: c10be9f09dcddd09f175452f86071330fe3cb72e9d5875169e20c000372a88ec44e9c9830154e5d2016af177e55852ccf3ae2594e5069e939be4ab0a43676a24
-  data.tar.gz: 5ded87b46c9757d28ac95028d16f2e2e71c3ed3d5252285898cc033dff835e61bff6aa7777633b8798eed6fb9dcecacf78d0e0623f1952f74139be8b66a9beee
+  metadata.gz: 6025cf472c24989b66d47b3d7c79d6d5a5bdb8e71540c0e7c0ca7bc2bd2baf5b438206e978d1d4d5bbdd975e793e675d5370364ece2f8ca223aa4eabed263c9e
+  data.tar.gz: 80e93356549005e70a9e3e66a6d87716aebcfc3a3b540e91ffb935d4fb18533df56164664a78c9371c69d07197e92be3aabfd54916428b94cdd19b7952e0d18a

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## master
 
+## 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

@@ -424,6 +424,16 @@ 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.
+
 ## 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/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.15.0"
   end
 end

data/lib/graphql/fragment_cache.rb

@@ -25,6 +25,8 @@ module GraphQL
       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 +54,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
@@ -84,6 +88,7 @@ module GraphQL
 
     self.cache_store = MemoryStore.new
     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.15.0
 platform: ruby
 authors:
 - DmitryTsepelev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-26 00:00:00.000000000 Z
+date: 2022-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql