Merge pull request #200 from kuzzleio/18-kuzzle-info

Add kuzzle info in Document object

Author: jenow

src/Collection.js

@@ -193,7 +193,7 @@ Collection.prototype.createDocument = function (id, document, options, cb) {
       return cb(err);
     }
 
-    doc = new Document(self, res.result._id, res.result._source);
+    doc = new Document(self, res.result._id, res.result._source, res.result._meta);
     doc.version = res.result._version;
     cb(null, doc);
   });
@@ -276,7 +276,7 @@ Collection.prototype.fetchDocument = function (documentId, options, cb) {
       return cb(err);
     }
 
-    document = new Document(self, res.result._id, res.result._source);
+    document = new Document(self, res.result._id, res.result._source, res.result._meta);
     document.version = res.result._version;
     cb(null, document);
   });
@@ -419,7 +419,7 @@ Collection.prototype.replaceDocument = function (documentId, content, options, c
       return cb(err);
     }
 
-    document = new Document(self, res.result._id, res.result._source);
+    document = new Document(self, res.result._id, res.result._source, res.result._meta);
     document.version = res.result._version;
     cb(null, document);
   });
@@ -462,7 +462,7 @@ Collection.prototype.search = function (filters, options, cb) {
     }
 
     result.result.hits.forEach(function (doc) {
-      var newDocument = new Document(self, doc._id, doc._source);
+      var newDocument = new Document(self, doc._id, doc._source, doc._meta);
 
       newDocument.version = doc._version;
 
@@ -531,7 +531,7 @@ Collection.prototype.scroll = function (scrollId, options, filters, cb) {
     }
 
     result.result.hits.forEach(function (doc) {
-      var newDocument = new Document(self, doc._id, doc._source);
+      var newDocument = new Document(self, doc._id, doc._source, doc._meta);
 
       newDocument.version = doc._version;
 

src/Document.js

@@ -18,9 +18,10 @@
  * @param {Collection} collection - an instanciated Collection object
  * @param {string} [documentId] - ID of an existing document
  * @param {object} [content] - Initializes this document with the provided content
+ * @param {object} [meta] - Initializes this document with the provided meta
  * @constructor
  */
-function Document(collection, documentId, content) {
+function Document(collection, documentId, content, meta) {
   Object.defineProperties(this, {
     // read-only properties
     collection: {
@@ -55,6 +56,11 @@ function Document(collection, documentId, content) {
       value: undefined,
       enumerable: true,
       writable: true
+    },
+    meta: {
+      value: meta || {},
+      enumerable: true,
+      writable: false
     }
   });
 
@@ -108,6 +114,7 @@ Document.prototype.serialize = function () {
   }
 
   data.body = this.content;
+  data.meta = this.meta;
   data._version = this.version;
   data = this.kuzzle.addHeaders(data, this.headers);
 
@@ -179,7 +186,7 @@ Document.prototype.refresh = function (options, cb) {
       return cb(error);
     }
 
-    newDocument = new Document(self.dataCollection, self.id, res.result._source);
+    newDocument = new Document(self.dataCollection, self.id, res.result._source, res.result._meta);
     newDocument.version = res.result._version;
 
     cb(null, newDocument);

src/Room.js

@@ -322,7 +322,7 @@ function notificationCallback (data) {
 
   if (data.controller === 'document' || (data.controller === 'realtime' && data.action === 'publish')) {
     data.type = 'document';
-    data.document = new Document(this.collection, data.result._id, data.result._source);
+    data.document = new Document(this.collection, data.result._id, data.result._source, data.result._meta);
     delete data.result;
   }
   else if (data.controller === 'realtime') {

test/Collection/methods.test.js

@@ -56,7 +56,16 @@ describe('Collection methods', function () {
       kuzzle = new Kuzzle('foo', {defaultIndex: 'bar'});
       kuzzle.query = queryStub;
       emitted = false;
-      result = { result: { _scroll_id: 'banana', total: 123, hits: [ {_id: 'foobar', _source: { foo: 'bar'}} ], aggregations: {someAggregate: {}}}};
+      result = {
+        result: {
+          _scroll_id: 'banana',
+          total: 123,
+          hits: [
+            {_id: 'foobar', _source: { foo: 'bar'}, _meta: {author: 'toto'}}
+          ],
+          aggregations: {someAggregate: {}}
+        }
+      };
       error = null;
       expectedQuery = {
         index: 'bar',

test/Document/constructor.test.js

@@ -34,29 +34,41 @@ describe('Document constructor', function () {
     should(refreshed).be.false();
     should(document.id).be.undefined();
     should(document.content).be.empty();
+    should(document.meta).be.empty();
     should(document.version).be.undefined();
     should(document.collection).be.exactly('foo');
 
     document = new Document(collection, { some: 'content' });
     should(refreshed).be.false();
     should(document.id).be.undefined();
     should(document.content).match({some: 'content'});
+    should(document.meta).be.empty();
     should(document.version).be.undefined();
     should(document.collection).be.exactly('foo');
 
     document = new Document(collection, 'id', { some: 'content', _version: 123 });
     should(refreshed).be.false();
     should(document.id).be.exactly('id');
     should(document.content).match({some: 'content'});
+    should(document.meta).be.empty();
     should(document.version).be.exactly(123);
     should(document.collection).be.exactly('foo');
 
     document = new Document(collection, 'id');
     should(refreshed).be.false();
     should(document.id).be.exactly('id');
     should(document.content).be.empty();
+    should(document.meta).be.empty();
     should(document.version).be.undefined();
     should(document.collection).be.exactly('foo');
+
+    document = new Document(collection, 'id', { some: 'content', _version: 123 }, {author: 'toto'});
+    should(refreshed).be.false();
+    should(document.id).be.exactly('id');
+    should(document.content).match({some: 'content'});
+    should(document.meta).match({author: 'toto'});
+    should(document.version).be.exactly(123);
+    should(document.collection).be.exactly('foo');
   });
 
   it('should expose documented properties with the right permissions', function () {
@@ -67,6 +79,7 @@ describe('Document constructor', function () {
     should(document).have.propertyWithDescriptor('headers', { enumerable: true, writable: true, configurable: false });
     should(document).have.propertyWithDescriptor('id', { enumerable: true, writable: true, configurable: false });
     should(document).have.propertyWithDescriptor('version', { enumerable: true, writable: true, configurable: false });
+    should(document).have.propertyWithDescriptor('meta', { enumerable: true, writable: false, configurable: false });
   });
 
   it('should promisify the right functions', function () {