fetchArraySize9.js

/* Copyright (c) 2017, 2023, 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
 *   156. fetchArraySize9.js
 *
 * DESCRIPTION
 *   Direct fetch (non-RS) tests querying BLOBs (for streaming) using different
 *   fetchArraySizes values & tablesizes.
 *
 *****************************************************************************/
'use strict';

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

describe("156. fetchArraySize9.js", function() {

  let connection = null;
  const default_fetcArraySize = oracledb.fetchArraySize;
  const default_maxRows = oracledb.maxRows;
  const tableName = "nodb_fetchArraySize_156";

  const create_table = "BEGIN \n" +
                     "    DECLARE \n" +
                     "        e_table_missing EXCEPTION; \n" +
                     "        PRAGMA EXCEPTION_INIT(e_table_missing, -00942); \n" +
                     "    BEGIN \n" +
                     "        EXECUTE IMMEDIATE('DROP TABLE " + tableName + " PURGE'); \n" +
                     "    EXCEPTION \n" +
                     "        WHEN e_table_missing \n" +
                     "        THEN NULL; \n" +
                     "    END; \n" +
                     "    EXECUTE IMMEDIATE (' \n" +
                     "        CREATE TABLE " + tableName + " ( \n" +
                     "            id         NUMBER, \n" +
                     "            content    BLOB \n" +
                     "        ) \n" +
                     "    '); \n" +
                     "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("156.1 Streaming blobs with different oracledb.fetchArraySize", function() {

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

    const basicFetchWithGlobalOption = async function(tableSize, fetchArraySizeVal, maxRowsVal, affectedID) {
      await connection.execute(create_table);
      await insertData(tableSize);
      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);
      await verifyResult(result.rows);

      await connection.execute(drop_table);
    };

    it("156.1.1 maxRows > table size > oracledb.fetchArraySize", async function() {
      const tableSize = 100;
      const fetchArraySizeVal = tableSize - 50;
      const maxRowsVal = tableSize + 200;
      const affectedID = 0;
      await basicFetchWithGlobalOption(tableSize, fetchArraySizeVal, maxRowsVal, affectedID);
    });

    it("156.1.2 maxRows > oracledb.fetchArraySize > table size", async function() {
      const tableSize = 20;
      const fetchArraySizeVal = tableSize + 30;
      const maxRowsVal = tableSize + 50;
      const affectedID = 0;
      await basicFetchWithGlobalOption(tableSize, fetchArraySizeVal, maxRowsVal, affectedID);
    });

    it("156.1.3 table size > maxRows > oracledb.fetchArraySize", async function() {
      const tableSize = 199;
      const fetchArraySizeVal = tableSize - 130;
      const maxRowsVal = tableSize - 50;
      const affectedID = 0;
      await basicFetchWithGlobalOption(tableSize, fetchArraySizeVal, maxRowsVal, affectedID);
    });

    it("156.1.4 table size > oracledb.fetchArraySize > maxRow", async function() {
      const tableSize = 290;
      const fetchArraySizeVal = tableSize - 90;
      const maxRowsVal = tableSize - 150;
      const affectedID = 0;
      await basicFetchWithGlobalOption(tableSize, fetchArraySizeVal, maxRowsVal, affectedID);
    });

    it("156.1.5 maxRows = oracledb.fetchArraySize < table size", async function() {
      const tableSize = 20;
      const fetchArraySizeVal = tableSize - 3;
      const maxRowsVal = fetchArraySizeVal;
      const affectedID = 0;
      await basicFetchWithGlobalOption(tableSize, fetchArraySizeVal, maxRowsVal, affectedID);
    });

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

    it("156.1.7 maxRows = oracledb.fetchArraySize > table size", async function() {
      const tableSize = 10;
      const fetchArraySizeVal = tableSize + 30;
      const maxRowsVal = fetchArraySizeVal;
      const affectedID = 0;
      await basicFetchWithGlobalOption(tableSize, fetchArraySizeVal, maxRowsVal, affectedID);
    });

    it("156.1.8 maxRows = oracledb.fetchArraySize/10", async function() {
      const tableSize = 100;
      const fetchArraySizeVal = 30;
      const maxRowsVal = fetchArraySizeVal / 10;
      const affectedID = 0;
      await basicFetchWithGlobalOption(tableSize, fetchArraySizeVal, maxRowsVal, affectedID);
    });

    it("156.1.9 maxRows = 10 * oracledb.fetchArraySize", async function() {
      const tableSize = 2;
      const fetchArraySizeVal = 30;
      const maxRowsVal = fetchArraySizeVal * 10;
      const affectedID = 0;
      await basicFetchWithGlobalOption(tableSize, fetchArraySizeVal, maxRowsVal, affectedID);
    });

    it("156.1.10 maxRows > fetchArraySize, fetchArraySize = (table size)/10", async function() {
      const tableSize = 200;
      const fetchArraySizeVal = tableSize / 10;
      const maxRowsVal = fetchArraySizeVal + 50;
      const affectedID = 0;
      await basicFetchWithGlobalOption(tableSize, fetchArraySizeVal, maxRowsVal, affectedID);
    });

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

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

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

  describe("156.2 Streaming blobs with different execute() option fetchArraySize", function() {

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

    const basicFetchWithExecOption = async function(tableSize, fetchArraySizeVal, maxRowsVal, affectedID) {
      await connection.execute(create_table);
      await insertData(tableSize);

      oracledb.maxRows = maxRowsVal;
      const result = await connection.execute(
        "select * from " + tableName + " where id > " + affectedID + " order by id",
        [],
        {
          fetchArraySize: fetchArraySizeVal
        }
      );
      let resultLenExpected = maxRowsVal > (tableSize - affectedID) ? (tableSize - affectedID) : maxRowsVal;
      if (maxRowsVal === 0) resultLenExpected = tableSize - affectedID;
      assert.strictEqual(result.rows.length, resultLenExpected);
      await verifyResult(result.rows);

      await connection.execute(drop_table);
    };

    it("156.2.1 maxRows > table size > oracledb.fetchArraySize", async function() {
      const tableSize = 100;
      const fetchArraySizeVal = tableSize - 50;
      const maxRowsVal = tableSize + 200;
      const affectedID = 0;
      await basicFetchWithExecOption(tableSize, fetchArraySizeVal, maxRowsVal, affectedID);
    });

    it("156.2.2 maxRows > oracledb.fetchArraySize > table size", async function() {
      const tableSize = 20;
      const fetchArraySizeVal = tableSize + 30;
      const maxRowsVal = tableSize + 50;
      const affectedID = 0;
      await basicFetchWithExecOption(tableSize, fetchArraySizeVal, maxRowsVal, affectedID);
    });

    it("156.2.3 table size > maxRows > oracledb.fetchArraySize", async function() {
      const tableSize = 199;
      const fetchArraySizeVal = tableSize - 30;
      const maxRowsVal = tableSize - 10;
      const affectedID = 0;
      await basicFetchWithExecOption(tableSize, fetchArraySizeVal, maxRowsVal, affectedID);
    });

    it("156.2.4 table size > oracledb.fetchArraySize > maxRow", async function() {
      const tableSize = 290;
      const fetchArraySizeVal = tableSize - 90;
      const maxRowsVal = tableSize - 150;
      const affectedID = 0;
      await basicFetchWithExecOption(tableSize, fetchArraySizeVal, maxRowsVal, affectedID);
    });

    it("156.2.5 maxRows = oracledb.fetchArraySize < table size", async function() {
      const tableSize = 20;
      const fetchArraySizeVal = tableSize - 3;
      const maxRowsVal = fetchArraySizeVal;
      const affectedID = 0;
      await basicFetchWithExecOption(tableSize, fetchArraySizeVal, maxRowsVal, affectedID);
    });

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

    it("156.2.7 maxRows = oracledb.fetchArraySize > table size", async function() {
      const tableSize = 10;
      const fetchArraySizeVal = tableSize + 30;
      const maxRowsVal = fetchArraySizeVal;
      const affectedID = 0;
      await basicFetchWithExecOption(tableSize, fetchArraySizeVal, maxRowsVal, affectedID);
    });

    it("156.2.8 maxRows = oracledb.fetchArraySize/10", async function() {
      const tableSize = 100;
      const fetchArraySizeVal = 30;
      const maxRowsVal = fetchArraySizeVal / 10;
      const affectedID = 0;
      await basicFetchWithExecOption(tableSize, fetchArraySizeVal, maxRowsVal, affectedID);
    });

    it("156.2.9 maxRows = 10 * oracledb.fetchArraySize", async function() {
      const tableSize = 2;
      const fetchArraySizeVal = 30;
      const maxRowsVal = fetchArraySizeVal * 10;
      const affectedID = 0;
      await basicFetchWithExecOption(tableSize, fetchArraySizeVal, maxRowsVal, affectedID);
    });

    it("156.2.10 maxRows > fetchArraySize, fetchArraySize = (table size)/10", async function() {
      const tableSize = 200;
      const fetchArraySizeVal = tableSize / 10;
      const maxRowsVal = tableSize / 10 + 50;
      const affectedID = 0;
      await basicFetchWithExecOption(tableSize, fetchArraySizeVal, maxRowsVal, affectedID);
    });

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

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

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

  const insertData = async function(tableSize) {
    const insert_data = "DECLARE \n" +
                        "    tmpchar VARCHAR2(2000); \n" +
                        "    tmplob BLOB; \n" +
                        "BEGIN \n" +
                        "    FOR i IN 1.." + tableSize + " LOOP \n" +
                        "         select to_char(i) into tmpchar from dual; \n" +
                        "         select utl_raw.cast_to_raw(tmpchar) into tmplob from dual; \n" +
                        "         insert into " + tableName + " values (i, tmplob); \n" +
                        "    END LOOP; \n" +
                        "    commit; \n" +
                        "END; ";
    await connection.execute(insert_data);
    const result = await connection.execute(
      "select id from " + tableName
    );
    assert.strictEqual(result.rows.length, tableSize);
  };

  const verifyResult = async function(rows) {
    for (const row of rows) {
      await verifyEachRow(row);
    }
  };

  const verifyEachRow = async function(row) {
    const id = row[0];
    const lob = row[1];
    const blobData = await lob.getData();
    const expected = Buffer.from((String(id)), "utf-8");
    assert.deepStrictEqual(blobData, expected);
  };

});