update

Author: zhiyuanliang-ms

package.json

@@ -25,7 +25,7 @@
     "dev": "rollup --config --watch",
     "lint": "eslint src/ test/",
     "fix-lint": "eslint src/ test/ --fix",
-    "test": "mocha out/test/failover.test.{js,cjs,mjs} --parallel"
+    "test": "mocha out/test/*.test.{js,cjs,mjs}"
   },
   "repository": {
     "type": "git",

src/AzureAppConfigurationImpl.ts

@@ -7,6 +7,7 @@ import { AzureAppConfiguration, ConfigurationObjectConstructionOptions } from ".
 import { AzureAppConfigurationOptions } from "./AzureAppConfigurationOptions.js";
 import { IKeyValueAdapter } from "./IKeyValueAdapter.js";
 import { JsonKeyValueAdapter } from "./JsonKeyValueAdapter.js";
+import { DEFAULT_STARTUP_TIMEOUT_IN_MS } from "./StartupOptions.js";
 import { DEFAULT_REFRESH_INTERVAL_IN_MS, MIN_REFRESH_INTERVAL_IN_MS } from "./RefreshOptions.js";
 import { Disposable } from "./common/disposable.js";
 import { base64Helper, jsonSorter } from "./common/utils.js";
@@ -41,7 +42,7 @@ import { FeatureFlagTracingOptions } from "./requestTracing/FeatureFlagTracingOp
 import { KeyFilter, LabelFilter, SettingSelector } from "./types.js";
 import { ConfigurationClientManager } from "./ConfigurationClientManager.js";
 import { getFixedBackoffDuration, calculateDynamicBackoffDuration } from "./failover.js";
-import { FailoverError, OperationError, isFailoverableError } from "./error.js";
+import { FailoverError, OperationError, isFailoverableError, isRetriableError } from "./error.js";
 
 type PagedSettingSelector = SettingSelector & {
     /**
@@ -50,8 +51,6 @@ type PagedSettingSelector = SettingSelector & {
     pageEtags?: string[];
 };
 
-const DEFAULT_STARTUP_TIMEOUT = 100 * 1000; // 100 seconds in milliseconds
-
 export class AzureAppConfigurationImpl implements AzureAppConfiguration {
     /**
      * Hosting key-value pairs in the configuration store.
@@ -233,7 +232,7 @@ export class AzureAppConfigurationImpl implements AzureAppConfiguration {
      * Loads the configuration store for the first time.
      */
     async load() {
-        const startupTimeout: number = this.#options?.startupOptions?.timeoutInMs ?? DEFAULT_STARTUP_TIMEOUT;
+        const startupTimeout: number = this.#options?.startupOptions?.timeoutInMs ?? DEFAULT_STARTUP_TIMEOUT_IN_MS;
         const abortController = new AbortController();
         const abortSignal = abortController.signal;
         let timeoutId;
@@ -344,11 +343,11 @@ export class AzureAppConfigurationImpl implements AzureAppConfiguration {
     /**
      * Initializes the configuration provider.
      */
-    async #initializeWithRetryPolicy(abortSignal: AbortSignal) {
+    async #initializeWithRetryPolicy(abortSignal: AbortSignal): Promise<void> {
         if (!this.#isInitialLoadCompleted) {
             await this.#inspectFmPackage();
             const startTimestamp = Date.now();
-            while (!abortSignal.aborted) {
+            do { // at least try to load once
                 try {
                     await this.#loadSelectedAndWatchedKeyValues();
                     if (this.#featureFlagEnabled) {
@@ -358,6 +357,13 @@ export class AzureAppConfigurationImpl implements AzureAppConfiguration {
                     this.#isInitialLoadCompleted = true;
                     break;
                 } catch (error) {
+
+                    if (!isRetriableError(error)) {
+                        throw error;
+                    }
+                    if (abortSignal.aborted) {
+                        return;
+                    }
                     const timeElapsed = Date.now() - startTimestamp;
                     let postAttempts = 0;
                     let backoffDuration = getFixedBackoffDuration(timeElapsed);
@@ -368,7 +374,7 @@ export class AzureAppConfigurationImpl implements AzureAppConfiguration {
                     await new Promise(resolve => setTimeout(resolve, backoffDuration));
                     console.warn("Failed to load configuration settings at startup. Retrying...");
                 }
-            }
+            } while (!abortSignal.aborted);
         }
     }
 

src/StartupOptions.ts

@@ -1,12 +1,14 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 
+export const DEFAULT_STARTUP_TIMEOUT_IN_MS = 100 * 1000; // 100 seconds in milliseconds
+
 export interface StartupOptions {
     /**
      * The amount of time allowed to load data from Azure App Configuration on startup.
      *
      * @remarks
-     * If not specified, the default value is 100 seconds. The maximum allowed value is 1 hour.
+     * If not specified, the default value is 100 seconds. Must be greater than 1 second.
      */
     timeoutInMs?: number;
 }

src/error.ts

@@ -3,13 +3,19 @@
 
 import { isRestError } from "@azure/core-rest-pipeline";
 
+/**
+ * Error thrown when an operation is not allowed to be performed.
+ */
 export class OperationError extends Error {
     constructor(message: string) {
         super(message);
         this.name = "OperationError";
     }
 }
 
+/**
+ * Error thrown when fail to perform failover.
+ */
 export class FailoverError extends Error {
     constructor(message: string) {
         super(message);
@@ -24,9 +30,9 @@ export function isFailoverableError(error: any): boolean {
 }
 
 export function isRetriableError(error: any): boolean {
-    if (error instanceof OperationError || 
+    if (error instanceof OperationError ||
         error instanceof RangeError) {
         return false;
     }
     return true;
-}
+}

src/refresh/RefreshTimer.ts

@@ -5,11 +5,9 @@ export class RefreshTimer {
     #backoffEnd: number; // Timestamp
     #interval: number;
 
-    constructor(
-        interval: number
-    ) {
+    constructor(interval: number) {
         if (interval <= 0) {
-            throw new Error(`Refresh interval must be greater than 0. Given: ${this.#interval}`);
+            throw new RangeError(`Refresh interval must be greater than 0. Given: ${this.#interval}`);
         }
 
         this.#interval = interval;

test/clientOptions.test.ts

@@ -48,6 +48,9 @@ describe("custom client options", function () {
                         policy: countPolicy,
                         position: "perRetry"
                     }]
+                },
+                startupOptions: {
+                    timeoutInMs: 5_000
                 }
             });
         };
@@ -73,6 +76,9 @@ describe("custom client options", function () {
                     retryOptions: {
                         maxRetries
                     }
+                },
+                startupOptions: {
+                    timeoutInMs: 5_000
                 }
             });
         };
@@ -108,6 +114,9 @@ describe("custom client options", function () {
                         policy: countPolicy,
                         position: "perRetry"
                     }]
+                },
+                startupOptions: {
+                    timeoutInMs: 5_000
                 }
             });
         };

test/failover.test.ts

@@ -6,7 +6,7 @@ import * as chaiAsPromised from "chai-as-promised";
 chai.use(chaiAsPromised);
 const expect = chai.expect;
 import { load } from "./exportedApi";
-import { MAX_TIME_OUT, createMockedConnectionString, createMockedFeatureFlag, createMockedKeyValue, mockConfigurationManagerGetClients, restoreMocks, sleepInMs } from "./utils/testHelper";
+import { MAX_TIME_OUT, createMockedConnectionString, createMockedFeatureFlag, createMockedKeyValue, mockConfigurationManagerGetClients, restoreMocks } from "./utils/testHelper";
 import { getValidDomain, isValidEndpoint } from "../src/ConfigurationClientManager";
 
 const mockedKVs = [{

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("Configure keyVaultOptions to resolve Key Vault Reference(s).");
+        return expect(load(createMockedConnectionString())).eventually.rejectedWith("Failed to process the key vault reference. The keyVaultOptions is not configured.");
     });
 
     it("should resolve key vault reference with credential", async () => {
@@ -96,7 +96,7 @@ describe("key vault reference", function () {
                 ]
             }
         });
-        return expect(loadKeyVaultPromise).eventually.rejectedWith("No key vault credential or secret resolver callback configured, and no matching secret client could be found.");
+        return expect(loadKeyVaultPromise).eventually.rejectedWith("Failed to process the key vault reference. No key vault credential or secret resolver callback configured, and no matching secret client could be found.");
     });
 
     it("should fallback to use default credential when corresponding secret client not provided", async () => {