wip

Author: zhiyuanliang-ms

src/AzureAppConfigurationImpl.ts

@@ -9,10 +9,11 @@ import { IKeyValueAdapter } from "./IKeyValueAdapter";
 import { JsonKeyValueAdapter } from "./JsonKeyValueAdapter";
 import { DEFAULT_REFRESH_INTERVAL_IN_MS, MIN_REFRESH_INTERVAL_IN_MS } from "./RefreshOptions";
 import { Disposable } from "./common/disposable";
-import { FEATURE_FLAGS_KEY_NAME, FEATURE_MANAGEMENT_KEY_NAME } from "./featureManagement/constants";
+import { FEATURE_FLAGS_KEY_NAME, FEATURE_MANAGEMENT_KEY_NAME, CONDITIONS_KEY_NAME, CLIENT_FILTERS_KEY_NAME } from "./featureManagement/constants";
 import { AzureKeyVaultKeyValueAdapter } from "./keyvault/AzureKeyVaultKeyValueAdapter";
 import { RefreshTimer } from "./refresh/RefreshTimer";
 import { getConfigurationSettingWithTrace, listConfigurationSettingsWithTrace, requestTracingEnabled } from "./requestTracing/utils";
+import { FeatureFlagTracing } from "./requestTracing/FeatureFlagTracing";
 import { KeyFilter, LabelFilter, SettingSelector } from "./types";
 
 type PagedSettingSelector = SettingSelector & {
@@ -38,6 +39,7 @@ export class AzureAppConfigurationImpl implements AzureAppConfiguration {
     #client: AppConfigurationClient;
     #options: AzureAppConfigurationOptions | undefined;
     #isInitialLoadCompleted: boolean = false;
+    #featureFlagTracing: FeatureFlagTracing = new FeatureFlagTracing();
 
     // Refresh
     #refreshInterval: number = DEFAULT_REFRESH_INTERVAL_IN_MS;
@@ -173,7 +175,8 @@ export class AzureAppConfigurationImpl implements AzureAppConfiguration {
         return {
             requestTracingEnabled: this.#requestTracingEnabled,
             initialLoadCompleted: this.#isInitialLoadCompleted,
-            appConfigOptions: this.#options
+            appConfigOptions: this.#options,
+            featureFlagTracingOptions: this.#featureFlagTracing
         };
     }
 
@@ -255,8 +258,7 @@ export class AzureAppConfigurationImpl implements AzureAppConfiguration {
     }
 
     async #loadFeatureFlags() {
-        // Temporary map to store feature flags, key is the key of the setting, value is the raw value of the setting
-        const featureFlagsMap = new Map<string, any>();
+        const featureFlagSettings: ConfigurationSetting[] = [];
         for (const selector of this.#featureFlagSelectors) {
             const listOptions: ListConfigurationSettingsOptions = {
                 keyFilter: `${featureFlagPrefix}${selector.keyFilter}`,
@@ -273,15 +275,17 @@ export class AzureAppConfigurationImpl implements AzureAppConfiguration {
                 pageEtags.push(page.etag ?? "");
                 for (const setting of page.items) {
                     if (isFeatureFlag(setting)) {
-                        featureFlagsMap.set(setting.key, setting.value);
+                        featureFlagSettings.push(setting);
                     }
                 }
             }
             selector.pageEtags = pageEtags;
         }
 
         // parse feature flags
-        const featureFlags = Array.from(featureFlagsMap.values()).map(rawFlag => JSON.parse(rawFlag));
+        const featureFlags = await Promise.all(
+            featureFlagSettings.map(setting => this.#parseFeatureFlag(setting))
+        );
 
         // feature_management is a reserved key, and feature_flags is an array of feature flags
         this.#configMap.set(FEATURE_MANAGEMENT_KEY_NAME, { [FEATURE_FLAGS_KEY_NAME]: featureFlags });
@@ -532,6 +536,18 @@ export class AzureAppConfigurationImpl implements AzureAppConfiguration {
         }
         return response;
     }
+
+    async #parseFeatureFlag(setting: ConfigurationSetting<string>): Promise<any> {
+        const rawFlag = setting.value;
+        if (rawFlag === undefined) {
+            throw new Error("The value of configuration setting cannot be undefined.");
+        }
+        const featureFlag = JSON.parse(rawFlag);
+
+        
+
+        return featureFlag;
+    }
 }
 
 function getValidSelectors(selectors: SettingSelector[]): SettingSelector[] {

src/featureManagement/constants.ts

@@ -2,4 +2,6 @@
 // Licensed under the MIT license.
 
 export const FEATURE_MANAGEMENT_KEY_NAME = "feature_management";
-export const FEATURE_FLAGS_KEY_NAME = "feature_flags";
+export const FEATURE_FLAGS_KEY_NAME = "feature_flags";
+export const CONDITIONS_KEY_NAME = "conditions";
+export const CLIENT_FILTERS_KEY_NAME = "client_filters";

src/requestTracing/FeatureFlagTracing.ts

@@ -0,0 +1,72 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import {
+    CUSTOM_FILTER_KEY,
+    TIME_WINDOW_FILTER_KEY,
+    TARGETING_FILTER_KEY,
+    DELIMITER
+} from "./constants";
+
+/**
+ * Tracing for tracking feature flag usage.
+ */
+export class FeatureFlagTracing {
+    #timeWindowFilterNames: string[] = ["TimeWindow", "Microsoft.TimeWindow", "TimeWindowFilter", "Microsoft.TimeWindowFilter"];
+    #targetingFilterNames: string[] = ["Targeting", "Microsoft.Targeting", "TargetingFilter", "Microsoft.TargetingFilter"];
+
+    /**
+     * Built-in feature filter usage.
+     */
+    usesCustomFilter: boolean = false;
+    usesTimeWindowFilter: boolean = false;
+    usesTargetingFilter: boolean = false;
+
+    resetFeatureFlagTracing(): void {
+        this.usesCustomFilter = false;
+        this.usesTimeWindowFilter = false;
+        this.usesTargetingFilter = false;
+    }
+
+    updateFeatureFilterTracing(filterName: string): void {
+        if (this.#timeWindowFilterNames.some(name => name.toLowerCase() === filterName.toLowerCase())) {
+            this.usesTimeWindowFilter = true;
+        } else if (this.#targetingFilterNames.some(name => name.toLowerCase() === filterName.toLowerCase())) {
+            this.usesTargetingFilter = true;
+        } else {
+            this.usesCustomFilter = true;
+        }
+    }
+    
+    usesAnyFeatureFilter(): boolean {
+        return this.usesCustomFilter || this.usesTimeWindowFilter || this.usesTargetingFilter;
+    }
+
+    createFeatureFiltersString(): string {
+        if (!this.usesAnyFeatureFilter()) {
+            return "";
+        }
+        
+        let result: string = "";
+        
+        if (this.usesCustomFilter) {
+            result += CUSTOM_FILTER_KEY
+        }
+        
+        if (this.usesTimeWindowFilter) {
+            if (result !== "") {
+                result += DELIMITER;
+            }
+            result += TIME_WINDOW_FILTER_KEY;
+        }
+        
+        if (this.usesTargetingFilter) {
+            if (result !== "") {
+                result += DELIMITER;
+            }
+            result += TARGETING_FILTER_KEY;
+        }
+        
+        return result;
+    }
+}

src/requestTracing/constants.ts

@@ -46,3 +46,10 @@ export enum RequestType {
 
 // Tag names
 export const KEY_VAULT_CONFIGURED_TAG = "UsesKeyVault";
+
+// Feature Flag Usage Tracing
+export const CUSTOM_FILTER_KEY = "CSTM";
+export const TIME_WINDOW_FILTER_KEY = "TIME";
+export const TARGETING_FILTER_KEY = "TRGT";
+
+export const DELIMITER = "+";

src/requestTracing/utils.ts

@@ -3,6 +3,7 @@
 
 import { AppConfigurationClient, ConfigurationSettingId, GetConfigurationSettingOptions, ListConfigurationSettingsOptions } from "@azure/app-configuration";
 import { AzureAppConfigurationOptions } from "../AzureAppConfigurationOptions";
+import { FeatureFlagTracing } from "./FeatureFlagTracing";
 import {
     AZURE_FUNCTION_ENV_VAR,
     AZURE_WEB_APP_ENV_VAR,
@@ -28,6 +29,7 @@ export function listConfigurationSettingsWithTrace(
         requestTracingEnabled: boolean;
         initialLoadCompleted: boolean;
         appConfigOptions: AzureAppConfigurationOptions | undefined;
+        featureFlagTracingOptions: FeatureFlagTracing | undefined;
     },
     client: AppConfigurationClient,
     listOptions: ListConfigurationSettingsOptions