oracledb 5.3.0 → 5.4.0

package/lib/connection.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved
+// Copyright (c) 2016, 2022, Oracle and/or its affiliates.
 
 //-----------------------------------------------------------------------------
 //
@@ -172,7 +172,20 @@ async function close(a1) {
     nodbUtil.assert(nodbUtil.isObject(a1), 'NJS-005', 1);
     options = a1;
   }
-  await this._close(options);
+
+  // If already in the process of closing, throw an error instead of doing
+  // a roundtrip
+  if (this._closing) {
+    throw new Error (nodbUtil.getErrorMessage('NJS-003'));
+  }
+
+  this._closing = true;
+  try {
+    await this._close(options);
+  } finally {
+    this._closing = false;
+  }
+
   for (const cls of Object.values(this._dbObjectClasses)) {
     cls.prototype.constructor = Object;
     cls.prototype = null;
@@ -453,7 +466,6 @@ async function tpcRollback(xid) {
 }
 
 
-
 // define class
 class Connection extends EventEmitter {
 
@@ -462,6 +474,7 @@ class Connection extends EventEmitter {
     this._dbObjectClasses = {};
     this._requestQueue = [];
     this._inProgress = false;
+    this._closing = false;
   }
 
   // extend class with promisified functions
@@ -541,6 +554,18 @@ class Connection extends EventEmitter {
     return (this._getSodaDatabase());
   }
 
+  //--------------------------------------------------------------------------
+  //  isHealthy()
+  //    To get the health status of the connection.
+  //  NOTE: if this function returns false, the application must close the
+  //        connection obect.
+  //        This is a synchronous call.
+  //---------------------------------------------------------------------------
+  isHealthy() {
+    return (!this._closing && this._isHealthy());
+  }
+
+
   // The queryStream function is similar to execute except that it immediately
   // returns a QueryStream.
   queryStream(sql, binding, options) {

package/lib/dbObject.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2019, 2021, Oracle and/or its affiliates.  All rights reserved.
+// Copyright (c) 2019, 2022, Oracle and/or its affiliates.
 //
 //----------------------------------------------------------------------------
 //

package/lib/lob.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved
+// Copyright (c) 2016, 2022, Oracle and/or its affiliates.
 
 //-----------------------------------------------------------------------------
 //

package/lib/oracledb.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2015, 2021, Oracle and/or its affiliates. All rights reserved
+// Copyright (c) 2015, 2022, Oracle and/or its affiliates.
 
 //-----------------------------------------------------------------------------
 //
@@ -105,6 +105,7 @@ class OracleDb {
     this.createPool = nodbUtil.callbackify(createPool).bind(_oracledb);
     this.shutdown = nodbUtil.callbackify(shutdown).bind(_oracledb);
     this.startup = nodbUtil.callbackify(startup).bind(_oracledb);
+    this.initOracleClient = this.initOracleClient.bind(_oracledb);
   }
 
   // temporary method for determining if an object is a date until
@@ -198,6 +199,39 @@ async function createPool(poolAttrs) {
     tempUsedPoolAliases[poolAlias] = true;
   }
 
+  if (adjustedPoolAttrs.accessToken !== undefined) {
+    // token and privateKey must be set for token based
+    // authentication
+    if (adjustedPoolAttrs.accessToken.token === undefined ||
+        adjustedPoolAttrs.accessToken.token === '' ||
+        adjustedPoolAttrs.accessToken.privateKey === undefined ||
+        adjustedPoolAttrs.accessToken.privateKey === '') {
+      throw new Error(nodbUtil.getErrorMessage('NJS-084'));
+    }
+
+    // cannot set username or password for token based authentication
+    if (adjustedPoolAttrs.user !== undefined ||
+        adjustedPoolAttrs.password !== undefined) {
+      throw new Error(nodbUtil.getErrorMessage('NJS-084'));
+    }
+
+    // homogeneous and externalAuth must be set to true for token based
+    // authentication
+    if (adjustedPoolAttrs.homogeneous === false ||
+        adjustedPoolAttrs.externalAuth === false) {
+      throw new Error(nodbUtil.getErrorMessage('NJS-085'));
+    }
+
+    adjustedPoolAttrs.token = adjustedPoolAttrs.accessToken.token;
+    adjustedPoolAttrs.privateKey =
+        adjustedPoolAttrs.accessToken.privateKey;
+  }
+
+  if (adjustedPoolAttrs.accessToken === undefined &&
+      adjustedPoolAttrs.accessTokenCallback !== undefined) {
+    throw new Error(nodbUtil.getErrorMessage('NJS-084'));
+  }
+
   try {
     const pool = await this._createPool(adjustedPoolAttrs);
 
@@ -270,6 +304,32 @@ async function getConnection(a1) {
 
   // otherwise, create a new standalone connection
   } else {
+    if (connAttrs.accessToken !== undefined) {
+      // token and privateKey must be set for token based
+      // authentication
+      if (connAttrs.accessToken.token === undefined ||
+          connAttrs.accessToken.token === '' ||
+          connAttrs.accessToken.privateKey === undefined ||
+          connAttrs.accessToken.privateKey === '') {
+        throw new Error(nodbUtil.getErrorMessage('NJS-084'));
+      }
+
+      // cannot set username or password for token based authentication
+      if (connAttrs.user !== undefined ||
+          connAttrs.password !== undefined) {
+        throw new Error(nodbUtil.getErrorMessage('NJS-084'));
+      }
+
+      // externalAuth must be set to true for token based authentication
+      if (connAttrs.externalAuth === false) {
+        throw new Error(nodbUtil.getErrorMessage('NJS-086'));
+      }
+
+      connAttrs.token = connAttrs.accessToken.token;
+      connAttrs.privateKey =
+        connAttrs.accessToken.privateKey;
+    }
+
     try {
       return await this._getConnection(connAttrs);
     } catch (err) {

package/lib/pool.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved
+// Copyright (c) 2016, 2022, Oracle and/or its affiliates.
 
 //-----------------------------------------------------------------------------
 //
@@ -488,6 +488,18 @@ function _setup(poolAttrs, poolAlias, oracledb) {
 }
 
 
+//-----------------------------------------------------------------------------
+// setAccessToken()
+//   set parameters for token based authentication
+//-----------------------------------------------------------------------------
+async function setAccessToken(options) {
+  // check arguments
+  nodbUtil.checkArgCount(arguments, 1, 1);
+  nodbUtil.assert(nodbUtil.isObject(options), 'NJS-005', 1);
+  await this._setAccessToken(options);
+}
+
+
 class Pool extends EventEmitter {
 
   _extend(oracledb) {
@@ -497,6 +509,7 @@ class Pool extends EventEmitter {
     this.close = nodbUtil.callbackify(close);
     this.getConnection = nodbUtil.callbackify(getConnection);
     this.reconfigure = nodbUtil.callbackify(reconfigure);
+    this.setAccessToken = nodbUtil.callbackify(setAccessToken);
     this.logStatistics = logStatistics;
     this.getStatistics = getStatistics;
     this.terminate = this.close;

package/lib/poolStatistics.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved
+// Copyright (c) 2021, 2022, Oracle and/or its affiliates.
 //-----------------------------------------------------------------------------
 //
 // You may not use the identified files except in compliance with the Apache

package/lib/queryStream.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2015, 2020, Oracle and/or its affiliates. All rights reserved
+// Copyright (c) 2015, 2022, Oracle and/or its affiliates.
 
 //-----------------------------------------------------------------------------
 //

package/lib/resultset.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved
+// Copyright (c) 2016, 2022, Oracle and/or its affiliates.
 
 //-----------------------------------------------------------------------------
 //

package/lib/sodaCollection.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2018, 2021, Oracle and/or its affiliates. All rights reserved
+// Copyright (c) 2018, 2022, Oracle and/or its affiliates.
 
 //-----------------------------------------------------------------------------
 //

package/lib/sodaDatabase.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2018, 2021, Oracle and/or its affiliates. All rights reserved
+// Copyright (c) 2018, 2022, Oracle and/or its affiliates.
 
 //-----------------------------------------------------------------------------
 //

package/lib/sodaDocCursor.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2018, 2021, Oracle and/or its affiliates. All rights reserved
+// Copyright (c) 2018, 2022, Oracle and/or its affiliates.
 
 //-----------------------------------------------------------------------------
 //

package/lib/sodaDocument.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2018, 2020, Oracle and/or its affiliates. All rights reserved
+// Copyright (c) 2018, 2022, Oracle and/or its affiliates.
 
 //-----------------------------------------------------------------------------
 //

package/lib/sodaOperation.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2018, 2021, Oracle and/or its affiliates. All rights reserved
+// Copyright (c) 2018, 2022, Oracle and/or its affiliates.
 
 //-----------------------------------------------------------------------------
 //

package/lib/util.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved
+// Copyright (c) 2016, 2022, Oracle and/or its affiliates.
 
 //-----------------------------------------------------------------------------
 //
@@ -66,7 +66,10 @@ const errorMessages = {
   'NJS-076': 'NJS-076: connection request rejected. Pool queue length queueMax %d reached',
   'NJS-081': 'NJS-081: concurrent operations on a connection are disabled',
   'NJS-082': 'NJS-082: connection pool is being reconfigured',
-  'NJS-083': 'NJS-083: pool statistics not enabled'
+  'NJS-083': 'NJS-083: pool statistics not enabled',
+  'NJS-084': 'NJS-084: invalid or missing parameter with token based authentication. The token and privateKey attributes must contain values. Other credentials cannot be specified',
+  'NJS-085': 'NJS-085: invalid connection pool configuration with token based authentication. The homogeneous and externalAuth attributes must be set to true',
+  'NJS-086': 'NJS-086: invalid standalone configuration with token based authentication. The externalAuth attribute must be set to true'
 };
 
 // getInstallURL returns a string with installation URL
@@ -170,12 +173,15 @@ module.exports.checkArgCount = checkArgCount;
 // is resolved or rejected and the callback invoked; otherwise, the function is
 // called unchanged and a promise is returned
 function callbackify(func) {
-  return function() {
+  const wrapper = function() {
 
     // if last argument is not a function, simply invoke the function as usual
     // and a promise will be returned
     if (typeof arguments[arguments.length - 1] !== 'function') {
-      return func.apply(this, arguments);
+      return func.apply(this, arguments).catch(function stackCapture(e) {
+        Error.captureStackTrace(e, stackCapture);
+        throw e;
+      });
     }
 
     // otherwise, resolve or reject the promise and invoke the callback
@@ -186,6 +192,10 @@ function callbackify(func) {
     }, cb);
 
   };
+  if (func.name) {
+    Object.defineProperty(wrapper, 'name', { value: func.name });
+  }
+  return wrapper;
 }
 
 module.exports.callbackify = callbackify;

package/package/install.js

@@ -1,4 +1,4 @@
-/* Copyright (c) 2017, 2021, Oracle and/or its affiliates. All rights reserved. */
+/* Copyright (c) 2017, 2022, Oracle and/or its affiliates. */
 
 /******************************************************************************
  *

package/package/prunebinaries.js

@@ -1,4 +1,4 @@
-/* Copyright (c) 2019, 2021, Oracle and/or its affiliates. All rights reserved. */
+/* Copyright (c) 2019, 2022, Oracle and/or its affiliates. */
 
 /******************************************************************************
  *

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "oracledb",
-  "version": "5.3.0",
-  "description": "A Node.js module for Oracle Database access",
+  "version": "5.4.0",
+  "description": "A Node.js module for Oracle Database access from JavaScript and TypeScript",
   "license": "Apache-2.0",
   "homepage": "http://oracle.github.io/node-oracledb/",
   "keywords": [