🌜
🌞
@middy/sqs-partial-batch-failure

@middy/sqs-partial-batch-failure

v3.1.1

SQS partial batch failure middleware for the middy framework

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

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

npm version npm install size GitHub Actions CI status badge
Standard Code Style Known Vulnerabilities Language grade: JavaScript Core Infrastructure Initiative (CII) Best Practices
Chat on Gitter Ask questions on StackOverflow

You can read the documentation at: https://middy.js.org/docs/middlewares/sqs-partial-batch-failure

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

  • logger (function) (default console.error) - a logging function that is invoked with the current error as an argument. You can pass false if you don't want the logging to happen.

NOTES:

  • Include the value ReportBatchItemFailures in the Lambda FunctionResponseTypes list
  • If you're using this feature with a FIFO queue, your function should stop processing messages after the first failure and return all failed and unprocessed messages. This helps preserve the ordering of messages in your queue.

Sample usage

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

const lambdaHandler = (event, context) => {
  if (event.Event === 's3:TestEvent') {
    console.log('s3:TestEvent')
    return null
  }
  
  const recordPromises = event.Records.map(async (record, index) => { 
    /* Custom message processing logic */
  })
  return Promise.allSettled(recordPromises)
}

const handler = middy(lambdaHandler)
  .use(sqsPartialBatchFailureMiddleware())

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-2022 Luciano Mammino, will Farrell, and the Middy team.

FOSSA Status

Release Notes

3.1.1
By will Farrell • Published on August 4, 2022

What's Changed

  • Add in module to package.json files @willfarrell
  • performance improvements @willfarrell

TypeScript

Docs

New Contributors

Full Changelog: https://github.com/middyjs/middy/compare/3.1.0...3.1.1

3.1.0
By will Farrell • Published on June 21, 2022

What's Changed

New Contributors

Full Changelog: https://github.com/middyjs/middy/compare/3.0.4...3.1.0

3.0.4
By will Farrell • Published on June 4, 2022

What's Changed

New Contributors

Full Changelog: https://github.com/middyjs/middy/compare/3.0.3...3.0.4

3.0.3
By will Farrell • Published on May 17, 2022

What's Changed

New Contributors

Full Changelog: https://github.com/middyjs/middy/compare/3.0.2...3.0.3

3.0.2
By will Farrell • Published on May 13, 2022

What's Changed

New Contributors

Full Changelog: https://github.com/middyjs/middy/compare/3.0.1...3.0.2

3.0.1
By will Farrell • Published on May 13, 2022

What's Changed

  • Updated dependencies

Full Changelog: https://github.com/middyjs/middy/compare/3.0.0...3.0.1

2.5.7
By will Farrell • Published on January 25, 2022

Fix publishing transpiling error in 2.5.6. Thanks to @maximepichou and @rreubenreyes for reporting.

General

License
MIT
Typescript Types
Built-in
Tree-shakeable
Yes

Popularity

GitHub Stargazers
3,038
Community Interest
2,905
Number of Forks
293

Maintenance

Commits
11/2110/220250
Last Commit
Open Issues
5
Closed Issues
410
Open Pull Requests
1
Closed Pull Requests
149

Versions

Versions Released
11/2110/22010
Latest Version Released
Aug 4, 2022
Current Tags
latest3.1.1
next3.1.0-rc.1

Dependencies

Contributors

willfarrell
willfarrell
Commits: 384
lmammino
lmammino
Commits: 113
vladgolubev
vladgolubev
Commits: 12
greenkeeper[bot]
greenkeeper[bot]
Commits: 12
thejuan
thejuan
Commits: 12
dkatavic
dkatavic
Commits: 11
gsingh1
gsingh1
Commits: 10
joseSantacruz
joseSantacruz
Commits: 9
leog
leog
Commits: 6
theburningmonk
theburningmonk
Commits: 6
ossareh
ossareh
Commits: 5
munierujp
munierujp
Commits: 4
JimiPedros
JimiPedros
Commits: 4
sdomagala
sdomagala
Commits: 4
chris-heathwood-uoy
chris-heathwood-uoy
Commits: 3