From b6e99d84cb024057b4cee0b724f1017a3325a7f9 Mon Sep 17 00:00:00 2001
From: fwcd <30873659+fwcd@users.noreply.github.com>
Date: Wed, 13 Sep 2023 20:19:27 +0200
Subject: [PATCH] Add `MessageType.Debug` (#1264)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* Add MessageType.Debug

* Factor out log implementation into helper method

* Add missing @since annotations

* Add @since tag to meta model

---------

Co-authored-by: Dirk Bäumer <dirkb@microsoft.com>
---
 client/src/common/client.ts     | 34 ++++++++++++++++-----------------
 protocol/metaModel.json         |  6 ++++++
 protocol/src/common/protocol.ts |  8 +++++++-
 server/src/common/server.ts     | 13 +++++++++++++
 4 files changed, 43 insertions(+), 18 deletions(-)

diff --git a/client/src/common/client.ts b/client/src/common/client.ts
index fef2065a8..47a8fc971 100644
--- a/client/src/common/client.ts
+++ b/client/src/common/client.ts
@@ -113,6 +113,7 @@ import { InlineCompletionItemFeature } from './inlineCompletion';
  * Controls when the output channel is revealed.
  */
 export enum RevealOutputChannelOn {
+	Debug = 0,
 	Info = 1,
 	Warn = 2,
 	Error = 3,
@@ -983,33 +984,29 @@ export abstract class BaseLanguageClient implements FeatureClient<Middleware, La
 		return data.toString();
 	}
 
+	public debug(message: string, data?: any, showNotification: boolean = true): void {
+		this.logOutputMessage(MessageType.Debug, RevealOutputChannelOn.Debug, 'Debug', message, data, showNotification);
+	}
+
 	public info(message: string, data?: any, showNotification: boolean = true): void {
-		this.outputChannel.appendLine(`[Info  - ${(new Date().toLocaleTimeString())}] ${message}`);
-		if (data !== null && data !== undefined) {
-			this.outputChannel.appendLine(this.data2String(data));
-		}
-		if (showNotification && this._clientOptions.revealOutputChannelOn <= RevealOutputChannelOn.Info) {
-			this.showNotificationMessage(MessageType.Info, message);
-		}
+		this.logOutputMessage(MessageType.Info, RevealOutputChannelOn.Info, 'Info', message, data, showNotification);
 	}
 
 	public warn(message: string, data?: any, showNotification: boolean = true): void {
-		this.outputChannel.appendLine(`[Warn  - ${(new Date().toLocaleTimeString())}] ${message}`);
-		if (data !== null && data !== undefined) {
-			this.outputChannel.appendLine(this.data2String(data));
-		}
-		if (showNotification && this._clientOptions.revealOutputChannelOn <= RevealOutputChannelOn.Warn) {
-			this.showNotificationMessage(MessageType.Warning, message);
-		}
+		this.logOutputMessage(MessageType.Warning, RevealOutputChannelOn.Warn, 'Warn', message, data, showNotification);
 	}
 
 	public error(message: string, data?: any, showNotification: boolean | 'force' = true): void {
-		this.outputChannel.appendLine(`[Error - ${(new Date().toLocaleTimeString())}] ${message}`);
+		this.logOutputMessage(MessageType.Error, RevealOutputChannelOn.Error, 'Error', message, data, showNotification);
+	}
+
+	private logOutputMessage(type: MessageType, reveal: RevealOutputChannelOn, name: string, message: string, data: any | undefined, showNotification: boolean | 'force'): void {
+		this.outputChannel.appendLine(`[${name.padEnd(5)} - ${(new Date().toLocaleTimeString())}] ${message}`);
 		if (data !== null && data !== undefined) {
 			this.outputChannel.appendLine(this.data2String(data));
 		}
-		if (showNotification === 'force' || (showNotification && this._clientOptions.revealOutputChannelOn <= RevealOutputChannelOn.Error)) {
-			this.showNotificationMessage(MessageType.Error, message);
+		if (showNotification === 'force' || (showNotification && this._clientOptions.revealOutputChannelOn <= reveal)) {
+			this.showNotificationMessage(type, message);
 		}
 	}
 
@@ -1115,6 +1112,9 @@ export abstract class BaseLanguageClient implements FeatureClient<Middleware, La
 					case MessageType.Info:
 						this.info(message.message, undefined, false);
 						break;
+					case MessageType.Debug:
+						this.debug(message.message, undefined, false);
+						break;
 					default:
 						this.outputChannel.appendLine(message.message);
 				}
diff --git a/protocol/metaModel.json b/protocol/metaModel.json
index e31531bca..bea1e3493 100644
--- a/protocol/metaModel.json
+++ b/protocol/metaModel.json
@@ -13470,6 +13470,12 @@
 					"name": "Log",
 					"value": 4,
 					"documentation": "A log message."
+				},
+				{
+					"name": "Debug",
+					"value": 5,
+					"documentation": "A debug message.\n\n@since 3.18.0",
+					"since": "3.18.0"
 				}
 			],
 			"documentation": "The message type"
diff --git a/protocol/src/common/protocol.ts b/protocol/src/common/protocol.ts
index f0a5364a8..90a5af4bc 100644
--- a/protocol/src/common/protocol.ts
+++ b/protocol/src/common/protocol.ts
@@ -1537,9 +1537,15 @@ export namespace MessageType {
 	 * A log message.
 	 */
 	export const Log = 4;
+	/**
+	 * A debug message.
+	 *
+	 * @since 3.18.0
+	 */
+	export const Debug = 5;
 }
 
-export type MessageType = 1 | 2 | 3 | 4;
+export type MessageType = 1 | 2 | 3 | 4 | 5;
 
 /**
  * The parameters of a notification message.
diff --git a/server/src/common/server.ts b/server/src/common/server.ts
index b7c7aab8f..462da1318 100644
--- a/server/src/common/server.ts
+++ b/server/src/common/server.ts
@@ -162,6 +162,15 @@ export interface RemoteConsole extends FeatureBase {
 	 * @param message The message to log.
 	 */
 	log(message: string): void;
+
+	/**
+	 * Log a debug message.
+	 *
+	 * @param message The message to log.
+	 *
+	 * @since 3.18.0
+	 */
+	debug(message: string): void;
 }
 
 class RemoteConsoleImpl implements Logger, RemoteConsole, Remote {
@@ -209,6 +218,10 @@ class RemoteConsoleImpl implements Logger, RemoteConsole, Remote {
 		this.send(MessageType.Log, message);
 	}
 
+	public debug(message: string): void {
+		this.send(MessageType.Debug, message);
+	}
+
 	private send(type: MessageType, message: string): void {
 		if (this._rawConnection) {
 			this._rawConnection.sendNotification(LogMessageNotification.type, { type, message }).catch(() => {