Add support for asynchronously delaying mocked responses (#52)

* add support for asynchronously delaying mocked responses

* fix lint issues presented in the delay feature

* make response local to current request and not global for all mocks.

* fix unit tests - update superagent lib files, tests are made on the latest v3 superagent which have changed on 3.4

* fix typo in README

Author: elisherer

README.md

@@ -75,7 +75,7 @@ module.exports = [
         if(params['superhero']) {
           return 'Your hero:' + params['superhero'];
         } else {
-          return 'You didnt chose a hero';
+          return 'You didnt choose a hero';
         }
       }
 
@@ -107,6 +107,17 @@ module.exports = [
         return null;
       }
 
+      /**
+       * Delaying the response with a specific number of milliseconds:
+       *   request.get('https://domain.example/delay_test').end(function(err, res){
+       *     console.log(res.body); // This log will be written after the delay time has passed 
+       *   })
+       */
+
+      if (match[1] === '/delay_test') {
+        context.delay = 3000; // This will delay the response by 3 seconds
+        return 'zzZ';
+      }
     },
 
     /**

lib/superagent-mock.js

@@ -13,7 +13,6 @@ module.exports = mock;
  */
 function mock (superagent, config, logger) {
   var Request = superagent.Request;
-  var response = {};
   var currentLog = {};
   var logEnabled = !!logger;
 
@@ -54,6 +53,7 @@ function mock (superagent, config, logger) {
     var error = null;
     var path;
     var isNodeServer = this.hasOwnProperty('cookies');
+    var response = {};
 
     if (isNodeServer) { // node server
       var originalPath = this.path;
@@ -106,8 +106,8 @@ function mock (superagent, config, logger) {
 
     var match = new RegExp(parser.pattern, 'g').exec(path);
 
+    var context = {};
     try {
-      var context = {};
       var fixtures = parser.fixtures(match, this._data, this.header, context);
       if (context.cancel === true) {
         return oldEnd.call(this, fn); // mocking was cancelled from within fixtures
@@ -142,7 +142,14 @@ function mock (superagent, config, logger) {
       }
     }
 
-    fn(error, response);
+    if (typeof context.delay === 'number') {
+      setTimeout(function () {
+        fn(error, response);
+      }, context.delay);
+    }
+    else {
+      fn(error, response);
+    }
     return this;
   };
 

tests/support/component.json

@@ -2,10 +2,11 @@
   "name": "superagent",
   "scripts": [
     "../../node_modules/superagent/lib/client.js",
-    "../../node_modules/superagent/lib/is-object.js",
     "../../node_modules/superagent/lib/is-function.js",
+    "../../node_modules/superagent/lib/is-object.js",
     "../../node_modules/superagent/lib/request-base.js",
     "../../node_modules/superagent/lib/response-base.js",
+    "../../node_modules/superagent/lib/should-retry.js",
     "../../node_modules/superagent/lib/utils.js"
   ],
   "main": "../../node_modules/superagent/lib/client.js",

tests/support/config.js

@@ -181,7 +181,7 @@ module.exports = [
     }
   },
   {
-    pattern: 'https://match.toomuch.example/([\\w-]+)',
+    pattern: 'https://context.cancel.example/([\\w-]+)',
     fixtures: function (match, data, headers, context) {
       if (match && match[1] === 'real-call') {
         context.cancel = true;
@@ -197,5 +197,21 @@ module.exports = [
     put: function (match, data) {
       return {match: match, data: data};
     }
+  },
+  {
+    pattern: 'https://context.delay.example/([\\w-]+)',
+    fixtures: function (match, data, headers, context) {
+      context.delay = 3000;
+      return match && match[1];
+    },
+    get: function (match, data) {
+      return {match: match, data: data};
+    },
+    post: function (match, data) {
+      return {match: match, data: data};
+    },
+    put: function (match, data) {
+      return {match: match, data: data};
+    }
   }
 ];

tests/support/expectations.js

@@ -11,6 +11,8 @@ module.exports = function (request, config, isServer) {
   };
   var superagentPackage = require('superagent/package.json');
   var superagentUserAgentHeader = isServer ? {"User-Agent": 'node-superagent/' + superagentPackage.version} : {};
+  var originalSetTimeout = setTimeout;
+  var timePassed = 0;
 
   return {
 
@@ -29,6 +31,14 @@ module.exports = function (request, config, isServer) {
         return oldSet.call(this, field, value);
       };
 
+      // Stub setTimeout
+      Object.defineProperty(global, 'setTimeout', {
+        value: function(callbackFunc, timeout) {
+          timePassed = timeout;
+          callbackFunc();
+        }
+      });
+
       // Init module
       superagentMock = require('./../../lib/superagent-mock')(request, config, logger);
 
@@ -39,6 +49,9 @@ module.exports = function (request, config, isServer) {
       superagentMock.unset();
       headers = null;
       currentLog = null;
+      // restore setTimeout
+      Object.defineProperty(global, 'setTimeout', { value: originalSetTimeout });
+      timePassed = 0;
 
       go();
     },
@@ -708,20 +721,28 @@ module.exports = function (request, config, isServer) {
         test.done();
       },
       'not calling real api if not cancelled': function (test) {
-        request.put('https://match.toomuch.example/mock-call')
+        request.put('https://context.cancel.example/mock-call')
           .end(function (err, result) {
             test.ok(!err);
             test.notEqual(result, 'Real call done');
             test.done();
           });
       },
       'calling real api when cancelled': function (test) {
-        request.put('https://match.toomuch.example/real-call')
+        request.put('https://context.cancel.example/real-call')
           .end(function (err, result) {
             test.ok(!err);
             test.equal(result, 'Real call done');
             test.done();
           });
+      },
+      'calling callback function after specified delay': function (test) {
+        request.put('https://context.delay.example/test')
+          .end(function (err, result) {
+            test.equal(result.data, 'test'); // just to see the arguments are passed as usual
+            test.equal(timePassed, 3000); // setTimeout has been called
+            test.done();
+          });
       }
     },
     'Logger': {