Class: GraphQL::Query

Inherits:
Object
  • Object
show all
Extended by:
Forwardable, Autoload
Includes:
Runnable, Tracing::Traceable
Defined in:
lib/graphql/query.rb,
lib/graphql/query/result.rb,
lib/graphql/query/context.rb,
lib/graphql/query/partial.rb,
lib/graphql/query/variables.rb,
lib/graphql/query/fingerprint.rb,
lib/graphql/query/null_context.rb,
lib/graphql/query/validation_pipeline.rb,
lib/graphql/query/context/scoped_context.rb,
lib/graphql/query/input_validation_result.rb,
lib/graphql/query/variable_validation_error.rb

Overview

A combination of query string and Schema instance which can be reduced to a #result.

Defined Under Namespace

Modules: Fingerprint, Runnable Classes: Context, InputValidationResult, NullContext, OperationNameMissingError, Partial, Result, ValidationPipeline, VariableValidationError, Variables

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Autoload

autoload, eager_load!

Methods included from Runnable

#after_lazy, #arguments_cache, #arguments_for, #handle_or_reraise

Methods included from Tracing::Traceable

#trace

Constructor Details

#initialize(schema, query_string = nil, query: nil, document: nil, context: nil, variables: nil, multiplex: nil, validate: true, static_validator: nil, visibility_profile: nil, subscription_topic: nil, operation_name: nil, root_value: nil, max_depth: schema.max_depth, max_complexity: schema.max_complexity, warden: nil, use_visibility_profile: nil) ⇒ Query

Prepare query query_string on schema

Parameters:

  • schema (GraphQL::Schema)
  • query_string (String) (defaults to: nil)
  • context (#[]) (defaults to: nil) —

    an arbitrary hash of values which you can access in Field#resolve

  • variables (Hash) (defaults to: nil) —

    values for $variables in the query

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

    if the query string contains many operations, this is the one which should be executed

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

    the object used to resolve fields on the root type

  • max_depth (Numeric) (defaults to: schema.max_depth) —

    the maximum number of nested selections allowed for this query (falls back to schema-level value)

  • max_complexity (Numeric) (defaults to: schema.max_complexity) —

    the maximum field complexity for this query (falls back to schema-level value)

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

    Another way to assign context[:visibility_profile]



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
 
# File 'lib/graphql/query.rb', line 136

def initialize(schema, query_string = nil, query: nil, document: nil, context: nil, variables: nil, multiplex: nil, validate: true, static_validator: nil, visibility_profile: nil, subscription_topic: nil, operation_name: nil, root_value: nil, max_depth: schema.max_depth, max_complexity: schema.max_complexity, warden: nil, use_visibility_profile: nil)
  # Even if `variables: nil` is passed, use an empty hash for simpler logic
  variables ||= {}
  @multiplex = multiplex
  @schema = schema
  @context = schema.context_class.new(query: self, values: context)
  if visibility_profile
    @context[:visibility_profile] ||= visibility_profile
  end

  if use_visibility_profile.nil?
    use_visibility_profile = warden ? false : schema.use_visibility_profile?
  end

  if use_visibility_profile
    @visibility_profile = @schema.visibility.profile_for(@context)
    @warden = Schema::Warden::NullWarden.new(context: @context, schema: @schema)
  else
    @visibility_profile = nil
    @warden = warden
  end

  @subscription_topic = subscription_topic
  @root_value = root_value
  @fragments = nil
  @operations = nil
  @validate = validate
  self.static_validator = static_validator if static_validator
  context_tracers = (context ? context.fetch(:tracers, []) : [])
  @tracers = schema.tracers + context_tracers

  if !context_tracers.empty? && !(schema.trace_class <= GraphQL::Tracing::CallLegacyTracers)
    raise ArgumentError, "context[:tracers] are not supported without `trace_with(GraphQL::Tracing::CallLegacyTracers)` in the schema configuration, please add it."
  end

  @analysis_errors = []
  if variables.is_a?(String)
    raise ArgumentError, "Query variables should be a Hash, not a String. Try JSON.parse to prepare variables."
  else
    @provided_variables = variables || {}
  end

  @query_string = query_string || query
  @document = document

  if @query_string && @document
    raise ArgumentError, "Query should only be provided a query string or a document, not both."
  end

  if @query_string && !@query_string.is_a?(String)
    raise ArgumentError, "Query string argument should be a String, got #{@query_string.class.name} instead."
  end

  # A two-layer cache of type resolution:
  # { abstract_type => { value => resolved_type } }
  @resolved_types_cache = Hash.new do |h1, k1|
    h1[k1] = Hash.new do |h2, k2|
      h2[k2] = @schema.resolve_type(k1, k2, @context)
    end
  end

  # Trying to execute a document
  # with no operations returns an empty hash
  @ast_variables = []
  @mutation = false
  @operation_name = operation_name
  @prepared_ast = false
  @validation_pipeline = nil
  @max_depth = max_depth
  @max_complexity = max_complexity

  @result_values = nil
  @executed = false

  @logger = schema.logger_for(context)
end

Instance Attribute Details

#analysis_errors ⇒ Object

Returns the value of attribute analysis_errors.



362
363
364
 
# File 'lib/graphql/query.rb', line 362

def analysis_errors
  @analysis_errors
end

#context ⇒ Object (readonly)

Returns the value of attribute context.



65
66
67
 
# File 'lib/graphql/query.rb', line 65

def context
  @context
end

#logger ⇒ Object (readonly)

Returns the value of attribute logger.



432
433
434
 
# File 'lib/graphql/query.rb', line 432

def logger
  @logger
end

#multiplex ⇒ Object

Returns the value of attribute multiplex.



221
222
223
 
# File 'lib/graphql/query.rb', line 221

def multiplex
  @multiplex
end

#operation_name ⇒ nil, String

Returns The operation name provided by client or the one inferred from the document. Used to determine which operation to run.

Returns:

  • (nil, String) —

    The operation name provided by client or the one inferred from the document. Used to determine which operation to run.



71
72
73
 
# File 'lib/graphql/query.rb', line 71

def operation_name
  @operation_name
end

#provided_variables ⇒ Object (readonly)

Returns the value of attribute provided_variables.



65
66
67
 
# File 'lib/graphql/query.rb', line 65

def provided_variables
  @provided_variables
end

#query_string ⇒ Object

If a document was provided to GraphQL::Schema#execute instead of the raw query string, we will need to get it from the document



214
215
216
 
# File 'lib/graphql/query.rb', line 214

def query_string
  @query_string ||= (document ? document.to_query_string : nil)
end

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



255
256
257
 
# File 'lib/graphql/query.rb', line 255

def result_values
  @result_values
end

#root_value ⇒ Object

The value for root types



68
69
70
 
# File 'lib/graphql/query.rb', line 68

def root_value
  @root_value
end

#schema ⇒ Object (readonly)

Returns the value of attribute schema.



65
66
67
 
# File 'lib/graphql/query.rb', line 65

def schema
  @schema
end

#static_validator ⇒ GraphQL::StaticValidation::Validator

Returns if present, the query will validate with these rules.

Returns:



86
87
88
 
# File 'lib/graphql/query.rb', line 86

def static_validator
  @static_validator
end

#subscription_topic ⇒ String? (readonly)

Returns the triggered event, if this query is a subscription update.

Returns:

  • (String, nil) —

    the triggered event, if this query is a subscription update



122
123
124
 
# File 'lib/graphql/query.rb', line 122

def subscription_topic
  @subscription_topic
end

#tracers ⇒ Object (readonly)

Returns the value of attribute tracers.



124
125
126
 
# File 'lib/graphql/query.rb', line 124

def tracers
  @tracers
end

#validate ⇒ Boolean

Returns if false, static validation is skipped (execution behavior for invalid queries is undefined).

Returns:

  • (Boolean) —

    if false, static validation is skipped (execution behavior for invalid queries is undefined)



74
75
76
 
# File 'lib/graphql/query.rb', line 74

def validate
  @validate
end

#visibility_profile ⇒ Symbol? (readonly)

Returns:

  • (Symbol, nil) 


219
220
221
 
# File 'lib/graphql/query.rb', line 219

def visibility_profile
  @visibility_profile
end

Instance Method Details

#current_trace ⇒ GraphQL::Tracing::Trace

Returns:



224
225
226
 
# File 'lib/graphql/query.rb', line 224

def current_trace
  @current_trace ||= context[:trace] || (multiplex ? multiplex.current_trace : schema.new_trace(multiplex: multiplex, query: self))
end

#document ⇒ GraphQL::Language::Nodes::Document

Returns:



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

def document
  # It's ok if this hasn't been assigned yet
  if @query_string || @document
    with_prepared_ast { @document }
  else
    nil
  end
end

#executed? ⇒ Boolean

Returns:

  • (Boolean) 


286
287
288
 
# File 'lib/graphql/query.rb', line 286

def executed?
  @executed
end

#fingerprint ⇒ String

This contains a few components:

  • The selected operation name (or anonymous)
  • The fingerprint of the query string
  • The number of given variables (for readability)
  • The fingerprint of the given variables

This fingerprint can be used to track runs of the same operation-variables combination over time.

Returns:

  • (String) —

    An opaque hash identifying this operation-variables combination

See Also:



341
342
343
 
# File 'lib/graphql/query.rb', line 341

def fingerprint
  @fingerprint ||= "#{operation_fingerprint}/#{variables_fingerprint}"
end

#fragments ⇒ Object 



257
258
259
 
# File 'lib/graphql/query.rb', line 257

def fragments
  with_prepared_ast { @fragments }
end

#get_field(owner, field_name) ⇒ Object 



375
376
377
 
# File 'lib/graphql/query.rb', line 375

def get_field(owner, field_name)
  types.field(owner, field_name) # rubocop:disable Development/ContextIsPassedCop
end

#get_type(type_name) ⇒ Object 



371
372
373
 
# File 'lib/graphql/query.rb', line 371

def get_type(type_name)
  types.type(type_name) # rubocop:disable Development/ContextIsPassedCop
end

#inspect ⇒ Object 



111
112
113
 
# File 'lib/graphql/query.rb', line 111

def inspect
  "query ..."
end

#lookahead ⇒ GraphQL::Execution::Lookahead

A lookahead for the root selections of this query

Returns:



234
235
236
237
238
239
240
241
242
 
# File 'lib/graphql/query.rb', line 234

def lookahead
  @lookahead ||= begin
    if selected_operation.nil?
      GraphQL::Execution::Lookahead::NULL_LOOKAHEAD
    else
      GraphQL::Execution::Lookahead.new(query: self, root_type: root_type, ast_nodes: [selected_operation])
    end
  end
end

#mutation? ⇒ Boolean

Returns:

  • (Boolean) 


420
421
422
 
# File 'lib/graphql/query.rb', line 420

def mutation?
  with_prepared_ast { @mutation }
end

#operation_fingerprint ⇒ String

Returns An opaque hash for identifying this query’s given query string and selected operation.

Returns:

  • (String) —

    An opaque hash for identifying this query’s given query string and selected operation



346
347
348
 
# File 'lib/graphql/query.rb', line 346

def operation_fingerprint
  @operation_fingerprint ||= "#{selected_operation_name || "anonymous"}/#{Fingerprint.generate(query_string || "")}"
end

#operations ⇒ Object 



261
262
263
 
# File 'lib/graphql/query.rb', line 261

def operations
  with_prepared_ast { @operations }
end

#possible_types(type) ⇒ Object 



379
380
381
 
# File 'lib/graphql/query.rb', line 379

def possible_types(type)
  types.possible_types(type) # rubocop:disable Development/ContextIsPassedCop
end

#query? ⇒ Boolean

Returns:

  • (Boolean) 


424
425
426
 
# File 'lib/graphql/query.rb', line 424

def query?
  with_prepared_ast { @query }
end

#resolve_type(abstract_type, value = NOT_CONFIGURED) ⇒ GraphQL::ObjectType?

Returns The runtime type of value from Schema.resolve_type.

Parameters:

  • abstract_type (GraphQL::UnionType, GraphQL::InterfaceType)
  • value (Object) (defaults to: NOT_CONFIGURED) —

    Any runtime value

Returns:

See Also:

  • to apply filtering from `only` / `except`


408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/graphql/query.rb', line 408

def resolve_type(abstract_type, value = NOT_CONFIGURED)
  if value.is_a?(Symbol) && value == NOT_CONFIGURED
    # Old method signature
    value = abstract_type
    abstract_type = nil
  end
  if value.is_a?(GraphQL::Schema::Object)
    value = value.object
  end
  @resolved_types_cache[abstract_type][value]
end

#result ⇒ GraphQL::Query::Result

Get the result for this query, executing it once

Returns:



279
280
281
282
283
284
 
# File 'lib/graphql/query.rb', line 279

def result
  if !@executed
    Execution::Interpreter.run_all(@schema, [self], context: @context)
  end
  @result ||= Query::Result.new(query: self, values: @result_values)
end

#root_type ⇒ Object 



396
397
398
 
# File 'lib/graphql/query.rb', line 396

def root_type
  root_type_for_operation(selected_operation.operation_type)
end

#root_type_for_operation(op_type) ⇒ Object 



383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/graphql/query.rb', line 383

def root_type_for_operation(op_type)
  case op_type
  when "query", nil
    types.query_root # rubocop:disable Development/ContextIsPassedCop
  when "mutation"
    types.mutation_root # rubocop:disable Development/ContextIsPassedCop
  when "subscription"
    types.subscription_root # rubocop:disable Development/ContextIsPassedCop
  else
    raise ArgumentError, "unexpected root type name: #{op_type.inspect}; expected nil, 'query', 'mutation', or 'subscription'"
  end
end

#run_partials(partials_hashes) ⇒ Array<GraphQL::Query::Result>

Run subtree partials of this query and return their results. Each partial is identified with a path: and object: where the path references a field in the AST and the object will be treated as the return value from that field. Subfields of the field named by path will be executed with object as the starting point

Parameters:

  • partials_hashes (Array<Hash{Symbol => Object}>) —

    Hashes with path: and object: keys

Returns:



272
273
274
275
 
# File 'lib/graphql/query.rb', line 272

def run_partials(partials_hashes)
  partials = partials_hashes.map { |partial_options| Partial.new(query: self, **partial_options) }
  Execution::Interpreter.run_all(@schema, partials, context: @context)
end

#sanitized_query_string(inline_variables: true) ⇒ String?

A version of the given query string, with: - Variables inlined to the query - Strings replaced with <REDACTED>

Returns:

  • (String, nil) —

    Returns nil if the query is invalid.



323
324
325
326
327
 
# File 'lib/graphql/query.rb', line 323

def sanitized_query_string(inline_variables: true)
  with_prepared_ast {
    schema.sanitized_printer.new(self, inline_variables: inline_variables).sanitized_query_string
  }
end

#selected_operation ⇒ GraphQL::Language::Nodes::OperationDefinition?

This is the operation to run for this query. If more than one operation is present, it must be named at runtime.

Returns:



297
298
299
 
# File 'lib/graphql/query.rb', line 297

def selected_operation
  with_prepared_ast { @selected_operation }
end

#selected_operation_name ⇒ String?

Returns The name of the operation to run (may be inferred).

Returns:

  • (String, nil) —

    The name of the operation to run (may be inferred)



116
117
118
119
 
# File 'lib/graphql/query.rb', line 116

def selected_operation_name
  return nil unless selected_operation
  selected_operation.name
end

#static_errors ⇒ Object 



290
291
292
 
# File 'lib/graphql/query.rb', line 290

def static_errors
  validation_errors + analysis_errors + context.errors
end

#subscription? ⇒ Boolean

Returns:

  • (Boolean) 


428
429
430
 
# File 'lib/graphql/query.rb', line 428

def subscription?
  with_prepared_ast { @subscription }
end

#subscription_update? ⇒ Boolean

Returns:

  • (Boolean) 


228
229
230
 
# File 'lib/graphql/query.rb', line 228

def subscription_update?
  @subscription_topic && subscription?
end

#types ⇒ Object 



400
401
402
 
# File 'lib/graphql/query.rb', line 400

def types
  @visibility_profile || warden.visibility_profile
end

#valid? ⇒ Boolean

Returns:

  • (Boolean) 


363
364
365
 
# File 'lib/graphql/query.rb', line 363

def valid?
  validation_pipeline.valid? && analysis_errors.empty?
end

#validation_pipeline ⇒ Object 



355
356
357
 
# File 'lib/graphql/query.rb', line 355

def validation_pipeline
  with_prepared_ast { @validation_pipeline }
end

#variables ⇒ GraphQL::Query::Variables

Determine the values for variables of this query, using default values if a value isn’t provided at runtime.

If some variable is invalid, errors are added to #validation_errors.

Returns:



307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/graphql/query.rb', line 307

def variables
  @variables ||= begin
    with_prepared_ast {
      GraphQL::Query::Variables.new(
        @context,
        @ast_variables,
        @provided_variables,
      )
    }
  end
end

#variables_fingerprint ⇒ String

Returns An opaque hash for identifying this query’s given a variable values (not including defaults).

Returns:

  • (String) —

    An opaque hash for identifying this query’s given a variable values (not including defaults)



351
352
353
 
# File 'lib/graphql/query.rb', line 351

def variables_fingerprint
  @variables_fingerprint ||= "#{provided_variables.size}/#{Fingerprint.generate(provided_variables.to_json)}"
end

#warden ⇒ Object 



367
368
369
 
# File 'lib/graphql/query.rb', line 367

def warden
  with_prepared_ast { @warden }
end