Test case and documentation updates

Author: sharadraju

doc/src/release_notes.rst

@@ -15,25 +15,17 @@ Common Changes
     :ref:`iamtokenbasedauthentication`.
 
 #)  Added new property :attr:`connection.instanceName` which provides the
-    Oracle Database instance name associated with the connection. This returns the
-    same value as the SQL expression ``sys_context('userenv', 'instance_name')``.
+    Oracle Database instance name associated with a connection. This returns
+    the same value as the SQL
+    expression ``sys_context('userenv', 'instance_name')``.
 
 #)  Minor code refactoring.
 
+#)  Test case and Documentation updates and improvements.
+
 Thin Mode Changes
 +++++++++++++++++
 
-#)  Fixed bug giving 'ORA-01002 and NJS-112 errors' during LOB columns
-    fetch after table recreation.
-    `Issue #1589 <https://github.com/oracle/node-oracledb/issues/1565>`__.
-
-#)  Fixed bug in handling unexpected pool growth which is crossing pool max limit
-    due to improper handling of parallel connection request.
-    `Issue #1591 <https://github.com/oracle/node-oracledb/issues/1591>`__.
-
-#)  Fixed Bug to return proper error when invalid service name is
-    configured in listener.
-
 #)  Added support for an Oracle Database 23c feature that can improve the
     performance of connection creation by reducing the number of round trips
     required to create the second and subsequent connections to the same
@@ -43,49 +35,59 @@ Thin Mode Changes
     ``oracledb.fetchAsString = [ oracledb.DB_TYPE_RAW ]``.
     `Issue #1586 <https://github.com/oracle/node-oracledb/issues/1586>`__.
 
-#)  Added ``sslAllowWeakDNMatch`` connection attribute and support for
-    ``SSL_WEAK_DN_MATCH``.  If set this enables ``sslServerDNMatch`` /
-    ``SSL_SERVER_DN_MATCH`` to check the database server certificate (but not
-    the listener) and enable the service name to be used for partial DN
-    matching. The search order is: the host name, then the subject alternative
-    name (SAN), and then the service name.
+#)  Added new ``sslAllowWeakDNMatch`` connection attribute and support for
+    ``SSL_WEAK_DN_MATCH`` (An Oracle Database 23c feature). If set, this
+    enables ``sslServerDNMatch`` / ``SSL_SERVER_DN_MATCH`` to check the
+    database server certificate (but not the listener) and enable the service
+    name to be used for partial DN matching. The search order is: the host
+    name, then the subject alternative name (SAN), and then the service name.
 
-#)  Connection Optimization(Internal):
-    When connecting to a host, if the host is found to be unreachable,
-    add that host to a cache(mark it as down). Subsequent requests to get
-    a connection will reorder the list of hosts to attempt making a connection
-    to so that the hosts which are marked as down are at the end of the list.
+#)  Added support to include database error cause/action URLs (introduced from
+    Oracle Database 23c onwards) for ORA error messages.    
 
-#)  Fixed bug when ``sslServerDNMatch`` is set and the connect string is in Easy
-    Connect format but a value for ``SSL_SERVER_DN_MATCH`` is not set in that
-    connect string.
+#)  Added network connection optimization for multiple database hosts.
+    If a host is found to be unreachable during connection, the host is added
+    to a cache (marked as 'down'). Subsequent requests to get a connection
+    will reorder the list of available hosts so that the hosts marked as down
+    are at the end of the list.
 
-#)  Fixed bug in DN matching when a remote and local listener use the same
-    certificate.
+#)  Fixed bug that throws unexpected 'ORA-01002' and 'NJS-112' errors
+    when LOB columns are fetched after table recreation.
+    `Issue #1565 <https://github.com/oracle/node-oracledb/issues/1565>`__.
 
-#)  Fixed bug with duplicate data for queries that exceed 2016 columns (only
-    possible with Oracle Database 23c).
+#)  Fixed bug with :attr:`oracledb.oracleClientVersion` and
+    :attr:`connection.oracleServerVersionString`. These attributes
+    now return 'undefined' in Thin mode instead of throwing an error.
+    `Issue #1582 <https://github.com/oracle/node-oracledb/issues/1582>`__.
 
 #)  Fixed bug giving 'Unexpected message type' during connection authentication.
     `Issue #1589 <https://github.com/oracle/node-oracledb/issues/1589>`__.
 
-#)  Fixed bug with :attr:`oracledb.oracleClientVersion` and
-    :attr:`connection.oracleServerVersionString`.  These now return 'undefined'
-    in Thin mode instead of throwing an error. `Issue #1582
-    <https://github.com/oracle/node-oracledb/issues/1582>`__.
+#)  Fixed bug in handling unexpected pool growth that exceeds pool max limit
+    due to improper handling of parallel connection requests.
+    `Issue #1591 <https://github.com/oracle/node-oracledb/issues/1591>`__.
+
+#)  Fixed bug to return proper error when an invalid database service name is
+    configured in the database listener.
 
-#) Added support to expose database error cause/action URL in error messages.
-   For ORA errors etc., the ERROR cause/action URL for that error code will
-   be provided along with error message.
+#)  Fixed bug when ``sslServerDNMatch`` is set and the connect string is in
+    Easy Connect syntax, but a value for ``SSL_SERVER_DN_MATCH`` is not set in
+    that connect string.
+
+#)  Fixed bug in DN matching when both a remote and a local listener use the
+    same certificate.
+
+#)  Fixed bug with duplicate data for queries that exceed 2016 columns (only
+    possible with Oracle Database 23c).
 
 Thick Mode Changes
 ++++++++++++++++++
 
-#)  Added msgID (message Id) attribute in the message object passed onto the
-    callback registered during AQ subscription. The msgID attribute passed
-    with the callback functions can be compared with the msgID attribute
-    returned by the deq* functions for proper validation of the returned
-    message objects during message dequeue.
+#)  Added ``msgID`` attribute in the message object passed onto the
+    callback function registered during AQ subscription. The msgID attribute
+    passed with the callback functions can be compared with the msgID 
+    attribute returned by the dequeue functions for proper validation of the
+    returned message objects with message dequeue.
 
 #)  Added support to return a message object from the :meth:`queue.enqOne()
     <aqQueue.enqOne()>` and :meth:`queue.enqMany() <aqQueue.enqMany()>`

test/aq5.js

@@ -1,4 +1,4 @@
-/* Copyright (c) 2019, 2023, Oracle and/or its affiliates. */
+/* Copyright (c) 2023, Oracle and/or its affiliates. */
 
 /******************************************************************************
  *
@@ -38,8 +38,6 @@ const dbConfig  = require('./dbconfig.js');
 const testsUtil = require('./testsUtil.js');
 const assert    = require('assert');
 
-oracledb.events = true;
-
 // callback for subscribe
 function cbSubscribe(message) {
   assert(message.msgId.length > 0);
@@ -51,6 +49,7 @@ describe('283.aq5.js', function() {
 
   let isRunnable = true;
   let conn;
+  let origEvents;
 
   const AQ_USER = 'NODB_SCHEMA_AQTEST5';
   const AQ_USER_PWD = testsUtil.generateRandomPassword();
@@ -66,6 +65,8 @@ describe('283.aq5.js', function() {
     if (!isRunnable) {
       this.skip();
     } else {
+      origEvents = oracledb.events;
+      oracledb.events = true;
       await testsUtil.createAQtestUser(AQ_USER, AQ_USER_PWD);
 
       const credential = {
@@ -99,6 +100,7 @@ describe('283.aq5.js', function() {
     if (!isRunnable) {
       return;
     } else {
+      oracledb.events = origEvents;
       await conn.close();
       await testsUtil.dropAQtestUser(AQ_USER);
     }

test/aq6.js

@@ -1,4 +1,4 @@
-/* Copyright (c) 2019, 2023, Oracle and/or its affiliates. */
+/* Copyright (c) 2023, Oracle and/or its affiliates. */
 
 /******************************************************************************
  *

test/aq7.js

@@ -1,4 +1,4 @@
-/* Copyright (c) 2019, 2022, Oracle and/or its affiliates. */
+/* Copyright (c) 2023, Oracle and/or its affiliates. */
 
 /******************************************************************************
  *
@@ -27,7 +27,7 @@
  *
  * DESCRIPTION
  *   Test Oracle Advanced Queueing (AQ).
- *   Test cases for JSON payload type
+ *   Test cases for JSON payload type with AQ.
  *
  *****************************************************************************/
 'use strict';

test/errorUrl.js

@@ -26,7 +26,7 @@
  *   284. errorUrl.js
  *
  * DESCRIPTION
- *   This test verifies enhancement to expose error portal URL in error message
+ *   This test verifies usage of the error URL in ORA-based error messages
  *
  *****************************************************************************/
 'use strict';

test/list.txt

@@ -5262,12 +5262,6 @@ oracledb.OUT_FORMAT_OBJECT and resultSet =  true
     267.10 recipient list with enqMany non-existent in dequeue
     267.11 recipient list with enqMany invalid datatype in dequeue
 
-268.  poolTimeout.js
-    268.1 poolTimeout as 0, no idle connection removals
-    268.2 poolTimeout as 1sec, idle connection will get removed
-    268.3 poolTimeout as 1sec and min connection defined, idle connection will be removed
-    268.4 check default poolTimeout as 60sec
-
 268. procAndFuncs.js
     268.1 calling stored procedures
         268.1.1 executing a stored procedure
@@ -5284,7 +5278,8 @@ oracledb.OUT_FORMAT_OBJECT and resultSet =  true
         268.3.6 executing a stored function with only one args
     268.4 calling functions without any arguments
         268.4.1 executing a stored function without any argument
-269. Pool Timeout
+
+269. PoolTimeout.js
     269.1 poolTimeout as 0, no idle connection removals
     269.2 poolTimeout as 1sec, idle connection will get removed
     269.3 poolTimeout as 1sec and min connection defined, idle connection will be removed
@@ -5388,7 +5383,7 @@ oracledb.OUT_FORMAT_OBJECT and resultSet =  true
     273.5 With Redaction on base tables
         273.5.1 redaction enabled on a base table
 
-274 jsonDualityView3.js
+274. jsonDualityView3.js
     274.1 Define Columns of View with WITH READ WRITE or WITH READ ONLY annotations
     274.2 Create View on Virtual columns, UNUSED columns
     274.3 Have columns of all scalar types, including FLOAT, TIMESTAMP, TIMESTAMP WITH TIME ZONE