Refactor BrowserConfigurationAuthError for reduced size (#6473)

Same changes as #6433 , #6471 , #6414, #6472

change/@azure-msal-browser-983aff1b-3c76-4c2f-a960-715c58758e34.json

@@ -0,0 +1,7 @@
+{
+  "type": "minor",
+  "comment": "Refactor BrowserConfigurationAuthError #6473",
+  "packageName": "@azure/msal-browser",
+  "email": "[email protected]",
+  "dependentChangeType": "patch"
+}

lib/msal-browser/src/app/IPublicClientApplication.ts

@@ -13,7 +13,10 @@ import { PopupRequest } from "../request/PopupRequest";
 import { SilentRequest } from "../request/SilentRequest";
 import { SsoSilentRequest } from "../request/SsoSilentRequest";
 import { EndSessionRequest } from "../request/EndSessionRequest";
-import { BrowserConfigurationAuthError } from "../error/BrowserConfigurationAuthError";
+import {
+    BrowserConfigurationAuthErrorCodes,
+    createBrowserConfigurationAuthError,
+} from "../error/BrowserConfigurationAuthError";
 import { WrapperSKU } from "../utils/BrowserConstants";
 import { INavigationClient } from "../navigation/INavigationClient";
 import { EndSessionPopupRequest } from "../request/EndSessionPopupRequest";
@@ -74,27 +77,37 @@ export interface IPublicClientApplication {
 export const stubbedPublicClientApplication: IPublicClientApplication = {
     initialize: () => {
         return Promise.reject(
-            BrowserConfigurationAuthError.createStubPcaInstanceCalledError()
+            createBrowserConfigurationAuthError(
+                BrowserConfigurationAuthErrorCodes.stubbedPublicClientApplicationCalled
+            )
         );
     },
     acquireTokenPopup: () => {
         return Promise.reject(
-            BrowserConfigurationAuthError.createStubPcaInstanceCalledError()
+            createBrowserConfigurationAuthError(
+                BrowserConfigurationAuthErrorCodes.stubbedPublicClientApplicationCalled
+            )
         );
     },
     acquireTokenRedirect: () => {
         return Promise.reject(
-            BrowserConfigurationAuthError.createStubPcaInstanceCalledError()
+            createBrowserConfigurationAuthError(
+                BrowserConfigurationAuthErrorCodes.stubbedPublicClientApplicationCalled
+            )
         );
     },
     acquireTokenSilent: () => {
         return Promise.reject(
-            BrowserConfigurationAuthError.createStubPcaInstanceCalledError()
+            createBrowserConfigurationAuthError(
+                BrowserConfigurationAuthErrorCodes.stubbedPublicClientApplicationCalled
+            )
         );
     },
     acquireTokenByCode: () => {
         return Promise.reject(
-            BrowserConfigurationAuthError.createStubPcaInstanceCalledError()
+            createBrowserConfigurationAuthError(
+                BrowserConfigurationAuthErrorCodes.stubbedPublicClientApplicationCalled
+            )
         );
     },
     getAllAccounts: () => {
@@ -111,37 +124,51 @@ export const stubbedPublicClientApplication: IPublicClientApplication = {
     },
     handleRedirectPromise: () => {
         return Promise.reject(
-            BrowserConfigurationAuthError.createStubPcaInstanceCalledError()
+            createBrowserConfigurationAuthError(
+                BrowserConfigurationAuthErrorCodes.stubbedPublicClientApplicationCalled
+            )
         );
     },
     loginPopup: () => {
         return Promise.reject(
-            BrowserConfigurationAuthError.createStubPcaInstanceCalledError()
+            createBrowserConfigurationAuthError(
+                BrowserConfigurationAuthErrorCodes.stubbedPublicClientApplicationCalled
+            )
         );
     },
     loginRedirect: () => {
         return Promise.reject(
-            BrowserConfigurationAuthError.createStubPcaInstanceCalledError()
+            createBrowserConfigurationAuthError(
+                BrowserConfigurationAuthErrorCodes.stubbedPublicClientApplicationCalled
+            )
         );
     },
     logout: () => {
         return Promise.reject(
-            BrowserConfigurationAuthError.createStubPcaInstanceCalledError()
+            createBrowserConfigurationAuthError(
+                BrowserConfigurationAuthErrorCodes.stubbedPublicClientApplicationCalled
+            )
         );
     },
     logoutRedirect: () => {
         return Promise.reject(
-            BrowserConfigurationAuthError.createStubPcaInstanceCalledError()
+            createBrowserConfigurationAuthError(
+                BrowserConfigurationAuthErrorCodes.stubbedPublicClientApplicationCalled
+            )
         );
     },
     logoutPopup: () => {
         return Promise.reject(
-            BrowserConfigurationAuthError.createStubPcaInstanceCalledError()
+            createBrowserConfigurationAuthError(
+                BrowserConfigurationAuthErrorCodes.stubbedPublicClientApplicationCalled
+            )
         );
     },
     ssoSilent: () => {
         return Promise.reject(
-            BrowserConfigurationAuthError.createStubPcaInstanceCalledError()
+            createBrowserConfigurationAuthError(
+                BrowserConfigurationAuthErrorCodes.stubbedPublicClientApplicationCalled
+            )
         );
     },
     addEventCallback: () => {
@@ -163,10 +190,14 @@ export const stubbedPublicClientApplication: IPublicClientApplication = {
         return;
     },
     getTokenCache: () => {
-        throw BrowserConfigurationAuthError.createStubPcaInstanceCalledError();
+        throw createBrowserConfigurationAuthError(
+            BrowserConfigurationAuthErrorCodes.stubbedPublicClientApplicationCalled
+        );
     },
     getLogger: () => {
-        throw BrowserConfigurationAuthError.createStubPcaInstanceCalledError();
+        throw createBrowserConfigurationAuthError(
+            BrowserConfigurationAuthErrorCodes.stubbedPublicClientApplicationCalled
+        );
     },
     setLogger: () => {
         return;
@@ -184,16 +215,22 @@ export const stubbedPublicClientApplication: IPublicClientApplication = {
         return;
     },
     getConfiguration: () => {
-        throw BrowserConfigurationAuthError.createStubPcaInstanceCalledError();
+        throw createBrowserConfigurationAuthError(
+            BrowserConfigurationAuthErrorCodes.stubbedPublicClientApplicationCalled
+        );
     },
     hydrateCache: () => {
         return Promise.reject(
-            BrowserConfigurationAuthError.createStubPcaInstanceCalledError()
+            createBrowserConfigurationAuthError(
+                BrowserConfigurationAuthErrorCodes.stubbedPublicClientApplicationCalled
+            )
         );
     },
     clearCache: () => {
         return Promise.reject(
-            BrowserConfigurationAuthError.createStubPcaInstanceCalledError()
+            createBrowserConfigurationAuthError(
+                BrowserConfigurationAuthErrorCodes.stubbedPublicClientApplicationCalled
+            )
         );
     },
 };

lib/msal-browser/src/cache/BrowserStorage.ts

@@ -3,7 +3,10 @@
  * Licensed under the MIT License.
  */
 
-import { BrowserConfigurationAuthError } from "../error/BrowserConfigurationAuthError";
+import {
+    BrowserConfigurationAuthErrorCodes,
+    createBrowserConfigurationAuthError,
+} from "../error/BrowserConfigurationAuthError";
 import { BrowserCacheLocation } from "../utils/BrowserConstants";
 import { IWindowStorage } from "./IWindowStorage";
 
@@ -17,17 +20,12 @@ export class BrowserStorage implements IWindowStorage<string> {
 
     private validateWindowStorage(cacheLocation: string): void {
         if (
-            cacheLocation !== BrowserCacheLocation.LocalStorage &&
-            cacheLocation !== BrowserCacheLocation.SessionStorage
+            (cacheLocation !== BrowserCacheLocation.LocalStorage &&
+                cacheLocation !== BrowserCacheLocation.SessionStorage) ||
+            !window[cacheLocation]
         ) {
-            throw BrowserConfigurationAuthError.createStorageNotSupportedError(
-                cacheLocation
-            );
-        }
-        const storageSupported = !!window[cacheLocation];
-        if (!storageSupported) {
-            throw BrowserConfigurationAuthError.createStorageNotSupportedError(
-                cacheLocation
+            throw createBrowserConfigurationAuthError(
+                BrowserConfigurationAuthErrorCodes.storageNotSupported
             );
         }
     }

lib/msal-browser/src/controllers/StandardController.ts

@@ -51,7 +51,10 @@ import { SsoSilentRequest } from "../request/SsoSilentRequest";
 import { EventCallbackFunction, EventError } from "../event/EventMessage";
 import { EventType } from "../event/EventType";
 import { EndSessionRequest } from "../request/EndSessionRequest";
-import { BrowserConfigurationAuthError } from "../error/BrowserConfigurationAuthError";
+import {
+    BrowserConfigurationAuthErrorCodes,
+    createBrowserConfigurationAuthError,
+} from "../error/BrowserConfigurationAuthError";
 import { EndSessionPopupRequest } from "../request/EndSessionPopupRequest";
 import { INavigationClient } from "../navigation/INavigationClient";
 import { EventHandler } from "../event/EventHandler";
@@ -1380,7 +1383,9 @@ export class StandardController implements IController {
                 BrowserCacheLocation.MemoryStorage &&
             !this.config.cache.storeAuthStateInCookie
         ) {
-            throw BrowserConfigurationAuthError.createInMemoryRedirectUnavailableError();
+            throw createBrowserConfigurationAuthError(
+                BrowserConfigurationAuthErrorCodes.inMemRedirectUnavailable
+            );
         }
 
         if (

lib/msal-browser/src/error/BrowserConfigurationAuthError.ts

@@ -4,46 +4,41 @@
  */
 
 import { AuthError } from "@azure/msal-common";
+import * as BrowserConfigurationAuthErrorCodes from "./BrowserConfigurationAuthErrorCodes";
+export { BrowserConfigurationAuthErrorCodes };
+
+export const BrowserConfigurationAuthErrorMessages = {
+    [BrowserConfigurationAuthErrorCodes.storageNotSupported]:
+        "Given storage configuration option was not supported.",
+    [BrowserConfigurationAuthErrorCodes.stubbedPublicClientApplicationCalled]:
+        "Stub instance of Public Client Application was called. If using msal-react, please ensure context is not used without a provider. For more visit: aka.ms/msaljs/browser-errors",
+    [BrowserConfigurationAuthErrorCodes.inMemRedirectUnavailable]:
+        "Redirect cannot be supported. In-memory storage was selected and storeAuthStateInCookie=false, which would cause the library to be unable to handle the incoming hash. If you would like to use the redirect API, please use session/localStorage or set storeAuthStateInCookie=true.",
+};
 
 /**
  * BrowserAuthErrorMessage class containing string constants used by error codes and messages.
+ * @deprecated Use BrowserAuthErrorCodes instead
  */
 export const BrowserConfigurationAuthErrorMessage = {
-    redirectUriNotSet: {
-        code: "redirect_uri_empty",
-        desc: "A redirect URI is required for all calls, and none has been set.",
-    },
-    postLogoutUriNotSet: {
-        code: "post_logout_uri_empty",
-        desc: "A post logout redirect has not been set.",
-    },
     storageNotSupportedError: {
-        code: "storage_not_supported",
-        desc: "Given storage configuration option was not supported.",
-    },
-    noRedirectCallbacksSet: {
-        code: "no_redirect_callbacks",
-        desc:
-            "No redirect callbacks have been set. Please call setRedirectCallbacks() with the appropriate function arguments before continuing. " +
-            "More information is available here: https://github.com/AzureAD/microsoft-authentication-library-for-js/wiki/MSAL-basics.",
-    },
-    invalidCallbackObject: {
-        code: "invalid_callback_object",
-        desc:
-            "The object passed for the callback was invalid. " +
-            "More information is available here: https://github.com/AzureAD/microsoft-authentication-library-for-js/wiki/MSAL-basics.",
+        code: BrowserConfigurationAuthErrorCodes.storageNotSupported,
+        desc: BrowserConfigurationAuthErrorMessages[
+            BrowserConfigurationAuthErrorCodes.storageNotSupported
+        ],
     },
     stubPcaInstanceCalled: {
-        code: "stubbed_public_client_application_called",
-        desc: "Stub instance of Public Client Application was called. If using msal-react, please ensure context is not used without a provider. For more visit: aka.ms/msaljs/browser-errors",
+        code: BrowserConfigurationAuthErrorCodes.stubbedPublicClientApplicationCalled,
+        desc: BrowserConfigurationAuthErrorMessages[
+            BrowserConfigurationAuthErrorCodes
+                .stubbedPublicClientApplicationCalled
+        ],
     },
     inMemRedirectUnavailable: {
-        code: "in_mem_redirect_unavailable",
-        desc: "Redirect cannot be supported. In-memory storage was selected and storeAuthStateInCookie=false, which would cause the library to be unable to handle the incoming hash. If you would like to use the redirect API, please use session/localStorage or set storeAuthStateInCookie=true.",
-    },
-    entropyNotProvided: {
-        code: "entropy_not_provided",
-        desc: "The available browser crypto interface requires entropy set via system.cryptoOptions.entropy configuration option.",
+        code: BrowserConfigurationAuthErrorCodes.inMemRedirectUnavailable,
+        desc: BrowserConfigurationAuthErrorMessages[
+            BrowserConfigurationAuthErrorCodes.inMemRedirectUnavailable
+        ],
     },
 };
 
@@ -57,77 +52,13 @@ export class BrowserConfigurationAuthError extends AuthError {
 
         Object.setPrototypeOf(this, BrowserConfigurationAuthError.prototype);
     }
+}
 
-    /**
-     * Creates an error thrown when the redirect uri is empty (not set by caller)
-     */
-    static createRedirectUriEmptyError(): BrowserConfigurationAuthError {
-        return new BrowserConfigurationAuthError(
-            BrowserConfigurationAuthErrorMessage.redirectUriNotSet.code,
-            BrowserConfigurationAuthErrorMessage.redirectUriNotSet.desc
-        );
-    }
-
-    /**
-     * Creates an error thrown when the post-logout redirect uri is empty (not set by caller)
-     */
-    static createPostLogoutRedirectUriEmptyError(): BrowserConfigurationAuthError {
-        return new BrowserConfigurationAuthError(
-            BrowserConfigurationAuthErrorMessage.postLogoutUriNotSet.code,
-            BrowserConfigurationAuthErrorMessage.postLogoutUriNotSet.desc
-        );
-    }
-
-    /**
-     * Creates error thrown when given storage location is not supported.
-     * @param givenStorageLocation
-     */
-    static createStorageNotSupportedError(
-        givenStorageLocation: string
-    ): BrowserConfigurationAuthError {
-        return new BrowserConfigurationAuthError(
-            BrowserConfigurationAuthErrorMessage.storageNotSupportedError.code,
-            `${BrowserConfigurationAuthErrorMessage.storageNotSupportedError.desc} Given Location: ${givenStorageLocation}`
-        );
-    }
-
-    /**
-     * Creates error thrown when redirect callbacks are not set before calling loginRedirect() or acquireTokenRedirect().
-     */
-    static createRedirectCallbacksNotSetError(): BrowserConfigurationAuthError {
-        return new BrowserConfigurationAuthError(
-            BrowserConfigurationAuthErrorMessage.noRedirectCallbacksSet.code,
-            BrowserConfigurationAuthErrorMessage.noRedirectCallbacksSet.desc
-        );
-    }
-
-    /**
-     * Creates error thrown when the stub instance of PublicClientApplication is called.
-     */
-    static createStubPcaInstanceCalledError(): BrowserConfigurationAuthError {
-        return new BrowserConfigurationAuthError(
-            BrowserConfigurationAuthErrorMessage.stubPcaInstanceCalled.code,
-            BrowserConfigurationAuthErrorMessage.stubPcaInstanceCalled.desc
-        );
-    }
-
-    /*
-     * Create an error thrown when in-memory storage is used and storeAuthStateInCookie=false.
-     */
-    static createInMemoryRedirectUnavailableError(): BrowserConfigurationAuthError {
-        return new BrowserConfigurationAuthError(
-            BrowserConfigurationAuthErrorMessage.inMemRedirectUnavailable.code,
-            BrowserConfigurationAuthErrorMessage.inMemRedirectUnavailable.desc
-        );
-    }
-
-    /**
-     * Creates an error thrown when a crypto interface that requires entropy is initialized without entropy
-     */
-    static createEntropyNotProvided(): BrowserConfigurationAuthError {
-        return new BrowserConfigurationAuthError(
-            BrowserConfigurationAuthErrorMessage.entropyNotProvided.code,
-            BrowserConfigurationAuthErrorMessage.entropyNotProvided.desc
-        );
-    }
+export function createBrowserConfigurationAuthError(
+    errorCode: string
+): BrowserConfigurationAuthError {
+    return new BrowserConfigurationAuthError(
+        errorCode,
+        BrowserConfigurationAuthErrorMessages[errorCode]
+    );
 }

lib/msal-browser/src/error/BrowserConfigurationAuthErrorCodes.ts

@@ -0,0 +1,9 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+export const storageNotSupported = "storage_not_supported";
+export const stubbedPublicClientApplicationCalled =
+    "stubbed_public_client_application_called";
+export const inMemRedirectUnavailable = "in_mem_redirect_unavailable";

lib/msal-browser/src/index.ts

@@ -47,6 +47,7 @@ export {
 } from "./error/BrowserAuthError";
 export {
     BrowserConfigurationAuthError,
+    BrowserConfigurationAuthErrorCodes,
     BrowserConfigurationAuthErrorMessage,
 } from "./error/BrowserConfigurationAuthError";