netlify-cli/src/utils/telemetry/validation.js

Netlify command line tool

/**
 * Utility to validating analytic event names for clean data
 */

module.exports = function isValidEventName(eventName, config) {
  const validProject = [config.projectName] || []
  const validObjects = config.objects || []
  const matches = eventName.match(/([a-zA-Z]*):([a-zA-Z]*)_([a-zA-Z]*$)/)
  if (!containsSeparators(eventName) || !matches) {
    return formattingWarning(eventName)
  }
  const [, project, object, action] = matches
  let error
  // if missing any parts of event, exit
  if (!project || !object || !action) {
    return formattingWarning(eventName)
  }
  // validate project name
  if (!validProject.includes(project)) {
    error = `> "${project}" is invalid tracking project. Must be one of ${JSON.stringify(validProject)}`
    return formattingWarning(eventName, error)
  }
  // validate object name
  if (!validObjects.includes(object)) {
    error = `> "${object}" is invalid tracking object. Must be one of ${JSON.stringify(validObjects)}`
    return formattingWarning(eventName, error)
  }
  return true
}

const containsSeparators = function (eventName) {
  const underscores = (eventName.match(/_/g) || []).length
  if (underscores !== 1) {
    console.log(`Event name must have single underscore. "${eventName}" contains ${underscores}`)
    return false
  }
  const colons = (eventName.match(/:/g) || []).length
  if (colons !== 1) {
    console.log(`Event name must have single colon. "${eventName}" contains ${colons}`)
    return false
  }
  return true
}

const formattingWarning = function (eventName, errorMsg) {
  console.log('-----------------------------')
  console.log('Tracking Error:')
  console.log(`Incorrect tracking event format: "${eventName}"`)
  if (errorMsg) {
    console.log(errorMsg)
  }
  console.log('-----------------------------')
  console.log(`Formatting information: `)
  console.log(`eventName must match 'cli:objectName_actionName'`)
  console.log(`eventName must be camelCased: 'camelCase:camelCase_camelCase'`)
  console.log(`Example: cli:sites_deploySucceeded`)
  console.log('-----------------------------')
  return false
}