graphql-fragment_cache 1.15.0 → 1.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba042028d0f9a6b8baebcfd86fcfddf9eb571014967498e1f0f609ad6445da18
-  data.tar.gz: ccf1d4764c9178faceac2ef63dbeb30ba7b1a303dbfc5e299289be3ec56a9ddd
+  metadata.gz: e2c544bc2742643748c5e36c59b3414def73c22e6f7c4b5080504751ea564ecd
+  data.tar.gz: b61980525863502ea4f30eeb96fee11dbc11a906ab98b863ed0ece7f9d97d1e9
 SHA512:
-  metadata.gz: 6025cf472c24989b66d47b3d7c79d6d5a5bdb8e71540c0e7c0ca7bc2bd2baf5b438206e978d1d4d5bbdd975e793e675d5370364ece2f8ca223aa4eabed263c9e
-  data.tar.gz: 80e93356549005e70a9e3e66a6d87716aebcfc3a3b540e91ffb935d4fb18533df56164664a78c9371c69d07197e92be3aabfd54916428b94cdd19b7952e0d18a
+  metadata.gz: aac16bb6d2541e573796043ebf2da2ffa171918730ad95f4613db1f6b20cb1156a4a1cb3d70b7e0c39be57a6d56d2cfd3a27d95470c0c316f8f95a756bf83377
+  data.tar.gz: 85349b218d754a716db3aa8165e8de64a92b48c22e4b4b1615e612d041000701a090c643fa6b6e68326bb51a3688df2eb71f84604a1bfd19034eb01201453b26

data/CHANGELOG.md

@@ -2,6 +2,17 @@
 
 ## master
 
+## 1.17.0 (2022-11-09)
+
+- [PR#92](https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache/pull/92) Make cache keys human-readable ([@jeromedalbert][])
+
+## 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][])

data/README.md

@@ -1,4 +1,4 @@
-# GraphQL::FragmentCache ![CI](https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache/workflows/CI/badge.svg?branch=master)
+# GraphQL::FragmentCache ![CI](https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache/actions/workflows/rspec.yml/badge.svg?branch=master) ![](https://ruby-gem-downloads-badge.herokuapp.com/graphql-fragment_cache?type=total)
 
 `GraphQL::FragmentCache` powers up [graphql-ruby](https://graphql-ruby.org) with the ability to cache response _fragments_: you can mark any field as cached and it will never be resolved again (at least, while cache is valid). For instance, the following code caches `title` for each post:
 
@@ -9,12 +9,6 @@ class PostType < BaseObject
 end
 ```
 
-<p align="center">
-  <a href="https://evilmartians.com/?utm_source=graphql-ruby-fragment_cache">
-    <img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54">
-  </a>
-</p>
-
 ## Getting started
 
 Add the gem to your Gemfile `gem 'graphql-fragment_cache'` and add the plugin to your schema class:
@@ -72,10 +66,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 +231,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`
@@ -434,6 +436,14 @@ 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:
@@ -473,6 +483,8 @@ end
 
 Based on the original [gist](https://gist.github.com/palkan/faad9f6ff1db16fcdb1c071ec50e4190) by [@palkan](https://github.com/palkan) and [@ssnickolay](https://github.com/ssnickolay).
 
+Initially sponsored by [Evil Martians](http://evilmartians.com).
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at [https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache](https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache).

data/lib/.rbnext/2.3/graphql/fragment_cache/cache_key_builder.rb

@@ -137,11 +137,17 @@ module GraphQL
       end
 
       def build
-        [
+        key_parts = [
           GraphQL::FragmentCache.namespace,
+          simple_path_cache_key,
           implicit_cache_key,
           object_cache_key
-        ].compact.join("/")
+        ]
+
+        key_parts
+          .compact
+          .map { |key_part| key_part.tr("/", "-") }
+          .join("/")
       end
 
       private
@@ -170,22 +176,28 @@ module GraphQL
         current_root.selections.to_selections_key
       end
 
+      def simple_path_cache_key
+        path_cache_key.split("(").first
+      end
+
       def path_cache_key
-        @options.fetch(:path_cache_key) do
-          lookahead = query.lookahead
+        @path_cache_key ||= begin
+          @options.fetch(:path_cache_key) do
+            lookahead = query.lookahead
 
-          path.map { |field_name|
-            # Handle cached fields inside collections:
-            next field_name if field_name.is_a?(Integer)
+            path.map { |field_name|
+              # Handle cached fields inside collections:
+              next field_name if field_name.is_a?(Integer)
 
-            lookahead = lookahead.selection_with_alias(field_name)
-            raise "Failed to look ahead the field: #{field_name}" if lookahead.is_a?(::GraphQL::Execution::Lookahead::NullLookahead)
+              lookahead = lookahead.selection_with_alias(field_name)
+              raise "Failed to look ahead the field: #{field_name}" if lookahead.is_a?(::GraphQL::Execution::Lookahead::NullLookahead)
 
-            next lookahead.field.name if lookahead.arguments.empty?
+              next lookahead.field.name if lookahead.arguments.empty?
 
-            args = lookahead.arguments.map { |_1, _2| "#{_1}:#{traverse_argument(_2)}" }.sort.join(",")
-            "#{lookahead.field.name}(#{args})"
-          }.join("/")
+              args = lookahead.arguments.map { |_1, _2| "#{_1}:#{traverse_argument(_2)}" }.sort.join(",")
+              "#{lookahead.field.name}(#{args})"
+            }.join("/")
+          end
         end
       end
 

data/lib/.rbnext/2.7/graphql/fragment_cache/cache_key_builder.rb

@@ -137,11 +137,17 @@ module GraphQL
       end
 
       def build
-        [
+        key_parts = [
           GraphQL::FragmentCache.namespace,
+          simple_path_cache_key,
           implicit_cache_key,
           object_cache_key
-        ].compact.join("/")
+        ]
+
+        key_parts
+          .compact
+          .map { |key_part| key_part.tr("/", "-") }
+          .join("/")
       end
 
       private
@@ -170,22 +176,28 @@ module GraphQL
         current_root.selections.to_selections_key
       end
 
+      def simple_path_cache_key
+        path_cache_key.split("(").first
+      end
+
       def path_cache_key
-        @options.fetch(:path_cache_key) do
-          lookahead = query.lookahead
+        @path_cache_key ||= begin
+          @options.fetch(:path_cache_key) do
+            lookahead = query.lookahead
 
-          path.map { |field_name|
-            # Handle cached fields inside collections:
-            next field_name if field_name.is_a?(Integer)
+            path.map { |field_name|
+              # Handle cached fields inside collections:
+              next field_name if field_name.is_a?(Integer)
 
-            lookahead = lookahead.selection_with_alias(field_name)
-            raise "Failed to look ahead the field: #{field_name}" if lookahead.is_a?(::GraphQL::Execution::Lookahead::NullLookahead)
+              lookahead = lookahead.selection_with_alias(field_name)
+              raise "Failed to look ahead the field: #{field_name}" if lookahead.is_a?(::GraphQL::Execution::Lookahead::NullLookahead)
 
-            next lookahead.field.name if lookahead.arguments.empty?
+              next lookahead.field.name if lookahead.arguments.empty?
 
-            args = lookahead.arguments.map { |_1, _2| "#{_1}:#{traverse_argument(_2)}" }.sort.join(",")
-            "#{lookahead.field.name}(#{args})"
-          }.join("/")
+              args = lookahead.arguments.map { |_1, _2| "#{_1}:#{traverse_argument(_2)}" }.sort.join(",")
+              "#{lookahead.field.name}(#{args})"
+            }.join("/")
+          end
         end
       end
 

data/lib/graphql/fragment_cache/cache_key_builder.rb

@@ -137,11 +137,17 @@ module GraphQL
       end
 
       def build
-        [
+        key_parts = [
           GraphQL::FragmentCache.namespace,
+          simple_path_cache_key,
           implicit_cache_key,
           object_cache_key
-        ].compact.join("/")
+        ]
+
+        key_parts
+          .compact
+          .map { |key_part| key_part.tr("/", "-") }
+          .join("/")
       end
 
       private
@@ -170,22 +176,28 @@ module GraphQL
         current_root.selections.to_selections_key
       end
 
+      def simple_path_cache_key
+        path_cache_key.split("(").first
+      end
+
       def path_cache_key
-        @options.fetch(:path_cache_key) do
-          lookahead = query.lookahead
+        @path_cache_key ||= begin
+          @options.fetch(:path_cache_key) do
+            lookahead = query.lookahead
 
-          path.map { |field_name|
-            # Handle cached fields inside collections:
-            next field_name if field_name.is_a?(Integer)
+            path.map { |field_name|
+              # Handle cached fields inside collections:
+              next field_name if field_name.is_a?(Integer)
 
-            lookahead = lookahead.selection_with_alias(field_name)
-            raise "Failed to look ahead the field: #{field_name}" if lookahead.is_a?(::GraphQL::Execution::Lookahead::NullLookahead)
+              lookahead = lookahead.selection_with_alias(field_name)
+              raise "Failed to look ahead the field: #{field_name}" if lookahead.is_a?(::GraphQL::Execution::Lookahead::NullLookahead)
 
-            next lookahead.field.name if lookahead.arguments.empty?
+              next lookahead.field.name if lookahead.arguments.empty?
 
-            args = lookahead.arguments.map { "#{_1}:#{traverse_argument(_2)}" }.sort.join(",")
-            "#{lookahead.field.name}(#{args})"
-          }.join("/")
+              args = lookahead.arguments.map { "#{_1}:#{traverse_argument(_2)}" }.sort.join(",")
+              "#{lookahead.field.name}(#{args})"
+            }.join("/")
+          end
         end
       end
 

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/version.rb

@@ -2,6 +2,6 @@
 
 module GraphQL
   module FragmentCache
-    VERSION = "1.15.0"
+    VERSION = "1.17.0"
   end
 end

data/lib/graphql/fragment_cache.rb

@@ -22,6 +22,7 @@ module GraphQL
   module FragmentCache
     class << self
       attr_reader :cache_store
+      attr_accessor :enabled
       attr_accessor :namespace
       attr_accessor :default_options
 
@@ -87,6 +88,8 @@ 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-fragment_cache
 version: !ruby/object:Gem::Version
-  version: 1.15.0
+  version: 1.17.0
 platform: ruby
 authors:
 - DmitryTsepelev
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-27 00:00:00.000000000 Z
+date: 2022-11-09 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: []