App Config - Query Param Ordering

eng/versioning/version_client.txt

@@ -544,6 +544,7 @@ io.clientcore:optional-dependency-tests;1.0.0-beta.1;1.0.0-beta.1
 # In the pom, the version update tag after the version should name the unreleased package and the dependency version:
 # <!-- {x-version-update;unreleased_com.azure:azure-core;dependency} -->
 
+unreleased_com.azure:azure-data-appconfiguration;1.9.0-beta.1
 unreleased_com.azure.v2:azure-core;2.0.0-beta.1
 unreleased_com.azure.v2:azure-identity;2.0.0-beta.1
 unreleased_com.azure.v2:azure-data-appconfiguration;2.0.0-beta.1

sdk/appconfiguration/azure-data-appconfiguration/CHANGELOG.md

@@ -3,6 +3,7 @@
 ## 1.9.0-beta.1 (Unreleased)
 
 ### Features Added
+- Added a pipeline policy to handle query parameters to make sure the keys are always in lower case and in alphabetical order.
 
 ### Breaking Changes
 

sdk/appconfiguration/azure-data-appconfiguration/assets.json

@@ -2,5 +2,5 @@
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "java",
   "TagPrefix": "java/appconfiguration/azure-data-appconfiguration",
-  "Tag": "java/appconfiguration/azure-data-appconfiguration_5e00bac278"
+  "Tag": "java/appconfiguration/azure-data-appconfiguration_90b5086be3"
 }

sdk/appconfiguration/azure-data-appconfiguration/src/main/java/com/azure/data/appconfiguration/ConfigurationClientBuilder.java

@@ -42,6 +42,7 @@
 import com.azure.data.appconfiguration.implementation.AzureAppConfigurationImpl;
 import com.azure.data.appconfiguration.implementation.ConfigurationClientCredentials;
 import com.azure.data.appconfiguration.implementation.ConfigurationCredentialsPolicy;
+import com.azure.data.appconfiguration.implementation.QueryParamPolicy;
 import com.azure.data.appconfiguration.implementation.SyncTokenPolicy;
 import com.azure.data.appconfiguration.models.ConfigurationAudience;
 
@@ -263,6 +264,9 @@ private HttpPipeline createDefaultHttpPipeline(SyncTokenPolicy syncTokenPolicy,
         policies.add(new AddHeadersFromContextPolicy());
         policies.add(ADD_HEADERS_POLICY);
 
+        // Add query parameter reordering policy
+        policies.add(new QueryParamPolicy());
+
         policies.addAll(perCallPolicies);
         HttpPolicyProviders.addBeforeRetryPolicies(policies);
 

sdk/appconfiguration/azure-data-appconfiguration/src/main/java/com/azure/data/appconfiguration/implementation/QueryParamPolicy.java

@@ -0,0 +1,58 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package com.azure.data.appconfiguration.implementation;
+
+import java.net.MalformedURLException;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Map;
+import java.util.TreeMap;
+
+import com.azure.core.http.HttpPipelineCallContext;
+import com.azure.core.http.HttpRequest;
+import com.azure.core.http.policy.HttpPipelineSyncPolicy;
+import com.azure.core.util.CoreUtils;
+import com.azure.core.util.UrlBuilder;
+import com.azure.core.util.logging.ClientLogger;
+
+public final class QueryParamPolicy extends HttpPipelineSyncPolicy {
+    private static final ClientLogger LOGGER = new ClientLogger(QueryParamPolicy.class);
+
+    @Override
+    protected void beforeSendingRequest(HttpPipelineCallContext context) {
+        HttpRequest httpRequest = context.getHttpRequest();
+
+        try {
+            UrlBuilder builder = UrlBuilder.parse(httpRequest.getUrl());
+            String queryString = builder.getQueryString();
+            builder.clearQuery();
+            TreeMap<String, List<String>> orderedQuery = new TreeMap<>(String::compareTo);
+            CoreUtils.parseQueryParameters(queryString).forEachRemaining(kvp -> {
+                String lowercaseKey = kvp.getKey().toLowerCase();
+                orderedQuery.compute(lowercaseKey, (ignored, values) -> {
+                    if (values == null) {
+                        values = new ArrayList<>();
+                    }
+                    values.add(kvp.getValue());
+                    return values;
+                });
+            });
+            for (Map.Entry<String, List<String>> ordered : orderedQuery.entrySet()) {
+                // Sort values for each parameter key to ensure consistent ordering
+                ordered.getValue().sort(String::compareTo);
+                for (String val : ordered.getValue()) {
+                    builder.addQueryParameter(ordered.getKey(), val);
+                }
+            }
+            httpRequest.setUrl(builder.toUrl().toString());
+        } catch (IllegalArgumentException | MalformedURLException e) {
+            // If the constructed URL is invalid when setting it, continue without modification
+            LOGGER.warning(
+                "Failed to set normalized URL due to invalid format. "
+                    + "Request will proceed with original URL. URL: {}, Error: {}",
+                httpRequest.getUrl(), e.getMessage(), e);
+        }
+    }
+
+}