Class: GraphQL::Execution::Interpreter::Runtime Private

Inherits:
Object
  • Object
show all
Defined in:
lib/graphql/execution/interpreter/runtime.rb,
lib/graphql/execution/interpreter/runtime/graphql_result.rb

Overview

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

I think it would be even better if we could somehow make continue_field not recursive. “Trampolining” it somehow.

Defined Under Namespace

Modules: GraphQLResult Classes: CurrentState, GraphQLResultArray, GraphQLResultHash

Constant Summary collapse

NO_ARGS =

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. 

GraphQL::EmptyObjects::EMPTY_HASH
HALT =

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. 

Object.new

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(query:, lazies_at_depth:) ⇒ Runtime

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

Returns a new instance of Runtime.



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/graphql/execution/interpreter/runtime.rb', line 38

def initialize(query:, lazies_at_depth:)
  @query = query
  @current_trace = query.current_trace
  @dataloader = query.multiplex.dataloader
  @lazies_at_depth = lazies_at_depth
  @schema = query.schema
  @context = query.context
  @response = nil
  # Identify runtime directives by checking which of this schema's directives have overridden `def self.resolve`
  @runtime_directive_names = []
  noop_resolve_owner = GraphQL::Schema::Directive.singleton_class
  @schema_directives = schema.directives
  @schema_directives.each do |name, dir_defn|
    if dir_defn.method(:resolve).owner != noop_resolve_owner
      @runtime_directive_names << name
    end
  end
  # { Class => Boolean }
  @lazy_cache = {}
  @lazy_cache.compare_by_identity
end

Instance Attribute Details

#context ⇒ GraphQL::Query::Context (readonly)

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

Returns:



36
37
38
 
# File 'lib/graphql/execution/interpreter/runtime.rb', line 36

def context
  @context
end

#query ⇒ GraphQL::Query (readonly)

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

Returns:



30
31
32
 
# File 'lib/graphql/execution/interpreter/runtime.rb', line 30

def query
  @query
end

#schema ⇒ Class<GraphQL::Schema> (readonly)

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

Returns:



33
34
35
 
# File 'lib/graphql/execution/interpreter/runtime.rb', line 33

def schema
  @schema
end

Instance Method Details

#after_lazy(lazy_obj, field:, owner_object:, arguments:, ast_node:, result:, result_name:, eager: false, runtime_state:, trace: true, &block) ⇒ GraphQL::Execution::Lazy, Object

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

Returns If loading object will be deferred, it’s a wrapper over it.

Parameters:

  • obj (Object) —

    Some user-returned value that may want to be batched

  • field (GraphQL::Schema::Field)
  • eager (Boolean) (defaults to: false) —

    Set to true for mutation root fields only

  • trace (Boolean) (defaults to: true) —

    If false, don’t wrap this with field tracing

Returns:



756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
 
# File 'lib/graphql/execution/interpreter/runtime.rb', line 756

def after_lazy(lazy_obj, field:, owner_object:, arguments:, ast_node:, result:, result_name:, eager: false, runtime_state:, trace: true, &block)
  if lazy?(lazy_obj)
    orig_result = result
    was_authorized_by_scope_items = runtime_state.was_authorized_by_scope_items
    lazy = GraphQL::Execution::Lazy.new(field: field) do
      # This block might be called in a new fiber;
      # In that case, this will initialize a new state
      # to avoid conflicting with the parent fiber.
      runtime_state = get_current_runtime_state
      runtime_state.current_field = field
      runtime_state.current_arguments = arguments
      runtime_state.current_result_name = result_name
      runtime_state.current_result = orig_result
      runtime_state.was_authorized_by_scope_items = was_authorized_by_scope_items
      # Wrap the execution of _this_ method with tracing,
      # but don't wrap the continuation below
      inner_obj = begin
        if trace
          @current_trace.execute_field_lazy(field: field, query: query, object: owner_object, arguments: arguments, ast_node: ast_node) do
            schema.sync_lazy(lazy_obj)
          end
        else
          schema.sync_lazy(lazy_obj)
        end
      rescue GraphQL::ExecutionError, GraphQL::UnauthorizedError => ex_err
        ex_err
      rescue StandardError => err
        begin
          query.handle_or_reraise(err)
        rescue GraphQL::ExecutionError => ex_err
          ex_err
        end
      end
      yield(inner_obj, runtime_state)
    end

    if eager
      lazy.value
    else
      set_result(result, result_name, lazy, false, false) # is_non_null is irrelevant here
      current_depth = 0
      while result
        current_depth += 1
        result = result.graphql_parent
      end
      @lazies_at_depth[current_depth] << lazy
      lazy
    end
  else
    # Don't need to reset state here because it _wasn't_ lazy.
    yield(lazy_obj, runtime_state)
  end
end

#arguments(graphql_object, arg_owner, ast_node) ⇒ Object

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



810
811
812
813
814
815
816
817
 
# File 'lib/graphql/execution/interpreter/runtime.rb', line 810

def arguments(graphql_object, arg_owner, ast_node)
  if arg_owner.arguments_statically_coercible?
    query.arguments_for(ast_node, arg_owner)
  else
    # The arguments must be prepared in the context of the given object
    query.arguments_for(ast_node, arg_owner, parent_object: graphql_object)
  end
end

#call_method_on_directives(method_name, object, directives, &block) ⇒ Object

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



686
687
688
689
 
# File 'lib/graphql/execution/interpreter/runtime.rb', line 686

def call_method_on_directives(method_name, object, directives, &block)
  return yield if directives.nil? || directives.empty?
  run_directive(method_name, object, directives, 0, &block)
end

#continue_field(value, owner_type, field, current_type, ast_node, next_selections, is_non_null, owner_object, arguments, result_name, selection_result, was_scoped, runtime_state) ⇒ Lazy, ...

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

The resolver for field returned value. Continue to execute the query, treating value as type (probably the return type of the field).

Use next_selections to resolve object fields, if there are any.

Location information from path and ast_node.

Returns:

  • (Lazy, Array, Hash, Object) —

    Lazy, Array, and Hash are all traversed to resolve lazy values later



557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
 
# File 'lib/graphql/execution/interpreter/runtime.rb', line 557

def continue_field(value, owner_type, field, current_type, ast_node, next_selections, is_non_null, owner_object, arguments, result_name, selection_result, was_scoped, runtime_state) # rubocop:disable Metrics/ParameterLists
  if current_type.non_null?
    current_type = current_type.of_type
    is_non_null = true
  end

  case current_type.kind.name
  when "SCALAR", "ENUM"
    r = begin
      current_type.coerce_result(value, context)
    rescue StandardError => err
      schema.handle_or_reraise(context, err)
    end
    set_result(selection_result, result_name, r, false, is_non_null)
    r
  when "UNION", "INTERFACE"
    resolved_type_or_lazy = resolve_type(current_type, value)
    after_lazy(resolved_type_or_lazy, ast_node: ast_node, field: field, owner_object: owner_object, arguments: arguments, trace: false, result_name: result_name, result: selection_result, runtime_state: runtime_state) do |resolved_type_result, runtime_state|
      if resolved_type_result.is_a?(Array) && resolved_type_result.length == 2
        resolved_type, resolved_value = resolved_type_result
      else
        resolved_type = resolved_type_result
        resolved_value = value
      end

      possible_types = query.possible_types(current_type)
      if !possible_types.include?(resolved_type)
        parent_type = field.owner_type
        err_class = current_type::UnresolvedTypeError
        type_error = err_class.new(resolved_value, field, parent_type, resolved_type, possible_types)
        schema.type_error(type_error, context)
        set_result(selection_result, result_name, nil, false, is_non_null)
        nil
      else
        continue_field(resolved_value, owner_type, field, resolved_type, ast_node, next_selections, is_non_null, owner_object, arguments, result_name, selection_result, was_scoped, runtime_state)
      end
    end
  when "OBJECT"
    object_proxy = begin
      was_scoped ? current_type.wrap_scoped(value, context) : current_type.wrap(value, context)
    rescue GraphQL::ExecutionError => err
      err
    end
    after_lazy(object_proxy, ast_node: ast_node, field: field, owner_object: owner_object, arguments: arguments, trace: false, result_name: result_name, result: selection_result, runtime_state: runtime_state) do |inner_object, runtime_state|
      continue_value = continue_value(inner_object, field, is_non_null, ast_node, result_name, selection_result)
      if HALT != continue_value
        response_hash = GraphQLResultHash.new(result_name, current_type, continue_value, selection_result, is_non_null, next_selections, false)
        set_result(selection_result, result_name, response_hash, true, is_non_null)
        each_gathered_selections(response_hash) do |selections, is_selection_array|
          if is_selection_array
            this_result = GraphQLResultHash.new(result_name, current_type, continue_value, selection_result, is_non_null, selections, false)
            final_result = response_hash
          else
            this_result = response_hash
            final_result = nil
          end

          evaluate_selections(
            selections,
            this_result,
            final_result,
            runtime_state,
          )
        end
      end
    end
  when "LIST"
    inner_type = current_type.of_type
    # This is true for objects, unions, and interfaces
    use_dataloader_job = !inner_type.unwrap.kind.input?
    inner_type_non_null = inner_type.non_null?
    response_list = GraphQLResultArray.new(result_name, current_type, owner_object, selection_result, is_non_null, next_selections, false)
    set_result(selection_result, result_name, response_list, true, is_non_null)
    idx = nil
    list_value = begin
      value.each do |inner_value|
        idx ||= 0
        this_idx = idx
        idx += 1
        if use_dataloader_job
          @dataloader.append_job do
            resolve_list_item(inner_value, inner_type, inner_type_non_null, ast_node, field, owner_object, arguments, this_idx, response_list, owner_type, was_scoped, runtime_state)
          end
        else
          resolve_list_item(inner_value, inner_type, inner_type_non_null, ast_node, field, owner_object, arguments, this_idx, response_list, owner_type, was_scoped, runtime_state)
        end
      end

      response_list
    rescue NoMethodError => err
      # Ruby 2.2 doesn't have NoMethodError#receiver, can't check that one in this case. (It's been EOL since 2017.)
      if err.name == :each && (err.respond_to?(:receiver) ? err.receiver == value : true)
        # This happens when the GraphQL schema doesn't match the implementation. Help the dev debug.
        raise ListResultFailedError.new(value: value, field: field, path: current_path)
      else
        # This was some other NoMethodError -- let it bubble to reveal the real error.
        raise
      end
    rescue GraphQL::ExecutionError, GraphQL::UnauthorizedError => ex_err
      ex_err
    rescue StandardError => err
      begin
        query.handle_or_reraise(err)
      rescue GraphQL::ExecutionError => ex_err
        ex_err
      end
    end
    # Detect whether this error came while calling `.each` (before `idx` is set) or while running list *items* (after `idx` is set)
    error_is_non_null = idx.nil? ? is_non_null : inner_type.non_null?
    continue_value(list_value, field, error_is_non_null, ast_node, result_name, selection_result)
  else
    raise "Invariant: Unhandled type kind #{current_type.kind} (#{current_type})"
  end
end

#continue_value(value, field, is_non_null, ast_node, result_name, selection_result) ⇒ Object

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

rubocop:disable Metrics/ParameterLists



451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
 
# File 'lib/graphql/execution/interpreter/runtime.rb', line 451

def continue_value(value, field, is_non_null, ast_node, result_name, selection_result) # rubocop:disable Metrics/ParameterLists
  case value
  when nil
    if is_non_null
      set_result(selection_result, result_name, nil, false, is_non_null) do
        # When this comes from a list item, use the parent object:
        parent_type = selection_result.is_a?(GraphQLResultArray) ? selection_result.graphql_parent.graphql_result_type : selection_result.graphql_result_type
        # This block is called if `result_name` is not dead. (Maybe a previous invalid nil caused it be marked dead.)
        err = parent_type::InvalidNullError.new(parent_type, field, value)
        schema.type_error(err, context)
      end
    else
      set_result(selection_result, result_name, nil, false, is_non_null)
    end
    HALT
  when GraphQL::Error
    # Handle these cases inside a single `when`
    # to avoid the overhead of checking three different classes
    # every time.
    if value.is_a?(GraphQL::ExecutionError)
      if selection_result.nil? || !selection_result.graphql_dead
        value.path ||= current_path
        value.ast_node ||= ast_node
        context.errors << value
        if selection_result
          set_result(selection_result, result_name, nil, false, is_non_null)
        end
      end
      HALT
    elsif value.is_a?(GraphQL::UnauthorizedFieldError)
      value.field ||= field
      # this hook might raise & crash, or it might return
      # a replacement value
      next_value = begin
        schema.unauthorized_field(value)
      rescue GraphQL::ExecutionError => err
        err
      end
      continue_value(next_value, field, is_non_null, ast_node, result_name, selection_result)
    elsif value.is_a?(GraphQL::UnauthorizedError)
      # this hook might raise & crash, or it might return
      # a replacement value
      next_value = begin
        schema.unauthorized_object(value)
      rescue GraphQL::ExecutionError => err
        err
      end
      continue_value(next_value, field, is_non_null, ast_node, result_name, selection_result)
    elsif GraphQL::Execution::SKIP == value
      # It's possible a lazy was already written here
      case selection_result
      when GraphQLResultHash
        selection_result.delete(result_name)
      when GraphQLResultArray
        selection_result.graphql_skip_at(result_name)
      when nil
        # this can happen with directives
      else
        raise "Invariant: unexpected result class #{selection_result.class} (#{selection_result.inspect})"
      end
      HALT
    else
      # What could this actually _be_? Anyhow,
      # preserve the default behavior of doing nothing with it.
      value
    end
  when Array
    # It's an array full of execution errors; add them all.
    if value.any? && value.all?(GraphQL::ExecutionError)
      list_type_at_all = (field && (field.type.list?))
      if selection_result.nil? || !selection_result.graphql_dead
        value.each_with_index do |error, index|
          error.ast_node ||= ast_node
          error.path ||= current_path + (list_type_at_all ? [index] : [])
          context.errors << error
        end
        if selection_result
          if list_type_at_all
            result_without_errors = value.map { |v| v.is_a?(GraphQL::ExecutionError) ? nil : v }
            set_result(selection_result, result_name, result_without_errors, false, is_non_null)
          else
            set_result(selection_result, result_name, nil, false, is_non_null)
          end
        end
      end
      HALT
    else
      value
    end
  when GraphQL::Execution::Interpreter::RawValue
    # Write raw value directly to the response without resolving nested objects
    set_result(selection_result, result_name, value.resolve, false, is_non_null)
    HALT
  else
    value
  end
end

#current_path ⇒ Object

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



439
440
441
442
443
444
445
446
447
448
 
# File 'lib/graphql/execution/interpreter/runtime.rb', line 439

def current_path
  st = get_current_runtime_state
  result = st.current_result
  path = result && result.path
  if path && (rn = st.current_result_name)
    path = path.dup
    path.push(rn)
  end
  path
end

#delete_all_interpreter_context ⇒ Object

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



819
820
821
822
823
824
825
826
827
828
 
# File 'lib/graphql/execution/interpreter/runtime.rb', line 819

def delete_all_interpreter_context
  per_query_state = Thread.current[:__graphql_runtime_info]
  if per_query_state
    per_query_state.delete(@query)
    if per_query_state.size == 0
      Thread.current[:__graphql_runtime_info] = nil
    end
  end
  nil
end

#directives_include?(node, graphql_object, parent_type) ⇒ Boolean

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

Check Schema::Directive.include? for each directive that’s present

Returns:

  • (Boolean) 


718
719
720
721
722
723
724
725
726
727
 
# File 'lib/graphql/execution/interpreter/runtime.rb', line 718

def directives_include?(node, graphql_object, parent_type)
  node.directives.each do |dir_node|
    dir_defn = @schema_directives.fetch(dir_node.name)
    args = arguments(graphql_object, dir_defn, dir_node)
    if !dir_defn.include?(graphql_object, args, context)
      return false
    end
  end
  true
end

#each_gathered_selections(response_hash) ⇒ Object

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



110
111
112
113
114
115
116
117
118
119
 
# File 'lib/graphql/execution/interpreter/runtime.rb', line 110

def each_gathered_selections(response_hash)
  gathered_selections = gather_selections(response_hash.graphql_application_value, response_hash.graphql_result_type, response_hash.graphql_selections)
  if gathered_selections.is_a?(Array)
    gathered_selections.each do |item|
      yield(item, true)
    end
  else
    yield(gathered_selections, false)
  end
end

#evaluate_selection(result_name, field_ast_nodes_or_ast_node, selections_result) ⇒ void

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

This method returns an undefined value.



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/graphql/execution/interpreter/runtime.rb', line 234

def evaluate_selection(result_name, field_ast_nodes_or_ast_node, selections_result) # rubocop:disable Metrics/ParameterLists
  return if selections_result.graphql_dead
  # As a performance optimization, the hash key will be a `Node` if
  # there's only one selection of the field. But if there are multiple
  # selections of the field, it will be an Array of nodes
  if field_ast_nodes_or_ast_node.is_a?(Array)
    field_ast_nodes = field_ast_nodes_or_ast_node
    ast_node = field_ast_nodes.first
  else
    field_ast_nodes = nil
    ast_node = field_ast_nodes_or_ast_node
  end
  field_name = ast_node.name
  owner_type = selections_result.graphql_result_type
  field_defn = query.warden.get_field(owner_type, field_name)

  # Set this before calling `run_with_directives`, so that the directive can have the latest path
  runtime_state = get_current_runtime_state
  runtime_state.current_field = field_defn
  runtime_state.current_result = selections_result
  runtime_state.current_result_name = result_name

  owner_object = selections_result.graphql_application_value
  if field_defn.dynamic_introspection
    owner_object = field_defn.owner.wrap(owner_object, context)
  end

  if !field_defn.any_arguments?
    resolved_arguments = GraphQL::Execution::Interpreter::Arguments::EMPTY
    if field_defn.extras.size == 0
      evaluate_selection_with_resolved_keyword_args(
        NO_ARGS, resolved_arguments, field_defn, ast_node, field_ast_nodes, owner_object, result_name, selections_result, runtime_state
      )
    else
      evaluate_selection_with_args(resolved_arguments, field_defn, ast_node, field_ast_nodes, owner_object, result_name, selections_result, runtime_state)
    end
  else
    @query.arguments_cache.dataload_for(ast_node, field_defn, owner_object) do |resolved_arguments|
      runtime_state = get_current_runtime_state # This might be in a different fiber
      evaluate_selection_with_args(resolved_arguments, field_defn, ast_node, field_ast_nodes, owner_object, result_name, selections_result, runtime_state)
    end
  end
end

#evaluate_selection_with_args(arguments, field_defn, ast_node, field_ast_nodes, object, result_name, selection_result, runtime_state) ⇒ Object

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

rubocop:disable Metrics/ParameterLists



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/graphql/execution/interpreter/runtime.rb', line 278

def evaluate_selection_with_args(arguments, field_defn, ast_node, field_ast_nodes, object, result_name, selection_result, runtime_state)  # rubocop:disable Metrics/ParameterLists
  after_lazy(arguments, field: field_defn, ast_node: ast_node, owner_object: object, arguments: arguments, result_name: result_name, result: selection_result, runtime_state: runtime_state) do |resolved_arguments, runtime_state|
    if resolved_arguments.is_a?(GraphQL::ExecutionError) || resolved_arguments.is_a?(GraphQL::UnauthorizedError)
      return_type_non_null = field_defn.type.non_null?
      continue_value(resolved_arguments, field_defn, return_type_non_null, ast_node, result_name, selection_result)
      next
    end

    kwarg_arguments = if field_defn.extras.empty?
      if resolved_arguments.empty?
        # We can avoid allocating the `{ Symbol => Object }` hash in this case
        NO_ARGS
      else
        resolved_arguments.keyword_arguments
      end
    else
      # Bundle up the extras, then make a new arguments instance
      # that includes the extras, too.
      extra_args = {}
      field_defn.extras.each do |extra|
        case extra
        when :ast_node
          extra_args[:ast_node] = ast_node
        when :execution_errors
          extra_args[:execution_errors] = ExecutionErrors.new(context, ast_node, current_path)
        when :path
          extra_args[:path] = current_path
        when :lookahead
          if !field_ast_nodes
            field_ast_nodes = [ast_node]
          end

          extra_args[:lookahead] = Execution::Lookahead.new(
            query: query,
            ast_nodes: field_ast_nodes,
            field: field_defn,
          )
        when :argument_details
          # Use this flag to tell Interpreter::Arguments to add itself
          # to the keyword args hash _before_ freezing everything.
          extra_args[:argument_details] = :__arguments_add_self
        when :parent
          parent_result = selection_result.graphql_parent
          extra_args[:parent] = parent_result&.graphql_application_value&.object
        else
          extra_args[extra] = field_defn.fetch_extra(extra, context)
        end
      end
      if extra_args.any?
        resolved_arguments = resolved_arguments.merge_extras(extra_args)
      end
      resolved_arguments.keyword_arguments
    end

    evaluate_selection_with_resolved_keyword_args(kwarg_arguments, resolved_arguments, field_defn, ast_node, field_ast_nodes, object, result_name, selection_result, runtime_state)
  end
end

#evaluate_selection_with_resolved_keyword_args(kwarg_arguments, resolved_arguments, field_defn, ast_node, field_ast_nodes, object, result_name, selection_result, runtime_state) ⇒ Object

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

rubocop:disable Metrics/ParameterLists



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/graphql/execution/interpreter/runtime.rb', line 336

def evaluate_selection_with_resolved_keyword_args(kwarg_arguments, resolved_arguments, field_defn, ast_node, field_ast_nodes, object, result_name, selection_result, runtime_state)  # rubocop:disable Metrics/ParameterLists
  runtime_state.current_field = field_defn
  runtime_state.current_arguments = resolved_arguments
  runtime_state.current_result_name = result_name
  runtime_state.current_result = selection_result
  # Optimize for the case that field is selected only once
  if field_ast_nodes.nil? || field_ast_nodes.size == 1
    next_selections = ast_node.selections
    directives = ast_node.directives
  else
    next_selections = []
    directives = []
    field_ast_nodes.each { |f|
      next_selections.concat(f.selections)
      directives.concat(f.directives)
    }
  end

  field_result = call_method_on_directives(:resolve, object, directives) do
    if directives.any?
      # This might be executed in a different context; reset this info
      runtime_state = get_current_runtime_state
      runtime_state.current_field = field_defn
      runtime_state.current_arguments = resolved_arguments
      runtime_state.current_result_name = result_name
      runtime_state.current_result = selection_result
    end
    # Actually call the field resolver and capture the result
    app_result = begin
      @current_trace.execute_field(field: field_defn, ast_node: ast_node, query: query, object: object, arguments: kwarg_arguments) do
        field_defn.resolve(object, kwarg_arguments, context)
      end
    rescue GraphQL::ExecutionError => err
      err
    rescue StandardError => err
      begin
        query.handle_or_reraise(err)
      rescue GraphQL::ExecutionError => ex_err
        ex_err
      end
    end
    after_lazy(app_result, field: field_defn, ast_node: ast_node, owner_object: object, arguments: resolved_arguments, result_name: result_name, result: selection_result, runtime_state: runtime_state) do |inner_result, runtime_state|
      owner_type = selection_result.graphql_result_type
      return_type = field_defn.type
      continue_value = continue_value(inner_result, field_defn, return_type.non_null?, ast_node, result_name, selection_result)
      if HALT != continue_value
        was_scoped = runtime_state.was_authorized_by_scope_items
        runtime_state.was_authorized_by_scope_items = nil
        continue_field(continue_value, owner_type, field_defn, return_type, ast_node, next_selections, false, object, resolved_arguments, result_name, selection_result, was_scoped, runtime_state)
      end
    end
  end
  # If this field is a root mutation field, immediately resolve
  # all of its child fields before moving on to the next root mutation field.
  # (Subselections of this mutation will still be resolved level-by-level.)
  if selection_result.graphql_is_eager
    Interpreter::Resolve.resolve_all([field_result], @dataloader)
  end
end

#evaluate_selections(gathered_selections, selections_result, target_result, runtime_state) ⇒ void

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

This method returns an undefined value.



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/graphql/execution/interpreter/runtime.rb', line 198

def evaluate_selections(gathered_selections, selections_result, target_result, runtime_state) # rubocop:disable Metrics/ParameterLists
  runtime_state ||= get_current_runtime_state
  runtime_state.current_result_name = nil
  runtime_state.current_result = selections_result
  # This is a less-frequent case; use a fast check since it's often not there.
  if (directives = gathered_selections[:graphql_directives])
    gathered_selections.delete(:graphql_directives)
  end

  call_method_on_directives(:resolve, selections_result.graphql_application_value, directives) do
    finished_jobs = 0
    enqueued_jobs = gathered_selections.size
    gathered_selections.each do |result_name, field_ast_nodes_or_ast_node|
      @dataloader.append_job {
        evaluate_selection(
          result_name, field_ast_nodes_or_ast_node, selections_result
        )
        finished_jobs += 1
        if target_result && finished_jobs == enqueued_jobs
          selections_result.merge_into(target_result)
        end
      }
      # Field resolution may pause the fiber,
      # so it wouldn't get to the `Resolve` call that happens below.
      # So instead trigger a run from this outer context.
      if selections_result.graphql_is_eager
        @dataloader.clear_cache
        @dataloader.run
        @dataloader.clear_cache
      end
    end
    selections_result
  end
end

#final_result ⇒ Object

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



60
61
62
 
# File 'lib/graphql/execution/interpreter/runtime.rb', line 60

def final_result
  @response && @response.graphql_result_data
end

#gather_selections(owner_object, owner_type, selections, selections_to_run = nil, selections_by_name = {}) ⇒ Object

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



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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/graphql/execution/interpreter/runtime.rb', line 121

def gather_selections(owner_object, owner_type, selections, selections_to_run = nil, selections_by_name = {})
  selections.each do |node|
    # Skip gathering this if the directive says so
    if !directives_include?(node, owner_object, owner_type)
      next
    end

    if node.is_a?(GraphQL::Language::Nodes::Field)
      response_key = node.alias || node.name
      selections = selections_by_name[response_key]
      # if there was already a selection of this field,
      # use an array to hold all selections,
      # otherwise, use the single node to represent the selection
      if selections
        # This field was already selected at least once,
        # add this node to the list of selections
        s = Array(selections)
        s << node
        selections_by_name[response_key] = s
      else
        # No selection was found for this field yet
        selections_by_name[response_key] = node
      end
    else
      # This is an InlineFragment or a FragmentSpread
      if @runtime_directive_names.any? && node.directives.any? { |d| @runtime_directive_names.include?(d.name) }
        next_selections = {}
        next_selections[:graphql_directives] = node.directives
        if selections_to_run
          selections_to_run << next_selections
        else
          selections_to_run = []
          selections_to_run << selections_by_name
          selections_to_run << next_selections
        end
      else
        next_selections = selections_by_name
      end

      case node
      when GraphQL::Language::Nodes::InlineFragment
        if node.type
          type_defn = schema.get_type(node.type.name, context)

          if query.warden.possible_types(type_defn).include?(owner_type)
            result = gather_selections(owner_object, owner_type, node.selections, selections_to_run, next_selections)
            if !result.equal?(next_selections)
              selections_to_run = result
            end
          end
        else
          # it's an untyped fragment, definitely continue
          result = gather_selections(owner_object, owner_type, node.selections, selections_to_run, next_selections)
          if !result.equal?(next_selections)
            selections_to_run = result
          end
        end
      when GraphQL::Language::Nodes::FragmentSpread
        fragment_def = query.fragments[node.name]
        type_defn = query.get_type(fragment_def.type.name)
        if query.warden.possible_types(type_defn).include?(owner_type)
          result = gather_selections(owner_object, owner_type, fragment_def.selections, selections_to_run, next_selections)
          if !result.equal?(next_selections)
            selections_to_run = result
          end
        end
      else
        raise "Invariant: unexpected selection class: #{node.class}"
      end
    end
  end
  selections_to_run || selections_by_name
end

#get_current_runtime_state ⇒ Object

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



729
730
731
732
733
734
735
736
737
 
# File 'lib/graphql/execution/interpreter/runtime.rb', line 729

def get_current_runtime_state
  current_state = Thread.current[:__graphql_runtime_info] ||= begin
    per_query_state = {}
    per_query_state.compare_by_identity
    per_query_state
  end

  current_state[@query] ||= CurrentState.new
end

#inspect ⇒ Object

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



64
65
66
 
# File 'lib/graphql/execution/interpreter/runtime.rb', line 64

def inspect
  "#<#{self.class.name} response=#{@response.inspect}>"
end

#lazy?(object) ⇒ Boolean

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

Returns:

  • (Boolean) 


846
847
848
849
850
851
852
853
 
# File 'lib/graphql/execution/interpreter/runtime.rb', line 846

def lazy?(object)
  obj_class = object.class
  is_lazy = @lazy_cache[obj_class]
  if is_lazy.nil?
    is_lazy = @lazy_cache[obj_class] = @schema.lazy?(object)
  end
  is_lazy
end

#minimal_after_lazy(value, &block) ⇒ Object

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



739
740
741
742
743
744
745
746
747
748
749
 
# File 'lib/graphql/execution/interpreter/runtime.rb', line 739

def minimal_after_lazy(value, &block)
  if lazy?(value)
    GraphQL::Execution::Lazy.new do
      result = @schema.sync_lazy(value)
      # The returned result might also be lazy, so check it, too
      minimal_after_lazy(result, &block)
    end
  else
    yield(value)
  end
end

#resolve_list_item(inner_value, inner_type, inner_type_non_null, ast_node, field, owner_object, arguments, this_idx, response_list, owner_type, was_scoped, runtime_state) ⇒ Object

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

rubocop:disable Metrics/ParameterLists



672
673
674
675
676
677
678
679
680
681
682
683
684
 
# File 'lib/graphql/execution/interpreter/runtime.rb', line 672

def resolve_list_item(inner_value, inner_type, inner_type_non_null, ast_node, field, owner_object, arguments, this_idx, response_list, owner_type, was_scoped, runtime_state) # rubocop:disable Metrics/ParameterLists
  runtime_state.current_result_name = this_idx
  runtime_state.current_result = response_list
  call_method_on_directives(:resolve_each, owner_object, ast_node.directives) do
    # This will update `response_list` with the lazy
    after_lazy(inner_value, ast_node: ast_node, field: field, owner_object: owner_object, arguments: arguments, result_name: this_idx, result: response_list, runtime_state: runtime_state) do |inner_inner_value, runtime_state|
      continue_value = continue_value(inner_inner_value, field, inner_type_non_null, ast_node, this_idx, response_list)
      if HALT != continue_value
        continue_field(continue_value, owner_type, field, inner_type, ast_node, response_list.graphql_selections, false, owner_object, arguments, this_idx, response_list, was_scoped, runtime_state)
      end
    end
  end
end

#resolve_type(type, value) ⇒ Object

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



830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
 
# File 'lib/graphql/execution/interpreter/runtime.rb', line 830

def resolve_type(type, value)
  resolved_type, resolved_value = @current_trace.resolve_type(query: query, type: type, object: value) do
    query.resolve_type(type, value)
  end

  if lazy?(resolved_type)
    GraphQL::Execution::Lazy.new do
      @current_trace.resolve_type_lazy(query: query, type: type, object: value) do
        schema.sync_lazy(resolved_type)
      end
    end
  else
    [resolved_type, resolved_value]
  end
end

#run_directive(method_name, object, directives, idx, &block) ⇒ Object

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



691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
 
# File 'lib/graphql/execution/interpreter/runtime.rb', line 691

def run_directive(method_name, object, directives, idx, &block)
  dir_node = directives[idx]
  if !dir_node
    yield
  else
    dir_defn = @schema_directives.fetch(dir_node.name)
    raw_dir_args = arguments(nil, dir_defn, dir_node)
    dir_args = continue_value(
      raw_dir_args, # value
      nil, # field
      false, # is_non_null
      dir_node, # ast_node
      nil, # result_name
      nil, # selection_result
    )

    if dir_args == HALT
      nil
    else
      dir_defn.public_send(method_name, object, dir_args, context) do
        run_directive(method_name, object, directives, idx + 1, &block)
      end
    end
  end
end

#run_eager ⇒ void

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

This method returns an undefined value.

This begins the execution. Some deferred work might be stored up in lazies.



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
 
# File 'lib/graphql/execution/interpreter/runtime.rb', line 71

def run_eager
  root_operation = query.selected_operation
  root_op_type = root_operation.operation_type || "query"
  root_type = schema.root_type_for_operation(root_op_type)
  runtime_object = root_type.wrap(query.root_value, context)
  runtime_object = schema.sync_lazy(runtime_object)
  is_eager = root_op_type == "mutation"
  @response = GraphQLResultHash.new(nil, root_type, runtime_object, nil, false, root_operation.selections, is_eager)
  st = get_current_runtime_state
  st.current_result = @response

  if runtime_object.nil?
    # Root .authorized? returned false.
    @response = nil
  else
    call_method_on_directives(:resolve, runtime_object, root_operation.directives) do # execute query level directives
      each_gathered_selections(@response) do |selections, is_selection_array|
        if is_selection_array
          selection_response = GraphQLResultHash.new(nil, root_type, runtime_object, nil, false, selections, is_eager)
          final_response = @response
        else
          selection_response = @response
          final_response = nil
        end

        @dataloader.append_job {
          evaluate_selections(
            selections,
            selection_response,
            final_response,
            nil,
          )
        }
      end
    end
  end
  nil
end

#set_graphql_dead(selection_result) ⇒ Object

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

Mark this node and any already-registered children as dead, so that it accepts no more writes.



426
427
428
429
430
431
432
433
434
435
436
437
 
# File 'lib/graphql/execution/interpreter/runtime.rb', line 426

def set_graphql_dead(selection_result)
  case selection_result
  when GraphQLResultArray
    selection_result.graphql_dead = true
    selection_result.values.each { |v| set_graphql_dead(v) }
  when GraphQLResultHash
    selection_result.graphql_dead = true
    selection_result.each { |k, v| set_graphql_dead(v) }
  else
    # It's a scalar, no way to mark it dead.
  end
end

#set_result(selection_result, result_name, value, is_child_result, is_non_null) ⇒ Object

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



396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/graphql/execution/interpreter/runtime.rb', line 396

def set_result(selection_result, result_name, value, is_child_result, is_non_null)
  if !selection_result.graphql_dead
    if value.nil? && is_non_null
      # This is an invalid nil that should be propagated
      # One caller of this method passes a block,
      # namely when application code returns a `nil` to GraphQL and it doesn't belong there.
      # The other possibility for reaching here is when a field returns an ExecutionError, so we write
      # `nil` to the response, not knowing whether it's an invalid `nil` or not.
      # (And in that case, we don't have to call the schema's handler, since it's not a bug in the application.)
      # TODO the code is trying to tell me something.
      yield if block_given?
      parent = selection_result.graphql_parent
      if parent.nil? # This is a top-level result hash
        @response = nil
      else
        name_in_parent = selection_result.graphql_result_name
        is_non_null_in_parent = selection_result.graphql_is_non_null_in_parent
        set_result(parent, name_in_parent, nil, false, is_non_null_in_parent)
        set_graphql_dead(selection_result)
      end
    elsif is_child_result
      selection_result.set_child_result(result_name, value)
    else
      selection_result.set_leaf(result_name, value)
    end
  end
end