Add MSSQL cert support options for knex

Author: damms005

README.md

@@ -188,6 +188,18 @@ The configuration file should contain a single array of database connection obje
 	{
 		"type": "sqlite",
 		"path": "/path/to/database.sqlite"
+	},
+	{
+		"name": "My MSSQL database",
+		"type": "mssql",
+		"host": "localhost",
+		"port": "1433",
+		"username": "sa",
+		"password": "YourPassword123",
+		"database": "master",
+		"options": {
+			"trustServerCertificate": true
+		}
 	}
 ]
 ```

schemas/devdbrc.json

@@ -8,11 +8,16 @@
     "oneOf": [
       {
         "title": "SQLite Configuration",
-        "required": ["type", "path"],
+        "required": [
+          "type",
+          "path"
+        ],
         "properties": {
           "type": {
             "type": "string",
-            "enum": ["sqlite"],
+            "enum": [
+              "sqlite"
+            ],
             "description": "Database type - SQLite"
           },
           "path": {
@@ -23,15 +28,23 @@
       },
       {
         "title": "MySQL/MariaDB Configuration",
-        "required": ["type", "username", "password", "database"],
+        "required": [
+          "type",
+          "username",
+          "password",
+          "database"
+        ],
         "properties": {
           "name": {
             "type": "string",
             "description": "Optional name for this connection"
           },
           "type": {
             "type": "string",
-            "enum": ["mysql", "mariadb"],
+            "enum": [
+              "mysql",
+              "mariadb"
+            ],
             "description": "Database type - MySQL or MariaDB"
           },
           "host": {
@@ -55,20 +68,32 @@
           "database": {
             "type": "string",
             "description": "Database name"
+          },
+          "options": {
+            "type": "object",
+            "description": "Driver-specific options for MSSQL, e.g. trustServerCertificate",
+            "additionalProperties": true
           }
         }
       },
       {
         "title": "PostgreSQL Configuration",
-        "required": ["type", "username", "password", "database"],
+        "required": [
+          "type",
+          "username",
+          "password",
+          "database"
+        ],
         "properties": {
           "name": {
             "type": "string",
             "description": "Optional name for this connection"
           },
           "type": {
             "type": "string",
-            "enum": ["postgres"],
+            "enum": [
+              "postgres"
+            ],
             "description": "Database type - PostgreSQL"
           },
           "host": {
@@ -97,15 +122,22 @@
       },
       {
         "title": "Microsoft SQL Server Configuration",
-        "required": ["type", "username", "password", "database"],
+        "required": [
+          "type",
+          "username",
+          "password",
+          "database"
+        ],
         "properties": {
           "name": {
             "type": "string",
             "description": "Optional name for this connection"
           },
           "type": {
             "type": "string",
-            "enum": ["mssql"],
+            "enum": [
+              "mssql"
+            ],
             "description": "Database type - Microsoft SQL Server"
           },
           "host": {
@@ -134,4 +166,4 @@
       }
     ]
   }
-}
+}

snippets/devdbrc.json

@@ -64,7 +64,10 @@
       "\t\"port\": ${3:1433},",
       "\t\"username\": \"${4:sa}\",",
       "\t\"password\": \"${5:password}\",",
-      "\t\"database\": \"${6:database_name}\"",
+      "\t\"database\": \"${6:database_name}\",",
+      "\t\"options\": {",
+      "\t\t\"trustServerCertificate\": ${7:true}",
+      "\t}",
       "}"
     ],
     "description": "Add a new Microsoft SQL Server database configuration"

src/providers/config-file-provider.ts

@@ -116,7 +116,7 @@ async function reportNameError(config: MysqlConfig | PostgresConfig | MssqlConfi
 }
 
 async function mssqlConfigResolver(mssqlConfig: MssqlConfig): Promise<EngineProviderCache | undefined> {
-	const connection = await getConnectionFor('Config file provider', 'mssql', mssqlConfig.host, mssqlConfig.port, mssqlConfig.username, mssqlConfig.password, mssqlConfig.database, false)
+	const connection = await getConnectionFor('Config file provider', 'mssql', mssqlConfig.host, mssqlConfig.port, mssqlConfig.username, mssqlConfig.password, mssqlConfig.database, false, mssqlConfig.options)
 	if (!connection) return
 
 	const engine: MssqlEngine = new MssqlEngine(connection)
@@ -208,4 +208,4 @@ async function postgresConfigResolver(postgresConfig: PostgresConfig): Promise<E
 		type: 'postgres',
 		engine: engine
 	}
-}
+}

src/services/connector.ts

@@ -4,20 +4,27 @@ import { log } from './logging-service';
 import { logToOutput } from './output-service';
 import { KnexClientType } from '../types';
 
-export async function getConnectionFor(description: string, dialect: KnexClientType, host: string, port: number, username: string, password: string, database: string | undefined = undefined, notifyOnError = true): Promise<knexlib.Knex | undefined> {
+export async function getConnectionFor(description: string, dialect: KnexClientType, host: string, port: number, username: string, password: string, database: string | undefined = undefined, notifyOnError = true, options?: Record<string, unknown>): Promise<knexlib.Knex | undefined> {
 
 	log(`Connector - ${description}`, `Attempting to connect to database: dialect=${dialect}, host=${host}, port=${port}, username=${username}, database=${database ? String(database[0]) + '*****' : '<not-provided>'}`);
 
 	try {
+		const connection: any = {
+			host: host ? String(host) : host,
+			port: port ? Number(port) : port,
+			user: username ? String(username) : username,
+			password: password ? String(password) : password,
+			database: database ? String(database) : database,
+		};
+
+		// Add options to connection config for MSSQL
+		if (dialect === 'mssql' && options) {
+			connection.options = options;
+		}
+
 		const knex = knexlib.knex({
 			client: dialect,
-			connection: {
-				host: host ? String(host) : host,
-				port: port ? Number(port) : port,
-				user: username ? String(username) : username,
-				password: password ? String(password) : password,
-				database: database ? String(database) : database,
-			},
+			connection,
 		});
 
 		return knex

src/test/suite/engines/mssql-certificate.test.ts

@@ -19,6 +19,7 @@ describe('MSSQL Certificate Connection Tests', () => {
       .withName('devdb-test-container-mssql-cert')
       .acceptLicense()
       .withPassword('yourStrong(!)Password')
+      .withReuse()
       .start();
   });
 

src/test/suite/services/sql.test.ts

@@ -20,6 +20,7 @@ describe('SqliteService Tests', () => {
 
 	before(async function () {
 		container = await new MySqlContainer(dockerImage)
+			.withName('devdb-test-container-for-general-sql-tests')
 			.withReuse()
 			.start();
 	})

src/types.ts

@@ -182,6 +182,7 @@ export interface PostgresConfig extends SqlConfig {
 
 export interface MssqlConfig extends SqlConfig {
 	type: 'mssql'
+	options?: Record<string, unknown>
 }
 
 export type LaravelConnection = 'pgsql' | 'mysql'