Skip to content

Fix EC2 DescribeInstances query use locale-dependent formatting #6238

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.

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 6 commits into from
Jul 8, 2025
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
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
6 changes: 6 additions & 0 deletions .changes/next-release/bugfix-AWSQueryProtocol-1398d13.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"type": "bugfix",
"category": "AWS Query Protocol",
"contributor": "",
"description": "Fixed the bug that EC2 DescribeInstances query uses locale-dependent formatting"
}
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
package software.amazon.awssdk.protocols.query.internal.marshall;

import java.util.List;
import java.util.Locale;
import software.amazon.awssdk.annotations.SdkInternalApi;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.traits.ListTrait;
Expand All @@ -31,7 +32,8 @@ public class ListQueryMarshaller implements QueryMarshaller<List<?>> {
listTrait.isFlattened() ?
String.format("%s.%d", path, i + 1) :
String.format("%s.%s.%d", path, listTrait.memberFieldInfo().locationName(), i + 1);
private static final PathResolver EC2_QUERY_PATH_RESOLVER = (path, i, listTrait) -> String.format("%s.%d", path, i + 1);
private static final PathResolver EC2_QUERY_PATH_RESOLVER = (path, i, listTrait) -> String.format(Locale.ROOT, "%s.%d", path
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it be simpler to just do path + "." + (i+1)?

String.format is relatively slow compared to building the string manually, anyway.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the suggestion! will check other path resolvers that uses String.format("%d"). Just did a test and using concatenation also fixes the locale problem.

, i + 1);

private static final EmptyListMarshaller AWS_QUERY_EMPTY_LIST_MARSHALLER =
(context, path) -> context.request().putRawQueryParameter(path, "");
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/

package software.amazon.awssdk.protocols.query;

import static org.junit.Assert.assertEquals;

import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import org.junit.jupiter.api.Test;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.http.SdkHttpFullRequest;
import software.amazon.awssdk.protocols.query.internal.marshall.ListQueryMarshaller;
import software.amazon.awssdk.protocols.query.internal.marshall.QueryMarshaller;
import software.amazon.awssdk.protocols.query.internal.marshall.QueryMarshallerContext;
import software.amazon.awssdk.protocols.query.internal.marshall.QueryMarshallerRegistry;


public class ListQueryMarshallerTest {

@Test
public void localeSetAsNe_ParsedCorrectly() {
Locale defaultLocale = Locale.getDefault();
Locale.setDefault(new Locale("ne"));

ListQueryMarshaller marshaller = ListQueryMarshaller.ec2Query();

QueryMarshallerContext context = createTestContext();
List<String> testList = Arrays.asList("value1", "value2");
SdkField<List<?>> field = createTestField();

marshaller.marshall(context, "TestParam", testList, field);

Map<String, List<String>> params = context.request().rawQueryParameters();

assertEquals(Collections.singletonList("value1"), params.get("TestParam.1"));
assertEquals(Collections.singletonList("value2"), params.get("TestParam.2"));
Locale.setDefault(defaultLocale);
}

private QueryMarshallerContext createTestContext() {

QueryMarshaller<String> stringMarshaller = (context, path, val, field) ->
context.request().putRawQueryParameter(path, val);

QueryMarshallerRegistry registry = QueryMarshallerRegistry.builder()
.marshaller(MarshallingType.STRING, stringMarshaller)
.build();

return QueryMarshallerContext.builder()
.request(SdkHttpFullRequest.builder())
.marshallerRegistry(registry)
.build();
}



private SdkField<List<?>> createTestField() {
SdkField<?> memberField = SdkField.builder(MarshallingType.STRING)
.memberName("item")
.traits(LocationTrait.builder()
.location(MarshallLocation.PAYLOAD)
.locationName("item")
.build())
.build();

ListTrait listTrait = ListTrait.builder()
.memberFieldInfo(memberField)
.memberLocationName("item")
.isFlattened(true)
.build();

return SdkField.builder(MarshallingType.LIST)
.memberName("TestParam")
.traits(LocationTrait.builder()
.location(MarshallLocation.QUERY_PARAM)
.locationName("TestParam")
.build(),listTrait)
.build();
}
}
Loading