https://github.com/kcalixto/poc-serverless-alerts

https://github.com/kcalixto/poc-serverless-alerts

Last synced: about 4 hours ago
JSON representation

• Host: GitHub
• URL: https://github.com/kcalixto/poc-serverless-alerts
• Owner: kcalixto
• Created: 2023-04-12T20:02:36.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-10-23T14:08:13.000Z (about 1 year ago)
• Last Synced: 2023-10-23T15:27:21.406Z (about 1 year ago)
• Language: JavaScript
• Size: 96.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


# 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 Serverless Framework and the [Lift](https://github.com/getlift/lift) plugin. 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 one function `producer` and one Lift construct - `jobs`. The producer function is triggered by `http` event type, accepts JSON payloads and sends it to a SQS queue for asynchronous processing. The SQS queue is created by the `jobs` queue construct of the Lift plugin. The queue is set up with a "dead-letter queue" (to receive failed messages) and a `worker` Lambda function that processes the SQS messages.

To learn more:

- about `http` event configuration options, refer to [http event docs](https://www.serverless.com/framework/docs/providers/aws/events/apigateway/)

- about the `queue` construct, refer to [the `queue` documentation in Lift](https://github.com/getlift/lift/blob/master/docs/queue.md)

- about the Lift plugin in general, refer to [the Lift project](https://github.com/getlift/lift)

- about SQS processing with AWS Lambda, please refer to the official [AWS documentation](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html)

### Deployment

Install dependencies with:

```

npm install

```

Then deploy:

```

serverless deploy

```

After running deploy, you should see output similar to:

```bash

Deploying aws-node-sqs-worker-project to stage dev (us-east-1)

✔ Service deployed to stack aws-node-sqs-worker-project-dev (175s)

endpoint: POST - https://xxxxxxxxxx.execute-api.us-east-1.amazonaws.com/produce

functions:

  producer: aws-node-sqs-worker-project-dev-producer (167 kB)

  jobsWorker: aws-node-sqs-worker-project-dev-jobsWorker (167 kB)

jobs: https://sqs.us-east-1.amazonaws.com/000000000000/aws-node-sqs-worker-project-dev-jobs

```

_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://xxxxxx.execute-api.us-east-1.amazonaws.com/produce' --header 'Content-Type: application/json' --data-raw '{"name": "John"}'

```

In response, you should see output similar to:

```bash

{"message": "Message accepted!"}

```

# poc-serverless-alerts