npmpackage.info

Gathering detailed insights and metrics for @adobe/node-fetch-retry

Other packages similar to @adobe/node-fetch-retry

@types/adobe__node-fetch-retry

2.1.5

Stub TypeScript definitions entry for @adobe/node-fetch-retry, which provides its own types definitions

@adobe/node-fetch-retry

Node Module for performing retries using node-fetch

2.2.0

Apache-2.0

JavaScript

1.55 kB

1,614,201 4

Installations

npm install @adobe/node-fetch-retry

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

12.19.1

NPM Version

7.24.1 Score

Supply Chain

98.3

Quality

83.1

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

13

Total

89

Closed

25

Merged

51

Issues

Open

14

Total

22

Closed

8

Releases

v2.2.0

Updated on Mar 08, 2022

v2.1.3

Updated on Feb 12, 2022

v2.1.2

Updated on Feb 07, 2022

v2.1.1

Updated on Jan 31, 2022

v2.1.0

Updated on Jan 24, 2022

v2.0.0

Updated on Oct 26, 2021

View All 11 releases

Contributors

241

Unable to fetch Contributors

View All 241 Contributors

Languages

JavaScript

JavaScript (100%)

validate.email 🚀

Verify real, reachable, and deliverable emails with instant MX records, SMTP checks, and disposable email detection.

Developer

adobe

Download Statistics

Total Downloads

1,614,201

Last Day

3,014

Last Week

15,260

Last Month

58,873

Last Year

634,509

GitHub Statistics

Apache-2.0 License

45 Stars

89 Commits

21 Forks

24 Watchers

14 Branches

241 Contributors

Updated on Dec 12, 2024

Bundle Size

4.20 kB

Minified

1.55 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

2.2.0

Package Id

@adobe/node-fetch-retry@2.2.0

Unpacked Size

35.98 kB

Size

11.21 kB

File Count

NPM Version

7.24.1

Node Version

12.19.1

Total Downloads

Cumulative downloads

Total Downloads

1,614,201

Last Day

21.4%

3,014

Compared to previous day

Last Week

5.5%

15,260

Compared to previous week

Last Month

29.1%

58,873

Compared to previous month

Last Year

38.6%

634,509

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

abort-controller node-fetch

Dev Dependencies

@adobe/eslint-config-asset-compute @semantic-release/git codecov conventional-changelog-eslint eslint get-port license-checker mocha nock nyc rewire semantic-release

node-fetch-retry

Node Module for performing retries for HTTP requests.

It is a wrapper around node-fetch library. It has default retry logic built in as described below, as well as configurable parameters. It also has built-in support for Apache OpenWhisk actions, adjusting the timeout to reflect the action timeout.

Installation

1npm install @adobe/node-fetch-retry

Usage

This library works the same as the normal fetch api, but with some added features.

Default Behavior

Without configuring any parameters, the retry behavior will be as follows:

retry for 60s
retry inital delay of 100ms with exponential backoff, configurable as a multiplier defaulting to 2
retry only on 5xx response
retry on all FetchError system errors
- see node-fetch error handling: https://github.com/node-fetch/node-fetch/blob/main/docs/ERROR-HANDLING.md
socket timeout of 30s

1const fetch = require('@adobe/node-fetch-retry');
2
3async main() {
4    const response = await fetch(url);
5}

This example uses only custom headers and will use default retry settings:

1const fetch = require('@adobe/node-fetch-retry');
2
3async main() {
4    const response = await fetch(url, {
5        headers: {
6            'custom-header': '<<put custom header value here>>'
7        }
8    });
9}

Optional Custom Parameters

All the retry options are configurable and can be set in retryOptions in the options object passed to fetch.

Parameter	Format	Description	Environment variable	Default Value
`retryMaxDuration`	Number	time in milliseconds to retry until throwing an error	`NODE_FETCH_RETRY_MAX_RETRY`	60000 ms
`retryInitialDelay`	Number	time in milliseconds to wait between retries	`NODE_FETCH_RETRY_INITIAL_WAIT`	100 ms
`retryBackoff`	Number	backoff factor for wait time between retries	`NODE_FETCH_RETRY_BACKOFF`	2.0
`retryOnHttpResponse`	Function	a function determining whether to retry given the HTTP response. Can be asynchronous	none	retry on all 5xx errors
`retryOnHttpError`	Function	a function determining whether to retry given the HTTP error exception thrown. Can be asynchronous	none	retry on all `FetchError`'s of type `system`
`socketTimeout`	Number	time until socket timeout in milliseconds. Note: if `socketTimeout` is >= `retryMaxDuration`, it will automatically adjust the socket timeout to be exactly half of the `retryMaxDuration`. To disable this feature, see `forceSocketTimeout` below	`NODE_FETCH_RETRY_SOCKET_TIMEOUT`	30000 ms
`forceSocketTimeout`	Boolean	If true, socket timeout will be forced to use `socketTimeout` property declared regardless of the `retryMaxDuration`. Note: this feature was designed to help with unit testing and is not intended to be used in practice	`NODE_FETCH_RETRY_FORCE_TIMEOUT`	false

Note: the environment variables override the default values if the corresponding parameter is not set. These are designed to help with unit testing. Passed in parameters will still override the environment variables

Custom Parameter Examples

This example decreases the retryMaxDuration and makes the retry delay a static 500ms. This will do no more than 4 retries.

1const fetch = require('@adobe/node-fetch-retry');
2
3async main() {
4    const response = await fetch(url, {
5        retryOptions: {
6            retryMaxDuration: 2000,  // 30s retry max duration
7            retryInitialDelay: 500,
8            retryBackoff: 1.0 // no backoff
9        }
10    });
11}

This example shows how to configure retries on specific HTTP responses:

1const fetch = require('@adobe/node-fetch-retry');
2
3async main() {
4    const response = await fetch(url, {
5        retryOptions: {
6            retryOnHttpResponse: function (response) {
7                if ( (response.status >= 500) || response.status >= 400) { // retry on all 5xx and all 4xx errors
8                    return true;
9                }
10            }
11        }
12    });
13}

This example uses custom socketTimeout values:

1const fetch = require('@adobe/node-fetch-retry');
2
3async main() {
4    const response = await fetch(url, {
5        retryOptions: {
6            retryMaxDuration: 300000, // 5min retry duration
7            socketTimeout: 60000, //  60s socket timeout
8        }
9    });
10}

This example uses custom socketTimeout values and custom headers:

1const fetch = require('@adobe/node-fetch-retry');
2
3async main() {
4    const response = await fetch(url, {
5        retryOptions: {
6            retryMaxDuration: 300000, // 5min retry duration
7            socketTimeout: 60000, //  60s socket timeout
8        },
9        headers: {
10            'custom-header': '<<put custom header value here>>'
11        }
12    });
13}

This example shows how to retry on all HTTP errors thrown as an exception:

1const fetch = require('@adobe/node-fetch-retry');
2
3async main() {
4    const response = await fetch(url, {
5        retryOptions: {
6            retryOnHttpError: function (error) {
7                return true;
8            }
9        }
10    });
11}

Disable Retry

You can disable all retry behavior by setting retryOptions to false.

1const fetch = require('@adobe/node-fetch-retry');
2
3async main() {
4    const response = await fetch(url, {
5        retryOptions: false
6    });
7}

Disabling retry behavior will not prevent the usage of other options set on the options object.

Additional notes on retry duration

If the fetch is unsuccessful, the retry logic determines how long it will wait before the next attempt. If the time remaining will exceed the total time allowed by retryMaxDuration then another attempt will not be made. There are examples of how this works in the testing code.

Apache OpenWhisk Action Support

If you are running this in the context of an OpenWhisk action, it will take into account the action timeout deadline when setting the retryMaxDuration. It uses the __OW_ACTION_DEADLINE environment variable to determine if there is an action running.

Behavior: If retryMaxDuration is greater than the time till the action will timeout, it will adjust the retryMaxDuration to be equal to the time till action timeout.

Contributing

Contributions are welcomed! Read the Contributing Guide for more information.

Licensing

This project is licensed under the Apache V2 License. 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

Dangerous-Workflow

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

10

License

Determines if the project has defined a license.

10

Security-Policy

Determines if the project has published a security policy.

5

Code-Review

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

1

Pinned-Dependencies

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

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

Maintained

Determines if the project is "actively maintained".

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

4

/10

Last Scanned on 2025-02-24

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