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/execution_context.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

Classes: Arguments, Context, 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: {}, operation_name: nil, root_value: nil, max_depth: nil, max_complexity: nil) ⇒ 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)


31
32
33
34
35
36
37
38
39
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
# File 'lib/graphql/query.rb', line 31

def initialize(schema, query_string = nil, document: nil, context: nil, variables: {}, operation_name: nil, root_value: nil, max_depth: nil, max_complexity: nil)
  fail ArgumentError, "a query string or document is required" unless query_string || document

  @schema = schema
  @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 = {}
  @provided_variables = variables
  @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


20
21
22
# File 'lib/graphql/query.rb', line 20

def context
  @context
end

#documentObject (readonly)

Returns the value of attribute document


20
21
22
# File 'lib/graphql/query.rb', line 20

def document
  @document
end

#fragmentsObject (readonly)

Returns the value of attribute fragments


20
21
22
# File 'lib/graphql/query.rb', line 20

def fragments
  @fragments
end

#max_depthObject (readonly)

Returns the value of attribute max_depth


20
21
22
# File 'lib/graphql/query.rb', line 20

def max_depth
  @max_depth
end

#operationsObject (readonly)

Returns the value of attribute operations


20
21
22
# File 'lib/graphql/query.rb', line 20

def operations
  @operations
end

#query_stringObject (readonly)

Returns the value of attribute query_string


20
21
22
# File 'lib/graphql/query.rb', line 20

def query_string
  @query_string
end

#root_valueObject (readonly)

Returns the value of attribute root_value


20
21
22
# File 'lib/graphql/query.rb', line 20

def root_value
  @root_value
end

#schemaObject (readonly)

Returns the value of attribute schema


20
21
22
# File 'lib/graphql/query.rb', line 20

def schema
  @schema
end

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


101
102
103
# File 'lib/graphql/query.rb', line 101

def selected_operation
  @selected_operation
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)


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

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:


143
144
145
146
147
148
149
150
151
# File 'lib/graphql/query.rb', line 143

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

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

Returns Irep node pairs

Returns:


122
123
124
125
# File 'lib/graphql/query.rb', line 122

def internal_representation
  valid?
  @internal_representation
end

#resultObject

Get the result for this query, executing it once


82
83
84
85
86
87
88
89
90
91
92
93
94
95
# File 'lib/graphql/query.rb', line 82

def result
  @result ||= begin
    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
  end
end

#valid?Boolean

Returns:

  • (Boolean)

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

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


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

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:


109
110
111
112
113
114
115
116
117
118
119
# File 'lib/graphql/query.rb', line 109

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