Class: GraphQL::Schema::Field

Inherits:
Object
  • Object
show all
Includes:
Member::AcceptsDefinition, Member::CachedGraphQLDefinition, Member::HasArguments, Member::HasPath
Defined in:
lib/graphql/schema/field.rb

Direct Known Subclasses

Types::Relay::BaseField

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Member::HasPath

#path

Methods included from Member::HasArguments

#add_argument, #argument, #argument_class, #arguments, #own_arguments

Methods included from Member::CachedGraphQLDefinition

#graphql_definition, #initialize_copy

Constructor Details

#initialize(type: nil, name: nil, owner: nil, null: nil, field: nil, function: nil, description: nil, deprecation_reason: nil, method: nil, connection: nil, max_page_size: nil, scope: nil, resolve: nil, introspection: false, hash_key: nil, camelize: true, trace: nil, complexity: 1, extras: [], resolver_class: nil, subscription_scope: nil, arguments: {}, &definition_block) ⇒ Field

Returns a new instance of Field.

Parameters:

  • name (Symbol) (defaults to: nil) —

    The underscore-cased version of this field name (will be camelized for the GraphQL API)

  • return_type_expr (Class, GraphQL::BaseType, Array) —

    The return type of this field

  • desc (String) —

    Field description

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

    The type that this field belongs to

  • null (Boolean) (defaults to: nil) —

    true if this field may return null, false if it is never null

  • description (String) (defaults to: nil) —

    Field description

  • deprecation_reason (String) (defaults to: nil) —

    If present, the field is marked "deprecated" with this message

  • method (Symbol) (defaults to: nil) —

    The method to call to resolve this field (defaults to name)

  • hash_key (Object) (defaults to: nil) —

    The hash key to lookup to resolve this field (defaults to name or name.to_s)

  • connection (Boolean) (defaults to: nil) —

    true if this field should get automagic connection behavior; default is to infer by *Connection in the return type name

  • max_page_size (Integer) (defaults to: nil) —

    For connections, the maximum number of items to return from this field

  • introspection (Boolean) (defaults to: false) —

    If true, this field will be marked as #introspection? and the name may begin with __

  • resolve (<#call(obj, args, ctx)>) (defaults to: nil) —

    deprecated for compatibility with <1.8.0

  • field (GraphQL::Field, GraphQL::Schema::Field) (defaults to: nil) —

    deprecated for compatibility with <1.8.0

  • function (GraphQL::Function) (defaults to: nil) —

    deprecated for compatibility with <1.8.0

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

    (Private) A Resolver which this field was derived from. Use resolver: to create a field with a resolver.

  • arguments ({String=>GraphQL::Schema::Argument, Hash}) (defaults to: {}) —

    Arguments for this field (may be added in the block, also)

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

    If true, the field name will be camelized when building the schema

  • complexity (Numeric) (defaults to: 1) —

    When provided, set the complexity for this field

  • scope (Boolean) (defaults to: nil) —

    If true, the return type's .scope_items method will be called on the return value

  • subscription_scope (Symbol, String) (defaults to: nil) —

    A key in context which will be used to scope subscription payloads



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
 
# File 'lib/graphql/schema/field.rb', line 132

def initialize(type: nil, name: nil, owner: nil, null: nil, field: nil, function: nil, description: nil, deprecation_reason: nil, method: nil, connection: nil, max_page_size: nil, scope: nil, resolve: nil, introspection: false, hash_key: nil, camelize: true, trace: nil, complexity: 1, extras: [], resolver_class: nil, subscription_scope: nil, arguments: {}, &definition_block)

  if name.nil?
    raise ArgumentError, "missing first `name` argument or keyword `name:`"
  end
  if !(field || function || resolver_class)
    if type.nil?
      raise ArgumentError, "missing second `type` argument or keyword `type:`"
    end
    if null.nil?
      raise ArgumentError, "missing keyword argument null:"
    end
  end
  if (field || function || resolve) && extras.any?
    raise ArgumentError, "keyword `extras:` may only be used with method-based resolve and class-based field such as mutation class, please remove `field:`, `function:` or `resolve:`"
  end
  @original_name = name
  @name = camelize ? Member::BuildType.camelize(name.to_s) : name.to_s
  @description = description
  if field.is_a?(GraphQL::Schema::Field)
    @field_instance = field
  else
    @field = field
  end
  @function = function
  @resolve = resolve
  @deprecation_reason = deprecation_reason
  if method && hash_key
    raise ArgumentError, "Provide `method:` _or_ `hash_key:`, not both. (called with: `method: #{method.inspect}, hash_key: #{hash_key.inspect}`)"
  end

  # TODO: I think non-string/symbol hash keys are wrongly normalized (eg `1` will not work)
  method_name = method || hash_key || Member::BuildType.underscore(name.to_s)

  @method_str = method_name.to_s
  @method_sym = method_name.to_sym
  @complexity = complexity
  @return_type_expr = type
  @return_type_null = null
  @connection = connection
  @max_page_size = max_page_size
  @introspection = introspection
  @extras = extras
  @resolver_class = resolver_class
  @scope = scope
  @trace = trace

  # Override the default from HasArguments
  @own_arguments = {}
  arguments.each do |name, arg|
    if arg.is_a?(Hash)
      argument(name: name, **arg)
    else
      @own_arguments[name] = arg
    end
  end

  @owner = owner
  @subscription_scope = subscription_scope

  if definition_block
    if definition_block.arity == 1
      yield self
    else
      instance_eval(&definition_block)
    end
  end
end

Instance Attribute Details

#deprecation_reason ⇒ String?

Returns If present, the field is marked as deprecated with this documentation.

Returns:

  • (String, nil) —

    If present, the field is marked as deprecated with this documentation



18
19
20
 
# File 'lib/graphql/schema/field.rb', line 18

def deprecation_reason
  @deprecation_reason
end

#description(text = nil) ⇒ String

Parameters:

  • text (String) (defaults to: nil)

Returns:

  • (String) 


203
204
205
206
207
208
209
 
# File 'lib/graphql/schema/field.rb', line 203

def description(text = nil)
  if text
    @description = text
  else
    @description
  end
end

#method_str ⇒ String (readonly)

Returns Method or hash key to look up.

Returns:

  • (String) —

    Method or hash key to look up



24
25
26
 
# File 'lib/graphql/schema/field.rb', line 24

def method_str
  @method_str
end

#method_sym ⇒ Symbol (readonly)

Returns Method or hash key to look up.

Returns:

  • (Symbol) —

    Method or hash key to look up



21
22
23
 
# File 'lib/graphql/schema/field.rb', line 21

def method_sym
  @method_sym
end

#name ⇒ String (readonly) Also known as: graphql_name

Returns the GraphQL name for this field, camelized unless camelize: false is provided.

Returns:

  • (String) —

    the GraphQL name for this field, camelized unless camelize: false is provided



12
13
14
 
# File 'lib/graphql/schema/field.rb', line 12

def name
  @name
end

#original_name ⇒ Symobol (readonly)

Returns the orignal name of the field, passed in by the user.

Returns:

  • (Symobol) —

    the orignal name of the field, passed in by the user



30
31
32
 
# File 'lib/graphql/schema/field.rb', line 30

def original_name
  @original_name
end

#owner ⇒ Class (readonly)

Returns The type that this field belongs to.

Returns:

  • (Class) —

    The type that this field belongs to



27
28
29
 
# File 'lib/graphql/schema/field.rb', line 27

def owner
  @owner
end

Class Method Details

.from_options(name = nil, type = nil, desc = nil, resolver: nil, mutation: nil, **kwargs, &block) ⇒ GraphQL::Schema:Field

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 #initialize.

Parameters:

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

    A Resolver class to use for field configuration

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

    A Mutation class to use for field configuration

Returns:

  • (GraphQL::Schema:Field) —

    an instance of `self

See Also:

  • for other options


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
 
# File 'lib/graphql/schema/field.rb', line 50

def self.from_options(name = nil, type = nil, desc = nil, resolver: nil, mutation: nil, **kwargs, &block)
  if (parent_config = resolver || mutation)
    # Get the parent config, merge in local overrides
    kwargs = parent_config.field_options.merge(kwargs)
    # Add a reference to that parent class
    kwargs[:resolver_class] = parent_config
  end

  if name
    kwargs[:name] = name
  end

  if !type.nil?
    if type.is_a?(GraphQL::Field)
      raise ArgumentError, "A GraphQL::Field was passed as the second argument, use the `field:` keyword for this instead."
    end
    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 (kwargs[:field] || kwargs[:function] || resolver || mutation) && type.is_a?(String)
      # The return type should be copied from `field` or `function`, and the second positional argument is the description
      kwargs[:description] = type
    else
      kwargs[:type] = type
    end
  end
  new(**kwargs, &block)
end

Instance Method Details

#accessible?(context) ⇒ Boolean

Returns:

  • (Boolean) 


322
323
324
325
326
327
328
 
# File 'lib/graphql/schema/field.rb', line 322

def accessible?(context)
  if @resolver_class
    @resolver_class.accessible?(context)
  else
    true
  end
end

#authorized?(object, context) ⇒ Boolean

Returns:

  • (Boolean) 


330
331
332
333
334
335
336
 
# File 'lib/graphql/schema/field.rb', line 330

def authorized?(object, context)
  if @resolver_class
    @resolver_class.authorized?(object, context)
  else
    true
  end
end

#complexity(new_complexity) ⇒ Object 



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/graphql/schema/field.rb', line 211

def complexity(new_complexity)
  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
  else
    raise("Invalid complexity: #{new_complexity.inspect} on #{@name}")
  end

end

#connection? ⇒ Boolean

Can be set with connection: true|false or inferred from a type name ending in *Connection

Returns:

  • (Boolean) —

    if true, this field will be wrapped with Relay connection behavior



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/graphql/schema/field.rb', line 85

def connection?
  if @connection.nil?
    # Provide default based on type name
    return_type_name = if (contains_type = @field || @function)
      Member::BuildType.to_type_name(contains_type.type)
    elsif @return_type_expr
      Member::BuildType.to_type_name(@return_type_expr)
    else
      raise "No connection info possible"
    end
    @connection = return_type_name.end_with?("Connection")
  else
    @connection
  end
end

#resolve_field(obj, args, ctx) ⇒ Object

Implement Field's resolve API.

Eventually, we might hook up field instances to execution in another way. TBD.



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/graphql/schema/field.rb', line 341

def resolve_field(obj, args, ctx)
  ctx.schema.after_lazy(obj) do |after_obj|
    # First, apply auth ...
    query_ctx = ctx.query.context
    # Some legacy fields can have `nil` here, not exactly sure why.
    # @see https://github.com/rmosolgo/graphql-ruby/issues/1990 before removing
    inner_obj = after_obj && after_obj.object
    if authorized?(inner_obj, query_ctx) && arguments.each_value.all? { |a| a.authorized?(inner_obj, query_ctx) }
      # Then if it passed, resolve the field
      v = if @resolve_proc
        # Might be nil, still want to call the func in that case
        @resolve_proc.call(inner_obj, args, ctx)
      elsif @resolver_class
        singleton_inst = @resolver_class.new(object: inner_obj, context: query_ctx)
        public_send_field(singleton_inst, args, ctx)
      else
        public_send_field(after_obj, args, ctx)
      end
      apply_scope(v, ctx)
    else
      nil
    end
  end
end

#resolve_field_method(obj, ruby_kwargs, ctx) ⇒ Object

Find a way to resolve this field, checking:

  • Hash keys, if the wrapped object is a hash;
  • A method on the wrapped object;
  • Or, raise not implemented.

This can be overridden by defining a method on the object type.

Parameters:



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
 
# File 'lib/graphql/schema/field.rb', line 376

def resolve_field_method(obj, ruby_kwargs, ctx)
  if obj.object.is_a?(Hash)
    inner_object = obj.object
    if inner_object.key?(@method_sym)
      inner_object[@method_sym]
    else
      inner_object[@method_str]
    end
  elsif obj.object.respond_to?(@method_sym)
    if ruby_kwargs.any?
      obj.object.public_send(@method_sym, **ruby_kwargs)
    else
      obj.object.public_send(@method_sym)
    end
  else
    raise <<-ERR
  Failed to implement #{@owner.graphql_name}.#{@name}, tried:

  - `#{obj.class}##{@method_sym}`, which did not exist
  - `#{obj.object.class}##{@method_sym}`, which did not exist
  - Looking up hash key `#{@method_sym.inspect}` or `#{@method_str.inspect}` on `#{obj.object}`, but it wasn't a Hash

  To implement this field, define one of the methods above (and check for typos)
  ERR
  end
end

#resolver ⇒ Class? Also known as: mutation

Returns The Resolver this field was derived from, if there is one.

Returns:

  • (Class, nil) —

    The Resolver this field was derived from, if there is one



34
35
36
 
# File 'lib/graphql/schema/field.rb', line 34

def resolver
  @resolver_class
end

#scoped? ⇒ Boolean

Returns if true, the return type's .scope_items method will be applied to this field's return value.

Returns:

  • (Boolean) —

    if true, the return type's .scope_items method will be applied to this field's return value



102
103
104
105
106
107
108
109
 
# File 'lib/graphql/schema/field.rb', line 102

def scoped?
  if !@scope.nil?
    # The default was overridden
    @scope
  else
    @return_type_expr && type.unwrap.respond_to?(:scope_items) && (connection? || type.list?)
  end
end

#to_graphql ⇒ GraphQL::Field

Returns:



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
 
# File 'lib/graphql/schema/field.rb', line 231

def to_graphql
  # this field was previously defined and passed here, so delegate to it
  if @field_instance
    return @field_instance.to_graphql
  end


  field_defn = if @field
    @field.dup
  elsif @function
    GraphQL::Function.build_field(@function)
  else
    GraphQL::Field.new
  end

  field_defn.name = @name
  if @return_type_expr
    field_defn.type = -> { type }
  end

  if @description
    field_defn.description = @description
  end

  if @deprecation_reason
    field_defn.deprecation_reason = @deprecation_reason
  end

  if @resolver_class
    if @resolver_class < GraphQL::Schema::Mutation
      field_defn.mutation = @resolver_class
    end
    field_defn.metadata[:resolver] = @resolver_class
  end

  if !@trace.nil?
    field_defn.trace = @trace
  end

  field_defn.resolve = self.method(:resolve_field)
  field_defn.connection = connection?
  field_defn.connection_max_page_size = @max_page_size
  field_defn.introspection = @introspection
  field_defn.complexity = @complexity
  field_defn.subscription_scope = @subscription_scope

  # apply this first, so it can be overriden below
  if connection?
    # TODO: this could be a bit weird, because these fields won't be present
    # after initialization, only in the `to_graphql` response.
    # This calculation _could_ be moved up if need be.
    argument :after, "String", "Returns the elements in the list that come after the specified cursor.", required: false
    argument :before, "String", "Returns the elements in the list that come before the specified cursor.", required: false
    argument :first, "Int", "Returns the first _n_ elements from the list.", required: false
    argument :last, "Int", "Returns the last _n_ elements from the list.", required: false
  end

  arguments.each do |name, defn|
    arg_graphql = defn.to_graphql
    field_defn.arguments[arg_graphql.name] = arg_graphql
  end

  # Support a passed-in proc, one way or another
  @resolve_proc = if @resolve
    @resolve
  elsif @function
    @function
  elsif @field
    @field.resolve_proc
  end

  # Ok, `self` isn't a class, but this is for consistency with the classes
  field_defn.metadata[:type_class] = self

  field_defn
end

#type ⇒ Object 



308
309
310
311
312
 
# File 'lib/graphql/schema/field.rb', line 308

def type
  @type ||= Member::BuildType.parse_type(@return_type_expr, null: @return_type_null)
rescue
  raise ArgumentError, "Failed to build return type for #{@owner.graphql_name}.#{name} from #{@return_type_expr.inspect}: #{$!.message}", $!.backtrace
end

#visible?(context) ⇒ Boolean

Returns:

  • (Boolean) 


314
315
316
317
318
319
320
 
# File 'lib/graphql/schema/field.rb', line 314

def visible?(context)
  if @resolver_class
    @resolver_class.visible?(context)
  else
    true
  end
end