WIP

Author: zhiyuanliang-ms

src/AzureAppConfigurationImpl.ts

@@ -9,11 +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, CONDITIONS_KEY_NAME, CLIENT_FILTERS_KEY_NAME } from "./featureManagement/constants";
+import { FEATURE_FLAGS_KEY_NAME, FEATURE_MANAGEMENT_KEY_NAME, CONDITIONS_KEY_NAME, CLIENT_FILTERS_KEY_NAME, NAME_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 { FeatureFlagTracingOptions } from "./requestTracing/FeatureFlagTracingOptions";
 import { KeyFilter, LabelFilter, SettingSelector } from "./types";
 
 type PagedSettingSelector = SettingSelector & {
@@ -39,7 +39,7 @@ export class AzureAppConfigurationImpl implements AzureAppConfiguration {
     #client: AppConfigurationClient;
     #options: AzureAppConfigurationOptions | undefined;
     #isInitialLoadCompleted: boolean = false;
-    #featureFlagTracing: FeatureFlagTracing = new FeatureFlagTracing();
+    #featureFlagTracing: FeatureFlagTracingOptions = new FeatureFlagTracingOptions();
 
     // Refresh
     #refreshInterval: number = DEFAULT_REFRESH_INTERVAL_IN_MS;
@@ -258,6 +258,7 @@ export class AzureAppConfigurationImpl implements AzureAppConfiguration {
     }
 
     async #loadFeatureFlags() {
+        this.#featureFlagTracing.resetFeatureFlagTracing();
         const featureFlagSettings: ConfigurationSetting[] = [];
         for (const selector of this.#featureFlagSelectors) {
             const listOptions: ListConfigurationSettingsOptions = {
@@ -544,7 +545,11 @@ export class AzureAppConfigurationImpl implements AzureAppConfiguration {
         }
         const featureFlag = JSON.parse(rawFlag);
 
-        
+        if (featureFlag[CONDITIONS_KEY_NAME] && featureFlag[CONDITIONS_KEY_NAME][CLIENT_FILTERS_KEY_NAME]) {
+            for (const filter of featureFlag[CONDITIONS_KEY_NAME][CLIENT_FILTERS_KEY_NAME]) {
+                this.#featureFlagTracing.updateFeatureFilterTracing(filter[NAME_KEY_NAME]);
+            }
+        }
 
         return featureFlag;
     }

src/featureManagement/constants.ts

@@ -4,4 +4,8 @@
 export const FEATURE_MANAGEMENT_KEY_NAME = "feature_management";
 export const FEATURE_FLAGS_KEY_NAME = "feature_flags";
 export const CONDITIONS_KEY_NAME = "conditions";
-export const CLIENT_FILTERS_KEY_NAME = "client_filters";
+export const CLIENT_FILTERS_KEY_NAME = "client_filters";
+export const NAME_KEY_NAME = "name";
+
+export const TIME_WINDOW_FILTER_NAMES = ["TimeWindow", "Microsoft.TimeWindow", "TimeWindowFilter", "Microsoft.TimeWindowFilter"];
+export const TARGETING_FILTER_NAMES = ["Targeting", "Microsoft.Targeting", "TargetingFilter", "Microsoft.TargetingFilter"];

src/requestTracing/FeatureFlagTracing.ts renamed to src/requestTracing/FeatureFlagTracingOptions.ts

@@ -1,20 +1,13 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 
-import {
-    CUSTOM_FILTER_KEY,
-    TIME_WINDOW_FILTER_KEY,
-    TARGETING_FILTER_KEY,
-    DELIMITER
-} from "./constants";
+import { TIME_WINDOW_FILTER_NAMES, TARGETING_FILTER_NAMES } from "../featureManagement/constants";
+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"];
-
+export class FeatureFlagTracingOptions {
     /**
      * Built-in feature filter usage.
      */
@@ -29,9 +22,9 @@ export class FeatureFlagTracing {
     }
 
     updateFeatureFilterTracing(filterName: string): void {
-        if (this.#timeWindowFilterNames.some(name => name.toLowerCase() === filterName.toLowerCase())) {
+        if (TIME_WINDOW_FILTER_NAMES.some(name => name === filterName)) {
             this.usesTimeWindowFilter = true;
-        } else if (this.#targetingFilterNames.some(name => name.toLowerCase() === filterName.toLowerCase())) {
+        } else if (TARGETING_FILTER_NAMES.some(name => name === filterName)) {
             this.usesTargetingFilter = true;
         } else {
             this.usesCustomFilter = true;

src/requestTracing/constants.ts

@@ -48,6 +48,7 @@ export enum RequestType {
 export const KEY_VAULT_CONFIGURED_TAG = "UsesKeyVault";
 
 // Feature Flag Usage Tracing
+export const FEATURE_FILTER_TYPE_KEY = "Filter";
 export const CUSTOM_FILTER_KEY = "CSTM";
 export const TIME_WINDOW_FILTER_KEY = "TIME";
 export const TARGETING_FILTER_KEY = "TRGT";

src/requestTracing/utils.ts

@@ -3,14 +3,15 @@
 
 import { AppConfigurationClient, ConfigurationSettingId, GetConfigurationSettingOptions, ListConfigurationSettingsOptions } from "@azure/app-configuration";
 import { AzureAppConfigurationOptions } from "../AzureAppConfigurationOptions";
-import { FeatureFlagTracing } from "./FeatureFlagTracing";
+import { FeatureFlagTracingOptions } from "./FeatureFlagTracingOptions";
 import {
     AZURE_FUNCTION_ENV_VAR,
     AZURE_WEB_APP_ENV_VAR,
     CONTAINER_APP_ENV_VAR,
     DEV_ENV_VAL,
     ENV_AZURE_APP_CONFIGURATION_TRACING_DISABLED,
     ENV_KEY,
+    FEATURE_FILTER_TYPE_KEY,
     HOST_TYPE_KEY,
     HostType,
     KEY_VAULT_CONFIGURED_TAG,
@@ -29,18 +30,18 @@ export function listConfigurationSettingsWithTrace(
         requestTracingEnabled: boolean;
         initialLoadCompleted: boolean;
         appConfigOptions: AzureAppConfigurationOptions | undefined;
-        featureFlagTracingOptions: FeatureFlagTracing | undefined;
+        featureFlagTracingOptions: FeatureFlagTracingOptions | undefined;
     },
     client: AppConfigurationClient,
     listOptions: ListConfigurationSettingsOptions
 ) {
-    const { requestTracingEnabled, initialLoadCompleted, appConfigOptions } = requestTracingOptions;
+    const { requestTracingEnabled, initialLoadCompleted, appConfigOptions, featureFlagTracingOptions } = requestTracingOptions;
 
     const actualListOptions = { ...listOptions };
     if (requestTracingEnabled) {
         actualListOptions.requestOptions = {
             customHeaders: {
-                [CORRELATION_CONTEXT_HEADER_NAME]: createCorrelationContextHeader(appConfigOptions, initialLoadCompleted)
+                [CORRELATION_CONTEXT_HEADER_NAME]: createCorrelationContextHeader(appConfigOptions, featureFlagTracingOptions, initialLoadCompleted)
             }
         };
     }
@@ -53,26 +54,27 @@ export function getConfigurationSettingWithTrace(
         requestTracingEnabled: boolean;
         initialLoadCompleted: boolean;
         appConfigOptions: AzureAppConfigurationOptions | undefined;
+        featureFlagTracingOptions: FeatureFlagTracingOptions | undefined;
     },
     client: AppConfigurationClient,
     configurationSettingId: ConfigurationSettingId,
     getOptions?: GetConfigurationSettingOptions,
 ) {
-    const { requestTracingEnabled, initialLoadCompleted, appConfigOptions } = requestTracingOptions;
+    const { requestTracingEnabled, initialLoadCompleted, appConfigOptions, featureFlagTracingOptions } = requestTracingOptions;
     const actualGetOptions = { ...getOptions };
 
     if (requestTracingEnabled) {
         actualGetOptions.requestOptions = {
             customHeaders: {
-                [CORRELATION_CONTEXT_HEADER_NAME]: createCorrelationContextHeader(appConfigOptions, initialLoadCompleted)
+                [CORRELATION_CONTEXT_HEADER_NAME]: createCorrelationContextHeader(appConfigOptions, featureFlagTracingOptions, initialLoadCompleted)
             }
         };
     }
 
     return client.getConfigurationSetting(configurationSettingId, actualGetOptions);
 }
 
-export function createCorrelationContextHeader(options: AzureAppConfigurationOptions | undefined, isInitialLoadCompleted: boolean): string {
+export function createCorrelationContextHeader(options: AzureAppConfigurationOptions | undefined, featureFlagTracing: FeatureFlagTracingOptions | undefined, isInitialLoadCompleted: boolean): string {
     /*
     RequestType: 'Startup' during application starting up, 'Watch' after startup completed.
     Host: identify with defined envs
@@ -83,6 +85,7 @@ export function createCorrelationContextHeader(options: AzureAppConfigurationOpt
     keyValues.set(REQUEST_TYPE_KEY, isInitialLoadCompleted ? RequestType.WATCH : RequestType.STARTUP);
     keyValues.set(HOST_TYPE_KEY, getHostType());
     keyValues.set(ENV_KEY, isDevEnvironment() ? DEV_ENV_VAL : undefined);
+    keyValues.set(FEATURE_FILTER_TYPE_KEY, featureFlagTracing?.usesAnyFeatureFilter() ? featureFlagTracing.createFeatureFiltersString() : undefined);
 
     const tags: string[] = [];
     if (options?.keyVaultOptions) {