Internal code and test refactoring and formatting changes

Author: sharadraju

doc/src/release_notes.rst

@@ -86,6 +86,8 @@ Thin Mode Changes
 #)  Fixed bug where connections were not removed from the pool, when
     :meth:`connection.close()` method fails for some reason.
 
+#)  Internal protocol handling improvements.
+
 Thick Mode Changes
 ++++++++++++++++++
 

lib/thin/protocol/messages/base.js

@@ -80,6 +80,7 @@ class Message {
   async postProcess() { }
 
   writeFunctionHeader(buf) {
+    this.writePiggybacks(buf);
     buf.writeUInt8(this.messageType);
     buf.writeUInt8(this.functionCode);
     buf.writeSeqNum();
@@ -328,6 +329,10 @@ class Message {
   }
 
   writePiggybacks(buf) {
+    // Don't write piggybacks if not authenticated yet
+    if (this.connection._protocol.connInProgress)
+      return;
+
     if (this.connection._currentSchemaModified) {
       this._writeCurrentSchemaPiggyback(buf);
     }

lib/thin/protocol/messages/execute.js

@@ -115,7 +115,6 @@ class ExecuteMessage extends MessageWithData {
     if (this.options.autoCommit) {
       options |= constants.TNS_EXEC_OPTION_COMMIT;
     }
-    this.writePiggybacks(buf);
     this.writeFunctionHeader(buf);
     buf.writeUB4(options);                           // execute options
     buf.writeUB4(stmt.cursorId);                     // cursor id
@@ -258,7 +257,6 @@ class ExecuteMessage extends MessageWithData {
       }
       numIters = this.numExecs;
     }
-    this.writePiggybacks(buf);
     this.writeFunctionHeader(buf);
     buf.writeUB4(stmt.cursorId);
     buf.writeUB4(numIters);

lib/thin/protocol/messages/logOff.js

@@ -44,7 +44,6 @@ class LogOffMessage extends Message {
   }
 
   encode(buf) {
-    this.writePiggybacks(buf);
     this.writeFunctionHeader(buf);
   }
 

lib/thin/protocol/messages/sessionRelease.js

@@ -45,7 +45,6 @@ class SessionReleaseMessage extends Message {
   }
 
   encode(buf) {
-    this.writePiggybacks(buf);
     this.writeFunctionHeader(buf);
     buf.writeUInt8(0); // pointer (tag name)
     buf.writeUInt8(0); // tag name length

src/njsModule.h

@@ -203,6 +203,9 @@ typedef struct njsBaton njsBaton;
 typedef struct njsClassDef njsClassDef;
 typedef struct njsConnection njsConnection;
 typedef struct njsDataTypeInfo njsDataTypeInfo;
+typedef struct njsDbObject njsDbObject;
+typedef struct njsDbObjectType njsDbObjectType;
+typedef struct njsDbObjectAttr njsDbObjectAttr;
 typedef struct njsImplicitResult njsImplicitResult;
 typedef struct njsJsonBuffer njsJsonBuffer;
 typedef struct njsLob njsLob;
@@ -216,12 +219,9 @@ typedef struct njsSodaDocCursor njsSodaDocCursor;
 typedef struct njsSodaDocument njsSodaDocument;
 typedef struct njsSodaOperation njsSodaOperation;
 typedef struct njsSubscription njsSubscription;
+typedef struct njsTokenCallback njsTokenCallback;
 typedef struct njsVariable njsVariable;
 typedef struct njsVariableBuffer njsVariableBuffer;
-typedef struct njsDbObject njsDbObject;
-typedef struct njsDbObjectType njsDbObjectType;
-typedef struct njsDbObjectAttr njsDbObjectAttr;
-typedef struct njsTokenCallback njsTokenCallback;
 
 
 //-----------------------------------------------------------------------------

src/njsUtils.c

@@ -878,7 +878,7 @@ bool njsUtils_validateArgs(napi_env env, napi_callback_info info,
 // njsUtils_setIntervalYM()
 //   Set the value of the interval year-to-month(YM) value from a JavaScript
 // IntervalYM object. It includes the "year" and "month" properties. At this
-// point it is assumed that the property values are intergers.
+// point it is assumed that the property values are integers.
 //-----------------------------------------------------------------------------
 bool njsUtils_setIntervalYM(napi_env env, napi_value value,
         dpiIntervalYM *data)
@@ -898,7 +898,7 @@ bool njsUtils_setIntervalYM(napi_env env, napi_value value,
 //   Set the value of the interval day-to-second(DS) value from a JavaScript
 // IntervalYM object. It includes the "days", "hours", "minutes", "seconds"
 // and "fseconds" (fractional seconds denoted in ns) properties. At this
-// point it is assumed that the property values are intergers.
+// point it is assumed that the property values are integers.
 //-----------------------------------------------------------------------------
 bool njsUtils_setIntervalDS(napi_env env, napi_value value,
         dpiIntervalDS *data)

test/bigInt.js

@@ -216,7 +216,6 @@ describe('300. bigInt.js', function() {
       // in JS Number.
       assert(result.outBinds.t.TESTNUMBER === num);
       assert(typeof result.outBinds.t.TESTNUMBER == 'bigint');
-      console.log(BigInt.prototype.toJSON);
       BigInt.prototype.toJSON = function() {
         return this.toString();
       };

test/lobBindAsStringBuffer.js

@@ -37,6 +37,7 @@ const dbConfig = require('./dbconfig.js');
 const fs = require('fs');
 const fsPromises = require('fs/promises');
 const random = require('./random.js');
+const { Readable } = require('stream');
 
 describe('80. lobBindAsStringBuffer.js', function() {
   let connection;
@@ -486,6 +487,57 @@ describe('80. lobBindAsStringBuffer.js', function() {
       assert.strictEqual(result.outBinds.blob.toString('utf8', (resultLength2 - specStrLength), resultLength2), specialStr);
     }); // 80.3.2
 
+    it('80.3.3 PLSQL, BIND_INOUT, bind a 32K string using temp lob and a 32K buffer', async function() {
+      const specialStr = "80.3.3";
+      const size = 32768;
+      const bigStr = random.getRandomString(size, specialStr);
+      const clob = await connection.createLob(oracledb.CLOB);
+      const inStream = Readable.from([bigStr]);
+      inStream.pipe(clob);
+      await new Promise((resolve, reject) => {
+        inStream.on("error", reject);
+        clob.on("error", reject);
+        clob.on("finish", resolve);
+      });
+      const bufferStr = Buffer.from(bigStr, "utf-8");
+      const blob = await connection.createLob(oracledb.CLOB);
+      const inStream2 = Readable.from([bufferStr]);
+      inStream2.pipe(blob);
+      await new Promise((resolve, reject) => {
+        inStream.on("error", reject);
+        blob.on("error", reject);
+        blob.on("finish", resolve);
+      });
+
+      const bindVar = {
+        clob: { dir: oracledb.BIND_INOUT, type: oracledb.CLOB, val: clob },
+        blob: { dir: oracledb.BIND_INOUT, type: oracledb.BUFFER, val: bufferStr,
+          maxSize: size }
+      };
+      const result = await connection.execute(sqlRun, bindVar);
+      const cloboutstr = await result.outBinds.clob.getData();
+      const specStrLength = specialStr.length;
+      const resultLength1 = result.outBinds.clob.length;
+      assert.strictEqual(resultLength1, size);
+      assert.strictEqual(cloboutstr.substring(0, specStrLength), specialStr);
+      assert.strictEqual(cloboutstr.substring(resultLength1 - specStrLength,
+        resultLength1), specialStr);
+      const resultLength2 = result.outBinds.blob.length;
+      assert.strictEqual(resultLength2, size);
+      assert.strictEqual(result.outBinds.blob.toString('utf8',
+        0, specStrLength), specialStr);
+      assert.strictEqual(result.outBinds.blob.toString('utf8',
+        (resultLength2 - specStrLength), resultLength2), specialStr);
+      await new Promise((resolve) => {
+        clob.once('close', resolve);
+        clob.destroy();
+      });
+      await new Promise((resolve) => {
+        blob.once('close', resolve);
+        blob.destroy();
+      });
+    }); // 80.3.3
+
   }); // 80.3
 
 });

test/lobClose.js

@@ -34,6 +34,7 @@
 const oracledb = require('oracledb');
 const assert   = require('assert');
 const dbConfig = require('./dbconfig.js');
+const testUtil = require('./testsUtil.js');
 const fs       = require('fs');
 
 describe('54. lobClose.js', function() {
@@ -107,18 +108,20 @@ describe('54. lobClose.js', function() {
 
   it('54.5 temp LOBs should be freed in next rpc', async function() {
     const conn2 = await oracledb.getConnection(dbConfig);
+    const sid = await testUtil.getSid(conn2);
     const tempLOBArray = [];
     const numLOBs = 20;
-    const query = "select cache_lobs+nocache_lobs from v$temporary_lobs where sid = sys_context('USERENV','SID')";
+    const query = "select cache_lobs+nocache_lobs from v$temporary_lobs where sid = :SID";
 
     // Create multiple temp LOB's
     for (let i = 0; i < numLOBs; i++) {
       tempLOBArray[i] = await conn2.createLob(oracledb.CLOB);
     }
 
     // Check number of opened temp LOB's
-    let result = await conn2.execute(query);
-    let numTempLOBs = result.rows[0][0];
+    await conn2.ping();
+    let result = await conn.execute(query, {SID: sid});
+    const numTempLOBs = result.rows[0][0];
     assert.strictEqual(numTempLOBs, numLOBs);
 
     // Destroy multiple temp LOB's
@@ -129,10 +132,11 @@ describe('54. lobClose.js', function() {
       });
     }
 
-    // temp LOB's should be freed on roundtrip (like execute) as piggybacks are sent for closing temp LOB's
-    result = await conn2.execute(query);
-    numTempLOBs = result.rows[0][0];
-    assert.strictEqual(numTempLOBs, 0);
+    // temp LOB's should be freed on roundtrip (like ping) as piggybacks are sent for closing temp LOB's
+    await conn2.ping();
+    result = await conn.execute(query, {SID: sid});
+    // if no temp lobs exist, the query will not return any rows
+    assert.strictEqual(result.rows.length, 0);
     await conn2.close();
   }); // 54.5