[App Configuration] - Fix feature flag model

sdk/appconfiguration/app-configuration/assets.json

@@ -2,5 +2,5 @@
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "js",
   "TagPrefix": "js/appconfiguration/app-configuration",
-  "Tag": "js/appconfiguration/app-configuration_bdaf29d71a"
+  "Tag": "js/appconfiguration/app-configuration_48f15db7c6"
 }

sdk/appconfiguration/app-configuration/review/app-configuration-node.api.md

@@ -141,11 +141,12 @@ export interface FeatureFlagValue {
             name: string;
             parameters?: Record<string, unknown>;
         }[];
+        requirementType?: "All" | "Any";
     };
     description?: string;
     displayName?: string;
     enabled: boolean;
-    id?: string;
+    id: string;
 }
 
 // @public

sdk/appconfiguration/app-configuration/samples-dev/featureFlag.ts

@@ -36,6 +36,7 @@ export async function main() {
     isReadOnly: false,
     contentType: featureFlagContentType,
     value: {
+      id: featureFlagName,
       enabled: false,
       description: "I'm a description",
       conditions: {

sdk/appconfiguration/app-configuration/samples/v1-beta/javascript/featureFlag.js

@@ -21,6 +21,7 @@ async function main() {
     isReadOnly: false,
     contentType: featureFlagContentType,
     value: {
+      id: "sample-feature-flag",
       enabled: false,
       description: "I'm a description",
       conditions: {
@@ -79,8 +80,8 @@ async function main() {
       `\n...clientFilter - "${clientFilter.name}"...\nparams => ${JSON.stringify(
         clientFilter.parameters,
         null,
-        1
-      )}\n`
+        1,
+      )}\n`,
     );
     switch (clientFilter.name) {
       // Tweak the client filters of the feature flag
@@ -126,8 +127,8 @@ async function main() {
       `\n...clientFilter - "${clientFilter.name}"...\nparams => ${JSON.stringify(
         clientFilter.parameters,
         null,
-        1
-      )}\n`
+        1,
+      )}\n`,
     );
   }
   await cleanupSampleValues([originalFeatureFlag.key], appConfigClient);

sdk/appconfiguration/app-configuration/samples/v1-beta/typescript/src/featureFlag.ts

@@ -24,6 +24,7 @@ export async function main() {
     isReadOnly: false,
     contentType: featureFlagContentType,
     value: {
+      id: "sample-feature-flag",
       enabled: false,
       description: "I'm a description",
       conditions: {
@@ -82,8 +83,8 @@ export async function main() {
       `\n...clientFilter - "${clientFilter.name}"...\nparams => ${JSON.stringify(
         clientFilter.parameters,
         null,
-        1
-      )}\n`
+        1,
+      )}\n`,
     );
     switch (clientFilter.name) {
       // Tweak the client filters of the feature flag
@@ -129,8 +130,8 @@ export async function main() {
       `\n...clientFilter - "${clientFilter.name}"...\nparams => ${JSON.stringify(
         clientFilter.parameters,
         null,
-        1
-      )}\n`
+        1,
+      )}\n`,
     );
   }
   await cleanupSampleValues([originalFeatureFlag.key], appConfigClient);
@@ -172,7 +173,7 @@ function isTargetingClientFilter(clientFilter: any): clientFilter is {
  * typeguard - for timewindow client filter
  */
 export function isTimeWindowClientFilter(
-  clientFilter: any
+  clientFilter: any,
 ): clientFilter is { parameters: { Start: string; End: string } } {
   return (
     clientFilter.name === "Microsoft.TimeWindow" &&

sdk/appconfiguration/app-configuration/samples/v1/javascript/featureFlag.js

@@ -24,6 +24,7 @@ async function main() {
     isReadOnly: false,
     contentType: featureFlagContentType,
     value: {
+      id: featureFlagName,
       enabled: false,
       description: "I'm a description",
       conditions: {

sdk/appconfiguration/app-configuration/samples/v1/typescript/src/featureFlag.ts

@@ -9,13 +9,17 @@ import {
   ConfigurationSetting,
   featureFlagContentType,
   featureFlagPrefix,
-  FeatureFlagValue
+  FeatureFlagValue,
 } from "@azure/app-configuration";
 import { DefaultAzureCredential } from "@azure/identity";
 
 // Use configuration provider and feature management library to consume feature flags
 import { load } from "@azure/app-configuration-provider";
-import { ConfigurationMapFeatureFlagProvider, FeatureManager, ITargetingContext } from "@microsoft/feature-management";
+import {
+  ConfigurationMapFeatureFlagProvider,
+  FeatureManager,
+  ITargetingContext,
+} from "@microsoft/feature-management";
 
 // Load the .env file if it exists
 import * as dotenv from "dotenv";
@@ -30,6 +34,7 @@ export async function main() {
     isReadOnly: false,
     contentType: featureFlagContentType,
     value: {
+      id: featureFlagName,
       enabled: false,
       description: "I'm a description",
       conditions: {
@@ -77,13 +82,14 @@ export async function main() {
       refresh: {
         enabled: true,
         // refreshIntervalInMs: 30_000, // Optional. Default: 30 seconds
-      }
-    }
+      },
+    },
   });
 
   console.log(`Use feature management library to consume feature flags`);
   const featureManager = new FeatureManager(
-    new ConfigurationMapFeatureFlagProvider(appConfigProvider));
+    new ConfigurationMapFeatureFlagProvider(appConfigProvider),
+  );
 
   let isEnabled = await featureManager.isEnabled(featureFlagName);
   console.log(`Is featureFlag enabled? ${isEnabled}`);
@@ -109,7 +115,7 @@ export async function main() {
     // The feature flag will not be enabled for everyone as targeting filter is configured
     isEnabled = await featureManager.isEnabled(featureFlagName);
     console.log(`Is featureFlag enabled? ${isEnabled}`);
-    
+
     isEnabled = await featureManager.isEnabled(featureFlagName, targetingContext);
     console.log(`Is featureFlag enabled for [email protected]? ${isEnabled}`);
   }

sdk/appconfiguration/app-configuration/src/featureFlag.ts

@@ -22,7 +22,7 @@ export interface FeatureFlagValue {
   /**
    * Id for the feature flag.
    */
-  id?: string;
+  id: string;
   /**
    * A Feature filter consistently evaluates the state of a feature flag.
    * Our feature management library supports three types of built-in filters: Targeting, TimeWindow, and Percentage.
@@ -32,6 +32,7 @@ export interface FeatureFlagValue {
    */
   conditions: {
     clientFilters: { name: string; parameters?: Record<string, unknown> }[];
+    requirementType?: "All" | "Any";
   };
   /**
    * Description of the feature.
@@ -76,6 +77,11 @@ export const FeatureFlagHelper = {
       display_name: featureFlag.value.displayName,
     };
 
+    if (featureFlag.value.conditions.requirementType) {
+      jsonFeatureFlagValue.conditions.requirement_type =
+        featureFlag.value.conditions.requirementType;
+    }
+
     const configSetting = {
       ...featureFlag,
       key,
@@ -117,6 +123,10 @@ export function parseFeatureFlag(
     key,
     contentType: featureFlagContentType,
   };
+
+  if (jsonFeatureFlagValue.conditions.requirement_type) {
+    featureflag.value.conditions.requirementType = jsonFeatureFlagValue.conditions.requirement_type;
+  }
   return featureflag;
 }
 

sdk/appconfiguration/app-configuration/src/internal/jsonModels.ts

@@ -7,10 +7,11 @@
 export type JsonFeatureFlagValue = {
   conditions: {
     client_filters: { name: string; parameters?: Record<string, unknown> }[];
+    requirement_type?: "All" | "Any";
   };
   description?: string;
   enabled: boolean;
-  id?: string;
+  id: string;
   display_name?: string;
 };
 

sdk/appconfiguration/app-configuration/test/public/featureFlag.spec.ts

@@ -26,6 +26,7 @@ describe("AppConfigurationClient - FeatureFlag", () => {
       baseSetting = {
         value: {
           conditions: {
+            requirementType: "Any",
             clientFilters: [
               {
                 name: "Microsoft.TimeWindow",
@@ -51,6 +52,7 @@ describe("AppConfigurationClient - FeatureFlag", () => {
               { name: "Microsoft.Percentage", parameters: { Value: 25 } },
             ],
           },
+          id: "name-1",
           enabled: false,
           description: "I'm a description",
           displayName: "for display",
@@ -202,7 +204,7 @@ describe("AppConfigurationClient - FeatureFlag", () => {
           `name-1${Math.floor(Math.random() * 1000)}`,
         )}`,
         isReadOnly: false,
-        value: { conditions: { clientFilters: [] }, enabled: true },
+        value: { conditions: { clientFilters: [] }, id: "name-1", enabled: true },
       };
     });