JDK-6801704: ChoiceFormat::applyPattern inconsistency for invalid patterns #17856

justin-curtis-lu · 2024-02-14T22:29:07Z

Please review this PR and CSR which defines the behavior for creating ChoiceFormats with incorrect patterns. The wording is added to both the ChoiceFormat constructor and ChoiceFormat::applyPattern method.

While ideally the inconsistent behavior itself could be fixed, this behavior has been long-standing for 20+ years and the benefit of consistent error handling does not outweigh the risk of breaking applications that may be relying on the "expected" incorrect behavior.

Examples of the range of behavior, (all examples violate the pattern syntax defined in the class description)

// no limit -> throws an expected IllegalArgumentException
var a = new ChoiceFormat("#foo");
// no limit or relation in the last subPattern -> discards the incorrect portion, 'baz' and continues
var b = new ChoiceFormat("0#foo|1#bar|baz"); 
b.format(2); // returns 'bar'
// no relation or limit -> discards the incorrect portion, 'foo' and continues
var c = new ChoiceFormat("foo");
c.format(1); // throws AIOOBE

Progress

Change must be properly reviewed (1 review required, with at least 1 Reviewer)
Change must not contain extraneous whitespace
Commit message must refer to an issue
Change requires CSR request JDK-8317756 to be approved

Issues

JDK-6801704: ChoiceFormat::applyPattern inconsistency for invalid patterns (Bug - P5)
JDK-8317756: ChoiceFormat::applyPattern inconsistency for invalid patterns (CSR)

Reviewers

Naoto Sato (@naotoj - Reviewer) ⚠️ Review applies to 8e5bbe05

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk.git pull/17856/head:pull/17856
$ git checkout pull/17856

Update a local copy of the PR:
$ git checkout pull/17856
$ git pull https://git.openjdk.org/jdk.git pull/17856/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 17856

View PR using the GUI difftool:
$ git pr show -t 17856

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/17856.diff

Webrev

Link to Webrev Comment

bridgekeeper · 2024-02-14T22:29:43Z

👋 Welcome back jlu! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

openjdk · 2024-02-14T22:31:22Z

@justin-curtis-lu The following labels will be automatically applied to this pull request:

core-libs
i18n

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing lists. If you would like to change these labels, use the /label pull request command.

mlbridge · 2024-02-14T22:34:13Z

Webrevs

naotoj · 2024-02-16T22:38:11Z

src/java.base/share/classes/java/text/ChoiceFormat.java

@@ -230,6 +230,12 @@ public class ChoiceFormat extends NumberFormat {
     * Patterns} section. Unlike {@link #setChoices(double[], String[])} this
     * method will throw an {@code IllegalArgumentException} if the {@code
     * limits} are not in ascending order.
+     *
+     * @implNote Given an incorrect pattern, this implementation may either
+     * throw an exception or succeed and discard the incorrect


An explanation for the exception may be helpful, either enumerating possible exceptions or simply a RuntimeException.

I think initially since it was an implSpec tag, I didn't want to over-detail the inconsistent behavior as specification. As an implNote tag it seems much better to give further explanation. I added details for the two possible exceptions. Let me know if you think I should go into further detail on when a pattern may be discarded if you think that is necessary.

naotoj · 2024-02-16T22:42:16Z

src/java.base/share/classes/java/text/ChoiceFormat.java

+     * @implNote Given an incorrect pattern, this implementation may either
+     * throw an exception or succeed and discard the incorrect
+     * portion. Discarding the incorrect portion may result in a ChoiceFormat
+     * with empty {@code limits} and {@code choices}.


formats instead of choices? A choice means a limit+format to me.

Yes, should definitely be formats here, thanks.

naotoj

LGTM. Thanks for the changes.

naotoj

LGTM

naotoj · 2024-02-29T23:54:28Z

src/java.base/share/classes/java/text/ChoiceFormat.java

-     * ##patterns Patterns} section.
+     * based on the pattern. The syntax and error related caveats for the
+     * ChoiceFormat pattern can be found in the {@linkplain ##patterns Patterns}
+     * section. Unlike {@link #ChoiceFormat(double[], String[])} this method will


Nit: constructor better suited than method.

openjdk · 2024-03-05T20:54:49Z

@justin-curtis-lu This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

6801704: ChoiceFormat::applyPattern inconsistency for invalid patterns

Reviewed-by: naoto

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been 240 new commits pushed to the master branch:

a7280d1: 8311002: missing @SInCE info in 21 files in jdk.security.auth
721bfee: 8326891: Prefer RPATH over RUNPATH for $ORIGIN rpaths in internal JDK binaries
809995b: 8174269: Remove COMPAT locale data provider from JDK
c6641c7: 8326831: Clarify test harness control variables in make help
3d106cb: 8325139: JFR SwapSpace event - add free swap space information on Linux when running in a container environment
c00c939: 8327364: Parallel: Remove unused ParallelCompactData::add_obj
98f0b86: 8319690: [AArch64] C2 compilation hits offset_ok_for_immed: assert "c2 compiler bug"
2372aba: 8326172: Dubious claim on long[]/double[] alignment in MemorySegment javadoc
c653e67: 8327225: Revert DataInputStream.readUTF to static final
a089ed2: 8326936: RISC-V: Shenandoah GC crashes due to incorrect atomic memory operations
... and 230 more: https://git.openjdk.org/jdk/compare/b823fa44508901a6bf39795ab18991d055a71b4e...master

As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

justin-curtis-lu · 2024-03-05T22:37:28Z

/integrate

openjdk · 2024-03-05T22:37:59Z

Going to push as commit b665fe3.
Since your change was applied there have been 240 commits pushed to the master branch:

a7280d1: 8311002: missing @SInCE info in 21 files in jdk.security.auth
721bfee: 8326891: Prefer RPATH over RUNPATH for $ORIGIN rpaths in internal JDK binaries
809995b: 8174269: Remove COMPAT locale data provider from JDK
c6641c7: 8326831: Clarify test harness control variables in make help
3d106cb: 8325139: JFR SwapSpace event - add free swap space information on Linux when running in a container environment
c00c939: 8327364: Parallel: Remove unused ParallelCompactData::add_obj
98f0b86: 8319690: [AArch64] C2 compilation hits offset_ok_for_immed: assert "c2 compiler bug"
2372aba: 8326172: Dubious claim on long[]/double[] alignment in MemorySegment javadoc
c653e67: 8327225: Revert DataInputStream.readUTF to static final
a089ed2: 8326936: RISC-V: Shenandoah GC crashes due to incorrect atomic memory operations
... and 230 more: https://git.openjdk.org/jdk/compare/b823fa44508901a6bf39795ab18991d055a71b4e...master

Your commit was automatically rebased without conflicts.

openjdk · 2024-03-05T22:38:04Z

@justin-curtis-lu Pushed as commit b665fe3.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.

justin-curtis-lu added 2 commits February 14, 2024 13:08

init

712433c

more conservative wording

af8622c

openjdk bot added csr Pull request needs approved CSR before integration rfr Pull request is ready for review labels Feb 14, 2024

openjdk bot added core-libs core-libs-dev@openjdk.org i18n i18n-dev@openjdk.org labels Feb 14, 2024

justin-curtis-lu mentioned this pull request Feb 15, 2024

JDK-8325898: ChoiceFormat returns erroneous result when formatting bad pattern #17883

Closed

3 tasks

replace spec tag with note

e4b602c

naotoj reviewed Feb 16, 2024

View reviewed changes

implement suggested changes

00f8179

naotoj approved these changes Feb 17, 2024

View reviewed changes

justin-curtis-lu added 3 commits February 22, 2024 10:21

wordsmithing

f1f1dc4

include apiSpec wording, move to patterns section

a20e1d1

include ascending order stipulation in constuctor as well

8e5bbe0

naotoj approved these changes Feb 29, 2024

View reviewed changes

wording: punctuation and use 'constructor'

aa1071e

openjdk bot added ready Pull request is ready to be integrated and removed csr Pull request needs approved CSR before integration labels Mar 5, 2024

openjdk bot added the integrated Pull request has been integrated label Mar 5, 2024

openjdk bot closed this Mar 5, 2024

openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Mar 5, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

JDK-6801704: ChoiceFormat::applyPattern inconsistency for invalid patterns #17856

JDK-6801704: ChoiceFormat::applyPattern inconsistency for invalid patterns #17856

justin-curtis-lu commented Feb 14, 2024 •

edited by openjdk bot

Loading

bridgekeeper bot commented Feb 14, 2024

openjdk bot commented Feb 14, 2024

mlbridge bot commented Feb 14, 2024 •

edited

Loading

naotoj Feb 16, 2024

justin-curtis-lu Feb 16, 2024

naotoj Feb 16, 2024

justin-curtis-lu Feb 16, 2024

naotoj left a comment

naotoj left a comment

naotoj Feb 29, 2024

openjdk bot commented Mar 5, 2024

justin-curtis-lu commented Mar 5, 2024

openjdk bot commented Mar 5, 2024

openjdk bot commented Mar 5, 2024

JDK-6801704: ChoiceFormat::applyPattern inconsistency for invalid patterns #17856

JDK-6801704: ChoiceFormat::applyPattern inconsistency for invalid patterns #17856

Conversation

justin-curtis-lu commented Feb 14, 2024 • edited by openjdk bot Loading

Progress

Issues

Reviewers

Reviewing

Webrev

bridgekeeper bot commented Feb 14, 2024

openjdk bot commented Feb 14, 2024

mlbridge bot commented Feb 14, 2024 • edited Loading

Webrevs

naotoj Feb 16, 2024

Choose a reason for hiding this comment

justin-curtis-lu Feb 16, 2024

Choose a reason for hiding this comment

naotoj Feb 16, 2024

Choose a reason for hiding this comment

justin-curtis-lu Feb 16, 2024

Choose a reason for hiding this comment

naotoj left a comment

Choose a reason for hiding this comment

naotoj left a comment

Choose a reason for hiding this comment

naotoj Feb 29, 2024

Choose a reason for hiding this comment

openjdk bot commented Mar 5, 2024

justin-curtis-lu commented Mar 5, 2024

openjdk bot commented Mar 5, 2024

openjdk bot commented Mar 5, 2024

justin-curtis-lu commented Feb 14, 2024 •

edited by openjdk bot

Loading

mlbridge bot commented Feb 14, 2024 •

edited

Loading