graphql-stitching 1.0.4 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ccc67e1b52f1a0688d25958d1955580c7f88a8115dc6b6b6905f785da94089db
-  data.tar.gz: 8e0925fb1ad0584bce11672be24868dc261cf680f8f88acdff87a7ca3819d9f8
+  metadata.gz: fbeabcd8c2327504cc5ccc613942d163bddddb2087e7eb90c966861777d67b9d
+  data.tar.gz: cf03589e91ef96fb8dc9b74ca2703c20095e586bab45f91a89b3579376edbdac
 SHA512:
-  metadata.gz: 9213dbd90d0fc0caf10a09b9ba68bfbfe072c3cce9d51c47623b0d5edabb9bfe1eac849fb3135bade04863c2ca9b62c42c2f67b469f1fc268f039fab15f17372
-  data.tar.gz: c62c51fda4c9210ba71c9be894e7a31fe3346c0e4d49ac57632efa32b8db9809174b6d0fb048eddc1437584c57d7f2bd748e4fab3f1e1440c2d5c6f3647657dd
+  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/docs/composer.md

@@ -12,6 +12,7 @@ composer = GraphQL::Stitching::Composer.new(
   mutation_name: "Mutation",
   description_merger: ->(values_by_location, info) { values_by_location.values.join("\n") },
   deprecation_merger: ->(values_by_location, info) { values_by_location.values.first },
+  default_value_merger: ->(values_by_location, info) { values_by_location.values.first },
   directive_kwarg_merger: ->(values_by_location, info) { values_by_location.values.last },
   root_field_location_selector: ->(locations, info) { locations.last },
 )
@@ -27,6 +28,8 @@ Constructor arguments:
 
 - **`deprecation_merger:`** _optional_, a [value merger function](#value-merger-functions) for merging element deprecation strings from across locations.
 
+- **`default_value_merger:`** _optional_, a [value merger function](#value-merger-functions) for merging argument default values from across locations.
+
 - **`directive_kwarg_merger:`** _optional_, a [value merger function](#value-merger-functions) for merging directive keyword arguments from across locations.
 
 - **`root_field_location_selector:`** _optional_, selects a default routing location for root fields with multiple locations. Use this to prioritize sending root fields to their primary data sources (only applies while routing the root operation scope). This handler receives an array of possible locations and an info object with field information, and should return the prioritized location. The last location is used by default.

data/docs/executor.md

@@ -50,8 +50,8 @@ The raw result will contain many irregularities from the stitching process, howe
   "data" => {
     "product" => {
       "upc" => "1",
-      "_STITCH_upc" => "1",
-      "_STITCH_typename" => "Product",
+      "_export_upc" => "1",
+      "_export_typename" => "Product",
       "name" => "iPhone",
       "price" => nil,
     }

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

@@ -5,9 +5,13 @@ module GraphQL
     class Composer
       class ComposerError < StitchingError; end
       class ValidationError < ComposerError; end
+      class ReferenceType < GraphQL::Schema::Object
+        field(:f, String) do
+          argument(:a, String)
+        end
+      end
 
-      attr_reader :query_name, :mutation_name, :candidate_types_by_name_and_location, :schema_directives
-
+      NO_DEFAULT_VALUE = ReferenceType.get_field("f").get_argument("a").default_value
       BASIC_VALUE_MERGER = ->(values_by_location, _info) { values_by_location.values.find { !_1.nil? } }
       BASIC_ROOT_FIELD_LOCATION_SELECTOR = ->(locations, _info) { locations.last }
 
@@ -16,6 +20,8 @@ module GraphQL
         "ValidateBoundaries",
       ].freeze
 
+      attr_reader :query_name, :mutation_name, :candidate_types_by_name_and_location, :schema_directives
+
       def initialize(
         query_name: "Query",
         mutation_name: "Mutation",
@@ -47,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
@@ -82,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)
@@ -194,8 +201,8 @@ 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)
-          builder.build_merged_arguments(directive_name, directives_by_location, self)
+          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
 
@@ -256,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
 
@@ -274,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
 
@@ -290,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
@@ -343,7 +350,7 @@ module GraphQL
         end
       end
 
-      def build_merged_arguments(type_name, members_by_location, owner, field_name: nil)
+      def build_merged_arguments(type_name, members_by_location, owner, field_name: nil, directive_name: nil)
         # "argument_name" => "location" => argument
         args_by_name_location = members_by_location.each_with_object({}) do |(location, member_candidate), memo|
           member_candidate.arguments.each do |argument_name, argument|
@@ -369,7 +376,7 @@ module GraphQL
 
           kwargs = {}
           default_values_by_location = arguments_by_location.each_with_object({}) do |(location, argument), memo|
-            next if argument.default_value.class == Object # << pass on NOT_CONFIGURED (todo: improve this check)
+            next if argument.default_value == NO_DEFAULT_VALUE
             memo[location] = argument.default_value
           end
 
@@ -378,7 +385,8 @@ module GraphQL
               type_name: type_name,
               field_name: field_name,
               argument_name: argument_name,
-            })
+              directive_name: directive_name,
+            }.tap(&:compact!))
           end
 
           type = merge_value_types(type_name, value_types, argument_name: argument_name, field_name: field_name)
@@ -430,7 +438,7 @@ module GraphQL
               enum_value: enum_value,
               directive_name: directive_name,
               kwarg_name: kwarg_name,
-            }.compact!)
+            }.tap(&:compact!))
           end
 
           owner.directive(directive_class, **kwargs)
@@ -438,7 +446,7 @@ module GraphQL
       end
 
       def merge_value_types(type_name, type_candidates, field_name: nil, argument_name: nil)
-        path = [type_name, field_name, argument_name].compact.join(".")
+        path = [type_name, field_name, argument_name].tap(&:compact!).join(".")
         alt_structures = type_candidates.map { Util.flatten_type_structure(_1) }
         basis_structure = alt_structures.shift
 
@@ -475,7 +483,7 @@ module GraphQL
           field_name: field_name,
           argument_name: argument_name,
           enum_value: enum_value,
-        }.compact!)
+        }.tap(&:compact!))
       end
 
       def merge_deprecations(type_name, members_by_location, field_name: nil, argument_name: nil, enum_value: nil)
@@ -485,7 +493,7 @@ module GraphQL
           field_name: field_name,
           argument_name: argument_name,
           enum_value: enum_value,
-        }.compact!)
+        }.tap(&:compact!))
       end
 
       def extract_boundaries(type_name, types_by_location)

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

@@ -16,7 +16,7 @@ module GraphQL
 
           if op.if_type
             # operations planned around unused fragment conditions should not trigger requests
-            origin_set.select! { _1[SelectionHint.typename_node.alias] == op.if_type }
+            origin_set.select! { _1[ExportSelection.typename_node.alias] == op.if_type }
           end
 
           memo[op] = origin_set if origin_set.any?
@@ -94,9 +94,9 @@ module GraphQL
       end
 
       def build_key(key, origin_obj, federation: false)
-        key_value = JSON.generate(origin_obj[SelectionHint.key(key)])
+        key_value = JSON.generate(origin_obj[ExportSelection.key(key)])
         if federation
-          "{ __typename: \"#{origin_obj[SelectionHint.typename_node.alias]}\", #{key}: #{key_value} }"
+          "{ __typename: \"#{origin_obj[ExportSelection.typename_node.alias]}\", #{key}: #{key_value} }"
         else
           key_value
         end
@@ -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/{selection_hint.rb → export_selection.rb}

@@ -4,18 +4,18 @@ module GraphQL
   module Stitching
     # Builds hidden selection fields added by stitiching code,
     # used to request operational data about resolved objects.
-    class SelectionHint
-      HINT_PREFIX = "_STITCH_"
+    class ExportSelection
+      EXPORT_PREFIX = "_export_"
 
       class << self
         def key?(name)
           return false unless name
 
-          name.start_with?(HINT_PREFIX)
+          name.start_with?(EXPORT_PREFIX)
         end
 
         def key(name)
-          "#{HINT_PREFIX}#{name}"
+          "#{EXPORT_PREFIX}#{name}"
         end
 
         def key_node(field_name)

data/lib/graphql/stitching/planner.rb

@@ -42,7 +42,7 @@ module GraphQL
       #      Adjoining selections not available here get split off into new entrypoints (C).
       # B.3) Collect all variable definitions used within the filtered selection.
       #      These specify which request variables to pass along with each step.
-      # B.4) Add a `__typename` hint to abstracts and types that implement fragments.
+      # B.4) Add a `__typename` export to abstracts and types that implement fragments.
       #      This provides resolved type information used during execution.
       #
       # C) Delegate adjoining selections to new entrypoint locations.
@@ -199,7 +199,9 @@ module GraphQL
         input_selections.each do |node|
           case node
           when GraphQL::Language::Nodes::Field
-            if node.name == TYPENAME
+            if node.alias&.start_with?(ExportSelection::EXPORT_PREFIX)
+              raise StitchingError, %(Alias "#{node.alias}" is not allowed because "#{ExportSelection::EXPORT_PREFIX}" is a reserved prefix.)
+            elsif node.name == TYPENAME
               locale_selections << node
               next
             end
@@ -257,10 +259,10 @@ module GraphQL
           end
         end
 
-        # B.4) Add a `__typename` hint to abstracts and types that implement
+        # B.4) Add a `__typename` export to abstracts and types that implement
         # fragments so that resolved type information is available during execution.
         if requires_typename
-          locale_selections << SelectionHint.typename_node
+          locale_selections << ExportSelection.typename_node
         end
 
         if remote_selections
@@ -274,18 +276,18 @@ module GraphQL
           routes.each_value do |route|
             route.reduce(locale_selections) do |parent_selections, boundary|
               # E.1) Add the key of each boundary query into the prior location's selection set.
-              foreign_key = SelectionHint.key(boundary.key)
+              foreign_key = ExportSelection.key(boundary.key)
               has_key = false
               has_typename = false
 
               parent_selections.each do |node|
                 next unless node.is_a?(GraphQL::Language::Nodes::Field)
                 has_key ||= node.alias == foreign_key
-                has_typename ||= node.alias == SelectionHint.typename_node.alias
+                has_typename ||= node.alias == ExportSelection.typename_node.alias
               end
 
-              parent_selections << SelectionHint.key_node(boundary.key) unless has_key
-              parent_selections << SelectionHint.typename_node unless has_typename
+              parent_selections << ExportSelection.key_node(boundary.key) unless has_key
+              parent_selections << ExportSelection.typename_node unless has_typename
 
               # E.2) Add a planner step for each new entrypoint location.
               add_step(

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
+          @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/shaper.rb

@@ -4,7 +4,7 @@
 module GraphQL
   module Stitching
     # Shapes the final results payload to the request selection and schema definition.
-    # This eliminates unrequested selection hints and applies null bubbling.
+    # This eliminates unrequested export selections and applies null bubbling.
     class Shaper
       def initialize(supergraph:, request:)
         @supergraph = supergraph
@@ -21,8 +21,8 @@ module GraphQL
       def resolve_object_scope(raw_object, parent_type, selections, typename = nil)
         return nil if raw_object.nil?
 
-        typename ||= raw_object[SelectionHint.typename_node.alias]
-        raw_object.reject! { |key, _v| SelectionHint.key?(key) }
+        typename ||= raw_object[ExportSelection.typename_node.alias]
+        raw_object.reject! { |key, _v| ExportSelection.key?(key) }
 
         selections.each do |node|
           case node

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
@@ -35,7 +39,7 @@ module GraphQL
           end
 
           if filtered_selections.none?
-            filtered_selections << SelectionHint.typename_node
+            filtered_selections << ExportSelection.typename_node
           end
 
           if changed

data/lib/graphql/stitching/version.rb

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

data/lib/graphql/stitching.rb

@@ -28,12 +28,12 @@ require_relative "stitching/boundary"
 require_relative "stitching/client"
 require_relative "stitching/composer"
 require_relative "stitching/executor"
+require_relative "stitching/export_selection"
 require_relative "stitching/http_executable"
 require_relative "stitching/plan"
 require_relative "stitching/planner_step"
 require_relative "stitching/planner"
 require_relative "stitching/request"
-require_relative "stitching/selection_hint"
 require_relative "stitching/shaper"
 require_relative "stitching/skip_include"
 require_relative "stitching/util"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-stitching
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.6
 platform: ruby
 authors:
 - Greg MacWilliam
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-03 00:00:00.000000000 Z
+date: 2023-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -106,12 +106,12 @@ files:
 - lib/graphql/stitching/executor.rb
 - lib/graphql/stitching/executor/boundary_source.rb
 - lib/graphql/stitching/executor/root_source.rb
+- lib/graphql/stitching/export_selection.rb
 - lib/graphql/stitching/http_executable.rb
 - lib/graphql/stitching/plan.rb
 - lib/graphql/stitching/planner.rb
 - lib/graphql/stitching/planner_step.rb
 - lib/graphql/stitching/request.rb
-- lib/graphql/stitching/selection_hint.rb
 - lib/graphql/stitching/shaper.rb
 - lib/graphql/stitching/skip_include.rb
 - lib/graphql/stitching/supergraph.rb