Fix cache key builder options handling and tests

Author: mgruner

lib/graphql/fragment_cache/cache_key_builder.rb

@@ -137,8 +137,12 @@ def path_cache_key
       end
 
       def include_argument?(argument_name)
-        return false if @options[:exclude_arguments]&.include?(argument_name)
-        return false if @options[:include_arguments] && !@options[:include_arguments].include?(argument_name)
+        exclude_arguments = @options.dig(:cache_key, :exclude_arguments)
+        return false if exclude_arguments&.include?(argument_name)
+
+        include_arguments = @options.dig(:cache_key, :include_arguments)
+        return false if include_arguments && !include_arguments.include?(argument_name)
+
         true
       end
 

spec/graphql/fragment_cache/cache_key_builder_spec.rb

@@ -68,13 +68,13 @@
     specify { is_expected.to eq "graphql/cachedPost/schema_key-cachedPost(id:#{id})[id.title.author[id.name]]" }
 
     context "when excluding arguments" do
-      let(:options) { {exclude_arguments: [:id]} }
+      let(:options) { {cache_key: {exclude_arguments: [:id]}} }
 
       specify { is_expected.to eq "graphql/cachedPost/schema_key-cachedPost()[id.title.author[id.name]]" }
     end
 
     context "when including arguments" do
-      let(:options) { {include_arguments: [:id]} }
+      let(:options) { {cache_key: {include_arguments: [:id]}} }
 
       specify { is_expected.to eq "graphql/cachedPost/schema_key-cachedPost(id:#{id})[id.title.author[id.name]]" }
     end
@@ -144,13 +144,13 @@
       specify { is_expected.to eq "graphql/cachedPostByComplexInput/schema_key-cachedPostByComplexInput(complex_post_input:{input_with_id:{id:#{id},int_arg:42},string_arg:woo})[id.title.author[id.name]]" }
 
       context "when excluding arguments" do
-        let(:options) { {exclude_arguments: [:int_arg]} }
+        let(:options) { {cache_key: {exclude_arguments: [:int_arg]}} }
 
         specify { is_expected.to eq "graphql/cachedPostByComplexInput/schema_key-cachedPostByComplexInput(complex_post_input:{input_with_id:{id:#{id}},string_arg:woo})[id.title.author[id.name]]" }
       end
 
       context "when including arguments" do
-        let(:options) { {include_arguments: [:complex_post_input, :input_with_id, :int_arg]} }
+        let(:options) { {cache_key: {include_arguments: [:complex_post_input, :input_with_id, :int_arg]}} }
 
         specify { is_expected.to eq "graphql/cachedPostByComplexInput/schema_key-cachedPostByComplexInput(complex_post_input:{input_with_id:{int_arg:42}})[id.title.author[id.name]]" }
       end

spec/graphql/fragment_cache/cacher_spec.rb

@@ -76,23 +76,6 @@ def write_multi(hash, options)
     end
 
     context "when cached fields have different options" do
-      let(:schema) do
-        build_schema do
-          query(
-            Class.new(Types::Query) {
-              field :post, Types::Post, null: true do
-                argument :id, GraphQL::Types::ID, required: true
-                argument :cache_key, GraphQL::Types::String, required: true
-              end
-
-              define_method(:post) { |id:, cache_key:|
-                cache_fragment(query_cache_key: cache_key) { Post.find(id) }
-              }
-            }
-          )
-        end
-      end
-
       let(:query) do
         <<~GQL
           query getPost($id: ID!) {
@@ -107,19 +90,38 @@ def write_multi(hash, options)
         GQL
       end
 
-      it "uses #write_multi two times with different options" do
-        execute_query
+      context "when there options are passed to cache_fragment" do
+        let(:schema) do
+          build_schema do
+            query(
+              Class.new(Types::Query) {
+                field :post, Types::Post, null: true do
+                  argument :id, GraphQL::Types::ID, required: true
+                  argument :cache_key, GraphQL::Types::String, required: true
+                end
 
-        args = []
-        expect(GraphQL::FragmentCache.cache_store).to \
-          have_received(:write_multi).exactly(2).times do |r, options|
-            args << options
+                define_method(:post) { |id:, cache_key:|
+                  cache_fragment(query_cache_key: cache_key) { Post.find(id) }
+                }
+              }
+            )
           end
+        end
+
+        it "uses #write_multi two times with different query_cache_key options" do
+          execute_query
+
+          args = []
+          expect(GraphQL::FragmentCache.cache_store).to \
+            have_received(:write_multi).exactly(2).times do |r, options|
+              args << options
+            end
 
-        expect(args).to eq([{query_cache_key: "1"}, {query_cache_key: "2"}])
+          expect(args).to eq([{query_cache_key: "1"}, {query_cache_key: "2"}])
+        end
       end
 
-      context "when different options exist, but should be excluded" do
+      context "when cache key is autogenerated" do
         let(:schema) do
           build_schema do
             query(
@@ -130,16 +132,54 @@ def write_multi(hash, options)
                 end
 
                 define_method(:post) { |id:, cache_key:|
-                  cache_fragment(cache_key: {exclude_arguments: [:cache_key]}) { Post.find(id) }
+                  cache_fragment { Post.find(id) }
                 }
               }
             )
           end
         end
 
-        it "uses #write_multi ony one time time" do
+        it "writes a cache key for each argument value" do
           execute_query
-          expect(GraphQL::FragmentCache.cache_store).to have_received(:write_multi).once
+
+          args = []
+          expect(GraphQL::FragmentCache.cache_store).to \
+            have_received(:write_multi).once.times do |hash, options|
+              args << hash
+            end
+
+          expect(args.first.keys.length).to be(2)
+        end
+
+        context "when arguments are excluded" do
+          let(:schema) do
+            build_schema do
+              query(
+                Class.new(Types::Query) {
+                  field :post, Types::Post, null: true do
+                    argument :id, GraphQL::Types::ID, required: true
+                    argument :cache_key, GraphQL::Types::String, required: true
+                  end
+
+                  define_method(:post) { |id:, cache_key:|
+                    cache_fragment(cache_key: {exclude_arguments: [:cache_key]}) { Post.find(id) }
+                  }
+                }
+              )
+            end
+          end
+
+          it "writes only one cache key" do
+            execute_query
+
+            args = []
+            expect(GraphQL::FragmentCache.cache_store).to \
+              have_received(:write_multi).once.times do |hash, options|
+                args << hash
+              end
+
+            expect(args.first.keys.length).to be(1)
+          end
         end
       end
     end