6.1.0

Author: romanbalayan

README.md

@@ -1,26 +1,27 @@
 # node-oracledb-prebuilt-for-lambda
 
  - This module is forked from the currently un-maintained [node-oracledb-for-lambda](https://github.com/nalbion/node-oracledb-for-lambda).
- - Core oracledb libraries are derived from [node-oracledb](https://github.com/oracle/node-oracledb) v6.0.3
- - 6.0.3: Prebuilt for use with AWS Lambda nodejs18.x Runtime
+ - Core oracledb libraries are derived from [node-oracledb](https://github.com/oracle/node-oracledb) v6.1.0
+ - 6.1.0: Prebuilt for use with AWS Lambda nodejs18.x Runtime
  - Also tested to work with AWS Lambda nodejs14.x, nodejs16.x, and nodejs18.x Runtime
 
 The scripts to reproduce the build process can be found at [node-oracledb-lambda-test](https://github.com/romanbalayan/node-oracledb-lambda-test). 
 
 # Usage
 
 ```bash
-npm install --save oracledb-prebuilt-for-lambda@6.0.3
+npm install --save oracledb-prebuilt-for-lambda@6.1.0
 ```
 
 # Versioning
  - Changed release version to match that of underlying node-oracledb version. 
- - i.e. for release based on oracledb 6.0.3, release will be oracledb-prebuilt-for-lambda@6.0.3
+ - i.e. for release based on oracledb 6.1.0, release will be oracledb-prebuilt-for-lambda@6.1.0
 
 
  # Releases
  | node-oracledb       | oracledb-prebuilt-for-lambda    |
  | ------------------- | ---------- |
+ | 6.1.0               | 6.1.0      |
  | 6.0.3               | 6.0.3      |
  | 6.0.1               | 6.0.1      |
  | 5.5.0               | 5.5.0      |
@@ -35,6 +36,7 @@ npm install --save oracledb-prebuilt-for-lambda@6.0.3
 
 
  # Changelog
+ - v6.1.0: [node-oracledb v6.1.0 changelog](https://node-oracledb.readthedocs.io/en/latest/release_notes.html#node-oracledb-v6-1-0-30-aug-2023)
  - v6.0.3: [node-oracledb v6.0.3 changelog](https://node-oracledb.readthedocs.io/en/latest/release_notes.html#node-oracledb-v6-0-3-12-jul-2023)
  - v6.0.1: [node-oracledb v6.0.1 changelog](https://node-oracledb.readthedocs.io/en/latest/release_notes.html#node-oracledb-v6-0-1-07-jun-2023)
  - v5.5.0: [node-oracledb v5.5.0 changelog](https://github.com/oracle/node-oracledb/blob/main/CHANGELOG.md#node-oracledb-v550-7-sep-2022)

build/Release/oracledb.node

@@ -27,13 +27,14 @@
 'use strict';
 
 const { Buffer } = require('buffer');
-const constants = require('./constants.js');
 const errors = require('./errors.js');
 const nodbUtil = require('./util.js');
 const AqDeqOptions = require('./aqDeqOptions.js');
 const AqEnqOptions = require('./aqEnqOptions.js');
 const AqMessage = require('./aqMessage.js');
 const BaseDbObject = require('./dbObject.js');
+const transformer = require('./transformer.js');
+const types = require('./types.js');
 
 class AqQueue {
 
@@ -47,6 +48,19 @@ class AqQueue {
         value instanceof BaseDbObject);
   }
 
+  //---------------------------------------------------------------------------
+  // _makeMessage()
+  //
+  // For enqOne()/deqOne()/enqMany()/deqMany(), wrap the return value with JS
+  // layer object.
+  //---------------------------------------------------------------------------
+  _makeMessage(msgImpl) {
+    const msg = new AqMessage();
+    msg._impl = msgImpl;
+    msg._payloadTypeClass = this._payloadTypeClass;
+    return msg;
+  }
+
   //---------------------------------------------------------------------------
   // _verifyMessage()
   //
@@ -64,7 +78,7 @@ class AqQueue {
       message = {};
     } else {
       message = {...message};
-      if (this._isPayload(message.payload)) {
+      if (this._isJson || this._isPayload(message.payload)) {
         payload = message.payload;
       } else if (this._payloadTypeClass) {
         payload = new this._payloadTypeClass(message.payload);
@@ -74,7 +88,9 @@ class AqQueue {
     }
 
     // validate payload
-    if (typeof payload === 'string') {
+    if (this._isJson) {
+      message.payload = transformer.transformJsonValue(payload);
+    } else if (typeof payload === 'string') {
       message.payload = Buffer.from(payload);
     } else if (Buffer.isBuffer(payload)) {
       message.payload = payload;
@@ -116,8 +132,17 @@ class AqQueue {
   // Creates the queue and populates some internal attributes.
   //---------------------------------------------------------------------------
   async create(conn, name, options) {
-    if (options.payloadType) {
-      if (typeof options.payloadType == 'string') {
+    if (options.payloadType === types.DB_TYPE_JSON) {
+      this._isJson = true;
+      this._payloadType = types.DB_TYPE_JSON;
+      this._payloadTypeName = "JSON";
+    } else if (options.payloadType === undefined ||
+               options.payloadType === types.DB_TYPE_RAW) {
+      this._payloadType = types.DB_TYPE_RAW;
+      this._payloadTypeName = "RAW";
+    } else {
+      if (typeof options.payloadType === 'string') {
+        // DB Object type
         const cls = await conn._getDbObjectClassForName(options.payloadType);
         this._payloadTypeClass = cls;
         options.payloadType = cls;
@@ -126,14 +151,12 @@ class AqQueue {
           options.payloadType.prototype instanceof BaseDbObject, 2, "payloadType");
         this._payloadTypeClass = options.payloadType;
       }
-      this._payloadType = constants.DB_TYPE_OBJECT;
+      this._payloadType = types.DB_TYPE_OBJECT;
       this._payloadTypeName = this._payloadTypeClass.prototype.name;
-    } else {
-      this._payloadType = constants.DB_TYPE_RAW;
-      this._payloadTypeName = "RAW";
     }
     this._name = name;
-    this._impl = await conn._impl.getQueue(name, options);
+    this._impl = await conn._impl.getQueue(name, this._payloadTypeClass,
+      this._payloadType);
   }
 
   //---------------------------------------------------------------------------
@@ -147,14 +170,7 @@ class AqQueue {
     errors.assertParamValue(Number.isInteger(maxMessages) && maxMessages > 0,
       1);
     const msgImpls = await this._impl.deqMany(maxMessages);
-    const messages = new Array(msgImpls.length);
-    for (let i = 0; i < msgImpls.length; i++) {
-      const msg = new AqMessage();
-      msg._impl = msgImpls[i];
-      msg._payloadTypeClass = this._payloadTypeClass;
-      messages[i] = msg;
-    }
-    return messages;
+    return  msgImpls.map(i => this._makeMessage(i));
   }
 
   //---------------------------------------------------------------------------
@@ -165,12 +181,8 @@ class AqQueue {
   async deqOne() {
     errors.assertArgCount(arguments, 0, 0);
     const msgImpl = await this._impl.deqOne();
-    if (msgImpl) {
-      const msg = new AqMessage();
-      msg._impl = msgImpl;
-      msg._payloadTypeClass = this._payloadTypeClass;
-      return msg;
-    }
+    if (msgImpl)
+      return this._makeMessage(msgImpl);
   }
 
   //---------------------------------------------------------------------------
@@ -200,7 +212,8 @@ class AqQueue {
     for (let i = 0; i < messages.length; i++) {
       verifiedMessages[i] = this._verifyMessage(messages[i]);
     }
-    return await this._impl.enqMany(verifiedMessages);
+    const msgImpls = await this._impl.enqMany(verifiedMessages);
+    return msgImpls.map(i => this._makeMessage(i));
   }
 
   //---------------------------------------------------------------------------
@@ -211,7 +224,8 @@ class AqQueue {
   async enqOne(message) {
     errors.assertArgCount(arguments, 1, 1);
     message = this._verifyMessage(message);
-    return await this._impl.enqOne(message);
+    const msgImpl = await this._impl.enqOne(message);
+    return this._makeMessage(msgImpl);
   }
 
   //---------------------------------------------------------------------------

lib/aqQueue.js

@@ -1039,6 +1039,19 @@ class Connection extends EventEmitter {
     return info;
   }
 
+  //---------------------------------------------------------------------------
+  // instanceName
+  //
+  // Returns the Oracle Database instance name associated with the connection.
+  // This is the equivalent of the SQL expression:
+  // sys_context('userenv', 'instance_name')
+  //---------------------------------------------------------------------------
+  get instanceName() {
+    if (this._impl)
+      return this._impl.getInstanceName();
+    return undefined;
+  }
+
   //---------------------------------------------------------------------------
   // internalName
   //
@@ -1227,7 +1240,7 @@ class Connection extends EventEmitter {
     errors.assertArgCount(arguments, 2, 2);
     errors.assertParamValue(typeof name === 'string', 1);
     errors.assertParamValue(nodbUtil.isObject(options), 2);
-    options = {...options};
+    options = {name: name, ...options};
     errors.assertParamPropUnsignedInt(options, 2, "namespace");
     if (options.namespace === undefined)
       options.namespace = constants.SUBSCR_NAMESPACE_DBCHANGE;
@@ -1253,14 +1266,13 @@ class Connection extends EventEmitter {
     errors.assert(this._impl, errors.ERR_INVALID_CONNECTION);
 
     const inSubscr = _subscriptions.get(name);
-    let outValue = await this._impl.subscribe(inSubscr, options);
+    const outValue = await this._impl.subscribe(inSubscr, options);
     let subscription;
     if (options.namespace === constants.SUBSCR_NAMESPACE_DBCHANGE) {
       subscription = outValue.subscription;
       delete outValue.subscription;
     } else {
       subscription = outValue;
-      outValue = undefined;
     }
     _subscriptions.set(name, subscription);
     return outValue;

lib/connection.js

@@ -116,7 +116,6 @@ const ERR_UNEXPECTED_DATA = 113;
 const ERR_OSON_FIELD_NAME_LIMITATION = 114;
 const ERR_ORACLE_NUMBER_NO_REPR = 115;
 const ERR_UNSUPPORTED_VERIFIER_TYPE = 116;
-const ERR_INVALID_PRIVATE_KEY = 117;
 const ERR_THIN_CONNECTION_ALREADY_CREATED = 118;
 const ERR_UNSUPPORTED_CONVERSION = 119;
 const ERR_FETCH_TYPE_HANDLER_RETURN_VALUE = 120;
@@ -178,7 +177,6 @@ adjustErrorXref.set("OCI-22165", [ERR_INVALID_COLL_INDEX_SET, /index \[([0-9]+)\
 adjustErrorXref.set("ORA-00028", ERR_CONNECTION_CLOSED);
 adjustErrorXref.set("ORA-00600", ERR_CONNECTION_CLOSED);
 adjustErrorXref.set("ORA-24338", ERR_INVALID_REF_CURSOR);
-adjustErrorXref.set("ORA-24422", ERR_POOL_HAS_BUSY_CONNECTIONS);
 adjustErrorXref.set("ORA-25708", ERR_TOKEN_HAS_EXPIRED);
 
 // define mapping for error messages
@@ -355,8 +353,6 @@ messages.set(ERR_ORACLE_NUMBER_NO_REPR,                 // NJS-115
   'value cannot be represented as an Oracle Database number');
 messages.set(ERR_UNSUPPORTED_VERIFIER_TYPE,             // NJS-116
   'password verifier type 0x%s is not supported by node-oracledb in Thin mode');
-messages.set(ERR_INVALID_PRIVATE_KEY,                   // NJS-117
-  'invalid private key. Headers and footers are not allowed');
 messages.set(ERR_THIN_CONNECTION_ALREADY_CREATED,       // NJS-118
   'node-oracledb Thick mode cannot be enabled because a Thin mode connection has already been created');
 messages.set(ERR_UNSUPPORTED_CONVERSION,                // NJS-119
@@ -612,10 +608,19 @@ function transformErr(err, fnOpt) {
     const pos = err.message.indexOf(":");
     if (pos > 0) {
       err.code = err.message.substr(0, pos);
+      /* add Oracle Database Error Help Portal URL for database error
+         messages, but only in thin mode since this is done
+         automatically in thick mode with Oracle Client 23c and higher
+      */
+      const settings = require('./settings.js');
+      if (err.errorNum && settings.thin) {
+        err.message += '\n' + 'Help: https://docs.oracle.com/error-help/db/ora-' +
+          `${err.errorNum.toString().padStart(5, '0')}/`;
+      }
       if (adjustErrorXref.has(err.code)) {
         let args = [];
         let driverErrorNum;
-        let driverErrorInfo = adjustErrorXref.get(err.code);
+        const driverErrorInfo = adjustErrorXref.get(err.code);
         if (typeof driverErrorInfo === 'number') {
           driverErrorNum = driverErrorInfo;
         } else {
@@ -748,7 +753,6 @@ module.exports = {
   ERR_UNEXPECTED_DATA,
   ERR_OSON_FIELD_NAME_LIMITATION,
   ERR_OSON_VERSION_NOT_SUPPORTED,
-  ERR_INVALID_PRIVATE_KEY,
   ERR_THIN_CONNECTION_ALREADY_CREATED,
   ERR_UNSUPPORTED_CONVERSION,
   ERR_FETCH_TYPE_HANDLER_RETURN_VALUE,

lib/errors.js

@@ -226,6 +226,15 @@ class ConnectionImpl {
     errors.throwNotImplemented("getting the external name");
   }
 
+  //---------------------------------------------------------------------------
+  // getInstanceName()
+  //
+  // Returns the Oracle Database instance name associated with the connection.
+  //---------------------------------------------------------------------------
+  getInstanceName() {
+    errors.throwNotImplemented("getting the Oracle Database instance name.");
+  }
+
   //---------------------------------------------------------------------------
   // getInternalName()
   //

lib/impl/connection.js

@@ -111,14 +111,17 @@ class ResultSetImpl {
       if (metadata.dbType === types.DB_TYPE_NUMBER &&
           metadata.fetchType === types.DB_TYPE_NUMBER) {
         converter = (v) => (v === null) ? null : parseFloat(v);
-      } else if (metadata.fetchType === types.DB_TYPE_VARCHAR &&
-          (metadata.dbType === types.DB_TYPE_BINARY_DOUBLE ||
+      } else if (metadata.fetchType === types.DB_TYPE_VARCHAR) {
+        if (metadata.dbType === types.DB_TYPE_BINARY_DOUBLE ||
            metadata.dbType === types.DB_TYPE_BINARY_FLOAT ||
            metadata.dbType === types.DB_TYPE_DATE ||
            metadata.dbType === types.DB_TYPE_TIMESTAMP ||
            metadata.dbType === types.DB_TYPE_TIMESTAMP_LTZ ||
-           metadata.dbType === types.DB_TYPE_TIMESTAMP_TZ)) {
-        converter = (v) => (v === null) ? null : v.toString();
+           metadata.dbType === types.DB_TYPE_TIMESTAMP_TZ) {
+          converter = (v) => (v === null) ? null : v.toString();
+        } else if (metadata.dbType === types.DB_TYPE_RAW) {
+          converter = (v) => (v === null) ? null : v.toString('hex').toUpperCase();
+        }
       }
       if (userConverter && converter) {
         const internalConverter = converter;