Consume logs list changed event

Multilogs is working, requires a little more testing
Also add inline enable button

Author: Tim Etchells

dev/package.json

@@ -159,7 +159,11 @@
             {
                 "command": "%cmdID_enable%",
                 "title": "%cmdTitle_enable%",
-                "category": "%commandCategory%"
+                "category": "%commandCategory%",
+                "icon": {
+                    "light": "res/img/light/play.svg",
+                    "dark": "res/img/dark/play.svg"
+                }
             },
             {
                 "command": "%cmdID_disable%",
@@ -277,7 +281,7 @@
                 },
                 {
                     "command": "%cmdID_refreshConnection%",
-                    "when": "%isActiveConnection%",
+                    "when": "%isConnection%",
                     "group": "ext.mc.conn.c@1"
                 },
                 {
@@ -370,10 +374,20 @@
                     "when": "%isEnabledAutoBuildOn%",
                     "group": "ext.mc.e@2"
                 },
+                {
+                    "command": "%cmdID_disable%",
+                    "when": "%isEnabledProject%",
+                    "group": "ext.mc.z"
+                },
                 {
                     "command": "%cmdID_enable%",
                     "when": "%isDisabledProject%",
                     "group": "ext.mc.z"
+                },
+                {
+                    "command": "%cmdID_enable%",
+                    "when": "%isDisabledProject%",
+                    "group": "inline"
                 }
             ]
         }

dev/res/img/dark/play.svg

@@ -80,7 +80,7 @@ async function manageLogsInner(project: Project, all?: "show" | "hide"): Promise
     };
 
     // https://github.com/Microsoft/vscode/issues/64014
-    const logsToShow: MCLog[] | undefined = await vscode.window.showQuickPick(logs, options) as (MCLog[] | undefined);
+    const logsToShow: MCLog[] | undefined = await vscode.window.showQuickPick<MCLog>(logs, options) as (MCLog[] | undefined);
     if (logsToShow != null) {
         // Log.d("selection", selection);
 

dev/res/img/light/play.svg

@@ -169,11 +169,18 @@ export default class MCSocket implements vscode.Disposable {
         }
     }
 
-    private readonly onLogsListChanged = async (payload: any): Promise<void> => {
+    private readonly onLogsListChanged = async (payload: SocketEvents.ILogsListChangedEvent): Promise<void> => {
         const project = await this.getProject(payload);
         if (project == null) {
             return;
         }
+
+        if (!this.connection.is1905OrNewer()) {
+            Log.e("Received new logs LIST event for a project that should be using the OLD logs API");
+            return;
+        }
+
+        (project.logManager as MCLogManager).onLogsListChanged(payload);
     }
 
     private readonly onLogUpdate = async (payload: SocketEvents.ILogUpdateEvent): Promise<void> => {
@@ -188,8 +195,7 @@ export default class MCSocket implements vscode.Disposable {
         }
 
         // Log.d(`Received log ${payload.logName} of length ${payload.logs.length} with reset ${payload.reset}`);
-        const logManager = project.logManager as MCLogManager;
-        logManager.onNewLogs(payload);
+        (project.logManager as MCLogManager).onNewLogs(payload);
     }
 
     private readonly onProjectValidated = async (payload: { projectID: string, validationResults: SocketEvents.IValidationResult[] })

dev/src/command/ManageLogsCmd.ts

@@ -72,6 +72,8 @@ namespace SocketEvents {
         readonly reset: boolean;
     }
 
+    export type ILogsListChangedEvent = { projectID: string } & ILogResponse;
+
     /**
      * Socket events we listen for from Microclimate Portal
      * See MCSocket
@@ -103,4 +105,14 @@ namespace SocketEvents {
     }
 }
 
+export interface ILogResponse {
+    readonly build?: ILogObject[];
+    readonly app?: ILogObject[];
+}
+
+export interface ILogObject {
+    readonly logName: string;
+    readonly workspathLogPath?: string;
+}
+
 export default SocketEvents;

dev/src/microclimate/connection/MCSocket.ts

@@ -19,6 +19,7 @@ import StringNamespaces from "../../constants/strings/StringNamespaces";
 import Translator from "../../constants/strings/translator";
 import * as MCUtil from "../../MCUtil";
 import EndpointUtil, { ProjectEndpoints, Endpoint, MCEndpoints } from "../../constants/Endpoints";
+import { ILogResponse } from "../connection/SocketEvents";
 
 const STRING_NS = StringNamespaces.REQUESTS;
 
@@ -78,10 +79,10 @@ namespace Requester {
     }
 
     export async function requestValidate(project: Project, silent: boolean): Promise<void> {
-        const [url, body]: [Endpoint, IValidateRequestBody] = assembleValidateRequest(project, false);
+        const [endpoint, body]: [Endpoint, IValidateRequestBody] = assembleValidateRequest(project, false);
 
         const userOperation = Translator.t(StringNamespaces.CMD_MISC, "validate");
-        await doProjectRequest(project, url, body, request.post, userOperation, silent);
+        await doProjectRequest(project, endpoint, body, request.post, userOperation, silent);
     }
 
     export async function requestGenerate(project: Project): Promise<void> {
@@ -148,16 +149,6 @@ namespace Requester {
         await doProjectRequest(project, ProjectEndpoints.PROPERTES, body, request.post, updateMsg);
     }
 
-    interface ILogResponse {
-        readonly build: ILogObject[];
-        readonly app: ILogObject[];
-    }
-
-    interface ILogObject {
-        readonly logName: string;
-        readonly workspathLogPath?: string;
-    }
-
     export async function requestAvailableLogs(project: Project): Promise<ILogResponse> {
         if (!project.state.isEnabled) {
             // there are no logs available for disabled projects

dev/src/microclimate/connection/SocketEvents.ts

@@ -1,42 +1,37 @@
+/*******************************************************************************
+ * Copyright (c) 2019 IBM Corporation and others.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v2.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v20.html
+ *
+ * Contributors:
+ *     IBM Corporation - initial API and implementation
+ *******************************************************************************/
 import * as vscode from "vscode";
 
-// export enum MCLogTypes {
-//     "app", "build",
-// }
-
-const FW_CONTAINER_LOGS_NAME = "-";
-const PORTAL_CONTAINER_LOGS_NAME = "container";
-const USER_CONTAINER_LOGS_NAME = "container log";
-
 export default class MCLog implements vscode.QuickPickItem {
 
     public readonly displayName: string;
 
     // quickPickItem
     public readonly label: string;
+    // public readonly detail: string;
 
     private output: vscode.OutputChannel | undefined;
 
     constructor(
         projectName: string,
-        // MUST match the logName provided in the events
+        // MUST match the logName provided in the log-update events
         public readonly logName: string,
-        // public readonly logType: MCLogTypes,
-        // path is not used at this time
         public readonly logPath?: string,
     ) {
-        // portal sends the logName for container logs (in log-update events) as "container", but filewatcher sends "-" (in REST requests)
-        // so we have to deal with that here, normalize to the portal name
-        const isContainerLog = logName === FW_CONTAINER_LOGS_NAME;
-        if (isContainerLog) {
-            this.logName = PORTAL_CONTAINER_LOGS_NAME;
-        }
-
-        this.displayName = projectName + " - " + (isContainerLog ? USER_CONTAINER_LOGS_NAME : this.logName);
+        this.displayName = `${projectName} - ${this.logName}`;
         this.label = this.displayName;
+        // this.detail = logPath;
         // this.description = `(${this.logType} log)`;
 
-        // Log.d(`Initialized log ${this.displayName} internal name ${this.logName}`);
+        // Log.d(`Initialized log ${this.displayName} internal name ${this.logName} from ${}`);
     }
 
     public onNewLogs(reset: boolean, logs: string): void {
@@ -86,7 +81,7 @@ export default class MCLog implements vscode.QuickPickItem {
                 msg += "Microclimate disconnected.";
             }
             else {
-                msg += "the project has been disabled.";
+                msg += "the project has been disabled. The log will be recreated when there is new output.";
             }
             this.output.appendLine(msg);
         }

dev/src/microclimate/project/Requester.ts

@@ -1,8 +1,20 @@
+/*******************************************************************************
+ * Copyright (c) 2019 IBM Corporation and others.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v2.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v20.html
+ *
+ * Contributors:
+ *     IBM Corporation - initial API and implementation
+ *******************************************************************************/
+// import * as vscode from "vscode";
+
 import Project from "../Project";
 import MCLog from "./MCLog";
 import Log from "../../../Logger";
 import Requester from "../Requester";
-import SocketEvents from "../../connection/SocketEvents";
+import SocketEvents, { ILogResponse } from "../../connection/SocketEvents";
 
 export default class MCLogManager {
 
@@ -26,9 +38,7 @@ export default class MCLogManager {
         // Log.d("Initializing logs");
         try {
             const availableLogs = await Requester.requestAvailableLogs(this.project);
-            availableLogs.app.concat(availableLogs.build).forEach((log) => {
-                this.logs.push(new MCLog(this.project.name, log.logName, log.workspathLogPath));
-            });
+            this.onLogsListChanged(availableLogs);
             Log.i(`${this.managerName} has finished initializing logs: ${this.logs.map((l) => l.displayName).join(", ") || "<none>"}`);
         }
         catch (err) {
@@ -41,6 +51,34 @@ export default class MCLogManager {
         return this.managerName;
     }
 
+    public onLogsListChanged(logs: ILogResponse): void {
+        const appLogs = logs.app || [];
+        const buildLogs = logs.build || [];
+
+        appLogs.concat(buildLogs).forEach((newLogData) => {
+            // skip useless container log
+            if (!(newLogData.logName === "-" || newLogData.logName === "container")) {
+                return;
+            }
+
+            const existingIndex = this.logs.findIndex((l) => l.logName === newLogData.logName);
+            const existed = existingIndex !== -1;
+            let openOnCreate = false;
+            if (existed) {
+                // destroy the old log and replace it with this one
+                const existingLog = this.logs.splice(existingIndex, 1)[0];
+                openOnCreate = existingLog.isOpen;
+                existingLog.destroy();
+            }
+
+            const newLog = new MCLog(this.project.name, newLogData.logName, newLogData.workspathLogPath);
+            this.logs.push(newLog);
+            if (openOnCreate) {
+                newLog.showOutput();
+            }
+        });
+    }
+
     /**
      * @param enable `true` to refresh (ie, restart) all logs for this project, `false` to stop streaming all logs for this project
      */