update

Author: zhiyuanliang-ms

src/AzureAppConfigurationImpl.ts

@@ -34,7 +34,7 @@ import { FeatureFlagTracingOptions } from "./requestTracing/FeatureFlagTracingOp
 import { KeyFilter, LabelFilter, SettingSelector } from "./types.js";
 import { ConfigurationClientManager } from "./ConfigurationClientManager.js";
 import { getFixedBackoffDuration, calculateBackoffDuration } from "./failover.js";
-import { OperationError, ArgumentError, isFailoverableError, isRetriableError, isInstantlyThrowError } from "./error.js";
+import { InvalidOperationError, ArgumentError, isFailoverableError, isRetriableError, isArgumentError } from "./error.js";
 
 const MIN_DELAY_FOR_UNHANDLED_FAILURE = 5_000; // 5 seconds
 
@@ -247,7 +247,7 @@ export class AzureAppConfigurationImpl implements AzureAppConfiguration {
                 })
             ]);
         } catch (error) {
-            if (!isInstantlyThrowError(error)) {
+            if (!isArgumentError(error)) {
                 const timeElapsed = Date.now() - startTimestamp;
                 if (timeElapsed < MIN_DELAY_FOR_UNHANDLED_FAILURE) {
                     // load() method is called in the application's startup code path.
@@ -282,22 +282,22 @@ export class AzureAppConfigurationImpl implements AzureAppConfiguration {
                 const segment = segments[i];
                 // undefined or empty string
                 if (!segment) {
-                    throw new OperationError(`Failed to construct configuration object: Invalid key: ${key}`);
+                    throw new InvalidOperationError(`Failed to construct configuration object: Invalid key: ${key}`);
                 }
                 // create path if not exist
                 if (current[segment] === undefined) {
                     current[segment] = {};
                 }
                 // The path has been occupied by a non-object value, causing ambiguity.
                 if (typeof current[segment] !== "object") {
-                    throw new OperationError(`Ambiguity occurs when constructing configuration object from key '${key}', value '${value}'. The path '${segments.slice(0, i + 1).join(separator)}' has been occupied.`);
+                    throw new InvalidOperationError(`Ambiguity occurs when constructing configuration object from key '${key}', value '${value}'. The path '${segments.slice(0, i + 1).join(separator)}' has been occupied.`);
                 }
                 current = current[segment];
             }
 
             const lastSegment = segments[segments.length - 1];
             if (current[lastSegment] !== undefined) {
-                throw new OperationError(`Ambiguity occurs when constructing configuration object from key '${key}', value '${value}'. The key should not be part of another key.`);
+                throw new InvalidOperationError(`Ambiguity occurs when constructing configuration object from key '${key}', value '${value}'. The key should not be part of another key.`);
             }
             // set value to the last segment
             current[lastSegment] = value;
@@ -310,7 +310,7 @@ export class AzureAppConfigurationImpl implements AzureAppConfiguration {
      */
     async refresh(): Promise<void> {
         if (!this.#refreshEnabled && !this.#featureFlagRefreshEnabled) {
-            throw new OperationError("Refresh is not enabled for key-values or feature flags.");
+            throw new InvalidOperationError("Refresh is not enabled for key-values or feature flags.");
         }
 
         if (this.#refreshInProgress) {
@@ -329,7 +329,7 @@ export class AzureAppConfigurationImpl implements AzureAppConfiguration {
      */
     onRefresh(listener: () => any, thisArg?: any): Disposable {
         if (!this.#refreshEnabled && !this.#featureFlagRefreshEnabled) {
-            throw new OperationError("Refresh is not enabled for key-values or feature flags.");
+            throw new InvalidOperationError("Refresh is not enabled for key-values or feature flags.");
         }
 
         const boundedListener = listener.bind(thisArg);

src/ConfigurationClientManager.ts

@@ -7,7 +7,7 @@ import { TokenCredential } from "@azure/identity";
 import { AzureAppConfigurationOptions } from "./AzureAppConfigurationOptions.js";
 import { isBrowser, isWebWorker } from "./requestTracing/utils.js";
 import * as RequestTracing from "./requestTracing/constants.js";
-import { instanceOfTokenCredential, shuffleList, getEndpointUrl } from "./common/utils.js";
+import { instanceOfTokenCredential, shuffleList } from "./common/utils.js";
 import { ArgumentError } from "./error.js";
 
 // Configuration client retry options
@@ -61,7 +61,7 @@ export class ConfigurationClientManager {
             const regexMatch = connectionString.match(ConnectionStringRegex);
             if (regexMatch) {
                 const endpointFromConnectionStr = regexMatch[1];
-                this.endpoint = getEndpointUrl(endpointFromConnectionStr);
+                this.endpoint = new URL(endpointFromConnectionStr);
                 this.#id = regexMatch[2];
                 this.#secret = regexMatch[3];
             } else {
@@ -72,7 +72,7 @@ export class ConfigurationClientManager {
             let endpoint = connectionStringOrEndpoint;
             // ensure string is a valid URL.
             if (typeof endpoint === "string") {
-                endpoint = getEndpointUrl(endpoint);
+                endpoint = new URL(endpoint);
             }
 
             const credential = credentialOrOptions as TokenCredential;

src/common/utils.ts

@@ -9,18 +9,6 @@ export function shuffleList<T>(array: T[]): T[] {
     return array;
 }
 
-export function getEndpointUrl(endpoint: string): URL {
-    try {
-        return new URL(endpoint);
-    } catch (error) {
-        throw new TypeError(`Invalid Endpoint URL: ${endpoint}`);
-    }
-}
-
-export function getUrlHost(url: string): string {
-    return new URL(url).host;
-}
-
 export function instanceOfTokenCredential(obj: unknown) {
     return obj && typeof obj === "object" && "getToken" in obj && typeof obj.getToken === "function";
 }

src/error.ts

@@ -6,10 +6,10 @@ import { isRestError } from "@azure/core-rest-pipeline";
 /**
  * Error thrown when an operation cannot be performed by the Azure App Configuration provider.
  */
-export class OperationError extends Error {
+export class InvalidOperationError extends Error {
     constructor(message: string) {
         super(message);
-        this.name = "OperationError";
+        this.name = "InvalidOperationError";
     }
 }
 
@@ -38,7 +38,7 @@ export function isFailoverableError(error: any): boolean {
         return false;
     }
     // ENOTFOUND: DNS lookup failed, ENOENT: no such file or directory
-    if (error.code == "ENOTFOUND" || error.code === "ENOENT") {
+    if (error.code === "ENOTFOUND" || error.code === "ENOENT") {
         return true;
     }
     // 401 Unauthorized, 403 Forbidden, 408 Request Timeout, 429 Too Many Requests, 5xx Server Errors
@@ -51,16 +51,14 @@ export function isFailoverableError(error: any): boolean {
 }
 
 export function isRetriableError(error: any): boolean {
-    if (error instanceof ArgumentError ||
-        error instanceof OperationError ||
-        error instanceof TypeError ||
+    if (isArgumentError(error) ||
         error instanceof RangeError) {
         return false;
     }
     return true;
 }
 
-export function isInstantlyThrowError(error: any): boolean {
+export function isArgumentError(error: any): boolean {
     if (error instanceof ArgumentError ||
         error instanceof TypeError ||
         error instanceof RangeError) {

src/failover.ts

@@ -5,7 +5,6 @@ const MIN_BACKOFF_DURATION = 30_000; // 30 seconds in milliseconds
 const MAX_BACKOFF_DURATION = 10 * 60 * 1000; // 10 minutes in milliseconds
 const JITTER_RATIO = 0.25;
 
-// The backoff duration algorithm is consistent with the .NET configuration provider's implementation.
 export function getFixedBackoffDuration(timeElapsed: number): number | undefined {
     if (timeElapsed <= 100_000) { // 100 seconds in milliseconds
         return 5_000; // 5 seconds in milliseconds

src/keyvault/AzureKeyVaultKeyValueAdapter.ts

@@ -4,14 +4,13 @@
 import { ConfigurationSetting, isSecretReference, parseSecretReference } from "@azure/app-configuration";
 import { IKeyValueAdapter } from "../IKeyValueAdapter.js";
 import { KeyVaultOptions } from "./KeyVaultOptions.js";
-import { getUrlHost } from "../common/utils.js";
 import { ArgumentError, KeyVaultReferenceError } from "../error.js";
 import { SecretClient, parseKeyVaultSecretIdentifier } from "@azure/keyvault-secrets";
 
 export class AzureKeyVaultKeyValueAdapter implements IKeyValueAdapter {
     /**
      * Map vault hostname to corresponding secret client.
-    */
+     */
     #secretClients: Map<string, SecretClient>;
     #keyVaultOptions: KeyVaultOptions | undefined;
 
@@ -59,7 +58,8 @@ export class AzureKeyVaultKeyValueAdapter implements IKeyValueAdapter {
         if (this.#secretClients === undefined) {
             this.#secretClients = new Map();
             for (const client of this.#keyVaultOptions?.secretClients ?? []) {
-                this.#secretClients.set(getUrlHost(client.vaultUrl), client);
+                const clientUrl = new URL(client.vaultUrl);
+                this.#secretClients.set(clientUrl.host, client);
             }
         }