DEV Community: usufjameel

How to Deploy Existing NodeJS Express application as an AWS Lambda Function using Serverless Framework

usufjameel — Wed, 09 Nov 2022 06:52:19 +0000

There are seven easy steps to deploy your existing NodeJS ExpressJS application as an AWS Lambda Function using Serverless Framework.

Step 1

Installing Dependencies

$ npm init -y
$ npm install --save serverless-http

Step 2

Do not start the server instead export it

const serverless = require("serverless-http");
...
...
...
// app.listen(port, () => {
//     console.log(`listening On PORT -> ${port} `);
// });

// Export your Express configuration wrapped into serverless function
module.exports.handler = serverless(app);

Step 3

install and Configure the Serverless Framework

$ npm install -g serverless

Prefix the command with sudo if you’re running this command on Linux.

$ sls config credentials --provider aws --key <aws_access_key_id> --secret <aws_secret_access_key>

Step 4

Add serverless.yml file in your project. Follow the link for more details.

service: example-project

provider:
  name: aws
  runtime: nodejs12.x
  stage: dev
  region: us-east-1

  # you can add statements to the Lambda function's IAM Role here
  iamRoleStatements:
    - Effect: "Allow"
      Action:
        - "s3:PutObject"
      Resource:
        - "arn:aws:s3:::${file(config.json):S3_BUCKET_NAME}/*"

functions:
  app:
    handler: index.handler
    events:
      - http: ANY /
      - http: "ANY /{proxy+}"

Step 4

Deploy the project
$ sls deploy

Step 5

We have to follow this step for production environment.
Add the NODE_ENV in the secrets.json.

{
  "NODE_ENV": "production"
}

Step 6

Add a reference for the secrets.json in the serverless.yml

service: example-project

custom: # add these two lines
  secrets: ${file(secrets.json)} # reference the secrets.json file

provider:
  name: aws
  runtime: nodejs12.x
  stage: dev
  region: us-east-1

  # you can add statements to the Lambda function's IAM Role here
  iamRoleStatements:
    - Effect: "Allow"
      Action:
        - "s3:PutObject"
      Resource:
        - "arn:aws:s3:::${file(config.json):S3_BUCKET_NAME}/*"

functions:
  app:
    handler: index.handler
    events:
      - http: ANY /
      - http: "ANY /{proxy+}"

Step 7

That’s it! Delete the node_modules and .serverless folders from the service and run npm install again, but this time with the --production flag.

$ npm install --production

How to Deploy Existing NodeJS Express application as an AWS Lambda Function using ClaudiaJS

usufjameel — Mon, 10 Jan 2022 06:45:07 +0000

There are five easy steps to deploy your existing NodeJS ExpressJS application as an AWS Lambda Function using ClaudiaJS.

Step 1

Do not start the server instead export it

// app.listen(port, () => {
//     console.log(`listening On PORT -> ${port} `);
// });

// Export your Express configuration so that it can be consumed by the Lambda handler
module.exports = app

Step 2

Create lambda.js file for creating a lambda handler

Step 3

Use aws-serverless-express for creating a lambda handler

// lambda.js
'use strict'
const awsServerlessExpress = require('aws-serverless-express')
const app = require('./app')
const server = awsServerlessExpress.createServer(app)

exports.handler = (event, context) => awsServerlessExpress.proxy(server, event, context)

Step 4

Install aws-cli. Follow the link for details description for installation.

MacOS(Commandline installer)
1) Download the file using the curl command. The -o option specifies the file name that the downloaded package is written to. In this example, the file is written to AWSCLIV2.pkg in the current folder.

$ curl "https://awscli.amazonaws.com/AWSCLIV2.pkg" -o "AWSCLIV2.pkg"

2) Run the standard macOS installer program, specifying the downloaded .pkg file as the source. Use the -pkg parameter to specify the name of the package to install, and the -target / parameter for which drive to install the package to. The files are installed to /usr/local/aws-cli, and a symlink is automatically created in /usr/local/bin. You must include sudo on the command to grant write permissions to those folders.

$ sudo installer -pkg ./AWSCLIV2.pkg -target /

After installation is complete, debug logs are written to /var/log/install.log.

3) To verify that the shell can find and run the aws command in your $PATH, use the following commands.

$ which aws
/usr/local/bin/aws 
$ aws --version
aws-cli/2.4.5 Python/3.8.8 Darwin/18.7.0 botocore/2.4.5

If the aws command cannot be found, you may need to restart your terminal or follow the instructions in Adding the AWS CLI to your path.

4) Configure aws-cli
The following example shows sample values. Replace them with your own values as described in the following sections.

$ aws configure
AWS Access Key ID [None]: AKIAIOSFODNN7EXAMPLE
AWS Secret Access Key [None]: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
Default region name [None]: us-west-2
Default output format [None]: json

Step 5

Deploy your application using ClaudiaJS.

1) Install claudiajs

   npm install claudia -g

2) Claudia was installed correctly by running the following command:

   claudia --version

3) The following command will create the lambda function and api gateway application for you to access.

   claudia create --deploy-proxy-api --region <region_name 
eg. us-east-1> --handler lambda.handler --name <name_of_the_function>

--deploy-proxy-api : If specified, a proxy API will be created for the Lambda function on API Gateway, and forward all requests to function.This is an alternative way to create web APIs to --api-module.
--region : AWS region where to create the lambda. For supported values, see https://docs.aws.amazon.com/general/latest/gr/rande.html#lambda_region for example: us-east-1
--handler : Main function for Lambda to execute, as module.function for example: if it is in the main.js file and exported as router, this would be main.router
--name : Lambda function name for example: awesome-microservice defaults to: the project name from package.json

Command for updating the lambda function

claudia update