-
Notifications
You must be signed in to change notification settings - Fork 6.2k
8372301: Improve error message for jimage command line tool regarding version mismatch #28456
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
base: master
Are you sure you want to change the base?
Conversation
|
👋 Welcome back david-beaumont! A progress list of the required criteria for merging this PR into |
|
❗ This change is not yet ready to be integrated. |
|
@david-beaumont The following label will be automatically applied to this pull request:
When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing list. If you would like to change these labels, use the /label pull request command. |
| * Specialized {@link IOException} thrown during construction to provide a | ||
| * semantic reason for failure and allow better user-facing error messages. | ||
| */ | ||
| public final static class ImageError extends IOException { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Exception names ending in "Error" are usually fatal to the VM, this seems more like a normal exception.
Generally, we don't add single purpose exceptions, they are little used and just contribute to bloat.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How else do you think it best to reliably detect the semantic difference for the JImageTool while keeping the non-tool usage as it was? This new exception has a vital role for doing that which, if it, or something like it, didn't exist would be done via unsatisfying heuristics on the debug message string.
An alternate version would be to refactor things to have an "open()" method that returns a failure-reason type of some sort.
And the exception based approach would pave the way to properly translated strings for all the failure modes (though the others aren't actionable in as distinct a way).
Adds a semantic reason for failure which can be optionally interrogated by calling code.
Use the 'Reason.BAD_VERSION' value to trigger a different translated error message from the JImageTask.
I would consider moving the error message string into the Reason enum to simplify the code triggering the error and avoid message string duplication, but it's not straightforward due to the need to supply the version numbers.
We can use this approach to provide translated messages for all the distinct failure reasons if needed.
Progress
Issue
Reviewing
Using
gitCheckout this PR locally:
$ git fetch https://git.openjdk.org/jdk.git pull/28456/head:pull/28456$ git checkout pull/28456Update a local copy of the PR:
$ git checkout pull/28456$ git pull https://git.openjdk.org/jdk.git pull/28456/headUsing Skara CLI tools
Checkout this PR locally:
$ git pr checkout 28456View PR using the GUI difftool:
$ git pr show -t 28456Using diff file
Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/28456.diff
Using Webrev
Link to Webrev Comment