@middy/sqs-partial-batch-failure

SQS partial batch failure middleware for the middy framework

Usage no npm install needed!

<script type="module">
  import middySqsPartialBatchFailure from 'https://cdn.skypack.dev/@middy/sqs-partial-batch-failure';
</script>

README

Middy sqs partial batch failure middleware

Middy logo

SQS batch middleware for the middy framework, the stylish Node.js middleware engine for AWS Lambda

Middleware for handling partially failed SQS batches.

Install

To install this middleware you can use NPM:

npm install --save @middy/sqs-partial-batch-failure

Options

  • AwsClient (object) (default AWS.SQS): AWS.SQS class constructor (e.g. that has been instrumented with AWS XRay). Must be from aws-sdk v2.
  • awsClientOptions (object) (optional): Options to pass to AWS.SQS class constructor.
  • awsClientAssumeRole (string) (optional): Internal key where role tokens are stored. See @middy/sts on to set this.
  • awsClientCapture (function) (optional): Enable XRay by passing captureAWSClient from aws-xray-sdk in.
  • disablePrefetch (boolean) (default false): On cold start requests will trigger early if they can. Setting awsClientAssumeRole disables prefetch.

NOTES:

  • Lambda is required to have IAM permission for sqs:DeleteMessage

Sample usage

import middy from '@middy/core'
import sqsBatch from '@middy/sqs-partial-batch-failure'

const baseHandler = (event, context) => {
  const recordPromises = event.Records.map(async (record, index) => { 
    /* Custom message processing logic */
    return record
  })
  return Promise.allSettled(recordPromises)
}

const handler = middy(baseHandler)
  .use(sqsBatch())

Middy documentation and examples

For more documentation and examples, refers to the main Middy monorepo on GitHub or Middy official website.

Contributing

Everyone is very welcome to contribute to this repository. Feel free to raise issues or to submit Pull Requests.

License

Licensed under MIT License. Copyright (c) 2017-2021 Luciano Mammino, will Farrell, and the Middy team.

FOSSA Status