Improve veraPDF Java version error message #14019
Open
+16
−5
Conversation
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
Collaborator
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
The check and message functions were both calling getJavaVersion(), spawning the subprocess twice. This created inefficiency and a TOCTOU risk where the Java environment could change between calls. Now check caches the detected version in context.props.javaVersion, and message reads from the cache. The message function is now synchronous since it only reads from context. The InstallPreReq.message type was updated to allow both sync and async functions for flexibility. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
When installing veraPDF with an unsupported Java version, the error message was generic: "Java is not installed or version is not supported. veraPDF requires Java 8, 11, 17, or 21."
This made it unclear whether Java was missing or just the wrong version.
Root Cause
The prereq check's error message was a static string, so it couldn't report the detected Java version.
Fix
Made
InstallPreReq.messagesupport async functions in addition to static strings. The veraPDF prereq now:kSupportedJavaVersionsResults
Now I got
However, there is still the question of why 25 is not supported, because manually I can install verapdf