graphql-stitching 1.4.0 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 448ca61527e02c6f232fa811e7e99ba1aa243bc58685f313ca5613a6724ea306
-  data.tar.gz: a0af76ea7eb429d60f5a7e4df4c39103539a01a69136c769f027cef52a108cab
+  metadata.gz: b81b29cdab4287ba09d6081595b83b4edcc96f0921790483f44d53ff946fb441
+  data.tar.gz: 39c3351dbb4a712aa4f43006017660a961a2056b82b96a5a14b3110b1ecfad44
 SHA512:
-  metadata.gz: 8cea8a8674d67a421059e32778ffc3d1bbd699fa307efe2aead4571925ed77d8da7852431ef99c5809e0106ff16af212c26a6372c211b2d287d3a2c4cef5eb80
-  data.tar.gz: 972f74c60afef0c615d8dc6a3069bb7ddfbe88a84e22a8940d496037ab67f23491c639e8cc3e145b98697c921eb6c20577babec4be2a8e6a3221264e925cdc01
+  metadata.gz: d376c15fa17088797be0b2f7ab42a94cf24050f68b37640aac88cc13a526d56f0ee366290b246e4cc6838a60050b9d9073610366cb7ad5bdb0a9a3435e688dd4
+  data.tar.gz: 6a4fda5651bdd8794f59497e32bb9421c1d3f931a706483b55088597efdc9fe0bb1166dca16a66832c4ded42a21c89de2a7a8f2dc36cfb51bc44cfd40df9c4da

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/planner.rb

@@ -244,6 +244,7 @@ module GraphQL
             fragment = @request.fragment_definitions[node.name]
             next unless @supergraph.locations_by_type[fragment.type.name].include?(current_location)
 
+            requires_typename = true
             fragment_type = @supergraph.memoized_schema_types[fragment.type.name]
             is_same_scope = fragment_type == parent_type
             selection_set = is_same_scope ? locale_selections : []
@@ -251,7 +252,6 @@ module GraphQL
 
             unless is_same_scope
               locale_selections << GraphQL::Language::Nodes::InlineFragment.new(type: fragment.type, selections: selection_set)
-              requires_typename = true
             end
 
           else

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/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.0"
+    VERSION = "1.4.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-stitching
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.2
 platform: ruby
 authors:
 - Greg MacWilliam
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-02 00:00:00.000000000 Z
+date: 2024-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql