newrelic/lib/transaction/handle.js

New Relic agent

'use strict'
var logger = require('../logger').child({component: 'transactionHandle'})
var DistributedTracePayloadStub = require('./dt-payload').Stub

module.exports = class TransactionHandle {
  /**
  * A light representation of a transaction instance, returned by calling
  * {@link API#getTransaction}.
  *
  * @constructor
  */
  constructor(transaction) {
    this._transaction = transaction
  }

  /**
  * End the transaction.
  *
  * @param  {Function} callback
  */
  end(callback) {
    this._transaction.end(callback)
  }

  /**
  * Mark the transaction to be ignored.
  */
  ignore() {
    this._transaction.setForceIgnore(true)
  }

  /**
  *
  * Proxy method for Transaction#createDistrubtedTracePayload.
  *
  * @returns {DistributedTracePayload} The created payload object.
  *
  */
  createDistributedTracePayload() {
    return this._transaction.createDistributedTracePayload()
  }

  /**
  *
  * Proxy method for Transaction#acceptDistributedTracePayload
  *
  * @param {String} The payload to accept as the parent to the current trace
  *
  */
  acceptDistributedTracePayload(payload) {
    return this._transaction.acceptDistributedTracePayload(payload)
  }
}

module.exports.Stub = class TransactionHandleStub {
  end(callback) {
    if (callback instanceof Function) {
      setImmediate(callback)
    }
    logger.debug("No transaction found when calling Transaction.end")
  }

  ignore() {
    logger.debug("No transaction found when calling Transaction.ignore")
  }

  createDistributedTracePayload() {
    logger.debug(
      "No transaction found when calling Transaction.createDistributedTracePayload"
    )
    return new DistributedTracePayloadStub()
  }

  acceptDistributedTracePayload() {
    logger.debug(
      "No transaction found when calling Transaction.acceptDistributedTracePayload"
    )
  }
}