support startup retry and timeout

Author: zhiyuanliang-ms

src/AzureAppConfigurationImpl.ts

@@ -40,6 +40,7 @@ import { RequestTracingOptions, getConfigurationSettingWithTrace, listConfigurat
 import { FeatureFlagTracingOptions } from "./requestTracing/FeatureFlagTracingOptions.js";
 import { KeyFilter, LabelFilter, SettingSelector } from "./types.js";
 import { ConfigurationClientManager } from "./ConfigurationClientManager.js";
+import { getFixedBackoffDuration, calculateDynamicBackoffDuration } from "./failover.js";
 
 type PagedSettingSelector = SettingSelector & {
     /**
@@ -48,6 +49,9 @@ type PagedSettingSelector = SettingSelector & {
     pageEtags?: string[];
 };
 
+const DEFAULT_STARTUP_TIMEOUT = 100 * 1000; // 100 seconds in milliseconds
+const MAX_STARTUP_TIMEOUT = 30 * 60 * 1000; // 15 minutes in milliseconds
+
 export class AzureAppConfigurationImpl implements AzureAppConfiguration {
     /**
      * Hosting key-value pairs in the configuration store.
@@ -229,13 +233,18 @@ export class AzureAppConfigurationImpl implements AzureAppConfiguration {
      * Loads the configuration store for the first time.
      */
     async load() {
-        await this.#inspectFmPackage();
-        await this.#loadSelectedAndWatchedKeyValues();
-        if (this.#featureFlagEnabled) {
-            await this.#loadFeatureFlags();
+        const startupTimeout = this.#options?.startupOptions?.timeoutInMs ?? DEFAULT_STARTUP_TIMEOUT;
+        let timer;
+        try {
+            await Promise.race([
+                new Promise((_, reject) => timer = setTimeout(() => reject(new Error("Load operation timed out.")), startupTimeout)),
+                this.#initialize()
+            ]);
+        } catch (error) {
+            throw new Error(`Failed to load: ${error.message}`);
+        } finally {
+            clearTimeout(timer);
         }
-        // Mark all settings have loaded at startup.
-        this.#isInitialLoadCompleted = true;
     }
 
     /**
@@ -320,6 +329,37 @@ export class AzureAppConfigurationImpl implements AzureAppConfiguration {
         return new Disposable(remove);
     }
 
+    /**
+     * Initializes the configuration provider.
+     */
+    async #initialize() {
+        if (this.#isInitialLoadCompleted) {
+            await this.#inspectFmPackage();
+            const startTimestamp = Date.now();
+            while (startTimestamp + MAX_STARTUP_TIMEOUT > Date.now()) {
+                try {
+                    await this.#loadSelectedAndWatchedKeyValues();
+                    if (this.#featureFlagEnabled) {
+                        await this.#loadFeatureFlags();
+                    }
+                    // Mark all settings have loaded at startup.
+                    this.#isInitialLoadCompleted = true;
+                    break;
+                } catch (error) {
+                    const timeElapsed = Date.now() - startTimestamp;
+                    let postAttempts = 0;
+                    let backoffDuration = getFixedBackoffDuration(timeElapsed);
+                    if (backoffDuration === undefined) {
+                        postAttempts += 1;
+                        backoffDuration = calculateDynamicBackoffDuration(postAttempts);
+                    }
+                    await new Promise(resolve => setTimeout(resolve, backoffDuration));
+                    console.warn("Failed to load configuration settings at startup. Retrying...");
+                }
+            }
+        }
+    }
+
     /**
      * Inspects the feature management package version.
      */

src/AzureAppConfigurationOptions.ts

@@ -6,9 +6,7 @@ import { KeyVaultOptions } from "./keyvault/KeyVaultOptions.js";
 import { RefreshOptions } from "./RefreshOptions.js";
 import { SettingSelector } from "./types.js";
 import { FeatureFlagOptions } from "./featureManagement/FeatureFlagOptions.js";
-
-export const MaxRetries = 2;
-export const MaxRetryDelayInMs = 60000;
+import { StartupOptions } from "./StartupOptions.js";
 
 export interface AzureAppConfigurationOptions {
     /**
@@ -48,6 +46,11 @@ export interface AzureAppConfigurationOptions {
      */
     featureFlagOptions?: FeatureFlagOptions;
 
+    /**
+     * Specifies options used to configure provider startup.
+     */
+    startupOptions?: StartupOptions;
+
     /**
      * Specifies whether to enable replica discovery or not.
      *

src/ConfigurationClientManager.ts

@@ -4,11 +4,15 @@
 import { AppConfigurationClient, AppConfigurationClientOptions } from "@azure/app-configuration";
 import { ConfigurationClientWrapper } from "./ConfigurationClientWrapper.js";
 import { TokenCredential } from "@azure/identity";
-import { AzureAppConfigurationOptions, MaxRetries, MaxRetryDelayInMs } from "./AzureAppConfigurationOptions.js";
+import { AzureAppConfigurationOptions } from "./AzureAppConfigurationOptions.js";
 import { isBrowser, isWebWorker } from "./requestTracing/utils.js";
 import * as RequestTracing from "./requestTracing/constants.js";
 import { shuffleList } from "./common/utils.js";
 
+// Configuration client retry options
+const CLIENT_MAX_RETRIES = 2;
+const CLIENT_MAX_RETRY_DELAY = 60_000; // 1 minute in milliseconds
+
 const TCP_ORIGIN_KEY_NAME = "_origin._tcp";
 const ALT_KEY_NAME = "_alt";
 const TCP_KEY_NAME = "_tcp";
@@ -17,8 +21,8 @@ const ID_KEY_NAME = "Id";
 const SECRET_KEY_NAME = "Secret";
 const TRUSTED_DOMAIN_LABELS = [".azconfig.", ".appconfig."];
 const FALLBACK_CLIENT_REFRESH_EXPIRE_INTERVAL = 60 * 60 * 1000; // 1 hour in milliseconds
-const MINIMAL_CLIENT_REFRESH_INTERVAL = 30 * 1000; // 30 seconds in milliseconds
-const SRV_QUERY_TIMEOUT = 30 * 1000; // 30 seconds in milliseconds
+const MINIMAL_CLIENT_REFRESH_INTERVAL = 30_000; // 30 seconds in milliseconds
+const SRV_QUERY_TIMEOUT = 30_000; // 30 seconds in milliseconds
 
 export class ConfigurationClientManager {
     #isFailoverable: boolean;
@@ -143,16 +147,16 @@ export class ConfigurationClientManager {
 
     async #discoverFallbackClients(host: string) {
         let result;
-        let timeout;
+        let timer;
         try {
             result = await Promise.race([
-                new Promise((_, reject) => timeout = setTimeout(() => reject(new Error("SRV record query timed out.")), SRV_QUERY_TIMEOUT)),
+                new Promise((_, reject) => timer = setTimeout(() => reject(new Error("SRV record query timed out.")), SRV_QUERY_TIMEOUT)),
                 this.#querySrvTargetHost(host)
             ]);
         } catch (error) {
-            throw new Error(`Failed to build fallback clients, ${error.message}`);
+            throw new Error(`Failed to build fallback clients: ${error.message}`);
         } finally {
-            clearTimeout(timeout);
+            clearTimeout(timer);
         }
 
         const srvTargetHosts = shuffleList(result) as string[];
@@ -269,8 +273,8 @@ function getClientOptions(options?: AzureAppConfigurationOptions): AppConfigurat
 
     // retry options
     const defaultRetryOptions = {
-        maxRetries: MaxRetries,
-        maxRetryDelayInMs: MaxRetryDelayInMs,
+        maxRetries: CLIENT_MAX_RETRIES,
+        maxRetryDelayInMs: CLIENT_MAX_RETRY_DELAY,
     };
     const retryOptions = Object.assign({}, defaultRetryOptions, options?.clientOptions?.retryOptions);
 

src/ConfigurationClientWrapper.ts

@@ -2,11 +2,7 @@
 // Licensed under the MIT license.
 
 import { AppConfigurationClient } from "@azure/app-configuration";
-
-const MaxBackoffDuration = 10 * 60 * 1000; // 10 minutes in milliseconds
-const MinBackoffDuration = 30 * 1000; // 30 seconds in milliseconds
-const MAX_SAFE_EXPONENTIAL = 30; // Used to avoid overflow. bitwise operations in JavaScript are limited to 32 bits. It overflows at 2^31 - 1.
-const JITTER_RATIO = 0.25;
+import { calculateDynamicBackoffDuration } from "./failover.js";
 
 export class ConfigurationClientWrapper {
     endpoint: string;
@@ -25,25 +21,7 @@ export class ConfigurationClientWrapper {
             this.backoffEndTime = Date.now();
         } else {
             this.#failedAttempts += 1;
-            this.backoffEndTime = Date.now() + calculateBackoffDuration(this.#failedAttempts);
+            this.backoffEndTime = Date.now() + calculateDynamicBackoffDuration(this.#failedAttempts);
         }
     }
 }
-
-export function calculateBackoffDuration(failedAttempts: number) {
-    if (failedAttempts <= 1) {
-        return MinBackoffDuration;
-    }
-
-    // exponential: minBackoff * 2 ^ (failedAttempts - 1)
-    const exponential = Math.min(failedAttempts - 1, MAX_SAFE_EXPONENTIAL);
-    let calculatedBackoffDuration = MinBackoffDuration * (1 << exponential);
-    if (calculatedBackoffDuration > MaxBackoffDuration) {
-        calculatedBackoffDuration = MaxBackoffDuration;
-    }
-
-    // jitter: random value between [-1, 1) * jitterRatio * calculatedBackoffMs
-    const jitter = JITTER_RATIO * (Math.random() * 2 - 1);
-
-    return calculatedBackoffDuration * (1 + jitter);
-}

src/StartupOptions.ts

@@ -0,0 +1,12 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+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.
+     */
+    timeoutInMs?: number;
+}

src/common/utils.ts

@@ -24,9 +24,9 @@ export function jsonSorter(key, value) {
 }
 
 export function shuffleList<T>(array: T[]): T[] {
-  for (let i = array.length - 1; i > 0; i--) {
-    const j = Math.floor(Math.random() * (i + 1));
-    [array[i], array[j]] = [array[j], array[i]];
-  }
-  return array;
+    for (let i = array.length - 1; i > 0; i--) {
+        const j = Math.floor(Math.random() * (i + 1));
+        [array[i], array[j]] = [array[j], array[i]];
+    }
+    return array;
 }

src/failover.ts

@@ -0,0 +1,39 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+const MIN_BACKOFF_DURATION = 30_000; // 30 seconds in milliseconds
+const MAX_BACKOFF_DURATION = 10 * 60 * 1000; // 10 minutes in milliseconds
+const MAX_SAFE_EXPONENTIAL = 30; // Used to avoid overflow. bitwise operations in JavaScript are limited to 32 bits. It overflows at 2^31 - 1.
+const JITTER_RATIO = 0.25;
+
+// Reference: https://github.com/Azure/AppConfiguration-DotnetProvider/blob/main/src/Microsoft.Extensions.Configuration.AzureAppConfiguration/Extensions/TimeSpanExtensions.cs#L14
+export function getFixedBackoffDuration(timeElapsed: number): number | undefined {
+    if (timeElapsed <= 100_000) { // 100 seconds in milliseconds
+        return 5_000; // 5 seconds in milliseconds
+    }
+    if (timeElapsed <= 200_000) { // 200 seconds in milliseconds
+        return 10_000; // 10 seconds in milliseconds
+    }
+    if (timeElapsed <= 10 * 60 * 1000) { // 10 minutes in milliseconds
+        return MIN_BACKOFF_DURATION;
+    }
+    return undefined;
+}
+
+export function calculateDynamicBackoffDuration(failedAttempts: number) {
+    if (failedAttempts <= 1) {
+        return MIN_BACKOFF_DURATION;
+    }
+
+    // exponential: minBackoff * 2 ^ (failedAttempts - 1)
+    const exponential = Math.min(failedAttempts - 1, MAX_SAFE_EXPONENTIAL);
+    let calculatedBackoffDuration = MIN_BACKOFF_DURATION * (1 << exponential);
+    if (calculatedBackoffDuration > MAX_BACKOFF_DURATION) {
+        calculatedBackoffDuration = MAX_BACKOFF_DURATION;
+    }
+
+    // jitter: random value between [-1, 1) * jitterRatio * calculatedBackoffMs
+    const jitter = JITTER_RATIO * (Math.random() * 2 - 1);
+
+    return calculatedBackoffDuration * (1 + jitter);
+}

src/load.ts

@@ -7,7 +7,7 @@ import { AzureAppConfigurationImpl } from "./AzureAppConfigurationImpl.js";
 import { AzureAppConfigurationOptions } from "./AzureAppConfigurationOptions.js";
 import { ConfigurationClientManager, instanceOfTokenCredential } from "./ConfigurationClientManager.js";
 
-const MIN_DELAY_FOR_UNHANDLED_ERROR: number = 5000; // 5 seconds
+const MIN_DELAY_FOR_UNHANDLED_ERROR: number = 5_000; // 5 seconds
 
 /**
  * Loads the data from Azure App Configuration service and returns an instance of AzureAppConfiguration.