graphql-stitching 1.5.2 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf60ae0ef85426a3011223bcc146a74a1664762e5488d8266d0afbf1c2143457
-  data.tar.gz: d20da5d4817193de7e156441cab88b0855f3fa93aeabe5e760f8fd66ac5b3547
+  metadata.gz: 227a7813eed1050c451d9bbee900305cfbac67aff35baa88f6ba9551535d1e97
+  data.tar.gz: 1533e6109c6a72af3f7d07891714c09a73476ca0a5a7ea53d83cbe829564ace3
 SHA512:
-  metadata.gz: b89843bfdd353a6b4aec47fce17a6bd6524b29f7d5fa5dc0452570dc1b4bec63691171f7cd3f841c393015df763e20e1be7cf907cc660fcc576cc93e08c3d4dd
-  data.tar.gz: a20f68f8bac0a52271fdc76ec4f173347669acda7f49b18e177746c83df1ec42dc878e8d3af37545a99f5456acc6d9f7577600d79c4568925cd23837fe5c2d0a
+  metadata.gz: 8342158a10bc25fb68c833a3366c2fd6e831cf86cccf15a2491067680bb5299700783af57fd5042b394131b48759f077d32f4b210149a2b3cb34e43e3cca77ff
+  data.tar.gz: 7313c93bb8cedf7ac06708a1f7fba6a2c46196982380a28a6d9244cf7320ad0149cb17df8ecb1abe438e14eac08b2f71e154dd9f2d6c3095be8e849c46061e16

data/docs/request.md

@@ -15,7 +15,6 @@ request = GraphQL::Stitching::Request.new(
 
 A `Request` provides the following information:
 
-- `req.document`: parsed AST of the GraphQL source.
 - `req.variables`: a hash of user-submitted variables.
 - `req.string`: the original GraphQL source string, or printed document.
 - `req.digest`: a digest of the request string, hashed by the `Stitching.digest` implementation.
@@ -31,6 +30,5 @@ A request manages the flow of stitching behaviors. These are sequenced by the `C
 component, or you may invoke them manually:
 
 1. `request.validate`: runs static validations on the request using the combined schema.
-2. `request.prepare!`: inserts variable defaults and pre-renders skip/include conditional shaping.
-3. `request.plan`: builds a plan for the request. May act as a setter for plans pulled from cache.
-4. `request.execute`: executes the request, and returns the resulting data.
+2. `request.plan`: builds a plan for the request. May act as a setter for plans pulled from cache.
+3. `request.execute`: executes the request, and returns the resulting data.

data/lib/graphql/stitching/client.rb

@@ -45,7 +45,6 @@ module GraphQL
           return error_result(request, validation_errors) if validation_errors.any?
         end
 
-        request.prepare!
         load_plan(request)
         request.execute
       rescue GraphQL::ParseError, GraphQL::ExecutionError => e

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

@@ -14,7 +14,7 @@ module GraphQL::Stitching
       end
 
       def perform!(raw)
-        @root_type = @supergraph.schema.root_type_for_operation(@request.operation.operation_type)
+        @root_type = @request.query.root_type_for_operation(@request.operation.operation_type)
         resolve_object_scope(raw, @root_type, @request.operation.selections, @root_type.graphql_name)
       end
 
@@ -118,7 +118,7 @@ module GraphQL::Stitching
       def typename_in_type?(typename, type)
         return true if type.graphql_name == typename
 
-        type.kind.abstract? && @supergraph.schema.possible_types(type).any? do |t|
+        type.kind.abstract? && @request.query.possible_types(type).any? do |t|
           t.graphql_name == typename
         end
       end

data/lib/graphql/stitching/http_executable.rb

@@ -132,7 +132,7 @@ module GraphQL
         elsif @upload_types.include?(ast_node.name)
           files_by_path[path.dup] = value
         else
-          type_def = request.supergraph.schema.get_type(ast_node.name)
+          type_def = request.query.get_type(ast_node.name)
           extract_type_node(type_def, value, files_by_path, path) if type_def&.kind&.input_object?
         end
       end

data/lib/graphql/stitching/planner.rb

@@ -106,7 +106,7 @@ module GraphQL
 
       # A) Group all root selections by their preferred entrypoint locations.
       def build_root_entrypoints
-        parent_type = @supergraph.schema.root_type_for_operation(@request.operation.operation_type)
+        parent_type = @request.query.root_type_for_operation(@request.operation.operation_type)
 
         case @request.operation.operation_type
         when QUERY_OP
@@ -331,7 +331,7 @@ module GraphQL
         end
 
         if expanded_selections
-          @supergraph.schema.possible_types(parent_type).each do |possible_type|
+          @request.query.possible_types(parent_type).each do |possible_type|
             next unless @supergraph.locations_by_type[possible_type.graphql_name].include?(current_location)
 
             type_name = GraphQL::Language::Nodes::TypeName.new(name: possible_type.graphql_name)

data/lib/graphql/stitching/request.rb

@@ -14,26 +14,21 @@ module GraphQL
       # @return [Supergraph] supergraph instance that resolves the request.
       attr_reader :supergraph
 
-      # @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 [GraphQL::Query] query object defining the request.
+      attr_reader :query
 
       # @return [Hash] contextual object passed through resolver flows.
       attr_reader :context
 
       # 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 source [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)
+      def initialize(supergraph, source, operation_name: nil, variables: nil, context: nil)
         @supergraph = supergraph
+        @prepared_document = nil
         @string = nil
         @digest = nil
         @normalized_string = nil
@@ -44,29 +39,32 @@ module GraphQL
         @fragment_definitions = nil
         @plan = nil
 
-        @document = if document.is_a?(String)
-          @string = document
-          GraphQL.parse(document)
+        params = {
+          operation_name: operation_name,
+          variables: variables,
+          context: context,
+        }
+
+        if source.is_a?(String)
+          @string = source
+          params[:query] = source
         else
-          document
+          params[:document] = source
         end
 
-        @operation_name = operation_name
-        @variables = variables || {}
-
-        @query = GraphQL::Query.new(@supergraph.schema, document: @document, context: context)
+        @query = GraphQL::Query.new(@supergraph.schema, **params)
         @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
+        with_prepared_document { @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
+        @normalized_string ||= prepared_document.to_query_string
       end
 
       # @return [String] a digest of the original document string. Generally faster but less consistent.
@@ -81,43 +79,48 @@ module GraphQL
 
       # @return [GraphQL::Language::Nodes::OperationDefinition] The selected root operation for the request.
       def operation
-        @operation ||= begin
-          operation_defs = @document.definitions.select do |d|
+        @operation ||= with_prepared_document do
+          selected_op = @query.selected_operation
+          raise GraphQL::ExecutionError, "No operation selected" unless selected_op
+
+          @prepared_document.definitions.find do |d|
             next unless d.is_a?(GraphQL::Language::Nodes::OperationDefinition)
-            @operation_name ? d.name == @operation_name : true
-          end
 
-          if operation_defs.length < 1
-            raise GraphQL::ExecutionError, "Invalid root operation for given name and operation type."
-          elsif operation_defs.length > 1
-            raise GraphQL::ExecutionError, "An operation name is required when sending multiple operations."
+            selected_op.name.nil? || d.name == selected_op.name
           end
+        end
+      end
 
-          operation_defs.first
+      def operation_name
+        operation.name
+      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
+          operation.directives.map { printer.print(_1) }.join(" ")
         end
       end
 
       # @return [Boolean] true if operation type is a query
       def query?
-        operation.operation_type == QUERY_OP
+        @query.query?
       end
 
       # @return [Boolean] true if operation type is a mutation
       def mutation?
-        operation.operation_type == MUTATION_OP
+        @query.mutation?
       end
 
       # @return [Boolean] true if operation type is a subscription
       def subscription?
-        operation.operation_type == SUBSCRIPTION_OP
+        @query.subscription?
       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
-          operation.directives.map { printer.print(_1) }.join(" ")
-        end
+      # @return [Hash<String, Any>] provided variables hash filled in with default values from definitions
+      def variables
+        @variables || with_prepared_document { @variables }
       end
 
       # @return [Hash<String, GraphQL::Language::Nodes::AbstractNode>] map of variable names to AST type definitions.
@@ -129,7 +132,7 @@ module GraphQL
 
       # @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|
+        @fragment_definitions ||= prepared_document.definitions.each_with_object({}) do |d, memo|
           memo[d.name] = d if d.is_a?(GraphQL::Language::Nodes::FragmentDefinition)
         end
       end
@@ -137,26 +140,7 @@ module GraphQL
       # Validates the request using the combined supergraph schema.
       # @return [Array<GraphQL::ExecutionError>] an array of static validation errors
       def validate
-        result = @supergraph.schema.static_validator.validate(@query)
-        result[:errors]
-      end
-
-      # Prepares the request for stitching by inserting 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?
-        end
-
-        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 = @plan = nil
-          end
-        end
-
-        self
+        @query.static_errors
       end
 
       # Gets and sets the query plan for the request. Assigned query plans may pull from a cache,
@@ -191,6 +175,27 @@ module GraphQL
 
       private
 
+      # Prepares the request for stitching by applying @skip/@include conditionals.
+      def prepared_document
+        @prepared_document || with_prepared_document { @prepared_document }
+      end
+
+      def with_prepared_document
+        unless @prepared_document
+          @variables = @query.variables.to_h
+
+          @prepared_document = if @string.nil? || @string.match?(SKIP_INCLUDE_DIRECTIVE)
+            changed = false
+            doc = SkipInclude.render(@query.document, @variables) { changed = true }
+            @string = @normalized_string = doc.to_query_string if changed
+            doc
+          else
+            @query.document
+          end
+        end
+        yield
+      end
+
       # Adds a handler into context for enriching subscription updates with stitched data
       def add_subscription_update_handler
         request = self

data/lib/graphql/stitching/version.rb

@@ -2,6 +2,6 @@
 
 module GraphQL
   module Stitching
-    VERSION = "1.5.2"
+    VERSION = "1.6.0"
   end
 end

metadata

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