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
|
# frozen_string_literal: true
module GraphQL
class Schema
class Member
module HasArguments
def self.included(cls)
cls.extend(ArgumentClassAccessor)
cls.include(ArgumentObjectLoader)
end
def self.extended(cls)
cls.extend(ArgumentClassAccessor)
cls.include(ArgumentObjectLoader)
cls.extend(ClassConfigured)
end
# @see {GraphQL::Schema::Argument#initialize} for parameters
# @return [GraphQL::Schema::Argument] An instance of {argument_class}, created from `*args`
def argument(*args, **kwargs, &block)
kwargs[:owner] = self
loads = kwargs[:loads]
if loads
name = args[0]
name_as_string = name.to_s
inferred_arg_name = case name_as_string
when /_id$/
name_as_string.sub(/_id$/, "").to_sym
when /_ids$/
name_as_string.sub(/_ids$/, "")
.sub(/([^s])$/, "\\1s")
.to_sym
else
name
end
kwargs[:as] ||= inferred_arg_name
end
arg_defn = self.argument_class.new(*args, **kwargs, &block)
add_argument(arg_defn)
if self.is_a?(Class) && !method_defined?(:"load_#{arg_defn.keyword}")
method_owner = if self < GraphQL::Schema::InputObject || self < GraphQL::Schema::Directive
"self."
elsif self < GraphQL::Schema::Resolver
""
else
raise "Unexpected argument owner: #{self}"
end
if loads && arg_defn.type.list?
class_eval <<-RUBY, __FILE__, __LINE__ + 1
def #{method_owner}load_#{arg_defn.keyword}(values, context = nil)
argument = get_argument("#{arg_defn.graphql_name}", context || self.context)
(context || self.context).query.after_lazy(values) do |values2|
GraphQL::Execution::Lazy.all(values2.map { |value| load_application_object(argument, value, context || self.context) })
end
end
RUBY
elsif loads
class_eval <<-RUBY, __FILE__, __LINE__ + 1
def #{method_owner}load_#{arg_defn.keyword}(value, context = nil)
argument = get_argument("#{arg_defn.graphql_name}", context || self.context)
load_application_object(argument, value, context || self.context)
end
RUBY
else
class_eval <<-RUBY, __FILE__, __LINE__ + 1
def #{method_owner}load_#{arg_defn.keyword}(value, _context = nil)
value
end
RUBY
end
end
arg_defn
end
# Register this argument with the class.
# @param arg_defn [GraphQL::Schema::Argument]
# @return [GraphQL::Schema::Argument]
def add_argument(arg_defn)
@own_arguments ||= {}
prev_defn = @own_arguments[arg_defn.name]
case prev_defn
when nil
@own_arguments[arg_defn.name] = arg_defn
when Array
prev_defn << arg_defn
when GraphQL::Schema::Argument
@own_arguments[arg_defn.name] = [prev_defn, arg_defn]
else
raise "Invariant: unexpected `@own_arguments[#{arg_defn.name.inspect}]`: #{prev_defn.inspect}"
end
arg_defn
end
def remove_argument(arg_defn)
prev_defn = @own_arguments[arg_defn.name]
case prev_defn
when nil
# done
when Array
prev_defn.delete(arg_defn)
when GraphQL::Schema::Argument
@own_arguments.delete(arg_defn.name)
else
raise "Invariant: unexpected `@own_arguments[#{arg_defn.name.inspect}]`: #{prev_defn.inspect}"
end
nil
end
# @return [Hash<String => GraphQL::Schema::Argument] Arguments defined on this thing, keyed by name. Includes inherited definitions
def arguments(context = GraphQL::Query::NullContext.instance)
if own_arguments.any?
own_arguments_that_apply = {}
own_arguments.each do |name, args_entry|
if (visible_defn = Warden.visible_entry?(:visible_argument?, args_entry, context))
own_arguments_that_apply[visible_defn.graphql_name] = visible_defn
end
end
end
# might be nil if there are actually no arguments
own_arguments_that_apply || own_arguments
end
def any_arguments?
own_arguments.any?
end
module ClassConfigured
def inherited(child_class)
super
child_class.extend(InheritedArguments)
end
module InheritedArguments
def arguments(context = GraphQL::Query::NullContext.instance)
own_arguments = super
inherited_arguments = superclass.arguments(context)
if own_arguments.any?
if inherited_arguments.any?
# Local definitions override inherited ones
inherited_arguments.merge(own_arguments)
else
own_arguments
end
else
inherited_arguments
end
end
def any_arguments?
super || superclass.any_arguments?
end
def all_argument_definitions
all_defns = {}
ancestors.reverse_each do |ancestor|
if ancestor.respond_to?(:own_arguments)
all_defns.merge!(ancestor.own_arguments)
end
end
all_defns = all_defns.values
all_defns.flatten!
all_defns
end
def get_argument(argument_name, context = GraphQL::Query::NullContext.instance)
warden = Warden.from_context(context)
for ancestor in ancestors
if ancestor.respond_to?(:own_arguments) &&
(a = ancestor.own_arguments[argument_name]) &&
(a = Warden.visible_entry?(:visible_argument?, a, context, warden))
return a
end
end
nil
end
end
end
module FieldConfigured
def arguments(context = GraphQL::Query::NullContext.instance)
own_arguments = super
if @resolver_class
inherited_arguments = @resolver_class.field_arguments(context)
if own_arguments.any?
if inherited_arguments.any?
inherited_arguments.merge(own_arguments)
else
own_arguments
end
else
inherited_arguments
end
else
own_arguments
end
end
def any_arguments?
super || (@resolver_class && @resolver_class.any_field_arguments?)
end
def all_argument_definitions
if @resolver_class
all_defns = {}
@resolver_class.all_field_argument_definitions.each do |arg_defn|
key = arg_defn.graphql_name
case (current_value = all_defns[key])
when nil
all_defns[key] = arg_defn
when Array
current_value << arg_defn
when GraphQL::Schema::Argument
all_defns[key] = [current_value, arg_defn]
else
raise "Invariant: Unexpected argument definition, #{current_value.class}: #{current_value.inspect}"
end
end
all_defns.merge!(own_arguments)
all_defns = all_defns.values
all_defns.flatten!
all_defns
else
super
end
end
end
def all_argument_definitions
all_defns = own_arguments.values
all_defns.flatten!
all_defns
end
# @return [GraphQL::Schema::Argument, nil] Argument defined on this thing, fetched by name.
def get_argument(argument_name, context = GraphQL::Query::NullContext.instance)
warden = Warden.from_context(context)
if (arg_config = own_arguments[argument_name]) && (visible_arg = Warden.visible_entry?(:visible_argument?, arg_config, context, warden))
visible_arg
elsif defined?(@resolver_class) && @resolver_class
@resolver_class.get_field_argument(argument_name, context)
else
nil
end
end
# @param new_arg_class [Class] A class to use for building argument definitions
def argument_class(new_arg_class = nil)
self.class.argument_class(new_arg_class)
end
# @api private
# If given a block, it will eventually yield the loaded args to the block.
#
# If no block is given, it will immediately dataload (but might return a Lazy).
#
# @param values [Hash<String, Object>]
# @param context [GraphQL::Query::Context]
# @yield [Interpreter::Arguments, Execution::Lazy<Interpeter::Arguments>]
# @return [Interpreter::Arguments, Execution::Lazy<Interpeter::Arguments>]
def coerce_arguments(parent_object, values, context, &block)
# Cache this hash to avoid re-merging it
arg_defns = context.warden.arguments(self)
total_args_count = arg_defns.size
finished_args = nil
prepare_finished_args = -> {
if total_args_count == 0
finished_args = GraphQL::Execution::Interpreter::Arguments::EMPTY
if block_given?
block.call(finished_args)
end
else
argument_values = {}
resolved_args_count = 0
raised_error = false
arg_defns.each do |arg_defn|
context.dataloader.append_job do
begin
arg_defn.coerce_into_values(parent_object, values, context, argument_values)
rescue GraphQL::ExecutionError, GraphQL::UnauthorizedError => err
raised_error = true
finished_args = err
if block_given?
block.call(finished_args)
end
end
resolved_args_count += 1
if resolved_args_count == total_args_count && !raised_error
finished_args = context.schema.after_any_lazies(argument_values.values) {
GraphQL::Execution::Interpreter::Arguments.new(
argument_values: argument_values,
)
}
if block_given?
block.call(finished_args)
end
end
end
end
end
}
if block_given?
prepare_finished_args.call
nil
else
# This API returns eagerly, gotta run it now
context.dataloader.run_isolated(&prepare_finished_args)
finished_args
end
end
# Usually, this is validated statically by RequiredArgumentsArePresent,
# but not for directives.
# TODO apply static validations on schema definitions?
def validate_directive_argument(arg_defn, value)
# this is only implemented on directives.
nil
end
module HasDirectiveArguments
def validate_directive_argument(arg_defn, value)
if value.nil? && arg_defn.type.non_null?
raise ArgumentError, "#{arg_defn.path} is required, but no value was given"
end
end
end
def arguments_statically_coercible?
if defined?(@arguments_statically_coercible) && !@arguments_statically_coercible.nil?
@arguments_statically_coercible
else
@arguments_statically_coercible = all_argument_definitions.all?(&:statically_coercible?)
end
end
module ArgumentClassAccessor
def argument_class(new_arg_class = nil)
if new_arg_class
@argument_class = new_arg_class
elsif defined?(@argument_class) && @argument_class
@argument_class
else
superclass.respond_to?(:argument_class) ? superclass.argument_class : GraphQL::Schema::Argument
end
end
end
module ArgumentObjectLoader
# Look up the corresponding object for a provided ID.
# By default, it uses Relay-style {Schema.object_from_id},
# override this to find objects another way.
#
# @param type [Class, Module] A GraphQL type definition
# @param id [String] A client-provided to look up
# @param context [GraphQL::Query::Context] the current context
def object_from_id(type, id, context)
context.schema.object_from_id(id, context)
end
def load_application_object(argument, id, context)
# See if any object can be found for this ID
if id.nil?
return nil
end
object_from_id(argument.loads, id, context)
end
def load_and_authorize_application_object(argument, id, context)
loaded_application_object = load_application_object(argument, id, context)
authorize_application_object(argument, id, context, loaded_application_object)
end
def authorize_application_object(argument, id, context, loaded_application_object)
context.query.after_lazy(loaded_application_object) do |application_object|
if application_object.nil?
err = GraphQL::LoadApplicationObjectFailedError.new(context: context, argument: argument, id: id, object: application_object)
application_object = load_application_object_failed(err)
end
# Double-check that the located object is actually of this type
# (Don't want to allow arbitrary access to objects this way)
if application_object.nil?
nil
else
maybe_lazy_resolve_type = context.schema.resolve_type(argument.loads, application_object, context)
context.query.after_lazy(maybe_lazy_resolve_type) do |resolve_type_result|
if resolve_type_result.is_a?(Array) && resolve_type_result.size == 2
application_object_type, application_object = resolve_type_result
else
application_object_type = resolve_type_result
# application_object is already assigned
end
if !(
context.warden.possible_types(argument.loads).include?(application_object_type) ||
context.warden.loadable?(argument.loads, context)
)
err = GraphQL::LoadApplicationObjectFailedError.new(context: context, argument: argument, id: id, object: application_object)
application_object = load_application_object_failed(err)
end
if application_object.nil?
nil
else
# This object was loaded successfully
# and resolved to the right type,
# now apply the `.authorized?` class method if there is one
context.query.after_lazy(application_object_type.authorized?(application_object, context)) do |authed|
if authed
application_object
else
err = GraphQL::UnauthorizedError.new(
object: application_object,
type: application_object_type,
context: context,
)
if self.respond_to?(:unauthorized_object)
err.set_backtrace(caller)
unauthorized_object(err)
else
raise err
end
end
end
end
end
end
end
end
def load_application_object_failed(err)
raise err
end
end
NO_ARGUMENTS = GraphQL::EmptyObjects::EMPTY_HASH
def own_arguments
@own_arguments || NO_ARGUMENTS
end
end
end
end
end
|