fetchArraySize2.js

/* Copyright (c) 2017, 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 https://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
 *   149. fetchArraySize2.js
 *
 * DESCRIPTION
 *   Basic test of fetching data from database with different oracledb.fetchArraySize, oracledb.maxRows, numRows.
 *   maxRows specifies maximum number of rows that are fetched by the execute() call of the
 *   Connection object when not using a ResultSet.
 *   Tests including:
 *     basic fetch tests with different oracledb.fetchArraySize and oracledb.maxRows.
 *     REF CURSORS tests with different oracledb.fetchArraySize and numRows.
 *     QueryStream() tests with different oracledb.fetchArraySize and oracledb.maxRows.
 *
 *****************************************************************************/
'use strict';

const oracledb = require('oracledb');
const assert   = require('assert');
const dbConfig = require('./dbconfig.js');

describe("149. fetchArraySize2.js", function() {

  let connection = null;
  const default_fetcArraySize = oracledb.fetchArraySize;
  const default_maxRows = oracledb.maxRows;
  const tableName = "nodb_fetchArraySize_149";
  const tableSize = 1000;

  const create_table = `BEGIN
                         DECLARE
                             e_table_missing EXCEPTION;
                             PRAGMA EXCEPTION_INIT(e_table_missing, -00942);
                         BEGIN
                             EXECUTE IMMEDIATE('DROP TABLE ` + tableName + ` PURGE');
                         EXCEPTION
                             WHEN e_table_missing
                             THEN NULL;
                         END;
                         EXECUTE IMMEDIATE ('
                             CREATE TABLE ` + tableName + ` (
                                 id         NUMBER,
                                 content    VARCHAR(2000)
                             )
                         ');
                         FOR i IN 1..` + tableSize + ` LOOP
                              EXECUTE IMMEDIATE ('
                                  INSERT INTO ` + tableName + ` VALUES (' || i || ',' || TO_CHAR(i) ||')
                             ');
                         END LOOP;
                         commit;
                       END;`;

  const drop_table = "DROP TABLE " + tableName + " PURGE";

  before(async function() {
    connection = await oracledb.getConnection(dbConfig);
    assert.strictEqual(default_fetcArraySize, 100);
    assert.strictEqual(default_maxRows, 0);
  });

  after(async function() {
    await connection.close();
  });

  describe("149.1 basic fetch with different maxRows and oracledb.fetchArraySize", function() {

    before(async function() {
      await connection.execute(create_table);
    });

    after(async function() {
      await connection.execute(drop_table);
    });

    afterEach(function() {
      oracledb.fetchArraySize = default_fetcArraySize;
      oracledb.maxRows = default_maxRows;
    });

    const basicFetch = async function(fetchArraySizeVal, maxRowsVal, affectedID) {
      oracledb.fetchArraySize = fetchArraySizeVal;
      oracledb.maxRows = maxRowsVal;
      const result = await connection.execute(
        "SELECT * FROM " + tableName + " WHERE id > " + affectedID + " ORDER BY id"
      );
      let resultLenExpected = maxRowsVal > (tableSize - affectedID) ? (tableSize - affectedID) : maxRowsVal;
      if (maxRowsVal === 0) resultLenExpected = tableSize - affectedID;
      assert.strictEqual(result.rows.length, resultLenExpected);
      verifyResult(result.rows, affectedID);
    };

    const verifyResult = function(result, affectedID) {
      for (const element of result) {
        const index = result.indexOf(element) + 1 + affectedID;
        assert.strictEqual(element[1], String(index));
        assert.strictEqual(element[0], index);
      }
    };

    it("149.1.1 maxRows > table size > oracledb.fetchArraySize", async function() {
      const fetchArraySizeVal = tableSize - 1;
      const maxRowsVal = tableSize + 1;
      const affectedID = 0;
      await basicFetch(fetchArraySizeVal, maxRowsVal, affectedID);
    });

    it("149.1.2 maxRows > oracledb.fetchArraySize > table size", async function() {
      const fetchArraySizeVal = tableSize - 99;
      const maxRowsVal = tableSize - 7;
      const affectedID = 20;
      await basicFetch(fetchArraySizeVal, maxRowsVal, affectedID);
    });

    it("149.1.3 table size > maxRows > oracledb.fetchArraySize", async function() {
      const fetchArraySizeVal = tableSize - 100;
      const maxRowsVal = tableSize - 2;
      const affectedID = 10;
      await basicFetch(fetchArraySizeVal, maxRowsVal, affectedID);
    });

    it("149.1.4 table size > oracledb.fetchArraySize > maxRow", async function() {
      const fetchArraySizeVal = tableSize - 3;
      const maxRowsVal = tableSize - 77;
      const affectedID = 50;
      await basicFetch(fetchArraySizeVal, maxRowsVal, affectedID);
    });

    it("149.1.5 maxRows = oracledb.fetchArraySize < table size", async function() {
      const fetchArraySizeVal = tableSize - 110;
      const maxRowsVal = tableSize - 110;
      const affectedID = 20;
      await basicFetch(fetchArraySizeVal, maxRowsVal, affectedID);
    });

    it("149.1.6 maxRows = oracledb.fetchArraySize = table size", async function() {
      const fetchArraySizeVal = tableSize;
      const maxRowsVal = tableSize;
      const affectedID = 0;
      await basicFetch(fetchArraySizeVal, maxRowsVal, affectedID);
    });

    it("149.1.7 maxRows = oracledb.fetchArraySize > table size", async function() {
      const fetchArraySizeVal = tableSize + 9999;
      const maxRowsVal = tableSize + 9999;
      const affectedID = 10;
      await basicFetch(fetchArraySizeVal, maxRowsVal, affectedID);
    });

    it("149.1.8 maxRows = oracledb.fetchArraySize/10", async function() {
      const fetchArraySizeVal = tableSize / 10 - 1;
      const maxRowsVal = tableSize / 10;
      const affectedID = 0;
      await basicFetch(fetchArraySizeVal, maxRowsVal, affectedID);
    });

    it("149.1.9 maxRows = 10 * oracledb.fetchArraySize", async function() {
      const fetchArraySizeVal = 90;
      const maxRowsVal = 900;
      const affectedID = 50;
      await basicFetch(fetchArraySizeVal, maxRowsVal, affectedID);
    });

    it("149.1.10 maxRows > fetchArraySize, fetchArraySize = (table size)/10", async function() {
      const fetchArraySizeVal = tableSize / 10;
      const maxRowsVal = tableSize / 10 + 1;
      const affectedID = 0;
      await basicFetch(fetchArraySizeVal, maxRowsVal, affectedID);
    });

    it("149.1.11 maxRows = 0, fetchArraySize = table size ", async function() {
      const fetchArraySizeVal = tableSize;
      const maxRowsVal = 0;
      const affectedID = 0;
      await basicFetch(fetchArraySizeVal, maxRowsVal, affectedID);
    });

    it("149.1.12 maxRows = 9999999, fetchArraySize = table size ", async function() {
      const fetchArraySizeVal = tableSize;
      const maxRowsVal = 9999999;
      const affectedID = 0;
      await basicFetch(fetchArraySizeVal, maxRowsVal, affectedID);
    });

    it("149.1.13 maxRows = (table size - 1), fetchArraySize = table size ", async function() {
      const fetchArraySizeVal = tableSize;
      const maxRowsVal = tableSize - 1;
      const affectedID = 0;
      await basicFetch(fetchArraySizeVal, maxRowsVal, affectedID);
    });

    it("149.1.14 fetchArraySize = (table size - 1), maxRows = table size ", async function() {
      const fetchArraySizeVal = tableSize - 1;
      const maxRowsVal = tableSize;
      const affectedID = 0;
      await basicFetch(fetchArraySizeVal, maxRowsVal, affectedID);
    });
  });

  describe("149.2 REF CURSORS with different numRows and oracledb.fetchArraySize", function() {

    before(async function() {
      await connection.execute(create_table);
    });

    after(async function() {
      await connection.execute(drop_table);
    });

    afterEach(function() {
      oracledb.fetchArraySize = default_fetcArraySize;
      oracledb.maxRows = default_maxRows;
    });

    const testRefCursor = async function(fetchArraySizeVal, numRowsVal) {
      const create_ref = `CREATE OR REPLACE PROCEDURE testrefproc (p_out OUT SYS_REFCURSOR)
                          AS
                          BEGIN
                            OPEN p_out FOR
                            SELECT * FROM ` + tableName  + ` order by id;
                          END;`;
      const drop_ref = "DROP PROCEDURE testrefproc";
      const exec_ref = "BEGIN testrefproc(:o); END;";

      await connection.execute(create_ref);

      oracledb.fetchArraySize = fetchArraySizeVal;
      const result = await connection.execute(
        exec_ref,
        [
          { type: oracledb.CURSOR, dir: oracledb.BIND_OUT }
        ],
        { outFormat: oracledb.OUT_FORMAT_OBJECT }
      );
      const rowCount = 0;
      await fetchRowsFromRS(result.outBinds[0], numRowsVal, rowCount);

      await connection.execute(drop_ref);
    };

    async function fetchRowsFromRS(rs, numRowsVal, rowCount) {
      const rows = await rs.getRows(numRowsVal);
      if (rows.length > 0) {
        for (let i = 0; i < rows.length; i++) {
          assert(rows.length <= numRowsVal);
          rowCount++;
          assert.strictEqual(rows[i].ID, rowCount);
          assert.strictEqual(rows[i].CONTENT, rowCount.toString());
        }
        return await fetchRowsFromRS(rs, numRowsVal, rowCount);
      } else {
        assert.strictEqual(rowCount, tableSize);
        await rs.close();
      }
    }

    it("149.2.1 numRows > table size > oracledb.fetchArraySize", async function() {
      const fetchArraySizeVal = tableSize - 1;
      const numRowsVal = tableSize + 1;
      await testRefCursor(fetchArraySizeVal, numRowsVal);
    });

    it("149.2.2 numRows > oracledb.fetchArraySize > table size", async function() {
      const fetchArraySizeVal = tableSize + 7;
      const numRowsVal = tableSize + 77;
      await testRefCursor(fetchArraySizeVal, numRowsVal);
    });

    it("149.2.3 table size > numRows > oracledb.fetchArraySize", async function() {
      const fetchArraySizeVal = tableSize - 11;
      const numRowsVal = tableSize - 2;
      await testRefCursor(fetchArraySizeVal, numRowsVal);
    });

    it("149.2.4 table size > oracledb.fetchArraySize > maxRow", async function() {
      const fetchArraySizeVal = tableSize - 90;
      const numRowsVal = tableSize - 150;
      await testRefCursor(fetchArraySizeVal, numRowsVal);
    });

    it("149.2.5 numRows = oracledb.fetchArraySize < table size", async function() {
      const fetchArraySizeVal = tableSize - 110;
      const numRowsVal = tableSize - 110;
      await testRefCursor(fetchArraySizeVal, numRowsVal);
    });

    it("149.2.6 numRows = oracledb.fetchArraySize = table size", async function() {
      const fetchArraySizeVal = tableSize;
      const numRowsVal = tableSize;
      await testRefCursor(fetchArraySizeVal, numRowsVal);
    });

    it("149.2.7 numRows = oracledb.fetchArraySize > table size", async function() {
      const fetchArraySizeVal = tableSize + 9999;
      const numRowsVal = tableSize + 9999;
      await testRefCursor(fetchArraySizeVal, numRowsVal);
    });

    it("149.2.8 numRows = oracledb.fetchArraySize/10", async function() {
      const fetchArraySizeVal = tableSize / 10 + 1;
      const numRowsVal = tableSize / 10;
      await testRefCursor(fetchArraySizeVal, numRowsVal);
    });

    it("149.2.9 numRows = 10 * oracledb.fetchArraySize", async function() {
      const fetchArraySizeVal = 90;
      const numRowsVal = 900;
      await testRefCursor(fetchArraySizeVal, numRowsVal);
    });

    it("149.2.10 numRows > fetchArraySize, fetchArraySize = (table size)/10", async function() {
      const fetchArraySizeVal = tableSize / 10;
      const numRowsVal = tableSize / 10 + 1;
      await testRefCursor(fetchArraySizeVal, numRowsVal);
    });

    it("149.2.11 numRows = (table size - 1), fetchArraySize = table size", async function() {
      const fetchArraySizeVal = tableSize;
      const numRowsVal = tableSize - 1;
      await testRefCursor(fetchArraySizeVal, numRowsVal);
    });

    it("149.2.12 fetchArraySize = (table size - 1), numRows = table size", async function() {
      const fetchArraySizeVal = tableSize - 1;
      const numRowsVal = tableSize;
      await testRefCursor(fetchArraySizeVal, numRowsVal);
    });
  });

  describe("149.3 queryStream() with different maxRows and oracledb.fetchArraySize", function() {

    before(async function() {
      await connection.execute(create_table);
    });

    after(async function() {
      await connection.execute(drop_table);
    });

    afterEach(function() {
      oracledb.fetchArraySize = default_fetcArraySize;
      oracledb.maxRows = default_maxRows;
    });

    const testQueryStream = async function(fetchArraySizeVal, maxRowsVal, affectedID) {
      oracledb.fetchArraySize = fetchArraySizeVal;
      oracledb.maxRows = maxRowsVal;
      const resultLenExpected = tableSize - affectedID;
      const querySql = "select * from " + tableName + " where id > " + affectedID + " order by id";
      const stream = await connection.queryStream(querySql);
      let counter = 0;
      await new Promise((resolve, reject) => {
        stream.on('error', reject);
        stream.on('end', function() {
          assert.strictEqual(counter, resultLenExpected);
          stream.destroy();
        });
        stream.on('close', resolve);
        stream.on('data', function(data) {
          assert(data);
          counter++;
          verifyResult(data, counter, affectedID);
        });
      });
    };

    const verifyResult = function(data, counter, affectedID) {
      assert.strictEqual(data[0], counter + affectedID);
      assert.strictEqual(data[1], String(counter + affectedID));
    };

    it("149.3.1 maxRows > table size > oracledb.fetchArraySize", async function() {
      const fetchArraySizeVal = tableSize - 1;
      const maxRowsVal = tableSize + 1;
      const affectedID = 0;
      await testQueryStream(fetchArraySizeVal, maxRowsVal, affectedID);
    });

    it("149.3.2 maxRows > oracledb.fetchArraySize > table size", async function() {
      const fetchArraySizeVal = tableSize + 101;
      const maxRowsVal = tableSize + 1000;
      const affectedID = 20;
      await testQueryStream(fetchArraySizeVal, maxRowsVal, affectedID);
    });

    it("149.3.3 table size > maxRows > oracledb.fetchArraySize", async function() {
      const fetchArraySizeVal = tableSize - 11;
      const maxRowsVal = tableSize - 2;
      const affectedID = 0;
      await testQueryStream(fetchArraySizeVal, maxRowsVal, affectedID);
    });

    it("149.3.4 table size > oracledb.fetchArraySize > maxRow", async function() {
      const fetchArraySizeVal = tableSize - 90;
      const maxRowsVal = tableSize - 150;
      const affectedID = 50;
      await testQueryStream(fetchArraySizeVal, maxRowsVal, affectedID);
    });

    it("149.3.5 maxRows = oracledb.fetchArraySize < table size", async function() {
      const fetchArraySizeVal = tableSize - 110;
      const maxRowsVal = tableSize - 110;
      const affectedID = 20;
      await testQueryStream(fetchArraySizeVal, maxRowsVal, affectedID);
    });

    it("149.3.6 maxRows = oracledb.fetchArraySize = table size", async function() {
      const fetchArraySizeVal = tableSize;
      const maxRowsVal = tableSize;
      const affectedID = 0;
      await testQueryStream(fetchArraySizeVal, maxRowsVal, affectedID);
    });

    it("149.3.7 maxRows = oracledb.fetchArraySize > table size", async function() {
      const fetchArraySizeVal = tableSize + 9999;
      const maxRowsVal = tableSize + 9999;
      const affectedID = 10;
      await testQueryStream(fetchArraySizeVal, maxRowsVal, affectedID);
    });

    it("149.3.8 maxRows = oracledb.fetchArraySize/10", async function() {
      const fetchArraySizeVal = tableSize / 10 + 1;
      const maxRowsVal = tableSize / 10;
      const affectedID = 0;
      await testQueryStream(fetchArraySizeVal, maxRowsVal, affectedID);
    });

    it("149.3.9 maxRows = 10 * oracledb.fetchArraySize", async function() {
      const fetchArraySizeVal = 90;
      const maxRowsVal = 900;
      const affectedID = 50;
      await testQueryStream(fetchArraySizeVal, maxRowsVal, affectedID);
    });

    it("149.3.10 maxRows > fetchArraySize, fetchArraySize = (table size)/10", async function() {
      const fetchArraySizeVal = tableSize / 10;
      const maxRowsVal = tableSize / 10 + 1;
      const affectedID = 50;
      await testQueryStream(fetchArraySizeVal, maxRowsVal, affectedID);
    });

    it("149.3.11 maxRows = 0, fetchArraySize = table size", async function() {
      const fetchArraySizeVal = tableSize;
      const maxRowsVal = 0;
      const affectedID = 0;
      await testQueryStream(fetchArraySizeVal, maxRowsVal, affectedID);
    });

    it("149.3.12 maxRows = 9999999, fetchArraySize = table size", async function() {
      const fetchArraySizeVal = tableSize;
      const maxRowsVal = 9999999;
      const affectedID = 0;
      await testQueryStream(fetchArraySizeVal, maxRowsVal, affectedID);
    });

    it("149.3.13 maxRows = (table size - 1), fetchArraySize = table size ", async function() {
      const fetchArraySizeVal = tableSize;
      const maxRowsVal = tableSize - 1;
      const affectedID = 0;
      await testQueryStream(fetchArraySizeVal, maxRowsVal, affectedID);
    });

    it("149.3.14 fetchArraySize = (table size - 1), maxRows = table size ", async function() {
      const fetchArraySizeVal = tableSize - 1;
      const maxRowsVal = tableSize;
      const affectedID = 0;
      await testQueryStream(fetchArraySizeVal, maxRowsVal, affectedID);
    });
  });

});