AWS Lambda NodeJS-16 Runtime

AWS Lambda runtime API implemented in Node.js. The supported version is usually the latest LTS.

It's easy to use this project and build Node.js runtime that will target any version - just replace the version number in auto/package with your preferred one.

Current versions

• Node.js - 16.0.0
• aws-sdk - 2.889.0

Goals

• Provide always up-to-date Node.js execution environment as a Lambda runtime layer and a Lambda container image.
• Include the most recent aws-cli library.
• Make the runtime environment compatible with the default node12.x and node14.x environments

How to install?

Prebuilt packages are available for use by any account in all AWS regions. Check the releases page for more information.

The following steps require docker and docker-compose to be installed on the system.

The minimum awscli version is 1.16.67.

1. Build

Run:

./auto/package

The script will build the Lambda layer in stage/layer.zip file.

2. Deploy

Deploy the runtime layer using the following command:

aws lambda publish-layer-version \
  --layer-name node-16-runtime \
  --description "nodejs-16.0.0 aws-cli-2.889.0" \
  --compatible-runtimes provided \
  --license-info Apache-2.0 \
  --zip-file fileb://stage/layer.zip

The output will look like this:

{
    "LayerVersionArn": "arn:aws:lambda:us-east-2:356111732087:layer:node-16-runtime:1",
    "Description": "nodejs-16.0.0 aws-cli-2.889.0",
    "CreatedDate": "2018-12-02T22:32:00.572+0000",
    "LayerArn": "arn:aws:lambda:us-east-2:356111732087:layer:node-16-runtime",
    "Content": {
        "CodeSize": 18104889,
        "CodeSha256": "VonrpX23FWJOmE4lvhpox+9PS9kuY4sng0o0wxNTROs=",
        "Location": "https://awslambda-us-east-2-layers.s3.us-east-2.amazonaws.com/snapshots/356111732087/node-16-runtime-f3415c38-d865-46b6-ae42-009985092116?......"
    },
    "Version": 1,
    "CompatibleRuntimes": [
        "provided"
    ],
    "LicenseInfo": "Apache-2.0"
}

3. Share

You can share the layer with other AWS accounts by executing the following command:

aws lambda add-layer-version-permission \
  --layer-name node-16-runtime \
  --version-number 1 \
  --principal "*" \
  --statement-id publish \
  --action lambda:GetLayerVersion

Response:

{
    "RevisionId": "8b5b2e27-5013-4983-ac1a-9008dff90bac",
    "Statement": "{\"Sid\":\"publish\",\"Effect\":\"Allow\",\"Principal\":\"*\",\"Action\":\"lambda:GetLayerVersion\",\"Resource\":\"arn:aws:lambda:us-east-2:356111732087:layer:node-16-runtime:1\"}"
}

4. Deploy lambda function using this runtime

Let's assume that your lambda function is packaged as lambda.zip file and the handler is called hello.handler. The following command will deploy this function with the runtime layer that has just been deployed.

1. Create the lambda zip file

   zip lambda.zip hello.js

2. Create the function

   aws lambda create-function \
     --region us-east-2 \
     --function-name node-16-runtime-example \
     --zip-file fileb://lambda.zip \
     --handler hello.handler \
     --runtime provided \
     --layers "arn:aws:lambda:us-east-2:356111732087:layer:node-16-runtime:2" \
     --role arn:aws:iam::356111732087:role/lambda-role
     out.txt

   Response:

   {
       "Layers": [
           {
               "CodeSize": 18104889,
               "Arn": "arn:aws:lambda:us-east-2:356111732087:layer:node-16-runtime:1"
           }
       ],
       "FunctionName": "node-16-runtime-example",
       "LastModified": "2018-12-02T22:59:10.408+0000",
       "RevisionId": "32e7e8a1-b5ba-4388-b6be-596278e36126",
       "MemorySize": 128,
       "Version": "$LATEST",
       "Role": "arn:aws:iam::356111732087:role/service-role/lambda-role",
       "Timeout": 3,
       "Runtime": "provided",
       "TracingConfig": {
           "Mode": "PassThrough"
       },
       "CodeSha256": "shSeSmJZHv8Z0WmOAcFcHeSUGbRYRR1cFdbEudkSJHo=",
       "Description": "",
       "CodeSize": 340,
       "FunctionArn": "arn:aws:lambda:us-east-2:356111732087:function:node-16-runtime-example",
       "Handler": "hello.handler"
   }

3. Invoke the function

   aws lambda invoke \
     --region us-east-2 \
     --function-name node-16-runtime-example \
     --payload '{"hello":"world"}' \
     output.txt
   
   cat output.txt

Context object

The context object is compatible with the default node environments.

Context Methods

• getRemainingTimeInMillis() – Returns the number of milliseconds left before the execution times out.

Context Properties

• functionName – The name of the Lambda function.

• functionVersion – The version of the function.

• invokedFunctionArn – The Amazon Resource Name (ARN) used to invoke the function. Indicates if the invoker specified a version number or alias.

• memoryLimitInMB – The amount of memory configured on the function.

• awsRequestId – The identifier of the invocation request.

• logGroupName – The log group for the function.

• logStreamName – The log stream for the function instance.

• callbackWaitsForEmptyEventLoop – Set to false to send the response right away when the callback executes, instead of waiting for the Node.js event loop to be empty.

• identity - Information about the Amazon Cognito identity that authorized the request.

• clientContext - Client context provided to the Lambda invoker by the client application.

  The Runtime API exposes the above properties in the response headers from the /runtime/invocation/next endpoint, but the documentation doesn't exactly specify the format of the header value.

Environment variables

Based on https://docs.aws.amazon.com/lambda/latest/dg/current-supported-versions.html

Key	Reserved	Value
_HANDLER	Yes	The handler location configured on the function.
AWS_REGION	Yes	The AWS region where the Lambda function is executed.
AWS_EXECUTION_ENV	Yes	The runtime identifier, prefixed by AWS_Lambda_. For example, AWS_Lambda_java8.
AWS_LAMBDA_FUNCTION_NAME	Yes	The name of the function.
AWS_LAMBDA_FUNCTION_MEMORY_SIZE	Yes	The amount of memory available to the function in MB.
AWS_LAMBDA_FUNCTION_VERSION	Yes	The version of the function being executed.
AWS_LAMBDA_LOG_GROUP_NAME AWS_LAMBDA_LOG_STREAM_NAME	Yes	The name of the Amazon CloudWatch Logs group and stream for the function.
AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_SESSION_TOKEN	Yes	Access keys obtained from the function's execution role.
LANG	No	en_US.UTF-8. This is the locale of the runtime.
TZ	Yes	The environment's timezone (UTC). The execution environment uses NTP to synchronize the system clock.
LAMBDA_TASK_ROOT	Yes	The path to your Lambda function code.
LAMBDA_RUNTIME_DIR	Yes	The path to runtime libraries.
PATH	No	/usr/local/bin:/usr/bin/:/bin:/opt/bin
LD_LIBRARY_PATH	No	/lib64:/usr/lib64:$LAMBDA_RUNTIME_DIR:$LAMBDA_RUNTIME_DIR/lib:$LAMBDA_TASK_ROOT:$LAMBDA_TASK_ROOT/lib:/opt/lib
NODE_PATH	No	/opt/node_modules
AWS_LAMBDA_RUNTIME_API	Yes	(custom runtime) The host and port of the runtime API.

The base container image

The releases include a base Docker image that is compatible with the Lambda Container runtime and it's compatible with the Node.js Lambda runtime.

Using the base image

The example below assumes that the Dockerfile is in the root folder of the Lambda project and there's an index.js file that exports the handler function called handler.

FROM janaz/aws-lambda-node-runtime:test-1

COPY . ${LAMBDA_TASK_ROOT}
RUN npm install

CMD ["index.handler"]

The image created from that Dockerfile should be uploaded to your ECR registry and referenced in the Lambda configuration.