feat: Add aws-node-sqs-worker template

README.md

@@ -89,6 +89,7 @@ serverless install -u https://github.com/serverless/examples/tree/master/folder-
 | [Aws Node Simple Transcribe S3](https://github.com/serverless/examples/tree/master/aws-node-simple-transcribe-s3) <br/> Example demonstrates how to setup a lambda function to transcribe audio file | nodeJS |
 | [Aws Single Page App Via Cloudfront](https://github.com/serverless/examples/tree/master/aws-node-single-page-app-via-cloudfront) <br/> Demonstrating how to deploy a Single Page Application with Serverless | nodeJS |
 | [Serverless Single Page App Plugin](https://github.com/serverless/examples/tree/master/aws-node-single-page-app-via-cloudfront/serverless-single-page-app-plugin) <br/> A plugin to simplify deploying Single Page Application using S3 and CloudFront | nodeJS |
+| [Aws Node Sqs Worker](https://github.com/serverless/examples/tree/master/aws-node-sqs-worker) <br/> Serverless Framework Node SQS Producer-Consumer on AWS | nodeJS |
 | [Aws Node Stripe Integration](https://github.com/serverless/examples/tree/master/aws-node-stripe-integration) <br/> This example for Stripe integration using AWS Lambda and API Gateway. | nodeJS |
 | [Aws Node Line Echo Bot](https://github.com/serverless/examples/tree/master/aws-node-telegram-echo-bot) <br/> This is a simple echo bot on Telegram | nodeJS |
 | [Aws Text Analysis Via Sns Post Processing](https://github.com/serverless/examples/tree/master/aws-node-text-analysis-via-sns-post-processing) <br/> Example demonstrates how to setup a simple data processing pipeline | nodeJS |

aws-node-sqs-worker/.gitignore

@@ -0,0 +1,2 @@
+node_modules
+.serverless

aws-node-sqs-worker/README.md

@@ -0,0 +1,87 @@
+<!--
+title: 'Serverless Framework Node SQS Producer-Consumer on AWS'
+description: 'This template demonstrates how to develop and deploy a simple SQS-based producer-consumer service running on AWS Lambda using the traditional Serverless Framework.'
+layout: Doc
+framework: v2
+platform: AWS
+language: nodeJS
+authorLink: 'https://github.com/serverless'
+authorName: 'Serverless, inc.'
+authorAvatar: 'https://avatars1.githubusercontent.com/u/13742415?s=200&v=4'
+-->
+
+# Serverless Framework Node SQS Producer-Consumer on AWS
+
+This template demonstrates how to develop and deploy a simple SQS-based producer-consumer service running on AWS Lambda using the traditional Serverless Framework. It allows to accept messages, for which computation might be time or resource intensive, and offload their processing to an asynchronous background process for a faster and more resilient system.
+
+## Anatomy of the template
+
+This template defines two functions, `producer` and `consumer`. First of them, `producer`, is triggered by `http` event type, accepts JSON payload and sends it to a corresponding SQS queue for further processing. To learn more about `http` event configuration options, please refer to [http event docs](https://www.serverless.com/framework/docs/providers/aws/events/apigateway/). Second function, `consumer`, is responsible for processing messages from SQS queue thanks to its `sqs` trigger definition. To learn more about `sqs` event configuration options, please refer to [sqs event docs](https://www.serverless.com/framework/docs/providers/aws/events/sqs/). Additionally, the template takes care of provisioning underlying SQS queue along with corresponding SQS dead-letter queue, which are defined in `resources` section. The dead-letter queue is defined in order to prevent processing invalid messages over and over. In our case, if message is delivered to the source queue more than 5 times, it will be moved to dead-letter queue. For more details, please refer to official [AWS documentation](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html). To learn more about `resources`, please refer to [our docs](https://www.serverless.com/framework/docs/providers/aws/guide/resources/).
+
+## Usage
+
+### Deployment
+
+This example is made to work with the Serverless Framework dashboard, which includes advanced features such as CI/CD, monitoring, metrics, etc.
+
+In order to deploy with dashboard, you need to first login with:
+
+```
+serverless login
+```
+
+and then perform deployment with:
+
+```
+serverless deploy
+```
+
+After running deploy, you should see output similar to:
+
+```bash
+Serverless: Packaging service...
+Serverless: Excluding development dependencies...
+Serverless: Creating Stack...
+Serverless: Checking Stack create progress...
+........
+Serverless: Stack create finished...
+Serverless: Uploading CloudFormation file to S3...
+Serverless: Uploading artifacts...
+Serverless: Uploading service aws-node-sqs-worker.zip file to S3 (1.04 KB)...
+Serverless: Validating template...
+Serverless: Updating Stack...
+Serverless: Checking Stack update progress...
+................................................
+Serverless: Stack update finished...
+Service Information
+service: aws-node-sqs-worker
+stage: dev
+region: us-east-1
+stack: aws-node-sqs-worker-dev
+resources: 17
+api keys:
+  None
+endpoints:
+  POST - https://xxxxxxx.execute-api.us-east-1.amazonaws.com/dev/produce
+functions:
+  producer: aws-node-sqs-worker-dev-producer
+  consumer: aws-node-sqs-worker-dev-consumer
+layers:
+  None
+```
+
+_Note_: In current form, after deployment, your API is public and can be invoked by anyone. For production deployments, you might want to configure an authorizer. For details on how to do that, refer to [http event docs](https://www.serverless.com/framework/docs/providers/aws/events/apigateway/).
+
+### Invocation
+
+After successful deployment, you can now call the created API endpoint with `POST` request to invoke `producer` function:
+
+```bash
+curl --request POST 'https://xxxxxxx.execute-api.us-east-1.amazonaws.com/dev/produce' --header 'Content-Type: application/json' --data-raw '{"name": "John"}'
+```
+
+In response, you should see output similar to:
+
+```bash
+{"message": "Message accepted!"}
+```

aws-node-sqs-worker/handler.js

@@ -0,0 +1,61 @@
+const { SQS } = require("aws-sdk");
+
+const sqs = new SQS();
+
+const producer = async (event) => {
+  let statusCode = 200;
+  let message;
+
+  if (!event.body) {
+    return {
+      statusCode: 400,
+      body: JSON.stringify({
+        message: "No body was found",
+      }),
+    };
+  }
+
+  try {
+    await sqs
+      .sendMessage({
+        QueueUrl: process.env.QUEUE_URL,
+        MessageBody: event.body,
+        MessageAttributes: {
+          AttributeName: {
+            StringValue: "Attribute Value",
+            DataType: "String",
+          },
+        },
+      })
+      .promise();
+
+    message = "Message accepted!";
+  } catch (error) {
+    console.log(error);
+    message = error;
+    statusCode = 500;
+  }
+
+  return {
+    statusCode,
+    body: JSON.stringify({
+      message,
+    }),
+  };
+};
+
+const consumer = async (event) => {
+  for (const record of event.Records) {
+    const messageAttributes = record.messageAttributes;
+    console.log(
+      "Message Attributte: ",
+      messageAttributes.AttributeName.stringValue
+    );
+    console.log("Message Body: ", record.body);
+  }
+};
+
+module.exports = {
+  producer,
+  consumer,
+};

aws-node-sqs-worker/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "aws-node-sqs-worker",
+  "version": "1.0.0",
+  "description": "Serverless Framework Node SQS Producer-Consumer on AWS",
+  "author": "",
+  "license": "MIT"
+}

aws-node-sqs-worker/serverless.template.yml

@@ -0,0 +1,6 @@
+name: aws-node-sqs-worker
+org: serverlessinc
+description: Deploys a Node SQS Producer-Consumer service with traditional Serverless Framework
+keywords: aws, serverless, faas, lambda, node, sqs
+repo: https://github.com/serverless/examples/aws-node-sqs-worker
+license: MIT

aws-node-sqs-worker/serverless.yml

@@ -0,0 +1,59 @@
+service: aws-node-sqs-worker
+
+frameworkVersion: '2'
+variablesResolutionMode: '20210219'
+configValidationMode: 'error'
+
+
+provider:
+  name: aws
+  runtime: nodejs12.x
+  lambdaHashingVersion: '20201221'
+  stage: dev
+  apiGateway:
+    shouldStartNameWithService: true
+  iam:
+    role:
+      statements:
+        - Effect: Allow
+          Action:
+            - sqs:SendMessage
+          Resource:
+            - Fn::GetAtt: [ WorkerQueue, Arn ]
+
+functions:
+  producer:
+    handler: handler.producer
+    events:
+      - http:
+          method: post
+          path: produce
+    environment:
+      QUEUE_URL: !Ref WorkerQueue
+
+  consumer:
+    handler: handler.consumer
+    events:
+      - sqs:
+          batchSize: 1
+          arn:
+            Fn::GetAtt:
+              - WorkerQueue
+              - Arn
+
+resources:
+  Resources:
+    WorkerQueue:
+      Type: AWS::SQS::Queue
+      Properties:
+        QueueName: workerQueue-${self:provider.stage}
+        RedrivePolicy:
+          deadLetterTargetArn:
+            Fn::GetAtt:
+              - WorkerDLQ
+              - Arn
+          maxReceiveCount: 5
+    WorkerDLQ:
+      Type: AWS::SQS::Queue
+      Properties:
+        QueueName: workerDlq-${self:provider.stage}