feat: write collation for nvarchar, nchar, ntext , varchar, `…

…char` and `text` data types
tediousjs · Aug 16, 2021 · b1db199 · b1db199
1 parent d27a7e0
commit b1db199
Show file tree

Hide file tree

Showing 10 changed files with 46 additions and 15 deletions.
diff --git a/src/always-encrypted/get-parameter-encryption-metadata.ts b/src/always-encrypted/get-parameter-encryption-metadata.ts
@@ -97,5 +97,5 @@ export const getParameterEncryptionMetadata = (connection: Connection, request:
     resultRows.push(columns);
   });
 
-  connection.makeRequest(metadataRequest, TYPE.RPC_REQUEST, new RpcRequestPayload(metadataRequest.sqlTextOrProcedure!, metadataRequest.parameters, connection.currentTransactionDescriptor(), connection.config.options));
+  connection.makeRequest(metadataRequest, TYPE.RPC_REQUEST, new RpcRequestPayload(metadataRequest.sqlTextOrProcedure!, metadataRequest.parameters, connection.currentTransactionDescriptor(), connection.config.options, connection.databaseCollation));
 };
diff --git a/src/connection.ts b/src/connection.ts
@@ -2808,7 +2808,7 @@ class Connection extends EventEmitter {
       parameters.push(...request.parameters);
     }
 
-    this.makeRequest(request, TYPE.RPC_REQUEST, new RpcRequestPayload('sp_executesql', parameters, this.currentTransactionDescriptor(), this.config.options));
+    this.makeRequest(request, TYPE.RPC_REQUEST, new RpcRequestPayload('sp_executesql', parameters, this.currentTransactionDescriptor(), this.config.options, this.databaseCollation));
   }
 
   /**
@@ -3022,7 +3022,7 @@ class Connection extends EventEmitter {
       }
     });
 
-    this.makeRequest(request, TYPE.RPC_REQUEST, new RpcRequestPayload('sp_prepare', parameters, this.currentTransactionDescriptor(), this.config.options));
+    this.makeRequest(request, TYPE.RPC_REQUEST, new RpcRequestPayload('sp_prepare', parameters, this.currentTransactionDescriptor(), this.config.options, this.databaseCollation));
   }
 
   /**
@@ -3046,7 +3046,7 @@ class Connection extends EventEmitter {
       scale: undefined
     });
 
-    this.makeRequest(request, TYPE.RPC_REQUEST, new RpcRequestPayload('sp_unprepare', parameters, this.currentTransactionDescriptor(), this.config.options));
+    this.makeRequest(request, TYPE.RPC_REQUEST, new RpcRequestPayload('sp_unprepare', parameters, this.currentTransactionDescriptor(), this.config.options, this.databaseCollation));
   }
 
   /**
@@ -3092,7 +3092,7 @@ class Connection extends EventEmitter {
       return;
     }
 
-    this.makeRequest(request, TYPE.RPC_REQUEST, new RpcRequestPayload('sp_execute', executeParameters, this.currentTransactionDescriptor(), this.config.options));
+    this.makeRequest(request, TYPE.RPC_REQUEST, new RpcRequestPayload('sp_execute', executeParameters, this.currentTransactionDescriptor(), this.config.options, this.databaseCollation));
   }
 
   /**
@@ -3114,7 +3114,7 @@ class Connection extends EventEmitter {
       return;
     }
 
-    this.makeRequest(request, TYPE.RPC_REQUEST, new RpcRequestPayload(request.sqlTextOrProcedure!, request.parameters, this.currentTransactionDescriptor(), this.config.options));
+    this.makeRequest(request, TYPE.RPC_REQUEST, new RpcRequestPayload(request.sqlTextOrProcedure!, request.parameters, this.currentTransactionDescriptor(), this.config.options, this.databaseCollation));
   }
 
   /**

diff --git a/src/data-type.ts b/src/data-type.ts
@@ -40,6 +40,7 @@ import Variant from './data-types/sql-variant';
 import { CryptoMetadata } from './always-encrypted/types';
 
 import { InternalConnectionOptions } from './connection';
+import { Collation } from './collation';
 
 export interface Parameter {
   type: DataType;
@@ -51,12 +52,6 @@ export interface Parameter {
   length?: number;
   precision?: number;
   scale?: number;
-  collation?: {
-    lcid: number;
-    flags: number;
-    version: number;
-    sortId: number;
-  };
 
   nullable?: boolean;
 
@@ -71,6 +66,8 @@ export interface ParameterData<T = any> {
   scale?: number;
   precision?: number;
 
+  collation?: Collation;
+
   value: T;
 }
 

diff --git a/src/data-types/char.ts b/src/data-types/char.ts
@@ -50,6 +50,11 @@ const Char: { maximumLength: number } & DataType = {
     const buffer = Buffer.alloc(8);
     buffer.writeUInt8(this.id, 0);
     buffer.writeUInt16LE(parameter.length!, 1);
+
+    if (parameter.collation) {
+      parameter.collation.toBuffer().copy(buffer, 3, 0, 5);
+    }
+
     return buffer;
   },
 

diff --git a/src/data-types/nchar.ts b/src/data-types/nchar.ts
@@ -51,6 +51,11 @@ const NChar: DataType & { maximumLength: number } = {
     const buffer = Buffer.alloc(8);
     buffer.writeUInt8(this.id, 0);
     buffer.writeUInt16LE(parameter.length! * 2, 1);
+
+    if (parameter.collation) {
+      parameter.collation.toBuffer().copy(buffer, 3, 0, 5);
+    }
+
     return buffer;
   },
 

diff --git a/src/data-types/ntext.ts b/src/data-types/ntext.ts
@@ -27,7 +27,11 @@ const NText: DataType = {
     const buffer = Buffer.alloc(10);
     buffer.writeUInt8(this.id, 0);
     buffer.writeInt32LE(parameter.length!, 1);
-    // TODO: Collation handling
+
+    if (parameter.collation) {
+      parameter.collation.toBuffer().copy(buffer, 5, 0, 5);
+    }
+
     return buffer;
   },
 

diff --git a/src/data-types/nvarchar.ts b/src/data-types/nvarchar.ts
@@ -59,6 +59,10 @@ const NVarChar: { maximumLength: number } & DataType = {
       buffer.writeUInt16LE(MAX, 1);
     }
 
+    if (parameter.collation) {
+      parameter.collation.toBuffer().copy(buffer, 3, 0, 5);
+    }
+
     return buffer;
   },
 

diff --git a/src/data-types/text.ts b/src/data-types/text.ts
@@ -27,7 +27,11 @@ const Text: DataType = {
     const buffer = Buffer.alloc(10);
     buffer.writeUInt8(this.id, 0);
     buffer.writeInt32LE(parameter.length!, 1);
-    // TODO: Collation handling
+
+    if (parameter.collation) {
+      parameter.collation.toBuffer().copy(buffer, 5, 0, 5);
+    }
+
     return buffer;
   },
 
@@ -53,6 +57,7 @@ const Text: DataType = {
     if (value == null) {
       return null;
     }
+
     if (typeof value !== 'string') {
       if (typeof value.toString !== 'function') {
         throw new TypeError('Invalid string.');

diff --git a/src/data-types/varchar.ts b/src/data-types/varchar.ts
@@ -60,6 +60,10 @@ const VarChar: { maximumLength: number } & DataType = {
       buffer.writeUInt16LE(MAX, 1);
     }
 
+    if (parameter.collation) {
+      parameter.collation.toBuffer().copy(buffer, 3, 0, 5);
+    }
+
     return buffer;
   },
 

diff --git a/src/rpcrequest-payload.ts b/src/rpcrequest-payload.ts
@@ -2,6 +2,7 @@ import WritableTrackingBuffer from './tracking-buffer/writable-tracking-buffer';
 import { writeToTrackingBuffer } from './all-headers';
 import { Parameter, ParameterData } from './data-type';
 import { InternalConnectionOptions } from './connection';
+import { Collation } from './collation';
 
 // const OPTION = {
 //   WITH_RECOMPILE: 0x01,
@@ -23,12 +24,14 @@ class RpcRequestPayload implements Iterable<Buffer> {
 
   options: InternalConnectionOptions;
   txnDescriptor: Buffer;
+  collation: Collation | undefined;
 
-  constructor(procedure: string | number, parameters: Parameter[], txnDescriptor: Buffer, options: InternalConnectionOptions) {
+  constructor(procedure: string | number, parameters: Parameter[], txnDescriptor: Buffer, options: InternalConnectionOptions, collation: Collation | undefined) {
     this.procedure = procedure;
     this.parameters = parameters;
     this.options = options;
     this.txnDescriptor = txnDescriptor;
+    this.collation = collation;
   }
 
   [Symbol.iterator]() {
@@ -99,6 +102,10 @@ class RpcRequestPayload implements Iterable<Buffer> {
       param.scale = type.resolveScale(parameter);
     }
 
+    if (this.collation) {
+      param.collation = this.collation;
+    }
+
     yield type.generateTypeInfo(param, this.options);
     yield type.generateParameterLength(param, this.options);
     yield * type.generateParameterData(param, this.options);