From d51273d9cf509b48bc54d828ad4beea7f6cac4ca Mon Sep 17 00:00:00 2001
From: Charles Gagnon <chgagnon@microsoft.com>
Date: Fri, 13 Jan 2023 14:49:49 -0800
Subject: [PATCH] Add config for enabling STS communication logging (#21591)

* Add config for enabling STS communication logging

* Add warning to description
---
 extensions/mssql/package.json          | 11 +++++++++++
 extensions/mssql/package.nls.json      |  1 +
 extensions/mssql/src/sqlToolsServer.ts | 26 ++------------------------
 3 files changed, 14 insertions(+), 24 deletions(-)

diff --git a/extensions/mssql/package.json b/extensions/mssql/package.json
index a8f74b24cd..07aa84ce54 100644
--- a/extensions/mssql/package.json
+++ b/extensions/mssql/package.json
@@ -150,6 +150,17 @@
             "Verbose"
           ]
         },
+        "mssql.trace.server": {
+          "type": "string",
+          "scope": "window",
+          "enum": [
+            "off",
+            "messages",
+            "verbose"
+          ],
+          "default": "off",
+          "description": "%mssql.tracing.desc%"
+        },
         "mssql.logRetentionMinutes": {
           "type": "number",
           "default": 10080,
diff --git a/extensions/mssql/package.nls.json b/extensions/mssql/package.nls.json
index 08094e2a2e..2e770666a9 100644
--- a/extensions/mssql/package.nls.json
+++ b/extensions/mssql/package.nls.json
@@ -65,6 +65,7 @@
 	"mssql.query.ansiWarnings": "Enable SET ANSI_WARNINGS",
 	"mssql.query.ansiNulls": "Enable SET ANSI_NULLS",
 	"mssql.query.alwaysEncryptedParameterization": "Enable Parameterization for Always Encrypted",
+	"mssql.tracing.desc": "Traces the communication between Azure Data Studio and SQL Tools Service to the SQL Tools Service output channel. WARNING: This may include sensitive information when verbose logging is enabled.",
 	"mssql.ignorePlatformWarning": "[Optional] Do not show unsupported platform warnings",
 
 	"onprem.databaseProperties.recoveryModel": "Recovery Model",
diff --git a/extensions/mssql/src/sqlToolsServer.ts b/extensions/mssql/src/sqlToolsServer.ts
index 31b280993a..1ad873545a 100644
--- a/extensions/mssql/src/sqlToolsServer.ts
+++ b/extensions/mssql/src/sqlToolsServer.ts
@@ -58,7 +58,7 @@ export class SqlToolsServer {
 			const installationComplete = Date.now();
 			let serverOptions = await generateServerOptions(context.extensionContext.logPath, serverPath);
 			let clientOptions = getClientOptions(context);
-			this.client = new SqlOpsDataClient(Constants.serviceName, serverOptions, clientOptions);
+			this.client = new SqlOpsDataClient('mssql', Constants.serviceName, serverOptions, clientOptions);
 			const processStart = Date.now();
 			const clientReadyPromise = this.client.onReady().then(() => {
 				const processEnd = Date.now();
@@ -196,28 +196,6 @@ function getClientOptions(context: AppContext): ClientOptions {
 			ExecutionPlanServiceFeature,
 			TdeMigrationService.asFeature(context),
 		],
-		outputChannel: new CustomOutputChannel()
+		outputChannel: outputChannel
 	};
 }
-
-class CustomOutputChannel implements vscode.OutputChannel {
-	name: string;
-	append(value: string): void {
-		console.log(value);
-	}
-	appendLine(value: string): void {
-		console.log(value);
-	}
-	clear(): void {
-	}
-	show(preserveFocus?: boolean): void;
-	show(column?: vscode.ViewColumn, preserveFocus?: boolean): void;
-	show(column?: any, preserveFocus?: any) {
-	}
-	hide(): void {
-	}
-	dispose(): void {
-	}
-	replace(_value: string): void {
-	}
-}