Add tracing log level to auth provider, #94005

microsoft · Mar 31, 2020 · bf456b6 · bf456b6
1 parent 563997c
commit bf456b6
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 2 deletions.
diff --git a/extensions/vscode-account/package.json b/extensions/vscode-account/package.json
@@ -27,7 +27,20 @@
 				"title": "%signOut%",
 				"category": "%displayName%"
 			}
-		]
+		],
+		"configuration": {
+			"title": "Microsoft Account",
+			"properties": {
+				"microsoftAccount.logLevel": {
+					"type": "string",
+					"enum": [
+						"info",
+						"trace"
+					],
+					"default": "info"
+				}
+			}
+		}
 	},
 	"scripts": {
 		"vscode:prepublish": "npm run compile",

diff --git a/extensions/vscode-account/src/keychain.ts b/extensions/vscode-account/src/keychain.ts
@@ -45,6 +45,7 @@ export class Keychain {
 
 	async setToken(token: string): Promise<void> {
 		try {
+			Logger.trace('Writing to keychain', token);
 			return await this.keytar.setPassword(SERVICE_ID, ACCOUNT_ID, token);
 		} catch (e) {
 			// Ignore
@@ -59,7 +60,9 @@ export class Keychain {
 
 	async getToken(): Promise<string | null | undefined> {
 		try {
-			return await this.keytar.getPassword(SERVICE_ID, ACCOUNT_ID);
+			const result = await this.keytar.getPassword(SERVICE_ID, ACCOUNT_ID);
+			Logger.trace('Reading from keychain', result);
+			return result;
 		} catch (e) {
 			// Ignore
 			Logger.error(`Getting token failed: ${e}`);

diff --git a/extensions/vscode-account/src/logger.ts b/extensions/vscode-account/src/logger.ts
@@ -7,11 +7,23 @@ import * as vscode from 'vscode';
 
 type LogLevel = 'Trace' | 'Info' | 'Error';
 
+enum Level {
+	Trace = 'trace',
+	Info = 'Info'
+}
+
 class Log {
 	private output: vscode.OutputChannel;
+	private level: Level;
 
 	constructor() {
 		this.output = vscode.window.createOutputChannel('Account');
+		this.level = vscode.workspace.getConfiguration('microsoftAccount').get('logLevel') || Level.Info;
+		vscode.workspace.onDidChangeConfiguration(e => {
+			if (e.affectsConfiguration('microsoftAccount.logLevel')) {
+				this.level = vscode.workspace.getConfiguration('microsoftAccount').get('logLevel') || Level.Info;
+			}
+		});
 	}
 
 	private data2String(data: any): string {
@@ -32,6 +44,12 @@ class Log {
 		this.logLevel('Error', message, data);
 	}
 
+	public trace(message: string, data?: any): void {
+		if (this.level === Level.Trace) {
+			this.logLevel('Trace', message, data);
+		}
+	}
+
 	public logLevel(level: LogLevel, message: string, data?: any): void {
 		this.output.appendLine(`[${level}  - ${this.now()}] ${message}`);
 		if (data) {