Inital work to add logging

enamkhan · enamkhan · commit e1281efaac48 · 2025-03-12T15:35:32.000Z
Signed-off-by: EKhan &lt;enam.khan@uk.ibm.com&gt;
diff --git a/packages/vsce/log4jsconfig.json b/packages/vsce/log4jsconfig.json
@@ -0,0 +1,44 @@
+{
+  "log4jsConfig": {
+    "appenders": {
+      "default": {
+        "type": "fileSync",
+        "layout": {
+          "type": "pattern",
+          "pattern": "[%d{yyyy/MM/dd} %d{hh:mm:ss.SSS}] [%p] %m"
+        },
+        "filename": "logs/imperative.log"
+      },
+      "imperative": {
+        "type": "fileSync",
+        "layout": {
+          "type": "pattern",
+          "pattern": "[%d{yyyy/MM/dd} %d{hh:mm:ss.SSS}] [%p] %m"
+        },
+        "filename": "logs/imperative.log"
+      },
+      "app": {
+        "type": "fileSync",
+        "layout": {
+          "type": "pattern",
+          "pattern": "[%d{yyyy/MM/dd} %d{hh:mm:ss.SSS}] [%p] %m"
+        },
+        "filename": "logs/zowe.log"
+      }
+    },
+    "categories": {
+      "default": {
+        "appenders": ["default"],
+        "level": "DEBUG"
+      },
+      "imperative": {
+        "appenders": ["imperative"],
+        "level": "DEBUG"
+      },
+      "app": {
+        "appenders": ["app"],
+        "level": "DEBUG"
+      }
+    }
+  }
+}
diff --git a/packages/vsce/package.json b/packages/vsce/package.json
@@ -755,6 +755,28 @@
           "description": "Zowe CICS Extension History",
           "scope": "window"
         },
+        "zowe.cics.logger": {
+          "type": "string",
+          "default": "INFO",
+          "enum": [
+            "TRACE",
+            "DEBUG",
+            "INFO",
+            "WARN",
+            "ERROR",
+            "FATAL"
+          ],
+          "markdownEnumDescriptions": [
+            "Messages about fine details of the application's behaviour.",
+            "Messages about diagnostic information for troubleshooting.",
+            "Messages about routine application operations.",
+            "Messages about potentially harmful occurrences.",
+            "Messages about serious problem occurrences.",
+            "Messages about catastraphic error events."
+          ],
+          "description": "Select the log level for IBM CICS for Zowe Explorer. The default is INFO.",
+          "scope": "window"
+        },
         "zowe.cics.program.filter": {
           "type": "string",
           "default": "NOT (PROGRAM=CEE* OR PROGRAM=DFH* OR PROGRAM=CJ* OR PROGRAM=EYU* OR PROGRAM=CSQ* OR PROGRAM=CEL* OR PROGRAM=IGZ*)",
diff --git a/packages/vsce/src/constants/Cics.messages.ts b/packages/vsce/src/constants/Cics.messages.ts
@@ -0,0 +1,36 @@
+/*
+* 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
+* https://www.eclipse.org/legal/epl-v20.html
+*
+* SPDX-License-Identifier: EPL-2.0
+*
+* Copyright Contributors to the Zowe Project.
+*
+*/
+
+import { IMessageDefinition } from "@zowe/imperative";
+
+export const CicsMessages: { [key: string]: IMessageDefinition } = {
+    zoweExplorerNotFound: {
+      message: "Zowe Explorer was not found: Please ensure Zowe Explorer v2.0.0 or higher is installed"
+    },
+
+    zoweExplorerModified: {
+      message: "Zowe Explorer was modified for the CICS Extension."
+    },
+
+    notInitializedCorrectly: {
+      message: "IBM CICS for Zowe Explorer was not initialized correctly."
+    },
+
+    incorrectZoweExplorerVersion: {
+      message: `Zowe Explorer was not found: either it is not installed or you are using an older version without extensibility API.
+Please ensure Zowe Explorer v2.0.0-next.202202221200 or higher is installed`
+    },
+
+    loadingResources: {
+      message: "Loading resources..."
+    }
+
+};
diff --git a/packages/vsce/src/extension.ts b/packages/vsce/src/extension.ts
@@ -16,8 +16,10 @@ import { getFolderIcon, getIconFilePathFromName } from "./utils/iconUtils";
 import { ProfileManagement } from "./utils/profileManagement";
 import { getZoweExplorerVersion } from "./utils/workspaceUtils";
 
-import { Logger } from "@zowe/imperative";
 import { getCommands } from "./commands";
+import { CicsLogger } from "./utils/cicsLogger";
+import { LoggerUtils } from "./utils/LoggerUtils";
+import { CicsMessages } from "./constants/Cics.messages";
 
 /**
  * Initializes the extension
@@ -26,13 +28,21 @@ import { getCommands } from "./commands";
  */
 export async function activate(context: ExtensionContext) {
   const zeVersion = getZoweExplorerVersion();
-  const logger = Logger.getAppLogger();
+
+  const logsPath =
+  await CicsLogger.initializeZoweLogger(context);
+  CicsLogger.zeOutputChannel = await LoggerUtils.initVscLogger(context, logsPath);
+
+
   let treeDataProv: CICSTree = null;
   if (!zeVersion) {
-    window.showErrorMessage("Zowe Explorer was not found: Please ensure Zowe Explorer v2.0.0 or higher is installed");
+    CicsLogger.error(CicsMessages.zoweExplorerNotFound.message);
+    window.showErrorMessage(CicsMessages.zoweExplorerNotFound.message);
     return;
   } else if (zeVersion[0] !== "3") {
-    window.showErrorMessage(`Current version of Zowe Explorer is ${zeVersion}. Please ensure Zowe Explorer v3.0.0 or higher is installed`);
+    const message = `Current version of Zowe Explorer is ${zeVersion}. Please ensure Zowe Explorer v3.0.0 or higher is installed`;
+    CicsLogger.error(message);
+    window.showErrorMessage(message);
     return;
   }
   if (ProfileManagement.apiDoesExist()) {
@@ -47,16 +57,14 @@ export async function activate(context: ExtensionContext) {
           await treeDataProv.refreshLoadedProfiles();
         });
       }
-      logger.debug("Zowe Explorer was modified for the CICS Extension.");
+      CicsLogger.debug(CicsMessages.zoweExplorerModified.message);
     } catch (error) {
-      logger.error("IBM CICS for Zowe Explorer was not initialized correctly");
+      CicsLogger.error(CicsMessages.notInitializedCorrectly.message);
       return;
     }
   } else {
-    window.showErrorMessage(
-      "Zowe Explorer was not found: either it is not installed or you are using an older version without extensibility API. " +
-        "Please ensure Zowe Explorer v2.0.0-next.202202221200 or higher is installed"
-    );
+    CicsLogger.error(CicsMessages.incorrectZoweExplorerVersion.message);
+    window.showErrorMessage(CicsMessages.incorrectZoweExplorerVersion.message);
     return;
   }
 
@@ -78,7 +86,7 @@ export async function activate(context: ExtensionContext) {
     window.withProgress(
       {
         location: ProgressLocation.Notification,
-        title: "Loading resources...",
+        title: CicsMessages.loadingResources.message,
         cancellable: true,
       },
       async (_progress, _token) => {
@@ -121,6 +129,7 @@ export async function activate(context: ExtensionContext) {
       try {
         plexExpansionHandler(node.element, treeDataProv);
       } catch (error) {
+        CicsLogger.error(error);
         node.element.getParent().iconPath = getIconFilePathFromName("profile-disconnected");
         treeDataProv._onDidChangeTreeData.fire(undefined);
       }
@@ -175,3 +184,7 @@ export async function activate(context: ExtensionContext) {
 
   context.subscriptions.concat(getCommands(treeDataProv, treeview));
 }
+
+export async function deactivate(): Promise<void> {
+  CicsLogger.disposeZoweLogger();
+}
diff --git a/packages/vsce/src/utils/LoggerUtils.ts b/packages/vsce/src/utils/LoggerUtils.ts
@@ -0,0 +1,88 @@
+/**
+ * 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
+ * https://www.eclipse.org/legal/epl-v20.html
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Copyright Contributors to the Zowe Project.
+ *
+ */
+
+/* eslint-disable @typescript-eslint/restrict-plus-operands */
+
+import * as vscode from "vscode";
+import { Gui } from "@zowe/zowe-explorer-api";
+
+import { CicsLogger } from "./cicsLogger";
+import { PersistentStorage } from "./PersistentStorage";
+
+export class LoggerUtils {
+    private static outputChannel: vscode.OutputChannel;
+    private static persistentStorage = new PersistentStorage("zowe.cics.persistent");
+
+    public static async initVscLogger(context: vscode.ExtensionContext, logFileLocation: string): Promise<vscode.OutputChannel> {
+        LoggerUtils.outputChannel ??= Gui.createOutputChannel(vscode.l10n.t("CICS for Zowe Explorer"));
+        this.writeVscLoggerInfo(LoggerUtils.outputChannel, logFileLocation, context);
+        CicsLogger.info(vscode.l10n.t("Initialized logger for IBM CICS for Zowe Explorer"));
+        await this.compareCliLogSetting();
+        return LoggerUtils.outputChannel;
+    }
+
+    private static writeVscLoggerInfo(outputChannel: vscode.OutputChannel, logFileLocation: string, context: vscode.ExtensionContext): void {
+        outputChannel.appendLine(`${context.extension.packageJSON.displayName as string} ${context.extension.packageJSON.version as string}`);
+        outputChannel.appendLine(
+            vscode.l10n.t({
+                message: "This log file can be found at {0}",
+                args: [logFileLocation],
+                comment: ["Log file location"],
+            })
+        );
+        outputChannel.appendLine(
+            vscode.l10n.t({
+                message: "Zowe Explorer log level: {0}",
+                args: [CicsLogger.getLogSetting()],
+                comment: ["Log setting"],
+            })
+        );
+    }
+
+    private static async compareCliLogSetting(): Promise<void> {
+      const cliLogSetting = this.getZoweLogEnvVar();
+      const zeLogSetting = CicsLogger.getLogSetting();
+      // @ts-expect-error
+      if (cliLogSetting && +MessageSeverity[zeLogSetting] !== +MessageSeverity[cliLogSetting]) {
+          const notified = LoggerUtils.persistentStorage.getCicsZoweLoggerSetting();
+          if (!notified) {
+              await this.updateVscLoggerSetting(cliLogSetting);
+          }
+      }
+  }
+
+  private static async updateVscLoggerSetting(cliSetting: string): Promise<void> {
+      const updateLoggerButton = vscode.l10n.t("Update");
+      const message = vscode.l10n.t({
+          message: `Zowe Explorer now has a VS Code logger with a default log level of INFO.
+              \nIt looks like the Zowe CLI's ZOWE_APP_LOG_LEVEL={0}.
+              \nWould you like Zowe Explorer to update to the the same log level?`,
+          args: [cliSetting],
+          comment: ["CLI setting"],
+      });
+      await Gui.infoMessage(message, {
+          items: [updateLoggerButton],
+          vsCodeOpts: { modal: true },
+      }).then((selection) => {
+          if (selection === updateLoggerButton) {
+              this.setLogSetting(cliSetting);
+          }
+      });
+  }
+
+  private static setLogSetting(setting: string): void {
+    LoggerUtils.persistentStorage.addCicsZoweLoggerSetting(setting);
+  }
+
+  private static getZoweLogEnvVar(): string {
+    return process.env.ZOWE_APP_LOG_LEVEL;
+  }
+}
diff --git a/packages/vsce/src/utils/PersistentStorage.ts b/packages/vsce/src/utils/PersistentStorage.ts
@@ -25,6 +25,7 @@ export class PersistentStorage {
   private static readonly urimapsSearchHistory: string = "urimapsSearchHistory";
   private static readonly pipelineSearchHistory: string = "pipelineSearchHistory";
   private static readonly webserviceSearchHistory: string = "webserviceSearchHistory";
+  private static readonly cicsZoweLoggerSetting: string = "cicsZoweLoggerSetting";
 
   private mProgramSearchHistory: string[] = [];
   private mLibrarySearchHistory: string[] = [];
@@ -37,6 +38,7 @@ export class PersistentStorage {
   private mURIMapsSearchHistory: string[] = [];
   private mPipelineSearchHistory: string[] = [];
   private mWebServiceSearchHistory: string[] = [];
+  private mCicsZoweLoggerSetting: string = "INFO";
 
   constructor(schema: string) {
     this.schema = schema;
@@ -55,6 +57,7 @@ export class PersistentStorage {
     let urimapsSearchHistoryLines: string[] | undefined;
     let pipelineSearchHistoryLines: string[] | undefined;
     let webserviceSearchHistoryLines: string[] | undefined;
+    let cicsZoweLoggerSetting: string;
 
     if (workspace.getConfiguration(this.schema)) {
       programSearchHistoryLines = workspace.getConfiguration(this.schema).get(PersistentStorage.programSearchHistory);
@@ -68,6 +71,7 @@ export class PersistentStorage {
       urimapsSearchHistoryLines = workspace.getConfiguration(this.schema).get(PersistentStorage.urimapsSearchHistory);
       pipelineSearchHistoryLines = workspace.getConfiguration(this.schema).get(PersistentStorage.pipelineSearchHistory);
       webserviceSearchHistoryLines = workspace.getConfiguration(this.schema).get(PersistentStorage.webserviceSearchHistory);
+      cicsZoweLoggerSetting = workspace.getConfiguration(this.schema).get(PersistentStorage.cicsZoweLoggerSetting);
     }
     if (programSearchHistoryLines) {
       this.mProgramSearchHistory = programSearchHistoryLines;
@@ -160,6 +164,10 @@ export class PersistentStorage {
     return this.mWebServiceSearchHistory;
   }
 
+  public getCicsZoweLoggerSetting() : string {
+    return this.mCicsZoweLoggerSetting;
+  }
+
   public async resetProgramSearchHistory(): Promise<void> {
     this.mProgramSearchHistory = [];
     await this.updateProgramSearchHistory();
@@ -205,6 +213,11 @@ export class PersistentStorage {
     await this.updateWebServiceSearchHistory();
   }
 
+  public async resetCicsZoweLoggerSetting() : Promise<void> {
+    this.mCicsZoweLoggerSetting = "INFO";
+    await this.updateCicsZoweLoggerSetting();
+  }
+
   private async updateProgramSearchHistory(): Promise<void> {
     const settings: any = { ...workspace.getConfiguration(this.schema) };
     if (settings.persistence) {
@@ -285,6 +298,14 @@ export class PersistentStorage {
     }
   }
 
+  private async updateCicsZoweLoggerSetting(): Promise<void> {
+    const settings: any = { ...workspace.getConfiguration(this.schema) };
+    if (settings.persistence) {
+      settings[PersistentStorage.cicsZoweLoggerSetting] = this.mCicsZoweLoggerSetting;
+      await workspace.getConfiguration().update(this.schema, settings, ConfigurationTarget.Global);
+    }
+  }
+
   public async addProgramSearchHistory(criteria: string): Promise<void> {
     if (criteria) {
       this.mProgramSearchHistory = this.mProgramSearchHistory.filter((element) => {
@@ -446,6 +467,14 @@ export class PersistentStorage {
     }
   }
 
+  public async addCicsZoweLoggerSetting(criteria: string): Promise<void> {
+    if (criteria) {
+      this.mCicsZoweLoggerSetting = criteria.trim();
+
+      await this.updateCicsZoweLoggerSetting();
+    }
+  }
+
   public async removeLoadedCICSProfile(name: string): Promise<void> {
     if (name) {
       this.mLoadedCICSProfile = this.mLoadedCICSProfile.filter((element) => {
diff --git a/packages/vsce/src/utils/cicsLogger.ts b/packages/vsce/src/utils/cicsLogger.ts
diff --git a/packages/vsce/src/utils/resourceUtils.ts b/packages/vsce/src/utils/resourceUtils.ts
diff --git a/packages/vsce/tsconfig.json b/packages/vsce/tsconfig.json
