Class: GraphQL::Query

Inherits:
Object
  • Object
show all
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

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

Defined Under Namespace

Modules: NullExcept Classes: Arguments, Context, ExecutionCall, Executor, InputValidationResult, LiteralInput, OperationNameMissingError, SerialExecution, VariableValidationError, Variables

Instance Attribute Summary collapse

Instance Method Summary collapse

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

Parameters:

  • schema (GraphQL::Schema)
  • query_string (String) (defaults to: nil)
  • context (#[])

    an arbitrary hash of values which you can access in Field#resolve

  • variables (Hash)

    values for $variables in the query

  • operation_name (String)

    if the query string contains many operations, this is the one which should be executed

  • root_value (Object)

    the object used to resolve fields on the root type

  • max_depth (Numeric)

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

  • max_complexity (Numeric)

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

  • except (<#call(schema_member)>)

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


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

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 = []
  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
    end
  end
end

Instance Attribute Details

#contextObject (readonly)

Returns the value of attribute context


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

def context
  @context
end

#documentObject (readonly)

Returns the value of attribute document


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

def document
  @document
end

#fragmentsObject (readonly)

Returns the value of attribute fragments


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

def fragments
  @fragments
end

#max_depthObject (readonly)

Returns the value of attribute max_depth


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

def max_depth
  @max_depth
end

#operationsObject (readonly)

Returns the value of attribute operations


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

def operations
  @operations
end

#query_stringObject (readonly)

Returns the value of attribute query_string


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

def query_string
  @query_string
end

#root_valueObject (readonly)

Returns the value of attribute root_value


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

def root_value
  @root_value
end

#schemaObject (readonly)

Returns the value of attribute schema


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

def schema
  @schema
end

#selected_operationGraphQL::Language::Nodes::Document? (readonly)


108
109
110
# File 'lib/graphql/query.rb', line 108

def selected_operation
  @selected_operation
end

#wardenObject (readonly)

Returns the value of attribute warden


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

def warden
  @warden
end

Instance Method Details

#analysis_errorsArray<Hash>

TODO this should probably contain error instances, not hashes

Returns:

  • (Array<Hash>)

    Errors for this particular query run (eg, exceeds max complexity)


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

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.

Returns:


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

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


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

def get_field(type, name)
  @warden.get_field(type, name)
end

#get_type(type_name) ⇒ Object


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

def get_type(type_name)
  @warden.get_type(type_name)
end

#internal_representationHash<String, nil => GraphQL::InternalRepresentation::Node] Operation name -

Returns Irep node pairs

Returns:


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

def internal_representation
  valid?
  @internal_representation
end

#possible_types(type) ⇒ Object


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

def possible_types(type)
  @warden.possible_types(type)
end

#resolve_type(type) ⇒ Object


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

def resolve_type(type)
  @schema.resolve_type(type, @context)
end

#resultObject

Get the result for this query, executing it once


96
97
98
99
100
101
102
# File 'lib/graphql/query.rb', line 96

def result
  @result ||= begin
    instrumenters = @schema.instrumenters[:query]
    execution_call = ExecutionCall.new(self, instrumenters)
    execution_call.call
  end
end

#selections(nodes, type) ⇒ Object


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

def selections(nodes, type)
  @selections ||= Hash.new { |h, k| h[k] = GraphQL::InternalRepresentation::Selections.build(self, k) }
  @selections[nodes][type]
end

#valid?Boolean

Returns:

  • (Boolean)

164
165
166
167
168
169
170
171
172
# File 'lib/graphql/query.rb', line 164

def valid?
  @was_validated ||= begin
    @was_validated = true
    @valid = document_valid? && query_valid? && variables.errors.none?
    true
  end

  @valid
end

#validation_errorsArray<Hash>

TODO this should probably contain error instances, not hashes

Returns:

  • (Array<Hash>)

    Static validation errors for the query string


137
138
139
140
# File 'lib/graphql/query.rb', line 137

def validation_errors
  valid?
  @validation_errors
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.

Returns:


116
117
118
119
120
121
122
123
124
125
126
127
# File 'lib/graphql/query.rb', line 116

def variables
  @variables ||= begin
    vars = GraphQL::Query::Variables.new(
      @schema,
      @warden,
      @ast_variables,
      @provided_variables,
    )
    @validation_errors.concat(vars.errors)
    vars
  end
end