dd-trace/packages/datadog-instrumentations/src/sharedb.js

Datadog APM tracing client for JavaScript

'use strict'

const shimmer = require('../../datadog-shimmer')
const {
  channel,
  addHook
} = require('./helpers/instrument')

/**
 * @description The enum values in this map are not exposed from ShareDB, so the keys are hard-coded here.
 * The values were derived from: https://github.com/share/sharedb/blob/master/lib/client/connection.js#L196
 */
const READABLE_ACTION_NAMES = {
  hs: 'handshake',
  qf: 'query-fetch',
  qs: 'query-subscribe',
  qu: 'query-unsubscribe',
  bf: 'bulk-fetch',
  bs: 'bulk-subscribe',
  bu: 'bulk-unsubscribe',
  f: 'fetch',
  s: 'subscribe',
  u: 'unsubscribe',
  op: 'op',
  nf: 'snapshot-fetch',
  nt: 'snapshot-fetch-by-ts',
  p: 'presence-broadcast',
  pr: 'presence-request',
  ps: 'presence-subscribe',
  pu: 'presence-unsubscribe'
}

addHook({ name: 'sharedb', versions: ['>=1'], file: 'lib/agent.js' }, Agent => {
  const startCh = channel('apm:sharedb:request:start')
  const finishCh = channel('apm:sharedb:request:finish')
  const errorCh = channel('apm:sharedb:request:error')

  shimmer.wrap(Agent.prototype, '_handleMessage', origHandleMessageFn => function (request, callback) {
    const action = request.a
    const actionName = getReadableActionName(action)

    const ctx = { actionName, request }
    return startCh.runStores(ctx, () => {
      arguments[1] = shimmer.wrapFunction(callback, callback => function (error, res) {
        if (error) {
          ctx.error = error
          errorCh.publish(error)
        }
        ctx.res = res
        return finishCh.runStores(ctx, callback, this, ...arguments)
      })

      try {
        return origHandleMessageFn.apply(this, arguments)
      } catch (error) {
        ctx.error = error
        errorCh.publish(ctx)

        throw error
      }
    })
  })
  return Agent
})

function getReadableActionName (action) {
  const actionName = READABLE_ACTION_NAMES[action]
  if (actionName === undefined) {
    return action
  }
  return actionName
}