Validate sparse index array values

Author: sharadraju

examples/vectorSparse.js

@@ -166,7 +166,7 @@ async function run() {
       /ORA-51803:/
     );
 
-    const sparseQueryVec = new oracledb.SparseVector({ values: queryVector, indices: [2, 4], numDimensions: 4 });
+    const sparseQueryVec = new oracledb.SparseVector({ values: queryVector, indices: [2, 3], numDimensions: 4 });
     console.log('vector distance with Query ', queryVector);
     console.log(await connection.execute(`select vector_distance (sparseF64, :1) from ${tableName}`, [sparseQueryVec]));
 

lib/errors.js

@@ -171,6 +171,7 @@ const ERR_VECTOR_SPARSE_INDICES_VALUES_NOT_EQUAL = 161;
 const ERR_VECTOR_SPARSE_INVALID_JSON = 162;
 const ERR_VECTOR_SPARSE_INVALID_STRING = 163;
 const ERR_VECTOR_SPARSE_INVALID_INPUT = 164;
+const ERR_VECTOR_SPARSE_INDICES_ELEM_IS_NOT_VALID = 165;
 
 // Oracle Net layer errors start from 500
 const ERR_CONNECTION_CLOSED = 500;
@@ -475,7 +476,7 @@ messages.set(ERR_OPERATION_ONLY_SUPPORTED_ON_BFILE,     // NJS-156
 messages.set(ERR_EXECMANY_NOT_ALLOWED_ON_QUERIES,       // NJS-157
   'executeMany() cannot be used with SELECT statement or WITH SQL clause');
 messages.set(ERR_VECTOR_SPARSE_INDICES_IS_NOT_ARRAY,    // NJS-158
-  'SPARSE VECTOR indices is not an Array');
+  'SPARSE VECTOR indices is not Uint32Array or an Array');
 messages.set(ERR_VECTOR_SPARSE_VALUES_IS_NOT_ARRAY,     // NJS-159
   'SPARSE VECTOR values is not an Array');
 messages.set(ERR_VECTOR_SPARSE_DIMS_IS_NOT_INTEGER,     // NJS-160
@@ -488,6 +489,8 @@ messages.set(ERR_VECTOR_SPARSE_INVALID_STRING,         // NJS-163
   'SPARSE VECTOR string data Array should have exactly 3 elements');
 messages.set(ERR_VECTOR_SPARSE_INVALID_INPUT,           // NJS-164
   'SPARSE VECTOR Invalid Input Data');
+messages.set(ERR_VECTOR_SPARSE_INDICES_ELEM_IS_NOT_VALID,    // NJS-165
+  'SPARSE VECTOR indices element at index %d is not valid');
 
 // Oracle Net layer errors
 
@@ -937,6 +940,7 @@ module.exports = {
   ERR_VECTOR_SPARSE_INVALID_JSON,
   ERR_VECTOR_SPARSE_INVALID_STRING,
   ERR_VECTOR_SPARSE_INVALID_INPUT,
+  ERR_VECTOR_SPARSE_INDICES_ELEM_IS_NOT_VALID,
   WRN_COMPILATION_CREATE,
   assert,
   assertArgCount,

lib/types.js

@@ -33,6 +33,7 @@ const util = require('util');
 const dbTypeByNum = new Map();
 const dbTypeByOraTypeNum = new Map();
 const dbTypeByColumnTypeName = new Map();
+const MAX_UINT32 = Math.pow(2, 32) - 1;
 
 // define class used for database types
 class DbType {
@@ -343,8 +344,6 @@ class JsonId extends Uint8Array {
 // indices must be an regular Array
 // values can be regular or typedArray.
 class SparseVector {
-  // It also takes skipChecks which is made true for avoiding checks if
-  // the SparseVector is constructed internally.
   constructor(input) {
     this._indices = new Uint32Array(0);
     this._values = new Float64Array(0);
@@ -353,25 +352,29 @@ class SparseVector {
     if (!input) {
       return;
     }
-    if (typeof input === 'string') {
+    if (typeof input === 'object' &&
+      "numDimensions" in input &&
+      "indices" in input &&
+      "values" in input
+    ) {
+      // Object has valid properties for Sparse.
+      this._fromObject(input);
+    } else if (typeof input === 'string') {
       // initialize from string.
       this._fromString(input);
     } else if (this._validDenseArray(input)) {
       // dense array
       this._fromDense(input);
-    } else if (typeof input === 'object') {
-      this._fromObject(input);
     } else {
       errors.throwErr(errors.ERR_VECTOR_SPARSE_INVALID_INPUT);
     }
   }
 
-  _validDenseArray(value, isIndices = false) {
-    const valid = (value instanceof Float32Array ||
+  _validDenseArray(value) {
+    return (value instanceof Float32Array ||
       value instanceof Float64Array ||
       value instanceof Int8Array || (Object.getPrototypeOf(value)
         === Uint8Array.prototype) || Array.isArray(value));
-    return !isIndices ? valid : valid || value instanceof Uint32Array;
   }
 
   // Check if indexArray and valuesArray have the same length
@@ -388,7 +391,7 @@ class SparseVector {
     if (!this._validDenseArray(values)) {
       errors.throwErr(errors.ERR_VECTOR_SPARSE_VALUES_IS_NOT_ARRAY);
     }
-    if (!(this._validDenseArray(indices, true))) {
+    if (!(indices instanceof Uint32Array) && !Array.isArray(indices)) {
       errors.throwErr(errors.ERR_VECTOR_SPARSE_INDICES_IS_NOT_ARRAY);
     }
     SparseVector._validateLengths(indices, values);
@@ -402,14 +405,27 @@ class SparseVector {
     this._convertToTypedArrays();
   }
 
-  _fromObject(input, skipChecks = false) {
-    this._updateProperties(input.numDimensions, input.indices, input.values, skipChecks);
+  _fromObject(input) {
+    this._updateProperties(input.numDimensions, input.indices, input.values);
   }
 
   _convertToTypedArrays() {
     // convert to typed arrays.
-    this._indices = this._indices instanceof Uint32Array ? this._indices :
-      new Uint32Array(this._indices);
+    if (!(this._indices instanceof Uint32Array)) {
+      // validate elements are valid uint32 type.
+      const indices = new Uint32Array(this._indices.map((x, index) => {
+        if (typeof x !== 'number' || !Number.isInteger(x)) {
+          errors.throwErr(errors.ERR_VECTOR_SPARSE_INDICES_ELEM_IS_NOT_VALID, index);
+        }
+        if (x < 0 || x > MAX_UINT32 || x > (this.numDimensions - 1)) {
+          errors.throwErr(errors.ERR_VECTOR_SPARSE_INDICES_ELEM_IS_NOT_VALID,
+            index);
+        }
+        return x;
+      }));
+      this._indices = indices;
+    }
+
     this._values = Array.isArray(this._values) ? new Float64Array(this._values)
       : this._values;
   }
@@ -428,8 +444,8 @@ class SparseVector {
         this._values.push(input[i]);
       }
     }
-    this._convertToTypedArrays();
     this._numDimensions = input.length;
+    this._convertToTypedArrays();
   }
 
   // parse a string input into a sparse vector

test/dataTypeJson.js

@@ -217,7 +217,7 @@ describe('244.dataTypeJson.js', function() {
         "key23": [new oracledb.SparseVector(
           {
             values: new Float64Array([-992.1, 994.3]),
-            indices: new Uint8Array([0, 2]),
+            indices: new Uint32Array([0, 2]),
             numDimensions: 4
           })]
       };