Skip to content

[SPARK-58536] Fix stale docstring for getDefaultFinalStatus in cluster mode #57736

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.

Sign up for GitHub

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

Open
Lobo2008 wants to merge 2 commits into
base: master
Choose a base branch
from
+4 −4
Open

[SPARK-58536] Fix stale docstring for getDefaultFinalStatus in cluster mode #57736

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
61c1e08
[SPARK-58536] Fix getDefaultFinalStatus to return SUCCEEDED in cluste…
Lobo2008 Aug 4, 2026
d2d054d
[SPARK-58536] Fix stale docstring for getDefaultFinalStatus in cluste…
Lobo2008 Aug 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions resource-managers/yarn/src/main/scala/org/apache/spark/deploy/yarn/ApplicationMaster.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -345,13 +345,13 @@ private[spark] class ApplicationMaster(

/**
* Set the default final application status for client mode to UNDEFINED to handle
* if YARN HA restarts the application so that it properly retries. Set the final
* status to SUCCEEDED in cluster mode to handle if the user calls System.exit
* from the application code.
* if YARN HA restarts the application so that it properly retries. SPARK-38270
* changed the default for cluster mode to FAILED to prevent the shutdown hook from
* reporting SUCCEEDED when the application exits with a non-zero exit code.
*/
final def getDefaultFinalStatus(): FinalApplicationStatus = {
if (isClusterMode) {
FinalApplicationStatus.FAILED
FinalApplicationStatus.SUCCEEDED

@uros-b uros-b Aug 4, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This inverts a FAIL-SAFE default, and the justification rests on a STALE docstring rather than the code's intent. The FAILED default was set deliberately in SPARK-38270; the docstring mentioning SUCCEEDED predates that change and was not updated. The real defect is the comment, not the code. This PR resolves the mismatch in the wrong direction.

@Lobo2008 Lobo2008 Aug 5, 2026

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@uros-b Thanks for the review! You're right — SPARK-38270 intentionally changed this
to FAILED. I've updated the PR to fix the stale docstring instead of the code.

} else {
FinalApplicationStatus.UNDEFINED
}
Expand Down