Class: GraphQL::Execution::Interpreter

Inherits:
Object
  • Object
show all
Defined in:
lib/graphql/execution/interpreter.rb,
lib/graphql/execution/interpreter/resolve.rb,
lib/graphql/execution/interpreter/runtime.rb,
lib/graphql/execution/interpreter/arguments.rb,
lib/graphql/execution/interpreter/argument_value.rb,
lib/graphql/execution/interpreter/arguments_cache.rb,
lib/graphql/execution/interpreter/execution_errors.rb,
lib/graphql/execution/interpreter/handles_raw_value.rb,
lib/graphql/execution/interpreter/runtime/graphql_result.rb

Defined Under Namespace

Modules: Resolve Classes: ArgumentValue, Arguments, ArgumentsCache, ExecutionErrors, ListResultFailedError, RawValue, Runtime

Constant Summary collapse

NO_OPERATION =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Used internally to signal that the query shouldn’t be executed

GraphQL::EmptyObjects::EMPTY_HASH

Class Method Summary collapse

Class Method Details

.run_all(schema, query_options, context: {}, max_complexity: schema.max_complexity) ⇒ Array<Hash>

Returns One result per query.

Parameters:

  • schema (GraphQL::Schema)
  • queries (Array<GraphQL::Query, Hash>)
  • context (Hash) (defaults to: {})
  • max_complexity (Integer, nil) (defaults to: schema.max_complexity)

Returns:

  • (Array<Hash>) —

    One result per query



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/graphql/execution/interpreter.rb', line 24

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

  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

    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

              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

      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]
        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 = {}

          if query.context.errors.any?
            error_result = query.context.errors.map(&:to_h)
            result["errors"] = error_result
          end

          result["data"] = query.context.namespace(:interpreter_runtime)[:runtime].final_result

          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