Documentation and test updates

Author: sharadraju

doc/src/release_notes.rst

@@ -38,7 +38,7 @@ Common Changes
 #)  Added support for an Oracle Database 23ai JSON feature improving JSON
     storage usage.
 
-#)  Updated the error thrown during pool reconfiguration from ``ORA-24413`` to
+#)  Updated error thrown during pool reconfiguration from ``ORA-24413`` to
     ``NJS-007`` when ``poolMax`` is *0*.
 
 #)  Error ``NJS-092`` is now thrown during
@@ -60,7 +60,7 @@ Common Changes
 Thin Mode Changes
 ++++++++++++++++++
 
-#)  Updated the ClientInfo terminal parameter to remove the hardcoded value.
+#)  Updated ClientInfo terminal parameter to remove the hardcoded value.
     See `Issue #1662 <https://github.com/oracle/node-oracledb/issues/1662>`__.
 
 #)  Fixed issue with connecting to Oracle Database, when the full path of
@@ -98,24 +98,24 @@ Thin Mode Changes
 Thick Mode Changes
 +++++++++++++++++++
 
-#)  Fixed an issue with privileges that prevented the
+#)  Fixed issue with privileges that prevented the
     :meth:`oracledb.startup()` method from bringing up the database.
 
 #)  Tightened code to avoid possible unexpected runtime errors during token
     callback.
 
-#)  Fixed an issue that caused unexpected behavior with SODA functions in
+#)  Fixed issue that caused unexpected behavior with SODA functions in
     some platforms.
 
-#)  Fixed the bug which inserted the invalid value `~`  into the database
+#)  Fixed bug which inserted the invalid value `~`  into the database
     if an unacceptable out-of-bounds number is bound to a DML statement. Now,
     numbers such as 1.0e+128, -1e128, and so on will throw an error
     ``NJS-115: value cannot be represented as an Oracle Database number``.
     Additionally, this fix resolves the issue related to JS numbers with
     precisions where `2.3` is returned as `2.300003`.
     See `Issue #1659 <https://github.com/oracle/node-oracledb/issues/1659>`__.
 
-#)  Fixed a regression that caused :meth:`~aqQueue.deqOne()` and
+#)  Fixed regression that caused :meth:`~aqQueue.deqOne()` and
     :meth:`~aqQueue.deqMany()` to return an invalid object in node-oracledb
     6.4 instead of undefined, which was returned in the previous releases.
     See `Issue #1656 <https://github.com/oracle/node-oracledb/issues/1656>`__.
@@ -188,7 +188,7 @@ Common Changes
 Thin Mode Changes
 ++++++++++++++++++
 
-#)  Fixed the intermittent error ``NJS-103`` which was seen while fetching
+#)  Fixed intermittent error ``NJS-103`` which was seen while fetching
     large number of CLOB columns whose metadata is split across multiple
     packets.
     `Issue #1642 <https://github.com/oracle/node-oracledb/issues/1642>`__.
@@ -367,7 +367,7 @@ Thick Mode Changes
     <enablingthick>` binary module.  `PR #1602
     <https://github.com/oracle/node-oracledb/pull/1602>`__ (Kwok Chun Man).
 
-#)  Fixed a segfault while populating a collection with a BLOB
+#)  Fixed segfault while populating a collection with a BLOB
     property. See `node-oracledb public Slack channel
     <https://node-oracledb.slack.com/ archives/CCM8AMSF7/p1694544451676639>`__.
 
@@ -516,7 +516,7 @@ Thin Mode Changes
     in the `V$CPOOL_STATS` view by default. This fix optimizes the use of DRCP
     connections.
 
-#)  Fixed the issue where dates with negative years are not inserted and
+#)  Fixed issue where dates with negative years are not inserted and
     fetched correctly.
 
 #)  Error handling and message improvements:

doc/src/user_guide/connection_handling.rst

@@ -2983,10 +2983,12 @@ applications more control over pooled server reuse.
 
 You should thoroughly test your application when using implicit connection
 pooling to ensure that the internal reuse of database servers does not cause
-any problems. For example, the connection `session id and serial number
-<https://www.oracle.com/pls/topic/lookup?ctx=dblatest&id=GUID-9F0DCAEA-A67E
--4183-89E7-B1555DC591CE>`__ may vary throughout the lifetime of the
-application connection as different servers may be used at different times.
+any problems. For example, any session state such as the connection `session
+id and serial number <https://www.oracle.com/pls/topic/lookup?ctx=dblatest&id
+=GUID-9F0DCAEA-A67E-4183-89E7-B1555DC591CE>`__ will vary throughout the
+lifetime of the application connection because different servers may be used
+at different times. Another example is when using a statement boundary of
+*transaction*. In this scenario, any commit can invalidate open cursors.
 
 .. _privconn:
 

test/dataTypeXML.js

@@ -55,6 +55,9 @@ describe('181. dataTypeXML.js', function() {
 
   before('create table and insert a row', async function() {
 
+    // Storing XMLType column as clob is disallowed in Oracle ADB.
+    if (dbConfig.test.isCloudService) this.skip();
+
     const connection = await oracledb.getConnection(dbConfig);
 
     let sql =
@@ -93,6 +96,9 @@ describe('181. dataTypeXML.js', function() {
   }); // before
 
   after('drop table', async () => {
+
+    if (dbConfig.test.isCloudService) return;
+
     const connection = await oracledb.getConnection(dbConfig);
     const sql = "BEGIN EXECUTE IMMEDIATE 'DROP TABLE " + tableName + "'; " +
               "EXCEPTION WHEN OTHERS THEN IF SQLCODE <> -942 THEN RAISE; END IF; END;";

test/list.txt

@@ -813,13 +813,13 @@ Overview of node-oracledb functional tests
         55.8.1
     55.9 calls getRows() once and then close RS before getting more rows
         55.9.1
-    55.10 resultSet with unsupported data types
-        55.10.1 INTERVAL YEAR TO MONTH data type
-    55.11 bind a cursor BIND_INOUT
-        55.11.1 has not supported binding a cursor with BIND_INOUT
-    55.12 Invalid Ref Cursor
-        55.12.1
-    55.13 use Resultset asyncIterator
+    55.10 use Resultset asyncIterator
+        55.10.1
+    55.11 NEgative - resultSet with unsupported data types
+        55.11.1 INTERVAL YEAR TO MONTH data type
+    55.12 bind a cursor BIND_INOUT
+        55.12.1 has not supported binding a cursor with BIND_INOUT
+    55.13 Negative - Invalid Ref Cursor
         55.13.1
 
 56. fetchAs.js

test/resultSet2.js

@@ -430,17 +430,39 @@ describe('55. resultSet2.js', function() {
     });
   }); // 55.9
 
-  describe('55.10 resultSet with unsupported data types', function() {
-    it('55.10.1 INTERVAL YEAR TO MONTH data type', async function() {
+  describe('55.10 use Resultset asyncIterator', function() {
+    before(async function() {
+      await setUp(connection, tableName);
+    });
+
+    after(async function() {
+      await clearUp(connection, tableName);
+    });
+
+    it('55.10.1 ', async function() {
+      const result = await connection.execute(
+        "SELECT * FROM nodb_rs2_emp ORDER BY employees_id",
+        [],
+        { resultSet: true });
+      const rs = result.resultSet;
+      for await (const row of rs) {
+        assert.strictEqual(row.length, 2);
+      }
+      await rs.close();
+    });
+  }); // 55.10
+
+  describe('55.11 Negative - resultSet with unsupported data types', function() {
+    it('55.11.1 INTERVAL YEAR TO MONTH data type', async function() {
       await assert.rejects(async () => {
         await connection.execute(
           "SELECT dummy, to_yminterval('1-3') FROM dual", [], { resultSet: true });
       }, /NJS-010:/);
     });
 
-  }); // 55.10
+  }); // 55.11
 
-  describe.skip('55.11 bind a cursor BIND_INOUT', function() {
+  describe.skip('55.12 bind a cursor BIND_INOUT', function() {
 
     before('prepare table nodb_rs2_emp', async function() {
       await setUp(connection, tableName);
@@ -450,7 +472,7 @@ describe('55. resultSet2.js', function() {
       await clearUp(connection, tableName);
     });
 
-    it('55.11.1 has not supported binding a cursor with BIND_INOUT', async function() {
+    it('55.12.1 has not supported binding a cursor with BIND_INOUT', async function() {
       const proc =
           "CREATE OR REPLACE PROCEDURE nodb_rs2_get_emp_inout (p_in IN NUMBER, p_out IN OUT SYS_REFCURSOR) \
              AS \
@@ -471,9 +493,9 @@ describe('55. resultSet2.js', function() {
       await connection.execute("DROP PROCEDURE nodb_rs2_get_emp_inout");
     });
 
-  }); // 55.11
+  }); // 55.12
 
-  describe('55.12 Invalid Ref Cursor', function() {
+  describe('55.13 Negative - Invalid Ref Cursor', function() {
     const proc =
       "CREATE OR REPLACE PROCEDURE get_invalid_refcur (p OUT SYS_REFCURSOR) " +
       "  AS " +
@@ -491,7 +513,7 @@ describe('55. resultSet2.js', function() {
       await clearUp(connection, tableName);
     });
 
-    it('55.12.1 ', async function() {
+    it('55.13.1 ', async function() {
       await assert.rejects(async () => {
         await connection.execute(
           "BEGIN get_invalid_refcur ( :p ); END; ",
@@ -501,28 +523,6 @@ describe('55. resultSet2.js', function() {
       }, /NJS-107:/);
 
     });
-  }); // 55.12
-
-  describe('55.13 use Resultset asyncIterator', function() {
-    before(async function() {
-      await setUp(connection, tableName);
-    });
-
-    after(async function() {
-      await clearUp(connection, tableName);
-    });
-
-    it('55.13.1 ', async function() {
-      const result = await connection.execute(
-        "SELECT * FROM nodb_rs2_emp ORDER BY employees_id",
-        [],
-        { resultSet: true });
-      const rs = result.resultSet;
-      for await (const row of rs) {
-        assert.strictEqual(row.length, 2);
-      }
-      await rs.close();
-    });
   }); // 55.13
 
 });