graphql-stitching 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d90338dfde5c26515a55afdee7f5bd936a4563b2b8f83e1ffc1a4420c56a5cf
-  data.tar.gz: d728c5dfabb5e0250c38a6718ac7b535cfa7a183872dc60fa95a9b91b777a64a
+  metadata.gz: fbeabcd8c2327504cc5ccc613942d163bddddb2087e7eb90c966861777d67b9d
+  data.tar.gz: cf03589e91ef96fb8dc9b74ca2703c20095e586bab45f91a89b3579376edbdac
 SHA512:
-  metadata.gz: cc5ff912f354e08b9f204028d5e6eed85a81bf283bd5dc13bb7ee9b69b83d0bb39ba83f9fbaac66be1363e86ce3f6bd1b3f7cc4466ef83998a751e3dbccf9013
-  data.tar.gz: 055e1c09f88e8f893a3ebb0aa3d7558156ec5c4a33b704cca69499efee4fd02e3a70e6efedeca1332f92392c7093ea8024ba9aefb159ce77b4f11510cd8d7a1c
+  metadata.gz: 78b5d6bbf4abccb99795c6225e1a61807ed74f94ad9ce5bdde0be534133e101c7d51f677d3c89aebaad7ebe2b125ff11a192a3d1a29cdacb3d3b51049801212f
+  data.tar.gz: ade024c4ace1474d9c7a7cd80fb8820fc71e456e566d89fe656d07bf4b64e60db83561546a908b5d2fcbec9d88ac740a7080946e981a74f7bd904b3da0aeebfb

data/docs/client.md

@@ -61,16 +61,16 @@ Arguments for the `execute` method include:
 The client provides cache hooks to enable caching query plans across requests. Without caching, every request made to the client will be planned individually. With caching, a query may be planned once, cached, and then executed from cache for subsequent requests. Cache keys are a normalized digest of each query string.
 
 ```ruby
-client.on_cache_read do |key, _context|
+client.on_cache_read do |key, _context, _request|
   $redis.get(key) # << 3P code
 end
 
-client.on_cache_write do |key, payload, _context|
+client.on_cache_write do |key, payload, _context, _request|
   $redis.set(key, payload) # << 3P code
 end
 ```
 
-Note that inlined input data works against caching, so you should _avoid_ this:
+Note that inlined input data works against caching, so you should _avoid_ this when possible:
 
 ```graphql
 query {
@@ -78,7 +78,7 @@ query {
 }
 ```
 
-Instead, always leverage variables in queries so that the document body remains consistent across requests:
+Instead, leverage query variables so that the document body remains consistent across requests:
 
 ```graphql
 query($id: ID!) {

data/lib/graphql/stitching/client.rb

@@ -75,14 +75,14 @@ module GraphQL
 
       def fetch_plan(request)
         if @on_cache_read
-          cached_plan = @on_cache_read.call(request.digest, request.context)
+          cached_plan = @on_cache_read.call(request.digest, request.context, request)
           return GraphQL::Stitching::Plan.from_json(JSON.parse(cached_plan)) if cached_plan
         end
 
         plan = yield
 
         if @on_cache_write
-          @on_cache_write.call(request.digest, JSON.generate(plan.as_json), request.context)
+          @on_cache_write.call(request.digest, JSON.generate(plan.as_json), request.context, request)
         end
 
         plan

data/lib/graphql/stitching/composer.rb

@@ -53,7 +53,7 @@ module GraphQL
           end
         end
 
-        # "Typename" => merged_directive
+        # "directive_name" => merged_directive
         @schema_directives = @candidate_directives_by_name_and_location.each_with_object({}) do |(directive_name, directives_by_location), memo|
           memo[directive_name] = build_directive(directive_name, directives_by_location)
         end
@@ -88,19 +88,20 @@ module GraphQL
 
         # "Typename" => merged_type
         schema_types = @candidate_types_by_name_and_location.each_with_object({}) do |(type_name, types_by_location), memo|
-          kinds = types_by_location.values.map { _1.kind.name }.uniq
+          kinds = types_by_location.values.map { _1.kind.name }.tap(&:uniq!)
 
           if kinds.length > 1
             raise ComposerError, "Cannot merge different kinds for `#{type_name}`. Found: #{kinds.join(", ")}."
           end
 
+          extract_boundaries(type_name, types_by_location) if type_name == @query_name
+
           memo[type_name] = case kinds.first
           when "SCALAR"
             build_scalar_type(type_name, types_by_location)
           when "ENUM"
             build_enum_type(type_name, types_by_location, enum_usage)
           when "OBJECT"
-            extract_boundaries(type_name, types_by_location) if type_name == @query_name
             build_object_type(type_name, types_by_location)
           when "INTERFACE"
             build_interface_type(type_name, types_by_location)
@@ -200,7 +201,7 @@ module GraphQL
           graphql_name(directive_name)
           description(builder.merge_descriptions(directive_name, directives_by_location))
           repeatable(directives_by_location.values.any?(&:repeatable?))
-          locations(*directives_by_location.values.flat_map(&:locations).uniq)
+          locations(*directives_by_location.values.flat_map(&:locations).tap(&:uniq!))
           builder.build_merged_arguments(directive_name, directives_by_location, self, directive_name: directive_name)
         end
       end
@@ -262,7 +263,7 @@ module GraphQL
           description(builder.merge_descriptions(type_name, types_by_location))
 
           interface_names = types_by_location.values.flat_map { _1.interfaces.map(&:graphql_name) }
-          interface_names.uniq.each do |interface_name|
+          interface_names.tap(&:uniq!).each do |interface_name|
             implements(builder.build_type_binding(interface_name))
           end
 
@@ -280,7 +281,7 @@ module GraphQL
           description(builder.merge_descriptions(type_name, types_by_location))
 
           interface_names = types_by_location.values.flat_map { _1.interfaces.map(&:graphql_name) }
-          interface_names.uniq.each do |interface_name|
+          interface_names.tap(&:uniq!).each do |interface_name|
             implements(builder.build_type_binding(interface_name))
           end
 
@@ -296,7 +297,7 @@ module GraphQL
           graphql_name(type_name)
           description(builder.merge_descriptions(type_name, types_by_location))
 
-          possible_names = types_by_location.values.flat_map { _1.possible_types.map(&:graphql_name) }.uniq
+          possible_names = types_by_location.values.flat_map { _1.possible_types.map(&:graphql_name) }.tap(&:uniq!)
           possible_types(*possible_names.map { builder.build_type_binding(_1) })
           builder.build_merged_directives(type_name, types_by_location, self)
         end

data/lib/graphql/stitching/executor/boundary_source.rb

@@ -160,7 +160,8 @@ module GraphQL
             errors_result.concat(pathed_errors_by_object_id.values)
           end
         end
-        errors_result.flatten!
+
+        errors_result.tap(&:flatten!)
       end
 
       private

data/lib/graphql/stitching/request.rb

@@ -4,14 +4,13 @@ module GraphQL
   module Stitching
     class Request
       SUPPORTED_OPERATIONS = ["query", "mutation"].freeze
+      SKIP_INCLUDE_DIRECTIVE = /@(?:skip|include)/
 
       attr_reader :document, :variables, :operation_name, :context
 
       def initialize(document, operation_name: nil, variables: nil, context: nil)
-        @may_contain_runtime_directives = true
-
         @document = if document.is_a?(String)
-          @may_contain_runtime_directives = document.include?("@")
+          @string = document
           GraphQL.parse(document)
         else
           document
@@ -23,13 +22,21 @@ module GraphQL
       end
 
       def string
-        @string ||= @document.to_query_string
+        @string || normalized_string
+      end
+
+      def normalized_string
+        @normalized_string ||= @document.to_query_string
       end
 
       def digest
         @digest ||= Digest::SHA2.hexdigest(string)
       end
 
+      def normalized_digest
+        @normalized_digest ||= Digest::SHA2.hexdigest(normalized_string)
+      end
+
       def operation
         @operation ||= begin
           operation_defs = @document.definitions.select do |d|
@@ -69,18 +76,15 @@ module GraphQL
 
       def prepare!
         operation.variables.each do |v|
-          @variables[v.name] = v.default_value if @variables[v.name].nil?
+          @variables[v.name] = v.default_value if @variables[v.name].nil? && !v.default_value.nil?
         end
 
-        if @may_contain_runtime_directives
-          @document, modified = SkipInclude.render(@document, @variables)
-
-          if modified
-            @string = nil
-            @digest = nil
-            @operation = nil
-            @variable_definitions = nil
-            @fragment_definitions = nil
+        if @string.nil? || @string.match?(SKIP_INCLUDE_DIRECTIVE)
+          SkipInclude.render(@document, @variables) do |modified_ast|
+            @document = modified_ast
+            @string = @normalized_string = nil
+            @digest = @normalized_digest = nil
+            @operation = @operation_directives = @variable_definitions = nil
           end
         end
 

data/lib/graphql/stitching/skip_include.rb

@@ -15,7 +15,11 @@ module GraphQL
             definition
           end
 
-          return document.merge(definitions: definitions), changed
+          return document unless changed
+
+          document = document.merge(definitions: definitions)
+          yield(document) if block_given?
+          document
         end
 
         private

data/lib/graphql/stitching/version.rb

@@ -2,6 +2,6 @@
 
 module GraphQL
   module Stitching
-    VERSION = "1.0.5"
+    VERSION = "1.0.6"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-stitching
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - Greg MacWilliam
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-19 00:00:00.000000000 Z
+date: 2023-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql