Module: GraphQL::Schema::Member::HasArguments Private

Included in:
Directive, Field, InputObject, Resolver
Defined in:
lib/graphql/schema/member/has_arguments.rb

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

Defined Under Namespace

Modules: ArgumentClassAccessor, ArgumentObjectLoader

Constant Summary collapse

NO_ARGUMENTS =

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. 

{}.freeze

Instance Method Summary collapse

Instance Method Details

#add_argument(arg_defn) ⇒ GraphQL::Schema::Argument

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.

Register this argument with the class.

Parameters:

Returns:



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/graphql/schema/member/has_arguments.rb', line 79

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

#all_argument_definitions ⇒ 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. 



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
 
# File 'lib/graphql/schema/member/has_arguments.rb', line 141

def all_argument_definitions
  if self.is_a?(Class)
    all_defns = {}
    ancestors.reverse_each do |ancestor|
      if ancestor.respond_to?(:own_arguments)
        all_defns.merge!(ancestor.own_arguments)
      end
    end
  elsif defined?(@resolver_class) && @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)
  else
    all_defns = own_arguments
  end
  all_defns = all_defns.values
  all_defns.flatten!
  all_defns
end

#argument(*args, **kwargs, &block) ⇒ GraphQL::Schema::Argument

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 An instance of #argument_class, created from *args.

Returns:

See Also:

  • for parameters


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
 
# File 'lib/graphql/schema/member/has_arguments.rb', line 18

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).schema.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}")
        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

#argument_class(new_arg_class = nil) ⇒ 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.

Parameters:

  • new_arg_class (Class) (defaults to: nil) —

    A class to use for building argument definitions



197
198
199
 
# File 'lib/graphql/schema/member/has_arguments.rb', line 197

def argument_class(new_arg_class = nil)
  self.class.argument_class(new_arg_class)
end

#arguments(context = GraphQL::Query::NullContext) ⇒ Hash<String => GraphQL::Schema::Argument] Arguments defined on this thing, keyed by name. Includes inherited definitions

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 Hash<String => GraphQL::Schema::Argument] Arguments defined on this thing, keyed by name. Includes inherited definitions.

Returns:

  • (Hash<String => GraphQL::Schema::Argument] Arguments defined on this thing, keyed by name. Includes inherited definitions) —

    Hash<String => GraphQL::Schema::Argument] Arguments defined on this thing, keyed by name. Includes inherited definitions



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
 
# File 'lib/graphql/schema/member/has_arguments.rb', line 111

def arguments(context = GraphQL::Query::NullContext)
  inherited_arguments = if self.is_a?(Class) && superclass.respond_to?(:arguments)
    superclass.arguments(context)
  elsif defined?(@resolver_class) && @resolver_class
    @resolver_class.field_arguments(context)
  else
    nil
  end
  # Local definitions override inherited ones
  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

  if inherited_arguments
    if own_arguments_that_apply
      inherited_arguments.merge(own_arguments_that_apply)
    else
      inherited_arguments
    end
  else
    # might be nil if there are actually no arguments
    own_arguments_that_apply || own_arguments
  end
end

#arguments_statically_coercible? ⇒ 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:



275
276
277
278
279
 
# File 'lib/graphql/schema/member/has_arguments.rb', line 275

def arguments_statically_coercible?
  return @arguments_statically_coercible if defined?(@arguments_statically_coercible)

  @arguments_statically_coercible = all_argument_definitions.all?(&:statically_coercible?)
end

#coerce_arguments(parent_object, values, context) {|Interpreter::Arguments, Execution::Lazy<Interpeter::Arguments>| ... } ⇒ Interpreter::Arguments, Execution::Lazy<Interpeter::Arguments>

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.

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).

Parameters:

Yields:

Returns:



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
 
# File 'lib/graphql/schema/member/has_arguments.rb', line 210

def coerce_arguments(parent_object, values, context, &block)
  # Cache this hash to avoid re-merging it
  arg_defns = self.arguments(context)
  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_name, 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

#get_argument(argument_name, context = GraphQL::Query::NullContext) ⇒ GraphQL::Schema::Argument?

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 Argument defined on this thing, fetched by name.

Returns:



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/graphql/schema/member/has_arguments.rb', line 174

def get_argument(argument_name, context = GraphQL::Query::NullContext)
  warden = Warden.from_context(context)
  if !self.is_a?(Class)
    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
  else
    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

#own_arguments ⇒ 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. 



364
365
366
 
# File 'lib/graphql/schema/member/has_arguments.rb', line 364

def own_arguments
  @own_arguments || NO_ARGUMENTS
end

#remove_argument(arg_defn) ⇒ 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. 



95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/graphql/schema/member/has_arguments.rb', line 95

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

#validate_directive_argument(arg_defn, 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.

Usually, this is validated statically by RequiredArgumentsArePresent, but not for directives. TODO apply static validations on schema definitions?



267
268
269
270
271
272
273
 
# File 'lib/graphql/schema/member/has_arguments.rb', line 267

def validate_directive_argument(arg_defn, value)
  if arg_defn.owner.is_a?(Class) && arg_defn.owner < GraphQL::Schema::Directive
    if value.nil? && arg_defn.type.non_null?
      raise ArgumentError, "#{arg_defn.path} is required, but no value was given"
    end
  end
end