Merge pull request #840 from marklogic/develop

merge develop 3.3.1 into master
marklogic · Feb 2, 2024 · f28ce95 · f28ce95
2 parents f004f8c + 41cd209
commit f28ce95
Show file tree

Hide file tree

Showing 17 changed files with 87 additions and 111 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## 3.3.1
+#### Bug Fix
+
+- Fixed a bug where a database property caused a problem when creating a URL path for querying ML.
+
 ## 3.3.0
 #### New Functionality
 

diff --git a/Jenkinsfile b/Jenkinsfile
@@ -4,8 +4,9 @@ def runTests(String type,String version){
     copyRPM type,version
     setUpML '$WORKSPACE/xdmp/src/Mark*.rpm'
     sh '''
-        export JAVA_HOME=/home/builder/java/openjdk-1.8.0-262
-        export PATH=${NODE_HOME_DIR}/bin:$PATH
+        export JAVA_HOME=$JAVA_HOME_DIR
+        export GRADLE_USER_HOME=$WORKSPACE/$GRADLE_DIR
+        export PATH=$JAVA_HOME/bin:$GRADLE_USER_HOME:${NODE_HOME_DIR}/bin:$PATH
         cd node-client-api
         node --version
         npm --version
@@ -84,6 +85,8 @@ pipeline{
           NODE_HOME_DIR= "/home/builder/nodeJs/node-v18.14.0-linux-x64"
           DMC_USER     = credentials('MLBUILD_USER')
           DMC_PASSWORD = credentials('MLBUILD_PASSWORD')
+          GRADLE_DIR=".gradle"
+          JAVA_HOME_DIR="/home/builder/java/openjdk-1.8.0-262"
     }
     stages{
         stage('runtests-11.1.0'){

diff --git a/README.md b/README.md
@@ -80,11 +80,8 @@ db.createCollection(
 ### Resources
 
 * [Node.js Client API Documentation](https://docs.marklogic.com/jsdoc/index.html)
-* [Feature Overview of the Node.js Client API](http://developer.marklogic.com/features/node-client-api)
-* [The Node.js Client API in 5 Minutes](https://developer.marklogic.com/learn/node-in-5-minutes)
 * [Node.js Application Developer's Guide](http://docs.marklogic.com/guide/node-dev)
 * [MarkLogic Training for the Node.js Client API](http://www.marklogic.com/training-courses/developing-marklogic-applications-i-node-js/)
-* [MarkLogic On-Demand Courses for Node.js](https://mlu.marklogic.com/ondemand/index.xqy?q=Series%3A%22Node.js%22)
 
 ### Code Examples
 

diff --git a/lib/documents.js b/lib/documents.js
@@ -266,7 +266,7 @@ function probeDocumentsImpl(contentOnly, args) {
     }
   }
 
-  const requestOptions = mlutil.newRequestOptions(this.client.getConnectionParams(), path, '&', 'HEAD');
+  const requestOptions = mlutil.newRequestOptions(this.client.getConnectionParams(), path, 'HEAD');
   mlutil.addTxidHeaders(requestOptions, txid);
 
   var operation = new Operation(
@@ -389,7 +389,7 @@ Documents.prototype.protect = function protectDocument() {
     path += '&archivePath=' + encodeURIComponent(archivePath);
   }
 
-  const requestOptions = mlutil.newRequestOptions(this.client.getConnectionParams(), path, '&', 'POST');
+  const requestOptions = mlutil.newRequestOptions(this.client.getConnectionParams(), path, 'POST');
 
   var operation = new Operation(
       'protect document', this.client, requestOptions, 'empty', 'empty'
@@ -456,7 +456,7 @@ Documents.prototype.wipe = function wipeDocument() {
   path += '&temporal-collection=' + encodeURIComponent(tempColl);
   path += '&result=wiped';
 
-  const requestOptions = mlutil.newRequestOptions(this.client.getConnectionParams(), path, '&', 'DELETE');
+  const requestOptions = mlutil.newRequestOptions(this.client.getConnectionParams(), path, 'DELETE');
 
   var operation = new Operation(
       'wipe document', this.client, requestOptions, 'empty', 'empty'
@@ -522,7 +522,7 @@ Documents.prototype.advanceLsqt = function temporalAdvanceLsqt() {
     path += '&lag=' + encodeURIComponent(lag);
   }
 
-  const requestOptions = mlutil.newRequestOptions(this.client.getConnectionParams(), path, '&', 'POST');
+  const requestOptions = mlutil.newRequestOptions(this.client.getConnectionParams(), path, 'POST');
 
   var operation = new Operation(
       'advance LSQT', this.client, requestOptions, 'empty', 'empty'
@@ -707,7 +707,7 @@ function readDocumentsImpl(contentOnly, args) {
           categories.indexOf('content') === -1
       ));
 
-  const requestOptions = mlutil.newRequestOptions(this.client.getConnectionParams(), path, '&','GET');
+  const requestOptions = mlutil.newRequestOptions(this.client.getConnectionParams(), path, 'GET');
   if (!isSinglePayload) {
     requestOptions.headers = {
         Accept: 'multipart/mixed; boundary='+mlutil.multipartBoundary
@@ -842,18 +842,15 @@ function writeStreamImpl(document, categories) {
   /*jshint validthis:true */
   var endpoint = '/v1/documents';
 
-  var sep = '?';
-
   var txid = getTxid(document);
 
   var writeParams = addWriteParams(document, categories, txid);
   if (writeParams.length > 0) {
     endpoint += writeParams;
-    sep = '&';
   }
 
   var multipartBoundary = mlutil.multipartBoundary;
-  const requestOptions = mlutil.newRequestOptions(this.client.getConnectionParams(), endpoint, sep, 'POST');
+  const requestOptions = mlutil.newRequestOptions(this.client.getConnectionParams(), endpoint, 'POST');
   requestOptions.headers = {
       'Content-Type': 'multipart/mixed; boundary='+multipartBoundary,
       'Accept': 'application/json'
@@ -1069,7 +1066,7 @@ function writeMetadata(document, categories) {
       'Content-Type': 'application/json'
   };
 
-  const requestOptions     = mlutil.newRequestOptions(this.client.getConnectionParams(), endpoint, '&', 'PUT');
+  const requestOptions     = mlutil.newRequestOptions(this.client.getConnectionParams(), endpoint, 'PUT');
   requestOptions.headers = requestHeaders;
   mlutil.addTxidHeaders(requestOptions, txid);
 
@@ -1189,7 +1186,7 @@ function writeContent(contentOnly, document, requestParams, categories, requestT
     if (sep === '?') { sep = '&'; }
   }
 
-  const requestOptions     = mlutil.newRequestOptions(this.client.getConnectionParams(), endpoint, sep, hasUri ? 'PUT' : 'POST');
+  const requestOptions     = mlutil.newRequestOptions(this.client.getConnectionParams(), endpoint, hasUri ? 'PUT' : 'POST');
   requestOptions.headers = requestHeaders;
   mlutil.addTxidHeaders(requestOptions, txid);
   var operation = new Operation(
@@ -1223,10 +1220,8 @@ function writeDocumentList(contentOnly, documents, requestParams, categories) {
   var txid = getTxid(requestParams);
 
   var writeParams = addWriteParams(requestParams, categories, txid);
-  var sep = '?';
   if (writeParams.length > 0) {
     endpoint += writeParams;
-    sep = '&';
   }
 
   var multipartBoundary = mlutil.multipartBoundary;
@@ -1236,7 +1231,7 @@ function writeDocumentList(contentOnly, documents, requestParams, categories) {
       'Content-Type': 'multipart/mixed; boundary='+multipartBoundary
   };
 
-  const requestOptions     = mlutil.newRequestOptions(this.client.getConnectionParams(), endpoint, sep, 'POST');
+  const requestOptions     = mlutil.newRequestOptions(this.client.getConnectionParams(), endpoint, 'POST');
   requestOptions.headers = requestHeaders;
   mlutil.addTxidHeaders(requestOptions, txid);
 
@@ -1579,7 +1574,7 @@ function removeDocumentImpl(contentOnly, args) {
     }
   }
 
-  const requestOptions = mlutil.newRequestOptions(this.client.getConnectionParams(), path, '&','DELETE');
+  const requestOptions = mlutil.newRequestOptions(this.client.getConnectionParams(), path, 'DELETE');
   if (versionId != null) {
     requestOptions.headers = {
         'If-Match': versionId
@@ -1692,7 +1687,7 @@ function removeAllDocumentsImpl(contentOnly, params) {
     }
   }
 
-  const requestOptions = mlutil.newRequestOptions(this.client.getConnectionParams(), endpoint, sep, 'DELETE');
+  const requestOptions = mlutil.newRequestOptions(this.client.getConnectionParams(), endpoint, 'DELETE');
   mlutil.addTxidHeaders(requestOptions, txid);
 
   var operation = new Operation(
@@ -1871,7 +1866,7 @@ function queryDocumentsImpl(collectionParam, contentOnly, builtQuery, timestamp,
     }
   }
 
-  const requestOptions = mlutil.newRequestOptions(this.client.getConnectionParams(), endpoint, '&', 'POST');
+  const requestOptions = mlutil.newRequestOptions(this.client.getConnectionParams(), endpoint, 'POST');
   requestOptions.headers = {
       'Content-Type': (isMultipart ?
           'multipart/mixed; boundary='+multipartBoundary :
@@ -2068,7 +2063,7 @@ Documents.prototype.patch = function patchDocuments() {
     patchBody.pathlang = pathlang;
   }
 
-  const requestOptions = mlutil.newRequestOptions(this.client.getConnectionParams(), endpoint, '&', 'POST');
+  const requestOptions = mlutil.newRequestOptions(this.client.getConnectionParams(), endpoint, 'POST');
   requestOptions.headers = {
       'Content-Type':
         ((format === 'xml') ? 'application/xml' : 'application/json'),
@@ -2194,7 +2189,7 @@ Documents.prototype.suggest = function suggestDocuments() {
     endpoint += '&limit=' + limit;
   }
 
-  const requestOptions = mlutil.newRequestOptions(this.client.getConnectionParams(), endpoint, '&', 'POST');
+  const requestOptions = mlutil.newRequestOptions(this.client.getConnectionParams(), endpoint, 'POST');
   requestOptions.headers = {
       'Content-Type': 'application/json',
       'Accept':       'application/json',
@@ -2242,7 +2237,7 @@ function writeAllDocumentsImpl(inputStream,jobOptions) {
 
   let path = '/v1/internal/forestinfo';
   let connectionParams = this.client.getConnectionParams();
-  const requestOptions = mlutil.newRequestOptions(connectionParams, path, '&','GET');
+  const requestOptions = mlutil.newRequestOptions(connectionParams, path, 'GET');
 
   requestOptions.headers = {
     'Accept':       'application/json',
@@ -2493,7 +2488,7 @@ function queryAllDocumentsImpl(query, jobOptions) {
    }
 
   let path = '/v1/internal/forestinfo';
-  const requestOptions = mlutil.newRequestOptions(this.client.getConnectionParams(), path, '&', 'POST');
+  const requestOptions = mlutil.newRequestOptions(this.client.getConnectionParams(), path, 'POST');
   let wrapper = {ctsast: bldrbase.exportArg(query.whereClause)};
 
   requestOptions.headers = {
@@ -2755,7 +2750,7 @@ Documents.prototype.readAll = function readAllDocuments(stream, options) {
 function readAllDocumentsImpl(inputStream, jobOptions) {
 
   let path = '/v1/internal/forestinfo';
-  const requestOptions = mlutil.newRequestOptions(this.client.getConnectionParams(), path, '&', 'GET');
+  const requestOptions = mlutil.newRequestOptions(this.client.getConnectionParams(), path, 'GET');
 
   requestOptions.headers = {
     'Accept':       'application/json',
@@ -3335,7 +3330,7 @@ Documents.prototype.transformAll = function transformAllDocuments(stream, option
 
 function transformAllDocumentsImpl(inputStream, jobOptions){
   let path = '/v1/internal/forestinfo';
-  const requestOptions = mlutil.newRequestOptions(this.client.getConnectionParams(), path, '&', 'GET');
+  const requestOptions = mlutil.newRequestOptions(this.client.getConnectionParams(), path, 'GET');
 
   requestOptions.headers = {
     'Accept':       'application/json',
@@ -3439,7 +3434,7 @@ function onTransformAllInit(output) {
 
   jobState.endpoint = endpoint;
 
-  const requestOptions = mlutil.newRequestOptions(jobState.docInstance.client.getConnectionParams(), jobState.endpoint, '&', 'POST');
+  const requestOptions = mlutil.newRequestOptions(jobState.docInstance.client.getConnectionParams(), jobState.endpoint, 'POST');
   requestOptions.headers = {
     'Accept':       'text/uri-list',
     'Content-Type': 'text/uri-list'
@@ -3747,7 +3742,7 @@ Documents.prototype.removeAllUris = function removeAllUrisDocuments(stream, opti
 
 function removeAllUrisDocumentsImpl(inputStream, jobOptions){
   let path = '/v1/internal/forestinfo';
-  const requestOptions = mlutil.newRequestOptions(this.client.getConnectionParams(), path, '&', 'GET');
+  const requestOptions = mlutil.newRequestOptions(this.client.getConnectionParams(), path, 'GET');
 
   requestOptions.headers = {
     'Accept':       'application/json',

diff --git a/lib/endpoint-proxy.js b/lib/endpoint-proxy.js
@@ -33,7 +33,7 @@ function emptyRequest(client, funcdef, args) {
   }
 
   const outputTransform = specifyOutputTransform(funcdef, requestHeaders);
-  const requestOptions = mlutil.newRequestOptions(client.getConnectionParams(), endpoint, '?', 'POST');
+  const requestOptions = mlutil.newRequestOptions(client.getConnectionParams(), endpoint, 'POST');
   requestOptions.headers = requestHeaders;
 
   const operation = new Operation(
@@ -52,7 +52,7 @@ function multiAtomicRequest(client, funcdef, args) {
 
   checkArgNames(funcdef, args, requestHeaders);
 
-  const requestOptions = mlutil.newRequestOptions(client.getConnectionParams(), endpoint, '?', 'POST');
+  const requestOptions = mlutil.newRequestOptions(client.getConnectionParams(), endpoint, 'POST');
   requestOptions.headers = requestHeaders;
 
   const operation = new Operation(
@@ -92,7 +92,7 @@ function multiNodeRequest(client, funcdef, args) {
 
   checkArgNames(funcdef, args, requestHeaders);
 
-  const requestOptions = mlutil.newRequestOptions(client.getConnectionParams(), endpoint, '?', 'POST');
+  const requestOptions = mlutil.newRequestOptions(client.getConnectionParams(), endpoint, 'POST');
   requestOptions.headers = requestHeaders;
 
   const operation = new Operation(

diff --git a/lib/graphs.js b/lib/graphs.js
@@ -181,7 +181,7 @@ Graphs.prototype.read = function readGraph() {
     }
   }
 
-  const requestOptions = mlutil.newRequestOptions(this.client.getConnectionParams(), endpoint, '&', 'GET');
+  const requestOptions = mlutil.newRequestOptions(this.client.getConnectionParams(), endpoint, 'GET');
   requestOptions.headers = {
       'Accept': contentType
   };
@@ -373,7 +373,7 @@ function changeGraph(action, isStreaming, args) {
     if (sep === '?') { sep = '&'; }
   }
 
-  const requestOptions = mlutil.newRequestOptions(this.client.getConnectionParams(), endpoint, sep, ((action === 'write') ? 'PUT' : 'POST'));
+  const requestOptions = mlutil.newRequestOptions(this.client.getConnectionParams(), endpoint, ((action === 'write') ? 'PUT' : 'POST'));
   requestOptions.headers = {
       'Content-Type': contentType
   };
@@ -477,7 +477,7 @@ function applyGraph(action, args) {
     if (sep === '?') { sep = '&'; }
   }
 
-  const requestOptions = mlutil.newRequestOptions(this.client.getConnectionParams(), endpoint, sep, ((action === 'remove') ? 'DELETE' : 'HEAD'));
+  const requestOptions = mlutil.newRequestOptions(this.client.getConnectionParams(), endpoint, ((action === 'remove') ? 'DELETE' : 'HEAD'));
 
   var operation = new Operation(
       action+' graph', this.client, requestOptions, 'empty', 'empty'
@@ -561,7 +561,7 @@ Graphs.prototype.list = function listGraphs() {
     }
   }
 
-  const requestOptions = mlutil.newRequestOptions(this.client.getConnectionParams(), endpoint, sep, 'GET');
+  const requestOptions = mlutil.newRequestOptions(this.client.getConnectionParams(), endpoint, 'GET');
   if (!noContentType) {
     requestOptions.headers = {
         'Accept': contentType
@@ -752,7 +752,7 @@ Graphs.prototype.sparql = function queryGraphSPARQL() {
     queryBody.search.sparql = query;
   }
 
-  const requestOptions = mlutil.newRequestOptions(this.client.getConnectionParams(), endpoint, sep, 'POST');
+  const requestOptions = mlutil.newRequestOptions(this.client.getConnectionParams(), endpoint, 'POST');
   requestOptions.headers = {
       'Content-Type': contentType,
       'Accept':       acceptType
@@ -878,7 +878,7 @@ Graphs.prototype.sparqlUpdate = function updateGraphSPARQL() {
     if (sep === '?') { sep = '&'; }
   }
 
-  const requestOptions = mlutil.newRequestOptions(this.client.getConnectionParams(), endpoint, sep, 'POST');
+  const requestOptions = mlutil.newRequestOptions(this.client.getConnectionParams(), endpoint, 'POST');
   requestOptions.headers = {
       'Content-Type': 'application/sparql-update'
   };

diff --git a/lib/internal.js b/lib/internal.js
@@ -26,7 +26,7 @@ class InternalClass {
         if(!path){
             throw new Error('Path is needed to send request.');
         }
-        let requestOptions = mlutil.newRequestOptions(this.clientObject.getConnectionParams(), path, '?');
+        let requestOptions = mlutil.newRequestOptions(this.clientObject.getConnectionParams(), path);
         if (requestOptionsCallback) {
             requestOptionsCallback(requestOptions);
         }

diff --git a/lib/marklogic.js b/lib/marklogic.js
@@ -392,7 +392,7 @@ MarkLogicClient.prototype.getConnectionParams = function getConnectionParams() {
  *  it contains httpStatusCode and httpStatusMessage properties identifying the failure.
  */
 MarkLogicClient.prototype.checkConnection = function checkConnection() {
-  const requestOptions = mlutil.newRequestOptions(this.connectionParams, '/v1/ping', '?', 'HEAD');
+  const requestOptions = mlutil.newRequestOptions(this.connectionParams, '/v1/ping', 'HEAD');
   var operation = new Operation(
       'test operation', this, requestOptions, 'empty', 'empty'
       );

diff --git a/lib/mlutil.js b/lib/mlutil.js
@@ -152,7 +152,7 @@ function endpointTransform(transform) {
   }
 }
 
-function newRequestOptions(connectionParams, endpoint, separator, method) {
+function newRequestOptions(connectionParams, endpoint, method) {
   const requestOptions = copyProperties(connectionParams);
   let database = connectionParams.database;
   if(connectionParams.basePath) {
@@ -163,7 +163,17 @@ function newRequestOptions(connectionParams, endpoint, separator, method) {
   }
   requestOptions.method = method? method:'GET';
 
-  requestOptions.path = (database == null)? endpoint: (endpoint + separator + 'database=' + encodeURIComponent(database));
+  if (database !== null) {
+    if (endpoint.includes('?')) {
+      if (endpoint.endsWith('?')) {
+        requestOptions.path = (database == null) ? endpoint : (endpoint + 'database=' + encodeURIComponent(database));
+      } else {
+        requestOptions.path = (database == null) ? endpoint : (endpoint + '&database=' + encodeURIComponent(database));
+      }
+    } else {
+      requestOptions.path = (database == null) ? endpoint : (endpoint + '?database=' + encodeURIComponent(database));
+    }
+  }
   return requestOptions;
 }
 

diff --git a/lib/resources-exec.js b/lib/resources-exec.js
@@ -81,7 +81,7 @@ function makeRequestOptions(client, args) {
     }
   }
 
-  const requestOptions = mlutil.newRequestOptions(client.getConnectionParams(), path, sep);
+  const requestOptions = mlutil.newRequestOptions(client.getConnectionParams(), path);
   mlutil.addTxidHeaders(requestOptions, txid);
 
   return requestOptions;