Merge pull request #172 from kuzzleio/topic-fix-scroll-and-next

Fix scroll action and next on searchResult

Author: stafyniaksacha

package.json

@@ -1,6 +1,6 @@
 {
   "name": "kuzzle-sdk",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "Official Javascript SDK for Kuzzle",
   "author": "The Kuzzle Team <support@kuzzle.io>",
   "repository": {

src/Collection.js

@@ -490,11 +490,11 @@ Collection.prototype.search = function (filters, options, cb) {
  */
 Collection.prototype.scroll = function (scrollId, options, filters, cb) {
   var
-    request = {body: {}},
+    request = {body:{}},
     self = this;
 
   if (!scrollId) {
-    throw new Error('Collection.scroll: scrollId required');
+    throw new Error('Collection.scroll: scrollId is required');
   }
 
   if (!cb) {
@@ -511,6 +511,10 @@ Collection.prototype.scroll = function (scrollId, options, filters, cb) {
     options = {};
   }
 
+  if (!options.scroll) {
+    throw new Error('Collection.scroll: scroll is required');
+  }
+
   options.scrollId = scrollId;
 
   this.kuzzle.callbackRequired('Collection.scroll', cb);

src/Kuzzle.js

@@ -1283,14 +1283,22 @@ Kuzzle.prototype.query = function (queryArgs, query, options, cb) {
       object.refresh = options.refresh;
     }
 
-    if (options.from) {
+    if (typeof options.from !== 'undefined' && options.from !== null) {
       object.from = options.from;
     }
 
     if (options.size) {
       object.size = options.size;
     }
 
+    if (options.scroll) {
+      object.scroll = options.scroll;
+    }
+
+    if (options.scrollId) {
+      object.scrollId = options.scrollId;
+    }
+
     if (options.metadata) {
       Object.keys(options.metadata).forEach(function (meta) {
         object.metadata[meta] = options.metadata[meta];

src/SearchResult.js

@@ -94,6 +94,15 @@ KuzzleSearchResult.prototype.next = function (cb) {
         return;
       }
 
+      // from and size parameters are not valid for a scroll action
+      if (options.from) {
+        delete options.from;
+      }
+
+      if (options.size) {
+        delete options.size;
+      }
+
       this.dataCollection.scroll(
         options.scrollId,
         options,

test/kuzzleDataCollection/methods.test.js

@@ -146,12 +146,17 @@ describe('Collection methods', function () {
 
     it('should throw an error if no scrollId is set', () => {
       var collection = kuzzle.collection(expectedQuery.collection);
-      should(() => { collection.scroll(); }).throw('Collection.scroll: scrollId required');
+      should(() => { collection.scroll(); }).throw('Collection.scroll: scrollId is required');
+    });
+
+    it('should throw an error if no scroll is provided', () => {
+      var collection = kuzzle.collection(expectedQuery.collection);
+      should(() => { collection.scroll('scrollId'); }).throw('Collection.scroll: scroll is required');
     });
 
     it('should throw an error if no callback is given', () => {
       var collection = kuzzle.collection(expectedQuery.collection);
-      should(() => { collection.scroll('scrollId'); }).throw('Collection.scroll: a callback argument is required for read queries');
+      should(() => { collection.scroll('scrollId', {scroll: '1m'}); }).throw('Collection.scroll: a callback argument is required for read queries');
     });
 
     it('should parse the given parameters', done => {
@@ -189,33 +194,6 @@ describe('Collection methods', function () {
 
       collection.scroll(scrollId, options, filters, cb);
     });
-
-    it('should parse the given parameters even if no options is given', done => {
-      var
-        queryScrollStub,
-        collection = kuzzle.collection(expectedQuery.collection),
-        scrollId = 'scrollId',
-        cb = () => {
-          done();
-        };
-
-      queryScrollStub = function (args, query, opts, callback) {
-        should(args.controller).be.exactly('document');
-        should(args.action).be.exactly('scroll');
-        should(opts.scrollId).be.exactly(scrollId);
-
-        callback(null, {
-          result: {
-            total: 0,
-            hits: []
-          }
-        });
-      };
-
-      kuzzle.query = queryScrollStub;
-
-      collection.scroll(scrollId, cb);
-    });
   });
 
   describe('#count', function () {