sort json key

Author: zhiyuanliang-ms

src/AzureAppConfigurationImpl.ts

@@ -9,6 +9,7 @@ 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 { base64Helper, jsonSorter } from "./common/utils";
 import {
     FEATURE_FLAGS_KEY_NAME,
     FEATURE_MANAGEMENT_KEY_NAME,
@@ -690,7 +691,7 @@ export class AzureAppConfigurationImpl implements AzureAppConfiguration {
 
                     const variantConfiguration: string[] = [];
                     for (const variant of sortedVariantsList) {
-                        const configurationValue = JSON.stringify(variant[CONFIGURATION_VALUE_KEY_NAME], null, 0) ?? "";
+                        const configurationValue = JSON.stringify(variant[CONFIGURATION_VALUE_KEY_NAME], jsonSorter) ?? "";
                         variantConfiguration.push(`${base64Helper(variant[NAME_KEY_NAME])},${configurationValue}`);
                     }
                     rawAllocationId += variantConfiguration.join(";");
@@ -750,15 +751,6 @@ export class AzureAppConfigurationImpl implements AzureAppConfiguration {
     }
 }
 
-function base64Helper(str: string): string {
-    const bytes = new TextEncoder().encode(str); // UTF-8 encoding
-    let chars = "";
-    for (let i = 0; i < bytes.length; i++) {
-        chars += String.fromCharCode(bytes[i]);
-    }
-    return btoa(chars);
-}
-
 function getValidSelectors(selectors: SettingSelector[]): SettingSelector[] {
     // below code deduplicates selectors by keyFilter and labelFilter, the latter selector wins
     const uniqueSelectors: SettingSelector[] = [];

src/common/utils.ts

@@ -0,0 +1,24 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+export function base64Helper(str: string): string {
+    const bytes = new TextEncoder().encode(str); // UTF-8 encoding
+    let chars = "";
+    for (let i = 0; i < bytes.length; i++) {
+        chars += String.fromCharCode(bytes[i]);
+    }
+    return btoa(chars);
+}
+
+export function jsonSorter(key, value) {
+    if (value === null) {
+        return null;
+    }
+    if (Array.isArray(value)) {
+        return value;
+    }
+    if (typeof value === "object") {
+        return Object.fromEntries(Object.entries(value).sort());
+    }
+    return value;
+}

test/featureFlag.test.ts

@@ -111,6 +111,34 @@ const mockedKVs = [{
             seed: "123"
         }
     }),
+    createMockedFeatureFlag("TelemetryVariantPercentile", {
+        enabled: true,
+        telemetry: { enabled: true },
+        variants: [
+            {
+                name: "True_Override",
+                configuration_value: {
+                    someOtherKey: {
+                        someSubKey: "someSubValue"
+                    },
+                    someKey4: [3, 1, 4,  true],
+                    someKey: "someValue",
+                    someKey3: 3.14,
+                    someKey2: 3                                    
+                }
+            }
+        ],
+        allocation: {
+            default_when_enabled: "True_Override",
+            percentile: [
+                {
+                    variant: "True_Override",
+                    from: 0,
+                    to: 100
+                }
+            ]
+        }
+    })
 ]);
 
 describe("feature flags", function () {
@@ -305,6 +333,10 @@ describe("feature flags", function () {
 
         const ComplexConfigurationValue = (featureFlags as any[]).find(item => item.id === "ComplexConfigurationValue");
         expect(ComplexConfigurationValue).not.undefined;
-        expect(ComplexConfigurationValue?.telemetry.metadata.AllocationId).equals("72A0b4sZ5HSAtaQxFe73");
+        expect(ComplexConfigurationValue?.telemetry.metadata.AllocationId).equals("4Bes0AlwuO8kYX-YkBWs");
+
+        const TelemetryVariantPercentile = (featureFlags as any[]).find(item => item.id === "TelemetryVariantPercentile");
+        expect(TelemetryVariantPercentile).not.undefined;
+        expect(TelemetryVariantPercentile?.telemetry.metadata.AllocationId).equals("YsdJ4pQpmhYa8KEhRLUn");
     });
 });