Class: GraphQL::Query
- Inherits:
-
Object
- Object
- GraphQL::Query
- 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/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
Defined Under Namespace
Modules: ArgumentsCache Classes: Arguments, Context, Executor, InputValidationResult, LiteralInput, NullContext, OperationNameMissingError, Result, SerialExecution, ValidationPipeline, VariableValidationError, Variables
Instance Attribute Summary collapse
-
#analysis_errors ⇒ Object
Returns the value of attribute analysis_errors.
-
#context ⇒ Object
readonly
Returns the value of attribute context.
-
#operation_name ⇒ nil, String
The operation name provided by client or the one inferred from the document.
-
#provided_variables ⇒ Object
readonly
Returns the value of attribute provided_variables.
-
#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. -
#result_values ⇒ Object
private
-
#root_value ⇒ Object
The value for root types.
-
#schema ⇒ Object
readonly
Returns the value of attribute schema.
-
#subscription_topic ⇒ String?
readonly
The triggered event, if this query is a subscription update.
-
#tracers ⇒ Object
readonly
Returns the value of attribute tracers.
-
#validate ⇒ Boolean
If false, static validation is skipped (execution behavior for invalid queries is undefined).
Instance Method Summary collapse
-
#arguments_for(irep_or_ast_node, definition) ⇒ GraphQL::Query::Arguments
private
Node-level cache for calculating arguments.
-
#document ⇒ GraphQL::Language::Nodes::Document
-
#fragments ⇒ Object
-
#initialize(schema, query_string = nil, query: nil, document: nil, context: nil, variables: nil, validate: true, subscription_topic: nil, operation_name: nil, root_value: nil, max_depth: schema.max_depth, max_complexity: schema.max_complexity, except: nil, only: nil) ⇒ Query
constructor
Prepare query
query_string
onschema
. -
#inspect ⇒ Object
-
#irep_selection ⇒ Object
-
#lookahead ⇒ GraphQL::Execution::Lookahead
A lookahead for the root selections of this query.
-
#merge_filters(only: nil, except: nil) ⇒ void
-
#mutation? ⇒ Boolean
-
#operations ⇒ Object
-
#query? ⇒ Boolean
-
#resolve_type(abstract_type, value = :__undefined__) ⇒ GraphQL::ObjectType?
The runtime type of
value
from Schema#resolve_type. -
#result ⇒ Hash
Get the result for this query, executing it once.
-
#selected_operation ⇒ GraphQL::Language::Nodes::OperationDefinition?
This is the operation to run for this query.
-
#selected_operation_name ⇒ String?
The name of the operation to run (may be inferred).
-
#static_errors ⇒ Object
-
#subscription? ⇒ Boolean
-
#subscription_update? ⇒ Boolean
-
#valid? ⇒ Boolean
-
#validation_pipeline ⇒ Object
-
#variables ⇒ GraphQL::Query::Variables
Determine the values for variables of this query, using default values if a value isn’t provided at runtime.
-
#warden ⇒ Object
Methods included from Tracing::Traceable
Constructor Details
#initialize(schema, query_string = nil, query: nil, document: nil, context: nil, variables: nil, validate: true, subscription_topic: nil, operation_name: nil, root_value: nil, max_depth: schema.max_depth, max_complexity: schema.max_complexity, except: nil, only: nil) ⇒ Query
Prepare query query_string
on schema
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 129 130 131 132 133 134 135 136 137 138 139 140 141 |
# File 'lib/graphql/query.rb', line 81 def initialize(schema, query_string = nil, query: nil, document: nil, context: nil, variables: nil, validate: true, subscription_topic: nil, operation_name: nil, root_value: nil, max_depth: schema.max_depth, max_complexity: schema.max_complexity, except: nil, only: nil) # Even if `variables: nil` is passed, use an empty hash for simpler logic variables ||= {} @schema = schema @filter = schema.default_filter.merge(except: except, only: only) @context = schema.context_class.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 @max_complexity = max_complexity @result_values = nil @executed = false # TODO add a general way to define schema-level filters # TODO also add this to schema dumps if @schema.respond_to?(:visible?) merge_filters(only: @schema.method(:visible?)) end end |
Instance Attribute Details
#analysis_errors ⇒ Object
Returns the value of attribute analysis_errors
250 251 252 |
# File 'lib/graphql/query.rb', line 250 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 ⇒ nil, String
Returns The operation name provided by client or the one inferred from the document. Used to determine which operation to run.
38 39 40 |
# File 'lib/graphql/query.rb', line 38 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
If a document was provided to GraphQL::Schema#execute
instead of the raw query string, we will need to get it from the document
144 145 146 |
# File 'lib/graphql/query.rb', line 144 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.
176 177 178 |
# File 'lib/graphql/query.rb', line 176 def result_values @result_values end |
#root_value ⇒ Object
The value for root types
35 36 37 |
# File 'lib/graphql/query.rb', line 35 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
66 67 68 |
# File 'lib/graphql/query.rb', line 66 def subscription_topic @subscription_topic end |
#tracers ⇒ Object (readonly)
Returns the value of attribute tracers
68 69 70 |
# File 'lib/graphql/query.rb', line 68 def tracers @tracers end |
#validate ⇒ Boolean
Returns if false, static validation is skipped (execution behavior for invalid queries is undefined)
41 42 43 |
# File 'lib/graphql/query.rb', line 41 def validate @validate 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.
239 240 241 |
# File 'lib/graphql/query.rb', line 239 def arguments_for(irep_or_ast_node, definition) @arguments_cache[irep_or_ast_node][definition] end |
#document ⇒ GraphQL::Language::Nodes::Document
46 47 48 49 50 51 52 53 |
# File 'lib/graphql/query.rb', line 46 def document # It's ok if this hasn't been assigned yet if @query_string || @document with_prepared_ast { @document } else nil end end |
#fragments ⇒ Object
178 179 180 |
# File 'lib/graphql/query.rb', line 178 def fragments with_prepared_ast { @fragments } end |
#inspect ⇒ Object
55 56 57 |
# File 'lib/graphql/query.rb', line 55 def inspect "query ..." end |
#irep_selection ⇒ Object
226 227 228 229 230 231 232 233 234 |
# File 'lib/graphql/query.rb', line 226 def irep_selection @selection ||= begin if selected_operation && internal_representation internal_representation.operation_definitions[selected_operation.name] else nil end end end |
#lookahead ⇒ GraphQL::Execution::Lookahead
A lookahead for the root selections of this query
156 157 158 159 160 161 162 163 |
# File 'lib/graphql/query.rb', line 156 def lookahead @lookahead ||= begin ast_node = selected_operation root_type = warden.root_type_for_operation(ast_node.operation_type || "query") root_type = root_type.[:type_class] || raise("Invariant: `lookahead` only works with class-based types") GraphQL::Execution::Lookahead.new(query: self, root_type: root_type, ast_nodes: [ast_node]) end end |
#merge_filters(only: nil, except: nil) ⇒ void
This method returns an undefined value.
286 287 288 289 290 291 292 293 |
# File 'lib/graphql/query.rb', line 286 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
277 278 279 |
# File 'lib/graphql/query.rb', line 277 def mutation? with_prepared_ast { @mutation } end |
#operations ⇒ Object
182 183 184 |
# File 'lib/graphql/query.rb', line 182 def operations with_prepared_ast { @operations } end |
#query? ⇒ Boolean
281 282 283 |
# File 'lib/graphql/query.rb', line 281 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
265 266 267 268 269 270 271 272 273 274 275 |
# File 'lib/graphql/query.rb', line 265 def resolve_type(abstract_type, value = :__undefined__) if value.is_a?(Symbol) && value == :__undefined__ # 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
188 189 190 191 192 193 194 195 |
# File 'lib/graphql/query.rb', line 188 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?
This is the operation to run for this query. If more than one operation is present, it must be named at runtime.
204 205 206 |
# File 'lib/graphql/query.rb', line 204 def selected_operation with_prepared_ast { @selected_operation } end |
#selected_operation_name ⇒ String?
Returns The name of the operation to run (may be inferred)
60 61 62 63 |
# File 'lib/graphql/query.rb', line 60 def selected_operation_name return nil unless selected_operation selected_operation.name end |
#static_errors ⇒ Object
197 198 199 |
# File 'lib/graphql/query.rb', line 197 def static_errors validation_errors + analysis_errors + context.errors end |
#subscription? ⇒ Boolean
295 296 297 |
# File 'lib/graphql/query.rb', line 295 def subscription? with_prepared_ast { @subscription } end |
#subscription_update? ⇒ Boolean
150 151 152 |
# File 'lib/graphql/query.rb', line 150 def subscription_update? @subscription_topic && subscription? end |
#valid? ⇒ Boolean
251 252 253 |
# File 'lib/graphql/query.rb', line 251 def valid? validation_pipeline.valid? && analysis_errors.empty? end |
#validation_pipeline ⇒ Object
243 244 245 |
# File 'lib/graphql/query.rb', line 243 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.
214 215 216 217 218 219 220 221 222 223 224 |
# File 'lib/graphql/query.rb', line 214 def variables @variables ||= begin with_prepared_ast { GraphQL::Query::Variables.new( @context, @ast_variables, @provided_variables, ) } end end |
#warden ⇒ Object
255 256 257 |
# File 'lib/graphql/query.rb', line 255 def warden with_prepared_ast { @warden } end |