Merge branch 'DmitryTsepelev:master' into master

Author: gsdean

.github/workflows/rspec.yml

@@ -19,14 +19,21 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [2.6, 2.7, '3.0', 3.1, 3.2]
+        ruby: [3.1, 3.2, 3.3, 3.4]
         gemfile: [
-          "gemfiles/graphql_1_12_0.gemfile",
-          "gemfiles/graphql_1_13_7.gemfile",
-          "gemfiles/graphql_2_0_0.gemfile",
-          "gemfiles/graphql_2_0_14.gemfile",
+          "gemfiles/graphql_2_1_4.gemfile",
+          "gemfiles/graphql_2_3_0.gemfile",
+          "gemfiles/graphql_2_3_11.gemfile",
+          "gemfiles/graphql_2_4_8.gemfile",
           "gemfiles/graphql_master.gemfile"
         ]
+        exclude:
+          - ruby: "3.1"
+            gemfile: gemfiles/graphql_2_3_0.gemfile
+          - ruby: "3.1"
+            gemfile: gemfiles/graphql_2_3_11.gemfile
+          - ruby: "3.1"
+            gemfile: gemfiles/graphql_master.gemfile
 
     steps:
     - uses: actions/checkout@v2
@@ -36,8 +43,6 @@ jobs:
         bundler-cache: true
         bundler: 2.2.0
         cache-version: 1
-    - name: Run Ruby Next
-      run: bundle exec rake nextify
     - name: Run RSpec
       run: |
         bundle exec rake spec

.github/workflows/rubocop.yml

@@ -14,7 +14,7 @@ jobs:
     - uses: actions/checkout@v2
     - uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.7
+        ruby-version: 3.1
         bundler-cache: true
         bundler: 2.2.0
     - name: Lint Ruby code with RuboCop

.gitignore

@@ -10,6 +10,7 @@ Gemfile.lock
 .DS_Store
 .rbnext/
 *.sqlite3
+*.sqlite3-*
 spec/internal/log/*.log
 .idea/
 .ruby-version

.rbnextrc

@@ -2,6 +2,49 @@
 
 ## master
 
+## 1.22.0 (2025-02-20)
+
+- [PR#134](https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache/pull/134) Add possibility to include and exclude arguments from generated cache key ([@mgruner][])
+
+## 1.21.0 (2025-02-01)
+
+- [PR#130](https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache/pull/130) Dataloader support ([@DmitryTsepelev][])
+- [PR#125](https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache/pull/125) Introduce cache lookup instrumentation hook ([@danielhartnell][])
+
+## 1.20.5 (2024-11-02)
+
+- [PR#120](https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache/pull/120) Fix warning on ActiveSupport::Cache.format_version ([@Drowze][])
+
+## 1.20.4 (2024-10-05)
+
+- [PR#119](https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache/pull/119) Fix Rails cache_format_version deprecation ([@noma4i][])
+
+## 1.20.3 (2024-09-06)
+
+- [PR#117](https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache/pull/117) Deprecate old ruby and gql versions  ([@DmitryTsepelev][])
+- [PR#116](https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache/pull/116) Migrate CompiledQueries instrumentation to tracer ([@DmitryTsepelev][])
+
+## 1.20.2 (2024-06-01)
+
+- [PR#115](https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache/pull/115) Fix deprecation warning for cache_format_version in Rails 7.1 ([@rince][])
+
+## 1.20.1 (2024-04-03)
+
+- [PR#112](https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache/pull/112) fix tracer deprecation warnings ([@diegofigueroa][])
+- [PR#109](https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache/pull/109) Remove `Lookahead` patch in modern versions of graphql-ruby ([@DmitryTsepelev][])
+
+## 1.20.0 (2024-03-02)
+
+- [PR#108](https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache/pull/108) Use trace_with instead of deprecated instrument method  ([@camero2734][])
+
+## 1.19.0 (2023-11-03)
+
+- [PR#104](https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache/pull/104) Support graphql-ruby 2.1.4 ([@DmitryTsepelev][])
+
+## 1.18.2 (2023-02-21)
+
+- [PR#100](https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache/pull/100) Fix an error when `path_cache_key` is nil ([@rince][])
+
 ## 1.18.1 (2023-01-06)
 
 - [PR#96](https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache/pull/96) Properly pass arguments to `write_multi` ([@DmitryTsepelev][])
@@ -172,3 +215,10 @@
 [@daukadolt]: https://github.com/daukadolt
 [@frostmark]: https://github.com/frostmark
 [@KTSCode]: https://github.com/KTSCode
+[@rince]: https://github.com/rince
+[@camero2734]: https://github.com/camero2734
+[@diegofigueroa]: https://github.com/diegofigueroa
+[@noma4i]: https://github.com/noma4i
+[@Drowze]: https://github.com/Drowze
+[@danielhartnell]: https://github.com/danielhartnell
+[@mgruner]: https://github.com/mgruner

CHANGELOG.md

@@ -1,9 +1,6 @@
 default: test
 
-nextify:
-	bundle exec rake nextify
-
-test: nextify
+test:
 	bundle exec rake
 	CI=true bundle exec rake
 

Makefile

@@ -9,6 +9,8 @@ class PostType < BaseObject
 end
 ```
 
+You can support my open–source work [here](https://boosty.to/dmitry_tsepelev).
+
 ## Getting started
 
 Add the gem to your Gemfile `gem 'graphql-fragment_cache'` and add the plugin to your schema class:
@@ -145,6 +147,34 @@ class QueryType < BaseObject
 end
 ```
 
+### Query arguments processing
+
+You can influence the way that graphql arguments are include in the cache key.
+
+A use case might be a `:renew_cache` parameter that can be used to force a cache rewrite,
+but should not be included with the cache key itself. Use `cache_key: { exclude_arguments: […]}`
+to specify a list of arguments to be excluded from the implicit cache key.
+
+```ruby
+class QueryType < BaseObject
+  field :post, PostType, null: true do
+    argument :id, ID, required: true
+    argument :renew_cache, Boolean, required: false
+  end
+
+  def post(id:, renew_cache: false)
+    if renew_cache
+      context.scoped_set!(:renew_cache, true)
+    end
+    cache_fragment(cache_key: {exclude_arguments: [:renew_cache]}) { Post.find(id) }
+  end
+end
+```
+
+Likewise, you can use `cache_key: { include_arguments: […] }` to specify an allowlist of arguments
+to be included in the cache key. In this case all arguments for the cache key must be specified, including
+parent arguments of nested fields.
+
 ### User-provided cache key (custom key)
 
 In most cases you want your cache key to depend on the resolved object (say, `ActiveRecord` model). You can do that by passing an argument to the `#cache_fragment` method in a similar way to Rails views [`#cache` method](https://guides.rubyonrails.org/caching_with_rails.html#fragment-caching):
@@ -379,6 +409,34 @@ class QueryType < BaseObject
 end
 ```
 
+## Dataloader
+
+If you are using [Dataloader](https://graphql-ruby.org/dataloader/overview.html), you will need to let the gem know using `dataloader: true`:
+
+```ruby
+class PostType < BaseObject
+  field :author, User, null: false
+
+  def author
+    cache_fragment(dataloader: true) do
+      dataloader.with(AuthorDataloaderSource).load(object.id)
+    end
+  end
+end
+
+# or
+
+class PostType < BaseObject
+  field :author, User, null: false, cache_fragment: {dataloader: true}
+
+  def author
+    dataloader.with(AuthorDataloaderSource).load(object.id)
+  end
+end
+```
+
+The problem is that I didn't find a way to detect that dataloader (and, therefore, Fiber) is used, and the block is forced to resolve, causing the N+1 inside the Dataloader Source class.
+
 ## 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:
@@ -444,6 +502,30 @@ Cache processing can be disabled if needed. For example:
 GraphQL::FragmentCache.enabled = false if Rails.env.test?
 ```
 
+## Cache lookup monitoring
+
+It may be useful to capture cache lookup events. When monitoring is enabled, the `cache_key`, `operation_name`, `path` and a boolean indicating a cache hit or miss will be sent to a `cache_lookup_event` method. This method can be implemented in your application to handle the event.
+
+Example handler defined in a Rails initializer:
+
+```ruby
+module GraphQL
+  module FragmentCache
+    class Fragment
+      def self.cache_lookup_event(**args)
+        # Monitoring such as incrementing a cache hit counter metric
+      end
+    end
+  end
+end
+```
+
+Like managing caching itself, monitoring can be enabled if needed. It is disabled by default. For example:
+
+```ruby
+GraphQL::FragmentCache.monitoring_enabled = true
+```
+
 ## 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:
@@ -469,13 +551,13 @@ def cached_author_inside_batch
 end
 ```
 
-2. 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:
+2. 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 `path_cache_key` explicitly:
 
 ```ruby
 field :cached_avatar_url, String, null: false
 
 def cached_avatar_url
-  cache_fragment(query_cache_key: "post_avatar_url(#{object.id})") { object.avatar_url }
+  cache_fragment(path_cache_key: "post_avatar_url(#{object.id})") { object.avatar_url }
 end
 ```
 

README.md

@@ -3,11 +3,6 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-desc "Run Ruby Next nextify"
-task :nextify do
-  sh "bundle exec ruby-next nextify ./lib -V"
-end
-
 desc "Run specs without Rails"
 RSpec::Core::RakeTask.new("spec:norails") do |task|
   task.exclude_pattern = "**/rails/**"

Rakefile

@@ -1,5 +1,5 @@
 source "https://rubygems.org"
 
-gem "graphql", "~> 2.0.0"
+gem "graphql", "~> 2.1.4"
 
 gemspec path: "../"

gemfiles/graphql_2_0_0.gemfile gemfiles/graphql_2_1_4.gemfilegemfiles/graphql_2_0_0.gemfile renamed to gemfiles/graphql_2_1_4.gemfile

@@ -1,5 +1,5 @@
 source "https://rubygems.org"
 
-gem "graphql", "~> 2.0.14"
+gem "graphql", "~> 2.3.0"
 
 gemspec path: "../"