Class: GraphQL::Tracing::Trace

Inherits:

Object

• Object
• GraphQL::Tracing::Trace

Defined in:

lib/graphql/tracing/trace.rb

Overview

This is the base class for a trace instance whose methods are called during query execution. “Trace modes” are subclasses of this with custom tracing modules mixed in.

A trace module may implement any of the methods on Trace, being sure to call super to continue any tracing hooks and call the actual runtime behavior.

Direct Known Subclasses

LegacyTrace

Instance Method Summary

• #analyze_multiplex(multiplex:) ⇒ void
• #analyze_query(query:) ⇒ Object
• #authorized(query:, type:, object:) ⇒ Object
• #authorized_lazy(query:, type:, object:) ⇒ Object
• #begin_analyze_multiplex(multiplex, analyzers) ⇒ void
• #begin_authorized(type, object, context) ⇒ void

  A call to .authorized? is starting.

• #begin_dataloader(dataloader) ⇒ void

  A dataloader run is starting.

• #begin_dataloader_source(source) ⇒ void

  A source with pending keys is about to fetch.

• #begin_execute_field(field, object, arguments, query) ⇒ Object

  GraphQL is about to resolve this field.

• #begin_execute_multiplex(multiplex) ⇒ void

  This is the first event in the tracing lifecycle.

• #begin_parse(query_str) ⇒ void
• #begin_resolve_type(type, value, context) ⇒ void

  A call to .resolve_type is starting.

• #begin_validate(query, validate) ⇒ Object
• #dataloader_fiber_exit ⇒ void

  Called when an execution or source fiber terminates.

• #dataloader_fiber_resume(source) ⇒ void

  Called when a Dataloader fiber is resumed because data has been loaded.

• #dataloader_fiber_yield(source) ⇒ void

  Called when a Dataloader fiber is paused to wait for data.

• #dataloader_spawn_execution_fiber(jobs) ⇒ void

  Called when Dataloader spins up a new fiber for GraphQL execution.

• #dataloader_spawn_source_fiber(pending_sources) ⇒ void

  Called when Dataloader spins up a new fiber for fetching data.

• #end_analyze_multiplex(multiplex, analyzers) ⇒ void
• #end_authorized(type, object, context, authorized_result) ⇒ void

  A call to .authorized? just finished.

• #end_dataloader(dataloader) ⇒ void

  A dataloader run has ended.

• #end_dataloader_source(source) ⇒ void

  A fetch call has just ended.

• #end_execute_field(field, object, arguments, query, result) ⇒ Object

  GraphQL just finished resolving this field.

• #end_execute_multiplex(multiplex) ⇒ void

  This is the last event of the tracing lifecycle.

• #end_parse(query_str) ⇒ void
• #end_resolve_type(type, value, context, resolved_type) ⇒ void

  A call to .resolve_type just ended.

• #end_validate(query, validate, errors) ⇒ Object
• #execute_field(field:, query:, ast_node:, arguments:, object:) ⇒ Object
• #execute_field_lazy(field:, query:, ast_node:, arguments:, object:) ⇒ Object
• #execute_multiplex(multiplex:) ⇒ void

  This wraps an entire .execute call.

• #execute_query(query:) ⇒ Object
• #execute_query_lazy(query:, multiplex:) ⇒ Object
• #initialize(multiplex: nil, query: nil, **_options) ⇒ Trace constructor

  A new instance of Trace.

• #lex(query_string:) ⇒ Object

  The Ruby parser doesn’t call this method (graphql/c_parser does.).

• #parse(query_string:) ⇒ void
• #resolve_type(query:, type:, object:) ⇒ Object
• #resolve_type_lazy(query:, type:, object:) ⇒ Object
• #validate(query:, validate:) ⇒ Object

Constructor Details

#initialize(multiplex: nil, query: nil, **_options) ⇒ Trace

Returns a new instance of Trace.

Parameters:

• multiplex (GraphQL::Execution::Multiplex, nil) (defaults to: nil)
• query (GraphQL::Query, nil) (defaults to: nil)

# File 'lib/graphql/tracing/trace.rb', line 16

def initialize(multiplex: nil, query: nil, **_options)
  @multiplex = multiplex
  @query = query
end

Instance Method Details

#analyze_multiplex(multiplex:) ⇒ void

This method returns an undefined value.

Parameters:

• multiplex (GraphQL::Execution::Multiplex)

# File 'lib/graphql/tracing/trace.rb', line 58

def analyze_multiplex(multiplex:)
  yield
end

#analyze_query(query:) ⇒ Object

# File 'lib/graphql/tracing/trace.rb', line 62

def analyze_query(query:)
  yield
end

#authorized(query:, type:, object:) ⇒ Object

# File 'lib/graphql/tracing/trace.rb', line 114

def authorized(query:, type:, object:)
  yield
end

#authorized_lazy(query:, type:, object:) ⇒ Object

# File 'lib/graphql/tracing/trace.rb', line 134

def authorized_lazy(query:, type:, object:)
  yield
end

#begin_analyze_multiplex(multiplex, analyzers) ⇒ void

This method returns an undefined value.

Parameters:

• multiplex (GraphQL::Execution::Multiplex)
• analyzers (Array<Class>)

# File 'lib/graphql/tracing/trace.rb', line 51

def begin_analyze_multiplex(multiplex, analyzers); end

#begin_authorized(type, object, context) ⇒ void

This method returns an undefined value.

A call to .authorized? is starting

Parameters:

• type (Class<GraphQL::Schema::Object>)
• object (Object)
• context (GraphQL::Query::Context)

# File 'lib/graphql/tracing/trace.rb', line 123

def begin_authorized(type, object, context)
end

#begin_dataloader(dataloader) ⇒ void

This method returns an undefined value.

A dataloader run is starting

Parameters:

• dataloader (GraphQL::Dataloader)

# File 'lib/graphql/tracing/trace.rb', line 166

def begin_dataloader(dataloader); end

#begin_dataloader_source(source) ⇒ void

This method returns an undefined value.

A source with pending keys is about to fetch

Parameters:

• source (GraphQL::Dataloader::Source)

# File 'lib/graphql/tracing/trace.rb', line 175

def begin_dataloader_source(source); end

#begin_execute_field(field, object, arguments, query) ⇒ Object

GraphQL is about to resolve this field

Parameters:

• field (GraphQL::Schema::Field)
• object (GraphQL::Schema::Object)
• arguments (Hash)
• query (GraphQL::Query)

# File 'lib/graphql/tracing/trace.rb', line 97

def begin_execute_field(field, object, arguments, query); end

#begin_execute_multiplex(multiplex) ⇒ void

This method returns an undefined value.

This is the first event in the tracing lifecycle. Every Query is technically run inside a Multiplex.

Parameters:

• multiplex (GraphQL::Execution::Multiplex)

# File 'lib/graphql/tracing/trace.rb', line 70

def begin_execute_multiplex(multiplex); end

#begin_parse(query_str) ⇒ void

This method returns an undefined value.

Parameters:

• query_str (String)

# File 'lib/graphql/tracing/trace.rb', line 28

def begin_parse(query_str); end

#begin_resolve_type(type, value, context) ⇒ void

This method returns an undefined value.

A call to .resolve_type is starting

Parameters:

• type (Class<GraphQL::Schema::Union>, Module<GraphQL::Schema::Interface>)
• value (Object)
• context (GraphQL::Query::Context)

# File 'lib/graphql/tracing/trace.rb', line 151

def begin_resolve_type(type, value, context)
end

#begin_validate(query, validate) ⇒ Object

# File 'lib/graphql/tracing/trace.rb', line 42

def begin_validate(query, validate)
end

#dataloader_fiber_exit ⇒ void

This method returns an undefined value.

Called when an execution or source fiber terminates

# File 'lib/graphql/tracing/trace.rb', line 191

def dataloader_fiber_exit; end

#dataloader_fiber_resume(source) ⇒ void

This method returns an undefined value.

Called when a Dataloader fiber is resumed because data has been loaded

Parameters:

• source (GraphQL::Dataloader::Source) —

  The Source whose load call previously caused this Fiber to wait

# File 'lib/graphql/tracing/trace.rb', line 200

def dataloader_fiber_resume(source); end

#dataloader_fiber_yield(source) ⇒ void

This method returns an undefined value.

Called when a Dataloader fiber is paused to wait for data

Parameters:

• source (GraphQL::Dataloader::Source) —

  The Source whose load call initiated this yield

# File 'lib/graphql/tracing/trace.rb', line 196

def dataloader_fiber_yield(source); end

#dataloader_spawn_execution_fiber(jobs) ⇒ void

This method returns an undefined value.

Called when Dataloader spins up a new fiber for GraphQL execution

Parameters:

• jobs (Array<#call>) —

  Execution steps to run

# File 'lib/graphql/tracing/trace.rb', line 184

def dataloader_spawn_execution_fiber(jobs); end

#dataloader_spawn_source_fiber(pending_sources) ⇒ void

This method returns an undefined value.

Called when Dataloader spins up a new fiber for fetching data

Parameters:

• pending_sources (GraphQL::Dataloader::Source) —

  Instances with pending keys

# File 'lib/graphql/tracing/trace.rb', line 188

def dataloader_spawn_source_fiber(pending_sources); end

#end_analyze_multiplex(multiplex, analyzers) ⇒ void

This method returns an undefined value.

Parameters:

• multiplex (GraphQL::Execution::Multiplex)
• analyzers (Array<Class>)

# File 'lib/graphql/tracing/trace.rb', line 55

def end_analyze_multiplex(multiplex, analyzers); end

#end_authorized(type, object, context, authorized_result) ⇒ void

This method returns an undefined value.

A call to .authorized? just finished

Parameters:

• type (Class<GraphQL::Schema::Object>)
• object (Object)
• context (GraphQL::Query::Context)
• authorized_result (Boolean)

# File 'lib/graphql/tracing/trace.rb', line 131

def end_authorized(type, object, context, authorized_result)
end

#end_dataloader(dataloader) ⇒ void

This method returns an undefined value.

A dataloader run has ended

Parameters:

• dataloder (GraphQL::Dataloader)

# File 'lib/graphql/tracing/trace.rb', line 170

def end_dataloader(dataloader); end

#end_dataloader_source(source) ⇒ void

This method returns an undefined value.

A fetch call has just ended

Parameters:

• source (GraphQL::Dataloader::Source)

# File 'lib/graphql/tracing/trace.rb', line 179

def end_dataloader_source(source); end

#end_execute_field(field, object, arguments, query, result) ⇒ Object

GraphQL just finished resolving this field

Parameters:

• field (GraphQL::Schema::Field)
• object (GraphQL::Schema::Object)
• arguments (Hash)
• query (GraphQL::Query)
• result (Object)

# File 'lib/graphql/tracing/trace.rb', line 104

def end_execute_field(field, object, arguments, query, result); end

#end_execute_multiplex(multiplex) ⇒ void

This method returns an undefined value.

This is the last event of the tracing lifecycle.

Parameters:

• multiplex (GraphQL::Execution::Multiplex)

# File 'lib/graphql/tracing/trace.rb', line 75

def end_execute_multiplex(multiplex); end

#end_parse(query_str) ⇒ void

This method returns an undefined value.

Parameters:

• query_str (String)

# File 'lib/graphql/tracing/trace.rb', line 31

def end_parse(query_str); end

#end_resolve_type(type, value, context, resolved_type) ⇒ void

This method returns an undefined value.

A call to .resolve_type just ended

Parameters:

• type (Class<GraphQL::Schema::Union>, Module<GraphQL::Schema::Interface>)
• value (Object)
• context (GraphQL::Query::Context)
• resolved_type (Class<GraphQL::Schema::Object>)

# File 'lib/graphql/tracing/trace.rb', line 160

def end_resolve_type(type, value, context, resolved_type)
end

#end_validate(query, validate, errors) ⇒ Object

# File 'lib/graphql/tracing/trace.rb', line 45

def end_validate(query, validate, errors)
end

#execute_field(field:, query:, ast_node:, arguments:, object:) ⇒ Object

# File 'lib/graphql/tracing/trace.rb', line 106

def execute_field(field:, query:, ast_node:, arguments:, object:)
  yield
end

#execute_field_lazy(field:, query:, ast_node:, arguments:, object:) ⇒ Object

# File 'lib/graphql/tracing/trace.rb', line 110

def execute_field_lazy(field:, query:, ast_node:, arguments:, object:)
  yield
end

#execute_multiplex(multiplex:) ⇒ void

This method returns an undefined value.

This wraps an entire .execute call.

Parameters:

• multiplex (GraphQL::Execution::Multiplex)

# File 'lib/graphql/tracing/trace.rb', line 80

def execute_multiplex(multiplex:)
  yield
end

#execute_query(query:) ⇒ Object

# File 'lib/graphql/tracing/trace.rb', line 84

def execute_query(query:)
  yield
end

#execute_query_lazy(query:, multiplex:) ⇒ Object

# File 'lib/graphql/tracing/trace.rb', line 88

def execute_query_lazy(query:, multiplex:)
  yield
end

#lex(query_string:) ⇒ Object

The Ruby parser doesn’t call this method (graphql/c_parser does.)

# File 'lib/graphql/tracing/trace.rb', line 22

def lex(query_string:)
  yield
end

#parse(query_string:) ⇒ void

This method returns an undefined value.

Parameters:

• query_string (String)

# File 'lib/graphql/tracing/trace.rb', line 34

def parse(query_string:)
  yield
end

#resolve_type(query:, type:, object:) ⇒ Object

# File 'lib/graphql/tracing/trace.rb', line 138

def resolve_type(query:, type:, object:)
  yield
end

#resolve_type_lazy(query:, type:, object:) ⇒ Object

# File 'lib/graphql/tracing/trace.rb', line 142

def resolve_type_lazy(query:, type:, object:)
  yield
end

#validate(query:, validate:) ⇒ Object

# File 'lib/graphql/tracing/trace.rb', line 38

def validate(query:, validate:)
  yield
end