Class: GraphQL::Query

Inherits:
Object
  • Object
show all
Extended by:
Forwardable, Autoload
Includes:
Tracing::Traceable
Defined in:
lib/graphql/query.rb,
lib/graphql/query/result.rb,
lib/graphql/query/context.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 Classes: Context, InputValidationResult, NullContext, OperationNameMissingError, Result, ValidationPipeline, VariableValidationError, Variables

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Autoload

autoload, eager_load!

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]



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

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.



337
338
339
 
# File 'lib/graphql/query.rb', line 337

def analysis_errors
  @analysis_errors
end

#context ⇒ Object (readonly)

Returns the value of attribute context.



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

def context
  @context
end

#logger ⇒ Object (readonly)

Returns the value of attribute logger.



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

def logger
  @logger
end

#multiplex ⇒ Object

Returns the value of attribute multiplex.



186
187
188
 
# File 'lib/graphql/query.rb', line 186

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.



36
37
38
 
# File 'lib/graphql/query.rb', line 36

def operation_name
  @operation_name
end

#provided_variables ⇒ Object (readonly)

Returns the value of attribute provided_variables.



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

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



179
180
181
 
# File 'lib/graphql/query.rb', line 179

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. 



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

def result_values
  @result_values
end

#root_value ⇒ Object

The value for root types



33
34
35
 
# File 'lib/graphql/query.rb', line 33

def root_value
  @root_value
end

#schema ⇒ Object (readonly)

Returns the value of attribute schema.



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

def schema
  @schema
end

#static_validator ⇒ GraphQL::StaticValidation::Validator

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

Returns:



51
52
53
 
# File 'lib/graphql/query.rb', line 51

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



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

def subscription_topic
  @subscription_topic
end

#tracers ⇒ Object (readonly)

Returns the value of attribute tracers.



89
90
91
 
# File 'lib/graphql/query.rb', line 89

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)



39
40
41
 
# File 'lib/graphql/query.rb', line 39

def validate
  @validate
end

#visibility_profile ⇒ Symbol? (readonly)

Returns:

  • (Symbol, nil) 


184
185
186
 
# File 'lib/graphql/query.rb', line 184

def visibility_profile
  @visibility_profile
end

Instance Method Details

#after_lazy(value, &block) ⇒ Object 



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

def after_lazy(value, &block)
  if !defined?(@runtime_instance)
    @runtime_instance = context.namespace(:interpreter_runtime)[:runtime]
  end

  if @runtime_instance
    @runtime_instance.minimal_after_lazy(value, &block)
  else
    @schema.after_lazy(value, &block)
  end
end

#arguments_cache ⇒ Object 



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

def arguments_cache
  @arguments_cache ||= Execution::Interpreter::ArgumentsCache.new(self)
end

#arguments_for(ast_node, definition, parent_object: nil) ⇒ Hash{Symbol => Object}

Node-level cache for calculating arguments. Used during execution and query analysis.

Parameters:

Returns:

  • (Hash{Symbol => Object}) 


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

def arguments_for(ast_node, definition, parent_object: nil)
  arguments_cache.fetch(ast_node, definition, parent_object)
end

#current_trace ⇒ GraphQL::Tracing::Trace

Returns:



189
190
191
 
# File 'lib/graphql/query.rb', line 189

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:



67
68
69
70
71
72
73
74
 
# File 'lib/graphql/query.rb', line 67

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) 


248
249
250
 
# File 'lib/graphql/query.rb', line 248

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:



316
317
318
 
# File 'lib/graphql/query.rb', line 316

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

#fragments ⇒ Object 



231
232
233
 
# File 'lib/graphql/query.rb', line 231

def fragments
  with_prepared_ast { @fragments }
end

#get_field(owner, field_name) ⇒ Object 



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

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

#get_type(type_name) ⇒ Object 



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

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

#handle_or_reraise(err) ⇒ 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. 



404
405
406
 
# File 'lib/graphql/query.rb', line 404

def handle_or_reraise(err)
  schema.handle_or_reraise(context, err)
end

#inspect ⇒ Object 



76
77
78
 
# File 'lib/graphql/query.rb', line 76

def inspect
  "query ..."
end

#lookahead ⇒ GraphQL::Execution::Lookahead

A lookahead for the root selections of this query

Returns:



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/graphql/query.rb', line 199

def lookahead
  @lookahead ||= begin
    ast_node = selected_operation
    if ast_node.nil?
      GraphQL::Execution::Lookahead::NULL_LOOKAHEAD
    else
      root_type = case ast_node.operation_type
      when nil, "query"
        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
      end
      GraphQL::Execution::Lookahead.new(query: self, root_type: root_type, ast_nodes: [ast_node])
    end
  end
end

#mutation? ⇒ Boolean

Returns:

  • (Boolean) 


391
392
393
 
# File 'lib/graphql/query.rb', line 391

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



321
322
323
 
# File 'lib/graphql/query.rb', line 321

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

#operations ⇒ Object 



235
236
237
 
# File 'lib/graphql/query.rb', line 235

def operations
  with_prepared_ast { @operations }
end

#possible_types(type) ⇒ Object 



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

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

#query? ⇒ Boolean

Returns:

  • (Boolean) 


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

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`


379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/graphql/query.rb', line 379

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:



241
242
243
244
245
246
 
# File 'lib/graphql/query.rb', line 241

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_for_operation(op_type) ⇒ Object 



358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/graphql/query.rb', line 358

def root_type_for_operation(op_type)
  case op_type
  when "query"
    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 'query', 'mutation', or 'subscription'"
  end
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.



298
299
300
301
302
 
# File 'lib/graphql/query.rb', line 298

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:



259
260
261
 
# File 'lib/graphql/query.rb', line 259

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)



81
82
83
84
 
# File 'lib/graphql/query.rb', line 81

def selected_operation_name
  return nil unless selected_operation
  selected_operation.name
end

#static_errors ⇒ Object 



252
253
254
 
# File 'lib/graphql/query.rb', line 252

def static_errors
  validation_errors + analysis_errors + context.errors
end

#subscription? ⇒ Boolean

Returns:

  • (Boolean) 


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

def subscription?
  with_prepared_ast { @subscription }
end

#subscription_update? ⇒ Boolean

Returns:

  • (Boolean) 


193
194
195
 
# File 'lib/graphql/query.rb', line 193

def subscription_update?
  @subscription_topic && subscription?
end

#types ⇒ Object 



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

def types
  @visibility_profile || warden.visibility_profile
end

#valid? ⇒ Boolean

Returns:

  • (Boolean) 


338
339
340
 
# File 'lib/graphql/query.rb', line 338

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

#validation_pipeline ⇒ Object 



330
331
332
 
# File 'lib/graphql/query.rb', line 330

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:



269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/graphql/query.rb', line 269

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)



326
327
328
 
# File 'lib/graphql/query.rb', line 326

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

#warden ⇒ Object 



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

def warden
  with_prepared_ast { @warden }
end