Improve .retry() method functionality with delays and prevent calling on successful request (#1527)

* Enable .retry() method to use an async function as a callback, to allow easily delaying retries by using a Promise and setTimeout.

* Prevent .retry() method from being invoked on successful request. Runs only when there's a defined error.

* - Update readme with new async functionality of retry()
- Make ESLint happy
- Add babel plugin so aync/await works on node 6.x

Author: IAMtheIAM

.dist.babelrc

@@ -6,5 +6,7 @@
       }
     }]
   ],
-  "sourceMaps": "inline"
+    "plugins": [
+      ["@babel/plugin-transform-runtime"]
+  ]
 }

.dist.eslintrc

@@ -18,7 +18,8 @@
     "no-useless-escape": "off",
     "no-cond-assign": "off",
     "no-redeclare": "off",
-    "node/no-exports-assign": "off"
+    "no-fallthrough": "off",
+    "no-constant-condition": "off"
   },
   "globals": {
     "regeneratorRuntime": "writable"

.lib.babelrc

@@ -7,5 +7,7 @@
       }
     }]
   ],
-  "sourceMaps": "inline"
+    "plugins": [
+      ["@babel/plugin-transform-runtime"]
+  ]
 }

.lib.eslintrc

@@ -11,7 +11,8 @@
     "node/no-unsupported-features/node-builtins": "off",
     "no-func-assign": "off",
     "no-global-assign": ["error", {"exceptions": ["exports"]}],
-    "node/no-exports-assign": "off"
+    "no-fallthrough": "off",
+    "no-constant-condition": "off"
   },
   "overrides": [
     {

docs/index.md

@@ -246,6 +246,15 @@ This method has two optional arguments: number of retries (default 1) and a call
        .then(finished);
        .catch(failed);
 
+The callback supplied can be async if you need to await any data or to create a delay before retrying. This code will retry 10 times, with a 3 second delay between each retry. To add a delay:
+
+         .retry(10, async function(err, res) {
+          let delay = 3000; // ms
+          log.error(`Request failed, retrying in ${delay / 1000} seconds ...`);
+          await new Promise(resolve => setTimeout(() => resolve(), delay));
+          return true;
+        })
+
 Use `.retry()` only with requests that are *idempotent* (i.e. multiple requests reaching the server won't cause undesirable side effects like duplicate purchases).
 
 ## Setting Accept

package.json

@@ -23,6 +23,7 @@
     "Nick Baugh <[email protected]>"
   ],
   "dependencies": {
+    "@babel/runtime": "7.4.5",
     "component-emitter": "^1.3.0",
     "cookiejar": "^2.1.2",
     "debug": "^4.1.1",

src/client.js

@@ -646,8 +646,8 @@ Request.prototype._getFormData = function() {
  * @api private
  */
 
-Request.prototype.callback = function(err, res) {
-  if (this._shouldRetry(err, res)) {
+Request.prototype.callback = async function(err, res) {
+  if (err !== null && (await this._shouldRetry(err, res))) {
     return this._retry();
   }
 

src/node/index.js

@@ -857,8 +857,8 @@ Request.prototype.request = function() {
  * @api private
  */
 
-Request.prototype.callback = function(err, res) {
-  if (this._shouldRetry(err, res)) {
+Request.prototype.callback = async function(err, res) {
+  if (err !== null && (await this._shouldRetry(err, res))) {
     return this._retry();
   }
 

src/request-base.js

@@ -178,14 +178,14 @@ const ERROR_CODES = ['ECONNRESET', 'ETIMEDOUT', 'EADDRINFO', 'ESOCKETTIMEDOUT'];
  * @param {Response} [res] response
  * @returns {Boolean} if segment should be retried
  */
-RequestBase.prototype._shouldRetry = function(err, res) {
+RequestBase.prototype._shouldRetry = async function(err, res) {
   if (!this._maxRetries || this._retries++ >= this._maxRetries) {
     return false;
   }
 
   if (this._retryCallback) {
     try {
-      const override = this._retryCallback(err, res);
+      const override = await this._retryCallback(err, res);
       if (override === true) return true;
       if (override === false) return false;
       // undefined falls back to defaults