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



72
73
74
75
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
# File 'lib/graphql/query.rb', line 72

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_errorsObject

Returns the value of attribute analysis_errors



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

def analysis_errors
  @analysis_errors
end

#contextObject (readonly)

Returns the value of attribute context



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

def context
  @context
end

#operation_nameString?



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

def operation_name
  @operation_name
end

#provided_variablesObject (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_stringObject

Returns the value of attribute query_string



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

def query_string
  @query_string
end

#result_valuesObject

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.



141
142
143
# File 'lib/graphql/query.rb', line 141

def result_values
  @result_values
end

#root_valueObject (readonly)

Returns the value of attribute root_value



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

def root_value
  @root_value
end

#schemaObject (readonly)

Returns the value of attribute schema



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

def schema
  @schema
end

#subscription_topicString? (readonly)



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

def subscription_topic
  @subscription_topic
end

#tracersObject (readonly)

Returns the value of attribute tracers



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

def tracers
  @tracers
end

#validateBoolean



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

def validate
  @validate
end

#wardenObject (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.



201
202
203
# File 'lib/graphql/query.rb', line 201

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

#documentGraphQL::Language::Nodes::Document



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

def document
  with_prepared_ast { @document }
end

#fragmentsObject



143
144
145
# File 'lib/graphql/query.rb', line 143

def fragments
  with_prepared_ast { @fragments }
end

#irep_selectionObject



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

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



249
250
251
252
253
254
255
256
# File 'lib/graphql/query.rb', line 249

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



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

def mutation?
  with_prepared_ast { @mutation }
end

#operationsObject



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

def operations
  with_prepared_ast { @operations }
end

#query?Boolean



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

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

See Also:

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


231
232
233
234
235
236
237
238
# File 'lib/graphql/query.rb', line 231

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

#resultHash

Get the result for this query, executing it once



153
154
155
156
157
158
159
160
# File 'lib/graphql/query.rb', line 153

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

#selected_operationGraphQL::Language::Nodes::OperationDefinition?



169
170
171
# File 'lib/graphql/query.rb', line 169

def selected_operation
  with_prepared_ast { @selected_operation }
end

#selected_operation_nameString?



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

def selected_operation_name
  return nil unless selected_operation
  selected_operation.name
end

#static_errorsObject



162
163
164
# File 'lib/graphql/query.rb', line 162

def static_errors
  validation_errors + analysis_errors + context.errors
end

#subscription?Boolean



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

def subscription?
  with_prepared_ast { @subscription }
end

#subscription_update?Boolean



126
127
128
# File 'lib/graphql/query.rb', line 126

def subscription_update?
  @subscription_topic && subscription?
end

#valid?Boolean



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

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

#validation_pipelineObject



210
211
212
# File 'lib/graphql/query.rb', line 210

def validation_pipeline
  with_prepared_ast { @validation_pipeline }
end

#variablesGraphQL::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.



179
180
181
182
183
184
185
186
187
188
189
# File 'lib/graphql/query.rb', line 179

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