Merge pull request #24 from kuzzleio/unitTests

code coverage

Author: scottinet

.travis.yml

@@ -3,7 +3,7 @@ language: node_js
 node_js:
 - '4.2'
 script:
-- grunt && npm test
+- grunt && npm test && cat ./coverage/lcov.info | ./node_modules/.bin/codecov
 before_install: npm install -g grunt-cli
 install: npm install
 after_deploy:

README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://travis-ci.org/kuzzleio/sdk-javascript.svg?branch=master)](https://travis-ci.org/kuzzleio/sdk-javascript) [![Dependency Status](https://david-dm.org/kuzzleio/sdk-javascript.svg)](https://david-dm.org/kuzzleio/sdk-javascript)
+[![Build Status](https://travis-ci.org/kuzzleio/sdk-javascript.svg?branch=master)](https://travis-ci.org/kuzzleio/sdk-javascript) [![codecov.io](http://codecov.io/github/kuzzleio/sdk-javascript/coverage.svg?branch=master)](http://codecov.io/github/kuzzleio/sdk-javascript?branch=master) [![Dependency Status](https://david-dm.org/kuzzleio/sdk-javascript.svg)](https://david-dm.org/kuzzleio/sdk-javascript)
 
 
 Kuzzle

package.json

@@ -1,6 +1,6 @@
 {
   "name": "kuzzle-sdk",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Official Javascript SDK for Kuzzle",
   "author": "The Kuzzle Team <[email protected]>",
   "repository": {
@@ -29,6 +29,7 @@
   },
   "devDependencies": {
     "browserify": "12.0.1",
+    "codecov": "^1.0.1",
     "grunt": "0.4.5",
     "grunt-browserify": "^4.0.1",
     "grunt-contrib-jshint": "^0.11.3",

src/kuzzle.js

@@ -234,13 +234,15 @@ module.exports = Kuzzle = function (url, options, cb) {
 Kuzzle.prototype.connect = function (cb) {
   var self = this;
 
-  if (['initializing', 'ready', 'loggedOff'].indexOf(this.state) === -1) {
+  if (['initializing', 'ready', 'loggedOff', 'error', 'offline'].indexOf(this.state) === -1) {
     if (cb) {
       cb(null, self);
     }
     return self;
   }
 
+  self.state = 'connecting';
+
   self.socket = io(self.url, {
     reconnection: self.autoReconnect,
     reconnectionDelay: self.reconnectionDelay,

src/kuzzleDataCollection.js

@@ -468,13 +468,18 @@ KuzzleDataCollection.prototype.replaceDocument = function (documentId, content,
  * To subscribe to the entire data collection, simply provide an empty filter.
  *
  * @param {object} filters - Filters in Kuzzle DSL format
- * @param {responseCallback} cb - called for each new notification
  * @param {object} [options] - subscriptions options
+ * @param {responseCallback} cb - called for each new notification
  * @returns {*} KuzzleRoom object
  */
-KuzzleDataCollection.prototype.subscribe = function (filters, cb, options) {
+KuzzleDataCollection.prototype.subscribe = function (filters, options, cb) {
   var room;
 
+  if (!cb && typeof options === 'function') {
+    cb = options;
+    options = null;
+  }
+
   this.kuzzle.callbackRequired('KuzzleDataCollection.subscribe', cb);
 
   room = new KuzzleRoom(this, options);
@@ -562,10 +567,6 @@ KuzzleDataCollection.prototype.updateDocument = function (documentId, content, o
 KuzzleDataCollection.prototype.documentFactory = function (id, content) {
   var document = content._source ? new KuzzleDocument(this, id, content._source) : new KuzzleDocument(this, id, content);
 
-  if (content._version) {
-    document.version = content._version;
-  }
-
   return document;
 };
 

src/kuzzleDataMapping.js

@@ -16,6 +16,7 @@
  *  The KuzzleDataMapping object allow to get the current mapping of a data collection and to modify it if needed.
  *
  * @param {object} kuzzleDataCollection - Instance of the inherited KuzzleDataCollection object
+ * @param {object} mapping - mappings
  * @constructor
  */
 function KuzzleDataMapping(kuzzleDataCollection, mapping) {

src/kuzzleDocument.js

@@ -37,10 +37,6 @@ function KuzzleDocument(kuzzleDataCollection, documentId, content) {
       value: kuzzleDataCollection.collection,
       enumerable: true
     },
-    createdTimestamp: {
-      value: 'not yet implemented',
-      enumerable: true
-    },
     dataCollection: {
       value: kuzzleDataCollection,
       enumerable: true
@@ -49,11 +45,12 @@ function KuzzleDocument(kuzzleDataCollection, documentId, content) {
       value: kuzzleDataCollection.kuzzle,
       enumerable: true
     },
-    modifiedTimestamp: {
-      value: 'not yet implemented',
-      enumerable: true
-    },
     // writable properties
+    id: {
+      value: undefined,
+      enumerable: true,
+      writable: true
+    },
     content: {
       value: {},
       writable: true,
@@ -78,6 +75,10 @@ function KuzzleDocument(kuzzleDataCollection, documentId, content) {
   }
 
   if (content) {
+    if (content._version) {
+      this.version = content._version;
+      delete content._version;
+    }
     this.setContent(content, true);
   }
 
@@ -161,7 +162,7 @@ KuzzleDocument.prototype.delete = function (options, cb) {
   }
 
   if (!this.id) {
-    throw new Error('KuzzleDocument.delete: cannot delete a document that has not been saved into Kuzzle');
+    throw new Error('KuzzleDocument.delete: cannot delete a document without a document ID');
   }
 
   if (cb) {
@@ -244,39 +245,32 @@ KuzzleDocument.prototype.refresh = function (options, cb) {
 KuzzleDocument.prototype.save = function (options, cb) {
   var
     data = this.toJSON(),
-    self = this,
-    queryCB;
+    self = this;
 
   if (options && cb === undefined && typeof options === 'function') {
     cb = options;
     options = null;
   }
 
-  queryCB = function (error, result) {
+  if (self.refreshing) {
+    self.queue.push({action: 'save', args: [options, cb]});
+    return self;
+  }
+
+  data.persist = true;
+
+  self.kuzzle.query(this.collection, 'write', 'createOrUpdate', data, options, function (error, result) {
     if (error) {
       return cb ? cb(error) : false;
     }
 
-    if (!self.id) {
-      Object.defineProperty(self, 'id', {
-        value: result._id,
-        enumerable: true
-      });
-    }
+    self.id = result._id;
+    self.version = result._version;
 
     if (cb) {
       cb(null, self);
     }
-  };
-
-  if (self.refreshing) {
-    self.queue.push({action: 'save', args: [options, cb]});
-    return self;
-  }
-
-  data.persist = true;
-
-  self.kuzzle.query(this.collection, 'write', 'createOrUpdate', data, options, queryCB);
+  });
 
   return self;
 };
@@ -350,18 +344,13 @@ KuzzleDocument.prototype.subscribe = function (options, cb) {
 
   this.kuzzle.callbackRequired('KuzzleDocument.subscribe', cb);
 
-  if (this.refreshing) {
-    this.queue.push({action: 'subscribe', args: [cb]});
-    return this;
-  }
-
   if (!this.id) {
     throw new Error('KuzzleDocument.subscribe: cannot subscribe to a document if no ID has been provided');
   }
 
   filters = { ids: { values: [this.id] } };
 
-  return this.dataCollection.subscribe(filters, cb, options);
+  return this.dataCollection.subscribe(filters, options, cb);
 };
 
 /**
@@ -382,7 +371,7 @@ KuzzleDocument.prototype.setHeaders = function (content, replace) {
 /**
  * internal function used to dequeue calls which were put on hold while refreshing the content of this document
  */
-function dequeue() {
+function dequeue () {
   var element;
 
   while (this.queue.length > 0) {

src/kuzzleRoom.js

@@ -22,10 +22,6 @@ var uuid = require('node-uuid');
  * @constructor
  */
 function KuzzleRoom(kuzzleDataCollection, options) {
-  if (!kuzzleDataCollection) {
-    throw new Error('KuzzleRoom: missing parameters');
-  }
-
   // Define properties
   Object.defineProperties(this, {
     // private properties
@@ -173,20 +169,16 @@ KuzzleRoom.prototype.renew = function (filters, cb) {
   subscribeQuery = this.kuzzle.addHeaders({body: self.filters}, this.headers);
 
   self.kuzzle.query(this.collection, 'subscribe', 'on', subscribeQuery, {metadata: this.metadata}, function (error, response) {
+    delete self.kuzzle.subscriptions.pending[self.id];
+    self.subscribing = false;
+
     if (error) {
-      /*
-       If we've already subscribed to this room, Kuzzle returns the actual roomID.
-       We'll simply ignore the error and acts as if we successfully subscribed.
-        */
-      if (error.details && error.details.roomId) {
-        self.roomId = error.details.roomId;
-      } else {
-        throw new Error('Error during Kuzzle subscription: ' + error.message);
-      }
-    } else {
-      self.roomId = response.roomId;
+      self.queue = [];
+      throw new Error('Error during Kuzzle subscription: ' + error.message);
     }
 
+    self.roomId = response.roomId;
+
     if (!self.kuzzle.subscriptions[self.roomId]) {
       self.kuzzle.subscriptions[self.roomId] = {};
     }
@@ -196,10 +188,7 @@ KuzzleRoom.prototype.renew = function (filters, cb) {
     self.notifier = notificationCallback.bind(self);
     self.kuzzle.socket.on(self.roomId, self.notifier);
 
-    self.subscribing = false;
-    delete self.kuzzle.subscriptions.pending[self.id];
-
-    self.dequeue();
+    dequeue.call(self);
   });
 
   return this;
@@ -241,7 +230,7 @@ KuzzleRoom.prototype.unsubscribe = function () {
             }
             clearInterval(interval);
           }
-        }, 500);
+        }, 100);
       }
     } else {
       delete self.kuzzle.subscriptions[room][self.id];
@@ -267,19 +256,6 @@ KuzzleRoom.prototype.setHeaders = function (content, replace) {
   return this;
 };
 
-/**
- * Dequeue actions performed while subscription was being renewed
- */
-KuzzleRoom.prototype.dequeue = function () {
-  var element;
-
-  while (this.queue.length > 0) {
-    element = this.queue.shift();
-
-    this[element.action].apply(this, element.args);
-  }
-};
-
 /**
  * Callback called by socket.io when a message is sent to the subscribed room ID
  * Calls the registered callback if the notification passes the subscription filters
@@ -312,7 +288,7 @@ function notificationCallback (data) {
       }
 
       self.kuzzle.eventListeners[globalEvent].forEach(function (listener) {
-        listener(self.subscriptionId, data.result);
+        listener.fn(self.subscriptionId, data.result);
       });
     }
   } else if (self.kuzzle.requestHistory[data.result.requestId]) {
@@ -325,4 +301,18 @@ function notificationCallback (data) {
   }
 }
 
+
+/**
+ * Dequeue actions performed while subscription was being renewed
+ */
+function dequeue () {
+  var element;
+
+  while (this.queue.length > 0) {
+    element = this.queue.shift();
+
+    this[element.action].apply(this, element.args);
+  }
+}
+
 module.exports = KuzzleRoom;