[Identity] Error name alignment (#14690)

This PR renames errors `CredentialUnavailable` to `CredentialUnavailableError`, and `AuthenticationRequired` to `AuthenticationRequiredError`, to improve the readability of these exported classes.

I couldn't find any instance of any of our packages using these error names (other than within Identity itself).

Fixes #14662

Author: sadasant

sdk/identity/identity/CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## 2.0.0-beta.2 (Unreleased)
 
+- Breaking change: Renamed errors `CredentialUnavailable` to `CredentialUnavailableError`, and `AuthenticationRequired` to `AuthenticationRequiredError`, to align with the naming convention used for error classes in the Azure SDKs in JavaScript.
 - Added `clientId` to the `AuthenticationRecord` type.
 - `AuthenticationRecord` no longer has a `serialize` method. This method is now called `serializeAuthenticationRecord` and is a function exported at the top level of the Identity library, similar to `deserializeAuthenticationRecord`.
 - `serializeAuthenticationRecord` now serializes into a JSON string with camel case properties. This makes it re-usable across languages.

sdk/identity/identity/review/identity.api.md

@@ -41,7 +41,7 @@ export interface AuthenticationRecord {
 }
 
 // @public
-export class AuthenticationRequired extends CredentialUnavailable {
+export class AuthenticationRequiredError extends CredentialUnavailableError {
     constructor(
     scopes: string[],
     getTokenOptions?: GetTokenOptions, message?: string);
@@ -108,12 +108,12 @@ export interface ClientSecretCredentialOptions extends TokenCredentialOptions {
 }
 
 // @public
-export class CredentialUnavailable extends Error {
+export class CredentialUnavailableError extends Error {
     constructor(message?: string);
 }
 
 // @public
-export const CredentialUnavailableName = "CredentialUnavailable";
+export const CredentialUnavailableErrorName = "CredentialUnavailableError";
 
 // @public
 export class DefaultAzureCredential extends ChainedTokenCredential {

sdk/identity/identity/src/client/errors.ts

@@ -65,17 +65,17 @@ function isErrorResponse(errorResponse: any): errorResponse is OAuthErrorRespons
 /**
  * The Error.name value of an CredentialUnavailable
  */
-export const CredentialUnavailableName = "CredentialUnavailable";
+export const CredentialUnavailableErrorName = "CredentialUnavailableError";
 
 /**
  * This signifies that the credential that was tried in a chained credential
  * was not available to be used as the credential. Rather than treating this as
  * an error that should halt the chain, it's caught and the chain continues
  */
-export class CredentialUnavailable extends Error {
+export class CredentialUnavailableError extends Error {
   constructor(message?: string) {
     super(message);
-    this.name = CredentialUnavailableName;
+    this.name = CredentialUnavailableErrorName;
   }
 }
 

sdk/identity/identity/src/credentials/authorizationCodeCredential.ts

@@ -3,7 +3,7 @@
 
 import qs from "qs";
 import { createSpan } from "../util/tracing";
-import { CredentialUnavailable } from "../client/errors";
+import { CredentialUnavailableError } from "../client/errors";
 import { TokenCredential, GetTokenOptions, AccessToken } from "@azure/core-http";
 import { IdentityClient, TokenResponse, TokenCredentialOptions } from "../client/identityClient";
 import { SpanStatusCode } from "@azure/core-tracing";
@@ -188,7 +188,7 @@ export class AuthorizationCodeCredential implements TokenCredential {
       const token = tokenResponse && tokenResponse.accessToken;
 
       if (!token) {
-        throw new CredentialUnavailable("Failed to retrieve a valid token");
+        throw new CredentialUnavailableError("Failed to retrieve a valid token");
       }
       return token;
     } catch (err) {

sdk/identity/identity/src/credentials/azureCliCredential.ts

@@ -3,7 +3,7 @@
 
 import { TokenCredential, GetTokenOptions, AccessToken } from "@azure/core-http";
 import { createSpan } from "../util/tracing";
-import { CredentialUnavailable } from "../client/errors";
+import { CredentialUnavailableError } from "../client/errors";
 import { SpanStatusCode } from "@azure/core-tracing";
 import { credentialLogger, formatSuccess, formatError } from "../util/logging";
 import * as child_process from "child_process";
@@ -91,19 +91,19 @@ export class AzureCliCredential implements TokenCredential {
               obj.stderr.match("az:(.*)not found") ||
               obj.stderr.startsWith("'az' is not recognized");
             if (isNotInstallError) {
-              const error = new CredentialUnavailable(
+              const error = new CredentialUnavailableError(
                 "Azure CLI could not be found.  Please visit https://aka.ms/azure-cli for installation instructions and then, once installed, authenticate to your Azure account using 'az login'."
               );
               logger.getToken.info(formatError(scopes, error));
               throw error;
             } else if (isLoginError) {
-              const error = new CredentialUnavailable(
+              const error = new CredentialUnavailableError(
                 "Please run 'az login' from a command prompt to authenticate before using this credential."
               );
               logger.getToken.info(formatError(scopes, error));
               throw error;
             }
-            const error = new CredentialUnavailable(obj.stderr);
+            const error = new CredentialUnavailableError(obj.stderr);
             logger.getToken.info(formatError(scopes, error));
             throw error;
           } else {

sdk/identity/identity/src/credentials/chainedTokenCredential.ts

@@ -2,7 +2,7 @@
 // Licensed under the MIT license.
 
 import { AccessToken, TokenCredential, GetTokenOptions } from "@azure/core-http";
-import { AggregateAuthenticationError, CredentialUnavailable } from "../client/errors";
+import { AggregateAuthenticationError, CredentialUnavailableError } from "../client/errors";
 import { createSpan } from "../util/tracing";
 import { SpanStatusCode } from "@azure/core-tracing";
 import { credentialLogger, formatSuccess, formatError } from "../util/logging";
@@ -61,7 +61,7 @@ export class ChainedTokenCredential implements TokenCredential {
       try {
         token = await this._sources[i].getToken(scopes, updatedOptions);
       } catch (err) {
-        if (err.name === "CredentialUnavailable") {
+        if (err.name === "CredentialUnavailableError") {
           errors.push(err);
         } else {
           logger.getToken.info(formatError(scopes, err));
@@ -85,7 +85,7 @@ export class ChainedTokenCredential implements TokenCredential {
     logger.getToken.info(formatSuccess(scopes));
 
     if (token === null) {
-      throw new CredentialUnavailable("Failed to retrieve a valid token");
+      throw new CredentialUnavailableError("Failed to retrieve a valid token");
     }
     return token;
   }

sdk/identity/identity/src/credentials/environmentCredential.ts

@@ -5,7 +5,7 @@ import { AccessToken, TokenCredential, GetTokenOptions } from "@azure/core-http"
 import { credentialLogger, processEnvVars, formatSuccess, formatError } from "../util/logging";
 import { TokenCredentialOptions } from "../client/identityClient";
 import { ClientSecretCredential } from "./clientSecretCredential";
-import { AuthenticationError, CredentialUnavailable } from "../client/errors";
+import { AuthenticationError, CredentialUnavailableError } from "../client/errors";
 import { checkTenantId } from "../util/checkTenantId";
 import { trace } from "../util/tracing";
 import { ClientCertificateCredential } from "./clientCertificateCredential";
@@ -131,7 +131,7 @@ export class EnvironmentCredential implements TokenCredential {
           throw authenticationError;
         }
       }
-      throw new CredentialUnavailable(
+      throw new CredentialUnavailableError(
         "EnvironmentCredential is unavailable. No underlying credential could be used."
       );
     });

sdk/identity/identity/src/credentials/managedIdentityCredential/index.ts

@@ -4,7 +4,7 @@
 import { AccessToken, GetTokenOptions, TokenCredential } from "@azure/core-http";
 import { IdentityClient, TokenCredentialOptions } from "../../client/identityClient";
 import { createSpan } from "../../util/tracing";
-import { AuthenticationError, CredentialUnavailable } from "../../client/errors";
+import { AuthenticationError, CredentialUnavailableError } from "../../client/errors";
 import { SpanStatusCode } from "@azure/core-tracing";
 import { credentialLogger, formatSuccess, formatError } from "../../util/logging";
 import { mapScopesToResource } from "./utils";
@@ -84,7 +84,7 @@ export class ManagedIdentityCredential implements TokenCredential {
       }
     }
 
-    throw new CredentialUnavailable("ManagedIdentityCredential - No MSI credential available");
+    throw new CredentialUnavailableError("ManagedIdentityCredential - No MSI credential available");
   }
 
   private async authenticateManagedIdentity(
@@ -147,7 +147,7 @@ export class ManagedIdentityCredential implements TokenCredential {
 
           // It also means that the endpoint answered with either 200 or 201 (see the sendTokenRequest method),
           // yet we had no access token. For this reason, we'll throw once with a specific message:
-          const error = new CredentialUnavailable(
+          const error = new CredentialUnavailableError(
             "The managed identity endpoint was reached, yet no tokens were received."
           );
           logger.getToken.info(formatError(scopes, error));
@@ -161,7 +161,7 @@ export class ManagedIdentityCredential implements TokenCredential {
       } else {
         // We've previously determined that the endpoint was unavailable,
         // either because it was unreachable or permanently unable to authenticate.
-        const error = new CredentialUnavailable(
+        const error = new CredentialUnavailableError(
           "The managed identity endpoint is not currently available"
         );
         logger.getToken.info(formatError(scopes, error));
@@ -173,7 +173,7 @@ export class ManagedIdentityCredential implements TokenCredential {
     } catch (err) {
       // CredentialUnavailable errors are expected to reach here.
       // We intend them to bubble up, so that DefaultAzureCredential can catch them.
-      if (err.name === "AuthenticationRequired") {
+      if (err.name === "AuthenticationRequiredError") {
         throw err;
       }
 
@@ -191,7 +191,7 @@ export class ManagedIdentityCredential implements TokenCredential {
       // If either the network is unreachable,
       // we can safely assume the credential is unavailable.
       if (err.code === "ENETUNREACH") {
-        const error = new CredentialUnavailable(
+        const error = new CredentialUnavailableError(
           "ManagedIdentityCredential is unavailable. Network unreachable."
         );
 
@@ -202,7 +202,7 @@ export class ManagedIdentityCredential implements TokenCredential {
       // If either the host was unreachable,
       // we can safely assume the credential is unavailable.
       if (err.code === "EHOSTUNREACH") {
-        const error = new CredentialUnavailable(
+        const error = new CredentialUnavailableError(
           "ManagedIdentityCredential is unavailable. No managed identity endpoint found."
         );
 
@@ -213,15 +213,15 @@ export class ManagedIdentityCredential implements TokenCredential {
       // If err.statusCode has a value of 400, it comes from sendTokenRequest,
       // and it means that the endpoint is working, but that no identity is available.
       if (err.statusCode === 400) {
-        throw new CredentialUnavailable(
+        throw new CredentialUnavailableError(
           "The managed identity endpoint is indicating there's no available identity"
         );
       }
 
       // If the error has no status code, we can assume there was no available identity.
       // This will throw silently during any ChainedTokenCredential.
       if (err.statusCode === undefined) {
-        throw new CredentialUnavailable(
+        throw new CredentialUnavailableError(
           `ManagedIdentityCredential authentication failed. Message ${err.message}`
         );
       }

sdk/identity/identity/src/credentials/visualStudioCodeCredential.ts

@@ -15,7 +15,7 @@ try {
   keytar = null;
 }
 
-import { CredentialUnavailable } from "../client/errors";
+import { CredentialUnavailableError } from "../client/errors";
 import { credentialLogger, formatSuccess, formatError } from "../util/logging";
 import { AzureAuthorityHosts } from "../constants";
 import { checkTenantId } from "../util/checkTenantId";
@@ -34,7 +34,7 @@ function checkUnsupportedTenant(tenantId: string): void {
   // If the Tenant ID isn't supported, we throw.
   const unsupportedTenantError = unsupportedTenantIds[tenantId];
   if (unsupportedTenantError) {
-    throw new CredentialUnavailable(unsupportedTenantError);
+    throw new CredentialUnavailableError(unsupportedTenantError);
   }
 }
 
@@ -172,7 +172,7 @@ export class VisualStudioCodeCredential implements TokenCredential {
   ): Promise<AccessToken> {
     await this.prepareOnce();
     if (!keytar) {
-      throw new CredentialUnavailable(
+      throw new CredentialUnavailableError(
         "Visual Studio Code credential requires the optional dependency 'keytar' to work correctly"
       );
     }
@@ -222,14 +222,14 @@ export class VisualStudioCodeCredential implements TokenCredential {
         logger.getToken.info(formatSuccess(scopes));
         return tokenResponse.accessToken;
       } else {
-        const error = new CredentialUnavailable(
+        const error = new CredentialUnavailableError(
           "Could not retrieve the token associated with Visual Studio Code. Have you connected using the 'Azure Account' extension recently?"
         );
         logger.getToken.info(formatError(scopes, error));
         throw error;
       }
     } else {
-      const error = new CredentialUnavailable(
+      const error = new CredentialUnavailableError(
         "Could not retrieve the token associated with Visual Studio Code. Did you connect using the 'Azure Account' extension?"
       );
       logger.getToken.info(formatError(scopes, error));

sdk/identity/identity/src/index.ts

@@ -5,7 +5,7 @@ import { TokenCredential } from "@azure/core-http";
 import { DefaultAzureCredential } from "./credentials/defaultAzureCredential";
 
 export { AuthenticationRecord } from "./msal/types";
-export { AuthenticationRequired } from "./msal/errors";
+export { AuthenticationRequiredError } from "./msal/errors";
 export { serializeAuthenticationRecord, deserializeAuthenticationRecord } from "./msal/utils";
 export { TokenCredentialOptions } from "./client/identityClient";
 export { InteractiveCredentialOptions } from "./credentials/interactiveCredentialOptions";
@@ -49,8 +49,8 @@ export {
   AggregateAuthenticationError,
   AuthenticationErrorName,
   AggregateAuthenticationErrorName,
-  CredentialUnavailable,
-  CredentialUnavailableName
+  CredentialUnavailableError,
+  CredentialUnavailableErrorName
 } from "./client/errors";
 
 export { TokenCredential, GetTokenOptions, AccessToken } from "@azure/core-http";