Add 'hide logs' command

Should revisit the structure of MCLogManager since it has changed a lot since initial impl, and is now weirdly complex

Author: Tim Etchells

dev/package.json

@@ -127,6 +127,11 @@
                 "title": "%cmdTitle_openAppLog%",
                 "category": "%commandCategory%"
             },
+            {
+                "command": "%cmdID_hideLogs%",
+                "title": "%cmdTitle_hideLogs%",
+                "category": "%commandCategory%"
+            },
             {
                 "command": "%cmdID_enable%",
                 "title": "%cmdTitle_enable%",

dev/package.nls.json

@@ -61,6 +61,9 @@
     "cmdTitle_openAppLog": "Show application log",
     "cmdDescr_openAppLog": "Show a project's Microclimate application logs in the Output view",
 
+    "cmdID_hideLogs": "ext.mc.hideLogs",
+    "cmdTitle_hideLogs": "Hide logs",
+
     "cmdID_projectInfo": "ext.mc.viewProjectInfo",
     "cmdTitle_projectInfo": "Show project info",
     "cmdDescr_projectInfo": "Show a project's Microclimate information",

dev/src/command/CommandUtil.ts

@@ -26,6 +26,7 @@ import newMCProjectCmd from "./NewMCProjectCmd";
 import Translator from "../constants/strings/translator";
 import StringNamespaces from "../constants/strings/StringNamespaces";
 import validateCmd from "./ValidateCmd";
+import hideLogsCmd from "./HideLogsCmd";
 
 export function createCommands(): vscode.Disposable[] {
 
@@ -59,6 +60,7 @@ export function createCommands(): vscode.Disposable[] {
 
         vscode.commands.registerCommand(Commands.OPEN_APP_LOG,      (selection) => openLogCmd(selection, true)),
         vscode.commands.registerCommand(Commands.OPEN_BUILD_LOG,    (selection) => openLogCmd(selection, false)),
+        vscode.commands.registerCommand(Commands.HIDE_LOGS,         () => hideLogsCmd()),
 
         vscode.commands.registerCommand(Commands.DISABLE_PROJECT,   (selection) => toggleEnablementCmd(selection, false)),
         vscode.commands.registerCommand(Commands.ENABLE_PROJECT,    (selection) => toggleEnablementCmd(selection, true)),

dev/src/command/HideLogsCmd.ts

@@ -0,0 +1,42 @@
+import * as vscode from "vscode";
+
+import Translator from "../constants/strings/translator";
+import StringNamespaces from "../constants/strings/StringNamespaces";
+import ConnectionManager from "../microclimate/connection/ConnectionManager";
+import MCLog from "../microclimate/logs/MCLog";
+import Log from "../Logger";
+
+const STRING_NS = StringNamespaces.LOGS;
+
+export default async function hideLogsCmd(): Promise<void> {
+
+    const quickPickItems: MCLog[] = ConnectionManager.instance.connections.reduce( (logs: MCLog[], connection): MCLog[] => {
+        return logs.concat(connection.logManager.getAllOpenLogs());
+    }, []);
+
+    if (quickPickItems.length === 0) {
+        vscode.window.showInformationMessage(Translator.t(STRING_NS, "noLogsToHide"));
+        return;
+    }
+
+    const options: vscode.QuickPickOptions = {
+        canPickMany: true
+    };
+
+    // https://github.com/Microsoft/vscode/issues/64014
+    // const selection: vscode.QuickPickItem[] | undefined = await vscode.window.showQuickPick(quickPickItems, options);
+
+    // The return type is an array of MCLogs, but we have to mark it as 'any' due to issue linked above
+    const selection: any = await vscode.window.showQuickPick(quickPickItems, options);
+    if (selection != null) {
+        // Log.d("selection", selection);
+
+        const logsToHide: MCLog[] = selection as MCLog[];
+
+        Log.d(`Hiding ${logsToHide.length} logs`);
+        logsToHide.forEach( (log) => {
+            log.destroy();
+        });
+        // vscode.window.showInformationMessage(Translator.t(STRING_NS, "hidNLogs", { count: logsToHide.length }));
+    }
+}

dev/src/constants/Commands.ts

@@ -22,6 +22,7 @@ enum Commands {
 
     OPEN_APP_LOG = "ext.mc.openAppLog",
     OPEN_BUILD_LOG = "ext.mc.openBuildLog",
+    HIDE_LOGS = "ext.mc.hideLogs",
     DISABLE_PROJECT = "ext.mc.disable",
     ENABLE_PROJECT = "ext.mc.enable",
     CONTAINER_SHELL = "ext.mc.containerShell",

dev/src/constants/strings/strings-en.json

@@ -60,7 +60,8 @@
         "errUpdatingBuildLog": "Error updating build log: {{- err }}.",
         "logName": "{{ projectName }} - {{ logType }} Log",
         "logNotUpdatingNoConnection": "******** The connection to Microclimate was lost, so this {{ logType }} log is no longer updating.",
-        "logNotUpdatingOther": "******** This {{ logType }} log is no longer updating."
+        "logNotUpdatingOther": "******** This {{ logType }} log is no longer updating.",
+        "noLogsToHide": "There are no Microclimate logs open."
     },
 
     "newConnectionCmd": {

dev/src/microclimate/logs/AppLog.ts

@@ -11,12 +11,13 @@ export default class AppLog extends MCLog {
 
     constructor(
         public readonly projectID: string,
-        public readonly projectName: string
+        public readonly projectName: string,
+        managerMap: Map<string, MCLog>
     ) {
-        super(projectID, projectName,
+        super(projectID, projectName, MCLog.LogTypes.APP,
+            managerMap,
             Translator.t(MCLog.STRING_NS, "waitingForAppLogs", { projectName }),
-            MCLog.LogTypes.APP);
-
+        );
         // update will be invoked when we get a container-logs event
     }
 

dev/src/microclimate/logs/BuildLog.ts

@@ -19,11 +19,13 @@ export default class BuildLog extends MCLog {
     constructor(
         private readonly connection: Connection,
         public readonly projectID: string,
-        public readonly projectName: string
+        public readonly projectName: string,
+        managerMap: Map<string, MCLog>
     ) {
-        super(projectID, projectName,
+        super(projectID, projectName, MCLog.LogTypes.BUILD,
+            managerMap,
             Translator.t(MCLog.STRING_NS, "waitingForBuildLogs", { projectName }),
-            MCLog.LogTypes.BUILD);
+        );
 
         this.update();
         this.timer = setInterval(this.update, BuildLog.UPDATE_INTERVAL);

dev/src/microclimate/logs/MCLog.ts

@@ -8,23 +8,30 @@ import Translator from "../../constants/strings/translator";
 /**
  * Type to capture common functionality between AppLogs and BuildLogs
  */
-export class MCLog {
+export class MCLog implements vscode.QuickPickItem {
 
     protected static readonly STRING_NS: StringNamespaces = StringNamespaces.LOGS;
 
     protected readonly outputChannel: vscode.OutputChannel;
 
     protected doUpdate: boolean = true;
 
+    // quickPickItem
+    public readonly label: string;
+
     protected constructor(
         public readonly projectID: string,
         public readonly projectName: string,
-        initialMsg: string,
-        private readonly logType: MCLog.LogTypes
+        public readonly logType: MCLog.LogTypes,
+        private readonly managerMap: Map<string, MCLog>,
+        initialMsg: string
     ) {
         const outputChannelName = Translator.t(MCLog.STRING_NS, "logName", { projectName, logType: logType.toString() });
         this.outputChannel = vscode.window.createOutputChannel(outputChannelName);
         this.outputChannel.appendLine(initialMsg);
+
+        // quickPickItem
+        this.label = this.outputChannel.name;
     }
 
     public async showOutputChannel(): Promise<void> {
@@ -39,7 +46,7 @@ export class MCLog {
      *  A slightly different message is displayed if the updates were cancelled because we lost the MC connection.
      *  It is possible for a user to manually stop the updates of a build log, in which case this should be false.
      */
-    public async stopUpdating(connectionLost: boolean = true): Promise<void> {
+    public stopUpdating(connectionLost: boolean = true): void {
         if (!this.doUpdate) {
             Log.d("Already stopped updating log " + this.outputChannel.name);
             return;
@@ -56,10 +63,17 @@ export class MCLog {
         this.outputChannel.appendLine("\n" + msg);          // non-nls
     }
 
-    public async destroy(): Promise<void> {
+    /**
+     * Disposes of this log's OutputChannel.
+     * Also removes it from the owner manager's log map, which is a nasty coupling I will revisit!
+     */
+    public destroy(): void {
         Log.d("Destroy log " + this.outputChannel.name);
         this.stopUpdating();
         this.outputChannel.dispose();
+        if (this.managerMap.has(this.projectID)) {
+            this.managerMap.delete(this.projectID);
+        }
     }
 
     /**

dev/src/microclimate/logs/MCLogManager.ts

@@ -4,6 +4,7 @@ import BuildLog from "./BuildLog";
 import Connection from "../connection/Connection";
 // Not to be confused with the other log classes :)
 import Log from "../../Logger";
+import MCLog from "./MCLog";
 
 /**
  * Contains info about app and build logs for a given Connection.
@@ -12,6 +13,7 @@ import Log from "../../Logger";
 export default class MCLogManager {
 
     // Maps projectIDs to Log instances
+    // TODO revist this. I think these can be combined into one array now, but will require an overhaul of this class.
     private readonly appLogMap: Map<string, AppLog> = new Map<string, AppLog>();
     private readonly buildLogMap: Map<string, BuildLog> = new Map<string, BuildLog>();
 
@@ -21,12 +23,22 @@ export default class MCLogManager {
 
     }
 
+    /**
+     * Returns an array of all open logs for this Connection (aka this logManager)
+     */
+    public getAllOpenLogs(): MCLog[] {
+        let openLogs: MCLog[] = [];
+        openLogs = openLogs.concat(Array.from(this.appLogMap.values()));
+        openLogs = openLogs.concat(Array.from(this.buildLogMap.values()));
+        return openLogs;
+    }
+
     public getOrCreateAppLog(projectID: string, projectName: string): AppLog {
         let appLog = this.appLogMap.get(projectID);
         if (appLog == null) {
             Log.i("Creating app log for " + projectName);
             // we have to create it
-            appLog = new AppLog(projectID, projectName);
+            appLog = new AppLog(projectID, projectName, this.appLogMap);
             this.appLogMap.set(projectID, appLog);
         }
         return appLog;
@@ -41,7 +53,7 @@ export default class MCLogManager {
         if (buildLog == null) {
             Log.i("Creating build log for " + projectName);
             // we have to create it
-            buildLog = new BuildLog(this.connection, projectID, projectName);
+            buildLog = new BuildLog(this.connection, projectID, projectName, this.buildLogMap);
             this.buildLogMap.set(projectID, buildLog);
         }
         return buildLog;