oracledb 5.2.0 → 5.5.0

package/lib/poolStatistics.js

@@ -0,0 +1,124 @@
+// Copyright (c) 2021, 2022, Oracle and/or its affiliates.
+//-----------------------------------------------------------------------------
+//
+// You may not use the identified files except in compliance with the Apache
+// License, Version 2.0 (the "License.")
+//
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0.
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+//-----------------------------------------------------------------------------
+
+'use strict';
+
+//-----------------------------------------------------------------------------
+// class PoolStatistics
+//  collection of statistics metrics for Pool object
+//-----------------------------------------------------------------------------
+
+class PoolStatistics {
+
+  constructor(pool) {
+    let averageTimeInQueue = 0;
+
+    if (pool._totalRequestsEnqueued !== 0) {
+      averageTimeInQueue = Math.round(pool._totalTimeInQueue /
+        pool._totalRequestsEnqueued);
+    }
+
+    this.gatheredDate = Date.now ();
+    this.upTime = this.gatheredDate - pool._createdDate;
+    this.upTimeSinceReset = this.gatheredDate - pool._timeOfReset;
+    this.connectionRequests = pool._totalConnectionRequests;
+    this.requestsEnqueued = pool._totalRequestsEnqueued;
+    this.requestsDequeued = pool._totalRequestsDequeued;
+    this.failedRequests = pool._totalFailedRequests;
+    this.rejectedRequests = pool._totalRequestsRejected;
+    this.requestTimeouts = pool._totalRequestTimeouts;
+    this.maximumQueueLength = pool._maximumQueueLength;
+    this.currentQueueLength = pool._connRequestQueue.length;
+    this.timeInQueue = pool._totalTimeInQueue;
+    this.minimumTimeInQueue = pool._minTimeInQueue;
+    this.maximumTimeInQueue = pool._maxTimeInQueue;
+    this.averageTimeInQueue = averageTimeInQueue;
+    this.connectionsInUse = pool.connectionsInUse;
+    this.connectionsOpen = pool.connectionsOpen;
+    this.connectString = pool.connectString;
+    this.edition = pool.edition;
+    this.events = pool.events;
+    this.externalAuth = pool.externalAuth;
+    this.homogeneous = pool.homogeneous;
+    this.poolAlias = pool.poolAlias;
+    this.poolIncrement = pool.poolIncrement;
+    this.poolMax = pool.poolMax;
+    this.poolMaxPerShard = pool.poolMaxPerShard;
+    this.poolMin = pool.poolMin;
+    this.poolPingInterval = pool.poolPingInterval;
+    this.poolTimeout = pool.poolTimeout;
+    this.queueMax = pool.queueMax;
+    this.queueTimeout = pool.queueTimeout;
+    this.sodaMetaDataCache = pool.sodaMetaDataCache;
+    this.stmtCacheSize = pool.stmtCacheSize;
+    this.user = pool.user;
+    this.threadPoolSize = process.env.UV_THREADPOOL_SIZE;
+  }
+
+  //---------------------------------------------------------------------------
+  // logStatistics()
+  //  To print the statistics metrics of the pool
+  //---------------------------------------------------------------------------
+  logStatistics() {
+    console.log('\nPool statistics:');
+    console.log('...gathered at:', new Date(this.gatheredDate).toISOString());
+    console.log('...up time (milliseconds):', this.upTime);
+    console.log('...up time from last reset (milliseconds)',
+      this.upTimeSinceReset);
+    console.log('...connection requests:', this.connectionRequests);
+    console.log('...requests enqueued:', this.requestsEnqueued);
+    console.log('...requests dequeued:', this.requestsDequeued);
+    console.log('...requests failed:', this.failedRequests);
+    console.log('...requests exceeding queueMax:', this.rejectedRequests);
+    console.log('...requests exceeding queueTimeout:', this.requestTimeouts);
+    console.log('...current queue length:', this.currentQueueLength);
+    console.log('...maximum queue length:', this.maximumQueueLength);
+    console.log('...sum of time in queue (milliseconds):', this.timeInQueue);
+    console.log('...minimum time in queue (milliseconds):',
+      this.minimumTimeInQueue);
+    console.log('...maximum time in queue (milliseconds):',
+      this.maximumTimeInQueue);
+    console.log('...average time in queue (milliseconds):',
+      this.averageTimeInQueue);
+    console.log('...pool connections in use:', this.connectionsInUse);
+    console.log('...pool connections open:', this.connectionsOpen);
+    console.log('Pool attributes:');
+    console.log('...connectString:', this.connectString);
+    console.log('...edition:', this.edition);
+    console.log('...events:', this.events);
+    console.log('...externalAuth:', this.externalAuth);
+    console.log('...homogeneous:', this.homogeneous);
+    console.log('...poolAlias:', this.poolAlias);
+    console.log('...poolIncrement:', this.poolIncrement);
+    console.log('...poolMax:', this.poolMax);
+    console.log('...poolMaxPerShard:', this.poolMaxPerShard);
+    console.log('...poolMin:', this.poolMin);
+    console.log('...poolPingInterval (seconds):', this.poolPingInterval);
+    console.log('...poolTimeout (seconds):', this.poolTimeout);
+    console.log('...queueMax:', this.queueMax);
+    console.log('...queueTimeout (milliseconds):', this.queueTimeout);
+    console.log('...sessionCallback:', this.sessionCallback);
+    console.log('...sodaMetaDataCache:', this.sodaMetaDataCache);
+    console.log('...stmtCacheSize:', this.stmtCacheSize);
+    console.log('...user:', this.user);
+    console.log('Related environment variables:');
+    console.log('...UV_THREADPOOL_SIZE:', this.threadPoolSize);
+  }
+}
+
+module.exports = PoolStatistics;

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.
 
 //-----------------------------------------------------------------------------
 //
@@ -89,11 +89,6 @@ class QueryStream extends Readable {
       this._fetching = true;
       this._resultSet._allowGetRowCall = true;
       const row = await this._resultSet.getRow();
-      this._fetching = false;
-      if (!this._resultSet) {
-        this.emit('_doneFetching');
-        return;
-      }
       if (row) {
         this.push(row);
       } else {
@@ -101,6 +96,13 @@ class QueryStream extends Readable {
       }
     } catch (err) {
       this.destroy(err);
+    } finally {
+      this._fetching = false;
+      if (this._resultSet) {
+        this._resultSet._allowGetRowCall = false;
+      } else {
+        this.emit('_doneFetching');
+      }
     }
   }
 

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.
 
 //-----------------------------------------------------------------------------
 //
@@ -225,6 +225,19 @@ class ResultSet {
     return this._connection._getDbObjectClassJS(schema, name);
   }
 
+  [Symbol.asyncIterator]() {
+    const resultSet = this;
+    return {
+      async next() {
+        const row = await resultSet.getRow();
+        return {value: row, done: row === undefined};
+      },
+      return() {
+        return {done: true};
+      }
+    };
+  }
+
   toQueryStream() {
     nodbUtil.checkArgCount(arguments, 0, 0);
 

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,12 @@ 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 access token',
+  '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',
+  'NJS-087': 'NJS-087: access token has expired',
+  'NJS-088': 'NJS-088: accessTokenCallback cannot be specified when accessToken is a function'
 };
 
 // getInstallURL returns a string with installation URL
@@ -170,12 +175,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 +194,10 @@ function callbackify(func) {
     }, cb);
 
   };
+  if (func.name) {
+    Object.defineProperty(wrapper, 'name', { value: func.name });
+  }
+  return wrapper;
 }
 
 module.exports.callbackify = callbackify;
@@ -245,4 +257,13 @@ function isSodaDocument(value) {
   return (value != null && value._sodaDocumentMarker);
 }
 
+function isXid(value) {
+  return (isObject(value) &&
+            (value.formatId !== undefined) &&
+            (value.globalTransactionId !== undefined) &&
+            (value.branchQualifier !== undefined));
+}
+
+module.exports.isXid = isXid;
+
 module.exports.isSodaDocument = isSodaDocument;

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.2.0",
-  "description": "A Node.js module for Oracle Database access",
+  "version": "5.5.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": [