graphql-stitching 1.4.1 → 1.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7c50a82a3fa6298b224bef6923478217e82e6ddd4b6b09ca33df72f690edbdc
-  data.tar.gz: 545e2817523bbcedcb84b2512942eb92ae66e5353c46d4556eb892590fa868b3
+  metadata.gz: a72adc399f618790fc1aefe1b6dca07709d45f10cc2936f5c3978d75b5d3f8c2
+  data.tar.gz: d45d7b73045755a750d6d4334e00e30f33c5124f83c849c24669c98f7912ca92
 SHA512:
-  metadata.gz: 426d87b634cb77ad8bb185c8a23fbbc1439abbc60b55f6561999eb64d9c08642496be4eafd3415ccd47aebef21b39f349aca38be7c6ada4d34f763e7910a3b67
-  data.tar.gz: 50711d59f93fc17809c2953a014438a3f59ea952030c0112393acacd8066d90e9824b332dfda9546d3bdc74e7a030442e5b74f3b2fdda61df356d7832469020b
+  metadata.gz: 5302083cb9047ad77aa5e6276d02e3bdac8256ef328edb8c72b9248efbb279c48bb3e34b8e220f131d3efa541fdaa1b682fe4622501900defe797217cbc365c8
+  data.tar.gz: 4e238de4607764406ac52634daafc293c1b5fe672457106ff1070e77bc4d52cdc1ace02ce46ca4cacbcde7648d8a4f2bb8cc0321157dfb3c85c3ec40d5f82e43

data/README.md

@@ -101,7 +101,7 @@ This directive (or [static configuration](#sdl-based-schemas)) is applied to roo
 
 ```ruby
 products_schema = <<~GRAPHQL
-  directive @stitch(key: String!) repeatable on FIELD_DEFINITION
+  directive @stitch(key: String!, arguments: String) repeatable on FIELD_DEFINITION
 
   type Product {
     id: ID!
@@ -114,7 +114,7 @@ products_schema = <<~GRAPHQL
 GRAPHQL
 
 catalog_schema = <<~GRAPHQL
-  directive @stitch(key: String!) repeatable on FIELD_DEFINITION
+  directive @stitch(key: String!, arguments: String) repeatable on FIELD_DEFINITION
 
   type Product {
     id: ID!
@@ -226,7 +226,7 @@ type Query {
 }
 ```
 
-Key insertions are prefixed by `$` and specify a dot-notation path to any selections made by the resolver `key`, or `__typename`. This syntax allows sending multiple arguments that intermix stitching keys with complex input shapes and other static values:
+Key insertions are prefixed by `$` and specify a dot-notation path to any selections made by the resolver key, or `__typename`. This syntax allows sending multiple arguments that intermix stitching keys with complex input shapes and other static values:
 
 ```graphql
 type Product {
@@ -237,10 +237,14 @@ input EntityKey {
   id: ID!
   type: String!
 }
+enum EntitySource {
+  DATABASE
+  CACHE
+}
 
 type Query {
-  entities(keys: [EntityKey!]!, source: String="database"): [Entity]!
-    @stitch(key: "id", arguments: "keys: { id: $.id, type: $.__typename }, source: 'cache'")
+  entities(keys: [EntityKey!]!, source: EntitySource = DATABASE): [Entity]!
+    @stitch(key: "id", arguments: "keys: { id: $.id, type: $.__typename }, source: CACHE")
 }
 ```
 
@@ -265,6 +269,7 @@ input CustomFieldLookup {
   ownerType: String!
   key: String!
 }
+
 type Query {
   customFields(lookups: [CustomFieldLookup!]!): [CustomField]! @stitch(
     key: "owner { id type } key",
@@ -320,6 +325,7 @@ class StitchingResolver < GraphQL::Schema::Directive
   locations FIELD_DEFINITION
   repeatable true
   argument :key, String, required: true
+  argument :arguments, String, required: false
 end
 
 class Query < GraphQL::Schema::Object
@@ -354,7 +360,7 @@ supergraph = GraphQL::Stitching::Composer.new.perform({
     executable: ->() { ... },
     stitch: [
       { field_name: "productById", key: "id" },
-      { field_name: "productBySku", key: "sku" },
+      { field_name: "productBySku", key: "sku", arguments: "mySku: $.sku" },
     ]
   },
   # ...

data/docs/mechanics.md

@@ -90,7 +90,7 @@ class GraphQlController
       variables: params[:variables],
       operation_name: params[:operation_name]
     )
-  end 
+  end
 end
 ```
 
@@ -345,4 +345,4 @@ type Query {
 }
 ```
 
-In this graph, `Widget` is a merged type without a resolver query in location C. This works because all of its fields are resolvable in other locations; that means location C can provide outbound representations of this type without ever needing to resolve inbound requests for it. Outbound types do still require a shared key field (such as `id` above) that allow them to join with data in other resolver locations (such as `price` above).
+In this graph, `Widget` is a merged type without a resolver query in location C. This works because all of its fields are resolvable in other locations; that means location C can provide outbound representations of this type without ever needing to resolve inbound requests for it. Outbound types do still require a shared key field (such as `id` above) that allow them to join with data in other resolver locations (such as `price` above). Support for this pattern is limited to single-field keys, [composite keys](../README.md#composite-type-keys) require a resolver definition.

data/lib/graphql/stitching/composer/validate_resolvers.rb

@@ -55,8 +55,10 @@ module GraphQL::Stitching
         end
 
         # All locations of a merged type must include at least one resolver key
-        supergraph.fields_by_type_and_location[type.graphql_name].each_key do |location|
-          if resolver_keys.none? { _1.locations.include?(location) }
+        supergraph.fields_by_type_and_location[type.graphql_name].each do |location, field_names|
+          has_resolver_key = resolver_keys.any? { _1.locations.include?(location) }
+          has_primitive_match = resolver_keys.any? { field_names.include?(_1.primitive_name) }
+          unless has_resolver_key || has_primitive_match
             raise ValidationError, "A resolver key is required for `#{type.graphql_name}` in #{location} to join with other locations."
           end
         end

data/lib/graphql/stitching/composer.rb

@@ -557,7 +557,7 @@ module GraphQL
                 argument = if subgraph_field.arguments.size == 1
                   subgraph_field.arguments.values.first
                 else
-                  subgraph_field.arguments[key.default_argument_name]
+                  subgraph_field.arguments[key.primitive_name]
                 end
 
                 unless argument
@@ -565,7 +565,7 @@ module GraphQL
                     "An argument mapping is required for unmatched names and composite keys."
                 end
 
-                "#{argument.graphql_name}: $.#{key.default_argument_name}"
+                "#{argument.graphql_name}: $.#{key.primitive_name}"
               end
 
               arguments = Resolver.parse_arguments_with_field(arguments_format, subgraph_field)

data/lib/graphql/stitching/{shaper.rb → executor/shaper.rb}

@@ -1,8 +1,8 @@
 # typed: false
 # frozen_string_literal: true
 
-module GraphQL
-  module Stitching
+module GraphQL::Stitching
+  class Executor
     # Shapes the final results payload to the request selection and schema definition.
     # This eliminates unrequested export selections and applies null bubbling.
     # @api private

data/lib/graphql/stitching/executor.rb

@@ -3,6 +3,7 @@
 require "json"
 require_relative "./executor/resolver_source"
 require_relative "./executor/root_source"
+require_relative "./executor/shaper"
 
 module GraphQL
   module Stitching
@@ -33,7 +34,7 @@ module GraphQL
         result = {}
 
         if @data && @data.length > 0
-          result["data"] = raw ? @data : GraphQL::Stitching::Shaper.new(@request).perform!(@data)
+          result["data"] = raw ? @data : Shaper.new(@request).perform!(@data)
         end
 
         if @errors.length > 0

data/lib/graphql/stitching/plan.rb

@@ -2,7 +2,7 @@
 
 module GraphQL
   module Stitching
-    # Immutable structures representing a query plan.
+    # Immutable (in theory) structures representing a query plan.
     # May serialize to/from JSON.
     class Plan
       Op = Struct.new(

data/lib/graphql/stitching/{planner_step.rb → planner/step.rb}

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-module GraphQL
-  module Stitching
+module GraphQL::Stitching
+  class Planner
     # A planned step in the sequence of stitching entrypoints together.
     # This is a mutable object that may change throughout the planning process.
     # It ultimately builds an immutable Plan::Op at the end of planning.
-    class PlannerStep
+    class Step
       GRAPHQL_PRINTER = GraphQL::Language::Printer.new
 
       attr_reader :index, :location, :parent_type, :operation_type, :path

data/lib/graphql/stitching/planner.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "./planner/step"
+
 module GraphQL
   module Stitching
     class Planner
@@ -85,7 +87,7 @@ module GraphQL
         end
 
         if step.nil?
-          @steps_by_entrypoint[entrypoint] = PlannerStep.new(
+          @steps_by_entrypoint[entrypoint] = Step.new(
             index: next_index,
             after: parent_index,
             location: location,
@@ -261,7 +263,7 @@ module GraphQL
 
         # 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
+        if requires_typename && !locale_selections.include?(Resolver::TYPENAME_EXPORT_NODE)
           locale_selections << Resolver::TYPENAME_EXPORT_NODE
         end
 
@@ -277,6 +279,10 @@ module GraphQL
             route.reduce(locale_selections) do |parent_selections, resolver|
               # E.1) Add the key of each resolver query into the prior location's selection set.
               parent_selections.push(*resolver.key.export_nodes) if resolver.key
+              parent_selections.uniq! do |node|
+                export_node = node.is_a?(GraphQL::Language::Nodes::Field) && Resolver.export_key?(node.alias)
+                export_node ? node.alias : node
+              end
 
               # E.2) Add a planner step for each new entrypoint location.
               add_step(
@@ -289,8 +295,6 @@ module GraphQL
               ).selections
             end
           end
-
-          locale_selections.uniq! { _1.alias || _1.name }
         end
 
         locale_selections

data/lib/graphql/stitching/resolver/keys.rb

@@ -42,7 +42,7 @@ module GraphQL::Stitching
         to_definition == other.to_definition
       end
 
-      def default_argument_name
+      def primitive_name
         length == 1 ? first.name : nil
       end
 

data/lib/graphql/stitching/resolver.rb

@@ -47,7 +47,7 @@ module GraphQL
       end
 
       def version
-        @version ||= Digest::SHA2.hexdigest(as_json.to_json)
+        @version ||= Digest::SHA2.hexdigest("#{Stitching::VERSION}/#{as_json.to_json}")
       end
 
       def ==(other)

data/lib/graphql/stitching/supergraph.rb

@@ -147,7 +147,11 @@ module GraphQL
       def possible_keys_for_type_and_location(type_name, location)
         possible_keys_by_type = @possible_keys_by_type_and_location[type_name] ||= {}
         possible_keys_by_type[location] ||= possible_keys_for_type(type_name).select do |key|
-          key.locations.include?(location)
+          next true if key.locations.include?(location)
+
+          # Outbound-only locations without resolver queries may dynamically match primitive keys
+          location_fields = fields_by_type_and_location[type_name][location] || GraphQL::Stitching::EMPTY_ARRAY
+          location_fields.include?(key.primitive_name)
         end
       end
 

data/lib/graphql/stitching/version.rb

@@ -2,6 +2,6 @@
 
 module GraphQL
   module Stitching
-    VERSION = "1.4.1"
+    VERSION = "1.4.3"
   end
 end

data/lib/graphql/stitching.rb

@@ -26,16 +26,14 @@ module GraphQL
 end
 
 require_relative "stitching/supergraph"
-require_relative "stitching/resolver"
 require_relative "stitching/client"
 require_relative "stitching/composer"
 require_relative "stitching/executor"
 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/shaper"
+require_relative "stitching/resolver"
 require_relative "stitching/skip_include"
 require_relative "stitching/util"
 require_relative "stitching/version"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-stitching
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.4.3
 platform: ruby
 authors:
 - Greg MacWilliam
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-03 00:00:00.000000000 Z
+date: 2024-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -120,15 +120,15 @@ files:
 - lib/graphql/stitching/executor.rb
 - lib/graphql/stitching/executor/resolver_source.rb
 - lib/graphql/stitching/executor/root_source.rb
+- lib/graphql/stitching/executor/shaper.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/planner/step.rb
 - lib/graphql/stitching/request.rb
 - lib/graphql/stitching/resolver.rb
 - lib/graphql/stitching/resolver/arguments.rb
 - lib/graphql/stitching/resolver/keys.rb
-- lib/graphql/stitching/shaper.rb
 - lib/graphql/stitching/skip_include.rb
 - lib/graphql/stitching/supergraph.rb
 - lib/graphql/stitching/supergraph/key_directive.rb