Class: GraphQL::Query

Inherits:
Object
  • Object
show all
Extended by:
Delegate
Includes:
Tracing::Traceable
Defined in:
lib/graphql/query.rb,
lib/graphql/query/result.rb,
lib/graphql/query/context.rb,
lib/graphql/query/executor.rb,
lib/graphql/query/arguments.rb,
lib/graphql/query/variables.rb,
lib/graphql/query/null_context.rb,
lib/graphql/query/literal_input.rb,
lib/graphql/query/arguments_cache.rb,
lib/graphql/query/serial_execution.rb,
lib/graphql/query/validation_pipeline.rb,
lib/graphql/query/input_validation_result.rb,
lib/graphql/query/variable_validation_error.rb,
lib/graphql/query/serial_execution/field_resolution.rb,
lib/graphql/query/serial_execution/value_resolution.rb,
lib/graphql/query/serial_execution/operation_resolution.rb,
lib/graphql/query/serial_execution/selection_resolution.rb

Overview

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

Defined Under Namespace

Modules: ArgumentsCache Classes: Arguments, Context, Executor, InputValidationResult, LiteralInput, NullContext, OperationNameMissingError, Result, SerialExecution, ValidationPipeline, VariableValidationError, Variables

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Delegate

def_delegators

Methods included from Tracing::Traceable

#trace

Constructor Details

#initialize(schema, query_string = nil, query: nil, document: nil, context: nil, variables: {}, validate: true, subscription_topic: nil, operation_name: nil, root_value: nil, max_depth: nil, max_complexity: nil, except: nil, only: 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: {}) —

    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: nil) —

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

  • max_complexity (Numeric) (defaults to: nil) —

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

  • except (<#call(schema_member, context)>) (defaults to: nil) —

    If provided, objects will be hidden from the schema when .call(schema_member, context) returns truthy

  • only (<#call(schema_member, context)>) (defaults to: nil) —

    If provided, objects will be hidden from the schema when .call(schema_member, context) returns false



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
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
 
# File 'lib/graphql/query.rb', line 76

def initialize(schema, query_string = nil, query: nil, document: nil, context: nil, variables: {}, validate: true, subscription_topic: nil, operation_name: nil, root_value: nil, max_depth: nil, max_complexity: nil, except: nil, only: nil)
  @schema = schema
  @filter = schema.default_filter.merge(except: except, only: only)
  @context = Context.new(query: self, object: root_value, values: context)
  @subscription_topic = subscription_topic
  @root_value = root_value
  @fragments = nil
  @operations = nil
  @validate = validate
  # TODO: remove support for global tracers
  @tracers = schema.tracers + GraphQL::Tracing.tracers + (context ? context.fetch(:tracers, []) : [])
  # Support `ctx[:backtrace] = true` for wrapping backtraces
  if context && context[:backtrace] && !@tracers.include?(GraphQL::Backtrace::Tracer)
    @tracers << GraphQL::Backtrace::Tracer
  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

  # 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

  @arguments_cache = ArgumentsCache.build(self)

  # 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 || schema.max_depth
  @max_complexity = max_complexity || schema.max_complexity

  @result_values = nil
  @executed = false
end

Instance Attribute Details

#analysis_errors ⇒ Object

Returns the value of attribute analysis_errors.



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

def analysis_errors
  @analysis_errors
end

#context ⇒ Object (readonly)

Returns the value of attribute context.



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

def context
  @context
end

#operation_name ⇒ String?

Returns:

  • (String, nil) 


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

def operation_name
  @operation_name
end

#provided_variables ⇒ Object (readonly)

Returns the value of attribute provided_variables.



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

def provided_variables
  @provided_variables
end

#query_string ⇒ Object

Returns the value of attribute query_string.



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

def query_string
  @query_string
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. 



145
146
147
 
# File 'lib/graphql/query.rb', line 145

def result_values
  @result_values
end

#root_value ⇒ Object (readonly)

Returns the value of attribute root_value.



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

def root_value
  @root_value
end

#schema ⇒ Object (readonly)

Returns the value of attribute schema.



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

def schema
  @schema
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



58
59
60
 
# File 'lib/graphql/query.rb', line 58

def subscription_topic
  @subscription_topic
end

#tracers ⇒ Object (readonly)

Returns the value of attribute tracers.



63
64
65
 
# File 'lib/graphql/query.rb', line 63

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)



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

def validate
  @validate
end

#warden ⇒ Object (readonly)

Returns the value of attribute warden.



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

def warden
  @warden
end

Instance Method Details

#arguments_for(irep_or_ast_node, definition) ⇒ GraphQL::Query::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.

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

Returns:



205
206
207
 
# File 'lib/graphql/query.rb', line 205

def arguments_for(irep_or_ast_node, definition)
  @arguments_cache[irep_or_ast_node][definition]
end

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

Returns:



43
44
45
 
# File 'lib/graphql/query.rb', line 43

def document
  with_prepared_ast { @document }
end

#fragments ⇒ Object 



147
148
149
 
# File 'lib/graphql/query.rb', line 147

def fragments
  with_prepared_ast { @fragments }
end

#inspect ⇒ Object 



47
48
49
 
# File 'lib/graphql/query.rb', line 47

def inspect
  "query ..."
end

#irep_selection ⇒ Object 



195
196
197
198
199
200
 
# File 'lib/graphql/query.rb', line 195

def irep_selection
  @selection ||= begin
    return nil unless selected_operation
    internal_representation.operation_definitions[selected_operation.name]
  end
end

#merge_filters(only: nil, except: nil) ⇒ void

This method returns an undefined value.



253
254
255
256
257
258
259
260
 
# File 'lib/graphql/query.rb', line 253

def merge_filters(only: nil, except: nil)
  if @prepared_ast
    raise "Can't add filters after preparing the query"
  else
    @filter = @filter.merge(only: only, except: except)
  end
  nil
end

#mutation? ⇒ Boolean

Returns:

  • (Boolean) 


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

def mutation?
  with_prepared_ast { @mutation }
end

#operations ⇒ Object 



151
152
153
 
# File 'lib/graphql/query.rb', line 151

def operations
  with_prepared_ast { @operations }
end

#query? ⇒ Boolean

Returns:

  • (Boolean) 


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

def query?
  with_prepared_ast { @query }
end

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

Returns The runtime type of value from Schema#resolve_type.

Parameters:

Returns:

See Also:

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


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

def resolve_type(abstract_type, value = :__undefined__)
  if value.is_a?(Symbol) && value == :__undefined__
    # Old method signature
    value = abstract_type
    abstract_type = nil
  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



157
158
159
160
161
162
163
164
 
# File 'lib/graphql/query.rb', line 157

def result
  if !@executed
    with_prepared_ast {
      Execution::Multiplex.run_queries(@schema, [self], context: @context)
    }
  end
  @result ||= Query::Result.new(query: self, values: @result_values)
end

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

Returns:



173
174
175
 
# File 'lib/graphql/query.rb', line 173

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)



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

def selected_operation_name
  return nil unless selected_operation
  selected_operation.name
end

#static_errors ⇒ Object 



166
167
168
 
# File 'lib/graphql/query.rb', line 166

def static_errors
  validation_errors + analysis_errors + context.errors
end

#subscription? ⇒ Boolean

Returns:

  • (Boolean) 


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

def subscription?
  with_prepared_ast { @subscription }
end

#subscription_update? ⇒ Boolean

Returns:

  • (Boolean) 


130
131
132
 
# File 'lib/graphql/query.rb', line 130

def subscription_update?
  @subscription_topic && subscription?
end

#valid? ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#validation_pipeline ⇒ Object 



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

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:



183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/graphql/query.rb', line 183

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