gdibble / backbone-ajaxretry Goto Github PK

View Code? Open in Web Editor NEW

5.0 2.0 2.0 268 KB

Exponentially retry Backbone.ajax & $.ajax requests

License: MIT License

JavaScript 100.00%

backbone-ajaxretry's Introduction

Backbone.js ajaxRetry

Exponentially retry Backbone.ajax and $.ajax requests

Installation

npm install --save backbone-ajaxretry

In your client app main.js, add the following line to default retry settings:

require('backbone-ajaxretry');

Or override any of the default settings using set: passing keyword arguments

require('backbone-ajaxretry').set({ y:0.3 });

Usage

The default settings are:

{
  base: 2.718281828,
  y: 0.25,
  retryCount: 3,
  onlyBackbone: false
}

By default both Backbone.ajax and $.ajax Server Errors are retried. To only retry Backbone.ajax requests and not also [regular] $.ajax requests, change the onlyBackbone default setting to true.

For Backbone.js sync, fetch, save or destroy, pass exhaust in the options object as a callback function to run when retries fail

please note that exhaust supersedes the error callback
if exhaust method is not passed, retries will end without further action
the returned jqXHR object has been extended with the ajax request options,
thus allowing jqXHR.type, jqXHR.url, etcetera

// Backbone ex.
myModel.fetch({
  exhaust : function (jqXHR, textStatus, errorThrown) {
    // Handle Internal Server Error
  }
});

// $.ajax ex.
$.ajax({
  url: '/test',
  type: 'GET',
  exhaust : function (jqXHR, textStatus, errorThrown) {
    // Handle Internal Server Error
  }
});

Changelog >>> releases

Dependency: Underscore.js
- Implied:
  - Backbone.js
    - jQuery, zepto.js, ENDER or even your own $ library which defines $.ajax

npmjs.org/package/backbone-ajaxretry

backbone-ajaxretry's People

Contributors

Stargazers

Watchers

Forkers

bitmatica sawyerlin

backbone-ajaxretry's Issues

only retry status codes < 500

usage request due to 400-class codes being retried when 403 forbidden returned, etc:

do not retry 400-class client errors
only retry 500-class internal server errors

ref: http://en.wikipedia.org/wiki/List_of_HTTP_status_codes

linear retry option

just in case someone wants a linear perpetuation

Uncaught TypeError: Cannot read property 'ajax' of undefined

Users have reported JS error.

Temporary fix (until this is resolved) includes adding the following first-line to the Backbone.ajax extend-function before the return:

  Backbone.$ = $; // <<< add as temp-fix
  return Backbone.$.ajax.apply(Backbone.$, args);

Test ticket from Code Climate

bug in extender fn

apologies w/ v1.2.0. when using $.get or $.post shortcuts, first argument is a string and thus internal extender function had a bug.

POST response 200 w/o body still retries

a POST with a response-body, PUT, GET, DELETE all work as expected,
but a POST with res.status 200 and no response-body keeps retrying the successful req.

considering checking jqXHR.status < 300 >>> _exhausted()

send ajax request params with jqXHR object

allow jqXHR.type, jqXHR.url, etcetera

remove underscore dependency

use vanilla js fns

convert to UMD pattern

ref: http://know.cujojs.com/tutorials/modules/authoring-umd-modules
ex: https://github.com/umdjs/umd/blob/master/returnExports.js#L17-L37

ability to overload settings per instantiation

For example, in my app I want to use the default of { retryCount:3 } in most cases,
but this particular fetch I would like to try more or less, i.e.

myModel1.fetch({
  retryCount: 99
});
// ||
myModel2.fetch({
  retryCount: 0
});

Any setting, default or via .set, should allow overloading (thus superseding settings) from the current instantiation.

function onExhaust(jqXHR, textStatus, errorThrown) {
  console.log(jqXHR, textStatus, errorThrown);
  if (jqXHR.status > 500) {
    //do something about Server Error
  } else if (jqXHR.status > 400) {
    //do something about Client Error
  }
}

myModel.fetch({ exhaust:onExhaust });