graphql 1.12.12 → 2.4.8

data/lib/graphql/query/context.rb

@@ -1,84 +1,10 @@
 # frozen_string_literal: true
+
 module GraphQL
   class Query
     # Expose some query-specific info to field resolve functions.
     # It delegates `[]` to the hash that's passed to `GraphQL::Query#initialize`.
     class Context
-      module SharedMethods
-        # @return [Object] The target for field resolution
-        attr_accessor :object
-
-        # @return [Hash, Array, String, Integer, Float, Boolean, nil] The resolved value for this field
-        attr_reader :value
-
-        # @return [Boolean] were any fields of this selection skipped?
-        attr_reader :skipped
-        alias :skipped? :skipped
-
-        # @api private
-        attr_writer :skipped
-
-        # Return this value to tell the runtime
-        # to exclude this field from the response altogether
-        def skip
-          GraphQL::Execution::Execute::SKIP
-        end
-
-        # @return [Boolean] True if this selection has been nullified by a null child
-        def invalid_null?
-          @invalid_null
-        end
-
-        # Remove this child from the result value
-        # (used for null propagation and skip)
-        # @api private
-        def delete_child(child_ctx)
-          @value.delete(child_ctx.key)
-        end
-
-        # Create a child context to use for `key`
-        # @param key [String, Integer] The key in the response (name or index)
-        # @param irep_node [InternalRepresentation::Node] The node being evaluated
-        # @api private
-        def spawn_child(key:, irep_node:, object:)
-          FieldResolutionContext.new(
-            @context,
-            key,
-            irep_node,
-            self,
-            object
-          )
-        end
-
-        # Add error at query-level.
-        # @param error [GraphQL::ExecutionError] an execution error
-        # @return [void]
-        def add_error(error)
-          if !error.is_a?(ExecutionError)
-            raise TypeError, "expected error to be a ExecutionError, but was #{error.class}"
-          end
-          errors << error
-          nil
-        end
-
-        # @example Print the GraphQL backtrace during field resolution
-        #   puts ctx.backtrace
-        #
-        # @return [GraphQL::Backtrace] The backtrace for this point in query execution
-        def backtrace
-          GraphQL::Backtrace.new(self)
-        end
-
-        def execution_errors
-          @execution_errors ||= ExecutionErrors.new(self)
-        end
-
-        def lookahead
-          ast_nodes = irep_node.ast_nodes
-          field = irep_node.definition.metadata[:type_class] || raise("Lookahead is only compatible with class-based schemas")
-          Execution::Lookahead.new(query: query, ast_nodes: ast_nodes, field: field)
-        end
-      end
 
       class ExecutionErrors
         def initialize(ctx)
@@ -102,30 +28,8 @@ module GraphQL
         alias :push :add
       end
 
-      include SharedMethods
       extend Forwardable
 
-      attr_reader :execution_strategy
-      # `strategy` is required by GraphQL::Batch
-      alias_method :strategy, :execution_strategy
-
-      def execution_strategy=(new_strategy)
-        # GraphQL::Batch re-assigns this value but it was previously not used
-        # (ExecutionContext#strategy was used instead)
-        # now it _is_ used, but it breaks GraphQL::Batch tests
-        @execution_strategy ||= new_strategy
-      end
-
-      # @return [GraphQL::InternalRepresentation::Node] The internal representation for this query node
-      def irep_node
-        @irep_node ||= query.irep_selection
-      end
-
-      # @return [GraphQL::Language::Nodes::Field] The AST node for the currently-executing field
-      def ast_node
-        @irep_node.ast_node
-      end
-
       # @return [Array<GraphQL::ExecutionError>] errors returned during execution
       attr_reader :errors
 
@@ -141,23 +45,27 @@ module GraphQL
       # Make a new context which delegates key lookup to `values`
       # @param query [GraphQL::Query] the query who owns this context
       # @param values [Hash] A hash of arbitrary values which will be accessible at query-time
-      def initialize(query:, schema: query.schema, values:, object:)
+      def initialize(query:, schema: query.schema, values:)
         @query = query
         @schema = schema
         @provided_values = values || {}
-        @object = object
         # Namespaced storage, where user-provided values are in `nil` namespace:
         @storage = Hash.new { |h, k| h[k] = {} }
         @storage[nil] = @provided_values
         @errors = []
         @path = []
         @value = nil
-        @context = self # for SharedMethods
-        @scoped_context = {}
+        @context = self # for SharedMethods TODO delete sharedmethods
+        @scoped_context = ScopedContext.new(self)
+      end
+
+      # @return [Hash] A hash that will be added verbatim to the result hash, as `"extensions" => { ... }`
+      def response_extensions
+        namespace(:__query_result_extensions__)
       end
 
       def dataloader
-        @dataloader ||= query.multiplex ? query.multiplex.dataloader : schema.dataloader_class.new
+        @dataloader ||= self[:dataloader] || (query.multiplex ? query.multiplex.dataloader : schema.dataloader_class.new)
       end
 
       # @api private
@@ -167,21 +75,85 @@ module GraphQL
       attr_writer :value
 
       # @api private
-      attr_accessor :scoped_context
+      attr_reader :scoped_context
 
       def []=(key, value)
         @provided_values[key] = value
       end
 
-      def_delegators :@query, :trace, :interpreter?
+      def_delegators :@query, :trace
 
+      def types
+        @types ||= @query.types
+      end
+
+      attr_writer :types
+
+      RUNTIME_METADATA_KEYS = Set.new([:current_object, :current_arguments, :current_field, :current_path])
       # @!method []=(key, value)
       #   Reassign `key` to the hash passed to {Schema#execute} as `context:`
 
       # Lookup `key` from the hash passed to {Schema#execute} as `context:`
       def [](key)
-        return @scoped_context[key] if @scoped_context.key?(key)
-        @provided_values[key]
+        if @scoped_context.key?(key)
+          @scoped_context[key]
+        elsif @provided_values.key?(key)
+          @provided_values[key]
+        elsif RUNTIME_METADATA_KEYS.include?(key)
+          if key == :current_path
+            current_path
+          else
+            (current_runtime_state = Fiber[:__graphql_runtime_info]) &&
+              (query_runtime_state = current_runtime_state[@query]) &&
+              (query_runtime_state.public_send(key))
+          end
+        else
+          # not found
+          nil
+        end
+      end
+
+      # Return this value to tell the runtime
+      # to exclude this field from the response altogether
+      def skip
+        GraphQL::Execution::SKIP
+      end
+
+      # Add error at query-level.
+      # @param error [GraphQL::ExecutionError] an execution error
+      # @return [void]
+      def add_error(error)
+        if !error.is_a?(ExecutionError)
+          raise TypeError, "expected error to be a ExecutionError, but was #{error.class}"
+        end
+        errors << error
+        nil
+      end
+
+      # @example Print the GraphQL backtrace during field resolution
+      #   puts ctx.backtrace
+      #
+      # @return [GraphQL::Backtrace] The backtrace for this point in query execution
+      def backtrace
+        GraphQL::Backtrace.new(self)
+      end
+
+      def execution_errors
+        @execution_errors ||= ExecutionErrors.new(self)
+      end
+
+      def current_path
+        current_runtime_state = Fiber[:__graphql_runtime_info]
+        query_runtime_state = current_runtime_state && current_runtime_state[@query]
+
+        path = query_runtime_state &&
+          (result = query_runtime_state.current_result) &&
+          (result.path)
+        if path && (rn = query_runtime_state.current_result_name)
+          path = path.dup
+          path.push(rn)
+        end
+        path
       end
 
       def delete(key)
@@ -195,8 +167,12 @@ module GraphQL
       UNSPECIFIED_FETCH_DEFAULT = Object.new
 
       def fetch(key, default = UNSPECIFIED_FETCH_DEFAULT)
-        if @scoped_context.key?(key)
-          @scoped_context[key]
+        if RUNTIME_METADATA_KEYS.include?(key)
+          (runtime = Fiber[:__graphql_runtime_info]) &&
+            (query_runtime_state = runtime[@query]) &&
+            (query_runtime_state.public_send(key))
+        elsif @scoped_context.key?(key)
+          scoped_context[key]
         elsif @provided_values.key?(key)
           @provided_values[key]
         elsif default != UNSPECIFIED_FETCH_DEFAULT
@@ -209,12 +185,30 @@ module GraphQL
       end
 
       def dig(key, *other_keys)
-        @scoped_context.key?(key) ? @scoped_context.dig(key, *other_keys) : @provided_values.dig(key, *other_keys)
+        if RUNTIME_METADATA_KEYS.include?(key)
+          (current_runtime_state = Fiber[:__graphql_runtime_info]) &&
+            (query_runtime_state = current_runtime_state[@query]) &&
+            (obj = query_runtime_state.public_send(key)) &&
+            if other_keys.empty?
+              obj
+            else
+              obj.dig(*other_keys)
+            end
+        elsif @scoped_context.key?(key)
+          @scoped_context.dig(key, *other_keys)
+        else
+          @provided_values.dig(key, *other_keys)
+        end
       end
 
       def to_h
-        @provided_values.merge(@scoped_context)
+        if (current_scoped_context = @scoped_context.merged_context)
+          @provided_values.merge(current_scoped_context)
+        else
+          @provided_values
+        end
       end
+
       alias :to_hash :to_h
 
       def key?(key)
@@ -223,28 +217,38 @@ module GraphQL
 
       # @return [GraphQL::Schema::Warden]
       def warden
-        @warden ||= @query.warden
+        @warden ||= (@query && @query.warden)
       end
 
+      # @api private
+      attr_writer :warden
+
       # Get an isolated hash for `ns`. Doesn't affect user-provided storage.
       # @param ns [Object] a usage-specific namespace identifier
       # @return [Hash] namespaced storage
       def namespace(ns)
-        @storage[ns]
+        if ns == :interpreter
+          self
+        else
+          @storage[ns]
+        end
       end
 
-      def inspect
-        "#<Query::Context ...>"
+      # @return [Boolean] true if this namespace was accessed before
+      def namespace?(ns)
+        @storage.key?(ns)
       end
 
-      # @api private
-      def received_null_child
-        @invalid_null = true
-        @value = nil
+      def logger
+        @query && @query.logger
+      end
+
+      def inspect
+        "#<Query::Context ...>"
       end
 
       def scoped_merge!(hash)
-        @scoped_context = @scoped_context.merge(hash)
+        @scoped_context.merge!(hash)
       end
 
       def scoped_set!(key, value)
@@ -252,117 +256,37 @@ module GraphQL
         nil
       end
 
-      class FieldResolutionContext
-        include SharedMethods
-        include Tracing::Traceable
-        extend Forwardable
-
-        attr_reader :irep_node, :field, :parent_type, :query, :schema, :parent, :key, :type
-        alias :selection :irep_node
-
-        def initialize(context, key, irep_node, parent, object)
-          @context = context
-          @key = key
-          @parent = parent
-          @object = object
-          @irep_node = irep_node
-          @field = irep_node.definition
-          @parent_type = irep_node.owner_type
-          @type = field.type
-          # This is needed constantly, so set it ahead of time:
-          @query = context.query
-          @schema = context.schema
-          @tracers = @query.tracers
-          # This hack flag is required by ConnectionResolve
-          @wrapped_connection = false
-          @wrapped_object = false
-        end
-
-        # @api private
-        attr_accessor :wrapped_connection, :wrapped_object
+      # Use this when you need to do a scoped set _inside_ a lazy-loaded (or batch-loaded)
+      # block of code.
+      #
+      # @example using scoped context inside a promise
+      #   scoped_ctx = context.scoped
+      #   SomeBatchLoader.load(...).then do |thing|
+      #     # use a scoped_ctx which was created _before_ dataloading:
+      #     scoped_ctx.set!(:thing, thing)
+      #   end
+      # @return [Context::Scoped]
+      def scoped
+        Scoped.new(@scoped_context, current_path)
+      end
 
-        def path
-          @path ||= @parent.path.dup << @key
+      class Scoped
+        def initialize(scoped_context, path)
+          @path = path
+          @scoped_context = scoped_context
         end
 
-        def_delegators :@context,
-          :[], :[]=, :key?, :fetch, :to_h, :namespace, :dig,
-          :spawn, :warden, :errors,
-          :execution_strategy, :strategy, :interpreter?
-
-        # @return [GraphQL::Language::Nodes::Field] The AST node for the currently-executing field
-        def ast_node
-          @irep_node.ast_node
+        def merge!(hash)
+          @scoped_context.merge!(hash, at: @path)
         end
 
-        # Add error to current field resolution.
-        # @param error [GraphQL::ExecutionError] an execution error
-        # @return [void]
-        def add_error(error)
-          super
-          error.ast_node ||= irep_node.ast_node
-          error.path ||= path
+        def set!(key, value)
+          @scoped_context.merge!({ key => value }, at: @path)
           nil
         end
-
-        def inspect
-          "#<GraphQL Context @ #{irep_node.owner_type.name}.#{field.name}>"
-        end
-
-        # Set a new value for this field in the response.
-        # It may be updated after resolving a {Lazy}.
-        # If it is {Execute::PROPAGATE_NULL}, tell the owner to propagate null.
-        # If it's {Execute::Execution::SKIP}, remove this field result from its parent
-        # @param new_value [Any] The GraphQL-ready value
-        # @api private
-        def value=(new_value)
-          case new_value
-          when GraphQL::Execution::Execute::PROPAGATE_NULL, nil
-            @invalid_null = true
-            @value = nil
-            if @type.kind.non_null?
-              @parent.received_null_child
-            end
-          when GraphQL::Execution::Execute::SKIP
-            @parent.skipped = true
-            @parent.delete_child(self)
-          else
-            @value = new_value
-          end
-        end
-
-        protected
-
-        def received_null_child
-          case @value
-          when Hash
-            self.value = GraphQL::Execution::Execute::PROPAGATE_NULL
-          when Array
-            if list_of_non_null_items?(@type)
-              self.value = GraphQL::Execution::Execute::PROPAGATE_NULL
-            end
-          when nil
-            # TODO This is a hack
-            # It was already nulled out but it's getting reassigned
-          else
-            raise "Unexpected value for received_null_child (#{self.value.class}): #{value}"
-          end
-        end
-
-        private
-
-        def list_of_non_null_items?(type)
-          case type
-          when GraphQL::NonNullType
-            # Unwrap [T]!
-            list_of_non_null_items?(type.of_type)
-          when GraphQL::ListType
-            type.of_type.is_a?(GraphQL::NonNullType)
-          else
-            raise "Unexpected list_of_non_null_items check: #{type}"
-          end
-        end
       end
     end
   end
 end
+
+require "graphql/query/context/scoped_context"

data/lib/graphql/query/input_validation_result.rb

@@ -4,6 +4,12 @@ module GraphQL
     class InputValidationResult
       attr_accessor :problems
 
+      def self.from_problem(explanation, path = nil, extensions: nil, message: nil)
+        result = self.new
+        result.add_problem(explanation, path, extensions: extensions, message: message)
+        result
+      end
+
       def initialize(valid: true, problems: nil)
         @valid = valid
         @problems = problems
@@ -27,7 +33,7 @@ module GraphQL
       end
 
       def merge_result!(path, inner_result)
-        return if inner_result.valid?
+        return if inner_result.nil? || inner_result.valid?
 
         if inner_result.problems
           inner_result.problems.each do |p|
@@ -38,6 +44,9 @@ module GraphQL
         # It could have been explicitly set on inner_result (if it had no problems)
         @valid = false
       end
+
+      VALID = self.new
+      VALID.freeze
     end
   end
 end

data/lib/graphql/query/null_context.rb

@@ -1,49 +1,32 @@
 # frozen_string_literal: true
+require "graphql/query/context"
 module GraphQL
   class Query
     # This object can be `ctx` in places where there is no query
-    class NullContext
-      class NullWarden < GraphQL::Schema::Warden
-        def visible?(t); true; end
-        def visible_field?(t); true; end
-        def visible_type?(t); true; end
-      end
+    class NullContext < Context
+      include Singleton
 
       class NullQuery
-        def with_error_handling
-          yield
+        def after_lazy(value)
+          yield(value)
         end
       end
 
+      class NullSchema < GraphQL::Schema
+      end
+
+      extend Forwardable
+
       attr_reader :schema, :query, :warden, :dataloader
+      def_delegators GraphQL::EmptyObjects::EMPTY_HASH, :[], :fetch, :dig, :key?, :to_h
 
       def initialize
         @query = NullQuery.new
         @dataloader = GraphQL::Dataloader::NullDataloader.new
-        @schema = GraphQL::Schema.new
-        @warden = NullWarden.new(
-          GraphQL::Filter.new,
-          context: self,
-          schema: @schema,
-        )
-      end
-
-      def [](key); end
-
-      def interpreter?
-        false
-      end
-
-      class << self
-        extend Forwardable
-
-        def [](key); end
-
-        def instance
-          @instance = self.new
-        end
-
-        def_delegators :instance, :query, :schema, :warden, :interpreter?, :dataloader
+        @schema = NullSchema
+        @warden = Schema::Warden::NullWarden.new(context: self, schema: @schema)
+        @types = @warden.visibility_profile
+        freeze
       end
     end
   end

data/lib/graphql/query/validation_pipeline.rb

@@ -14,12 +14,10 @@ module GraphQL
     #
     # @api private
     class ValidationPipeline
-      attr_reader :max_depth, :max_complexity
+      attr_reader :max_depth, :max_complexity, :validate_timeout_remaining
 
-      def initialize(query:, validate:, parse_error:, operation_name_error:, max_depth:, max_complexity:)
+      def initialize(query:, parse_error:, operation_name_error:, max_depth:, max_complexity:)
         @validation_errors = []
-        @internal_representation = nil
-        @validate = validate
         @parse_error = parse_error
         @operation_name_error = operation_name_error
         @query = query
@@ -42,17 +40,15 @@ module GraphQL
         @validation_errors
       end
 
-      # @return [Hash<String, nil => GraphQL::InternalRepresentation::Node] Operation name -> Irep node pairs
-      def internal_representation
-        ensure_has_validated
-        @internal_representation
-      end
-
       def analyzers
         ensure_has_validated
         @query_analyzers
       end
 
+      def has_validated?
+        @has_validated == true
+      end
+
       private
 
       # If the pipeline wasn't run yet, run it.
@@ -63,7 +59,7 @@ module GraphQL
 
         if @parse_error
           # This is kind of crazy: we push the parse error into `ctx`
-          # in {DefaultParseError} so that users can _opt out_ by redefining that hook.
+          # in `def self.parse_error` by default so that users can _opt out_ by redefining that hook.
           # That means we can't _re-add_ the error here (otherwise we'd either
           # add it twice _or_ override the user's choice to not add it).
           # So we just have to know that it was invalid and go from there.
@@ -72,10 +68,10 @@ module GraphQL
         elsif @operation_name_error
           @validation_errors << @operation_name_error
         else
-          validation_result = @schema.static_validator.validate(@query, validate: @validate, timeout: @schema.validate_timeout)
+          validator = @query.static_validator || @schema.static_validator
+          validation_result = validator.validate(@query, validate: @query.validate, timeout: @schema.validate_timeout, max_errors: @schema.validate_max_errors)
           @validation_errors.concat(validation_result[:errors])
-          @internal_representation = validation_result[:irep]
-
+          @validate_timeout_remaining = validation_result[:remaining_timeout]
           if @validation_errors.empty?
             @validation_errors.concat(@query.variables.errors)
           end
@@ -100,35 +96,15 @@ module GraphQL
       def build_analyzers(schema, max_depth, max_complexity)
         qa = schema.query_analyzers.dup
 
-        # Filter out the built in authorization analyzer.
-        # It is deprecated and does not have an AST analyzer alternative.
-        qa = qa.select do |analyzer|
-          if analyzer == GraphQL::Authorization::Analyzer && schema.using_ast_analysis?
-            raise "The Authorization analyzer is not supported with AST Analyzers"
-          else
-            true
-          end
-        end
-
         if max_depth || max_complexity
           # Depending on the analysis engine, we must use different analyzers
           # remove this once everything has switched over to AST analyzers
-          if schema.using_ast_analysis?
-            if max_depth
-              qa << GraphQL::Analysis::AST::MaxQueryDepth
-            end
-            if max_complexity
-              qa << GraphQL::Analysis::AST::MaxQueryComplexity
-            end
-          else
-            if max_depth
-              qa << GraphQL::Analysis::MaxQueryDepth.new(max_depth)
-            end
-            if max_complexity
-              qa << GraphQL::Analysis::MaxQueryComplexity.new(max_complexity)
-            end
+          if max_depth
+            qa << GraphQL::Analysis::MaxQueryDepth
+          end
+          if max_complexity
+            qa << GraphQL::Analysis::MaxQueryComplexity
           end
-
           qa
         else
           qa

data/lib/graphql/query/variable_validation_error.rb

@@ -4,13 +4,13 @@ module GraphQL
     class VariableValidationError < GraphQL::ExecutionError
       attr_accessor :value, :validation_result
 
-      def initialize(variable_ast, type, value, validation_result)
+      def initialize(variable_ast, type, value, validation_result, msg: nil)
         @value = value
         @validation_result = validation_result
 
-        msg = "Variable $#{variable_ast.name} of type #{type.to_type_signature} was provided invalid value"
+        msg ||= "Variable $#{variable_ast.name} of type #{type.to_type_signature} was provided invalid value"
 
-        if problem_fields.any?
+        if !problem_fields.empty?
           msg += " for #{problem_fields.join(", ")}"
         end