Merge pull request #301 from cloudant/fix-multiple-callback-execution

Prevent client executing done callback multiple times

Author: smithsz

CHANGES.md

@@ -1,6 +1,7 @@
 # UNRELEASED
 - [FIXED] Add missing `maxAttempt` parameter to TypeScript definition.
 - [FIXED] Include client initialization callback in TypeScript definition.
+- [FIXED] Prevent client executing done callback multiple times.
 - [FIXED] Removed test and lint data that bloated npm package size.
 - [FIXED] Support Cloudant query when using promises request plugin.
 

lib/client.js

@@ -267,6 +267,20 @@ class CloudantClient {
     };
 
     async.forever(function(done) {
+      request.doneCallback = done;
+      request.done = false;
+
+      // Fixes an intermittent bug where the `done` callback is executed
+      // multiple times.
+      done = function(error) {
+        if (request.done) {
+          debug('Callback was already called.');
+          return;
+        }
+        request.done = true;
+        return request.doneCallback(error);
+      };
+
       request.options = Object.assign({}, options); // new copy
       request.response = undefined;