Class: GraphQL::Backtrace

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Includes:
Enumerable
Defined in:
lib/graphql/backtrace.rb,
lib/graphql/backtrace/table.rb,
lib/graphql/backtrace/tracer.rb,
lib/graphql/backtrace/traced_error.rb,
lib/graphql/backtrace/legacy_tracer.rb,
lib/graphql/backtrace/inspect_result.rb

Overview

Wrap unhandled errors with TracedError.

TracedError provides a GraphQL backtrace with arguments and return values. The underlying error is available as TracedError#cause.

Examples:

toggling backtrace annotation

class MySchema < GraphQL::Schema
  if Rails.env.development? || Rails.env.test?
    use GraphQL::Backtrace
  end
end

Defined Under Namespace

Modules: InspectResult, LegacyTracer, Tracer Classes: Frame, Table, TracedError

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(context, value: nil) ⇒ Backtrace

Returns a new instance of Backtrace.


35
36
37
# File 'lib/graphql/backtrace.rb', line 35

def initialize(context, value: nil)
  @table = Table.new(context, value: value)
end

Class Method Details

.use(schema_defn, legacy: false) ⇒ Object


26
27
28
29
30
31
32
33
# File 'lib/graphql/backtrace.rb', line 26

def self.use(schema_defn, legacy: false)
  tracer = if legacy
    self::LegacyTracer
  else
    self::Tracer
  end
  schema_defn.tracer(tracer)
end

Instance Method Details

#inspectObject Also known as: to_s


39
40
41
# File 'lib/graphql/backtrace.rb', line 39

def inspect
  @table.to_table
end

#to_aObject


45
46
47
# File 'lib/graphql/backtrace.rb', line 45

def to_a
  @table.to_backtrace
end