requestretry - npm Package Compare versions

Comparing version 0.0.1 to 1.0.0

index.js

 'use strict';
 
 /*
- * retriablerequest
+ * Request
  *
@@ -10,4 +10,5 @@ * Copyright(c) 2014 Francois-Guillaume Ribreau <[e-mail]>
  */
-var request          = require('request');
-var _                = require('fg-lodash');
+var request    = require('request');
+var _          = require('fg-lodash');
+var Cancelable = require('cancelable');
 
@@ -21,24 +22,48 @@ var RETRIABLE_ERRORS = ['ECONNRESET', 'ENOTFOUND', 'ESOCKETTIMEDOUT', 'ETIMEDOUT', 'ECONNREFUSED'];
 
-function isRetriableRequest(err, response){
-  // Inspired from https://github.com/geoffreak/request-enhanced/blob/master/src/request-enhanced.coffee#L107
-  return (err && _.contains(RETRIABLE_ERRORS, err.code)) || (response && 500 <= response.statusCode && response.statusCode < 600);
+function Request(options, f, maxAttempts, retryDelay){
+  this.maxAttempts = maxAttempts;
+  this.retryDelay  = retryDelay;
+  this.options     = options;
+  this.f           = _.once(f);
+  this._timeout    = null;
+  this._req        = null;
 }
 
-function tryUntilFail(options, f, retryOptions){
-  retryOptions.maxAttempts--;
+Request.request = request;
 
-  request(options, function(err, response, body){
-    if(isRetriableRequest(err, response) && retryOptions.maxAttempts >= 0){
-      return setTimeout(tryUntilFail.bind(null, options, f, retryOptions), retryOptions.retryDelay);
+Request.prototype._tryUntilFail = function(){
+  this.maxAttempts--;
+
+  this._req = Request.request(this.options, function(err, response, body){
+    if(this._isRetriable(err, response) && this.maxAttempts >= 0){
+      this._timeout = setTimeout(this._tryUntilFail.bind(this), this.retryDelay);
+      return;
     }
 
-    return f(err, response, body);
-  });
-}
+    return this.f(err, response, body);
+  }.bind(this));
+};
 
-function RetriableRequest(options, f){
-  var retryOptions = _(options || {}).defaults(DEFAULTS).pick(Object.keys(DEFAULTS)).value();
-  tryUntilFail(options, f, retryOptions);
+Request.prototype._isRetriable = function(err, response){
+  // Inspired from https://github.com/geoffreak/request-enhanced/blob/master/src/request-enhanced.coffee#L107
+  return (err && _.contains(RETRIABLE_ERRORS, err.code)) || (response && 500 <= response.statusCode && response.statusCode < 600);
+};
+
+Request.prototype.abort = function(){
+  if(this._req){
+    this._req.abort();
+  }
+  clearTimeout(this._timeout);
+  this.f(new Error('Aborted'));
+};
+
+function Factory(options, f){
+  var retry = _(options || {}).defaults(DEFAULTS).pick(Object.keys(DEFAULTS)).value();
+  var req = new Request(options, f, retry.maxAttempts, retry.retryDelay);
+  req._tryUntilFail();
+  return req;
 }
 
-module.exports = RetriableRequest;
+module.exports = Factory;
+
+Factory.Request = Request;

package.json

@@ -9,3 +9,3 @@ {
   },
-  "version": "0.0.1",
+  "version": "1.0.0",
   "repository": {
@@ -19,3 +19,7 @@ "url": "https://github.com/FGRibreau/node-request-retry"
     "request": "~2.34.0"
+  },
+  "devDependencies": {
+    "chai": "~1.9.1",
+    "mocha": "~1.18.2"
   }
 }

README.md

 # Request-retry [![Deps](https://david-dm.org/FGRibreau/node-request-retry.png)](https://david-dm.org/FGRibreau/node-request-retry)
 
-![npm](https://nodei.co/npm/requestretry.png)
+[![npm](https://nodei.co/npm/requestretry.png)](https://npmjs.org/package/requestretry)
 
 When the connection fails with one of `ECONNRESET`, `ENOTFOUND`, `ESOCKETTIMEDOUT`, `ETIMEDOUT`, `ECONNREFUSED` or when an HTTP 5xx error occurrs, the request will automatically be re-attempted as these are often recoverable errors and will go away on retry.
 
-# Usage
+## Usage
 
@@ -22,3 +22,3 @@ Request-retry is a drop-in replacement for [request](https://github.com/mikeal/request) but adds two new options `maxAttempts` and `retryDelay`.
 }, function(err, response, body){
-  // this callback will only be called when the request succeeded or after maxAttempts.
+  // this callback will only be called when the request succeeded or after maxAttempts or on error
 });
@@ -33,6 +33,13 @@ ```
 
+## Todos
+
+- Tests
+- Use an EventEmitter to notify retries
+- Allow the end-user to specify its own conditions to trigger a retry
+
 ## Changelog
 
-v1.0.0: Initial commit
+v1.0.0: request now yield an Request instance with a `.abort()` method.
+v0.0.1: Initial commit
 
 Copyright 2014, [Francois-Guillaume Ribreau](http://fgribreau.com) ([e-mail])

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

5469

increased by32.33%

Number of package files

6

increased by20%

Lines of code

70

increased by112.12%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

44

increased by18.92%

Worsened metrics

Dev dependency count

2

increased byInfinity%

No dependency changes