dd-trace/packages/datadog-plugin-aws-durable-execution-sdk-js/src/context.js

Datadog APM tracing client for JavaScript

'use strict'

const { storage } = require('../../datadog-core')
const TracingPlugin = require('../../dd-trace/src/plugins/tracing')
const { addOpMeta, getOperationAttempt, getStepDataForNext, unwrapDurableError } = require('./util')

// Span names whose direct children must keep the default resource.
// These can have very high cardinality which is undesireable in the resource.
const HIGH_CARDINALITY_PARENT_SPAN_NAMES = new Set([
  'aws.durable.map',
  'aws.durable.parallel',
])

// The SDK emits these subTypes as internal scaffolding around map/parallel iterations
// and waitForCallback; not user-visible operations.
const SUPPRESSED_CHILD_CONTEXT_SUBTYPES = new Set([
  'Map',
  'Parallel',
  'MapIteration',
  'ParallelBranch',
  'WaitForCallback',
])

class BaseContextPlugin extends TracingPlugin {
  static id = 'aws-durable-execution-sdk-js'
  static type = 'serverless'
  static kind = 'internal'

  constructor (...args) {
    super(...args)
    this.addSub(this.constructor.settleChannel, ctx => this.settle(ctx))
  }

  bindStart (ctx) {
    const spanName = this.constructor.spanName
    const parentName = this.activeSpan?.context()._name
    const operationName = this.getOperationName(ctx)
    const resource = HIGH_CARDINALITY_PARENT_SPAN_NAMES.has(parentName) ? undefined : operationName

    const meta = {}
    if (operationName) {
      meta['aws.durable.operation_name'] = operationName
    }
    const stepInfo = getStepDataForNext(ctx.self)
    addOpMeta(meta, stepInfo)

    const metrics = this.constructor.retryable
      ? { 'aws.durable.operation_attempt': getOperationAttempt(stepInfo.stepData) }
      : undefined

    this.startSpan(spanName, {
      resource,
      type: this.constructor.type,
      kind: this.constructor.kind,
      meta,
      metrics,
    }, ctx)

    return ctx.currentStore
  }

  // All context methods have two overloads: method(name, …) and method(…); args[0] is the name in the first form.
  getOperationName (ctx) {
    const args = ctx.arguments || []
    return typeof args[0] === 'string' ? args[0] : undefined
  }

  settle (ctx) {
    if (ctx.suppressed) return
    if (ctx.error !== undefined) {
      ctx.currentStore?.span?.setTag('error', unwrapDurableError(ctx))
    }
    this.finish(ctx)
  }

  error (ctxOrError) {
    this.settle(ctxOrError)
  }
}

function makeContextPlugin (method, spanName, { retryable }) {
  return class extends BaseContextPlugin {
    static prefix = `tracing:orchestrion:@aws/durable-execution-sdk-js:DurableContextImpl_${method}`
    static settleChannel = `apm:aws-durable-execution-sdk-js:${method}:settle`
    static spanName = spanName
    static retryable = retryable
  }
}

class RunInChildContextPlugin extends BaseContextPlugin {
  static prefix = 'tracing:orchestrion:@aws/durable-execution-sdk-js:DurableContextImpl_runInChildContext'
  static settleChannel = 'apm:aws-durable-execution-sdk-js:runInChildContext:settle'
  static spanName = 'aws.durable.child_context'
  static retryable = false

  bindStart (ctx) {
    if (SUPPRESSED_CHILD_CONTEXT_SUBTYPES.has(getRunInChildContextSubtype(ctx))) {
      // Pass the active store through unchanged so any nested spans
      // remain parented to the surrounding map/parallel span
      ctx.suppressed = true
      return storage('legacy').getStore()
    }
    return super.bindStart(ctx)
  }
}

// runInChildContext has two overloads: `(name, fn, options)` and `(fn, options)`.
function getRunInChildContextSubtype (ctx) {
  const args = ctx.arguments || []
  const opts = typeof args[0] === 'function' ? args[1] : args[2]
  return opts?.subType
}

module.exports = {
  step: makeContextPlugin('step', 'aws.durable.step', { retryable: true }),
  wait: makeContextPlugin('wait', 'aws.durable.wait', { retryable: false }),
  waitForCondition: makeContextPlugin('waitForCondition', 'aws.durable.wait_for_condition', { retryable: true }),
  waitForCallback: makeContextPlugin('waitForCallback', 'aws.durable.wait_for_callback', { retryable: false }),
  createCallback: makeContextPlugin('createCallback', 'aws.durable.create_callback', { retryable: false }),
  map: makeContextPlugin('map', 'aws.durable.map', { retryable: false }),
  parallel: makeContextPlugin('parallel', 'aws.durable.parallel', { retryable: false }),
  runInChildContext: RunInChildContextPlugin,
}