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

Conversation

Fred1155
Copy link
Contributor

@Fred1155 Fred1155 commented Jul 7, 2025

Motivation and Context

User reported the issue #5968. Currently we are render the filters using locale-dependent numerals, UTF-8-encoded. For example, for instance running in the ne (Nepalese) local the query uses Filter.%E0%A5%A7.Name rather than Filter.1.Name, where %E0%A5%A7 is the UTF-8 encoding for U+0967 DEVANAGARI DIGIT ONE which is the rendering for the integer 1 in this locale. The expected behavior is in all locales, we should render the filters using ASCII digits 0 to 9 only.

Modifications

The current ListQueryMarshaller code uses String.format("%s.%d", path, i + 1) which is locale-dependent. When formatting the %d (decimal integer), Java uses the system's default locale to determine how to display numbers.
Locale.ROOT is Java's locale-neutral locale. By adding that to String.format, it will always produce ASCII digits regardless of system locale. This issue only appear for Java version 9 and above.

Testing

Added unit test for ListQueryMarshaller class and also did a local integration test using the self-repro code provided in the original issue.

Screenshots (if appropriate)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)

Checklist

  • I have read the CONTRIBUTING document
  • Local run of mvn install succeeds
  • My code follows the code style of this project
  • My change requires a change to the Javadoc documentation
  • I have updated the Javadoc documentation accordingly
  • I have added tests to cover my changes
  • All new and existing tests passed
  • I have added a changelog entry. Adding a new entry must be accomplished by running the scripts/new-change script and following the instructions. Commit the new file created by the script in .changes/next-release with your changes.
  • My change is to implement 1.11 parity feature and I have updated LaunchChangelog

License

  • I confirm that this pull request can be released under the Apache 2 license

@Fred1155 Fred1155 requested a review from a team as a code owner July 7, 2025 20:03
Copy link
Contributor

@alextwoods alextwoods left a comment

Choose a reason for hiding this comment

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

Overall change looks good - Are there other areas where we are formatting URL components that we should make a similar fix for?

@@ -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.

@Fred1155
Copy link
Contributor Author

Fred1155 commented Jul 7, 2025

Overall change looks good - Are there other areas where we are formatting URL components that we should make a similar fix for?

Good suggestion! I think technically this fix could be applied to all path resolver that uses String.format("%d")?

@Fred1155 Fred1155 requested review from millems and alextwoods July 7, 2025 21:35
Copy link

sonarqubecloud bot commented Jul 8, 2025

@Fred1155 Fred1155 added this pull request to the merge queue Jul 8, 2025
Merged via the queue into master with commit a1a4b44 Jul 8, 2025
35 checks passed
Copy link

github-actions bot commented Jul 8, 2025

This pull request has been closed and the conversation has been locked. Comments on closed PRs are hard for our team to see. If you need more assistance, please open a new issue that references this one.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 8, 2025
@Fred1155 Fred1155 deleted the bole/ec2_locale_format_fix branch July 8, 2025 19:50
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants