class GraphQL::Tracing::PlatformTracing

Each platform provides:

@api private

Attributes

platform_keys[RW]
options[R]

Public Class Methods

inherited(child_class) click to toggle source
# File lib/graphql/tracing/platform_tracing.rb, line 14
def inherited(child_class)
  child_class.platform_keys = self.platform_keys
end
new(options = {}) click to toggle source
# File lib/graphql/tracing/platform_tracing.rb, line 19
def initialize(options = {})
  @options = options
  @platform_keys = self.class.platform_keys
  @trace_scalars = options.fetch(:trace_scalars, false)
end
use(schema_defn, options = {}) click to toggle source
# File lib/graphql/tracing/platform_tracing.rb, line 102
def self.use(schema_defn, options = {})
  tracer = self.new(**options)
  if !schema_defn.is_a?(Class)
    schema_defn.instrument(:field, tracer)
  end
  schema_defn.tracer(tracer)
end

Public Instance Methods

instrument(type, field) click to toggle source
# File lib/graphql/tracing/platform_tracing.rb, line 82
def instrument(type, field)
  return_type = field.type.unwrap
  case return_type
  when GraphQL::ScalarType, GraphQL::EnumType
    if field.trace || (field.trace.nil? && @trace_scalars)
      trace_field(type, field)
    else
      field
    end
  else
    trace_field(type, field)
  end
end
trace(key, data) { || ... } click to toggle source
# File lib/graphql/tracing/platform_tracing.rb, line 25
def trace(key, data)
  case key
  when "lex", "parse", "validate", "analyze_query", "analyze_multiplex", "execute_query", "execute_query_lazy", "execute_multiplex"
    platform_key = @platform_keys.fetch(key)
    platform_trace(platform_key, key, data) do
      yield
    end
  when "execute_field", "execute_field_lazy"
    if data[:context]
      field = data[:context].field
      platform_key = field.metadata[:platform_key]
      trace_field = true # implemented with instrumenter
    else
      field = data[:field]
      # HERE
      return_type = field.type.unwrap
      trace_field = if return_type.kind.scalar? || return_type.kind.enum?
        (field.trace.nil? && @trace_scalars) || field.trace
      else
        true
      end

      platform_key = if trace_field
        context = data.fetch(:query).context
        cached_platform_key(context, field, :field) { platform_field_key(data[:owner], field) }
      else
        nil
      end
    end

    if platform_key && trace_field
      platform_trace(platform_key, key, data) do
        yield
      end
    else
      yield
    end
  when "authorized", "authorized_lazy"
    type = data.fetch(:type)
    context = data.fetch(:context)
    platform_key = cached_platform_key(context, type, :authorized) { platform_authorized_key(type) }
    platform_trace(platform_key, key, data) do
      yield
    end
  when "resolve_type", "resolve_type_lazy"
    type = data.fetch(:type)
    context = data.fetch(:context)
    platform_key = cached_platform_key(context, type, :resolve_type) { platform_resolve_type_key(type) }
    platform_trace(platform_key, key, data) do
      yield
    end
  else
    # it's a custom key
    yield
  end
end
trace_field(type, field) click to toggle source
# File lib/graphql/tracing/platform_tracing.rb, line 96
def trace_field(type, field)
  new_f = field.redefine
  new_f.metadata[:platform_key] = platform_field_key(type, field)
  new_f
end

Private Instance Methods

cached_platform_key(ctx, key, trace_phase) { || ... } click to toggle source

Different kind of schema objects have different kinds of keys:

  • Object types: `.authorized`

  • Union/Interface types: `.resolve_type`

  • Fields: execution

So, they can all share one cache.

If the key isn't present, the given block is called and the result is cached for `key`.

@return [String]

# File lib/graphql/tracing/platform_tracing.rb, line 143
def cached_platform_key(ctx, key, trace_phase)
  cache = ctx.namespace(self.class)[:platform_key_cache] ||= {}
  cache.fetch(key) { cache[key] = yield }
end
fallback_transaction_name(context) click to toggle source
# File lib/graphql/tracing/platform_tracing.rb, line 126
def fallback_transaction_name(context)
  context[:tracing_fallback_transaction_name]
end
transaction_name(query) click to toggle source

Get the transaction name based on the operation type and name if possible, or fall back to a user provided one. Useful for anonymous queries.

# File lib/graphql/tracing/platform_tracing.rb, line 114
def transaction_name(query)
  selected_op = query.selected_operation
  txn_name = if selected_op
    op_type = selected_op.operation_type
    op_name = selected_op.name || fallback_transaction_name(query.context) || "anonymous"
    "#{op_type}.#{op_name}"
  else
    "query.anonymous"
  end
  "GraphQL/#{txn_name}"
end