refactor error handling part 1 (#307)

- created `getErrorMessage` function which takes in an error string or any type of error object and returns the correct error message
- replaced `error.message` with `getErrorMessage` since `error` could be a string in some cases
- merged sendNotificationForError.ts with ErrorHandlingUtils.ts
- some minor refactoring

In part 2, I will make the following changes:
 - Make `Logger.logError` function take an error message string instead of an error object. This will reduce some redundancy where the `getErrorMessage` function is being called twice (the error object passed by the caller is already an error message).
 - Update every `TelemetryProcessor.traceFailure` call to make sure we pass in an error message instead of an error object since we stringify the data we send.

src/Explorer/Tree/Collection.ts

@@ -40,6 +40,7 @@ import Explorer from "../Explorer";
 import { userContext } from "../../UserContext";
 import TabsBase from "../Tabs/TabsBase";
 import { fetchPortalNotifications } from "../../Common/PortalNotifications";
+import { getErrorMessage } from "../../Common/ErrorHandlingUtils";
 
 export default class Collection implements ViewModels.Collection {
   public nodeKind: string;
@@ -610,6 +611,7 @@ export default class Collection implements ViewModels.Collection {
           settingsTab.pendingNotification(pendingNotification);
         },
         (error: any) => {
+          const errorMessage = getErrorMessage(error);
           TelemetryProcessor.traceFailure(
             Action.Tab,
             {
@@ -619,13 +621,13 @@ export default class Collection implements ViewModels.Collection {
               defaultExperience: this.container.defaultExperience(),
               dataExplorerArea: Constants.Areas.Tab,
               tabTitle: settingsTabOptions.title,
-              error: error
+              error: errorMessage
             },
             startKey
           );
           NotificationConsoleUtils.logConsoleMessage(
             ConsoleDataType.Error,
-            `Error while fetching container settings for container ${this.id()}: ${error.message}`
+            `Error while fetching container settings for container ${this.id()}: ${errorMessage}`
           );
           throw error;
         }
@@ -869,7 +871,7 @@ export default class Collection implements ViewModels.Collection {
           collectionName: this.id(),
           defaultExperience: this.container.defaultExperience(),
           dataExplorerArea: Constants.Areas.ResourceTree,
-          error: typeof error === "string" ? error : error.message
+          error: getErrorMessage(error)
         });
       }
     );
@@ -928,7 +930,7 @@ export default class Collection implements ViewModels.Collection {
           collectionName: this.id(),
           defaultExperience: this.container.defaultExperience(),
           dataExplorerArea: Constants.Areas.ResourceTree,
-          error: typeof error === "string" ? error : error.message
+          error: getErrorMessage(error)
         });
       }
     );
@@ -988,7 +990,7 @@ export default class Collection implements ViewModels.Collection {
           collectionName: this.id(),
           defaultExperience: this.container.defaultExperience(),
           dataExplorerArea: Constants.Areas.ResourceTree,
-          error: typeof error === "string" ? error : error.message
+          error: getErrorMessage(error)
         });
       }
     );
@@ -1185,7 +1187,7 @@ export default class Collection implements ViewModels.Collection {
           },
           error => {
             record.numFailed++;
-            record.errors = [...record.errors, error.message];
+            record.errors = [...record.errors, getErrorMessage(error)];
             return Q.resolve();
           }
         );
@@ -1238,7 +1240,7 @@ export default class Collection implements ViewModels.Collection {
       (error: any) => {
         Logger.logError(
           JSON.stringify({
-            error: error.message,
+            error: getErrorMessage(error),
             accountName: this.container && this.container.databaseAccount(),
             databaseName: this.databaseId,
             collectionName: this.id()

src/Explorer/Tree/Database.ts

@@ -16,6 +16,7 @@ import { readCollections } from "../../Common/dataAccess/readCollections";
 import { readDatabaseOffer } from "../../Common/dataAccess/readDatabaseOffer";
 import { DefaultAccountExperienceType } from "../../DefaultAccountExperienceType";
 import { fetchPortalNotifications } from "../../Common/PortalNotifications";
+import { getErrorMessage } from "../../Common/ErrorHandlingUtils";
 
 export default class Database implements ViewModels.Database {
   public nodeKind: string;
@@ -88,6 +89,7 @@ export default class Database implements ViewModels.Database {
           this.container.tabsManager.activateNewTab(settingsTab);
         },
         (error: any) => {
+          const errorMessage = getErrorMessage(error);
           TelemetryProcessor.traceFailure(
             Action.Tab,
             {
@@ -97,13 +99,13 @@ export default class Database implements ViewModels.Database {
               defaultExperience: this.container.defaultExperience(),
               dataExplorerArea: Constants.Areas.Tab,
               tabTitle: "Scale",
-              error: error
+              error: errorMessage
             },
             startKey
           );
           NotificationConsoleUtils.logConsoleMessage(
             ConsoleDataType.Error,
-            `Error while fetching database settings for database ${this.id()}: ${error.message}`
+            `Error while fetching database settings for database ${this.id()}: ${errorMessage}`
           );
           throw error;
         }
@@ -239,7 +241,7 @@ export default class Database implements ViewModels.Database {
       (error: any) => {
         Logger.logError(
           JSON.stringify({
-            error: error.message,
+            error: getErrorMessage(error),
             accountName: this.container && this.container.databaseAccount(),
             databaseName: this.id(),
             collectionName: this.id()

src/Explorer/Tree/StoredProcedure.ts

@@ -9,6 +9,7 @@ import * as TelemetryProcessor from "../../Shared/Telemetry/TelemetryProcessor";
 import Explorer from "../Explorer";
 import StoredProcedureTab from "../Tabs/StoredProcedureTab";
 import TabsBase from "../Tabs/TabsBase";
+import { getErrorMessage } from "../../Common/ErrorHandlingUtils";
 
 const sampleStoredProcedureBody: string = `// SAMPLE STORED PROCEDURE
 function sample(prefix) {
@@ -158,7 +159,7 @@ export default class StoredProcedure {
             sprocTab.onExecuteSprocsResult(result, result.scriptLogs);
           },
           (error: any) => {
-            sprocTab.onExecuteSprocsError(error.message);
+            sprocTab.onExecuteSprocsError(getErrorMessage(error));
           }
         )
         .finally(() => {