oracledb 5.5.0 → 6.0.0

package/package/install.js

@@ -1,17 +1,24 @@
-/* Copyright (c) 2017, 2022, Oracle and/or its affiliates. */
+/* Copyright (c) 2017, 2023, Oracle and/or its affiliates. */
 
 /******************************************************************************
  *
- * You may not use the identified files except in compliance with the Apache
- * License, Version 2.0 (the "License.")
+ * This software is dual-licensed to you under the Universal Permissive License
+ * (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl and Apache License
+ * 2.0 as shown at https://www.apache.org/licenses/LICENSE-2.0. You may choose
+ * either license.
  *
+ * If you elect to accept the software under the Apache License, Version 2.0,
+ * the following applies:
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with 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.
+ *    https://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.
  *
@@ -20,10 +27,12 @@
  *
  * DESCRIPTION
  *   This script is included in the npm bundle of node-oracledb.  It
- *   is invoked by package.json during npm install.
+ *   is invoked by package.json during npm install to check the viability
+ *   of the installation.
  *
  * MAINTENANCE NOTES
- *   This file should only ever 'require' packages included in core Node.js.
+ *   This file should only ever 'require' packages included in core Node.js
+ *   or that are part of node-oracledb.
  *
  *****************************************************************************/
 
@@ -31,6 +40,12 @@
 
 const fs = require('fs');
 const nodbUtil = require('../lib/util.js');
+const errors = require('../lib/errors.js');
+const constants = require('../lib/constants.js');
+
+let installUrl = constants.DEFAULT_ERROR_URL;
+let arch;
+let thickModeErrMsg;
 
 // Log standard output with an 'oracledb' prefix
 function log(message) { // eslint-disable-line
@@ -46,67 +61,77 @@ function error(message) { // eslint-disable-line
   console.error.apply(console, args);
 }
 
-// Print concluding messages and quit
-function done(err) {
-  let installUrl = 'https://oracle.github.io/node-oracledb/INSTALL.html';
+// Log warnings. It combines 'oracledb' with a stylized 'WARN' prefix
+function warn(message) { // eslint-disable-line
+  const args = Array.from(arguments);
+  args.unshift('oracledb \x1b[31mWARN!\x1b[0m');
+  console.error.apply(console, args);
+}
 
-  if (err) { // Couldn't install the binary
-    error(err.message);
-    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;
+// This version of node-oracledb works with Node.js 14.6 or later.
+// Note: the checked version is the minimum required for Node-API
+// compatibility.  When new Node.js versions are released, older Node.js
+// versions are dropped from the node-oracledb test plan.
+//
+// Keep this code in sync with lib/oracledb.js
+function checkVersion() {
+  const vs = process.version.substring(1).split(".").map(Number);
+  errors.assert(vs[0] > 14 || (vs[0] === 14 && vs[1] >= 6),
+    errors.ERR_NODE_TOO_OLD, nodbUtil.PACKAGE_JSON_VERSION, "14.6");
+}
 
-    if (process.arch === 'x64') {
-      arch = '64-bit';
-    } else {
-      arch = '32-bit';
-    }
+// Check for the binary node-oracledb module needed for "Thick mode".
+// If one isn't available, only Thin mode can be used.
+function checkThickMode() {
+  try {
+    fs.statSync(nodbUtil.RELEASE_DIR + '/' + nodbUtil.BINARY_FILE);
+  } catch (err) {
+    errors.throwErr(errors.ERR_NO_BINARY_AVAILABLE, process.platform + ' ' + process.arch);
+  }
+}
 
-    if (process.platform === 'linux') {
-      installUrl += '#linuxinstall';
-    } else if (process.platform === 'darwin') {
-      installUrl += '#instosx';
-    } else if (process.platform === 'win32') {
-      installUrl += '#windowsinstallation';
-    }
+try {
+  checkVersion();
+} catch (err) {
+  // This version of Node.js is too old
+  error(err.message);
+  error('An older node-oracledb version may work with Node.js ' + process.version);
+  process.exit(87);
+}
 
-    log('********************************************************************************');
-    log('** Node-oracledb ' + nodbUtil.PACKAGE_JSON_VERSION + ' installed in Node.js ' + process.versions.node + ' (' + process.platform + ', ' + process.arch + ')');
-    log('**');
-    log('** To use node-oracledb:');
-    log('** - Oracle Client libraries (' + arch + ') must be available.');
-    log('** - Follow the installation instructions:');
-    log('**   ' + installUrl);
-    log('********************************************************************************\n');
-  }
+try {
+  checkThickMode();
+} catch (err) {
+  // No Thick mode binary was found for this platform
+  thickModeErrMsg = err.message;
 }
 
-// Check for a usable binary file for the node-oracledb module.  Node.js 8.16
-// and 10.16 (and 12.0) contain an important Node-API performance regression fix.
-// Note that the checked versions are the minimum required for Node-API
-// compatibility; as new Node.js versions are released, older Node.js versions
-// are dropped from the node-oracledb test plan.  For example, the obsolete
-// Node.js 9 and 11 versions are not tested.
+// Successfully installed
 
-function checkAvailable(cb) {
-  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)));
-    }
-  }
+if (process.arch === 'x64' || process.arch === 'arm64') {
+  arch = '64-bit';
+} else {
+  arch = '32-bit';
+}
+
+if (process.platform === 'linux') {
+  installUrl += '#node-oracledb-installation-on-linux';
+} else if (process.platform === 'darwin') {
+  installUrl += '#node-oracledb-installation-on-apple-macos-intel-x86';
+} else if (process.platform === 'win32') {
+  installUrl += '#node-oracledb-installation-on-microsoft-windowsstallation';
 }
 
-checkAvailable(done);
+log('********************************************************************************');
+log('** Node-oracledb ' + nodbUtil.PACKAGE_JSON_VERSION + ' installed in Node.js ' + process.versions.node + ' (' + process.platform + ', ' + process.arch + ')');
+log('** To use node-oracledb in Thin mode, no additional steps are needed.');
+if (thickModeErrMsg) {
+  warn(thickModeErrMsg);
+  warn('If you want to use the optional Thick mode, compile node-oracledb code using');
+  warn(installUrl + '#github');
+} else {
+  log('** To use the optional Thick mode, the Oracle Client libraries (' + arch + ')');
+  log('** must be available, see the installation instructions:');
+  log('**   ' + installUrl);
+}
+log('********************************************************************************\n');

package/package/prunebinaries.js

@@ -1,17 +1,24 @@
-/* Copyright (c) 2019, 2022, Oracle and/or its affiliates. */
+/* Copyright (c) 2019, 2023, Oracle and/or its affiliates. */
 
 /******************************************************************************
  *
- * You may not use the identified files except in compliance with the Apache
- * License, Version 2.0 (the "License.")
+ * This software is dual-licensed to you under the Universal Permissive License
+ * (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl and Apache License
+ * 2.0 as shown at https://www.apache.org/licenses/LICENSE-2.0. You may choose
+ * either license.
  *
+ * If you elect to accept the software under the Apache License, Version 2.0,
+ * the following applies:
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with 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.
+ *    https://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.
  *
@@ -25,7 +32,11 @@
  * USAGE
  *   Invoke this from the top level directory.
  *   After an 'npm install oracledb' installs pre-built binaries, this file
- *   can be run with 'npm run prune'.
+ *   can be run with 'npm run prune [all]'.
+ *   'npm run prune' will keep only the binary files for the platform where
+ *   the application using node-oracledb is being run.
+ *   Passing the optional 'all' parameter deletes all binary files, so that
+ *   only Thin mode will be available.
  *
  *****************************************************************************/
 
@@ -34,17 +45,54 @@
 const fs = require('fs');
 const nodbUtil = require('../lib/util.js');
 
-const dir = nodbUtil.RELEASE_DIR;
+const dir = nodbUtil.RELEASE_DIR; // contains the binaries
 
 let re = new RegExp(nodbUtil.BINARY_FILE);
 
 try {
   let f = fs.readdirSync(dir);
-  for (let i = 0; i < f.length; i++) {
-    if (!f[i].match(re) && (f[i].match(/oracledb.*\.node(-buildinfo.txt)*/))) {
-      fs.unlinkSync(dir + '/' + f[i]);
+  let opt = process.argv[2];
+
+  if (opt) {
+    // 'npm run prune <option>' is called
+    if (opt.toLowerCase() === 'all') {
+      // Remove all the binaries in nodbUtil.RELEASE_DIR
+      for (let i = 0; i < f.length; i++) {
+        removeFileorDir(dir + '/' + f[i]);
+      }
+    } else {
+      // Invalid option
+      throw new Error('Invalid Command option: ' + `'${opt}'. Usage 'npm run prune [all]'`);
+    }
+  } else {
+    // 'npm run prune' is called
+    for (let i = 0; i < f.length; i++) {
+      if (!f[i].match(re) && (f[i].match(/oracledb.*\.node(-buildinfo.txt)*/))) {
+        fs.unlinkSync(dir + '/' + f[i]);
+      }
     }
   }
 } catch (err) {
   console.error(err.message);
 }
+
+async function removeFileorDir(fileOrDirPath) {
+  try {
+    const isDir = fs.statSync(fileOrDirPath).isDirectory();
+    if (isDir) {
+      // Remove the directory and its files recursively
+      // Use fs.promises for Node.js versions 14.6-14.13,
+      // which do not support fs.rmSync()
+      const vs = process.version.substring(1).split(".").map(Number);
+      if (vs[0] > 14 || (vs[0] === 14 && vs[1] >= 14))
+        fs.rmSync(fileOrDirPath, { recursive: true, force: true });
+      else
+        await fs.promises.rmdir(fileOrDirPath, { recursive: true, force: true });
+    } else {
+      // Remove the file or the symlink synchronously
+      fs.unlinkSync(fileOrDirPath);
+    }
+  } catch (err) {
+    throw new Error('Invalid File or Directory: ' + `'${fileOrDirPath}'`);
+  }
+}

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "oracledb",
-  "version": "5.5.0",
+  "version": "6.0.0",
   "description": "A Node.js module for Oracle Database access from JavaScript and TypeScript",
-  "license": "Apache-2.0",
+  "license": "(Apache-2.0 OR UPL-1.0)",
   "homepage": "http://oracle.github.io/node-oracledb/",
   "keywords": [
     "Oracle",
@@ -34,7 +34,7 @@
     "prune": "node package/prunebinaries.js"
   },
   "engines": {
-    "node": ">=10.16"
+    "node": ">=14.6"
   },
   "maintainers": [
     {

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

@@ -1 +0,0 @@
-oracledb-5.5.0-darwin-x64.node v18.8.0 6bbe60772e67967e524cedb23c8e501fd8d18cf0 1b40d66d5375522445b9a05a2243317057ef11c3 Wed, 07 Sep 2022 08:36:54 GMT

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

@@ -1 +0,0 @@
-oracledb-5.5.0-linux-x64.node v10.23.1 6bbe60772e67967e524cedb23c8e501fd8d18cf0 1b40d66d5375522445b9a05a2243317057ef11c3 Wed, 07 Sep 2022 08:40:30 GMT

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

@@ -1 +0,0 @@
-oracledb-5.5.0-win32-x64.node v18.8.0 77dd8c6c2822588ae3996f1c810f97bcab25b954 1b40d66d5375522445b9a05a2243317057ef11c3 Wed, 07 Sep 2022 07:01:17 GMT