Add BigInt support for binding values

Author: sharadraju

doc/src/release_notes.rst

@@ -23,11 +23,16 @@ Common Changes
 #)  Added support for an Oracle Database 23c JSON feature improving JSON
     storage usage.
 
-#)  Updated error thrown during pool reconfiguration while poolMax is 0 from
-    `ORA-24413` to `NJS-007`.
+#)  Updated error thrown during pool reconfiguration from `ORA-24413` to
+    `NJS-007` when poolMax is 0.
 
-#)  Added new condition check during pool reconfiguration for `poolMin > poolMax`
-    and error `NJS-092` will be thrown.
+#)  Throw `NJS-092`` error if `poolMin` > `poolMax` during pool
+    reconfiguration.
+
+#)  Added support for binding BigInt values. BigInts like ``123n`` can
+    be passed to ``connection.execute()``, ``connection.executeMany()``.
+    See `PR #1572 <https://github.com/oracle/node-oracledb/pull/1572>`__
+    (Slawomir Osoba).
 
 Thin Mode Changes
 ++++++++++++++++++

lib/connection.js

@@ -200,6 +200,7 @@ class Connection extends EventEmitter {
       typeof value === 'number' ||
       typeof value === 'string' ||
       typeof value === 'boolean' ||
+      typeof value === 'bigint' ||
       Array.isArray(value) ||
       value instanceof Float32Array ||
       value instanceof Float64Array ||

lib/transformer.js

@@ -172,7 +172,7 @@ function transformValueIn(info, value, options) {
     return value;
 
   // handle numbers
-  } else if (typeof value === 'number') {
+  } else if (typeof value === 'number' || typeof value === 'bigint') {
     checkType(info, options,
       types.DB_TYPE_NUMBER,
       types.DB_TYPE_BINARY_INTEGER,

src/njsVariable.c

@@ -823,7 +823,7 @@ bool njsVariable_setScalarValue(njsVariable *var, uint32_t pos, napi_env env,
     }
 
     // handle binding numbers
-    if (valueType == napi_number) {
+    if (valueType == napi_number || valueType == napi_bigint) {
         if (var->varTypeNum == DPI_ORACLE_TYPE_NUMBER) {
             NJS_CHECK_NAPI(env, napi_coerce_to_string(env, value, &numStr));
             return njsVariable_setFromString(var, pos, env, numStr, baton);

test/bigInt.js

@@ -0,0 +1,113 @@
+/* Copyright 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
+ *   300. bigInt.js
+ *
+ * DESCRIPTION
+ *   Test cases related to use of bigInts for binding and fetching.
+ *
+ *****************************************************************************/
+'use strict';
+
+const oracledb = require('oracledb');
+const dbConfig = require('./dbconfig.js');
+const assert = require('assert');
+
+describe('300. bigInt.js', function() {
+  let connection;
+  const createTable = `CREATE TABLE nodb_bigint (id NUMBER)`;
+  const dropTable = `DROP TABLE nodb_bigint PURGE`;
+
+  before('get connection and create table', async function() {
+    connection = await oracledb.getConnection(dbConfig);
+    await connection.execute(createTable);
+  });
+
+  after('drop table and release connection', async function() {
+    await connection.execute(dropTable);
+    await connection.close();
+  });
+
+  describe('300.1 can bind bigInts', function() {
+
+    it('300.1.1 with execute', async function() {
+      const sql = 'INSERT INTO nodb_bigint VALUES(:1)';
+      const bind = [123n];
+      await assert.doesNotReject(connection.execute(sql, bind));
+    }); //300.1.1
+
+    it('300.1.2 with executeMany', async function() {
+      const sql = 'INSERT INTO nodb_bigint VALUES(:a)';
+      const binds = [
+        { a: 1234n },
+        { a: 98765432123456n },
+        { a: -1234n },
+        { a: BigInt(Number.MAX_SAFE_INTEGER) + 1n }
+      ];
+      const options = {
+        bindDefs: {
+          a: { type: oracledb.NUMBER }
+        }
+      };
+      await assert.doesNotReject(connection.executeMany(sql, binds, options));
+    }); //300.1.2
+
+  }); //300.1
+
+  describe('300.2 fetch values', function() {
+    const sql = 'SELECT id FROM nodb_bigint WHERE id = :1';
+    const bind = [ 123n ];
+
+    afterEach('Reset oracledb.fetchTypeHandler property', function() {
+      oracledb.fetchTypeHandler = undefined;
+    });
+
+    it('300.2.1 fetches the value as number(default)', async function() {
+      const result = await connection.execute(sql, bind);
+      assert.deepStrictEqual(result.rows[0][0], 123);
+    }); //300.2.1
+
+    it('300.2.2 use fetchTypeHandler to get BigInt value', async function() {
+      const myFetchTypeHandler = function() {
+        return {converter: (val) => BigInt(val)};
+      };
+
+      oracledb.fetchTypeHandler = myFetchTypeHandler;
+
+      const result = await connection.execute(sql, bind);
+      assert.deepStrictEqual(result.rows[0][0], 123n);
+    }); //300.2.2
+
+    it('300.2.3 fetches values greater than Number.MAX_SAFE_INTEGER correctly', async function() {
+      const bindval = [ BigInt(Number.MAX_SAFE_INTEGER) + 1n ];
+
+      const result = await connection.execute(sql, bindval);
+      assert.deepStrictEqual(result.rows[0][0], Number.MAX_SAFE_INTEGER + 1);
+
+    }); //300.2.3
+
+  }); //300.2
+
+}); //300

test/list.txt

@@ -5812,3 +5812,12 @@ oracledb.OUT_FORMAT_OBJECT and resultSet =  true
 
   299. invalidNumber.js
     299.1 throws error for invalid numbers
+
+  300. bigInt.js
+    300.1 can bind bigInts
+      300.1.1 with execute
+      300.1.2 with executeMany
+    300.2 fetch values
+      300.2.1 fetches the value as number(default)
+      300.2.2 use fetchTypeHandler to get BigInt value
+      300.2.3 fetches values greater than Number.MAX_SAFE_INTEGER correctly

test/opts/.mocharc.yaml

@@ -281,3 +281,4 @@ spec:
   - test/dataTypeVector3.js
   - test/jsonDualityViews7.js
   - test/invalidNumber.js
+  - test/bigInt.js