graphql-stitching 1.2.5 → 1.4.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-stitching
 version: !ruby/object:Gem::Version
-  version: 1.2.5
+  version: 1.4.0
 platform: ruby
 authors:
 - Greg MacWilliam
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-31 00:00:00.000000000 Z
+date: 2024-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -89,6 +89,7 @@ files:
 - docs/images/stitching.png
 - docs/mechanics.md
 - docs/request.md
+- docs/resolver.md
 - docs/supergraph.md
 - examples/file_uploads/Gemfile
 - examples/file_uploads/Procfile
@@ -110,27 +111,30 @@ files:
 - gemfiles/graphql_2.2.0.gemfile
 - graphql-stitching.gemspec
 - lib/graphql/stitching.rb
-- lib/graphql/stitching/boundary.rb
 - lib/graphql/stitching/client.rb
 - lib/graphql/stitching/composer.rb
 - lib/graphql/stitching/composer/base_validator.rb
-- lib/graphql/stitching/composer/boundary_config.rb
-- lib/graphql/stitching/composer/validate_boundaries.rb
+- lib/graphql/stitching/composer/resolver_config.rb
 - lib/graphql/stitching/composer/validate_interfaces.rb
+- lib/graphql/stitching/composer/validate_resolvers.rb
 - lib/graphql/stitching/executor.rb
-- lib/graphql/stitching/executor/boundary_source.rb
+- lib/graphql/stitching/executor/resolver_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/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
 - lib/graphql/stitching/supergraph/resolver_directive.rb
 - lib/graphql/stitching/supergraph/source_directive.rb
+- lib/graphql/stitching/supergraph/to_definition.rb
 - lib/graphql/stitching/util.rb
 - lib/graphql/stitching/version.rb
 homepage: https://github.com/gmac/graphql-stitching-ruby

data/lib/graphql/stitching/boundary.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module GraphQL
-  module Stitching
-    # Defines a boundary query that provides direct access to an entity type.
-    Boundary = Struct.new(
-      :location,
-      :type_name,
-      :key,
-      :field,
-      :arg,
-      :list,
-      :federation,
-      keyword_init: true
-    ) do
-      def as_json
-        {
-          location: location,
-          type_name: type_name,
-          key: key,
-          field: field,
-          arg: arg,
-          list: list,
-          federation: federation,
-        }.tap(&:compact!)
-      end
-    end
-  end
-end

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

@@ -1,96 +0,0 @@
-# frozen_string_literal: true
-
-module GraphQL::Stitching
-  class Composer
-    class ValidateBoundaries < BaseValidator
-
-      def perform(supergraph, composer)
-        supergraph.schema.types.each do |type_name, type|
-          # objects and interfaces that are not the root operation types
-          next unless type.kind.object? || type.kind.interface?
-          next if supergraph.schema.query == type || supergraph.schema.mutation == type
-          next if type.graphql_name.start_with?("__")
-
-          # multiple subschemas implement the type
-          candidate_types_by_location = composer.candidate_types_by_name_and_location[type_name]
-          next unless candidate_types_by_location.length > 1
-
-          boundaries = supergraph.boundaries[type_name]
-          if boundaries&.any?
-            validate_as_boundary(supergraph, type, candidate_types_by_location, boundaries)
-          elsif type.kind.object?
-            validate_as_shared(supergraph, type, candidate_types_by_location)
-          end
-        end
-      end
-
-      private
-
-      def validate_as_boundary(supergraph, type, candidate_types_by_location, boundaries)
-        # abstract boundaries are expanded with their concrete implementations, which each get validated. Ignore the abstract itself.
-        return if type.kind.abstract?
-
-        # only one boundary allowed per type/location/key
-        boundaries_by_location_and_key = boundaries.each_with_object({}) do |boundary, memo|
-          if memo.dig(boundary.location, boundary.key)
-            raise Composer::ValidationError, "Multiple boundary queries for `#{type.graphql_name}.#{boundary.key}` "\
-              "found in #{boundary.location}. Limit one boundary query per type and key in each location. "\
-              "Abstract boundaries provide all possible types."
-          end
-          memo[boundary.location] ||= {}
-          memo[boundary.location][boundary.key] = boundary
-        end
-
-        boundary_keys = boundaries.map(&:key).to_set
-
-        # All non-key fields must be resolvable in at least one boundary location
-        supergraph.locations_by_type_and_field[type.graphql_name].each do |field_name, locations|
-          next if boundary_keys.include?(field_name)
-
-          if locations.none? { boundaries_by_location_and_key[_1] }
-            where = locations.length > 1 ? "one of #{locations.join(", ")} locations" : locations.first
-            raise Composer::ValidationError, "A boundary query is required for `#{type.graphql_name}` in #{where} to resolve field `#{field_name}`."
-          end
-        end
-
-        # All locations of a boundary type must include at least one key field
-        supergraph.fields_by_type_and_location[type.graphql_name].each do |location, field_names|
-          if field_names.none? { boundary_keys.include?(_1) }
-            raise Composer::ValidationError, "A boundary key is required for `#{type.graphql_name}` in #{location} to join with other locations."
-          end
-        end
-
-        # verify that all outbound locations can access all inbound locations
-        resolver_locations = boundaries_by_location_and_key.keys
-        candidate_types_by_location.each_key do |location|
-          remote_locations = resolver_locations.reject { _1 == location }
-          paths = supergraph.route_type_to_locations(type.graphql_name, location, remote_locations)
-          if paths.length != remote_locations.length || paths.any? { |_loc, path| path.nil? }
-            raise Composer::ValidationError, "Cannot route `#{type.graphql_name}` boundaries in #{location} to all other locations. "\
-              "All locations must provide a boundary accessor that uses a conjoining key."
-          end
-        end
-      end
-
-      def validate_as_shared(supergraph, type, candidate_types_by_location)
-        expected_fields = begin
-          type.fields.keys.sort
-        rescue StandardError => e
-          # bug with inherited interfaces in older versions of GraphQL
-          if type.interfaces.any? { _1.is_a?(GraphQL::Schema::LateBoundType) }
-            raise Composer::ComposerError, "Merged interface inheritance requires GraphQL >= v2.0.3"
-          else
-            raise e
-          end
-        end
-
-        candidate_types_by_location.each do |location, candidate_type|
-          if candidate_type.fields.keys.sort != expected_fields
-            raise Composer::ValidationError, "Shared type `#{type.graphql_name}` must have consistent fields across locations, "\
-              "or else define boundary queries so that its unique fields may be accessed remotely."
-          end
-        end
-      end
-    end
-  end
-end

data/lib/graphql/stitching/export_selection.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-module GraphQL
-  module Stitching
-    # Builds hidden selection fields added by stitiching code,
-    # used to request operational data about resolved objects.
-    class ExportSelection
-      EXPORT_PREFIX = "_export_"
-
-      class << self
-        @typename_node = nil
-
-        def key?(name)
-          return false unless name
-
-          name.start_with?(EXPORT_PREFIX)
-        end
-
-        def key(name)
-          "#{EXPORT_PREFIX}#{name}"
-        end
-
-        # The argument assigning Field.alias changed from
-        # a generic `alias` hash key to a structured `field_alias` kwarg.
-        # See https://github.com/rmosolgo/graphql-ruby/pull/4718
-        FIELD_ALIAS_KWARG = !GraphQL::Language::Nodes::Field.new(field_alias: "a").alias.nil?
-
-        def key_node(field_name)
-          if FIELD_ALIAS_KWARG
-            GraphQL::Language::Nodes::Field.new(field_alias: key(field_name), name: field_name)
-          else
-            GraphQL::Language::Nodes::Field.new(alias: key(field_name), name: field_name)
-          end
-        end
-
-        def typename_node
-          @typename_node ||= key_node("__typename")
-        end
-      end
-    end
-  end
-end