oracledb 4.1.0 → 4.2.0

package/CHANGELOG.md

@@ -1,5 +1,58 @@
 # Change Log
 
+## node-oracledb v4.2.0 (24 Jan 2020)
+
+- Added support for binding using the node-oracledb [Database Type
+  Constants](https://oracle.github.io/node-oracledb/doc/api.html#oracledbconstantsdbtype)
+  `DB_TYPE_DATE`, `DB_TYPE_CHAR`, `DB_TYPE_NCHAR`, `DB_TYPE_NVARCHAR`,
+  `DB_TYPE_NCLOB`, `DB_TYPE_BINARY_DOUBLE`, `DB_TYPE_BINARY_FLOAT`,
+  `DB_TYPE_BINARY_INTEGER`, `DB_TYPE_TIMESTAMP`, and `DB_TYPE_TIMESTAMP_TZ`.
+
+- Added support for binding using `DB_TYPE_BOOLEAN` (Diego Arce).
+
+- Added support for creating temporary NCLOBS with
+  [`connection.createLob(oracledb.NCLOB)`](https://oracle.github.io/node-oracledb/doc/api.html#connectioncreatelob).
+
+- Added [client initiated
+  connection](https://oracle.github.io/node-oracledb/doc/api.html#consubscribeoptclientinitiated)
+  support for Continuous Query Notification (CQN) and other subscription based
+  notifications.
+
+- Added
+  [`result.lastRowid`](https://oracle.github.io/node-oracledb/doc/api.html#execlastrowid)
+  to `execute()`.  It contains the ROWID of the last row affected by an INSERT,
+  UPDATE, DELETE or MERGE statement.
+
+- Changed the Error object
+  [`offset`](https://oracle.github.io/node-oracledb/doc/api.html#properroffset)
+  to be 32-bit, allowing the
+  [`batchErrors`](https://oracle.github.io/node-oracledb/doc/api.html#executemanyoptbatcherrors)
+  mode of `executeMany()` to show row `offset` values up to (2^32)-1 ([ODPI-C
+  change](https://github.com/oracle/odpi/commit/294d5966cd513d0c29fdeec3bbbdfad376f81d4f)).
+
+- Avoid intermediate conversion from the database national character set to the
+  database character set when querying NCLOB columns as String.
+
+- Fixed various execution failures with Node.js 13.2 due to a Node.js NULL pointer behavior change ([ODPI-C
+  change](https://github.com/oracle/odpi/commit/7693865bb6a98568546aa319cc0fdb9e208cf9d4)).
+
+- Fixed connection pooling so sharded `pool.getConnection()` requests respect
+  `queueTimeout` when `poolMaxPerShard` has been reached.
+
+- Added a directory to the binary module search to help Webpack use, though a
+  copy plugin is still required, see
+  [here](https://github.com/oracle/node-oracledb/issues/1156#issuecomment-571554125).
+
+- Fixed some static code analysis warnings.
+
+- Updated Lob streaming documentation and examples. Applications should use the
+  `end` event (for readable streams) and `finish` event (for writeable streams)
+  instead of the `close` event.  The node-oracledb `lob.close()` method is now
+  deprecated in favor of the more functional Node.js 8 Stream `destroy()`
+  method.
+
+- Test and documentation improvements.
+
 ## node-oracledb v4.1.0 (26 Nov 2019)
 
 - Added end-to-end tracing attributes

package/README.md

@@ -1,9 +1,9 @@
-# node-oracledb version 4.1
+# node-oracledb version 4.2
 
 The node-oracledb add-on for Node.js powers high performance Oracle
 Database applications.
 
-Use node-oracledb 4.1 to connect Node.js 8.16, 10.16, 12, or later, to Oracle Database.
+Use node-oracledb 4.2 to connect Node.js 8.16, 10.16, 12, or later, to Oracle Database.
 Older versions of node-oracledb may work with older versions of Node.js.
 
 Node-oracledb supports basic and advanced features of Oracle Database
@@ -43,7 +43,7 @@ have been made by the community.
 
 ## <a name="license"></a> License
 
-Copyright (c) 2015, 2019, Oracle and/or its affiliates. All rights reserved.
+Copyright (c) 2015, 2020, 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.")

package/build/Release/oracledb-4.2.0-darwin-x64.node-buildinfo.txt

@@ -0,0 +1 @@
+oracledb-4.2.0-darwin-x64.node v12.14.0 da38f81a6d5a455470eeac591d361d840f9d7ff7 3bfc57e44f88465440b046ff70be38097d2d4fd7 Thu, 16 Jan 2020 06:03:53 GMT

package/build/Release/oracledb-4.2.0-linux-x64.node-buildinfo.txt

@@ -0,0 +1 @@
+oracledb-4.2.0-linux-x64.node v10.18.1 da38f81a6d5a455470eeac591d361d840f9d7ff7 3bfc57e44f88465440b046ff70be38097d2d4fd7 Thu, 16 Jan 2020 06:04:31 GMT

package/build/Release/oracledb-4.2.0-win32-x64.node-buildinfo.txt

@@ -0,0 +1 @@
+oracledb-4.2.0-win32-x64.node v13.5.0 da38f81a6d5a455470eeac591d361d840f9d7ff7 3bfc57e44f88465440b046ff70be38097d2d4fd7 Thu, 16 Jan 2020 05:59:23 GMT

package/lib/connection.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved
+// Copyright (c) 2016, 2020, Oracle and/or its affiliates. All rights reserved
 
 //-----------------------------------------------------------------------------
 //
@@ -244,6 +244,8 @@ function createLob(type, createLobCb) { //eslint-disable-line
   const self = this;
 
   nodbUtil.checkAsyncArgs(arguments, 2, 2);
+  nodbUtil.assert(typeof type === 'number', 'NJS-005', 1);
+  nodbUtil.assert(typeof createLobCb === 'function', 'NJS-005', 2);
 
   self._createLob.apply(self, arguments);
 }

package/lib/lob.js

@@ -69,6 +69,18 @@ class Lob {
     this.getData = nodbUtil.promisify(oracledb, getData);
   }
 
+  // called by stream.destroy() and ensures that the LOB is closed if it has
+  // not already been closed (never called directly)
+  _destroy(err, cb) {
+    this._close(function(closeErr) {
+      if (closeErr) {
+        cb(closeErr);
+      } else {
+        cb(err);
+      }
+    });
+  }
+
   // implementation of streaming read; if lob is set to auto-close, the lob is
   // automatically closed within the C++ code when an error occurs or when
   // there are no more bytes to transfer; all that needs to be done in the JS

package/lib/oracledb.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2015, 2019, Oracle and/or its affiliates. All rights reserved
+// Copyright (c) 2015, 2020, Oracle and/or its affiliates. All rights reserved
 
 //-----------------------------------------------------------------------------
 //
@@ -59,7 +59,10 @@ const defaultPoolAlias = 'default';
 const binaryLocations = [
   '../' + nodbUtil.RELEASE_DIR + '/' + nodbUtil.BINARY_FILE,  // pre-built binary
   '../' + nodbUtil.RELEASE_DIR + '/' + 'oracledb.node',       // binary built from source
-  '../build/Debug/oracledb.node'                              // debug binary
+  '../build/Debug/oracledb.node',                             // debug binary
+  // Ease Webpack use, see https://github.com/oracle/node-oracledb/issues/1156
+  './node_modules/oracledb/' + nodbUtil.RELEASE_DIR + '/' + nodbUtil.BINARY_FILE,
+  './node_modules/oracledb/' + nodbUtil.RELEASE_DIR + '/' + 'oracledb.node'
 ];
 
 let oracledbCLib;
@@ -71,7 +74,7 @@ for (let i = 0; i < binaryLocations.length; i++) {
     if (err.code !== 'MODULE_NOT_FOUND' || i == binaryLocations.length - 1) {
       let nodeInfo;
       if (err.code === 'MODULE_NOT_FOUND') {
-        // none of the three binaries could be found
+        // a binary was not found in any of the search directories
         nodeInfo = `\n  Looked for ${binaryLocations.map(x => require('path').resolve(__dirname, x)).join(', ')}\n  ${nodbUtil.getInstallURL()}\n`;
       } else {
         nodeInfo = `\n  Node.js require('oracledb') error was:\n  ${err.message}\n  ${nodbUtil.getInstallHelp()}\n`;
@@ -171,9 +174,22 @@ function createPool(poolAttrs, createPoolCb) {
   // be called by the database when a connection acquired from the pool doesn't
   // have the requested tag
   sessionCallback = poolAttrs.sessionCallback;
+
+  // create an adjusted set of pool attributes to pass to the C layer; the
+  // session callback must be removed if it is a JavaScript function and the
+  // queue timeout is used to specify the maximum amount of time that the C
+  // layer will wait for a connection to be returned; ordinarily since the
+  // JavaScript layer never calls the C layer to get a connection unless one is
+  // known to be available, this should not be needed, but in some cases (such
+  // as when the maximum for a particular shard is specified) this may not be
+  // known, so this prevents an unnecessarily long wait from taking place
+  const adjustedPoolAttrs = Object.defineProperties({},
+    Object.getOwnPropertyDescriptors(poolAttrs));
   if (typeof poolAttrs.sessionCallback === 'function') {
-    poolAttrs = Object.assign({}, poolAttrs);
-    delete poolAttrs.sessionCallback;
+    delete adjustedPoolAttrs.sessionCallback;
+  }
+  if (adjustedPoolAttrs.queueTimeout === undefined) {
+    adjustedPoolAttrs.queueTimeout = self.queueTimeout;
   }
 
   // Need to prevent another call in the same stack from succeeding, otherwise
@@ -183,7 +199,7 @@ function createPool(poolAttrs, createPoolCb) {
     tempUsedPoolAliases[poolAlias] = true;
   }
 
-  self._createPool(poolAttrs, function(err, poolInst) {
+  self._createPool(adjustedPoolAttrs, function(err, poolInst) {
     if (err) {
       // We need to free this up since the creation of the pool failed.
       if (poolAlias) {
@@ -205,7 +221,6 @@ function createPool(poolAttrs, createPoolCb) {
       delete tempUsedPoolAliases[poolAlias];
     }
 
-    poolAttrs.sessionCallback = sessionCallback;
     poolInst._setup(poolAttrs, poolAlias, self);
 
     poolInst.on('_after_close', function() {

package/package/install.js

@@ -81,25 +81,25 @@ function done(err) {
 
     if (process.platform === 'linux') {
       if (process.arch === 'x64') {
-        clientUrl = 'https://www.oracle.com/technetwork/topics/linuxx86-64soft-092277.html';
+        clientUrl = 'https://www.oracle.com/database/technologies/instant-client/linux-x86-64-downloads.html';
       } else {
-        clientUrl = 'https://www.oracle.com/technetwork/topics/linuxsoft-082809.html';
+        clientUrl = 'https://www.oracle.com/database/technologies/instant-client/linux-x86-32-downloads.html';
       }
 
       log('** - Oracle Client libraries (' + arch + ') must be configured with ldconfig or LD_LIBRARY_PATH');
       log('** - To get libraries, install an Instant Client Basic or Basic Light package from');
       log('**   ' + clientUrl);
     } else if (process.platform === 'darwin') {
-      clientUrl = 'https://www.oracle.com/technetwork/topics/intel-macsoft-096467.html';
+      clientUrl = 'https://www.oracle.com/database/technologies/instant-client/macos-intel-x86-downloads.html';
       installUrl = 'https://oracle.github.io/node-oracledb/INSTALL.html#instosx';
 
       log('** - Oracle Instant Client Basic or Basic Light package libraries must be in ~/lib or /usr/local/lib');
       log('**   Download from ' + clientUrl);
     } else if (process.platform === 'win32') {
       if (process.arch === 'x64') {
-        clientUrl = 'https://www.oracle.com/technetwork/topics/winx64soft-089540.html';
+        clientUrl = 'https://www.oracle.com/database/technologies/instant-client/winx64-64-downloads.html';
       } else {
-        clientUrl = 'https://www.oracle.com/technetwork/topics/winsoft-085727.html';
+        clientUrl = 'https://www.oracle.com/database/technologies/instant-client/microsoft-windows-32-downloads.html';
       }
 
       log('** - Oracle Client libraries (' + arch + ') must be in your PATH environment variable');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oracledb",
-  "version": "4.1.0",
+  "version": "4.2.0",
   "description": "A Node.js module for Oracle Database access",
   "license": "Apache-2.0",
   "homepage": "http://oracle.github.io/node-oracledb/",

package/build/Release/oracledb-4.1.0-darwin-x64.node-buildinfo.txt

@@ -1 +0,0 @@
-oracledb-4.1.0-darwin-x64.node v12.13.1 e734ca522dcb428a60cd3cae544b8b26ca9bd1d4 cbdd015ded87785e85b409fcf73aaedbadd0780d Thu, 21 Nov 2019 05:02:32 GMT

package/build/Release/oracledb-4.1.0-linux-x64.node-buildinfo.txt

@@ -1 +0,0 @@
-oracledb-4.1.0-linux-x64.node v10.17.0 e734ca522dcb428a60cd3cae544b8b26ca9bd1d4 cbdd015ded87785e85b409fcf73aaedbadd0780d Thu, 21 Nov 2019 05:10:19 GMT

package/build/Release/oracledb-4.1.0-win32-x64.node-buildinfo.txt

@@ -1 +0,0 @@
-oracledb-4.1.0-win32-x64.node v12.13.0 e734ca522dcb428a60cd3cae544b8b26ca9bd1d4 cbdd015ded87785e85b409fcf73aaedbadd0780d Thu, 21 Nov 2019 05:11:15 GMT