graphql 1.12.12 → 2.2.14

data/lib/graphql/execution/interpreter.rb

@@ -11,98 +11,140 @@ 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.response
-      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
+              schema.query_class.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_class)
-        if schema_class.interpreter?
-          definition_line = caller(2, 1).first
-          GraphQL::Deprecation.warn("GraphQL::Execution::Interpreter is now the default; remove `use GraphQL::Execution::Interpreter` from the schema definition (#{definition_line})")
-        else
-          schema_class.query_execution_strategy(self)
-          schema_class.mutation_execution_strategy(self)
-          schema_class.subscription_execution_strategy(self)
-          schema_class.add_subscription_extension_if_necessary
-        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
+            lazies_at_depth = Hash.new { |h, k| h[k] = [] }
+            multiplex_analyzers = schema.multiplex_analyzers
+            if multiplex.max_complexity
+              multiplex_analyzers += [GraphQL::Analysis::AST::MaxQueryComplexity]
+            end
 
-      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
+            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(deprecation_warning: false).new
+              # Do as much eager evaluation of the query as possible
+              results = []
+              queries.each_with_index do |query, idx|
+                if query.subscription? && !query.subscription_update?
+                  query.context.namespace(:subscriptions)[:events] = []
+                end
+                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.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
+                      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_multiplex(_results, multiplex)
-        interpreter = multiplex.context[:interpreter_instance]
-        interpreter.sync_lazies(multiplex: multiplex)
-      end
+              multiplex.dataloader.run
 
-      def self.finish_query(query, _multiplex)
-        {
-          "data" => query.context.namespace(:interpreter)[:runtime].response
-        }
-      end
+              # 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
 
-      # 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)
-        query.context.namespace(:interpreter)[:runtime] = runtime
+              # Then, find all errors and assign the result to the query object
+              results.each_with_index do |data_result, idx|
+                query = queries[idx]
+                if (events = query.context.namespace(:subscriptions)[:events]) && events.any?
+                  schema.subscriptions.write_subscription(query, events)
+                end
+                # 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 = {}
 
-        query.trace("execute_query", {query: query}) do
-          runtime.run_eager
-        end
+                  if query.context.errors.any?
+                    error_result = query.context.errors.map(&:to_h)
+                    result["errors"] = error_result
+                  end
 
-        runtime
-      end
+                  result["data"] = query.context.namespace(:interpreter_runtime)[:runtime].final_result
 
-      # 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]
-        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.response : nil
-        end
-        final_values.compact!
-        tracer.trace("execute_query_lazy", {multiplex: multiplex, query: query}) do
-          Interpreter::Resolve.resolve_all(final_values, multiplex.dataloader)
-        end
-        queries.each do |query|
-          runtime = query.context.namespace(:interpreter)[:runtime]
-          if runtime
-            runtime.delete_interpreter_context(:current_path)
-            runtime.delete_interpreter_context(:current_field)
-            runtime.delete_interpreter_context(:current_object)
-            runtime.delete_interpreter_context(:current_arguments)
+                  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
-        nil
       end
 
       class ListResultFailedError < GraphQL::Error

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

data/lib/graphql/execution/lookahead.rb

@@ -55,7 +55,7 @@ module GraphQL
           @arguments
         else
           @arguments = if @field
-            @query.schema.after_lazy(@query.arguments_for(@ast_nodes.first, @field)) do |args|
+            @query.after_lazy(@query.arguments_for(@ast_nodes.first, @field)) do |args|
               args.is_a?(Execution::Interpreter::Arguments) ? args.keyword_arguments : args
             end
           else
@@ -76,8 +76,24 @@ module GraphQL
       # @param field_name [String, Symbol]
       # @param arguments [Hash] Arguments which must match in the selection
       # @return [Boolean]
-      def selects?(field_name, arguments: nil)
-        selection(field_name, arguments: arguments).selected?
+      def selects?(field_name, selected_type: @selected_type, arguments: nil)
+        selection(field_name, selected_type: selected_type, arguments: arguments).selected?
+      end
+
+      # True if this node has a selection with alias matching `alias_name`.
+      # If `alias_name` is a String, it is treated as a GraphQL-style (camelized)
+      # field name and used verbatim. If `alias_name` is a Symbol, it is
+      # treated as a Ruby-style (underscored) name and camelized before comparing.
+      #
+      # If `arguments:` is provided, each provided key/value will be matched
+      # against the arguments in the next selection. This method will return false
+      # if any of the given `arguments:` are not present and matching in the next selection.
+      # (But, the next selection may contain _more_ than the given arguments.)
+      # @param alias_name [String, Symbol]
+      # @param arguments [Hash] Arguments which must match in the selection
+      # @return [Boolean]
+      def selects_alias?(alias_name, arguments: nil)
+        alias_selection(alias_name, arguments: arguments).selected?
       end
 
       # @return [Boolean] True if this lookahead represents a field that was requested
@@ -87,27 +103,57 @@ module GraphQL
 
       # Like {#selects?}, but can be used for chaining.
       # It returns a null object (check with {#selected?})
+      # @param field_name [String, Symbol]
       # @return [GraphQL::Execution::Lookahead]
       def selection(field_name, selected_type: @selected_type, arguments: nil)
-        next_field_name = normalize_name(field_name)
-
-        next_field_defn = get_class_based_field(selected_type, next_field_name)
-        if next_field_defn
-          next_nodes = []
-          @ast_nodes.each do |ast_node|
-            ast_node.selections.each do |selection|
-              find_selected_nodes(selection, next_field_name, next_field_defn, arguments: arguments, matches: next_nodes)
-            end
+        next_field_defn = case field_name
+        when String
+          @query.get_field(selected_type, field_name)
+        when Symbol
+          # Try to avoid the `.to_s` below, if possible
+          all_fields = if selected_type.kind.fields?
+            @query.warden.fields(selected_type)
+          else
+            # Handle unions by checking possible
+            @query.warden
+              .possible_types(selected_type)
+              .map { |t| @query.warden.fields(t) }
+              .tap(&:flatten!)
           end
 
-          if next_nodes.any?
-            Lookahead.new(query: @query, ast_nodes: next_nodes, field: next_field_defn, owner_type: selected_type)
+
+          if (match_by_orig_name = all_fields.find { |f| f.original_name == field_name })
+            match_by_orig_name
           else
-            NULL_LOOKAHEAD
+            # Symbol#name is only present on 3.0+
+            sym_s = field_name.respond_to?(:name) ? field_name.name : field_name.to_s
+            guessed_name = Schema::Member::BuildType.camelize(sym_s)
+            @query.get_field(selected_type, guessed_name)
           end
-        else
-          NULL_LOOKAHEAD
         end
+        lookahead_for_selection(next_field_defn, selected_type, arguments)
+      end
+
+      # Like {#selection}, but for aliases.
+      # It returns a null object (check with {#selected?})
+      # @return [GraphQL::Execution::Lookahead]
+      def alias_selection(alias_name, selected_type: @selected_type, arguments: nil)
+        alias_cache_key = [alias_name, arguments]
+        return alias_selections[key] if alias_selections.key?(alias_name)
+
+        alias_node = lookup_alias_node(ast_nodes, alias_name)
+        return NULL_LOOKAHEAD unless alias_node
+
+        next_field_defn = @query.get_field(selected_type, alias_node.name)
+
+        alias_arguments = @query.arguments_for(alias_node, next_field_defn)
+        if alias_arguments.is_a?(::GraphQL::Execution::Interpreter::Arguments)
+          alias_arguments = alias_arguments.keyword_arguments
+        end
+
+        return NULL_LOOKAHEAD if arguments && arguments != alias_arguments
+
+        alias_selections[alias_cache_key] = lookahead_for_selection(next_field_defn, selected_type, alias_arguments, alias_name)
       end
 
       # Like {#selection}, but for all nodes.
@@ -137,7 +183,7 @@ module GraphQL
 
         subselections_by_type.each do |type, ast_nodes_by_response_key|
           ast_nodes_by_response_key.each do |response_key, ast_nodes|
-            field_defn = get_class_based_field(type, ast_nodes.first.name)
+            field_defn = @query.get_field(type, ast_nodes.first.name)
             lookahead = Lookahead.new(query: @query, ast_nodes: ast_nodes, field: field_defn, owner_type: type)
             subselections.push(lookahead)
           end
@@ -196,34 +242,10 @@ module GraphQL
 
       private
 
-      # If it's a symbol, stringify and camelize it
-      def normalize_name(name)
-        if name.is_a?(Symbol)
-          Schema::Member::BuildType.camelize(name.to_s)
-        else
-          name
-        end
-      end
-
-      def normalize_keyword(keyword)
-        if keyword.is_a?(String)
-          Schema::Member::BuildType.underscore(keyword).to_sym
-        else
-          keyword
-        end
-      end
-
-      # Wrap get_field and ensure that it returns a GraphQL::Schema::Field.
-      # Remove this when legacy execution is removed.
-      def get_class_based_field(type, name)
-        f = @query.get_field(type, name)
-        f && f.type_class
-      end
-
       def skipped_by_directive?(ast_selection)
         ast_selection.directives.each do |directive|
           dir_defn = @query.schema.directives.fetch(directive.name)
-          directive_class = dir_defn.type_class
+          directive_class = dir_defn
           if directive_class
             dir_args = @query.arguments_for(directive, dir_defn)
             return true unless directive_class.static_include?(dir_args, @query.context)
@@ -244,7 +266,7 @@ module GraphQL
             elsif arguments.nil? || arguments.empty?
               selections_on_type[response_key] = [ast_selection]
             else
-              field_defn = get_class_based_field(selected_type, ast_selection.name)
+              field_defn = @query.get_field(selected_type, ast_selection.name)
               if arguments_match?(arguments, field_defn, ast_selection)
                 selections_on_type[response_key] = [ast_selection]
               end
@@ -254,14 +276,14 @@ module GraphQL
             subselections_on_type = selections_on_type
             if (t = ast_selection.type)
               # Assuming this is valid, that `t` will be found.
-              on_type = @query.schema.get_type(t.name).type_class
+              on_type = @query.get_type(t.name)
               subselections_on_type = subselections_by_type[on_type] ||= {}
             end
             find_selections(subselections_by_type, subselections_on_type, on_type, ast_selection.selections, arguments)
           when GraphQL::Language::Nodes::FragmentSpread
-            frag_defn = @query.fragments[ast_selection.name] || raise("Invariant: Can't look ahead to nonexistent fragment #{ast_selection.name} (found: #{@query.fragments.keys})")
+            frag_defn = lookup_fragment(ast_selection)
             # Again, assuming a valid AST
-            on_type = @query.schema.get_type(frag_defn.type.name).type_class
+            on_type = @query.get_type(frag_defn.type.name)
             subselections_on_type = subselections_by_type[on_type] ||= {}
             find_selections(subselections_by_type, subselections_on_type, on_type, frag_defn.selections, arguments)
           else
@@ -272,11 +294,11 @@ module GraphQL
 
       # If a selection on `node` matches `field_name` (which is backed by `field_defn`)
       # and matches the `arguments:` constraints, then add that node to `matches`
-      def find_selected_nodes(node, field_name, field_defn, arguments:, matches:)
+      def find_selected_nodes(node, field_name, field_defn, arguments:, matches:, alias_name: NOT_CONFIGURED)
         return if skipped_by_directive?(node)
         case node
         when GraphQL::Language::Nodes::Field
-          if node.name == field_name
+          if node.name == field_name && (NOT_CONFIGURED.equal?(alias_name) || node.alias == alias_name)
             if arguments.nil? || arguments.empty?
               # No constraint applied
               matches << node
@@ -285,10 +307,10 @@ module GraphQL
             end
           end
         when GraphQL::Language::Nodes::InlineFragment
-          node.selections.each { |s| find_selected_nodes(s, field_name, field_defn, arguments: arguments, matches: matches) }
+          node.selections.each { |s| find_selected_nodes(s, field_name, field_defn, arguments: arguments, matches: matches, alias_name: alias_name) }
         when GraphQL::Language::Nodes::FragmentSpread
-          frag_defn = @query.fragments[node.name] || raise("Invariant: Can't look ahead to nonexistent fragment #{node.name} (found: #{@query.fragments.keys})")
-          frag_defn.selections.each { |s| find_selected_nodes(s, field_name, field_defn, arguments: arguments, matches: matches) }
+          frag_defn = lookup_fragment(node)
+          frag_defn.selections.each { |s| find_selected_nodes(s, field_name, field_defn, arguments: arguments, matches: matches, alias_name: alias_name) }
         else
           raise "Unexpected selection comparison on #{node.class.name} (#{node})"
         end
@@ -297,11 +319,60 @@ module GraphQL
       def arguments_match?(arguments, field_defn, field_node)
         query_kwargs = @query.arguments_for(field_node, field_defn)
         arguments.all? do |arg_name, arg_value|
-          arg_name = normalize_keyword(arg_name)
+          arg_name_sym = if arg_name.is_a?(String)
+            Schema::Member::BuildType.underscore(arg_name).to_sym
+          else
+            arg_name
+          end
+
           # Make sure the constraint is present with a matching value
-          query_kwargs.key?(arg_name) && query_kwargs[arg_name] == arg_value
+          query_kwargs.key?(arg_name_sym) && query_kwargs[arg_name_sym] == arg_value
+        end
+      end
+
+      def lookahead_for_selection(field_defn, selected_type, arguments, alias_name = NOT_CONFIGURED)
+        return NULL_LOOKAHEAD unless field_defn
+
+        next_nodes = []
+        field_name = field_defn.name
+        @ast_nodes.each do |ast_node|
+          ast_node.selections.each do |selection|
+            find_selected_nodes(selection, field_name, field_defn, arguments: arguments, matches: next_nodes, alias_name: alias_name)
+          end
+        end
+
+        return NULL_LOOKAHEAD if next_nodes.empty?
+
+        Lookahead.new(query: @query, ast_nodes: next_nodes, field: field_defn, owner_type: selected_type)
+      end
+
+      def alias_selections
+        return @alias_selections if defined?(@alias_selections)
+        @alias_selections ||= {}
+      end
+
+      def lookup_alias_node(nodes, name)
+        return if nodes.empty?
+
+        nodes.flat_map(&:children)
+             .flat_map { |child| unwrap_fragments(child) }
+             .find { |child| child.is_a?(GraphQL::Language::Nodes::Field) && child.alias == name }
+      end
+
+      def unwrap_fragments(node)
+        case node
+        when GraphQL::Language::Nodes::InlineFragment
+          node.children
+        when GraphQL::Language::Nodes::FragmentSpread
+          lookup_fragment(node).children
+        else
+          [node]
         end
       end
+
+      def lookup_fragment(ast_selection)
+        @query.fragments[ast_selection.name] || raise("Invariant: Can't look ahead to nonexistent fragment #{ast_selection.name} (found: #{@query.fragments.keys})")
+      end
     end
   end
 end