npmpackage.info

Gathering detailed insights and metrics for @vercel/sqs-consumer

@vercel/sqs-consumer

Build Amazon Simple Queue Service (SQS) based applications without the boilerplate

5.6.0

1,758

NOASSERTION

TypeScript

6,026,920 5.6

Installations

npm install @vercel/sqs-consumer

Pull Requests

Open

0

Total

233

Closed

72

Merged

161

Issues

Open

1

Total

231

Closed

230

Releases

v11.2.0

Published on 19 Oct 2024

v11.2.0-canary.1

Published on 14 Oct 2024

v11.1.0

Published on 01 Oct 2024

v11.1.0-canary.2

Published on 01 Oct 2024

v11.1.0-canary.1

Published on 01 Oct 2024

v11.0.2

Published on 16 Aug 2024

View all 91 releases

Developer

BBC

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

Yes

Node Version

16.19.1

NPM Version

8.19.3 Statistics

1,758 Stars

513 Commits

334 Forks

63 Watching

13 Branches

135 Contributors

Updated on 26 Nov 2024

Languages

TypeScript (90.67%)

JavaScript (7.41%)

Shell (0.98%)

Gherkin (0.94%)

Total Downloads

Cumulative downloads

Total Downloads

6,026,920

Last day

-66.5%

27,305

Compared to previous day

Last week

0.7%

351,660

Compared to previous week

Last month

0.4%

1,380,213

Compared to previous month

Last year

446.8%

4,305,338

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

sqs-consumer

Build SQS-based applications without the boilerplate. Just define an async function that handles the SQS message processing.

Installation

To install this package, simply enter the following command into your terminal (or the variant of whatever package manager you are using):

1npm install sqs-consumer

If you would like to use JSR instead, you can find the package here.

Node version

We will only support Node versions that are actively or security supported by the Node team. If you are still using an Node 14, please use a version of this library before the v7 release, if you are using Node 16, please use a version before the v7.3.0 release.

Documentation

Visit https://bbc.github.io/sqs-consumer/ for the full API documentation.

Usage

1import { Consumer } from "sqs-consumer";
2
3const app = Consumer.create({
4  queueUrl: "https://sqs.eu-west-1.amazonaws.com/account-id/queue-name",
5  handleMessage: async (message) => {
6    // do some work with `message`
7  },
8});
9
10app.on("error", (err) => {
11  console.error(err.message);
12});
13
14app.on("processing_error", (err) => {
15  console.error(err.message);
16});
17
18app.start();

The queue is polled continuously for messages using long polling.
Throwing an error (or returning a rejected promise) from the handler function will cause the message to be left on the queue. An SQS redrive policy can be used to move messages that cannot be processed to a dead letter queue.
By default messages are processed one at a time – a new message won't be received until the first one has been processed. To process messages in parallel, use the batchSize option detailed here.
- It's also important to await any processing that you are doing to ensure that messages are processed one at a time.
By default, messages that are sent to the handleMessage and handleMessageBatch functions will be considered as processed if they return without an error.
- To acknowledge individual messages, please return the message that you want to acknowledge if you are using handleMessage or the messages for handleMessageBatch.
  - To note, returning an empty object or an empty array will be considered an acknowledgement of no message(s) and will result in no messages being deleted. If you would like to change this behaviour, please use the alwaysAcknowledge option detailed here.
  - By default, if an object or an array is not returned, all messages will be acknowledged.
Messages are deleted from the queue once the handler function has completed successfully (the above items should also be taken into account).

Credentials

By default the consumer will look for AWS credentials in the places specified by the AWS SDK. The simplest option is to export your credentials as environment variables:

1export AWS_SECRET_ACCESS_KEY=...
2export AWS_ACCESS_KEY_ID=...

If you need to specify your credentials manually, you can use a pre-configured instance of the SQS Client client.

1import { Consumer } from "sqs-consumer";
2import { SQSClient } from "@aws-sdk/client-sqs";
3
4const app = Consumer.create({
5  queueUrl: "https://sqs.eu-west-1.amazonaws.com/account-id/queue-name",
6  handleMessage: async (message) => {
7    // ...
8  },
9  sqs: new SQSClient({
10    region: "my-region",
11    credentials: {
12      accessKeyId: "yourAccessKey",
13      secretAccessKey: "yourSecret",
14    },
15  }),
16});
17
18app.on("error", (err) => {
19  console.error(err.message);
20});
21
22app.on("processing_error", (err) => {
23  console.error(err.message);
24});
25
26app.on("timeout_error", (err) => {
27  console.error(err.message);
28});
29
30app.start();

AWS IAM Permissions

Consumer will receive and delete messages from the SQS queue. Ensure sqs:ReceiveMessage, sqs:DeleteMessage, sqs:DeleteMessageBatch, sqs:ChangeMessageVisibility and sqs:ChangeMessageVisibilityBatch access is granted on the queue being consumed.

API

`Consumer.create(options)`

Creates a new SQS consumer using the defined options.

`consumer.start()`

Start polling the queue for messages.

`consumer.stop(options)`

Stop polling the queue for messages. You can find the options definition here.

By default, the value of abort is set to false which means pre existing requests to AWS SQS will still be made until they have concluded. If you would like to abort these requests instead, pass the abort value as true, like so:

consumer.stop({ abort: true })

`consumer.status`

Returns the current status of the consumer.

isRunning - true if the consumer has been started and not stopped, false if was not started or if it was stopped.
isPolling - true if the consumer is actively polling, false if it is not.

Note: This method is not available in versions before v9.0.0 and replaced the method isRunning to supply both running and polling states.

`consumer.updateOption(option, value)`

Updates the provided option with the provided value.

Please note that any update of the option pollingWaitTimeMs will take effect only on next polling cycle.

You can find out more about this here.

Events

Each consumer is an EventEmitter and emits these events.

Contributing

We welcome and appreciate contributions for anyone who would like to take the time to fix a bug or implement a new feature.

But before you get started, please read the contributing guidelines and code of conduct.

License

SQS Consumer is distributed under the Apache License, Version 2.0, see LICENSE for more information.

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Security-Policy

Determines if the project has published a security policy.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Packaging

Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.

10

SAST

Determines if the project uses static code analysis.

9

License

Determines if the project has defined a license.

7

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

4

Maintained

Determines if the project is "actively maintained".

4

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

3

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 3

Details

Warn: third-party GitHubAction not pinned by hash: .github/workflows/annotate-test-reports.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/bbc/sqs-consumer/annotate-test-reports.yml/canary?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/cla.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/bbc/sqs-consumer/cla.yml/canary?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:43: update your workflow using https://app.stepsecurity.io/secureworkflow/bbc/sqs-consumer/codeql.yml/canary?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:47: update your workflow using https://app.stepsecurity.io/secureworkflow/bbc/sqs-consumer/codeql.yml/canary?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:61: update your workflow using https://app.stepsecurity.io/secureworkflow/bbc/sqs-consumer/codeql.yml/canary?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:74: update your workflow using https://app.stepsecurity.io/secureworkflow/bbc/sqs-consumer/codeql.yml/canary?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/coverage.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/bbc/sqs-consumer/coverage.yml/canary?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/coverage.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/bbc/sqs-consumer/coverage.yml/canary?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/coverage.yml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/bbc/sqs-consumer/coverage.yml/canary?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/dependency-review.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/bbc/sqs-consumer/dependency-review.yml/canary?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/dependency-review.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/bbc/sqs-consumer/dependency-review.yml/canary?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docs.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/bbc/sqs-consumer/docs.yml/canary?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docs.yml:35: update your workflow using https://app.stepsecurity.io/secureworkflow/bbc/sqs-consumer/docs.yml/canary?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docs.yml:50: update your workflow using https://app.stepsecurity.io/secureworkflow/bbc/sqs-consumer/docs.yml/canary?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docs.yml:53: update your workflow using https://app.stepsecurity.io/secureworkflow/bbc/sqs-consumer/docs.yml/canary?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docs.yml:59: update your workflow using https://app.stepsecurity.io/secureworkflow/bbc/sqs-consumer/docs.yml/canary?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/issues-to-projects.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/bbc/sqs-consumer/issues-to-projects.yml/canary?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/lock-threads.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/bbc/sqs-consumer/lock-threads.yml/canary?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pr-coverage.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/bbc/sqs-consumer/pr-coverage.yml/canary?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pr-coverage.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/bbc/sqs-consumer/pr-coverage.yml/canary?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/pr-coverage.yml:35: update your workflow using https://app.stepsecurity.io/secureworkflow/bbc/sqs-consumer/pr-coverage.yml/canary?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/pr-coverage.yml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/bbc/sqs-consumer/pr-coverage.yml/canary?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/bbc/sqs-consumer/publish.yml/canary?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/bbc/sqs-consumer/publish.yml/canary?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/stale.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/bbc/sqs-consumer/stale.yml/canary?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/bbc/sqs-consumer/test.yml/canary?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/bbc/sqs-consumer/test.yml/canary?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:43: update your workflow using https://app.stepsecurity.io/secureworkflow/bbc/sqs-consumer/test.yml/canary?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:52: update your workflow using https://app.stepsecurity.io/secureworkflow/bbc/sqs-consumer/test.yml/canary?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:55: update your workflow using https://app.stepsecurity.io/secureworkflow/bbc/sqs-consumer/test.yml/canary?enable=pin
Info: 0 out of 23 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 7 third-party GitHubAction dependencies pinned
Info: 5 out of 5 npmCommand dependencies pinned

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

Score

5.6

/10

Last Scanned on 2024-11-25

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

@vercel/sqs-consumer

Installations

Pull Requests

0

233

72

161

Issues

1

231

230

Releases

Developer

Developer Guide

CommonJS

Yes

16.19.1

8.19.3

Statistics

Languages

Total Downloads

6,026,920

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

sqs-consumer

Installation

Node version

Documentation

Usage

Credentials

AWS IAM Permissions

API

Consumer.create(options)

consumer.start()

consumer.stop(options)

consumer.status

consumer.updateOption(option, value)

Events

Contributing

License

10

10

10

10

10

9

7

4

4

3

0

0

0

0

5.6

/10

`Consumer.create(options)`

`consumer.start()`

`consumer.stop(options)`

`consumer.status`

`consumer.updateOption(option, value)`