AWS Lambda Runtime Interface Client for NodeJs
We have open-sourced a set of software packages, Runtime Interface Clients (RIC), that implement the Lambda
Runtime API, allowing you to seamlessly extend your preferred
base images to be Lambda compatible.
The Lambda Runtime Interface Client is a lightweight interface that allows your runtime to receive requests from and send requests to the Lambda service.
The Lambda NodeJS Runtime Interface Client is vended through npm.
You can include this package in your preferred base image to make that base image Lambda compatible.
- Amazon Linux 2
- Alpine
- CentOS
- Debian
- Ubuntu
The Runtime Interface Client can be installed outside of the Dockerfile as a dependency of the function we want to run in Lambda (run the below command in your function directory to add the dependency to package.json):
``shell script`
npm install aws-lambda-ric --save`
or inside the Dockerfile:dockerfile`
RUN npm install aws-lambda-ric
Next step would be to copy your Lambda function code into the image's working directory.
`dockerfileCopy function code
RUN mkdir -p ${FUNCTION_DIR}
COPY myFunction/* ${FUNCTION_DIR}
WORKDIR ${FUNCTION_DIR}
RUN npm install
`
The next step would be to set the ENTRYPOINT property of the Docker image to invoke the Runtime Interface Client and then set the CMD argument to specify the desired handler.
Example Dockerfile (to keep the image light we used a multi-stage build):
`dockerfileDefine custom function directory
ARG FUNCTION_DIR="/function"
FROM node:12-buster as build-image
WORKDIR ${FUNCTION_DIR}
RUN npm install
ENTRYPOINT ["/usr/local/bin/npx", "aws-lambda-ric"]
CMD ["app.handler"]
`
Example NodeJS handler app.js:`js
"use strict";
exports.handler = async (event, context) => {
return 'Hello World!';
}
`
To make it easy to locally test Lambda functions packaged as container images we open-sourced a lightweight web-server, Lambda Runtime Interface Emulator (RIE), which allows your function packaged as a container image to accept HTTP requests. You can install the AWS Lambda Runtime Interface Emulator on your local machine to test your function. Then when you run the image function, you set the entrypoint to be the emulator.
To install the emulator and test your Lambda function
1) From your project directory, run the following command to download the RIE from GitHub and install it on your local machine.
`shell script`
mkdir -p ~/.aws-lambda-rie && \
curl -Lo ~/.aws-lambda-rie/aws-lambda-rie https://github.com/aws/aws-lambda-runtime-interface-emulator/releases/latest/download/aws-lambda-rie && \
chmod +x ~/.aws-lambda-rie/aws-lambda-rie
2) Run your Lambda image function using the docker run command.
`shell script`
docker run -d -v ~/.aws-lambda-rie:/aws-lambda -p 9000:8080 \
--entrypoint /aws-lambda/aws-lambda-rie \
myfunction:latest \
/usr/local/bin/npx aws-lambda-ric app.handler
This runs the image as a container and starts up an endpoint locally at http://localhost:9000/2015-03-31/functions/function/invocations.
3) Post an event to the following endpoint using a curl command:
`shell script`
curl -XPOST "http://localhost:9000/2015-03-31/functions/function/invocations" -d '{}'
This command invokes the function running in the container image and returns a response.
Alternately, you can also include RIE as a part of your base image. See the AWS documentation on how to Build RIE into your base image.
`shell script`
make init
make build
Make sure the project is built:
`shell script`
make init buildmake test
Then,
* to run unit tests: make test-integ
* to run integration tests: make test-smoke
* to run smoke tests:
While running integration tests, you might encounter the Docker Hub rate limit error with the following body:
``
You have reached your pull rate limit. You may increase the limit by authenticating and upgrading: https://www.docker.com/increase-rate-limits`
To fix the above issue, consider authenticating to a Docker Hub account by setting the Docker Hub credentials as below CodeBuild environment variables.shell script``
DOCKERHUB_USERNAME=
DOCKERHUB_PASSWORD=
Recommended way is to set the Docker Hub credentials in CodeBuild job by retrieving them from AWS Secrets Manager.
If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our vulnerability reporting page. Please do not create a public github issue.
This project is licensed under the Apache-2.0 License.