Giter Club home page Giter Club logo

backoff-decorator's Introduction

backoff-decorator

License: MIT

This library is no longer maintained by Unito, please consider forking it if you intend to use it.

This modules allows retrying an asynchronous call, backing off exponentially. Optionally, full jitter can be added to the backoff time, as explained in this AWS article. The functionality is accessible directly through a function call, or using ES2016 decorators.

Installation

npm install --save backoff-decorator

Basic usage

const Backoff = require("../src/backoff");
const request = require("request-promise");

// an error class used to determine when to retry
class NotNowError extends Error {}

// this function simulates an async call that fails
// 9 times than succeeds on the 10th call.
let trials = 0;
function get(url) {
  trials++;
  console.log(new Date());
  if (trials % 10 === 0) {
    console.log('fetching', url);
    return request.get(url);
  }
  else {
    return Promise.reject(new NotNowError());
  }
}

// this are the options to the backoff call
const backoffOptions = {
  maxRetries: 10,     // do not retry more than this amount of times
  maxDelayMs: 1000,   // cap the exponential backoff to this value
  backoffFactor: 100, // the backoff factor
  predicate: (err) => err instanceof NotNowError, // determines when to retry
  fullJitter: false,  // do not add random jitter
};


// call the 'get' function with retries.
// the arguments following the function itself are the same as bind()
Backoff.retry(backoffOptions, get, this, 'http://unito.io');

Using a decorator

This example uses TypeScript to allow the use of decorators.

import { backoff } from '../src/backoff';
import * as request from 'request-promise';

class NotNowError extends Error {}

class UnsureCaller {
  private trials = 0;

  async get(url: string): Promise<any> {
    this.trials++;
    console.log(new Date());
    if (this.trials % 10 === 0) {
      console.log('fetching', url);
      return request.get(url);
    } else {
      throw new NotNowError();
    }
  }
}

class Fetcher {
  backoffOptions = {
    maxRetries: 10,
    maxDelayMs: 1000,
    backoffFactor: 100,
    predicate: (err: Error) => err instanceof NotNowError,
    fullJitter: false,
  };

  private caller = new UnsureCaller();

  @backoff
  async fetchUrl(url: string): Promise<any> {
    return this.caller.get(url);
  }
}

const fetcher = new Fetcher();
fetcher.fetchUrl('http://unito.io');

License

MIT

backoff-decorator's People

Contributors

dependabot[bot] avatar erykwarren avatar heretogo avatar louib avatar ronjouch avatar unitobot avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

backoff-decorator's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.