Serverless Framework Enterprise Safeguard Policies

require-function-description.js

const { fromPairs } = require('lodash')

module.exports = function requireFunctionDescription(policy, service, options) {
  const {
    declaration: { functions },
    provider: { naming },
    compiled: {
      'cloudformation-template-update-stack.json': { Resources }
    }
  } = service
  const logicalFuncNamesToConfigFuncName = fromPairs(
    Object.keys(functions || {}).map((funcName) => [naming.getLambdaLogicalId(funcName), funcName])
  )

  for (const [funcName, { Properties, Type}] of Object.entries(Resources)) {
    if (Type !== 'AWS::Lambda::Function') {
      continue
    }

    if (!Properties.Description) {
      const configFuncName = logicalFuncNamesToConfigFuncName[funcName] || funcName
      policy.warn (
        `Description on function '${configFuncName}' is missing`
      )
    }
  }

  policy.approve()
}