Miss any of our Open RFC calls?Watch the recordings here! »

aws-lambda-router-await

0.1.3 • Public • Published

npm version dependencies

Importante.

Las fuentes reales se encuentra en el repositorio https://github.com/spring-media/aws-lambda-router , la cual se ha tomado las fuentes para modificarlo y adaptarlo a la necesidad que se tenía de usar await como retorno de promesas. Asimismo, cualquier cambio o aportación que deseen realizar sería recomendable ir a la fuentes origen del proyecto. Además, no se esta implementando pruebas unitarias.

Gracias.

aws-lambda-router-await

A small library for AWS Lambda providing routing for API Gateway, Proxy Integrations, SNS and S3 Events.

Features

  • Easy Handling of ANY method in API Gateways
  • Simplifies writing lambda handlers (in nodejs)
  • Lambda Proxy Resource support for AWS API Gateway
  • Enable CORS for requests
  • No external dependencies
  • Using async / await
  • Currently there are four processors (callers for Lambda) implemented: API Gateway ANY method (called proxyIntegration), SNS, SQS and S3.

Installation

Install via npm

$ npm install aws-lambda-router-await

or yarn

$ yarn install aws-lambda-router-await

Getting Started

This is a simple example of aws-lambda-router-await in conjunction with ANY method and the API Gateway proxy integration. The following code will respond with a message when executed using an AWS API Gateway with a GET request on URL path <base-url-of-gateway>/gateway-mapping/article/123.

const router = require('aws-lambda-router-await');
 
// handler for an api gateway event
exports.handler = router.handler({
    // for handling an http-call from an AWS API Gateway proxyIntegration we provide the following config:
    proxyIntegration: {
        routes: [
            {
                // request-path-pattern with a path variable:
                path: '/article/:id',
                method: 'GET',
                // we can use the path param 'id' in the action call:
                action: (request, context) => {
                    return "You called me with: " + request.paths.id;
                }
            }
        ]
    }
}

Enable CORS

To activate CORS on all http methods (OPTIONS requests are handled automatically) you only need to set the parameter cors to true on the proxyIntegration rule.

See the following example:

const router = require('aws-lambda-router-await');
 
exports.handler = router.handler({
    // for handling an http-call from an AWS Apigateway proxyIntegration we provide the following config:
    proxyIntegration: {
        cors: true,
        routes: [
            {
                path: '/graphql',
                method: 'POST',
                // provide a function to be called with the appropriate data
                action: (request, context) => doAnything(request.body)
            }
        ]
    }
});

If CORS is activated, these default headers will be sent on every response:

"Access-Control-Allow-Origin" = "'*'"
"Access-Control-Allow-Methods" = "'GET,POST,PUT,DELETE,HEAD,PATCH'"
"Access-Control-Allow-Headers" = "'Content-Type,X-Amz-Date,Authorization,X-Api-Key,X-Amz-Security-Token'"

Errormapping

const router = require('aws-lambda-router-await');
 
exports.handler = router.handler({
    // for handling an http-call from an AWS Apigateway proxyIntegration we provide the following config:
    proxyIntegration: {
        routes: [
            {
                path: '/graphql',
                method: 'POST',
                action: (request, context) => doAnything(request.body)
            }
        ],
        debug: true,
        errorMapping: {
            'NotFound': 404,
            'ServerError': 500
        }
    }
});

With the key word errorMapping shown in the example above you can custom mapping of thrown errors to http response code error. The action can throw an object like

"throw {reason: 'NotFound', message: 'object id not found'}"

and the http response then contains the configured value as response code and the message as the body.

SNS to Lambda Integrations

SNS Event Structure: https://docs.aws.amazon.com/sns/latest/dg/sns-message-and-json-formats.html

For handling calls in Lambdas initiated from AWS-SNS you can use the following code snippet:

const router = require('aws-lambda-router-await');
 
exports.handler = router.handler({
    sns: {
        routes: [
            {
                // a regex to match the content of the SNS-Subject:
                subject: /.*/,
                // Attention: the message is JSON-stringified
                action: (sns, context) => service.doSomething(JSON.parse(sns.Message))
            }
        ]
    }
});

SQS to Lambda Integrations

For handling calls in Lambdas initiated from AWS-SQS you can use the following code snippet:

const router = require('aws-lambda-router-await');
 
exports.handler = router.handler({
    sqs: {
        routes: [
            {
                // match complete SQS ARN:
                source: 'arn:aws:sqs:us-west-2:594035263019:aticle-import',
                // Attention: the messages Array is JSON-stringified
                action: (messages, context) => messages.forEach(message => console.log(JSON.parse(message)))
            },
            {
                // a regex to match the source SQS ARN:
                source: /.*notification/,
                // Attention: the messages array is JSON-stringified
                action: (messages, context) => service.doNotify(messages)
            }
        ]
    }
});

An SQS message always contains an array of records. In each SQS record there is the message in the body JSON key. The action method gets all body elements from the router as an array.

If more than one route matches, only the first is used!

S3 to Lambda Integrations

Lambdas can be triggered by S3 events. The router now supports these events. With the router it is very easy and flexible to connect a lambda to different s3 sources (different buckets). The following configurations are available:

  • bucketName: By specifying a fixed bucketName all s3 records with this bucket name are forwarded to a certain action. Instead of a fixed bucket a RegExp is also possible.
  • eventName: By configuring the S3 event name the routing can be further restricted. A RegExp is also possible here.
  • objectKeyPrefix: fixed string as an prefix of an object key (but not an RegExp). Is useful if you want to organize your bucket in subfolder.

A combination of bucketName, eventName and objectKeyPrefix is possible. If no bucketName, eventName and objectKeyPrefix is configured, all records of s3 events are forwarded to the action.

The action method will be called with the records of the S3Event Structure

The following examples demonstrates the most use cases:

const router = require('aws-lambda-router-await');
 
exports.handler = router.handler({
    s3: {
        routes: [
            {
                //match every s3 record to this action 
                action: (record, context) => console.log(record.s3.object.key, record.eventName)
            },
            {
                //match s3 events which created, bucket name is whitelisted here
                eventName: 'ObjectCreated:Put',
                action: (record, context) => console.log(record.s3.object.key, record.eventName)
            },
            {
                //event name is an regex: match 'ObjectCreated:Put' or 'ObjectCreated:Copy'
                eventName: /ObjectCreated:*/,
                action: (record, context) => console.log(record.s3.object.key, record.eventName)
            },
            {
                //exact name of bucket 'myBucket', event name is whitelisted and will not be checked
                bucketName: 'myBucket',
                action: (record, context) => console.log(record.s3.object.key, record.eventName)
            },
            {
                //regex of bucket name (all buckets started with 'bucket-dev-' will be machted
                bucketName: /^bucket-dev-.*/,
                action: (record, context) => console.log(record.s3.object.key, record.eventName)
            },
            { 
                //action only will be called if bucket and event matched to the given regex
                bucketName: /bucket-dev-.*/,
                eventName: /ObjectCreated:*/,
                action: (record, context) => console.log(event.s3.object.key, record.eventName)
            },
            { 
                //action only will be called if bucket and event matched to the given fixed string
                bucketName: 'bucket',
                eventName: 'ObjectRemoved:Delete',
                action: (record, context) => console.log(event.s3.object.key, record.eventName)
            },
            { 
                //match if s3 events comes from Bucket 'bucket' with event 'ObjectRemoved:Delete' 
                // and the object key starts with /upload
                objectKeyPrefix: '/upload',
                bucketName: 'bucket',
                eventName: 'ObjectRemoved:Delete',
                action: (record, context) => console.log(record.s3.object.key, record.eventName)
            }
        ],
        debug: true
    }
});

Per s3 event there can be several records per event. The action methods are called one after the other record. The result of the action method is an array with objects insides.

Custom response

Per default a status code 200 will be returned. This behavior can be overridden.

By providing a body property in the returned object you can modify the status code and response headers.

return {
        // Allow for custom status codes depending on execution.
        statusCode: 218,
        // Headers will merge with CORS headers when enabled.
        // Will merge with Content-Type: application/json
        headers: {
            'x-new-header': 'another-value'
        },
        // When returning a custom response object, a key of body is required
        // The value of body needs to be JSON stringified, this matches
        // the expected response for an AWS Lambda.
        body: JSON.stringify({
            foo: 'bar'
        })
    };

Local developement

The best is to work with yarn link

See here: https://yarnpkg.com/en/docs/cli/link

Release History

  • 1.0 Version initial.

Install

npm i aws-lambda-router-await

DownloadsWeekly Downloads

2

Version

0.1.3

License

Apache-2.0

Unpacked Size

116 kB

Total Files

10

Last publish

Collaborators

  • avatar