Merge pull request #15 from kuzzleio/unitTests

added offline queue unit tests + bugfixes

Author: scottinet

.travis.yml

@@ -31,5 +31,12 @@ deploy:
     repo: kuzzleio/sdk-javascript
     branch: master
 notifications:
+  webhooks:
+    urls:
+    - https://webhooks.gitter.im/e/8e145155fbaaf37cffea
+    on_success: change
+    on_failure: always
+    on_start: never
+  email: false
   slack:
     secure: m0BEda/eXxYkil0zDZ1uNpK13kiNbb5/80I5OqDBz6X7/WH3uhWIV6q38lI929tQKz04eHAfVDaRSoPk1XwZBnb70MgcRmSG/m4/moR7BCnx7D9hHFqhNf0EfdzwEg44dCCVtD2vUvChtYV+jK74sNd4yqeq86YXi33qS7SYLS6kYnRloX0D7sQXDy14FWU2a5+hsrPX8yBoWuPjBergvK6W1dZAG+SfDywaqsrUDs+q64yEHiYV9VlvVZ/oKXZiDnVcB2hi0uulIZ8+iZaMJFEU30uCQiK6w3HG587yx3sVJmprr64ZYHKaFJD2ZAG1td6wJ1ccJsU/ruGkj4+0CeoZUYYBYXYQ4qhQl8F2QT0m+8dWqPwzYpxEoqyvGS9ioZG/YI18V2CE1pEyc72JzEv6c3AgDbtwrLH5s3ViNts7kulk3wwCzuAww+DapSV9ggezo+Bs7OGRpXwh/saeKWUCLqTkLQTjuq2dFVdo85HsC2RrLcSsZLMTOuV/A//FNBDJBlNnuneGP84zGkWGPEja0FFXvm2TS95gh1hd2PMe+QxjygOAvIMLmDmfdlWSLayUeWbqp20EdF7TUHV0dvBucga8s3UvFhIMnnGLS9vcNEIRtVornXznwdYSLbYD0mLXNtitneXTnSAxilThKtGDPOWQFkYkyoFV9FEwKO8=

src/kuzzle.js

@@ -374,7 +374,7 @@ function dequeue () {
     self.offlineQueue.shift();
 
     setTimeout(function () {
-      dequeue();
+      dequeue.call(self);
     }, Math.max(0, self.replayInterval));
   } else {
     self.queuing = false;

test/kuzzle/offlineQueue.test.js

@@ -0,0 +1,114 @@
+var
+  should = require('should'),
+  rewire = require('rewire'),
+  Kuzzle = rewire('../../src/kuzzle');
+
+describe('Kuzzle: offline queue management', () => {
+  var sent;
+
+  // deactivate socket.io
+  before(function () {
+    Kuzzle.__set__('io', function () {
+      return {
+        emit: function () { sent++; },
+        close: function () {},
+        on: function () {},
+        once: function () {}
+      };
+    });
+  });
+
+  describe('#cleanQueue', function () {
+    var
+      cleanQueue = Kuzzle.__get__('cleanQueue'),
+      now = Date.now(),
+      kuzzle;
+
+    beforeEach(function () {
+      var
+        pastTime = 60000;
+
+      kuzzle = new Kuzzle('foo');
+
+      // queuing a bunch of requests from 1min ago to right now, 10s apart
+      while (pastTime >= 0) {
+        kuzzle.offlineQueue.push({ts: now - pastTime, query: {}, cb: function () {}});
+        pastTime -= 10000;
+      }
+    });
+
+    it('should remove outdated queued requests', function () {
+      // setting the request TTL to 5s
+      kuzzle.queueTTL = 5000;
+
+      cleanQueue.call(kuzzle);
+
+      // should keep only the latest requests, dating from a few ms ago
+      should(kuzzle.offlineQueue.length).be.exactly(1);
+      should(kuzzle.offlineQueue[0].ts).be.above(now - kuzzle.queueTTL);
+    });
+
+    it('should ignore requests timestamps if queueTTL is 0', function () {
+      var numRequests = kuzzle.offlineQueue.length;
+
+      kuzzle.queueTTL = 0;
+      cleanQueue.call(kuzzle);
+      should(kuzzle.offlineQueue.length).be.exactly(numRequests);
+    });
+
+    it('should remove older requests until the queueMaxSize condition is met', function () {
+      var lastRequest = kuzzle.offlineQueue[kuzzle.offlineQueue.length - 1];
+
+      kuzzle.queueMaxSize = 1;
+      cleanQueue.call(kuzzle);
+      should(kuzzle.offlineQueue.length).be.exactly(1);
+      should(kuzzle.offlineQueue[0]).match(lastRequest);
+    });
+
+    it('should not remove any request if queueMaxSize is 0', function () {
+      var numRequests = kuzzle.offlineQueue.length;
+
+      kuzzle.queueMaxSize = 0;
+      cleanQueue.call(kuzzle);
+      should(kuzzle.offlineQueue.length).be.exactly(numRequests);
+    });
+  });
+
+  describe('#dequeuing', function () {
+    var
+      dequeue = Kuzzle.__get__('dequeue'),
+      now = Date.now(),
+      kuzzle;
+
+    beforeEach(function () {
+      var
+        pastTime = 60000;
+
+      sent = 0;
+      kuzzle = new Kuzzle('foo');
+      kuzzle.socket = { emit: function () { sent++; } };
+      kuzzle.queuing = true;
+
+      // queuing a bunch of requests from 1min ago to right now, 10s apart
+      while (pastTime >= 0) {
+        kuzzle.offlineQueue.push({ts: now - pastTime, query: {}});
+        pastTime -= 10000;
+      }
+    });
+
+    it('should play all queued requests', function (done) {
+      var numRequests = kuzzle.offlineQueue.length;
+
+      this.timeout(200);
+      dequeue.call(kuzzle);
+
+      setTimeout(() => {
+        should(sent).be.exactly(numRequests);
+        should(kuzzle.offlineQueue).be.an.Array();
+        should(kuzzle.offlineQueue.length).be.exactly(0);
+        should(kuzzle.queuing).be.false();
+        done();
+      }, numRequests * kuzzle.replayInterval + 10)
+    });
+  });
+});