Merge branch '2.0-develop' into 2.0-master

Author: wooldridge

README.md

@@ -44,9 +44,9 @@ db.createCollection(
   {author: 'WG Sebald',     ...}
   )
 .result(function(response) {
-    console.log(JSON.stringify(response,null,2));
+    console.log(JSON.stringify(response, null, 2));
   }, function (error) {
-    console.log(JSON.stringify(error,null,2));
+    console.log(JSON.stringify(error, null, 2));
   });
 ```
 

lib/responder.js

@@ -147,7 +147,7 @@ BodyDispatcher.prototype.promise = function dispatchBodyPromise(
     contentType, response
     ) {
   var operation = this.operation;
-  
+
   operation.logger.debug('body promise');
   var collectObject = function collectPromiseBodyObject(data) {
     operation.data = operation.collectBodyObject(data);
@@ -166,7 +166,7 @@ BodyDispatcher.prototype.chunkedStream = function dispatchBodyChunkedStream(
     contentType, response
     ) {
   var operation = this.operation;
-  
+
   operation.logger.debug('body chunked stream');
 
   response.pipe(operation.outputStream);
@@ -175,7 +175,7 @@ BodyDispatcher.prototype.objectStream = function dispatchBodyObjectStream(
     contentType, response
     ) {
   var operation = this.operation;
-  
+
   operation.logger.debug('body object stream');
 
   var outputStream = operation.outputStream;
@@ -345,7 +345,7 @@ MultipartDispatcher.prototype.chunkedStream = function dispatchMultipartChunkedS
     boundary, response
     ) {
   var operation = this.operation;
-  
+
   var errorListener = operation.errorListener;
 
   var outputStream = operation.outputStream;
@@ -414,7 +414,7 @@ MultipartDispatcher.prototype.objectStream = function dispatchMultipartObjectStr
     boundary, response
     ) {
   var operation = this.operation;
-  
+
   var errorListener   = operation.errorListener;
 
   var rawHeaderQueue = new FifoQueue(5);
@@ -426,31 +426,13 @@ MultipartDispatcher.prototype.objectStream = function dispatchMultipartObjectStr
   var hasParsed = false;
   var hasEnded  = false;
 
-  var partTransform = function objectPartQueueTransform(
-      isLast, data, objectQueue
-      ) {
+  var partTransform = function objectPartQueueTransform(data) {
     parsedParts++;
+    var objectQueue = queuedReader.getItemQueue();
     metadataBuffer = operation.queueDocument(
         (data.length === 0) ? null : data, rawHeaderQueue, metadataBuffer, objectQueue
         );
-
-    if (isLast) {
-      if (metadataBuffer !== null) {
-        operation.queueMetadata(metadataBuffer, objectQueue);
-        metadataBuffer = null;
-      }
-
-      rawHeaderQueue      = null;
-      queuedReader        = null;
-      parser              = null;
-      partHeadersListener = null;
-      partListener        = null;
-      parseFinishListener = null;
-      responseEndListener = null;
-      partTransform       = null;
-    } else if (!hasEnded && parsedParts === parsingParts) {
-      parser.emit('drain');
-    }
+    doneChecker();
   };
 
   var queuedReader = new QueuedReader(
@@ -470,15 +452,44 @@ MultipartDispatcher.prototype.objectStream = function dispatchMultipartObjectStr
     queuedReader.addReader(partReadStream);
   };
 
-  var parseFinishListener = function promiseParseFinishListener() {
+  var parseFinishListener = function objectParseFinishListener() {
     hasParsed = true;
-    if (queuedReader !== null) {
-      queuedReader.queuedAll();
-    }
+    doneChecker();
   };
 
-  var responseEndListener = function promiseResponseEndListener() {
+  var responseEndListener = function objectResponseEndListener() {
     hasEnded = true;
+    doneChecker();
+  };
+
+  /**
+   * Check if HTTP response has ended, Dicer has finished parsing,
+   * and the Queue is empty. If all are true, then we can call end()
+   * on output stream.
+   */
+  var doneChecker = function doneChecker() {
+
+    if (queuedReader.isQueueEmpty() && hasParsed && hasEnded) {
+      if (metadataBuffer !== null) {
+        var objectQueue = queuedReader.getItemQueue();
+        operation.queueMetadata(metadataBuffer, objectQueue);
+        metadataBuffer = null;
+      }
+
+      rawHeaderQueue      = null;
+      queuedReader        = null;
+      parser              = null;
+      partHeadersListener = null;
+      partListener        = null;
+      parseFinishListener = null;
+      responseEndListener = null;
+      partTransform       = null;
+
+      operation.outputStream.end();
+    } else if (!hasEnded && parsedParts === parsingParts) {
+      parser.emit('drain');
+    }
+
   };
 
   var parser = new Dicer({boundary: boundary});
@@ -537,13 +548,10 @@ function QueuedReader(options, logger, itemsTransform) {
 
     self.logger.debug('concatenated item');
 
-    var isLast = (self.queueDone && self.readerQueue.length() === 0 &&
-        self.writerQueue.length() === 0);
-
     var itemQueue    = self.itemQueue;
     var beforeLength = itemQueue.length();
 
-    self.itemsTransform(isLast, data, itemQueue);
+    self.itemsTransform(data);
 
     if (beforeLength < itemQueue.length()) {
       if (beforeLength === 0) {
@@ -569,6 +577,12 @@ QueuedReader.prototype.addReader = function queuedAddReader(reader) {
   this.logger.debug('queued item %d', readerQueue.getTotal());
   this.nextReader();
 };
+QueuedReader.prototype.getItemQueue = function getItemQueue() {
+  return this.itemQueue;
+};
+QueuedReader.prototype.isQueueEmpty = function isQueueEmpty() {
+  return (this.readerQueue.length() === 0 && this.writerQueue.length() === 0);
+};
 QueuedReader.prototype.nextReader = function queuedReaderNextReader() {
   if (!this.isReading) {
     return;
@@ -635,12 +649,6 @@ QueuedReader.prototype._read = function queuedReaderRead(/*size*/) {
     this.nextReader();
   }
 };
-QueuedReader.prototype.queuedAll = function queuedReaderAll() {
-  if (!this.queueDone) {
-    this.logger.debug('queued all items');
-    this.queueDone = true;
-  }
-};
 
 function FifoQueue(min) {
   if (!(this instanceof FifoQueue)) {
@@ -799,13 +807,13 @@ function operationResultPromise(fullfilled, rejected) {
   switch (operation.outputMode) {
   case 'none':
     if (operation.startedResponse === true) {
-      throw new Error('cannot create result promise after receiving response');    
+      throw new Error('cannot create result promise after receiving response');
     }
     break;
   case 'promise':
-    throw new Error('already created result promise');    
+    throw new Error('already created result promise');
   default:
-    throw new Error('cannot create result promise after creating stream');    
+    throw new Error('cannot create result promise after creating stream');
   }
   operation.outputMode = 'promise';
 
@@ -847,7 +855,7 @@ function resolvedPromise(operation, resolve) {
       )+' data');
 
   if (!hasData) {
-    resolve.call(operation);          
+    resolve.call(operation);
   } else {
     resolve.call(operation, data);
   }
@@ -932,7 +940,7 @@ function operationResultStream() {
   if (error != null) {
     var i = 0;
     for (; i < error.length; i++) {
-      outputStream.emit('error', error[i]);      
+      outputStream.emit('error', error[i]);
     }
     operation.error = undefined;
   }

lib/values-builder.js

@@ -307,19 +307,27 @@ function udf() {
 
 /**
  * Sets the slice clause of a built query to select the slice
- * of the result set based on the first tuple and the number
- * of tuples (aka rows).
+ * of the result set based on the start tuple within the result set
+ * and the number of tuples (aka rows) in the slice.
  * This function must be called on the builtQuery returned
  * by the {@link valuesBuilder#valuesFromIndexes} function
  * or another function specifying a values query clause.
+ * By default, the slice uses array slice mode, but you can switch
+ * to legacy slice mode with {@link marklogic.setSliceMode}. Legacy
+ * slice mode is deprecated and will be removed in the next major release.
  * @method valuesBuilder.BuiltQuery#slice
  * @since 1.0
- * @param {number} start - the one-based position within the
- * result set of the first tuple.
- * @param {number} length - the number of tuples in the slice.
+ * @param {number} start - in array slice mode, the zero-based position
+ * within the result set of the first tuple; in legacy slice mode, the
+ * one-based position within the result set of the first tuple or 0 to
+ * suppress the tuples and return only the summary
+ * @param {number} length - in array slice mode, the zero-based position
+ * of the tuple after the last document in the slice or 0 to suppress
+ * the documents and return only the summary; in legacy slice mode, the
+ * number of tuples in the slice
  * @param {transform} [transform] - a transform to apply to the
  * slice on the server as specified by the {@link valuesBuilder#transform}
- * function.
+ * function
  * @returns {valuesBuilder.BuiltQuery} a built query
  */
 ValueBuilder.prototype.slice = function valuesSlice() {

package.json

@@ -3,7 +3,7 @@
   "name": "marklogic",
   "description": "The official MarkLogic Node.js client API.",
   "homepage": "http://github.com/marklogic/node-client-api",
-  "version": "2.0.2",
+  "version": "2.0.3",
   "license": "Apache-2.0",
   "main": "./lib/marklogic.js",
   "keywords": [

test-complete/data/geo/Prime-Meridian-json.json

@@ -7,7 +7,7 @@
 "line-desc":"Json Linestring In Prime-Meridian",
 "line-vertices":"6",
 
-"circle":"@5673.4567 37.463235,0",
+"circle":"@3525 37.463235,0",
 "circle-desc":"Json Circle In Prime-Meridian",
 
 "box":"[30.8456, -10.34634, 40.345, 10.4564]",

test-complete/data/geo/Prime-Meridian.xml

@@ -8,7 +8,7 @@
 <line-desc>Linestring In Prime-Meridian</line-desc>
 <line-vertices>6</line-vertices>
 
-<circle>@5673.4567 37.463235,0</circle>
+<circle>@3525 37.463235,0</circle>
 <circle-desc>Circle In Prime-Meridian</circle-desc>
 
 <box>[30.8456, -10.34634, 40.345, 10.4564]</box>

test-complete/nodejs-documents-extract.js

@@ -26,7 +26,7 @@ var dbAdmin = marklogic.createDatabaseClient(testconfig.restAdminConnection);
 
 describe('Document extract test', function(){
   before(function(done){
-    this.timeout(10000);
+    this.timeout(30000);
     dbWriter.documents.write({
       uri: '/test/query/matchDir/doc1.json',
       collections: ['matchCollection1'],

test-complete/nodejs-documents-patch-2.js

@@ -27,7 +27,7 @@ var dbAdmin = marklogic.createDatabaseClient(testconfig.restAdminConnection);
 
 describe('document patch test 2', function(){
   before(function(done){
-    this.timeout(10000);
+    this.timeout(30000);
 // NOTE: must create a string range index on rangeKey1 and rangeKey2
     dbWriter.documents.write({
       uri: '/test/query/matchDir/doc1.json',

test-complete/nodejs-documents-patch-negative.js

@@ -27,7 +27,7 @@ var dbAdmin = marklogic.createDatabaseClient(testconfig.restAdminConnection);
 
 describe('document patch negative test', function(){
   before(function(done){
-    this.timeout(10000);
+    this.timeout(30000);
 // NOTE: must create a string range index on rangeKey1 and rangeKey2
     dbWriter.documents.write({
       uri: '/test/query/matchDir/doc1.json',

test-complete/nodejs-documents-patch.js

@@ -27,7 +27,7 @@ var dbAdmin = marklogic.createDatabaseClient(testconfig.restAdminConnection);
 
 describe('document patch test', function(){
   before(function(done){
-    this.timeout(6000);
+    this.timeout(30000);
 // NOTE: must create a string range index on rangeKey1 and rangeKey2
     dbWriter.documents.write({
       uri: '/test/patch/doc1.json',

test-complete/nodejs-documents-qbe.js

@@ -26,7 +26,7 @@ var dbAdmin = marklogic.createDatabaseClient(testconfig.restAdminConnection);
 
 describe('Document qbe test', function(){
   before(function(done){
-    this.timeout(10000);
+    this.timeout(30000);
     dbWriter.documents.write({
       uri: '/test/query/matchDir/doc1.json',
       collections: ['matchCollection1'],

test-complete/nodejs-documents-query-geo-region.js

@@ -113,7 +113,7 @@ var geoDataFiles = [
 
 describe('Document geo query test', function(){
   before(function(done){
-    this.timeout(10000);
+    this.timeout(30000);
     dbWriter.documents.write(geoDataFiles).
     result(function(response){done();})
     .catch(done);
@@ -314,13 +314,11 @@ describe('Document geo query test', function(){
     ).
     result(function(response) {
       //console.log(JSON.stringify(response, null, 2));
-      response.length.should.equal(6);
+      response.length.should.equal(4);
       response[0].uri.should.equal('/geo/region/test/South-More-json.json');
       response[1].uri.should.equal('/geo/region/test/Equator.xml');
       response[2].uri.should.equal('/geo/region/test/Equator-json.json');
       response[3].uri.should.equal('/geo/region/test/South-More.xml');
-      response[4].uri.should.equal('/geo/region/test/Prime-Meridian.xml');
-      response[5].uri.should.equal('/geo/region/test/Prime-Meridian-json.json');
       done();
     }, done);
   });
@@ -451,11 +449,9 @@ describe('Document geo query test', function(){
     ).
     result(function(response) {
       //console.log(JSON.stringify(response, null, 2));
-      response.length.should.equal(4);
-      response[0].uri.should.equal('/geo/region/test/Tropic-of-Capricorn-json.json');
-      response[1].uri.should.equal('/geo/region/test/Tropic-of-Cancer-json.json');
-      response[2].uri.should.equal('/geo/region/test/Tropic-of-Capricorn.xml');
-      response[3].uri.should.equal('/geo/region/test/Tropic-of-Cancer.xml');
+      response.length.should.equal(8);
+      response[0].uri.should.equal('/geo/region/test/International-Date-Line.xml');
+      response[7].uri.should.equal('/geo/region/test/North-West.xml');
       done();
     }, done);
   });
@@ -557,7 +553,7 @@ describe('Document geo query test', function(){
       done();
     }, function(error) {
       //console.log(JSON.stringify(error, null, 2));
-      error.body.errorResponse.message.should.containEql('XDMP-OPERATION');
+      error.body.errorResponse.message.should.containEql('XDMP-INVGEOOP');
       done();
     });
   });