/
field.rb
846 lines (762 loc) · 34.2 KB
/
field.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
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
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
194
195
196
197
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
232
233
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
277
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
335
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
395
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
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
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
548
549
550
551
552
553
554
555
556
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
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
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
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
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
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
# frozen_string_literal: true
require "graphql/schema/field/connection_extension"
require "graphql/schema/field/scope_extension"
module GraphQL
class Schema
class Field
include GraphQL::Schema::Member::HasArguments
include GraphQL::Schema::Member::HasAstNode
include GraphQL::Schema::Member::HasPath
include GraphQL::Schema::Member::HasValidators
extend GraphQL::Schema::FindInheritedValue
include GraphQL::Schema::FindInheritedValue::EmptyObjects
include GraphQL::Schema::Member::HasDirectives
include GraphQL::Schema::Member::HasDeprecationReason
class FieldImplementationFailed < GraphQL::Error; end
# @return [String] the GraphQL name for this field, camelized unless `camelize: false` is provided
attr_reader :name
alias :graphql_name :name
attr_writer :description
# @return [Symbol] Method or hash key on the underlying object to look up
attr_reader :method_sym
# @return [String] Method or hash key on the underlying object to look up
attr_reader :method_str
attr_reader :hash_key
attr_reader :dig_keys
# @return [Symbol] The method on the type to look up
def resolver_method
if @resolver_class
@resolver_class.resolver_method
else
@resolver_method
end
end
# @return [Class] The thing this field was defined on (type, mutation, resolver)
attr_accessor :owner
# @return [Class] The GraphQL type this field belongs to. (For fields defined on mutations, it's the payload type)
def owner_type
@owner_type ||= if owner.nil?
raise GraphQL::InvariantError, "Field #{original_name.inspect} (graphql name: #{graphql_name.inspect}) has no owner, but all fields should have an owner. How did this happen?!"
elsif owner < GraphQL::Schema::Mutation
owner.payload_type
else
owner
end
end
# @return [Symbol] the original name of the field, passed in by the user
attr_reader :original_name
# @return [Class, nil] The {Schema::Resolver} this field was derived from, if there is one
def resolver
@resolver_class
end
# @return [Boolean] Is this field a predefined introspection field?
def introspection?
@introspection
end
def inspect
"#<#{self.class} #{path}#{all_argument_definitions.any? ? "(...)" : ""}: #{type.to_type_signature}>"
end
alias :mutation :resolver
# @return [Boolean] Apply tracing to this field? (Default: skip scalars, this is the override value)
attr_reader :trace
# @return [String, nil]
def subscription_scope
@subscription_scope || (@resolver_class.respond_to?(:subscription_scope) ? @resolver_class.subscription_scope : nil)
end
attr_writer :subscription_scope
# Create a field instance from a list of arguments, keyword arguments, and a block.
#
# This method implements prioritization between the `resolver` or `mutation` defaults
# and the local overrides via other keywords.
#
# It also normalizes positional arguments into keywords for {Schema::Field#initialize}.
# @param resolver [Class] A {GraphQL::Schema::Resolver} class to use for field configuration
# @param mutation [Class] A {GraphQL::Schema::Mutation} class to use for field configuration
# @param subscription [Class] A {GraphQL::Schema::Subscription} class to use for field configuration
# @return [GraphQL::Schema:Field] an instance of `self
# @see {.initialize} for other options
def self.from_options(name = nil, type = nil, desc = nil, resolver: nil, mutation: nil, subscription: nil,**kwargs, &block)
if (resolver_class = resolver || mutation || subscription)
# Add a reference to that parent class
kwargs[:resolver_class] = resolver_class
end
if name
kwargs[:name] = name
end
if !type.nil?
if desc
if kwargs[:description]
raise ArgumentError, "Provide description as a positional argument or `description:` keyword, but not both (#{desc.inspect}, #{kwargs[:description].inspect})"
end
kwargs[:description] = desc
kwargs[:type] = type
elsif (resolver || mutation) && type.is_a?(String)
# The return type should be copied from the resolver, and the second positional argument is the description
kwargs[:description] = type
else
kwargs[:type] = type
end
if type.is_a?(Class) && type < GraphQL::Schema::Mutation
raise ArgumentError, "Use `field #{name.inspect}, mutation: Mutation, ...` to provide a mutation to this field instead"
end
end
new(**kwargs, &block)
end
# Can be set with `connection: true|false` or inferred from a type name ending in `*Connection`
# @return [Boolean] if true, this field will be wrapped with Relay connection behavior
def connection?
if @connection.nil?
# Provide default based on type name
return_type_name = if @resolver_class && @resolver_class.type
Member::BuildType.to_type_name(@resolver_class.type)
elsif @return_type_expr
Member::BuildType.to_type_name(@return_type_expr)
else
# As a last ditch, try to force loading the return type:
type.unwrap.name
end
@connection = return_type_name.end_with?("Connection")
else
@connection
end
end
# @return [Boolean] if true, the return type's `.scope_items` method will be applied to this field's return value
def scoped?
if !@scope.nil?
# The default was overridden
@scope
elsif @return_type_expr
# Detect a list return type, but don't call `type` since that may eager-load an otherwise lazy-loaded type
@return_type_expr.is_a?(Array) ||
(@return_type_expr.is_a?(String) && @return_type_expr.include?("[")) ||
connection?
elsif @resolver_class
resolver_type = @resolver_class.type_expr
resolver_type.is_a?(Array) ||
(resolver_type.is_a?(String) && resolver_type.include?("[")) ||
connection?
else
false
end
end
# This extension is applied to fields when {#connection?} is true.
#
# You can override it in your base field definition.
# @return [Class] A {FieldExtension} subclass for implementing pagination behavior.
# @example Configuring a custom extension
# class Types::BaseField < GraphQL::Schema::Field
# connection_extension(MyCustomExtension)
# end
def self.connection_extension(new_extension_class = nil)
if new_extension_class
@connection_extension = new_extension_class
else
@connection_extension ||= find_inherited_value(:connection_extension, ConnectionExtension)
end
end
# @return Boolean
attr_reader :relay_node_field
# @return [Boolean] Should we warn if this field's name conflicts with a built-in method?
def method_conflict_warning?
@method_conflict_warning
end
# @param name [Symbol] The underscore-cased version of this field name (will be camelized for the GraphQL API)
# @param type [Class, GraphQL::BaseType, Array] The return type of this field
# @param owner [Class] The type that this field belongs to
# @param null [Boolean] (defaults to `true`) `true` if this field may return `null`, `false` if it is never `null`
# @param description [String] Field description
# @param deprecation_reason [String] If present, the field is marked "deprecated" with this message
# @param method [Symbol] The method to call on the underlying object to resolve this field (defaults to `name`)
# @param hash_key [String, Symbol] The hash key to lookup on the underlying object (if its a Hash) to resolve this field (defaults to `name` or `name.to_s`)
# @param dig [Array<String, Symbol>] The nested hash keys to lookup on the underlying hash to resolve this field using dig
# @param resolver_method [Symbol] The method on the type to call to resolve this field (defaults to `name`)
# @param connection [Boolean] `true` if this field should get automagic connection behavior; default is to infer by `*Connection` in the return type name
# @param connection_extension [Class] The extension to add, to implement connections. If `nil`, no extension is added.
# @param max_page_size [Integer, nil] For connections, the maximum number of items to return from this field, or `nil` to allow unlimited results.
# @param introspection [Boolean] If true, this field will be marked as `#introspection?` and the name may begin with `__`
# @param resolver_class [Class] (Private) A {Schema::Resolver} which this field was derived from. Use `resolver:` to create a field with a resolver.
# @param arguments [{String=>GraphQL::Schema::Argument, Hash}] Arguments for this field (may be added in the block, also)
# @param camelize [Boolean] If true, the field name will be camelized when building the schema
# @param complexity [Numeric] When provided, set the complexity for this field
# @param scope [Boolean] If true, the return type's `.scope_items` method will be called on the return value
# @param subscription_scope [Symbol, String] A key in `context` which will be used to scope subscription payloads
# @param extensions [Array<Class, Hash<Class => Object>>] Named extensions to apply to this field (see also {#extension})
# @param directives [Hash{Class => Hash}] Directives to apply to this field
# @param trace [Boolean] If true, a {GraphQL::Tracing} tracer will measure this scalar field
# @param broadcastable [Boolean] Whether or not this field can be distributed in subscription broadcasts
# @param ast_node [Language::Nodes::FieldDefinition, nil] If this schema was parsed from definition, this AST node defined the field
# @param method_conflict_warning [Boolean] If false, skip the warning if this field's method conflicts with a built-in method
# @param validates [Array<Hash>] Configurations for validating this field
# @fallback_value [Object] A fallback value if the method is not defined
def initialize(type: nil, name: nil, owner: nil, null: nil, description: :not_given, deprecation_reason: nil, method: nil, hash_key: nil, dig: nil, resolver_method: nil, connection: nil, max_page_size: :not_given, scope: nil, introspection: false, camelize: true, trace: nil, complexity: nil, ast_node: nil, extras: EMPTY_ARRAY, extensions: EMPTY_ARRAY, connection_extension: self.class.connection_extension, resolver_class: nil, subscription_scope: nil, relay_node_field: false, relay_nodes_field: false, method_conflict_warning: true, broadcastable: nil, arguments: EMPTY_HASH, directives: EMPTY_HASH, validates: EMPTY_ARRAY, fallback_value: :not_given, &definition_block)
if name.nil?
raise ArgumentError, "missing first `name` argument or keyword `name:`"
end
if !(resolver_class)
if type.nil?
raise ArgumentError, "missing second `type` argument or keyword `type:`"
end
end
@original_name = name
name_s = -name.to_s
@underscored_name = -Member::BuildType.underscore(name_s)
@name = -(camelize ? Member::BuildType.camelize(name_s) : name_s)
if description != :not_given
@description = description
end
self.deprecation_reason = deprecation_reason
if method && hash_key && dig
raise ArgumentError, "Provide `method:`, `hash_key:` _or_ `dig:`, not multiple. (called with: `method: #{method.inspect}, hash_key: #{hash_key.inspect}, dig: #{dig.inspect}`)"
end
if resolver_method
if method
raise ArgumentError, "Provide `method:` _or_ `resolver_method:`, not both. (called with: `method: #{method.inspect}, resolver_method: #{resolver_method.inspect}`)"
end
if hash_key || dig
raise ArgumentError, "Provide `hash_key:`, `dig:`, _or_ `resolver_method:`, not multiple. (called with: `hash_key: #{hash_key.inspect}, dig: #{dig.inspect}, resolver_method: #{resolver_method.inspect}`)"
end
end
method_name = method || hash_key || name_s
@dig_keys = dig
if hash_key
@hash_key = hash_key
@hash_key_str = hash_key.to_s
end
@method_str = -method_name.to_s
@method_sym = method_name.to_sym
@resolver_method = (resolver_method || name_s).to_sym
@complexity = complexity
@return_type_expr = type
@return_type_null = if !null.nil?
null
elsif resolver_class
nil
else
true
end
@connection = connection
@has_max_page_size = max_page_size != :not_given
@max_page_size = max_page_size == :not_given ? nil : max_page_size
@introspection = introspection
@extras = extras
if !broadcastable.nil?
@broadcastable = broadcastable
end
@resolver_class = resolver_class
@scope = scope
@trace = trace
@relay_node_field = relay_node_field
@relay_nodes_field = relay_nodes_field
@ast_node = ast_node
@method_conflict_warning = method_conflict_warning
@fallback_value = fallback_value
arguments.each do |name, arg|
case arg
when Hash
argument(name: name, **arg)
when GraphQL::Schema::Argument
add_argument(arg)
when Array
arg.each { |a| add_argument(a) }
else
raise ArgumentError, "Unexpected argument config (#{arg.class}): #{arg.inspect}"
end
end
@owner = owner
@subscription_scope = subscription_scope
@extensions = EMPTY_ARRAY
@call_after_define = false
# This should run before connection extension,
# but should it run after the definition block?
if scoped?
self.extension(ScopeExtension)
end
# The problem with putting this after the definition_block
# is that it would override arguments
if connection? && connection_extension
self.extension(connection_extension)
end
# Do this last so we have as much context as possible when initializing them:
if extensions.any?
self.extensions(extensions)
end
if resolver_class && resolver_class.extensions.any?
self.extensions(resolver_class.extensions)
end
if directives.any?
directives.each do |(dir_class, options)|
self.directive(dir_class, **options)
end
end
if !validates.empty?
self.validates(validates)
end
if definition_block
if definition_block.arity == 1
yield self
else
instance_eval(&definition_block)
end
end
self.extensions.each(&:after_define_apply)
@call_after_define = true
end
# If true, subscription updates with this field can be shared between viewers
# @return [Boolean, nil]
# @see GraphQL::Subscriptions::BroadcastAnalyzer
def broadcastable?
if defined?(@broadcastable)
@broadcastable
elsif @resolver_class
@resolver_class.broadcastable?
else
nil
end
end
# @param text [String]
# @return [String]
def description(text = nil)
if text
@description = text
elsif defined?(@description)
@description
elsif @resolver_class
@description || @resolver_class.description
else
nil
end
end
# Read extension instances from this field,
# or add new classes/options to be initialized on this field.
# Extensions are executed in the order they are added.
#
# @example adding an extension
# extensions([MyExtensionClass])
#
# @example adding multiple extensions
# extensions([MyExtensionClass, AnotherExtensionClass])
#
# @example adding an extension with options
# extensions([MyExtensionClass, { AnotherExtensionClass => { filter: true } }])
#
# @param extensions [Array<Class, Hash<Class => Hash>>] Add extensions to this field. For hash elements, only the first key/value is used.
# @return [Array<GraphQL::Schema::FieldExtension>] extensions to apply to this field
def extensions(new_extensions = nil)
if new_extensions
new_extensions.each do |extension_config|
if extension_config.is_a?(Hash)
extension_class, options = *extension_config.to_a[0]
self.extension(extension_class, options)
else
self.extension(extension_config)
end
end
end
@extensions
end
# Add `extension` to this field, initialized with `options` if provided.
#
# @example adding an extension
# extension(MyExtensionClass)
#
# @example adding an extension with options
# extension(MyExtensionClass, filter: true)
#
# @param extension_class [Class] subclass of {Schema::FieldExtension}
# @param options [Hash] if provided, given as `options:` when initializing `extension`.
# @return [void]
def extension(extension_class, options = nil)
extension_inst = extension_class.new(field: self, options: options)
if @extensions.frozen?
@extensions = @extensions.dup
end
if @call_after_define
extension_inst.after_define_apply
end
@extensions << extension_inst
nil
end
# Read extras (as symbols) from this field,
# or add new extras to be opted into by this field's resolver.
#
# @param new_extras [Array<Symbol>] Add extras to this field
# @return [Array<Symbol>]
def extras(new_extras = nil)
if new_extras.nil?
# Read the value
field_extras = @extras
if @resolver_class && @resolver_class.extras.any?
field_extras + @resolver_class.extras
else
field_extras
end
else
if @extras.frozen?
@extras = @extras.dup
end
# Append to the set of extras on this field
@extras.concat(new_extras)
end
end
def calculate_complexity(query:, nodes:, child_complexity:)
if respond_to?(:complexity_for)
lookahead = GraphQL::Execution::Lookahead.new(query: query, field: self, ast_nodes: nodes, owner_type: owner)
complexity_for(child_complexity: child_complexity, query: query, lookahead: lookahead)
elsif connection?
arguments = query.arguments_for(nodes.first, self)
max_possible_page_size = nil
if arguments.respond_to?(:[]) # It might have been an error
if arguments[:first]
max_possible_page_size = arguments[:first]
end
if arguments[:last] && (max_possible_page_size.nil? || arguments[:last] > max_possible_page_size)
max_possible_page_size = arguments[:last]
end
end
if max_possible_page_size.nil?
max_possible_page_size = max_page_size || query.schema.default_max_page_size
end
if max_possible_page_size.nil?
raise GraphQL::Error, "Can't calculate complexity for #{path}, no `first:`, `last:`, `max_page_size` or `default_max_page_size`"
else
metadata_complexity = 0
lookahead = GraphQL::Execution::Lookahead.new(query: query, field: self, ast_nodes: nodes, owner_type: owner)
if (page_info_lookahead = lookahead.selection(:page_info)).selected?
metadata_complexity += 1 # pageInfo
metadata_complexity += page_info_lookahead.selections.size # subfields
end
if lookahead.selects?(:total) || lookahead.selects?(:total_count) || lookahead.selects?(:count)
metadata_complexity += 1
end
nodes_edges_complexity = 0
nodes_edges_complexity += 1 if lookahead.selects?(:edges)
nodes_edges_complexity += 1 if lookahead.selects?(:nodes)
# Possible bug: selections on `edges` and `nodes` are _both_ multiplied here. Should they be?
items_complexity = child_complexity - metadata_complexity - nodes_edges_complexity
# Add 1 for _this_ field
1 + (max_possible_page_size * items_complexity) + metadata_complexity + nodes_edges_complexity
end
else
defined_complexity = complexity
case defined_complexity
when Proc
arguments = query.arguments_for(nodes.first, self)
if arguments.is_a?(GraphQL::ExecutionError)
return child_complexity
elsif arguments.respond_to?(:keyword_arguments)
arguments = arguments.keyword_arguments
end
defined_complexity.call(query.context, arguments, child_complexity)
when Numeric
defined_complexity + child_complexity
else
raise("Invalid complexity: #{defined_complexity.inspect} on #{path} (#{inspect})")
end
end
end
def complexity(new_complexity = nil)
case new_complexity
when Proc
if new_complexity.parameters.size != 3
fail(
"A complexity proc should always accept 3 parameters: ctx, args, child_complexity. "\
"E.g.: complexity ->(ctx, args, child_complexity) { child_complexity * args[:limit] }"
)
else
@complexity = new_complexity
end
when Numeric
@complexity = new_complexity
when nil
if @resolver_class
@complexity || @resolver_class.complexity || 1
else
@complexity || 1
end
else
raise("Invalid complexity: #{new_complexity.inspect} on #{@name}")
end
end
# @return [Boolean] True if this field's {#max_page_size} should override the schema default.
def has_max_page_size?
@has_max_page_size || (@resolver_class && @resolver_class.has_max_page_size?)
end
# @return [Integer, nil] Applied to connections if {#has_max_page_size?}
def max_page_size
@max_page_size || (@resolver_class && @resolver_class.max_page_size)
end
class MissingReturnTypeError < GraphQL::Error; end
attr_writer :type
def type
if @resolver_class
return_type = @return_type_expr || @resolver_class.type_expr
if return_type.nil?
raise MissingReturnTypeError, "Can't determine the return type for #{self.path} (it has `resolver: #{@resolver_class}`, perhaps that class is missing a `type ...` declaration, or perhaps its type causes a cyclical loading issue)"
end
nullable = @return_type_null.nil? ? @resolver_class.null : @return_type_null
Member::BuildType.parse_type(return_type, null: nullable)
else
@type ||= Member::BuildType.parse_type(@return_type_expr, null: @return_type_null)
end
rescue GraphQL::Schema::InvalidDocumentError, MissingReturnTypeError => err
# Let this propagate up
raise err
rescue StandardError => err
raise MissingReturnTypeError, "Failed to build return type for #{@owner.graphql_name}.#{name} from #{@return_type_expr.inspect}: (#{err.class}) #{err.message}", err.backtrace
end
def visible?(context)
if @resolver_class
@resolver_class.visible?(context)
else
true
end
end
def accessible?(context)
if @resolver_class
@resolver_class.accessible?(context)
else
true
end
end
def authorized?(object, args, context)
if @resolver_class
# The resolver _instance_ will check itself during `resolve()`
@resolver_class.authorized?(object, context)
else
if (arg_values = context[:current_arguments])
# ^^ that's provided by the interpreter at runtime, and includes info about whether the default value was used or not.
using_arg_values = true
arg_values = arg_values.argument_values
else
arg_values = args
using_arg_values = false
end
# Faster than `.any?`
arguments(context).each_value do |arg|
arg_key = arg.keyword
if arg_values.key?(arg_key)
arg_value = arg_values[arg_key]
if using_arg_values
if arg_value.default_used?
# pass -- no auth required for default used
next
else
application_arg_value = arg_value.value
if application_arg_value.is_a?(GraphQL::Execution::Interpreter::Arguments)
application_arg_value.keyword_arguments
end
end
else
application_arg_value = arg_value
end
if !arg.authorized?(object, application_arg_value, context)
return false
end
end
end
true
end
end
# This method is called by the interpreter for each field.
# You can extend it in your base field classes.
# @param object [GraphQL::Schema::Object] An instance of some type class, wrapping an application object
# @param args [Hash] A symbol-keyed hash of Ruby keyword arguments. (Empty if no args)
# @param ctx [GraphQL::Query::Context]
def resolve(object, args, query_ctx)
# Unwrap the GraphQL object to get the application object.
application_object = object.object
method_receiver = nil
method_to_call = nil
method_args = nil
Schema::Validator.validate!(validators, application_object, query_ctx, args)
query_ctx.schema.after_lazy(self.authorized?(application_object, args, query_ctx)) do |is_authorized|
if is_authorized
with_extensions(object, args, query_ctx) do |obj, ruby_kwargs|
method_args = ruby_kwargs
if @resolver_class
if obj.is_a?(GraphQL::Schema::Object)
obj = obj.object
end
obj = @resolver_class.new(object: obj, context: query_ctx, field: self)
end
inner_object = obj.object
if defined?(@hash_key)
inner_object[@hash_key] || inner_object[@hash_key_str] || (@fallback_value != :not_given ? @fallback_value : nil)
elsif obj.respond_to?(resolver_method)
method_to_call = resolver_method
method_receiver = obj
# Call the method with kwargs, if there are any
if ruby_kwargs.any?
obj.public_send(resolver_method, **ruby_kwargs)
else
obj.public_send(resolver_method)
end
elsif inner_object.is_a?(Hash)
if @dig_keys
inner_object.dig(*@dig_keys)
elsif defined?(@hash_key)
if inner_object.key?(@hash_key)
inner_object[@hash_key]
elsif inner_object.key?(@hash_key_str)
inner_object[@hash_key_str]
elsif @fallback_value != :not_given
@fallback_value
else
nil
end
elsif inner_object.key?(@method_sym)
inner_object[@method_sym]
elsif inner_object.key?(@method_str)
inner_object[@method_str]
elsif @fallback_value != :not_given
@fallback_value
else
nil
end
elsif inner_object.respond_to?(@method_sym)
method_to_call = @method_sym
method_receiver = obj.object
if ruby_kwargs.any?
inner_object.public_send(@method_sym, **ruby_kwargs)
else
inner_object.public_send(@method_sym)
end
elsif @fallback_value != :not_given
@fallback_value
else
raise <<-ERR
Failed to implement #{@owner.graphql_name}.#{@name}, tried:
- `#{obj.class}##{resolver_method}`, which did not exist
- `#{inner_object.class}##{@method_sym}`, which did not exist
- Looking up hash key `#{@method_sym.inspect}` or `#{@method_str.inspect}` on `#{inner_object}`, but it wasn't a Hash
To implement this field, define one of the methods above (and check for typos), or supply a `fallback_value`.
ERR
end
end
else
raise GraphQL::UnauthorizedFieldError.new(object: application_object, type: object.class, context: query_ctx, field: self)
end
end
rescue GraphQL::UnauthorizedFieldError => err
err.field ||= self
begin
query_ctx.schema.unauthorized_field(err)
rescue GraphQL::ExecutionError => err
err
end
rescue GraphQL::UnauthorizedError => err
begin
query_ctx.schema.unauthorized_object(err)
rescue GraphQL::ExecutionError => err
err
end
rescue ArgumentError
if method_receiver && method_to_call
assert_satisfactory_implementation(method_receiver, method_to_call, method_args)
end
# if the line above doesn't raise, re-raise
raise
end
# @param ctx [GraphQL::Query::Context]
def fetch_extra(extra_name, ctx)
if extra_name != :path && extra_name != :ast_node && respond_to?(extra_name)
self.public_send(extra_name)
elsif ctx.respond_to?(extra_name)
ctx.public_send(extra_name)
else
raise GraphQL::RequiredImplementationMissingError, "Unknown field extra for #{self.path}: #{extra_name.inspect}"
end
end
private
def assert_satisfactory_implementation(receiver, method_name, ruby_kwargs)
method_defn = receiver.method(method_name)
unsatisfied_ruby_kwargs = ruby_kwargs.dup
unsatisfied_method_params = []
encountered_keyrest = false
method_defn.parameters.each do |(param_type, param_name)|
case param_type
when :key
unsatisfied_ruby_kwargs.delete(param_name)
when :keyreq
if unsatisfied_ruby_kwargs.key?(param_name)
unsatisfied_ruby_kwargs.delete(param_name)
else
unsatisfied_method_params << "- `#{param_name}:` is required by Ruby, but not by GraphQL. Consider `#{param_name}: nil` instead, or making this argument required in GraphQL."
end
when :keyrest
encountered_keyrest = true
when :req
unsatisfied_method_params << "- `#{param_name}` is required by Ruby, but GraphQL doesn't pass positional arguments. If it's meant to be a GraphQL argument, use `#{param_name}:` instead. Otherwise, remove it."
when :opt, :rest
# This is fine, although it will never be present
end
end
if encountered_keyrest
unsatisfied_ruby_kwargs.clear
end
if unsatisfied_ruby_kwargs.any? || unsatisfied_method_params.any?
raise FieldImplementationFailed.new, <<-ERR
Failed to call `#{method_name.inspect}` on #{receiver.inspect} because the Ruby method params were incompatible with the GraphQL arguments:
#{ unsatisfied_ruby_kwargs
.map { |key, value| "- `#{key}: #{value}` was given by GraphQL but not defined in the Ruby method. Add `#{key}:` to the method parameters." }
.concat(unsatisfied_method_params)
.join("\n") }
ERR
end
end
# Wrap execution with hooks.
# Written iteratively to avoid big stack traces.
# @return [Object] Whatever the
def with_extensions(obj, args, ctx)
if @extensions.empty?
yield(obj, args)
else
# This is a hack to get the _last_ value for extended obj and args,
# in case one of the extensions doesn't `yield`.
# (There's another implementation that uses multiple-return, but I'm wary of the perf cost of the extra arrays)
extended = { args: args, obj: obj, memos: nil, added_extras: nil }
value = run_extensions_before_resolve(obj, args, ctx, extended) do |obj, args|
if (added_extras = extended[:added_extras])
args = args.dup
added_extras.each { |e| args.delete(e) }
end
yield(obj, args)
end
extended_obj = extended[:obj]
extended_args = extended[:args]
memos = extended[:memos] || EMPTY_HASH
ctx.schema.after_lazy(value) do |resolved_value|
idx = 0
@extensions.each do |ext|
memo = memos[idx]
# TODO after_lazy?
resolved_value = ext.after_resolve(object: extended_obj, arguments: extended_args, context: ctx, value: resolved_value, memo: memo)
idx += 1
end
resolved_value
end
end
end
def run_extensions_before_resolve(obj, args, ctx, extended, idx: 0)
extension = @extensions[idx]
if extension
extension.resolve(object: obj, arguments: args, context: ctx) do |extended_obj, extended_args, memo|
if memo
memos = extended[:memos] ||= {}
memos[idx] = memo
end
if (extras = extension.added_extras)
ae = extended[:added_extras] ||= []
ae.concat(extras)
end
extended[:obj] = extended_obj
extended[:args] = extended_args
run_extensions_before_resolve(extended_obj, extended_args, ctx, extended, idx: idx + 1) { |o, a| yield(o, a) }
end
else
yield(obj, args)
end
end
end
end
end