Add an SSH logging channel (#9901)

* Add an SSH logging channel

Author: xisui-MSFT

Extension/src/SSH/sshCommandRunner.ts

@@ -23,7 +23,8 @@ import {
     ConnectionFailureInteractor
 } from './commandInteractors';
 import { isWindows, ISshHostInfo, splitLines, stripEscapeSequences, ProcessReturnType } from '../common';
-import { getOutputChannelLogger } from '../logger';
+import { getSshChannel } from '../logger';
+import { CppSettings } from '../LanguageServer/settings';
 
 nls.config({ messageFormat: nls.MessageFormat.bundle, bundleFormat: nls.BundleFormat.standalone })();
 const localize: nls.LocalizeFunc = nls.loadMessageBundle();
@@ -257,6 +258,7 @@ export function runInteractiveSshTerminalCommand(args: ITerminalCommandArgs): Pr
     const disposables: vscode.Disposable[] = [];
     const { systemInteractor, command, interactors, nickname, token } = args;
     let logIsPaused: boolean = false;
+    const loggingLevel: string | undefined = new CppSettings().loggingLevel;
     return new Promise(async (resolve, reject) => {
         let stdout: string = '';
         let windowListener: vscode.Disposable | undefined;
@@ -292,11 +294,13 @@ export function runInteractiveSshTerminalCommand(args: ITerminalCommandArgs): Pr
             if (!noClean) {
                 clean();
             }
-            getOutputChannelLogger().appendLine(cancel ? localize('ssh.terminal.command.canceled', '"{0}" terminal command canceled.', nickname) : localize('ssh.terminal.command.done', '"{0}" terminal command done.', nickname));
+            getSshChannel().appendLine(cancel ? localize('ssh.terminal.command.canceled', '"{0}" terminal command canceled.', nickname) : localize('ssh.terminal.command.done', '"{0}" terminal command done.', nickname));
 
             if (cancel) {
                 if (continueWithoutExiting) {
-                    getOutputChannelLogger().showWarningMessage(localize('ssh.continuing.command.canceled', 'Task \'{0}\' is canceled, but the underlying command may not be terminated. Please check manually.', command));
+                    const warningMessage: string = localize('ssh.continuing.command.canceled', 'Task \'{0}\' is canceled, but the underlying command may not be terminated. Please check manually.', command);
+                    getSshChannel().appendLine(warningMessage);
+                    vscode.window.showWarningMessage(warningMessage);
                 }
                 return reject(new CanceledError());
             }
@@ -308,7 +312,9 @@ export function runInteractiveSshTerminalCommand(args: ITerminalCommandArgs): Pr
 
         const failed = (error?: any) => {
             clean();
-            getOutputChannelLogger().showErrorMessage(localize('ssh.process.failed', '"{0}" process failed: {1}', nickname, error));
+            const errorMessage: string = localize('ssh.process.failed', '"{0}" process failed: {1}', nickname, error);
+            getSshChannel().appendLine(errorMessage);
+            vscode.window.showErrorMessage(errorMessage);
             reject(error);
         };
 
@@ -341,7 +347,9 @@ export function runInteractiveSshTerminalCommand(args: ITerminalCommandArgs): Pr
         };
 
         const handleTerminalOutput = async (dataWrite: vscode.TerminalDataWriteEvent): Promise<void> => {
-            handleOutputLogging(dataWrite.data);
+            if (loggingLevel !== 'None') {
+                handleOutputLogging(dataWrite.data);
+            }
             stdout += dataWrite.data;
 
             if (interactors) {
@@ -385,7 +393,9 @@ export function runInteractiveSshTerminalCommand(args: ITerminalCommandArgs): Pr
                                 const logOutput: string = interaction.isPassword
                                     ? interaction.response.replace(/./g, '*')
                                     : interaction.response;
-                                getOutputChannelLogger().appendLine(localize('ssh.wrote.data.to.terminal', '"{0}" wrote data to terminal: "{1}".', nickname, logOutput));
+                                if (loggingLevel === 'Debug' || loggingLevel === 'Information') {
+                                    getSshChannel().appendLine(localize('ssh.wrote.data.to.terminal', '"{0}" wrote data to terminal: "{1}".', nickname, logOutput));
+                                }
                             }
                         }
                     } catch (e) {
@@ -447,7 +457,9 @@ export function runInteractiveSshTerminalCommand(args: ITerminalCommandArgs): Pr
                 const sendText: string = terminalIsWindows ? `(${args.sendText})\nexit /b %ErrorLevel%` : `${args.sendText}\nexit $?`;
 
                 terminal.sendText(sendText);
-                getOutputChannelLogger().appendLine(localize('ssh.wrote.data.to.terminal', '"{0}" wrote data to terminal: "{1}".', nickname, args.sendText));
+                if (loggingLevel === 'Debug' || loggingLevel === 'Information') {
+                    getSshChannel().appendLine(localize('ssh.wrote.data.to.terminal', '"{0}" wrote data to terminal: "{1}".', nickname, args.sendText));
+                }
             }
 
             if (args.showLoginTerminal) {
@@ -493,7 +505,7 @@ function logReceivedData(data: string, nickname: string): void {
         .map(line => `${nickname}> ${line}`)
         .join('\n');
 
-    getOutputChannelLogger().appendLine(markedLines);
+    getSshChannel().appendLine(markedLines);
 }
 
 function lastNonemptyLine(str: string): string | undefined {

Extension/src/SSH/sshHosts.ts

@@ -17,7 +17,7 @@ import {
 } from 'ssh-config';
 import { promisify } from 'util';
 import { ISshConfigHostInfo, ISshHostInfo, isWindows, resolveHome } from "../common";
-import { getOutputChannelLogger } from '../logger';
+import { getSshChannel } from '../logger';
 import * as glob from 'glob';
 import * as vscode from 'vscode';
 import * as nls from 'vscode-nls';
@@ -133,7 +133,7 @@ async function getIncludedConfigFile(config: Configuration, includePath: string)
         const parsed: Configuration = parse(includedContents);
         config.push(...parsed);
     } catch (e) {
-        getOutputChannelLogger().appendLine(localize("failed.to.read.file", "Failed to read file {0}.", includePath));
+        getSshChannel().appendLine(localize("failed.to.read.file", "Failed to read file {0}.", includePath));
     }
 }
 
@@ -143,7 +143,7 @@ export async function writeSshConfiguration(configurationPath: string, configura
         await vscode.workspace.fs.createDirectory(vscode.Uri.file(path.dirname(configurationPath)));
         await fs.writeFile(configurationPath, configuration.toString());
     } catch (e) {
-        getOutputChannelLogger().appendLine(localize("failed.to.write.file", "Failed to write to file {0}.", configurationPath));
+        getSshChannel().appendLine(localize("failed.to.write.file", "Failed to write to file {0}.", configurationPath));
     }
 }
 
@@ -153,7 +153,10 @@ async function getSshConfigSource(configurationPath: string): Promise<string> {
         const buffer: Buffer = await fs.readFile(configurationPath);
         return buffer.toString('utf8');
     } catch (e) {
-        getOutputChannelLogger().appendLine(localize("failed.to.read.file", "Failed to read file {0}.", configurationPath));
+        if ((e as NodeJS.ErrnoException).code === 'ENOENT') {
+            return '';
+        }
+        getSshChannel().appendLine(localize("failed.to.read.file", "Failed to read file {0}.", configurationPath));
     }
 
     return '';

Extension/src/logger.ts

@@ -75,6 +75,7 @@ export let outputChannel: vscode.OutputChannel | undefined;
 export let diagnosticsChannel: vscode.OutputChannel | undefined;
 export let debugChannel: vscode.OutputChannel | undefined;
 export let warningChannel: vscode.OutputChannel | undefined;
+export let sshChannel: vscode.OutputChannel | undefined;
 
 export function getOutputChannel(): vscode.OutputChannel {
     if (!outputChannel) {
@@ -96,6 +97,13 @@ export function getDiagnosticsChannel(): vscode.OutputChannel {
     return diagnosticsChannel;
 }
 
+export function getSshChannel(): vscode.OutputChannel {
+    if (!sshChannel) {
+        sshChannel = vscode.window.createOutputChannel(localize("c.cpp.ssh.channel", "{0}: SSH", "Cpptools"));
+    }
+    return sshChannel;
+}
+
 export function showOutputChannel(): void {
     getOutputChannel().show();
 }