Class: GraphQL::Query

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
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 Tracing::Traceable

#trace

Constructor Details

#initialize(schema, query_string = nil, query: nil, document: nil, context: nil, variables: nil, validate: true, static_validator: nil, subscription_topic: nil, operation_name: nil, root_value: nil, max_depth: schema.max_depth, max_complexity: schema.max_complexity, warden: 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)



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

def initialize(schema, query_string = nil, query: nil, document: nil, context: nil, variables: nil, validate: true, static_validator: nil, subscription_topic: nil, operation_name: nil, root_value: nil, max_depth: schema.max_depth, max_complexity: schema.max_complexity, warden: nil)
  # Even if `variables: nil` is passed, use an empty hash for simpler logic
  variables ||= {}
  @schema = schema
  @context = schema.context_class.new(query: self, object: root_value, values: context)
  @warden = warden
  @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

  # Support `ctx[:backtrace] = true` for wrapping backtraces
  if context && context[:backtrace] && !@tracers.include?(GraphQL::Backtrace::Tracer)
    if schema.trace_class <= GraphQL::Tracing::CallLegacyTracers
      context_tracers += [GraphQL::Backtrace::Tracer]
      @tracers << GraphQL::Backtrace::Tracer
    elsif !(current_trace.class <= GraphQL::Backtrace::Trace)
      raise "Invariant: `backtrace: true` should have provided a trace class with Backtrace mixed in, but it didnt. (Found: #{current_trace.class.ancestors}). This is a bug in GraphQL-Ruby, please report it on GitHub."
    end
  end

  if context_tracers.any? && !(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 = if context && context[:logger] == false
    Logger.new(IO::NULL)
  elsif context && (l = context[:logger])
    l
  else
    schema.default_logger
  end
end

Instance Attribute Details

#analysis_errors ⇒ Object

Returns the value of attribute analysis_errors.



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

def analysis_errors
  @analysis_errors
end

#context ⇒ Object (readonly)

Returns the value of attribute context.



28
29
30
 
# File 'lib/graphql/query.rb', line 28

def context
  @context
end

#logger ⇒ Object (readonly)

Returns the value of attribute logger.



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

def logger
  @logger
end

#multiplex ⇒ Object

Returns the value of attribute multiplex.



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

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.



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

def operation_name
  @operation_name
end

#provided_variables ⇒ Object (readonly)

Returns the value of attribute provided_variables.



28
29
30
 
# File 'lib/graphql/query.rb', line 28

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



176
177
178
 
# File 'lib/graphql/query.rb', line 176

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. 



216
217
218
 
# File 'lib/graphql/query.rb', line 216

def result_values
  @result_values
end

#root_value ⇒ Object

The value for root types



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

def root_value
  @root_value
end

#schema ⇒ Object (readonly)

Returns the value of attribute schema.



28
29
30
 
# File 'lib/graphql/query.rb', line 28

def schema
  @schema
end

#static_validator ⇒ GraphQL::StaticValidation::Validator

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

Returns:



49
50
51
 
# File 'lib/graphql/query.rb', line 49

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



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

def subscription_topic
  @subscription_topic
end

#tracers ⇒ Object (readonly)

Returns the value of attribute tracers.



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

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)



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

def validate
  @validate
end

Instance Method Details

#after_lazy(value, &block) ⇒ Object 



368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/graphql/query.rb', line 368

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 



277
278
279
 
# File 'lib/graphql/query.rb', line 277

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

#arguments_for(ast_node, definition, parent_object: nil) ⇒ Object

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

Parameters:



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

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

#current_trace ⇒ GraphQL::Tracing::Trace

Returns:



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

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:



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

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) 


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

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:



303
304
305
 
# File 'lib/graphql/query.rb', line 303

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

#fragments ⇒ Object 



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

def fragments
  with_prepared_ast { @fragments }
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. 



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

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

#inspect ⇒ Object 



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

def inspect
  "query ..."
end

#interpreter? ⇒ Boolean

Returns:

  • (Boolean) 


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

def interpreter?
  true
end

#lookahead ⇒ GraphQL::Execution::Lookahead

A lookahead for the root selections of this query

Returns:



197
198
199
200
201
202
203
 
# File 'lib/graphql/query.rb', line 197

def lookahead
  @lookahead ||= begin
    ast_node = selected_operation
    root_type = warden.root_type_for_operation(ast_node.operation_type || "query")
    GraphQL::Execution::Lookahead.new(query: self, root_type: root_type, ast_nodes: [ast_node])
  end
end

#mutation? ⇒ Boolean

Returns:

  • (Boolean) 


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

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



308
309
310
 
# File 'lib/graphql/query.rb', line 308

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

#operations ⇒ Object 



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

def operations
  with_prepared_ast { @operations }
end

#query? ⇒ Boolean

Returns:

  • (Boolean) 


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

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`


339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/graphql/query.rb', line 339

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 ⇒ Hash

Get the result for this query, executing it once

Returns:

  • (Hash) —

    A GraphQL response, with "data" and/or "errors" keys



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

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



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

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:



246
247
248
 
# File 'lib/graphql/query.rb', line 246

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)



79
80
81
82
 
# File 'lib/graphql/query.rb', line 79

def selected_operation_name
  return nil unless selected_operation
  selected_operation.name
end

#static_errors ⇒ Object 



239
240
241
 
# File 'lib/graphql/query.rb', line 239

def static_errors
  validation_errors + analysis_errors + context.errors
end

#subscription? ⇒ Boolean

Returns:

  • (Boolean) 


359
360
361
 
# File 'lib/graphql/query.rb', line 359

def subscription?
  with_prepared_ast { @subscription }
end

#subscription_update? ⇒ Boolean

Returns:

  • (Boolean) 


191
192
193
 
# File 'lib/graphql/query.rb', line 191

def subscription_update?
  @subscription_topic && subscription?
end

#valid? ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#validation_pipeline ⇒ Object 



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

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:



256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/graphql/query.rb', line 256

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)



313
314
315
 
# File 'lib/graphql/query.rb', line 313

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

#warden ⇒ Object 



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

def warden
  with_prepared_ast { @warden }
end