Support dynamic refresh

Eskibear · Eskibear · commit c8ab1c965b9c · 2023-11-08T13:30:39.000+08:00
diff --git a/.eslintrc b/.eslintrc
@@ -40,5 +40,6 @@
                 "avoidEscape": true
             }
         ],
-    },
+        "@typescript-eslint/no-explicit-any": "off"
+    }
 }
diff --git a/examples/refresh.mjs b/examples/refresh.mjs
@@ -0,0 +1,43 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import * as dotenv from "dotenv";
+import { promisify } from "util";
+dotenv.config();
+const sleepInMs = promisify(setTimeout);
+
+/**
+ * This example retrives all settings with key following pattern "app.settings.*", i.e. starting with "app.settings.".
+ * With the option `trimKeyPrefixes`, it trims the prefix "app.settings." from keys for simplicity.
+ * Value of config "app.settings.message" will be printed.
+ *
+ * Below environment variables are required for this example:
+ * - APPCONFIG_CONNECTION_STRING
+ */
+
+import { load } from "@azure/app-configuration-provider";
+const connectionString = process.env.APPCONFIG_CONNECTION_STRING;
+const settings = await load(connectionString, {
+    selectors: [{
+        keyFilter: "app.settings.*"
+    }],
+    trimKeyPrefixes: ["app.settings."],
+    refreshOptions: {
+        watchedSettings: [{ key: "app.settings.sentinel" }],
+        refreshIntervalInMs: 10 * 1000 // Default value is 30 seconds, shorted for this sample
+    }
+});
+
+console.log("Update the `message` in your App Configuration store using Azure portal or CLI.")
+console.log("First, update the `message` value, and then update the `sentinel` key value.")
+
+while (true) {
+    // Refreshing the configuration setting
+    await settings.refresh();
+
+    // Current value of message
+    console.log(settings.get("message"));
+
+    // Waiting before the next refresh
+    await sleepInMs(5000);
+}
diff --git a/src/AzureAppConfiguration.ts b/src/AzureAppConfiguration.ts
@@ -1,6 +1,19 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 
+import { Disposable } from "./common/disposable";
+
 export type AzureAppConfiguration = {
-    // methods for advanced features, e.g. refresh()
-} & ReadonlyMap<string, unknown>;
+    /**
+     * API to trigger refresh operation.
+     */
+    refresh(): Promise<void>;
+
+    /**
+     * API to register callback listeners, which will be called only when a refresh operation successfully updates key-values.
+     *
+     * @param listener Callback funtion to be registered.
+     * @param thisArg Optional. Value to use as this when executing callback.
+     */
+    onRefresh(listener: () => any, thisArg?: any): Disposable;
+} & ReadonlyMap<string, any>;
diff --git a/src/AzureAppConfigurationImpl.ts b/src/AzureAppConfigurationImpl.ts
@@ -9,8 +9,11 @@ import { JsonKeyValueAdapter } from "./JsonKeyValueAdapter";
 import { KeyFilter } from "./KeyFilter";
 import { LabelFilter } from "./LabelFilter";
 import { AzureKeyVaultKeyValueAdapter } from "./keyvault/AzureKeyVaultKeyValueAdapter";
-import { CorrelationContextHeaderName } from "./requestTracing/constants";
+import { CorrelationContextHeaderName, RequestType } from "./requestTracing/constants";
 import { createCorrelationContextHeader, requestTracingEnabled } from "./requestTracing/utils";
+import { DefaultRefreshIntervalInMs, MinimumRefreshIntervalInMs } from "./RefreshOptions";
+import { LinkedList } from "./common/linkedList";
+import { Disposable } from "./common/disposable";
 
 export class AzureAppConfigurationImpl extends Map<string, unknown> implements AzureAppConfiguration {
     private adapters: IKeyValueAdapter[] = [];
@@ -20,7 +23,10 @@ export class AzureAppConfigurationImpl extends Map<string, unknown> implements A
      */
     private sortedTrimKeyPrefixes: string[] | undefined;
     private readonly requestTracingEnabled: boolean;
-    private correlationContextHeader: string | undefined;
+    // Refresh
+    private refreshIntervalInMs: number;
+    private onRefreshListeners: LinkedList<() => any>;
+    private lastUpdateTimestamp: number;
 
     constructor(
         private client: AppConfigurationClient,
@@ -29,20 +35,32 @@ export class AzureAppConfigurationImpl extends Map<string, unknown> implements A
         super();
         // Enable request tracing if not opt-out
         this.requestTracingEnabled = requestTracingEnabled();
-        if (this.requestTracingEnabled) {
-            this.enableRequestTracing();
-        }
 
         if (options?.trimKeyPrefixes) {
             this.sortedTrimKeyPrefixes = [...options.trimKeyPrefixes].sort((a, b) => b.localeCompare(a));
         }
+
+        if (options?.refreshOptions) {
+            this.onRefreshListeners = new LinkedList();
+            this.refreshIntervalInMs = DefaultRefreshIntervalInMs;
+
+            const refreshIntervalInMs = this.options?.refreshOptions?.refreshIntervalInMs;
+            if (refreshIntervalInMs !== undefined) {
+                if (refreshIntervalInMs < MinimumRefreshIntervalInMs) {
+                    throw new Error(`The refresh interval time cannot be less than ${MinimumRefreshIntervalInMs} milliseconds.`);
+                } else {
+                    this.refreshIntervalInMs = refreshIntervalInMs;
+                }
+            }
+        }
+
         // TODO: should add more adapters to process different type of values
         // feature flag, others
         this.adapters.push(new AzureKeyVaultKeyValueAdapter(options?.keyVaultOptions));
         this.adapters.push(new JsonKeyValueAdapter());
     }
 
-    public async load() {
+    public async load(requestType: RequestType = RequestType.Startup) {
         const keyValues: [key: string, value: unknown][] = [];
 
         // validate selectors
@@ -55,23 +73,66 @@ export class AzureAppConfigurationImpl extends Map<string, unknown> implements A
             };
             if (this.requestTracingEnabled) {
                 listOptions.requestOptions = {
-                    customHeaders: this.customHeaders()
+                    customHeaders: this.customHeaders(requestType)
                 }
             }
 
             const settings = this.client.listConfigurationSettings(listOptions);
 
             for await (const setting of settings) {
                 if (setting.key) {
-                    const [key, value] = await this.processAdapters(setting);
-                    const trimmedKey = this.keyWithPrefixesTrimmed(key);
-                    keyValues.push([trimmedKey, value]);
+                    const keyValuePair = await this.processKeyValues(setting);
+                    keyValues.push(keyValuePair);
                 }
             }
         }
         for (const [k, v] of keyValues) {
             this.set(k, v);
         }
+        this.lastUpdateTimestamp = Date.now();
+    }
+
+    public async refresh(): Promise<void> {
+        // if no refreshOptions set, return
+        if (this.options?.refreshOptions === undefined || this.options.refreshOptions.watchedSettings.length === 0) {
+            return Promise.resolve();
+        }
+        // if still within refresh interval, return
+        const now = Date.now();
+        if (now < this.lastUpdateTimestamp + this.refreshIntervalInMs) {
+            return Promise.resolve();
+        }
+
+        // try refresh if any of watched settings is changed.
+        // TODO: watchedSettings as optional, etag based refresh if not specified.
+        let needRefresh = false;
+        for (const watchedSetting of this.options.refreshOptions.watchedSettings) {
+            const response = await this.client.getConfigurationSetting(watchedSetting);
+            const [key, value] = await this.processKeyValues(response);
+            if (value !== this.get(key)) {
+                needRefresh = true;
+                break;
+            }
+        }
+        if (needRefresh) {
+            await this.load(RequestType.Watch);
+            // run callbacks in async
+            for (const listener of this.onRefreshListeners) {
+                listener();
+            }
+        }
+    }
+
+    public onRefresh(listener: () => any, thisArg?: any): Disposable {
+        const boundedListener = listener.bind(thisArg);
+        const remove = this.onRefreshListeners.push(boundedListener);
+        return new Disposable(remove);
+    }
+
+    private async processKeyValues(setting: ConfigurationSetting<string>): Promise<[string, unknown]> {
+        const [key, value] = await this.processAdapters(setting);
+        const trimmedKey = this.keyWithPrefixesTrimmed(key);
+        return [trimmedKey, value];
     }
 
     private async processAdapters(setting: ConfigurationSetting<string>): Promise<[string, unknown]> {
@@ -94,17 +155,13 @@ export class AzureAppConfigurationImpl extends Map<string, unknown> implements A
         return key;
     }
 
-    private enableRequestTracing() {
-        this.correlationContextHeader = createCorrelationContextHeader(this.options);
-    }
-
-    private customHeaders() {
+    private customHeaders(requestType: RequestType) {
         if (!this.requestTracingEnabled) {
             return undefined;
         }
 
         const headers = {};
-        headers[CorrelationContextHeaderName] = this.correlationContextHeader;
+        headers[CorrelationContextHeaderName] = createCorrelationContextHeader(this.options, requestType);
         return headers;
     }
 }
diff --git a/src/AzureAppConfigurationOptions.ts b/src/AzureAppConfigurationOptions.ts
@@ -3,6 +3,7 @@
 
 import { AppConfigurationClientOptions } from "@azure/app-configuration";
 import { AzureAppConfigurationKeyVaultOptions } from "./keyvault/AzureAppConfigurationKeyVaultOptions";
+import { RefreshOptions } from "./RefreshOptions";
 
 export const MaxRetries = 2;
 export const MaxRetryDelayInMs = 60000;
@@ -31,4 +32,8 @@ export interface AzureAppConfigurationOptions {
     trimKeyPrefixes?: string[];
     clientOptions?: AppConfigurationClientOptions;
     keyVaultOptions?: AzureAppConfigurationKeyVaultOptions;
+    /**
+     * Specifies options for dynamic refresh key-values.
+     */
+    refreshOptions?: RefreshOptions;
 }
diff --git a/src/RefreshOptions.ts b/src/RefreshOptions.ts
@@ -0,0 +1,21 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import { WatchedSetting } from "./WatchedSetting";
+
+export const DefaultRefreshIntervalInMs = 30 * 1000;
+export const MinimumRefreshIntervalInMs = 1 * 1000;
+
+export interface RefreshOptions {
+    /**
+     * Specifies the interval for refresh to really update the values.
+     * Default value is 30 seconds. Must be greater than 1 second.
+     * Any refresh operation triggered will not update the value for a key until after the interval.
+     */
+    refreshIntervalInMs?: number;
+
+    /**
+     * Specifies settings to be watched, to determine whether the provider triggers a refresh.
+     */
+    watchedSettings: WatchedSetting[];
+}
diff --git a/src/WatchedSetting.ts b/src/WatchedSetting.ts
@@ -0,0 +1,7 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+export interface WatchedSetting {
+    key: string;
+    label?: string;
+}
diff --git a/src/common/disposable.ts b/src/common/disposable.ts
@@ -0,0 +1,15 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+export class Disposable {
+    private disposed = false;
+    constructor(private callOnDispose: () => any) { }
+
+    dispose() {
+        if (!this.disposed) {
+            this.callOnDispose();
+        }
+        this.disposed = true;
+    }
+
+}
diff --git a/src/common/linkedList.ts b/src/common/linkedList.ts
diff --git a/src/requestTracing/utils.ts b/src/requestTracing/utils.ts
diff --git a/test/refresh.test.js b/test/refresh.test.js
diff --git a/test/utils/testHelper.js b/test/utils/testHelper.js

Original file line number	Diff line number	Diff line change
`@@ -40,5 +40,6 @@`
`40`	`40`	`"avoidEscape": true`
`41`	`41`	`}`
`42`	`42`	`],`
`43`		`- },`
	`43`	`+ "@typescript-eslint/no-explicit-any": "off"`
	`44`	`+ }`
`44`	`45`	`}`