class GraphQL::ExecutionError

If a field’s resolve function returns an ExecutionError, the error will be inserted into the response’s "errors" key and the field will resolve to nil.

Attributes

extensions [RW]

Returns

Hash — Optional custom data for error objects which will be added under the extensions key.

options [RW]

Deprecated: Use extensions instead of options. The GraphQL spec recommends that any custom entries in an error be under the extensions key.

Returns

Hash — Optional data for error objects

path [RW]

Returns

String — an array describing the JSON-path into the execution response which corresponds to this error.

Public Class Methods

new (message, ast_node: nil, ast_nodes: nil, options: nil, extensions: nil)

Source

# File lib/graphql/execution_error.rb, line 25
def initialize(message, ast_node: nil, ast_nodes: nil, options: nil, extensions: nil)
  @ast_nodes = ast_nodes || [ast_node]
  @options = options
  @extensions = extensions
  super(message)
end

Calls superclass method

Public Instance Methods

finalize_graphql_result (query, result_data, key)

Source

# File lib/graphql/execution_error.rb, line 32
def finalize_graphql_result(query, result_data, key)
  add_this_error = !query.context.errors.any? { |e| e.eql?(self) }
  if add_this_error
    query.context.add_error(self)
  end
  if ast_node.is_a?(GraphQL::Language::Nodes::Directive)
    # This is for backwards compatibility ... what does the spec say?
    result_data.delete(key)
  else
    result_data[key] = nil
  end
end

to_h() → Hash

Source

# File lib/graphql/execution_error.rb, line 51
def to_h
  hash = {
    "message" => message,
  }
  if ast_node
    hash["locations"] = @ast_nodes.map { |a| { "line" => a.line, "column" => a.col } }
  end
  if path
    hash["path"] = path
  end
  if options
    hash.merge!(options)
  end
  if extensions
    hash["extensions"] = extensions.each_with_object({}) { |(key, value), ext|
      ext[key.to_s] = value
    }
  end
  hash
end

Returns

Hash — An entry for the response’s “errors” key