serverless-helper

Deploy flow using GIT and SemVer

Dependencies

• Serverless
• AWS

How to Use

/**
 * package.json
 * @type {object}
 */
var pkg = require('./package.json');
/**
 * Serverless Helper
 * @type {object}
 */
var lib = require('serverless-helper')(pkg, [opts]);
/**
 * Serverless Helper Schema
 * @type {object}
 */
var schema = lib.schema;

// Standard

// Prepare packs most of the startup logic
// Any thrown/uncaught exception will be automatically logged
module.exports = lib.prepare({
  // Event Schema Validation
  eventSchema: schema.object().keys({
    // Query String Validation
    queryStringParameters: schema.object()
      .keys({
        foo: schema.string().required(true),
      })
      .requiredKeys('foo')
      .unknown(true)
    })
    .requiredKeys('queryStringParameters')
    .unknown(true)
},
// Your logic goes inside this function
function(event, context, callback) {
  // Get parameter from event after being parsed
  const foo = event.queryStringParameters.foo

  // Context will be raw since no contextSchema has been passed

  // ...

  // Respond with 200
  lib.respond({
    message: 'Hello ' + foo
  }, callback);
});

// Promisified

// Prepare packs most of the startup logic
// Any thrown/uncaught exception will be automatically logged
module.exports = lib.prepare({
  // Promisify
  expectPromise: true
  // Event Schema Validation
  eventSchema: schema.object().keys({
    // Query String Validation
    queryStringParameters: schema.object()
      .keys({
        foo: schema.string().required(true),
      })
      .requiredKeys('foo')
      .unknown(true)
    })
    .requiredKeys('queryStringParameters')
    .unknown(true)
})
// Your logic goes inside this function
.then(function(data) {
  const event = data.event
  const context = data.context
  const callback = data.callback

  // Get parameter from event after being parsed
  const foo = event.queryStringParameters.foo

  // Context will be raw since no contextSchema has been passed

  // ...

  // Respond with 200
  lib.respond({
    message: 'Hello ' + foo
  }, callback);
});

Opts

| lib. | via opts Object | via process.env | type | default | |:--- |:--- |:--- |:--- |:--- | | env | | NODE_ENV | string | 'unknown' | | schema | schema | | object | Joi | | schema.validate | schema.validate | | function | Joi.validate | | error | error | | object | Boom | | logger | logger | | object | new (winston.Logger)(options) | | logger.log | logger.log | | function | (new (winston.Logger)(options)).log | | config | config | | object | {} |

You can also extend to your own properties

Config

| lib.config. | via opts.config Object | via process.env | type | default | |:--- |:--- |:--- |:--- |:--- | | onLocal | onLocal | ON_LOCAL | boolean | false | | logLevel | logLevel | LOG_LEVEL | string | 'verbose' | | loggly | loggly | LOGGLY | boolean | false | | airbrake | airbrake | AIRBRAKE | boolean | false | | airbrakeProjectId | airbrakeProjectId | AIRBRAKE_PROJECT_ID | string | '' | | airbrakeProjectKey | airbrakeProjectKey | AIRBRAKE_PROJECT_KEY | string | '' |

Hook to package.json

lib.name // pkg.name
lib.version // pkg.version

Hook to process.env

lib.getEnv // require('env-var').get
lib.env // process.env.NODE_ENV
lib.isEnv(env) // (process.env.NODE_ENV === env)
lib.isTest() // (process.env.NODE_ENV === 'test')
lib.isDevelopment() // (process.env.NODE_ENV === 'development')
lib.isStage() // (process.env.NODE_ENV === 'stage')
lib.isProduction() // (process.env.NODE_ENV === 'production')

Hook to Logger (default Winston + Loggly Bulk)

• Console
• Loggly Bulk

lib.logger // new (winston.Logger)(options)
lib.logger.log // (new (winston.Logger)(options)).log
lib.logJson // obj ? JSON.parse(JSON.stringify(obj)) : obj

Hook to Airbrake

lib.airbrake // new AirbrakeClient

HTTP Response

lib.respond(output, callback)

• output:

statusCode || 200
headers || {}
body || '{}'

Fail (with Error)

lib.fail(err, [boomFnArgs], callback)

• err as Error instance
• opts:

statusCode || 400
message
decorate
override

Fail (with Error message)

lib.fail(message, [boomFnArgs], callback)

• message as string
• opts:

statusCode || 400
data
message
decorate
override
ctor

Fail (with Boom function)

lib.failWith(boomFn, boomFnArgs, callback)

• boomFn as string (one of supported Boom.*)
• boomFnArgs as array (arguments to apply to Boom.*)

More info

• 4xx errors
• 5xx errors

Schema Validation (default JOI)

lib.schema // JOI
lib.schemaValidate(data, schema) // Promise.reject(Boom.badRequest) || Promise.resolve(joiResult.value)

Middlewares

lib.prepare(opts[, cb]) // function(event, context, callback){}

• cb as function (handler function)
• opts as object
• opts.[expectPromise] as boolean (default false, cb won't be called and instead .then will need to be used)
• opts.[respondAfter] as boolean (default false, cb must be a promise)
• opts.[eventSchema] as lib.schema.* (schema to validate event or null)
• opts.[contextSchema] as lib.schema (schema to validate context or null)
• opts.[bodyParser] as string ('json' or null)
• opts.[forcedResponse] as boolean (to set context.callbackWaitsForEmptyEventLoop)

TODO

Please Contribute!

I'm happy to receive contributions of any kind!

Did you like my work?

Help me out with a little donation, press on the button below.