[FEATURE] added error code for setup command related libs (#498)

* [FEATURE] added error code for setup command related libs

* added error code for variable groups

* added more error handling in prompts.ts

* added error id to error condition

* add more error handling code

* cover error to cascading error

* update gitutil function

* revert code when we throw exception when pr link cannot be found

* throw exception with errorBuilder

* Update i18n.json

* Update i18n.json

Co-authored-by: Andre Briggs <[email protected]>

Author: dennisseah

src/config.test.ts

@@ -15,6 +15,7 @@ import {
 import { createTempDir } from "./lib/ioUtil";
 import { disableVerboseLogging, enableVerboseLogging } from "./logger";
 import { BedrockFile } from "./types";
+import { getErrorMessage } from "./lib/errorBuilder";
 import { getVersionMessage } from "./lib/fileutils";
 
 beforeAll(() => {
@@ -40,15 +41,16 @@ describe("Test updateVariableWithLocalEnv function", () => {
     ).toBe("world - world : world1");
   });
   it("negative test", () => {
-    try {
+    expect(() => {
       updateVariableWithLocalEnv(
         "${env:hello2} - ${env:hello} : ${env:hello1}"
       );
-    } catch (e) {
-      expect(e.message).toBe(
-        "Environment variable needs to be defined for hello2 since it's referenced in the config file."
-      );
-    }
+    }).toThrow(
+      getErrorMessage({
+        errorKey: "spk-config-yaml-var-undefined",
+        values: ["hello2"],
+      })
+    );
   });
 });
 
@@ -180,13 +182,9 @@ describe("Initializing a project a config file but no env vars", () => {
 describe("Initializing a project with a non-existent file", () => {
   test("Non-existent file test", () => {
     const filename = path.resolve("./spk-config-test.yaml");
-    try {
+    expect(() => {
       loadConfiguration(filename);
-      // Make sure execution does not get here:
-      expect(true).toBeFalsy();
-    } catch (e) {
-      expect(e.code).toBe("ENOENT");
-    }
+    }).toThrow(getErrorMessage("spk-config-yaml-load-err"));
   });
 });
 

src/config.ts

@@ -3,6 +3,8 @@ import fs from "fs";
 import yaml from "js-yaml";
 import * as os from "os";
 import path from "path";
+import { build as buildError } from "./lib/errorBuilder";
+import { errorStatusCode } from "./lib/errorStatusCode";
 import { writeVersion } from "./lib/fileutils";
 import { logger } from "./logger";
 import {
@@ -32,7 +34,10 @@ export const readYaml = <T>(filepath: string): T => {
     const contents = fs.readFileSync(filepath, "utf8");
     return yaml.safeLoad(contents) as T;
   }
-  throw Error(`Unable to load file '${filepath}'`);
+  throw buildError(errorStatusCode.FILE_IO_ERR, {
+    errorKey: "spk-config-yaml-err-readyaml",
+    values: [filepath],
+  });
 };
 
 /**
@@ -48,10 +53,10 @@ export const updateVariableWithLocalEnv = (value: string): string => {
       if (process.env[matches[1]]) {
         value = value.replace(matches[0], process.env[matches[1]] as string);
       } else {
-        logger.error(`Env variable needs to be defined for ${matches[1]}`);
-        throw Error(
-          `Environment variable needs to be defined for ${matches[1]} since it's referenced in the config file.`
-        );
+        throw buildError(errorStatusCode.ENV_SETTING_ERR, {
+          errorKey: "spk-config-yaml-var-undefined",
+          values: [matches[1]],
+        });
       }
       matches = regexp.exec(value);
     }
@@ -117,8 +122,11 @@ export const loadConfiguration = (
     const data = readYaml<ConfigYaml>(filepath);
     spkConfig = loadConfigurationFromLocalEnv(data || {});
   } catch (err) {
-    logger.verbose(`An error occurred while loading configuration\n ${err}`);
-    throw err;
+    throw buildError(
+      errorStatusCode.FILE_IO_ERR,
+      "spk-config-yaml-load-err",
+      err
+    );
   }
 };
 
@@ -188,7 +196,10 @@ export const Bedrock = (fileDirectory = process.cwd()): BedrockFile => {
     for (const error of helmErrors) {
       logger.error(error);
     }
-    throw Error(`invalid helm configuration found in ${bedrockYamlPath}`);
+    throw buildError(errorStatusCode.ENV_SETTING_ERR, {
+      errorKey: "bedrock-config-invalid",
+      values: [bedrockYamlPath],
+    });
   }
 
   return { ...bedrock };
@@ -248,7 +259,7 @@ export const write = (
   } else {
     // Is azure pipelines yaml file
     if (typeof fileName === "undefined") {
-      throw new Error(`Pipeline yaml file name is undefined`);
+      throw buildError(errorStatusCode.EXE_FLOW_ERR, "config-file-not-defined");
     }
 
     writeVersion(path.join(targetDirectory, fileName));

src/lib/azdoClient.ts

@@ -6,6 +6,8 @@ import { RestClient } from "typed-rest-client";
 import { Config } from "../config";
 import { logger } from "../logger";
 import { AzureDevOpsOpts } from "./git";
+import { build as buildError } from "./errorBuilder";
+import { errorStatusCode } from "./errorStatusCode";
 
 // Module state Variables
 let connection: WebApi | undefined;
@@ -41,15 +43,17 @@ export const getWebApi = async (
   } = opts;
 
   // PAT and devops URL are required
-  if (typeof personalAccessToken === "undefined") {
-    throw Error(
-      `Unable to parse Azure DevOps Personal Access Token (azure_devops.access_token) from spk config`
+  if (!personalAccessToken) {
+    throw buildError(
+      errorStatusCode.AZURE_CLIENT,
+      "azure-client-get-web-api-err-missing-access-token"
     );
   }
 
-  if (typeof orgName === "undefined") {
-    throw Error(
-      `Unable to parse Azure DevOps Organization name (azure_devops.org) from spk config`
+  if (!orgName) {
+    throw buildError(
+      errorStatusCode.AZURE_CLIENT,
+      "azure-client-get-web-api-err-missing-org"
     );
   }
 
@@ -61,7 +65,6 @@ export const getWebApi = async (
 
   const authHandler = getPersonalAccessTokenHandler(personalAccessToken);
   connection = new WebApi(orgUrl, authHandler);
-
   return connection;
 };
 
@@ -77,13 +80,21 @@ export const invalidateWebApi = (): void => {
 export const getRestClient = async (
   opts: AzureDevOpsOpts = {}
 ): Promise<RestClient> => {
-  if (typeof restApi !== "undefined") {
+  if (restApi) {
     return restApi;
   }
 
-  const webApi = await getWebApi(opts);
-  restApi = webApi.rest;
-  return restApi;
+  try {
+    const webApi = await getWebApi(opts);
+    restApi = webApi.rest;
+    return restApi;
+  } catch (err) {
+    throw buildError(
+      errorStatusCode.AZURE_CLIENT,
+      "azure-client-get-rest-client-err",
+      err
+    );
+  }
 };
 
 /**
@@ -94,13 +105,21 @@ export const getRestClient = async (
 export const getBuildApi = async (
   opts: AzureDevOpsOpts = {}
 ): Promise<IBuildApi> => {
-  if (typeof buildApi !== "undefined") {
+  if (buildApi) {
     return buildApi;
   }
 
-  const webApi = await getWebApi(opts);
-  buildApi = await webApi.getBuildApi();
-  return buildApi;
+  try {
+    const webApi = await getWebApi(opts);
+    buildApi = await webApi.getBuildApi();
+    return buildApi;
+  } catch (err) {
+    throw buildError(
+      errorStatusCode.AZURE_CLIENT,
+      "azure-client-get-build-client-err",
+      err
+    );
+  }
 };
 
 /**
@@ -112,11 +131,19 @@ export const getBuildApi = async (
 export const getTaskAgentApi = async (
   opts: AzureDevOpsOpts = {}
 ): Promise<ITaskAgentApi> => {
-  if (typeof taskAgentApi !== "undefined") {
+  if (taskAgentApi) {
     return taskAgentApi;
   }
 
-  const webApi = await getWebApi(opts);
-  taskAgentApi = await webApi.getTaskAgentApi();
-  return taskAgentApi;
+  try {
+    const webApi = await getWebApi(opts);
+    taskAgentApi = await webApi.getTaskAgentApi();
+    return taskAgentApi;
+  } catch (err) {
+    throw buildError(
+      errorStatusCode.AZURE_CLIENT,
+      "azure-client-get-task-agent-client-err",
+      err
+    );
+  }
 };

src/lib/azure/servicePrincipalService.ts

@@ -1,5 +1,7 @@
 import { logger } from "../../logger";
 import { exec } from "../shell";
+import { build as buildError } from "../errorBuilder";
+import { errorStatusCode } from "../errorStatusCode";
 
 export interface ServicePrincipal {
   id: string;
@@ -29,9 +31,7 @@ export const azCLILogin = async (): Promise<SubscriptionData[]> => {
       };
     });
   } catch (err) {
-    logger.error("Unable to execute az login");
-    logger.error(err);
-    throw err;
+    throw buildError(errorStatusCode.AZURE_CLI_ERR, "az-cli-login-err", err);
   }
 };
 
@@ -61,8 +61,10 @@ export const createWithAzCLI = async (
       tenantId: oResult.tenant,
     };
   } catch (err) {
-    logger.error("Unable to create service principal with az command line");
-    logger.error(err);
-    throw err;
+    throw buildError(
+      errorStatusCode.AZURE_CLI_ERR,
+      "az-cli-create-sp-err",
+      err
+    );
   }
 };