feat: add flag parsing and tests for returnvalue token

Author: Suraiya Hameed

src/tokens/returnvalue/index.js

@@ -8,17 +8,6 @@ class ReturnValueToken extends Token {
   paramName: ?string
   status: ?number
   userType: ?number
-  // TODO: parser flag
-  flags: {
-        nullable: ?boolean,
-        caseSensitive: ?boolean,
-        updateable: ?boolean,
-        identity: ?boolean,
-        computed: ?boolean,
-        reservedODBC: ?boolean,
-        fixedLenCLRType: ?boolean,
-        encrypted: ?boolean
-    }
   typeInfo: ?TypeInfo
   valueLength: ?number
   value: ?any
@@ -30,16 +19,6 @@ class ReturnValueToken extends Token {
     this.paramName = undefined;
     this.status = undefined;
     this.userType = undefined;
-    this.flags = {
-      nullable: undefined,
-      caseSensitive: undefined,
-      updateable: undefined,
-      identity: undefined,
-      computed: undefined,
-      reservedODBC: undefined,
-      fixedLenCLRType: undefined,
-      encrypted: undefined
-    };
     this.typeInfo = undefined;
     this.valueLength = undefined;
     this.value = undefined;

src/tokens/returnvalue/read.js

@@ -59,48 +59,16 @@ function parseUserType_7_2(reader: Reader) {
 }
 
 function parseFlags(reader: Reader) {
-  if (reader.version < 0x72090002) {
-    return parseFlags_7_0;
-  } else if (reader.version < 0x74000004) {
-    return parseFlags_7_2;
-  } else {
-    return parseFlags_7_4;
-  }
-}
-
-
-function parseFlags_7_0(reader: Reader) {
+  // for RETURNVALUE_TOKEN all the flags should be zero (TDS 2.2.7.18)
   if (!reader.bytesAvailable(2)) {
     return;
   }
 
-  // TODO: Implement flag parsing
   const flags = reader.readUInt16LE(0); // eslint-disable-line no-unused-vars
   reader.consumeBytes(2);
 
-  return parseTypeInfo;
-}
-
-function parseFlags_7_2(reader: Reader) {
-  if (!reader.bytesAvailable(2)) {
-    return;
-  }
-
-  // TODO: Implement flag parsing
-  const flags = reader.readUInt16LE(0); // eslint-disable-line no-unused-vars
-  reader.consumeBytes(2);
-
-  return parseTypeInfo;
-}
-
-function parseFlags_7_4(reader: Reader) {
-  if (!reader.bytesAvailable(2)) {
-    return;
-  }
-
-  // TODO: Implement flag parsing
-  const flags = reader.readUInt16LE(0); // eslint-disable-line no-unused-vars
-  reader.consumeBytes(2);
+  if (0 != flags)
+    throw new Error('Unknown flags in RETURNVALUE_TOKEN ');
 
   return parseTypeInfo;
 }

test/returnValue-test.js

@@ -15,13 +15,14 @@ describe('Parsing a RETURNVALUE token', function() {
 
   describe('in TDS 7.0 mode', function() {
 
-    let reader, data, paramOrdinal, paramName, status, userType, typeid, dataLength, value, offset, tempBuff;
+    let reader, data, paramOrdinal, paramName, status, userType, flag, typeid, dataLength, value, offset, tempBuff;
 
     before(function() {
       paramOrdinal = 1;
       paramName = '@count';
       status = 1;
       userType = 0;
+      flag = 0;
       typeid = 0x26;
       value = 4;
       offset = 0;
@@ -60,8 +61,7 @@ describe('Parsing a RETURNVALUE token', function() {
       tempBuff.writeUInt8(status, offset++);
       tempBuff.writeUInt16LE(userType, offset);
       offset += 2;
-      // Flag
-      tempBuff.writeUInt16LE(0, offset);
+      tempBuff.writeUInt16LE(flag, offset);
       offset += 2;
     }
 
@@ -82,19 +82,43 @@ describe('Parsing a RETURNVALUE token', function() {
       addListners(done, token);
       reader.end(data);
     });
+
+    it('should throw exception on receiving non-zero flag', function(done) {
+      dataLength = 4;
+
+      data = Buffer.alloc(28);
+      tempBuff.copy(data, 0, 0, offset - 2);
+
+      // write non-zero flag
+      data.writeUInt16LE(56, offset - 2);
+
+      // TYPE_INFO
+      data.writeUInt8(typeid, offset++);
+      data.writeUInt8(dataLength, offset++);
+
+      // TYPE_VARBYTE
+      data.writeUInt8(dataLength, offset++);
+      data.writeUInt32LE(value, offset);
+      const token = {};
+
+      addListners(done, token);
+      assert.throw(() => reader.end(data), Error, 'Unknown flags in RETURNVALUE_TOKEN');
+      done();
+    });
   });
 
   describe('in TDS 7.2 mode', function() {
 
     describe('test INTNTYPE', function() {
 
-      let reader, data, paramOrdinal, paramName, status, userType, typeid, dataLength, value, offset, tempBuff, tempOffset;
+      let reader, data, paramOrdinal, paramName, status, userType, flag, typeid, dataLength, value, offset, tempBuff, tempOffset;
 
       before(function() {
         paramOrdinal = 1;
         paramName = '@count';
         status = 1;
         userType = 0;
+        flag = 0;
         typeid = 0x26;
         value = 4;
         tempOffset = 0;
@@ -133,8 +157,7 @@ describe('Parsing a RETURNVALUE token', function() {
         tempBuff.writeUInt8(status, tempOffset++);
         tempBuff.writeUInt32LE(userType, tempOffset);
         tempOffset += 4;
-        // Flag
-        tempBuff.writeUInt16LE(0, tempOffset);
+        tempBuff.writeUInt16LE(flag, tempOffset);
         tempOffset += 2;
       }