fix: update usages of String.format to explicitly pass Locale.US - #2974
Merged
BenWhitehead merged 1 commit intoMar 5, 2025
Merged
fix: update usages of String.format to explicitly pass Locale.US#2974BenWhitehead merged 1 commit into
BenWhitehead merged 1 commit into
Conversation
Copy link
Copy Markdown
Collaborator
Sorry, something went wrong.
Usage of `Storage#format(String, Object...)` will use the default locale for it's formatting. This can lead to unexpected formatting if a right-to-left language such as Arabic is the default locale. Update all usages to use `String.format(Locale.US, pattern, Object...)` so we ensure things like headers or error messages are formatted according to the US conventions which match `en_US` and ascii byte conventions. Incidentally, things like right-to-left formatting seem to only apply to java11+ not java8. Fixes #2972
ddelgrosso1
approved these changes
Mar 5, 2025
ddelgrosso1
left a comment
Copy link
Copy Markdown
Contributor
There was a problem hiding this comment.
Yowza! This touches a lot of files but looks pretty boilerplate
Sorry, something went wrong.
Copy link
Copy Markdown
Perhaps related to https://openjdk.org/jeps/252 |
Sorry, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Reviewers
1 more reviewer3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Usage of Storage#format(String, Object...) will use the default locale for it's formatting. This can lead to unexpected formatting if a right-to-left language such as Arabic is the default locale.
Update all usages to use String.format(Locale.US, pattern, Object...) so we ensure things like headers or error messages are formatted according to the US conventions which match en_US and ascii byte conventions.
Incidentally, things like right-to-left formatting seem to only apply to java11+ not java8.
Fixes #2972