Latest test updates and new examples added

Author: sharadraju

examples/resultset3.js

@@ -0,0 +1,109 @@
+/* Copyright (c) 2024, Oracle and/or its affiliates. */
+
+/******************************************************************************
+ *
+ * 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 http://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
+ *
+ *    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.
+ *
+ * NAME
+ *   resultset3.js
+ *
+ * DESCRIPTION
+ *   Executes a query and uses a ResultSet to fetch batches of rows
+ *   with asyncIterator().
+ *
+ *****************************************************************************/
+
+'use strict';
+
+Error.stackTraceLimit = 50;
+
+const oracledb = require('oracledb');
+const dbConfig = require('./dbconfig.js');
+const demoSetup = require('./demosetup.js');
+
+// This example runs in both node-oracledb Thin and Thick modes.
+//
+// Optionally run in node-oracledb Thick mode
+if (process.env.NODE_ORACLEDB_DRIVER_MODE === 'thick') {
+
+  // Thick mode requires Oracle Client or Oracle Instant Client libraries.
+  // On Windows and macOS Intel you can specify the directory containing the
+  // libraries at runtime or before Node.js starts.  On other platforms (where
+  // Oracle libraries are available) the system library search path must always
+  // include the Oracle library path before Node.js starts.  If the search path
+  // is not correct, you will get a DPI-1047 error.  See the node-oracledb
+  // installation documentation.
+  let clientOpts = {};
+  // On Windows and macOS Intel platforms, set the environment
+  // variable NODE_ORACLEDB_CLIENT_LIB_DIR to the Oracle Client library path
+  if (process.platform === 'win32' || (process.platform === 'darwin' && process.arch === 'x64')) {
+    clientOpts = { libDir: process.env.NODE_ORACLEDB_CLIENT_LIB_DIR };
+  }
+  oracledb.initOracleClient(clientOpts);  // enable node-oracledb Thick mode
+}
+
+console.log(oracledb.thin ? 'Running in thin mode' : 'Running in thick mode');
+
+async function run() {
+  let connection;
+
+  try {
+    connection = await oracledb.getConnection(dbConfig);
+
+    await demoSetup.setupBf(connection);  // create the demo table
+
+    const result = await connection.execute(
+      `SELECT id, farmer
+       FROM no_banana_farmer
+       ORDER BY id`,
+      [], // no bind variables
+      {
+        resultSet: true // return a ResultSet (default is false)
+      }
+    );
+
+    // Fetch rows from the ResultSet using asyncIterator
+    const rs = result.resultSet;
+
+    let rowCount = 0;
+    console.log('Calling the asyncIterator for the resultSet object...');
+    for await (const row of rs) {
+      console.log(row);
+      rowCount++;
+    }
+    console.log("Total rows in the resultset: " + rowCount + " rows");
+
+    // always close the ResultSet
+    await rs.close();
+  } catch (err) {
+    console.error(err);
+  } finally {
+    if (connection) {
+      try {
+        await connection.close();
+      } catch (err) {
+        console.error(err);
+      }
+    }
+  }
+}
+
+run();

test/dbObject20.js

@@ -868,9 +868,16 @@ describe('290. dbObject20.js', () => {
     const TYPE2 = 'NODB_TEST_INV_OBJ_TBL';
     const TYPE3 = 'NODB_TEST_INV_OBJ';
     const TYPE4 = 'NODB_TEST_INV_OBJ_TBL_VARCHAR';
+
+    // GH issue https://github.com/oracle/node-oracledb/issues/1646
+    const TYPE5 = 'NODB_TEST_VARCHAR_CHAR';
+    const TYPE6 = 'NODB_TEST_VARCHAR_BYTE';
+
     const maxVarCharLen = 4;
     const maxVarNCharLen = 4;
     const maxVarRawLen = 10;
+    const maxVarChar2CharLen = 100;
+    const maxVarChar2ByteLen = 100;
 
     before(async () => {
       conn = await oracledb.getConnection(dbConfig);
@@ -889,6 +896,12 @@ describe('290. dbObject20.js', () => {
         { type: TYPE3, sql: `CREATE TYPE ${TYPE3} FORCE AS OBJECT (HEADER_ID NUMBER(5,2), TBL ${TYPE2})` },
         {
           type: TYPE4, sql: `CREATE OR REPLACE TYPE ${TYPE4} IS TABLE OF VARCHAR2 (${maxVarCharLen})`
+        },
+        {
+          type: TYPE5, sql: `CREATE OR REPLACE TYPE ${TYPE5} IS TABLE OF VARCHAR2 (${maxVarChar2CharLen} CHAR)`
+        },
+        {
+          type: TYPE6, sql: `CREATE OR REPLACE TYPE ${TYPE6} IS TABLE OF VARCHAR2 (${maxVarChar2ByteLen} BYTE)`
         }
       ];
 
@@ -900,6 +913,8 @@ describe('290. dbObject20.js', () => {
 
     after(async () => {
       if (conn) {
+        await testsUtil.dropType(conn, TYPE6);
+        await testsUtil.dropType(conn, TYPE5);
         await testsUtil.dropType(conn, TYPE4);
         await testsUtil.dropType(conn, TYPE3);
         await testsUtil.dropType(conn, TYPE2);
@@ -1041,6 +1056,104 @@ describe('290. dbObject20.js', () => {
       );
     });
 
+    it('290.4.4 Verify table of VARCHAR2 with CHAR/BYTE specifier', async () => {
+      // Verify table of VARCHAR2 CHAR.
+      const dataChar = [
+        "1".repeat(maxVarChar2CharLen),
+        "A".repeat(maxVarChar2CharLen)
+      ];
+      const charset = await testsUtil.getDBCharSet(conn);
+      const isUTF8Charset = (charset === "AL32UTF8");
+      if (isUTF8Charset) {
+        // push multi byte characters test...
+        dataChar.push("Ő".repeat(maxVarChar2CharLen));
+        dataChar.push("𠜎".repeat(maxVarChar2CharLen));
+      }
+
+      let pInClass = await conn.getDbObjectClass(TYPE5);
+      let pOutClass = await conn.getDbObjectClass(TYPE5);
+      let pInObj = new pInClass(dataChar);
+      let pOutObj = new pOutClass();
+
+      // create Procedure.
+      let PROC = 'nodb_proc_test2029044';
+      let createProc = `
+      CREATE OR REPLACE PROCEDURE ${PROC}
+        (a IN ${TYPE5}, b IN OUT ${TYPE5}) AS
+      BEGIN
+         b := a;
+      END;
+    `;
+      let result = await conn.execute(createProc);
+
+      // Call procedure.
+      let plsql = `BEGIN ${PROC} (:pIn, :pOut); END;`;
+      let bindVar = {
+        pIn: { val: pInObj, dir: oracledb.BIND_IN },
+        pOut: { val: pOutObj, dir: oracledb.BIND_INOUT },
+      };
+      result = await conn.execute(plsql, bindVar);
+
+      // Verify the result.
+      assert.strictEqual(JSON.stringify(dataChar), JSON.stringify(result.outBinds.pOut));
+
+      if (isUTF8Charset) {
+      // Check more than max characters allowed (utf-8 DB charset) but with-in max bytes.
+        dataChar.push("Ő".repeat(maxVarChar2CharLen + 1));
+        new pInClass(dataChar);
+      }
+
+      // Throw an error if number of characters exceed max bytes storage.
+      if (isUTF8Charset) {
+        dataChar.push("𠜎".repeat(maxVarChar2CharLen + 1));
+      } else {
+        dataChar.push("A".repeat(maxVarChar2CharLen + 1));
+      }
+      assert.throws(
+        () => new pInClass(dataChar),
+        /NJS-143:/
+      );
+
+      // Verify table of VARCHAR2 BYTE
+      const dataBytes = [
+        "1".repeat(maxVarChar2ByteLen),
+        "A".repeat(maxVarChar2ByteLen)
+      ];
+
+      // create Procedure.
+      PROC = 'nodb_proc_test2029044_byte';
+      createProc = `
+      CREATE OR REPLACE PROCEDURE ${PROC}
+        (a IN ${TYPE6}, b IN OUT ${TYPE6}) AS
+      BEGIN
+         b := a;
+      END;
+    `;
+      result = await conn.execute(createProc);
+      pInClass = await conn.getDbObjectClass(TYPE6);
+      pOutClass = await conn.getDbObjectClass(TYPE6);
+      pInObj = new pInClass(dataBytes);
+      pOutObj = new pOutClass();
+
+      // Call procedure.
+      plsql = `BEGIN ${PROC} (:pIn, :pOut); END;`;
+      bindVar = {
+        pIn: { val: pInObj, dir: oracledb.BIND_IN },
+        pOut: { val: pOutObj, dir: oracledb.BIND_INOUT },
+      };
+      result = await conn.execute(plsql, bindVar);
+
+      // Verify the result.
+      assert.strictEqual(JSON.stringify(dataBytes), JSON.stringify(result.outBinds.pOut));
+
+      // Verify data larger than max size.
+      dataBytes.push("A".repeat(maxVarChar2ByteLen + 1));
+      assert.throws(
+        () => new pInClass(dataBytes),
+        /NJS-143:/
+      );
+    }); // 290.4.4
+
   });
 
   describe('290.5 Associative Arrays fetch ', function() {

test/list.txt

@@ -788,7 +788,7 @@ Overview of node-oracledb functional tests
     55.3 alternating getRow() & getRows() function
         55.3.1 result set
         55.3.2 REF Cursor
-    55.4 automatically close result sets and LOBs when the connection is closed
+    55.4 automatically close resultSets and LOBs when the connection is closed
         55.4.1 resultSet gets closed automatically
         55.4.2 REF Cursor gets closed automatically
     55.5 the content of resultSet should be consistent
@@ -805,12 +805,14 @@ 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 result set with unsupported data types
+    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.13.1
 
 56. fetchAs.js
     56.1 property value check
@@ -5627,6 +5629,7 @@ oracledb.OUT_FORMAT_OBJECT and resultSet =  true
         290.4.1 Invalid Values for nested property string
         290.4.2 Invalid Values for different datatypes
         290.4.3 Invalid Values for collection
+        290.4.4 Verify table of VARCHAR2 with CHAR/BYTE specifier
 
 291. dbSchema.js
     291.1 dbSchema and Annotations

test/resultSet2.js

@@ -159,7 +159,7 @@ describe('55. resultSet2.js', function() {
 
   }); // 55.3
 
-  describe('55.4 automatically close result sets and LOBs when the connection is closed', function() {
+  describe('55.4 automatically close resultSets and LOBs when the connection is closed', function() {
     before(async function() {
       await setUp(connection, tableName);
     });
@@ -430,11 +430,11 @@ describe('55. resultSet2.js', function() {
     });
   }); // 55.9
 
-  describe('55.10 result set with unsupported data types', function() {
+  describe('55.10 resultSet with unsupported data types', function() {
     it('55.10.1 INTERVAL YEAR TO MONTH data type', async function() {
       await assert.rejects(async () => {
         await connection.execute(
-          "SELECT dummy, to_yminterval('1-3') FROM dual");
+          "SELECT dummy, to_yminterval('1-3') FROM dual", [], { resultSet: true });
       }, /NJS-010:/);
     });
 
@@ -475,7 +475,7 @@ describe('55. resultSet2.js', function() {
 
   describe('55.12 Invalid Ref Cursor', function() {
     const proc =
-      "CREATE OR REPLACE PROCEDURE get_invalid_refcur ( p OUT SYS_REFCURSOR) " +
+      "CREATE OR REPLACE PROCEDURE get_invalid_refcur (p OUT SYS_REFCURSOR) " +
       "  AS " +
       "  BEGIN " +
       "    NULL; " +
@@ -500,9 +500,31 @@ describe('55. resultSet2.js', function() {
           });
       }, /NJS-107:/);
 
-    }); // 55.12.1
+    });
   }); // 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
+
 });
 
 

test/testsUtil.js

@@ -565,3 +565,13 @@ testsUtil.checkAndWait = async function(intervalWait, numIntervals, func) {
   err.totalTimeWaited = (intervalWait * numIntervals) / 1000;
   throw err;
 };
+
+// function to return DBCHARSET
+testsUtil.getDBCharSet = async function(conn) {
+  const res = await conn.execute(`
+      select value
+      from nls_database_parameters
+      where parameter = 'NLS_CHARACTERSET'`
+  );
+  return res.rows[0][0];
+};