Skip to content

Update feature flag equality check #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Mar 11, 2025
Merged

Update feature flag equality check #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
38aff52
Update feature flag equality check
Mar 3, 2025
cc9d523
code improvements
Mar 3, 2025
901572a
fix linting issue
Mar 3, 2025
751e1d8
Add tests
Mar 3, 2025
f6b6a41
address comments
Mar 6, 2025
58b4c1f
resolve conflicts
Mar 10, 2025
fa4ebb5
avoid defining function
Mar 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 30 additions & 13 deletions libraries/azure-app-configuration-importer/src/internal/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import { SourceOptions } from "../importOptions";
import { ConfigurationFormat, ConfigurationProfile } from "../enums";
import { ArgumentError, ArgumentNullError } from "../errors";
import { Constants } from "../internal/constants";
import { MsFeatureFlagValue } from "../featureFlag";
import { MsFeatureFlagValue, Variant } from "../featureFlag";

/** @internal*/
export function isJsonContentType(contentType?: string): boolean {
Expand Down Expand Up @@ -125,17 +125,17 @@ export function validateOptions(options: SourceOptions): void {
}
}

function isFeatureFlagValueEqual(valueA: string | FeatureFlagValue, valueB: string): boolean {
let featureFlagAValue: FeatureFlagValue;
function isFeatureFlagValueEqual(valueA: string | MsFeatureFlagValue, valueB: string): boolean {
let featureFlagAValue: MsFeatureFlagValue;

if (typeof valueA == "string") {
featureFlagAValue = toFeatureFlagValue(valueA);
featureFlagAValue = toMsFeatureFlagValue(valueA);
}
else {
featureFlagAValue = valueA;
featureFlagAValue = valueA as MsFeatureFlagValue;
}

const featureFlagBValue: FeatureFlagValue = toFeatureFlagValue(valueB);
const featureFlagBValue: MsFeatureFlagValue = toMsFeatureFlagValue(valueB);

if (Object.keys(featureFlagAValue).length !== Object.keys(featureFlagBValue).length) {
return false;
Expand All @@ -144,31 +144,48 @@ function isFeatureFlagValueEqual(valueA: string | FeatureFlagValue, valueB: stri
return featureFlagAValue.id == featureFlagBValue.id &&
featureFlagAValue.enabled == featureFlagBValue.enabled &&
featureFlagAValue.description == featureFlagBValue.description &&
areFeatureFlagFiltersEqual(featureFlagAValue.conditions.clientFilters, featureFlagBValue.conditions.clientFilters);
areArrayEqual<FeatureFlagClientFilters>(featureFlagAValue.conditions.clientFilters, featureFlagBValue.conditions.clientFilters) &&
isEqual(featureFlagAValue.allocation, featureFlagBValue.allocation) &&
areArrayEqual<Variant>(featureFlagAValue.variants ?? [], featureFlagBValue.variants ?? []) &&
isEqual(featureFlagAValue.telemetry, featureFlagBValue.telemetry);
}

function areFeatureFlagFiltersEqual(filterA: FeatureFlagClientFilters[], filterB: FeatureFlagClientFilters[]): boolean {
if (filterA.length !== filterB.length) {
function areArrayEqual<T>(arrayA: T[], arrayB: T[]): boolean {
if (arrayA.length !== arrayB.length) {
return false;
}

for (let i = 0; i < filterA.length; i++) {
if (!isEqual(filterA[i], filterB[i])) {
for (let i = 0; i < arrayA.length; i++) {
if (!isEqual(arrayA[i], arrayB[i])) {
return false;
}
}
return true;
}

function toFeatureFlagValue(value: string): FeatureFlagValue {
function toMsFeatureFlagValue(value: string): MsFeatureFlagValue {
const parsedJson: any = JSON.parse(value);

return {
const msFeatureFlagValue: MsFeatureFlagValue = {
id: parsedJson.id,
enabled: parsedJson.enabled,
description:parsedJson.description,
conditions: isEmpty(parsedJson.conditions) ? {clientFilters: []} : {clientFilters: parsedJson.conditions.client_filters}
};

if (parsedJson.allocation) {
msFeatureFlagValue.allocation = parsedJson.allocation;
}

if (parsedJson.variants) {
msFeatureFlagValue.variants = parsedJson.variants;
}

if (parsedJson.telemetry) {
msFeatureFlagValue.telemetry = parsedJson.telemetry;
}

return msFeatureFlagValue;
}

export function serializeFeatureFlagValue(featureFlagValue: MsFeatureFlagValue): string {
Expand Down
166 changes: 166 additions & 0 deletions libraries/azure-app-configuration-importer/tests/util.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
import { assert } from "chai";
import { areTagsEqual, isJsonContentType, isConfigSettingEqual } from "../src/internal/utils";
import { ConfigurationSetting, FeatureFlagValue, SetConfigurationSettingParam } from "@azure/app-configuration";
import { MsFeatureFlagValue } from "../src/featureFlag";

describe("Test the utility methods", () => {
it("Determine the content type is json contentType", async () => {
Expand Down Expand Up @@ -244,9 +245,92 @@ describe("Test the utility methods", () => {
isReadOnly: true
};

const testKeyValue7: SetConfigurationSettingParam<MsFeatureFlagValue> = {
key: "FeatureX",
label: "test",
value: {
id: "time001",
enabled: true,
description: "",
conditions: {
clientFilters: []
},
allocation: {
percentile: [
{
variant: "Off",
from: 0,
to: 23
},
{
variant: "On",
from: 23,
to: 100
}
],
group: [
{
variant: "On",
groups: [
"m1"
]
},
{
variant: "Off",
groups: [
"m2",
"m3"
]
}
],
user: [
{
variant: "Off",
users: [
"user1",
"user3"
]
},
{
variant: "On",
users: [
"user2"
]
}
],
seed: "bcngrfgnfgn",
default_when_enabled: "On",
default_when_disabled: "On"
},
variants: [
{
name: "Off",
configuration_value: false
},
{
name: "On",
configuration_value: true
}
]
},
contentType: "application/vnd.microsoft.appconfig.ff+json;charset=utf-8",
tags: {tag1: "tag1"}
};

const testKeyValue8: ConfigurationSetting = {
key: "FeatureX",
label: "test",
value: "{\"id\":\"time001\",\"enabled\":true,\"description\":\"\",\"conditions\":{\"client_filters\":[]},\"allocation\":{\"percentile\":[{\"variant\":\"Off\",\"from\":0,\"to\":23},{\"variant\":\"On\",\"from\":23,\"to\":100}],\"group\":[{\"variant\":\"On\",\"groups\":[\"m1\"]},{\"variant\":\"Off\",\"groups\":[\"m2\",\"m3\"]}],\"user\":[{\"variant\":\"Off\",\"users\":[\"user1\",\"user3\"]},{\"variant\":\"On\",\"users\":[\"user2\"]}],\"seed\":\"bcngrfgnfgn\",\"default_when_enabled\":\"On\",\"default_when_disabled\":\"On\"},\"variants\":[{\"name\":\"Off\",\"configuration_value\":false},{\"name\":\"On\",\"configuration_value\":true}]}",
contentType: "application/vnd.microsoft.appconfig.ff+json;charset=utf-8",
tags: {tag1: "tag1"},
isReadOnly: true
};


assert.isTrue(isConfigSettingEqual(testKeyValue1, testKeyValue2));
assert.isTrue(isConfigSettingEqual(testKeyValue3, testKeyValue4));
assert.isTrue(isConfigSettingEqual(testKeyValue5, testKeyValue6));
assert.isTrue(isConfigSettingEqual(testKeyValue7, testKeyValue8));
});

it("Determine if feature flag values with different values are not equal", async()=> {
Expand Down Expand Up @@ -339,9 +423,91 @@ describe("Test the utility methods", () => {
isReadOnly: true
};

const testKeyValue9: SetConfigurationSettingParam<MsFeatureFlagValue> = {
key: "FeatureX",
label: "test",
value: {
id: "time001",
enabled: true,
description: "",
conditions: {
clientFilters: []
},
allocation: {
percentile: [
{
variant: "Off",
from: 0,
to: 23
},
{
variant: "On",
from: 23,
to: 100
}
],
group: [
{
variant: "On",
groups: [
"m1"
]
},
{
variant: "Off",
groups: [
"m2",
"m3"
]
}
],
user: [
{
variant: "Off",
users: [
"user1",
"user3"
]
},
{
variant: "On",
users: [
"user2"
]
}
],
seed: "bcngrfgnfgn",
default_when_enabled: "On",
default_when_disabled: "On"
},
variants: [
{
name: "Off",
configuration_value: false
},
{
name: "On",
configuration_value: true
}
]
},
contentType: "application/vnd.microsoft.appconfig.ff+json;charset=utf-8",
tags: { tag1: "tag1" }
};

const testKeyValue10: ConfigurationSetting = {
key: "FeatureX",
label: "test",
value: "{\"id\":\"time001\",\"enabled\":true,\"description\":\"\",\"conditions\":{\"client_filters\":[]},\"allocation\":{\"percentile\":[{\"variant\":\"Off\",\"from\":0,\"to\":23},{\"variant\":\"On\",\"from\":23,\"to\":100}],\"group\":[{\"variant\":\"On\",\"groups\":[\"m1\"]},{\"variant\":\"Off\",\"groups\":[\"m2\",\"m3\"]}],\"user\":[{\"variant\":\"Off\",\"users\":[\"user1\",\"user3\"]},{\"variant\":\"On\",\"users\":[\"user2\"]}],\"seed\":\"bcngrfgnfgn\",\"default_when_enabled\":\"On\",\"default_when_disabled\":\"On\"},\"variants\":[{\"name\":\"Off\",\"configuration_value\":false},{\"name\":\"On\",\"configuration_value\":true,\"status_override\":\"None\"}]}",
contentType: "application/vnd.microsoft.appconfig.ff+json;charset=utf-8",
tags: {},
isReadOnly: true
};

assert.isFalse(isConfigSettingEqual(testKeyValue1, testKeyValue2));
assert.isFalse(isConfigSettingEqual(testKeyValue3, testKeyValue4));
assert.isFalse(isConfigSettingEqual(testKeyValue5, testKeyValue6));
assert.isFalse(isConfigSettingEqual(testKeyValue7, testKeyValue8));
assert.isFalse(isConfigSettingEqual(testKeyValue9, testKeyValue10));
});
});
Loading