Merge pull request #473 from ryanseys/fix-fix-fix

Check for rateLimitExceeded and userRateLimitExceeded errors
googleapis · Mar 31, 2015 · 70f4a95 · 70f4a95
2 parents 1d536f3 + 44865d6
commit 70f4a95
Show file tree

Hide file tree

Showing 2 changed files with 90 additions and 1 deletion.
diff --git a/lib/common/util.js b/lib/common/util.js
@@ -432,7 +432,24 @@ module.exports.getNextRetryWait = getNextRetryWait;
  * @return {boolean} True if the API request should be retried, false otherwise.
  */
 function shouldRetry(err) {
-  return !!err && [429, 500, 503].indexOf(err.code) !== -1;
+  if (err) {
+    if ([429, 500, 503].indexOf(err.code) !== -1) {
+      return true;
+    }
+
+    if (err.errors) {
+      for (var i in err.errors) {
+        var reason = err.errors[i].reason;
+        if (reason === 'rateLimitExceeded') {
+          return true;
+        } else if (reason === 'userRateLimitExceeded') {
+          return true;
+        }
+      }
+    }
+  }
+
+  return false;
 }
 
 module.exports.shouldRetryErr = shouldRetry;

diff --git a/test/common/util.js b/test/common/util.js
@@ -573,6 +573,78 @@ describe('common/util', function() {
         });
       });
 
+      it('should retry rate limits on rateLimitExceeded', function(done) {
+        var attemptedRetries = 0;
+        var error = new Error('Rate Limit Error.');
+        error.code = 403; // not a rate limit code!
+        error.errors = [{ reason: 'rateLimitExceeded' }];
+
+        var authorizedReqOpts = { a: 'b', c: 'd' };
+
+        var old_setTimeout = setTimeout;
+        setTimeout = function(callback, time) {
+          var MIN_TIME = (Math.pow(2, attemptedRetries) * 1000);
+          var MAX_TIME = (Math.pow(2, attemptedRetries) * 1000) + 1000;
+          assert(time >= MIN_TIME && time <= MAX_TIME);
+          attemptedRetries++;
+          callback(); // make the request again
+        };
+
+        gsa_Override = function() {
+          return function authorize(reqOpts, callback) {
+            callback(null, authorizedReqOpts);
+          };
+        };
+
+        request_Override = function(reqOpts, callback) {
+          callback(null, null, { error: error });
+        };
+
+        var makeRequest = util.makeAuthorizedRequest({});
+        makeRequest({}, function(err) {
+          setTimeout = old_setTimeout;
+          assert.equal(attemptedRetries, 3);
+          assert.equal(err.message, 'Rate Limit Error.');
+          done();
+        });
+      });
+
+      it('should retry rate limits on userRateLimitExceeded', function(done) {
+        var attemptedRetries = 0;
+        var error = new Error('Rate Limit Error.');
+        error.code = 403; // not a rate limit code!
+        error.errors = [{ reason: 'userRateLimitExceeded' }];
+
+        var authorizedReqOpts = { a: 'b', c: 'd' };
+
+        var old_setTimeout = setTimeout;
+        setTimeout = function(callback, time) {
+          var MIN_TIME = (Math.pow(2, attemptedRetries) * 1000);
+          var MAX_TIME = (Math.pow(2, attemptedRetries) * 1000) + 1000;
+          assert(time >= MIN_TIME && time <= MAX_TIME);
+          attemptedRetries++;
+          callback(); // make the request again
+        };
+
+        gsa_Override = function() {
+          return function authorize(reqOpts, callback) {
+            callback(null, authorizedReqOpts);
+          };
+        };
+
+        request_Override = function(reqOpts, callback) {
+          callback(null, null, { error: error });
+        };
+
+        var makeRequest = util.makeAuthorizedRequest({});
+        makeRequest({}, function(err) {
+          setTimeout = old_setTimeout;
+          assert.equal(attemptedRetries, 3);
+          assert.equal(err.message, 'Rate Limit Error.');
+          done();
+        });
+      });
+
       it('should retry rate limits 3x by default', function(done) {
         var attemptedRetries = 0;
         var error = new Error('Rate Limit Error.');