graphql 1.9.0 → 2.1.1

data/lib/graphql/execution/interpreter.rb

@@ -1,97 +1,222 @@
 # frozen_string_literal: true
+require "fiber"
+require "graphql/execution/interpreter/argument_value"
+require "graphql/execution/interpreter/arguments"
+require "graphql/execution/interpreter/arguments_cache"
 require "graphql/execution/interpreter/execution_errors"
-require "graphql/execution/interpreter/hash_response"
 require "graphql/execution/interpreter/runtime"
 require "graphql/execution/interpreter/resolve"
+require "graphql/execution/interpreter/handles_raw_value"
 
 module GraphQL
   module Execution
     class Interpreter
-      def initialize
-      end
+      class << self
+        # Used internally to signal that the query shouldn't be executed
+        # @api private
+        NO_OPERATION = GraphQL::EmptyObjects::EMPTY_HASH
 
-      # Support `Executor` :S
-      def execute(_operation, _root_type, query)
-        runtime = evaluate(query)
-        sync_lazies(query: query)
-        runtime.final_value
-      end
+        # @param schema [GraphQL::Schema]
+        # @param queries [Array<GraphQL::Query, Hash>]
+        # @param context [Hash]
+        # @param max_complexity [Integer, nil]
+        # @return [Array<Hash>] One result per query
+        def run_all(schema, query_options, context: {}, max_complexity: schema.max_complexity)
+          queries = query_options.map do |opts|
+            case opts
+            when Hash
+              GraphQL::Query.new(schema, nil, **opts)
+            when GraphQL::Query
+              opts
+            else
+              raise "Expected Hash or GraphQL::Query, not #{opts.class} (#{opts.inspect})"
+            end
+          end
 
-      def self.use(schema_defn)
-        schema_defn.target.interpreter = true
-        # Reach through the legacy objects for the actual class defn
-        schema_class = schema_defn.target.class
-        # This is not good, since both of these are holding state now,
-        # we have to update both :(
-        [schema_class, schema_defn].each do |schema_config|
-          schema_config.query_execution_strategy(GraphQL::Execution::Interpreter)
-          schema_config.mutation_execution_strategy(GraphQL::Execution::Interpreter)
-          schema_config.subscription_execution_strategy(GraphQL::Execution::Interpreter)
-        end
-      end
+          multiplex = Execution::Multiplex.new(schema: schema, queries: queries, context: context, max_complexity: max_complexity)
+          multiplex.current_trace.execute_multiplex(multiplex: multiplex) do
+            schema = multiplex.schema
+            queries = multiplex.queries
+            query_instrumenters = schema.instrumenters[:query]
+            multiplex_instrumenters = schema.instrumenters[:multiplex]
+            lazies_at_depth = Hash.new { |h, k| h[k] = [] }
 
-      def self.begin_multiplex(multiplex)
-        # Since this is basically the batching context,
-        # share it for a whole multiplex
-        multiplex.context[:interpreter_instance] ||= self.new
-      end
+            # First, run multiplex instrumentation, then query instrumentation for each query
+            call_hooks(multiplex_instrumenters, multiplex, :before_multiplex, :after_multiplex) do
+              each_query_call_hooks(query_instrumenters, queries) do
+                schema = multiplex.schema
+                multiplex_analyzers = schema.multiplex_analyzers
+                queries = multiplex.queries
+                if multiplex.max_complexity
+                  multiplex_analyzers += [GraphQL::Analysis::AST::MaxQueryComplexity]
+                end
 
-      def self.begin_query(query, multiplex)
-        # The batching context is shared by the multiplex,
-        # so fetch it out and use that instance.
-        interpreter =
-          query.context.namespace(:interpreter)[:interpreter_instance] =
-          multiplex.context[:interpreter_instance]
-        interpreter.evaluate(query)
-        query
-      end
+                schema.analysis_engine.analyze_multiplex(multiplex, multiplex_analyzers)
+                begin
+                  # Since this is basically the batching context,
+                  # share it for a whole multiplex
+                  multiplex.context[:interpreter_instance] ||= multiplex.schema.query_execution_strategy.new
+                  # Do as much eager evaluation of the query as possible
+                  results = []
+                  queries.each_with_index do |query, idx|
+                    multiplex.dataloader.append_job {
+                      operation = query.selected_operation
+                      result = if operation.nil? || !query.valid? || query.context.errors.any?
+                        NO_OPERATION
+                      else
+                        begin
+                          # Although queries in a multiplex _share_ an Interpreter instance,
+                          # they also have another item of state, which is private to that query
+                          # in particular, assign it here:
+                          runtime = Runtime.new(query: query, lazies_at_depth: lazies_at_depth)
+                          query.context.namespace(:interpreter_runtime)[:runtime] = runtime
 
-      def self.finish_multiplex(_results, multiplex)
-        interpreter = multiplex.context[:interpreter_instance]
-        interpreter.sync_lazies(multiplex: multiplex)
-      end
+                          query.current_trace.execute_query(query: query) do
+                            runtime.run_eager
+                          end
+                        rescue GraphQL::ExecutionError => err
+                          query.context.errors << err
+                          NO_OPERATION
+                        end
+                      end
+                      results[idx] = result
+                    }
+                  end
 
-      def self.finish_query(query, _multiplex)
-        {
-          "data" => query.context.namespace(:interpreter)[:runtime].final_value
-        }
-      end
+                  multiplex.dataloader.run
+
+                  # Then, work through lazy results in a breadth-first way
+                  multiplex.dataloader.append_job {
+                    query = multiplex.queries.length == 1 ? multiplex.queries[0] : nil
+                    queries = multiplex ? multiplex.queries : [query]
+                    final_values = queries.map do |query|
+                      runtime = query.context.namespace(:interpreter_runtime)[:runtime]
+                      # it might not be present if the query has an error
+                      runtime ? runtime.final_result : nil
+                    end
+                    final_values.compact!
+                    multiplex.current_trace.execute_query_lazy(multiplex: multiplex, query: query) do
+                      Interpreter::Resolve.resolve_each_depth(lazies_at_depth, multiplex.dataloader)
+                    end
+                  }
+                  multiplex.dataloader.run
+
+                  # Then, find all errors and assign the result to the query object
+                  results.each_with_index do |data_result, idx|
+                    query = queries[idx]
+                    # Assign the result so that it can be accessed in instrumentation
+                    query.result_values = if data_result.equal?(NO_OPERATION)
+                      if !query.valid? || query.context.errors.any?
+                        # A bit weird, but `Query#static_errors` _includes_ `query.context.errors`
+                        { "errors" => query.static_errors.map(&:to_h) }
+                      else
+                        data_result
+                      end
+                    else
+                      result = {
+                        "data" => query.context.namespace(:interpreter_runtime)[:runtime].final_result
+                      }
+
+                      if query.context.errors.any?
+                        error_result = query.context.errors.map(&:to_h)
+                        result["errors"] = error_result
+                      end
 
-      # Run the eager part of `query`
-      # @return {Interpreter::Runtime}
-      def evaluate(query)
-        # Although queries in a multiplex _share_ an Interpreter instance,
-        # they also have another item of state, which is private to that query
-        # in particular, assign it here:
-        runtime = Runtime.new(
-          query: query,
-          response: HashResponse.new,
-        )
-        query.context.namespace(:interpreter)[:runtime] = runtime
-
-        query.trace("execute_query", {query: query}) do
-          runtime.run_eager
+                      result
+                    end
+                    if query.context.namespace?(:__query_result_extensions__)
+                      query.result_values["extensions"] = query.context.namespace(:__query_result_extensions__)
+                    end
+                    # Get the Query::Result, not the Hash
+                    results[idx] = query.result
+                  end
+
+                  results
+                rescue Exception
+                  # TODO rescue at a higher level so it will catch errors in analysis, too
+                  # Assign values here so that the query's `@executed` becomes true
+                  queries.map { |q| q.result_values ||= {} }
+                  raise
+                ensure
+                  queries.map { |query|
+                    runtime = query.context.namespace(:interpreter_runtime)[:runtime]
+                    if runtime
+                      runtime.delete_all_interpreter_context
+                    end
+                  }
+                end
+              end
+            end
+          end
         end
 
-        runtime
-      end
+        private
 
-      # Run the lazy part of `query` or `multiplex`.
-      # @return [void]
-      def sync_lazies(query: nil, multiplex: nil)
-        tracer = query || multiplex
-        if query.nil? && multiplex.queries.length == 1
-          query = multiplex.queries[0]
+        # Call the before_ hooks of each query,
+        # Then yield if no errors.
+        # `call_hooks` takes care of appropriate cleanup.
+        def each_query_call_hooks(instrumenters, queries, i = 0)
+          if i >= queries.length
+            yield
+          else
+            query = queries[i]
+            call_hooks(instrumenters, query, :before_query, :after_query) {
+              each_query_call_hooks(instrumenters, queries, i + 1) {
+                yield
+              }
+            }
+          end
         end
-        queries = multiplex ? multiplex.queries : [query]
-        final_values = queries.map do |query|
-          runtime = query.context.namespace(:interpreter)[:runtime]
-          # it might not be present if the query has an error
-          runtime ? runtime.final_value : nil
+
+        # Call each before hook, and if they all succeed, yield.
+        # If they don't all succeed, call after_ for each one that succeeded.
+        def call_hooks(instrumenters, object, before_hook_name, after_hook_name)
+          begin
+            successful = []
+            instrumenters.each do |instrumenter|
+              instrumenter.public_send(before_hook_name, object)
+              successful << instrumenter
+            end
+
+            # if any before hooks raise an exception, quit calling before hooks,
+            # but call the after hooks on anything that succeeded but also
+            # raise the exception that came from the before hook.
+          rescue GraphQL::ExecutionError => err
+            object.context.errors << err
+          rescue => e
+            raise call_after_hooks(successful, object, after_hook_name, e)
+          end
+
+          begin
+            yield # Call the user code
+          ensure
+            ex = call_after_hooks(successful, object, after_hook_name, nil)
+            raise ex if ex
+          end
         end
-        final_values.compact!
-        tracer.trace("execute_query_lazy", {multiplex: multiplex, query: query}) do
-          Interpreter::Resolve.resolve_all(final_values)
+
+        def call_after_hooks(instrumenters, object, after_hook_name, ex)
+          instrumenters.reverse_each do |instrumenter|
+            begin
+              instrumenter.public_send(after_hook_name, object)
+            rescue => e
+              ex = e
+            end
+          end
+          ex
+        end
+      end
+
+      class ListResultFailedError < GraphQL::Error
+        def initialize(value:, path:, field:)
+          message = "Failed to build a GraphQL list result for field `#{field.path}` at path `#{path.join(".")}`.\n".dup
+
+          message << "Expected `#{value.inspect}` (#{value.class}) to implement `.each` to satisfy the GraphQL return type `#{field.type.to_type_signature}`.\n"
+
+          if field.connection?
+            message << "\nThis field was treated as a Relay-style connection; add `connection: false` to the `field(...)` to disable this behavior."
+          end
+          super(message)
         end
       end
     end

data/lib/graphql/execution/lazy/lazy_method_map.rb

@@ -36,6 +36,10 @@ module GraphQL
           @storage.compute_if_absent(value.class) { find_superclass_method(value.class) }
         end
 
+        def each
+          @storage.each_pair { |k, v| yield(k, v) }
+        end
+
         protected
 
         attr_reader :storage

data/lib/graphql/execution/lazy.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require "graphql/execution/lazy/lazy_method_map"
-require "graphql/execution/lazy/resolve"
 
 module GraphQL
   module Execution
@@ -13,23 +12,14 @@ module GraphQL
     # - It has no error-catching functionality
     # @api private
     class Lazy
-      # Traverse `val`, lazily resolving any values along the way
-      # @param val [Object] A data structure containing mixed plain values and `Lazy` instances
-      # @return void
-      def self.resolve(val)
-        Resolve.resolve(val)
-      end
-
-      attr_reader :path, :field
+      attr_reader :field
 
       # Create a {Lazy} which will get its inner value by calling the block
-      # @param path [Array<String, Integer>]
       # @param field [GraphQL::Schema::Field]
       # @param get_value_func [Proc] a block to get the inner value (later)
-      def initialize(path: nil, field: nil, &get_value_func)
+      def initialize(field: nil, &get_value_func)
         @get_value_func = get_value_func
         @resolved = false
-        @path = path
         @field = field
       end
 
@@ -37,18 +27,18 @@ module GraphQL
       def value
         if !@resolved
           @resolved = true
-          @value = begin
-            v = @get_value_func.call
-            if v.is_a?(Lazy)
-              v = v.value
-            end
-            v
-          rescue GraphQL::ExecutionError => err
-            err
+          v = @get_value_func.call
+          if v.is_a?(Lazy)
+            v = v.value
           end
+          @value = v
         end
 
-        if @value.is_a?(StandardError)
+        # `SKIP` was made into a subclass of `GraphQL::Error` to improve runtime performance
+        # (fewer clauses in a hot `case` block), but now it requires special handling here.
+        # I think it's still worth it for the performance win, but if the number of special
+        # cases grows, then maybe it's worth rethinking somehow.
+        if @value.is_a?(StandardError) && @value != GraphQL::Execution::SKIP
           raise @value
         else
           @value