[SPARK-47179][SQL] Improve error message from SparkThrowableSuite for better debuggability #45273
Conversation
This file contains 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
amaliujia
reviewed
Feb 27, 2024
| "The error class document is not up to date. Please regenerate it.") | ||
| "The error class document is not up to date. Please regenerate it by running " + | ||
| "`SPARK_GENERATE_GOLDEN_FILES=1 build/sbt \"core/testOnly *SparkThrowableSuite -- -t " + | ||
| "\\\"Error classes match with document\\\"\"`") |
There was a problem hiding this comment.
Can we use a variable of string to replace this hardcoded instruction and put that val at the begging of this class and under the comment of how to re-generate the golden file?
The reason it is better because it is possible that the instruction of how to re-gen is updated but the developer fail to update the instruction in the such messages.
There was a problem hiding this comment.
E.g.
/* Used to regenerate the error class file. Run:
{{{
SPARK_GENERATE_GOLDEN_FILES=1 build/sbt \
"core/testOnly *SparkThrowableSuite -- -t \"Error classes are correctly formatted\""
}}}
To regenerate the error class document. Run:
{{{
SPARK_GENERATE_GOLDEN_FILES=1 build/sbt \
"core/testOnly *SparkThrowableSuite -- -t \"Error classes match with document\""
}}}
*/
val error_message_instrcution = "Please regenerate it by running " +
"`SPARK_GENERATE_GOLDEN_FILES=1 build/sbt \"core/testOnly *SparkThrowableSuite -- -t " +
"\\\"Error classes match with document\\\"\"
The use the val in the error message.
There was a problem hiding this comment.
Sounds good. Will update
There was a problem hiding this comment.
I agree but try to avoid duplicates. Just combine a short comment + a val with a command.
|
The failed test seems like unrelated: |
MaxGekk
approved these changes
Feb 27, 2024
|
+1, LGTM. Merging to master. |
|
Late LGTM thanks! |
|
Thanks all for the review! |
TakawaAkirayo
pushed a commit
to TakawaAkirayo/spark
that referenced
this pull request
Mar 4, 2024
… better debuggability ### What changes were proposed in this pull request? This PR proposes to improve error message from SparkThrowableSuite for better debuggability ### Why are the changes needed? The current error message is not very actionable for developer who need regenerating the error class documentation. ### Does this PR introduce _any_ user-facing change? No API change, but the error message is changed: **Before** ``` The error class document is not up to date. Please regenerate it. ``` **After** ``` he error class document is not up to date. Please regenerate it by running `SPARK_GENERATE_GOLDEN_FILES=1 build/sbt "core/testOnly *SparkThrowableSuite -- -t \"Error classes match with document\""` ``` ### How was this patch tested? The existing CI should pass. ### Was this patch authored or co-authored using generative AI tooling? No. Closes apache#45273 from itholic/improve_error_suite_debuggability. Authored-by: Haejoon Lee <haejoon.lee@databricks.com> Signed-off-by: Max Gekk <max.gekk@gmail.com>
ericm-db
pushed a commit
to ericm-db/spark
that referenced
this pull request
Mar 5, 2024
… better debuggability ### What changes were proposed in this pull request? This PR proposes to improve error message from SparkThrowableSuite for better debuggability ### Why are the changes needed? The current error message is not very actionable for developer who need regenerating the error class documentation. ### Does this PR introduce _any_ user-facing change? No API change, but the error message is changed: **Before** ``` The error class document is not up to date. Please regenerate it. ``` **After** ``` he error class document is not up to date. Please regenerate it by running `SPARK_GENERATE_GOLDEN_FILES=1 build/sbt "core/testOnly *SparkThrowableSuite -- -t \"Error classes match with document\""` ``` ### How was this patch tested? The existing CI should pass. ### Was this patch authored or co-authored using generative AI tooling? No. Closes apache#45273 from itholic/improve_error_suite_debuggability. Authored-by: Haejoon Lee <haejoon.lee@databricks.com> Signed-off-by: Max Gekk <max.gekk@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What changes were proposed in this pull request?
This PR proposes to improve error message from SparkThrowableSuite for better debuggability
Why are the changes needed?
The current error message is not very actionable for developer who need regenerating the error class documentation.
Does this PR introduce any user-facing change?
No API change, but the error message is changed:
Before
After
How was this patch tested?
The existing CI should pass.
Was this patch authored or co-authored using generative AI tooling?
No.