More test and documentation updates for Oracle Database 23ai

Author: sharadraju

doc/src/release_notes.rst

@@ -13,11 +13,11 @@ node-oracledb `v6.5.0 <https://github.com/oracle/node-oracledb/compare/v6.4.0...
 Common Changes
 ++++++++++++++
 
-#)  Incorporate changes to use end of data request flag set with data packets
+#)  Incorporated changes to use end of data request flag set with data packets
     available in Oracle Database 23c to improve handling of the async reads.
 
 #)  Added class :ref:`oracledb.JsonId <jsonid>` to represent JSON ID values
-    returned by SODA in Oracle Database 23.4 and higher in the ``_id``
+    returned by SODA in Oracle Database 23.4 and later in the ``_id``
     attribute of documents stored in native collections.
 
 #)  Added support for an Oracle Database 23c JSON feature allowing for field
@@ -26,27 +26,31 @@ Common Changes
 #)  Added support for an Oracle Database 23c JSON feature improving JSON
     storage usage.
 
-#)  Updated error thrown during pool reconfiguration from `ORA-24413` to
-    `NJS-007` when poolMax is 0.
+#)  Updated the error thrown during pool reconfiguration from ``ORA-24413`` to
+    ``NJS-007`` when ``poolMax`` is *0*.
 
-#)  Throw `NJS-092` error if `poolMin` > `poolMax` during pool
-    reconfiguration.
+#)  Error ``NJS-092`` is now thrown during
+    :meth:`pool reconfiguration <pool.reconfigure()>` if the ``poolMin`` value is
+    greater than the ``poolMax`` value.
 
-#)  Added support for binding BigInt values. BigInts like ``123n`` can
-    be passed to ``connection.execute()``, ``connection.executeMany()``.
+#)  Added support for :ref:`binding BigInt values <binddatatypenotes>`.
+    BigInts such as ``123n`` can be passed to :meth:`connection.execute()` and
+    :meth:`connection.executeMany()`.
     See `PR #1572 <https://github.com/oracle/node-oracledb/pull/1572>`__
     (Slawomir Osoba).
 
 Thin Mode Changes
 ++++++++++++++++++
+
 #)  Updated the 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
-    the Node.js executable contains certain non-standard characters like '(' and ')'.
+    the Node.js executable contains certain non-standard characters such as
+    '(' and ')'.
     See `Issue #1664 <https://github.com/oracle/node-oracledb/issues/1664>`__.
 
-#)  Added support for easy connect string entries in tnsnames.ora
+#)  Added support for easy connect string entries in tnsnames.ora.
     See `Issue #1644 <https://github.com/oracle/node-oracledb/issues/1644>`__.
 
 #)  Added support for Oracle Database 23c feature that can improve the
@@ -61,22 +65,23 @@ Thin Mode Changes
     errors were raised.
     See `Issue #1652 <https://github.com/oracle/node-oracledb/issues/1652>`__.
 
-#)  Added support for pool reconfiguration.
+#)  Added support for :meth:`pool reconfiguration <pool.reconfigure()>`.
 
 #)  Added support for Oracle Database 23c
-    :ref:`Implicit Connection Pooling <implicitpool>` in DRCP and PRCP.
+    :ref:`Implicit Connection Pooling <implicitpool>` in Database Resident
+    Connection Pooling (DRCP) and Proxy Resident Connection Pooling (PRCP).
 
-#)  Added support for usage with extension of Array.prototype methods
+#)  Added support for usage with extension of Array.prototype methods.
     See `Issue #1653 <https://github.com/oracle/node-oracledb/issues/1653>`__.
 
 #)  Fixed bug which threw an error due to the presence of duplicate cursors
-    with DRCP.
+    with :ref:`DRCP <drcp>`.
 
 Thick Mode Changes
 +++++++++++++++++++
 
-#)  Fixed an issue with privileges that prevented the startup() function from
-    bringing up the database.
+#)  Fixed an 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.
@@ -86,7 +91,7 @@ Thick Mode Changes
 
 #)  Fixed the bug which inserted the invalid value `~`  into the database
     if an unacceptable out-of-bounds number is bound to a DML statement. Now,
-    numbers like 1.0e+128, -1e128, etc. will throw an error
+    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`.

test/callTimeout.js

@@ -157,4 +157,16 @@ describe('222. callTimeout.js', function() {
     const result = await conn.execute(`SELECT (1+2) AS SUM FROM DUAL`);
     assert.strictEqual(3, result.rows[0][0]);
   });
+
+  it('222.9 get the callTimeout value', async () => {
+    const TIME_OUT = 10;
+    const DB_OP_TIME = 2;
+
+    //set the callTimeout
+    conn.callTimeout = TIME_OUT * 1000;  // milliseconds
+
+    // get and assert the set callTimeout
+    assert.strictEqual(conn.callTimeout, TIME_OUT * 1000);
+    await conn.execute(`BEGIN DBMS_SESSION.SLEEP(:sleepsec); END;`, [DB_OP_TIME]);
+  });
 });

test/invalidNumber.js

@@ -34,17 +34,20 @@
 const oracledb = require('oracledb');
 const assert   = require('assert');
 const dbConfig = require('./dbconfig.js');
+const testsUtil = require('./testsUtil.js');
 
 describe('299. invalidNumber.js', function() {
   let conn;
+  let tableName = 'nodb_num';
 
   before(async function() {
     conn = await oracledb.getConnection(dbConfig);
-    await conn.execute('CREATE TABLE nodb_num(id NUMBER)');
+    const sql = `CREATE TABLE ${tableName}(id NUMBER)`;
+    await testsUtil.createTable(conn, tableName, sql);
   });
 
   after(async function() {
-    await conn.execute('DROP TABLE nodb_num PURGE');
+    await testsUtil.dropTable(conn, tableName);
     await conn.close();
   });
 
@@ -56,6 +59,6 @@ describe('299. invalidNumber.js', function() {
       async () => await conn.execute(sql, binds),
       /NJS-115:/
     );
-  }); //299.1
+  }); // 299.1
 
 });

test/list.txt

@@ -4675,6 +4675,7 @@ oracledb.OUT_FORMAT_OBJECT and resultSet =  true
     222.6 callTimeout is a String
     222.7 The callTimeout value applies not to the sum of all round-trips
     222.8 The callTimeout value applies to each round-trip individually
+	222.9 get the callTimeout value
 
 223. accessPropertiesOnClosedObjects.js
     223.1 access properties of closed Connection object
@@ -5265,6 +5266,8 @@ oracledb.OUT_FORMAT_OBJECT and resultSet =  true
         259.2.5 negative - missing formatId in XID
         259.2.6 negative missing globalTxnId in XID
         259.2.7 negative missing branchQualifier in XID
+		259.2.8 negative tpcForget after tpcPrepare
+		259.2.9 negative tpcForget without tpcPrepare
     259.3 TPC Functions with no default values
         259.3.1 test tpcBegin, tpcPrepare, tpcRollback
         259.3.2 test tpcBegin, tpcPrepare, tpcCommit

test/nullColumnValues.js

@@ -1,4 +1,4 @@
-/* Copyright (c) 2015, 2022, Oracle and/or its affiliates. */
+/* Copyright (c) 2015, 2024, Oracle and/or its affiliates. */
 
 /******************************************************************************
  *
@@ -166,7 +166,7 @@ describe('10. nullColumnValues.js', function() {
 
     await connection.execute(
       "UPDATE nodb_nullcol_dept SET department_name = :dname, \
-          manager_id = :mid WHERE department_id = :did ",
+          manager_id = :mid WHERE department_id = :did",
       {
         dname: '',
         mid: null,
@@ -177,7 +177,7 @@ describe('10. nullColumnValues.js', function() {
       "SELECT * FROM nodb_nullcol_dept WHERE department_id = :1",
       [50],
       { resultSet: true });
-    await  fetchRowFromRS(result.resultSet);
+    await fetchRowFromRS(result.resultSet);
 
     async function fetchRowFromRS(rs) {
       let accessCount = 0;

test/passwordExpiryWarning.js

@@ -1,4 +1,4 @@
-/* Copyright (c) 2023, Oracle and/or its affiliates. */
+/* Copyright (c) 2023, 2024, Oracle and/or its affiliates. */
 
 /******************************************************************************
  *
@@ -71,14 +71,17 @@ describe('292. passwordExpiryWarning.js', function() {
   };
 
   before(async function() {
-    if (dbConfig.test.drcp) this.skip();
+    if (!dbConfig.test.DBA_PRIVILEGE || dbConfig.test.drcp) this.skip();
+
     const connAsDBA = await oracledb.getConnection(dbaCredential);
     await connAsDBA.execute(plsql);
     await testsUtil.sleep(2000);
     await connAsDBA.close();
   });
 
   after(async function() {
+    if (!dbConfig.test.DBA_PRIVILEGE || dbConfig.test.drcp) return;
+
     const connAsDBA = await oracledb.getConnection(dbaCredential);
     await connAsDBA.execute (`ALTER USER ${userName} PROFILE DEFAULT`);
     await connAsDBA.execute (`DROP PROFILE SHORT_LIFE_PROFILE1`);

test/random.js

@@ -1,4 +1,4 @@
-/* Copyright (c) 2017, 2022, Oracle and/or its affiliates. */
+/* Copyright (c) 2017, 2024, Oracle and/or its affiliates. */
 
 /******************************************************************************
  *
@@ -27,34 +27,34 @@
  *
  * DESCRIPTION
  *   generate a random string which length is 'length', with specialStr
- *   in it's head and tail
+ *   at its head and tail
  *
  *****************************************************************************/
 'use strict';
 
-var random = exports;
+let random = exports;
 module.exports = random;
 
 // generate a random string which length is 'length', with specialStr in it's head and tail
 random.getRandomString = function(length, specialStr) {
-  var str = '';
-  var strLength = length - specialStr.length * 2;
+  let str = '';
+  let strLength = length - specialStr.length * 2;
   for (; str.length < strLength; str += Math.random().toString(36).slice(2));
-  str = str.substr(0, strLength);
+  str = str.slice(0, strLength);
   str = specialStr + str + specialStr;
   return str;
 };
 
 random.getRandomLengthString = function(length) {
-  var str = '';
+  let str = '';
   for (; str.length < length; str += Math.random().toString(36).slice(2));
-  str = str.substr(0, length);
+  str = str.slice(0, length);
   return str;
 };
 
 random.getRandomNumArray = function(size) {
-  var numbers = new Array(size);
-  for (var i = 0; i < numbers.length; i++) {
+  let numbers = new Array(size);
+  for (let i = 0; i < numbers.length; i++) {
     numbers[i] = this.getRandomInt(1, 9999999);
   }
   return numbers;
@@ -67,7 +67,7 @@ random.getRandomInt = function(min, max) {
 };
 
 random.getIntArray = function(N) {
-  var arr = Array.apply(null, Array(N));
+  let arr = Array.apply(null, Array(N));
   // The map() method creates a new array with the results of calling a provided function on every element in this array.
   //   var new_array = arr.map(callback[, thisArg])
   // Parameters

test/soda1.js

@@ -211,7 +211,8 @@ describe('164. soda1.js', () => {
     await conn.close();
   }); // 164.9
 
-  it('164.10 the "examples/soda1.js" case', async () => {
+  it('164.10 the "examples/soda1.js" case with autoCommit = true', async () => {
+    oracledb.autoCommit = true;
     const conn = await oracledb.getConnection(dbConfig);
     // Create the parent object for SODA
     const soda = conn.getSodaDatabase();
@@ -274,7 +275,7 @@ describe('164. soda1.js', () => {
     // Count all documents
     const res1 = await collection.find().count();
     assert.strictEqual(res1.count, 4);
-
+    oracledb.autoCommit = false;
     // Remove documents with cities containing 'o'
     const res2 = await collection.find().filter({"address.city": {"$regex": ".*o.*"}}).remove();
     assert.strictEqual(res2.count, 2);
@@ -293,7 +294,89 @@ describe('164. soda1.js', () => {
     await conn.close();
   }); // 164.10
 
-  it('164.11 Negative: create collection with invalid metaData value', async () => {
+  it('164.11 the "examples/soda1.js" case with no autocommit set up', async () => {
+    const conn = await oracledb.getConnection(dbConfig);
+    // Create the parent object for SODA
+    const soda = conn.getSodaDatabase();
+
+    // Create a new SODA collection and index
+    const collection = await soda.createCollection("soda_test_164_11");
+    const indexSpec = {
+      "name": "CITY_IDX",
+      "fields": [
+        {
+          "path": "address.city",
+          "datatype": "string",
+          "order": "asc"
+        }
+      ]
+    };
+    await collection.createIndex(indexSpec);
+
+    // Insert a document
+    // A system generated key is created by default
+    const content1 = { name: "Matilda", address: {city: "Melbourne"} };
+    const doc1 = await collection.insertOneAndGet(content1);
+    const myKey = doc1.key;
+    assert(myKey);
+    assert.strictEqual(typeof (myKey), "string");
+
+    // Fetch the document back
+    const doc2 = await collection.find().key(myKey).getOne();
+    const content2 = doc2.getContent(); // A JavaScript object
+    testsUtil.removeID(content1);
+    testsUtil.removeID(content2);
+    assert.deepStrictEqual(content2, content1);
+
+    const content3 = testsUtil.removeID(doc2.getContentAsString()); // A JSON string
+
+    assert.strictEqual(JSON.stringify(content2), content3);
+
+    // Replace document contents
+    const content4 = { name: "Matilda", address: {city: "Sydney"} };
+    await collection.find().key(myKey).replaceOne(content4);
+
+    // Insert some more documents without caring about their keys
+    const content5 = { name: "Venkat", address: {city: "Bengaluru"} };
+    await collection.insertOne(content5);
+    const content6 = { name: "May", address: {city: "London"} };
+    await collection.insertOne(content6);
+    const content7 = { name: "Sally-Ann", address: {city: "San Francisco"} };
+    await collection.insertOne(content7);
+
+    // Find all documents with city names starting with 'S'
+    const documents = await collection.find()
+      .filter({"address.city": {"$like": "S%"}})
+      .getDocuments();
+
+    for (let i = 0; i < documents.length; i++) {
+      const content = documents[i].getContent();
+      (['Sydney', 'San Francisco']).includes(content.address.city);
+    }
+
+    // Count all documents
+    const res1 = await collection.find().count();
+    assert.strictEqual(res1.count, 4);
+
+    // Remove documents with cities containing 'o'
+    const res2 = await collection.find().filter({"address.city": {"$regex": ".*o.*"}}).remove();
+    assert.strictEqual(res2.count, 2);
+
+    // Count all documents
+    const res3 = await collection.find().count();
+    assert.strictEqual(res3.count, 2);
+
+    await collection.dropIndex("CITY_IDX");
+
+    // Commit changes
+    await conn.commit();
+
+    const res = await collection.drop();
+    assert.strictEqual(res.dropped, true);
+    await conn.close();
+  }); // 164.11
+
+  it('164.12 Negative: create collection with invalid metaData value', async () => {
     const conn = await oracledb.getConnection(dbConfig);
     const sd = conn.getSodaDatabase();
 
@@ -306,6 +389,6 @@ describe('164. soda1.js', () => {
     );
 
     await conn.close();
-  }); // 164.11
+  }); // 164.12
 
 });