Class: GraphQL::Query
- Inherits:
-
Object
- Object
- GraphQL::Query
- Defined in:
- lib/graphql/query.rb,
lib/graphql/query/context.rb,
lib/graphql/query/executor.rb,
lib/graphql/query/arguments.rb,
lib/graphql/query/variables.rb,
lib/graphql/query/literal_input.rb,
lib/graphql/query/serial_execution.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: NullExcept Classes: Arguments, Context, Executor, InputValidationResult, LiteralInput, OperationNameMissingError, SerialExecution, VariableValidationError, Variables
Instance Attribute Summary collapse
-
#context ⇒ Object
readonly
Returns the value of attribute context.
-
#document ⇒ Object
readonly
Returns the value of attribute document.
-
#fragments ⇒ Object
readonly
Returns the value of attribute fragments.
-
#max_depth ⇒ Object
readonly
Returns the value of attribute max_depth.
-
#operations ⇒ Object
readonly
Returns the value of attribute operations.
-
#provided_variables ⇒ Object
readonly
Returns the value of attribute provided_variables.
-
#query_string ⇒ Object
readonly
Returns the value of attribute query_string.
-
#root_value ⇒ Object
readonly
Returns the value of attribute root_value.
-
#schema ⇒ Object
readonly
Returns the value of attribute schema.
- #selected_operation ⇒ GraphQL::Language::Nodes::Document? readonly
-
#warden ⇒ Object
readonly
Returns the value of attribute warden.
Instance Method Summary collapse
-
#analysis_errors ⇒ Array<Hash>
TODO this should probably contain error instances, not hashes.
-
#arguments_for(irep_node, definition) ⇒ GraphQL::Query::Arguments
Node-level cache for calculating arguments.
- #get_field(type, name) ⇒ Object
- #get_type(type_name) ⇒ Object
-
#initialize(schema, query_string = nil, document: nil, context: nil, variables: {}, validate: true, operation_name: nil, root_value: nil, max_depth: nil, max_complexity: nil, except: NullExcept) ⇒ Query
constructor
Prepare query
query_string
onschema
. -
#internal_representation ⇒ Hash<String, nil => GraphQL::InternalRepresentation::Node] Operation name -
Irep node pairs.
- #irep_selection ⇒ Object
- #mutation? ⇒ Boolean
- #possible_types(type) ⇒ Object
- #resolve_type(type) ⇒ Object
-
#result ⇒ Hash
Get the result for this query, executing it once.
- #valid? ⇒ Boolean
-
#validation_errors ⇒ Array<Hash>
TODO this should probably contain error instances, not hashes.
-
#variables ⇒ GraphQL::Query::Variables
Determine the values for variables of this query, using default values if a value isn't provided at runtime.
Constructor Details
#initialize(schema, query_string = nil, document: nil, context: nil, variables: {}, validate: true, operation_name: nil, root_value: nil, max_depth: nil, max_complexity: nil, except: NullExcept) ⇒ Query
Prepare query query_string
on schema
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 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 |
# File 'lib/graphql/query.rb', line 41 def initialize(schema, query_string = nil, document: nil, context: nil, variables: {}, validate: true, operation_name: nil, root_value: nil, max_depth: nil, max_complexity: nil, except: NullExcept) fail ArgumentError, "a query string or document is required" unless query_string || document @schema = schema @warden = GraphQL::Schema::Warden.new(schema, except) @max_depth = max_depth || schema.max_depth @max_complexity = max_complexity || schema.max_complexity @query_analyzers = schema.query_analyzers.dup if @max_depth @query_analyzers << GraphQL::Analysis::MaxQueryDepth.new(@max_depth) end if @max_complexity @query_analyzers << GraphQL::Analysis::MaxQueryComplexity.new(@max_complexity) end @context = Context.new(query: self, values: context) @root_value = root_value @operation_name = operation_name @fragments = {} @operations = {} 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 @document = document || GraphQL.parse(query_string) @document.definitions.each do |part| if part.is_a?(GraphQL::Language::Nodes::FragmentDefinition) @fragments[part.name] = part elsif part.is_a?(GraphQL::Language::Nodes::OperationDefinition) @operations[part.name] = part else raise GraphQL::ExecutionError, "GraphQL query cannot contain a schema definition" end end @arguments_cache = Hash.new { |h, k| h[k] = {} } @validation_errors = [] @analysis_errors = [] @internal_representation = nil @was_validated = false # Trying to execute a document # with no operations returns an empty hash @ast_variables = [] @mutation = false if @operations.any? @selected_operation = find_operation(@operations, @operation_name) if @selected_operation.nil? @validation_errors << GraphQL::Query::OperationNameMissingError.new(@operations.keys) else @ast_variables = @selected_operation.variables @mutation = @selected_operation.operation_type == "mutation" end end @result = nil @executed = false end |
Instance Attribute Details
#context ⇒ Object (readonly)
Returns the value of attribute context.
29 30 31 |
# File 'lib/graphql/query.rb', line 29 def context @context end |
#document ⇒ Object (readonly)
Returns the value of attribute document.
29 30 31 |
# File 'lib/graphql/query.rb', line 29 def document @document end |
#fragments ⇒ Object (readonly)
Returns the value of attribute fragments.
29 30 31 |
# File 'lib/graphql/query.rb', line 29 def fragments @fragments end |
#max_depth ⇒ Object (readonly)
Returns the value of attribute max_depth.
29 30 31 |
# File 'lib/graphql/query.rb', line 29 def max_depth @max_depth end |
#operations ⇒ Object (readonly)
Returns the value of attribute operations.
29 30 31 |
# File 'lib/graphql/query.rb', line 29 def operations @operations end |
#provided_variables ⇒ Object (readonly)
Returns the value of attribute provided_variables.
29 30 31 |
# File 'lib/graphql/query.rb', line 29 def provided_variables @provided_variables end |
#query_string ⇒ Object (readonly)
Returns the value of attribute query_string.
29 30 31 |
# File 'lib/graphql/query.rb', line 29 def query_string @query_string end |
#root_value ⇒ Object (readonly)
Returns the value of attribute root_value.
29 30 31 |
# File 'lib/graphql/query.rb', line 29 def root_value @root_value end |
#schema ⇒ Object (readonly)
Returns the value of attribute schema.
29 30 31 |
# File 'lib/graphql/query.rb', line 29 def schema @schema end |
#selected_operation ⇒ GraphQL::Language::Nodes::Document? (readonly)
130 131 132 |
# File 'lib/graphql/query.rb', line 130 def selected_operation @selected_operation end |
#warden ⇒ Object (readonly)
Returns the value of attribute warden.
29 30 31 |
# File 'lib/graphql/query.rb', line 29 def warden @warden end |
Instance Method Details
#analysis_errors ⇒ Array<Hash>
TODO this should probably contain error instances, not hashes
174 175 176 177 |
# File 'lib/graphql/query.rb', line 174 def analysis_errors valid? @analysis_errors end |
#arguments_for(irep_node, definition) ⇒ GraphQL::Query::Arguments
Node-level cache for calculating arguments. Used during execution and query analysis.
181 182 183 184 185 186 187 188 189 |
# File 'lib/graphql/query.rb', line 181 def arguments_for(irep_node, definition) @arguments_cache[irep_node][definition] ||= begin GraphQL::Query::LiteralInput.from_arguments( irep_node.ast_node.arguments, definition.arguments, self.variables ) end end |
#get_field(type, name) ⇒ Object
208 209 210 211 |
# File 'lib/graphql/query.rb', line 208 def get_field(type, name) @fields ||= Hash.new { |h, k| h[k] = Hash.new { |h2, k2| h2[k2] = @warden.get_field(k, k2) } } @fields[type][name] end |
#get_type(type_name) ⇒ Object
204 205 206 |
# File 'lib/graphql/query.rb', line 204 def get_type(type_name) @warden.get_type(type_name) end |
#internal_representation ⇒ Hash<String, nil => GraphQL::InternalRepresentation::Node] Operation name -
Returns Irep node pairs.
152 153 154 155 |
# File 'lib/graphql/query.rb', line 152 def internal_representation valid? @internal_representation end |
#irep_selection ⇒ Object
157 158 159 160 161 162 |
# File 'lib/graphql/query.rb', line 157 def irep_selection @selection ||= begin irep_root = internal_representation[selected_operation.name] GraphQL::InternalRepresentation::Selection.new(query: self, nodes: [irep_root]) end end |
#mutation? ⇒ Boolean
221 222 223 |
# File 'lib/graphql/query.rb', line 221 def mutation? @mutation end |
#possible_types(type) ⇒ Object
213 214 215 |
# File 'lib/graphql/query.rb', line 213 def possible_types(type) @warden.possible_types(type) end |
#resolve_type(type) ⇒ Object
217 218 219 |
# File 'lib/graphql/query.rb', line 217 def resolve_type(type) @schema.resolve_type(type, @context) end |
#result ⇒ Hash
Get the result for this query, executing it once
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 102 def result if @executed @result else @executed = true instrumenters = @schema.instrumenters[:query] begin instrumenters.each { |i| i.before_query(self) } @result = if !valid? all_errors = validation_errors + analysis_errors if all_errors.any? { "errors" => all_errors.map(&:to_h) } else nil end else Executor.new(self).result end ensure instrumenters.each { |i| i.after_query(self) } end end end |
#valid? ⇒ Boolean
194 195 196 197 198 199 200 201 202 |
# File 'lib/graphql/query.rb', line 194 def valid? @was_validated ||= begin @was_validated = true @valid = document_valid? && query_valid? && variables.errors.none? true end @valid end |
#validation_errors ⇒ Array<Hash>
TODO this should probably contain error instances, not hashes
167 168 169 170 |
# File 'lib/graphql/query.rb', line 167 def validation_errors valid? @validation_errors 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.
138 139 140 141 142 143 144 145 146 147 148 149 |
# File 'lib/graphql/query.rb', line 138 def variables @variables ||= begin vars = GraphQL::Query::Variables.new( @schema, @warden, @ast_variables, @provided_variables, ) @validation_errors.concat(vars.errors) vars end end |