oracledb 3.1.2 → 4.2.0

package/package/README.md

@@ -1,8 +1,8 @@
 # Overview
 
 This directory is used for building the [node-oracledb npm
-package](https://www.npmjs.com/package/oracledb).  The scripts can
-also be used to create custom packages for hosting on a local server.
+package](https://www.npmjs.com/package/oracledb).  The scripts can also be used
+to create a custom package for hosting on a local server.
 
 Most users do not need to use anything in this directory.
 
@@ -10,37 +10,42 @@ Most users do not need to use anything in this directory.
 
 In a clone or copy of the repository:
 
-- `npm run buildbinary` calls `buildbinary.js` to create a binary for
-  the current node-oracledb / Node.js / platform combination.
-
-- `npm run buildpackage` calls `buildpackage.js` to make the
-  node-oracledb package containing the node-oracledb JavaScript files,
-  the available binaries, and a package.json that has an "install"
-  script and a "prune" script.  The package will be created in the top
-  level directory.
-
-  Before executing `npm run buildpackage`, all binaries and related
-  build metadata information files from all node-oracledb / Node.js /
-  platform combinations should be placed in the `package/Staging`
-  directory.
-
-Package installation:
-
-- As part of an `npm install` that uses the created package, the
-  `package.json` install script runs `package/install.js` to check a
-  binary module for the current Node.js and platform is available.
-
-  If a suitable binary is not available, installation will fail.
-  Users must then compile node-oracledb using source code from GitHub,
-  or choose an alternative Node.js / platform that has a pre-built
-  binary module.
-
-- After install, space conscious users can run `npm run prune` which
-  removes pre-built binaries for all other Node.js releases and
-  architectures.
-
-By default the top level `package.json` doesn't have an install script
-target.  This means that node-gyp will be invoked to compile
-node-oracledb.  This allows installation from [source
-code](https://oracle.github.io/node-oracledb/INSTALL.html#github) (via
-GitHub) when no suitable pre-built binary is available.
+- Run `npm run buildbinary`.  This calls `buildbinary.js` to create a
+  node-oracledb binary for the current operating system.  Depending how Node.js
+  was installed, you may need to run `npm install node-gyp -g` first.
+
+  You can run `npm run buildbinary` on each operating system architecture that
+  you want to include in your package.  Copy the node-oracledb binaries and
+  related build metadata information files to the `package/Staging` directory on
+  one machine.
+
+- Run `npm run buildpackage`.  This calls `buildpackage.js` to make the
+  node-oracledb package containing the node-oracledb JavaScript files, the
+  available binaries, and a `package.json` that has `install` and `prune` script
+  targets.  The package will be created in the top level directory.  It can be
+  uploaded to npmjs.com, or to your own local server, and then used as a
+  dependency in your projects.
+
+# Package Installation
+
+- As part of an `npm install` that uses the created package, the `package.json`
+  install script runs `install.js` to check the availability of a binary module
+  for the current Node.js version and operating system architecture.
+
+  If a suitable binary is not available, installation will fail.  Users must
+  then compile node-oracledb using source code from GitHub.  Alternatively a
+  different version of node-oracledb, Node.js, or different operating system may
+  have a suitable pre-built binary available.  See
+  https://github.com/oracle/node-oracledb/releases for information about Node.js
+  versions and pre-built node-oracledb binaries.
+
+- After install, space conscious users can run `npm run prune` which removes
+  pre-built binaries for all other architectures.
+
+The
+[`package.json`](https://github.com/oracle/node-oracledb/blob/master/package.json)
+in GitHub doesn't have an `install` script target by default.  This means that
+node-gyp will be invoked to compile node-oracledb.  This allows installation
+from GitHub [source
+code](https://oracle.github.io/node-oracledb/INSTALL.html#github) when no
+suitable pre-built binary is available.

package/package/install.js

@@ -36,14 +36,6 @@
 const fs = require('fs');
 const nodbUtil = require('../lib/util.js');
 
-let packageJSON;
-try {
-  packageJSON = require('../package.json');
-} catch(err) {
-  throw new Error('package.json is missing');
-}
-const PACKAGE_JSON_VERSION = packageJSON.version;
-
 // Log standard output with an 'oracledb' prefix
 function log(message) { // eslint-disable-line
   const args = Array.from(arguments);
@@ -64,7 +56,11 @@ function done(err) {
 
   if (err) { // Couldn't install the binary
     error(err.message);
-    error('Try compiling node-oracledb source code using ' + installUrl + '#github');
+    if (err.message.match(/^NJS-067/)) {
+      error('Try compiling node-oracledb source code using ' + installUrl + '#github');
+    } else if (err.message.match(/^NJS-069/)) {
+      error('An older node-oracledb version may work with Node.js ' + process.version);
+    }
     process.exit(87);
   } else { // Successfully installed
     let arch;
@@ -78,32 +74,32 @@ function done(err) {
 
     log('********************************************************************************');
 
-    log('** Node-oracledb ' + PACKAGE_JSON_VERSION + ' installed for Node.js ' + process.versions.node + ' (' + process.platform + ', ' + process.arch +')');
+    log('** Node-oracledb ' + nodbUtil.PACKAGE_JSON_VERSION + ' installed for Node.js ' + process.versions.node + ' (' + process.platform + ', ' + process.arch +')');
 
     log('**');
     log('** To use node-oracledb:');
 
     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('** - An Oracle Instant Client Basic or Basic Light package must be in ~/lib or /usr/local/lib');
+      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');
@@ -124,15 +120,25 @@ function done(err) {
   }
 }
 
-// Check there is a usable binary file for the node-oracledb module
+// Check for a usable binary file for the node-oracledb module.
+// Node.js 8.16 and 10.16 (and 12.0) contain an important N-API
+// performance regression fix.  If you're using the obsolete Node.js 9
+// or 11 versions, install will work but you're on your own regarding
+// performance and functionality.
+
 function checkAvailable(cb) {
-  const binaryFile = nodbUtil.RELEASE_DIR + '/' + nodbUtil.BINARY_FILE;
-  try {
-    fs.statSync(binaryFile);
-    cb();
-  } catch (err) {
-    let m = process.version + ' (NODE_MODULE_VERSION=' + process.versions.modules + ') on ' + process.platform + ' ' + process.arch;
-    cb(new Error(nodbUtil.getErrorMessage('NJS-067', m)));
+  let vs = process.version.substring(1).split(".").map(Number);
+  if (vs[0] < 8 || (vs[0] === 8 && vs[1] < 16)) {
+    cb(new Error(nodbUtil.getErrorMessage('NJS-069', nodbUtil.PACKAGE_JSON_VERSION, "8.16")));
+  } else if (vs[0] === 10 && vs[1] < 16) {
+    cb(new Error(nodbUtil.getErrorMessage('NJS-069', nodbUtil.PACKAGE_JSON_VERSION, "10.16")));
+  } else {
+    try {
+      fs.statSync(nodbUtil.RELEASE_DIR + '/' + nodbUtil.BINARY_FILE);
+      cb();
+    } catch (err) {
+      cb(new Error(nodbUtil.getErrorMessage('NJS-067', process.platform + ' ' + process.arch)));
+    }
   }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oracledb",
-  "version": "3.1.2",
+  "version": "4.2.0",
   "description": "A Node.js module for Oracle Database access",
   "license": "Apache-2.0",
   "homepage": "http://oracle.github.io/node-oracledb/",
@@ -33,7 +33,7 @@
     "prune": "node package/prunebinaries.js"
   },
   "engines": {
-    "node": ">=6"
+    "node": ">=8.16"
   },
   "maintainers": [
     {

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

@@ -1 +0,0 @@
-oracledb-abi48-darwin-x64.node v6.16.0 e70199aedd8542402cb2c5f8d75c2f8aa621df76 5768d8f93ef9ba42e8d4a6d701ace16504debc90 Tue, 19 Feb 2019 22:43:26 GMT

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

@@ -1 +0,0 @@
-oracledb-abi48-linux-x64.node v6.16.0 e70199aedd8542402cb2c5f8d75c2f8aa621df76 5768d8f93ef9ba42e8d4a6d701ace16504debc90 Tue, 19 Feb 2019 23:04:20 GMT

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

@@ -1 +0,0 @@
-oracledb-abi48-win32-x64.node v6.16.0 e70199aedd8542402cb2c5f8d75c2f8aa621df76 5768d8f93ef9ba42e8d4a6d701ace16504debc90 Wed, 20 Feb 2019 05:36:36 GMT

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

@@ -1 +0,0 @@
-oracledb-abi57-darwin-x64.node v8.15.0 e70199aedd8542402cb2c5f8d75c2f8aa621df76 5768d8f93ef9ba42e8d4a6d701ace16504debc90 Tue, 19 Feb 2019 22:44:49 GMT

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

@@ -1 +0,0 @@
-oracledb-abi57-linux-x64.node v8.15.0 e70199aedd8542402cb2c5f8d75c2f8aa621df76 5768d8f93ef9ba42e8d4a6d701ace16504debc90 Tue, 19 Feb 2019 23:04:59 GMT

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

@@ -1 +0,0 @@
-oracledb-abi57-win32-x64.node v8.15.0 e70199aedd8542402cb2c5f8d75c2f8aa621df76 5768d8f93ef9ba42e8d4a6d701ace16504debc90 Wed, 20 Feb 2019 05:36:45 GMT

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

@@ -1 +0,0 @@
-oracledb-abi64-darwin-x64.node v10.15.1 e70199aedd8542402cb2c5f8d75c2f8aa621df76 5768d8f93ef9ba42e8d4a6d701ace16504debc90 Tue, 19 Feb 2019 22:45:35 GMT

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

@@ -1 +0,0 @@
-oracledb-abi64-linux-x64.node v10.15.1 e70199aedd8542402cb2c5f8d75c2f8aa621df76 5768d8f93ef9ba42e8d4a6d701ace16504debc90 Tue, 19 Feb 2019 23:06:02 GMT

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

@@ -1 +0,0 @@
-oracledb-abi64-win32-x64.node v10.15.0 e70199aedd8542402cb2c5f8d75c2f8aa621df76 5768d8f93ef9ba42e8d4a6d701ace16504debc90 Wed, 20 Feb 2019 05:36:58 GMT

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

@@ -1 +0,0 @@
-oracledb-abi67-darwin-x64.node v11.10.0 e70199aedd8542402cb2c5f8d75c2f8aa621df76 5768d8f93ef9ba42e8d4a6d701ace16504debc90 Tue, 19 Feb 2019 22:46:26 GMT

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

@@ -1 +0,0 @@
-oracledb-abi67-linux-x64.node v11.10.0 e70199aedd8542402cb2c5f8d75c2f8aa621df76 5768d8f93ef9ba42e8d4a6d701ace16504debc90 Tue, 19 Feb 2019 23:06:38 GMT

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

@@ -1 +0,0 @@
-oracledb-abi67-win32-x64.node v11.10.0 e70199aedd8542402cb2c5f8d75c2f8aa621df76 5768d8f93ef9ba42e8d4a6d701ace16504debc90 Wed, 20 Feb 2019 05:37:10 GMT