graphql-stitching 1.1.1 → 1.2.1

data/lib/graphql/stitching/request.rb

@@ -6,9 +6,32 @@ module GraphQL
       SUPPORTED_OPERATIONS = ["query", "mutation"].freeze
       SKIP_INCLUDE_DIRECTIVE = /@(?:skip|include)/
 
-      attr_reader :document, :variables, :operation_name, :context
+      # @return [Supergraph] supergraph instance that resolves the request.
+      attr_reader :supergraph
 
-      def initialize(document, operation_name: nil, variables: nil, context: nil)
+      # @return [GraphQL::Language::Nodes::Document] the parsed GraphQL AST document.
+      attr_reader :document
+
+      # @return [Hash] input variables for the request.
+      attr_reader :variables
+
+      # @return [String] operation name selected for the request.
+      attr_reader :operation_name
+
+      # @return [Hash] contextual object passed through resolver flows.
+      attr_reader :context
+
+      # @return [GraphQL::Schema::Warden] a visibility warden for this request.
+      attr_reader :warden
+
+      # Creates a new supergraph request.
+      # @param supergraph [Supergraph] supergraph instance that resolves the request.
+      # @param document [String, GraphQL::Language::Nodes::Document] the request string or parsed AST.
+      # @param operation_name [String, nil] operation name selected for the request.
+      # @param variables [Hash, nil] input variables for the request.
+      # @param context [Hash, nil] a contextual object passed through resolver flows.
+      def initialize(supergraph, document, operation_name: nil, variables: nil, context: nil)
+        @supergraph = supergraph
         @string = nil
         @digest = nil
         @normalized_string = nil
@@ -17,6 +40,7 @@ module GraphQL
         @operation_directives = nil
         @variable_definitions = nil
         @fragment_definitions = nil
+        @plan = nil
 
         @document = if document.is_a?(String)
           @string = document
@@ -27,25 +51,34 @@ module GraphQL
 
         @operation_name = operation_name
         @variables = variables || {}
-        @context = context || GraphQL::Stitching::EMPTY_OBJECT
+
+        @query = GraphQL::Query.new(@supergraph.schema, document: @document, context: context)
+        @warden = @query.warden
+        @context = @query.context
+        @context[:request] = self
       end
 
+      # @return [String] the original document string, or a print of the parsed AST document.
       def string
         @string || normalized_string
       end
 
+      # @return [String] a print of the parsed AST document with consistent whitespace.
       def normalized_string
         @normalized_string ||= @document.to_query_string
       end
 
+      # @return [String] a digest of the original document string. Generally faster but less consistent.
       def digest
         @digest ||= Digest::SHA2.hexdigest(string)
       end
 
+      # @return [String] a digest of the normalized document string. Slower but more consistent.
       def normalized_digest
         @normalized_digest ||= Digest::SHA2.hexdigest(normalized_string)
       end
 
+      # @return [GraphQL::Language::Nodes::OperationDefinition] The selected root operation for the request.
       def operation
         @operation ||= begin
           operation_defs = @document.definitions.select do |d|
@@ -64,6 +97,7 @@ module GraphQL
         end
       end
 
+      # @return [String] A string of directives applied to the root operation. These are passed through in all subgraph requests.
       def operation_directives
         @operation_directives ||= if operation.directives.any?
           printer = GraphQL::Language::Printer.new
@@ -71,18 +105,27 @@ module GraphQL
         end
       end
 
+      # @return [Hash<String, GraphQL::Language::Nodes::AbstractNode>] map of variable names to AST type definitions.
       def variable_definitions
         @variable_definitions ||= operation.variables.each_with_object({}) do |v, memo|
           memo[v.name] = v.type
         end
       end
 
+      # @return [Hash<String, GraphQL::Language::Nodes::FragmentDefinition>] map of fragment names to their AST definitions.
       def fragment_definitions
         @fragment_definitions ||= @document.definitions.each_with_object({}) do |d, memo|
           memo[d.name] = d if d.is_a?(GraphQL::Language::Nodes::FragmentDefinition)
         end
       end
 
+      # Validates the request using the combined supergraph schema.
+      def validate
+        result = @supergraph.static_validator.validate(@query)
+        result[:errors]
+      end
+
+      # Prepares the request for stitching by rendering variable defaults and applying @skip/@include conditionals.
       def prepare!
         operation.variables.each do |v|
           @variables[v.name] = v.default_value if @variables[v.name].nil? && !v.default_value.nil?
@@ -93,12 +136,31 @@ module GraphQL
             @document = modified_ast
             @string = @normalized_string = nil
             @digest = @normalized_digest = nil
-            @operation = @operation_directives = @variable_definitions = nil
+            @operation = @operation_directives = @variable_definitions = @plan = nil
           end
         end
 
         self
       end
+
+      # Gets and sets the query plan for the request. Assigned query plans may pull from cache.
+      # @param new_plan [Plan, nil] a cached query plan for the request.
+      # @return [Plan] query plan for the request.
+      def plan(new_plan = nil)
+        if new_plan
+          raise StitchingError, "Plan must be a `GraphQL::Stitching::Plan`." unless new_plan.is_a?(Plan)
+          @plan = new_plan
+        else
+          @plan ||= GraphQL::Stitching::Planner.new(self).perform
+        end
+      end
+
+      # Executes the request and returns the rendered response.
+      # @param raw [Boolean] specifies the result should be unshaped without pruning or null bubbling. Useful for debugging.
+      # @return [Hash] the rendered GraphQL response with "data" and "errors" sections.
+      def execute(raw: false)
+        GraphQL::Stitching::Executor.new(self).perform(raw: raw)
+      end
     end
   end
 end

data/lib/graphql/stitching/shaper.rb

@@ -5,10 +5,11 @@ module GraphQL
   module Stitching
     # Shapes the final results payload to the request selection and schema definition.
     # This eliminates unrequested export selections and applies null bubbling.
+    # @api private
     class Shaper
-      def initialize(supergraph:, request:)
-        @supergraph = supergraph
+      def initialize(request)
         @request = request
+        @supergraph = request.supergraph
         @root_type = nil
       end
 
@@ -117,7 +118,7 @@ module GraphQL
       def typename_in_type?(typename, type)
         return true if type.graphql_name == typename
 
-        type.kind.abstract? && @supergraph.memoized_schema_possible_types(type.graphql_name).any? do |t|
+        type.kind.abstract? && @request.warden.possible_types(type).any? do |t|
           t.graphql_name == typename
         end
       end

data/lib/graphql/stitching/skip_include.rb

@@ -2,11 +2,12 @@
 
 module GraphQL
   module Stitching
+    # Faster implementation of an AST visitor for prerendering
+    # @skip and @include conditional directives into a document.
+    # This avoids unnecessary planning steps, and prepares result shaping.
+    # @api private
     class SkipInclude
       class << self
-        # Faster implementation of an AST visitor for prerendering
-        # @skip and @include conditional directives into a document.
-        # This avoids unnecessary planning steps, and prepares result shaping.
         def render(document, variables)
           changed = false
           definitions = document.definitions.map do |original_definition|

data/lib/graphql/stitching/supergraph/resolver_directive.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module GraphQL::Stitching
+  class Supergraph
+    class ResolverDirective < GraphQL::Schema::Directive
+      graphql_name "resolver"
+      locations OBJECT, INTERFACE, UNION
+      argument :location, String, required: true
+      argument :key, String, required: true
+      argument :field, String, required: true
+      argument :arg, String, required: true
+      argument :list, Boolean, required: false
+      argument :federation, Boolean, required: false
+      repeatable true
+    end
+  end
+end

data/lib/graphql/stitching/supergraph/source_directive.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module GraphQL::Stitching
+  class Supergraph
+    class SourceDirective < GraphQL::Schema::Directive
+      graphql_name "source"
+      locations FIELD_DEFINITION
+      argument :location, String, required: true
+      repeatable true
+    end
+  end
+end

data/lib/graphql/stitching/supergraph.rb

@@ -1,29 +1,13 @@
 # frozen_string_literal: true
 
+require_relative "./supergraph/resolver_directive"
+require_relative "./supergraph/source_directive"
+
 module GraphQL
   module Stitching
     class Supergraph
       SUPERGRAPH_LOCATION = "__super"
 
-      class ResolverDirective < GraphQL::Schema::Directive
-        graphql_name "resolver"
-        locations OBJECT, INTERFACE, UNION
-        argument :location, String, required: true
-        argument :key, String, required: true
-        argument :field, String, required: true
-        argument :arg, String, required: true
-        argument :list, Boolean, required: false
-        argument :federation, Boolean, required: false
-        repeatable true
-      end
-
-      class SourceDirective < GraphQL::Schema::Directive
-        graphql_name "source"
-        locations FIELD_DEFINITION
-        argument :location, String, required: true
-        repeatable true
-      end
-
       class << self
         def validate_executable!(location, executable)
           return true if executable.is_a?(Class) && executable <= GraphQL::Schema
@@ -88,19 +72,27 @@ module GraphQL
         end
       end
 
-      attr_reader :schema, :boundaries, :locations_by_type_and_field, :executables
+      # @return [GraphQL::Schema] the composed schema for the supergraph.
+      attr_reader :schema
+
+      # @return [Hash<String, Executable>] a map of executable resources by location.
+      attr_reader :executables
 
-      def initialize(schema:, fields:, boundaries:, executables:)
+      attr_reader :boundaries, :locations_by_type_and_field
+
+      def initialize(schema:, fields: {}, boundaries: {}, executables: {})
         @schema = schema
+        @schema.use(GraphQL::Schema::AlwaysVisible)
+
         @boundaries = boundaries
-        @possible_keys_by_type = {}
-        @possible_keys_by_type_and_location = {}
-        @memoized_schema_possible_types = {}
-        @memoized_schema_fields = {}
-        @memoized_introspection_types = nil
-        @memoized_schema_types = nil
         @fields_by_type_and_location = nil
         @locations_by_type = nil
+        @memoized_introspection_types = nil
+        @memoized_schema_fields = {}
+        @memoized_schema_types = nil
+        @possible_keys_by_type = {}
+        @possible_keys_by_type_and_location = {}
+        @static_validator = nil
 
         # add introspection types into the fields mapping
         @locations_by_type_and_field = memoized_introspection_types.each_with_object(fields) do |(type_name, type), memo|
@@ -172,6 +164,11 @@ module GraphQL
         @schema.to_definition
       end
 
+      # @return [GraphQL::StaticValidation::Validator] static validator for the supergraph schema.
+      def static_validator
+        @static_validator ||= @schema.static_validator
+      end
+
       def fields
         @locations_by_type_and_field.reject { |k, _v| memoized_introspection_types[k] }
       end
@@ -188,10 +185,6 @@ module GraphQL
         @memoized_schema_types ||= @schema.types
       end
 
-      def memoized_schema_possible_types(type_name)
-        @memoized_schema_possible_types[type_name] ||= @schema.possible_types(memoized_schema_types[type_name])
-      end
-
       def memoized_schema_fields(type_name)
         @memoized_schema_fields[type_name] ||= begin
           fields = memoized_schema_types[type_name].fields
@@ -209,7 +202,7 @@ module GraphQL
         end
       end
 
-      def execute_at_location(location, source, variables, context)
+      def execute_at_location(location, source, variables, request)
         executable = executables[location]
 
         if executable.nil?
@@ -218,11 +211,11 @@ module GraphQL
           executable.execute(
             query: source,
             variables: variables,
-            context: context.frozen? ? context.dup : context,
+            context: request.context.frozen? ? request.context.dup : request.context,
             validate: false,
           )
         elsif executable.respond_to?(:call)
-          executable.call(location, source, variables, context)
+          executable.call(request, source, variables)
         else
           raise StitchingError, "Missing valid executable for #{location} location."
         end

data/lib/graphql/stitching/util.rb

@@ -12,16 +12,7 @@ module GraphQL
         end
       end
 
-      GRAPHQL_VERSION = GraphQL::VERSION.split(".").map(&:to_i).freeze
-
       class << self
-        def graphql_version?(major, minor = nil, patch = nil)
-          result = GRAPHQL_VERSION[0] >= major
-          result &&= GRAPHQL_VERSION[1] >= minor if minor
-          result &&= GRAPHQL_VERSION[2] >= patch if patch
-          result
-        end
-
         # specifies if a type is a primitive leaf value
         def is_leaf_type?(type)
           type.kind.scalar? || type.kind.enum?

data/lib/graphql/stitching/version.rb

@@ -2,6 +2,6 @@
 
 module GraphQL
   module Stitching
-    VERSION = "1.1.1"
+    VERSION = "1.2.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-stitching
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.1
 platform: ruby
 authors:
 - Greg MacWilliam
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-26 00:00:00.000000000 Z
+date: 2024-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -74,15 +74,16 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/ci.yml"
 - ".gitignore"
+- ".yardopts"
 - Gemfile
 - LICENSE
-- Procfile
 - README.md
 - Rakefile
 - docs/README.md
 - docs/client.md
 - docs/composer.md
 - docs/executor.md
+- docs/http_executable.md
 - docs/images/library.png
 - docs/images/merging.png
 - docs/images/stitching.png
@@ -90,10 +91,20 @@ files:
 - docs/planner.md
 - docs/request.md
 - docs/supergraph.md
-- example/gateway.rb
-- example/graphiql.html
-- example/remote1.rb
-- example/remote2.rb
+- examples/file_uploads/Gemfile
+- examples/file_uploads/Procfile
+- examples/file_uploads/README.md
+- examples/file_uploads/file.txt
+- examples/file_uploads/gateway.rb
+- examples/file_uploads/helpers.rb
+- examples/file_uploads/remote.rb
+- examples/merged_types/Gemfile
+- examples/merged_types/Procfile
+- examples/merged_types/README.md
+- examples/merged_types/gateway.rb
+- examples/merged_types/graphiql.html
+- examples/merged_types/remote1.rb
+- examples/merged_types/remote2.rb
 - gemfiles/graphql_1.13.9.gemfile
 - graphql-stitching.gemspec
 - lib/graphql/stitching.rb
@@ -115,6 +126,8 @@ files:
 - lib/graphql/stitching/shaper.rb
 - lib/graphql/stitching/skip_include.rb
 - lib/graphql/stitching/supergraph.rb
+- lib/graphql/stitching/supergraph/resolver_directive.rb
+- lib/graphql/stitching/supergraph/source_directive.rb
 - lib/graphql/stitching/util.rb
 - lib/graphql/stitching/version.rb
 homepage: https://github.com/gmac/graphql-stitching-ruby

data/Procfile

@@ -1,3 +0,0 @@
-gateway: bundle exec ruby example/gateway.rb
-remote1: bundle exec ruby example/remote1.rb
-remote2: bundle exec ruby example/remote2.rb

data/example/remote1.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-require 'rackup'
-require 'json'
-require 'graphql'
-require_relative '../test/schemas/example'
-
-class FirstRemoteApp
-  def call(env)
-    req = Rack::Request.new(env)
-    case req.path_info
-    when /graphql/
-      params = JSON.parse(req.body.read)
-      result = Schemas::Example::Storefronts.execute(
-        query: params["query"],
-        variables: params["variables"],
-        operation_name: params["operationName"],
-      )
-      [200, {"content-type" => "application/json"}, [JSON.generate(result)]]
-    else
-      [404, {"content-type" => "text/html"}, ["not found"]]
-    end
-  end
-end
-
-Rackup::Handler.default.run(FirstRemoteApp.new, :Port => 3001)

data/example/remote2.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-require 'rackup'
-require 'json'
-require 'graphql'
-require_relative '../test/schemas/example'
-
-class SecondRemoteApp
-  def call(env)
-    req = Rack::Request.new(env)
-    case req.path_info
-    when /graphql/
-      params = JSON.parse(req.body.read)
-      result = Schemas::Example::Manufacturers.execute(
-        query: params["query"],
-        variables: params["variables"],
-        operation_name: params["operationName"],
-      )
-      [200, {"content-type" => "application/json"}, [JSON.generate(result)]]
-    else
-      [404, {"content-type" => "text/html"}, ["not found"]]
-    end
-  end
-end
-
-Rackup::Handler.default.run(SecondRemoteApp.new, :Port => 3002)