Merge pull request #1776 from zowe/confusing-error-messages

Improve activation errors and team config logging
zowe · May 6, 2022 · c178df0 · c178df0
2 parents 1c4e1a9 + 29e16ce
commit c178df0
Show file tree

Hide file tree

Showing 3 changed files with 41 additions and 22 deletions.
diff --git a/packages/zowe-explorer/i18n/sample/src/extension.i18n.json b/packages/zowe-explorer/i18n/sample/src/extension.i18n.json
@@ -1,6 +1,7 @@
 {
   "initialize.log.debug": "Initialized logger from VSCode extension",
   "initialize.log.error": "Error encountered while activating and initializing logger! ",
+  "initialize.profiles.error": "Error reading or initializing Zowe CLI profiles.",
   "createNewConnection.option.prompt.profileName.placeholder": "Connection Name",
   "createNewConnection.option.prompt.profileName": "Enter a name for the connection.",
   "createNewConnection.undefined.passWord": "Operation Cancelled",

diff --git a/packages/zowe-explorer/src/extension.ts b/packages/zowe-explorer/src/extension.ts
@@ -70,25 +70,23 @@ export async function activate(context: vscode.ExtensionContext): Promise<ZoweEx
 
     hideTempFolder(getZoweDir());
 
-    try {
-        if (!fs.existsSync(globals.ZOWETEMPFOLDER)) {
-            fs.mkdirSync(globals.ZOWETEMPFOLDER);
-            fs.mkdirSync(globals.ZOWE_TMP_FOLDER);
-            fs.mkdirSync(globals.USS_DIR);
-            fs.mkdirSync(globals.DS_DIR);
-        }
-    } catch (err) {
-        await errorHandling(err, null, err.message);
-    }
-
     let datasetProvider: IZoweTree<IZoweDatasetTreeNode>;
     let ussFileProvider: IZoweTree<IZoweUSSTreeNode>;
     let jobsProvider: IZoweTree<IZoweJobTreeNode>;
 
     try {
         globals.initLogger(context);
         globals.LOG.debug(localize("initialize.log.debug", "Initialized logger from VSCode extension"));
+    } catch (err) {
+        const errorMessage = localize(
+            "initialize.log.error",
+            "Error encountered while activating and initializing logger! "
+        );
+        await errorHandling(err, null, errorMessage);
+        globals.LOG.error(errorMessage + JSON.stringify(err));
+    }
 
+    try {
         // Ensure that ~/.zowe folder exists
         if (!ImperativeConfig.instance.config?.exists) {
             await CliProfileManager.initialize({
@@ -102,23 +100,25 @@ export async function activate(context: vscode.ExtensionContext): Promise<ZoweEx
         // Initialize profile manager
         await Profiles.createInstance(globals.LOG);
 
+        if (!fs.existsSync(globals.ZOWETEMPFOLDER)) {
+            fs.mkdirSync(globals.ZOWETEMPFOLDER);
+            fs.mkdirSync(globals.ZOWE_TMP_FOLDER);
+            fs.mkdirSync(globals.USS_DIR);
+            fs.mkdirSync(globals.DS_DIR);
+        }
+
         // Initialize dataset provider
         datasetProvider = await createDatasetTree(globals.LOG);
         // Initialize uss provider
         ussFileProvider = await createUSSTree(globals.LOG);
         // Initialize Jobs provider with the created session and the selected pattern
         jobsProvider = await createJobsTree(globals.LOG);
     } catch (err) {
-        await errorHandling(
-            err,
-            null,
-            localize("initialize.log.error", "Error encountered while activating and initializing logger! ")
-        );
-        globals.LOG.error(
-            localize("initialize.log.error", "Error encountered while activating and initializing logger! ") +
-                JSON.stringify(err)
-        );
+        const errorMessage = localize("initialize.profiles.error", "Error reading or initializing Zowe CLI profiles.");
+        await errorHandling(err, null, errorMessage);
+        globals.LOG.error(errorMessage + JSON.stringify(err));
     }
+
     // set a command to silently reload extension
     context.subscriptions.push(
         vscode.commands.registerCommand("zowe.extRefresh", async () => {

diff --git a/packages/zowe-explorer/src/utils/ProfilesUtils.ts b/packages/zowe-explorer/src/utils/ProfilesUtils.ts
@@ -14,8 +14,8 @@
 import * as vscode from "vscode";
 import * as fs from "fs";
 import * as globals from "../globals";
-import { Session, IProfile, IProfileLoaded, ProfileInfo, Logger } from "@zowe/imperative";
-import { getSecurityModules, IZoweTreeNode, ProfilesCache, ZoweTreeNode, getZoweDir } from "@zowe/zowe-explorer-api";
+import { Session, IProfile, IProfileLoaded, ProfileInfo, IConfigLayer } from "@zowe/imperative";
+import { getSecurityModules, IZoweTreeNode, ZoweTreeNode, getZoweDir } from "@zowe/zowe-explorer-api";
 import { Profiles } from "../Profiles";
 import * as nls from "vscode-nls";
 
@@ -247,5 +247,23 @@ export async function readConfigFromDisk() {
     }
     if (mProfileInfo.usingTeamConfig) {
         globals.setConfigPath(rootPath);
+        globals.LOG.debug(
+            'Zowe Explorer is using the team configuration file "%s"',
+            mProfileInfo.getTeamConfig().configName
+        );
+        const layers = mProfileInfo.getTeamConfig().layers || [];
+        const layerSummary = layers.map(
+            (config: IConfigLayer) =>
+                `Path: ${config.path}: ${
+                    config.exists
+                        ? "Found, with the following defaults:" +
+                          JSON.stringify(config.properties?.defaults || "Undefined default")
+                        : "Not available"
+                } `
+        );
+        globals.LOG.debug(
+            "Summary of team configuration files considered for Zowe Explorer: %s",
+            JSON.stringify(layerSummary)
+        );
     }
 }