oracledb 3.1.2 → 4.2.0

package/lib/pool.js

@@ -1,34 +1,33 @@
-/* Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved. */
-
-/******************************************************************************
- *
- * 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.
- *
- *****************************************************************************/
+// Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved
+
+//-----------------------------------------------------------------------------
+//
+// 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';
 
-var connection = require('./connection.js');
-var nodbUtil = require('./util.js');
-var getConnectionPromisified;
-var closePromisified;
+const EventEmitter = require('events');
+const nodbUtil = require('./util.js');
+const util = require('util');
 
 // completeConnectionRequest does the actual work of getting a connection from
 // a pool. It's abstracted out so it can be called from getConnection and
 // checkRequestQueue consistently.
 function completeConnectionRequest(config, getConnectionCb) {
-  var self = this;
+  const self = this;
 
   // Incrementing _connectionsOut prior to making the async call to get a connection
   // to prevent other connection requests from exceeding the poolMax.
@@ -53,8 +52,6 @@ function completeConnectionRequest(config, getConnectionCb) {
       return;
     }
 
-    connection.extend(connInst, self._oracledb, self);
-
     connInst.on('_after_close', function() {
       self._connectionsOut -= 1;
       if (self._connectionsOut == 0 && self._closeCb)
@@ -92,9 +89,9 @@ function completeConnectionRequest(config, getConnectionCb) {
 // when requests for connections should be completed and cancels any timeout
 // that may have been associated with the request.
 function checkRequestQueue() {
-  var self = this;
-  var payload;
-  var waitTime;
+  const self = this;
+  let payload;
+  let waitTime;
 
   if (self._connRequestQueue.length === 0 || self._connectionsOut === self.poolMax) {
     return; // no need to do any work
@@ -128,9 +125,9 @@ function checkRequestQueue() {
 // queue for too long. The number of milliseconds can be set via queueTimeout
 // property of the poolAttrs used when creating a pool.
 function onRequestTimeout(timerIdx) {
-  var self = this;
-  var payloadToDequeue = self._connRequestTimersMap[timerIdx];
-  var requestIndex;
+  const self = this;
+  let payloadToDequeue = self._connRequestTimersMap[timerIdx];
+  let requestIndex;
 
   if (payloadToDequeue) {
     if (self._enableStats) {
@@ -143,7 +140,7 @@ function onRequestTimeout(timerIdx) {
     self._connRequestQueue.splice(requestIndex, 1);
     delete self._connRequestTimersMap[timerIdx];
 
-    payloadToDequeue.getConnectionCb(new Error(nodbUtil.getErrorMessage('NJS-040')));
+    payloadToDequeue.getConnectionCb(new Error(nodbUtil.getErrorMessage('NJS-040', self.queueTimeout)));
   }
 }
 
@@ -152,26 +149,25 @@ function onRequestTimeout(timerIdx) {
 // immediately; otherwise, the request will be queued for up to queueTimeout
 // milliseconds.
 function getConnection(a1, a2) {
-  var self = this;
-  var payload;
-  var timeoutHandle;
-  var timerIdx;
-  var poolMax;
-  var getConnectionCb;
-  var options = {};
-
-  nodbUtil.assert(arguments.length >= 1 && arguments.length <= 2, 'NJS-009');
+  const self = this;
+  let payload;
+  let timeoutHandle;
+  let timerIdx;
+  let poolMax;
+  let getConnectionCb;
+  let options = {};
+
+  nodbUtil.checkAsyncArgs(arguments, 1, 2);
   switch (arguments.length) {
     case 1:
       getConnectionCb = a1;
       break;
     case 2:
-      nodbUtil.assert(nodbUtil.isObject(a1), 'NJS-006', 1);
+      nodbUtil.assert(nodbUtil.isObject(a1), 'NJS-005', 1);
       options = a1;
       getConnectionCb = a2;
       break;
   }
-  nodbUtil.assert(typeof getConnectionCb === 'function', 'NJS-006', arguments.length);
 
   if (self.status === self._oracledb.POOL_STATUS_DRAINING) {  // closing soon
     getConnectionCb(new Error(nodbUtil.getErrorMessage('NJS-064')));
@@ -233,28 +229,27 @@ function getConnection(a1, a2) {
   }
 }
 
-getConnectionPromisified = nodbUtil.promisify(getConnection);
 
 function close(a1, a2) {
   const upperLimitTimeout = 2147483647;
-  var self = this;
-  var forceClose;
-  var drainTime;
-  var timeoutCb;
-  var closeCb;
+  const self = this;
+  let forceClose;
+  let drainTime;
+  let timeoutCb;
+  let closeCb;
 
-  nodbUtil.assert(arguments.length === 1 || arguments.length === 2, 'NJS-009');
+  nodbUtil.checkArgCount(arguments, 1, 2);
 
   switch (arguments.length) {
     case 1:
-      nodbUtil.assert(typeof a1 === 'function', 'NJS-006', 1);
+      nodbUtil.assert(typeof a1 === 'function', 'NJS-005', 1);
       closeCb = a1;
       drainTime = 0;
       forceClose = false;
       break;
     case 2:
-      nodbUtil.assert(typeof a1 === 'number', 'NJS-006', 1);
-      nodbUtil.assert(typeof a2 === 'function', 'NJS-006', 2);
+      nodbUtil.assert(typeof a1 === 'number', 'NJS-005', 1);
+      nodbUtil.assert(typeof a2 === 'function', 'NJS-005', 2);
       closeCb = a2;
       forceClose = true;
 
@@ -262,7 +257,10 @@ function close(a1, a2) {
       drainTime = self._connectionsOut === 0 ? 0 : a1 * 1000;  // a1 represents seconds of time
 
       // SetTimeout does not accept numbers greater than a 32-bit signed integer.
-      nodbUtil.assert(drainTime >= 0 && drainTime <= upperLimitTimeout, 'NJS-005', 1);
+      if (drainTime < 0 || isNaN(drainTime) || drainTime > upperLimitTimeout) {
+        closeCb(new Error(nodbUtil.getErrorMessage('NJS-005', 1)));
+        return;
+      }
       break;
   }
 
@@ -279,7 +277,7 @@ function close(a1, a2) {
   self._closeCb = function() {
     self._close({forceClose : forceClose}, function(err) {
       if (!err) {
-        self.status = self._oracledb.POOL_STATUS_CLOSED;
+        self._status = self._oracledb.POOL_STATUS_CLOSED;
         self.emit('_after_close', self);
       }
       self._closeCb = undefined;
@@ -290,7 +288,7 @@ function close(a1, a2) {
   };
 
   if (forceClose) {
-    self.status = self._oracledb.POOL_STATUS_DRAINING;
+    self._status = self._oracledb.POOL_STATUS_DRAINING;
   }
   if (drainTime === 0) {
     self._closeCb();
@@ -300,15 +298,14 @@ function close(a1, a2) {
 
 }
 
-closePromisified = nodbUtil.promisify(close);
 
-// logStats is used to add a hidden method (_logStats) to each pool instance. This
-// provides an easy way to log out the statistics related information that's collected
-// when _enableStats is set to true when creating a pool. This functionality may
-// be altered or enhanced in the future.
+// logStats is used to add a hidden method (_logStats) to each pool instance.
+// This provides an easy way to log out the statistics related information
+// that's collected when _enableStats is set to true when creating a pool. This
+// functionality may be altered or enhanced in the future.
 function logStats() {
-  var self = this;
-  var averageTimeInQueue;
+  const self = this;
+  let averageTimeInQueue;
 
   if (self.status === self._oracledb.POOL_STATUS_CLOSED) {
     throw new Error(nodbUtil.getErrorMessage('NJS-065'));
@@ -357,11 +354,11 @@ function logStats() {
   console.log('...process.env.UV_THREADPOOL_SIZE:', process.env.UV_THREADPOOL_SIZE);
 }
 
-// The extend method is used to extend Pool instances from the C layer with custom
-// properties, methods, and method overrides. References to the original methods are
-// maintained so they can be invoked by the overriding method at the right time.
-function extend(pool, poolAttrs, poolAlias, oracledb) {
-  var queueTimeout;
+// sets up the instance with additional attributes used for logging statistics
+// and managing the connection queue
+function setup(poolAttrs, poolAlias, oracledb) {
+  const self = this;
+  let queueTimeout;
 
   if (typeof poolAttrs.queueTimeout !== 'undefined') {
     queueTimeout = poolAttrs.queueTimeout;
@@ -369,23 +366,15 @@ function extend(pool, poolAttrs, poolAlias, oracledb) {
     queueTimeout = oracledb.queueTimeout;
   }
 
-  nodbUtil.makeEventEmitter(pool);
-
-  // Using Object.defineProperties to add properties to the Pool instance with special
-  // properties, such as enumerable but not writable.
+  // Using Object.defineProperties to add properties to the Pool instance with
+  // special properties, such as enumerable but not writable.
   Object.defineProperties(
-    pool,
+    self,
     {
-      _oracledb: { // storing a reference to the base instance to avoid circular references with require
-        value: oracledb
-      },
       queueTimeout: { // milliseconds a connection request can spend in queue before being failed
         enumerable: true,
         get: function() {
           return queueTimeout;
-        },
-        set: function() {
-          throw new Error(nodbUtil.getErrorMessage('NJS-014', 'queueTimeout'));
         }
       },
       _closeCb: { // performs close when drainTime expires or connections closed
@@ -455,53 +444,50 @@ function extend(pool, poolAttrs, poolAlias, oracledb) {
         value: {},
         writable: true
       },
-      _getConnection: {
-        value: pool.getConnection
+      _status: {  // open/closing/closed
+        value: oracledb.POOL_STATUS_OPEN,
+        writable: true
       },
       poolAlias: {
         enumerable: true,
         get: function() {
           return poolAlias;
-        },
-        set: function() {
-          throw new Error(nodbUtil.getErrorMessage('NJS-014', 'poolAlias'));
         }
       },
-      getConnection: {
-        value: getConnectionPromisified,
-        enumerable: true,
-        writable: true
-      },
-      _close: {
-        value: pool.close
-      },
-      close: {
-        value: closePromisified,
-        enumerable: true,
-        writable: true
-      },
-      terminate: { // alias for close
-        value: closePromisified,
-        enumerable: true,
-        writable: true
-      },
       status: {  // open/closing/closed
-        writable: true,
         enumerable: true,
-        value: oracledb.POOL_STATUS_OPEN
+        get: function() {
+          return this._status;
+        }
       },
       sessionCallback: {  // session callback
         enumerable: true,
         get: function() {
           return poolAttrs.sessionCallback;
-        },
-        set: function() {
-          throw new Error(nodbUtil.getErrorMessage('NJS-014',
-            'sessionCallback'));
         }
       }
     }
   );
 }
 
-module.exports.extend = extend;
+
+class Pool extends EventEmitter {
+
+  _extend(oracledb) {
+    this._oracledb = oracledb;
+    this._setup = setup;
+    this.close = nodbUtil.promisify(oracledb, close);
+    this.getConnection = nodbUtil.promisify(oracledb, getConnection);
+    this.terminate = this.close;
+  }
+
+  // temporary method for determining if an object is a date until
+  // napi_is_date() can be used (when N-API v5 can be used)
+  _isDate(val) {
+    return util.isDate(val);
+  }
+
+}
+
+
+module.exports = Pool;

package/lib/{querystream.js → queryStream.js}

@@ -1,37 +1,34 @@
-/* Copyright (c) 2015, 2018, Oracle and/or its affiliates. All rights reserved. */
-
-/******************************************************************************
- *
- * 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.
- *
- *****************************************************************************/
+// Copyright (c) 2015, 2019, Oracle and/or its affiliates. All rights reserved
+
+//-----------------------------------------------------------------------------
+//
+// 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';
 
-var util = require('util');
-var Readable = require('stream').Readable;
+const util = require('util');
+const Readable = require('stream').Readable;
 
 // This class was originally based on https://github.com/sagiegurari/simple-oracledb/blob/master/lib/resultset-read-stream.js
-function QueryStream(resultSet, oracledb) {
-  var self = this;
+function QueryStream(resultSet) {
+  const self = this;
 
   Object.defineProperties(
     self,
     {
-      _oracledb: { // storing a reference to the base instance to avoid circular references with require
-        value: oracledb
-      },
       _resultSet: {
         value: resultSet,
         writable: true
@@ -70,7 +67,11 @@ function QueryStream(resultSet, oracledb) {
     // Using setImmediate to ensure that end event handlers are processed
     // before the destroy logic is invoked.
     setImmediate(function() {
-      self._destroy(null, function() {});
+      self._destroy(null, function(err) {
+        if (err) {
+          self.emit('error', err);
+        }
+      });
     });
   });
 }
@@ -80,7 +81,7 @@ util.inherits(QueryStream, Readable);
 // The _open method is called by Connection.execute() when the ResultSet is
 // ready.
 QueryStream.prototype._open = function(err, rs) {
-  var self = this;
+  const self = this;
 
   if (err) {
     self.emit('error', err);
@@ -99,7 +100,7 @@ QueryStream.prototype._open = function(err, rs) {
 };
 
 QueryStream.prototype._read = function() {
-  var self = this;
+  const self = this;
 
   if (!self._resultSet) {
     // Still waiting on the ResultSet to be added via _open, add an event listener
@@ -163,7 +164,7 @@ QueryStream.prototype._read = function() {
 // The destroyCallback is only used when _close is invoked by _destroy. In that
 // case, errors are passed back via the callback rather than emitted.
 QueryStream.prototype._close = function(callback) {
-  var self = this;
+  const self = this;
 
   if (self._closed) {
     return;
@@ -213,7 +214,7 @@ QueryStream.prototype._close = function(callback) {
 // pass an error that will be emitted after the ResultSet is closed (provided
 // no other errors occur).
 QueryStream.prototype._destroy = function(userErr, callback) {
-  var self = this;
+  const self = this;
 
   this._close(function(closeErr) {
     // Invoking this callback will signal the end of destroy. If an error is