update

Author: zhiyuanliang-ms

src/AzureAppConfigurationImpl.ts

@@ -34,8 +34,8 @@ import { FeatureFlagTracingOptions } from "./requestTracing/FeatureFlagTracingOp
 import { AIConfigurationTracingOptions } from "./requestTracing/AIConfigurationTracingOptions.js";
 import { KeyFilter, LabelFilter, SettingSelector } from "./types.js";
 import { ConfigurationClientManager } from "./ConfigurationClientManager.js";
-import { getFixedBackoffDuration, calculateBackoffDuration } from "./backoffDuration.js";
-import { InvalidOperationError, ArgumentError, isFailoverableError, isRetriableError, isArgumentError } from "./error.js";
+import { getFixedBackoffDuration, getExponentialBackoffDuration } from "./common/backoffUtils.js";
+import { InvalidOperationError, ArgumentError, isFailoverableError, isInputError } from "./error.js";
 
 const MIN_DELAY_FOR_UNHANDLED_FAILURE = 5_000; // 5 seconds
 
@@ -251,7 +251,7 @@ export class AzureAppConfigurationImpl implements AzureAppConfiguration {
                 })
             ]);
         } catch (error) {
-            if (!isArgumentError(error)) {
+            if (!isInputError(error)) {
                 const timeElapsed = Date.now() - startTimestamp;
                 if (timeElapsed < MIN_DELAY_FOR_UNHANDLED_FAILURE) {
                     // load() method is called in the application's startup code path.
@@ -365,7 +365,7 @@ export class AzureAppConfigurationImpl implements AzureAppConfiguration {
                     this.#isInitialLoadCompleted = true;
                     break;
                 } catch (error) {
-                    if (!isRetriableError(error)) {
+                    if (isInputError(error)) {
                         throw error;
                     }
                     if (abortSignal.aborted) {
@@ -375,7 +375,7 @@ export class AzureAppConfigurationImpl implements AzureAppConfiguration {
                     let backoffDuration = getFixedBackoffDuration(timeElapsed);
                     if (backoffDuration === undefined) {
                         postAttempts += 1;
-                        backoffDuration = calculateBackoffDuration(postAttempts);
+                        backoffDuration = getExponentialBackoffDuration(postAttempts);
                     }
                     console.warn(`Failed to load. Error message: ${error.message}. Retrying in ${backoffDuration} ms.`);
                     await new Promise(resolve => setTimeout(resolve, backoffDuration));

src/ConfigurationClientWrapper.ts

@@ -2,7 +2,7 @@
 // Licensed under the MIT license.
 
 import { AppConfigurationClient } from "@azure/app-configuration";
-import { calculateBackoffDuration } from "./backoffDuration.js";
+import { getExponentialBackoffDuration } from "./common/backoffUtils.js";
 
 export class ConfigurationClientWrapper {
     endpoint: string;
@@ -21,7 +21,7 @@ export class ConfigurationClientWrapper {
             this.backoffEndTime = Date.now();
         } else {
             this.#failedAttempts += 1;
-            this.backoffEndTime = Date.now() + calculateBackoffDuration(this.#failedAttempts);
+            this.backoffEndTime = Date.now() + getExponentialBackoffDuration(this.#failedAttempts);
         }
     }
 }

src/backoffDuration.ts renamed to src/common/backoffUtils.ts

@@ -5,20 +5,20 @@ 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;
 
-export function getFixedBackoffDuration(timeElapsed: number): number | undefined {
-    if (timeElapsed < 100_000) { // 100 seconds in milliseconds
-        return 5_000; // 5 seconds in milliseconds
+export function getFixedBackoffDuration(timeElapsedInMs: number): number | undefined {
+    if (timeElapsedInMs < 100_000) {
+        return 5_000;
     }
-    if (timeElapsed < 200_000) { // 200 seconds in milliseconds
-        return 10_000; // 10 seconds in milliseconds
+    if (timeElapsedInMs < 200_000) {
+        return 10_000;
     }
-    if (timeElapsed < 10 * 60 * 1000) { // 10 minutes in milliseconds
+    if (timeElapsedInMs < 10 * 60 * 1000) {
         return MIN_BACKOFF_DURATION;
     }
     return undefined;
 }
 
-export function calculateBackoffDuration(failedAttempts: number) {
+export function getExponentialBackoffDuration(failedAttempts: number): number {
     if (failedAttempts <= 1) {
         return MIN_BACKOFF_DURATION;
     }

src/error.ts

@@ -14,7 +14,7 @@ export class InvalidOperationError extends Error {
 }
 
 /**
- * Error thrown when an argument or configuration is invalid.
+ * Error thrown when an input argument is invalid.
  */
 export class ArgumentError extends Error {
     constructor(message: string) {
@@ -24,7 +24,7 @@ export class ArgumentError extends Error {
 }
 
 /**
- * Error thrown when it fails to get the secret from the Key Vault.
+ * Error thrown when a Key Vault reference cannot be resolved.
  */
 export class KeyVaultReferenceError extends Error {
     constructor(message: string) {
@@ -50,17 +50,10 @@ export function isFailoverableError(error: any): boolean {
     return false;
 }
 
-export function isRetriableError(error: any): boolean {
-    if (isArgumentError(error)) {
-        return false;
-    }
-    return true;
-}
-
 /**
  * Check if the error is an instance of ArgumentError, TypeError, or RangeError.
  */
-export function isArgumentError(error: any): boolean {
+export function isInputError(error: any): boolean {
     if (error instanceof ArgumentError ||
         error instanceof TypeError ||
         error instanceof RangeError) {

src/keyvault/AzureKeyVaultKeyValueAdapter.ts

@@ -25,7 +25,7 @@ export class AzureKeyVaultKeyValueAdapter implements IKeyValueAdapter {
     async processKeyValue(setting: ConfigurationSetting): Promise<[string, unknown]> {
         // TODO: cache results to save requests.
         if (!this.#keyVaultOptions) {
-            throw new ArgumentError("Failed to process the key vault reference. The keyVaultOptions is not configured.");
+            throw new ArgumentError("Failed to process the Key Vault reference because Key Vault options are not configured.");
         }
 
         const { name: secretName, vaultUrl, sourceId, version } = parseKeyVaultSecretIdentifier(

test/keyvault.test.ts

@@ -40,7 +40,7 @@ describe("key vault reference", function () {
     });
 
     it("require key vault options to resolve reference", async () => {
-        return expect(load(createMockedConnectionString())).eventually.rejectedWith("Failed to process the key vault reference. The keyVaultOptions is not configured.");
+        return expect(load(createMockedConnectionString())).eventually.rejectedWith("Failed to process the Key Vault reference because Key Vault options are not configured.");
     });
 
     it("should resolve key vault reference with credential", async () => {