httplease-retry

httplease-retry

Request retries with optional fallback to alternate servers as an httplease filter.

Usage guide

Install the library:

npm install --save httplease-retry

For more examples have a look at the test/integration directory.

Simple request

const httplease = require('httplease');
const httpleaseRetry = require('httplease-retry');


const retryConfig = {
    shouldRetryFn: (err, attempts, url) => true,
    maxAttempts: 2,
    retryDelayMillis: 50,
    baseUrlList: [
        'http://example.com/basePath',
        'http://example.com/secondaryPath
   ]
};

// this can be saved and reused as many times as you want
const httpClient = httplease.builder()
    .withFilter(httpleaseRetry.createRetryFilter(retryConfig));


// make a request
httpClient
    .withPath('/some-resource')
    .withMethodGet()
    .send();

Development guide

Install dependencies

npm install

Useful commands

# Run all checks
npm test

# Run just the jasmine tests
npm run test:jasmine

# Run just the linter
npm run test:lint

Perform a release

npm version 99.98.97
npm publish
git push
git push --tags

Contributors

Pull requests, issues and comments welcome. For pull requests:

• Add tests for new features and bug fixes
• Follow the existing style
• Separate unrelated changes into multiple pull requests

See the existing issues for things to start contributing.

For bigger changes, make sure you start a discussion first by creating an issue and explaining the intended change.

Atlassian requires contributors to sign a Contributor License Agreement, known as a CLA. This serves as a record stating that the contributor is entitled to contribute the code/documentation/translation to the project and is willing to have it used in distributions and derivative works (or is willing to transfer ownership).

• CLA for corporate contributors
• CLA for individuals

License

Copyright (c) 2017 Atlassian and others. Apache 2.0 licensed, see LICENSE file.