eason-yuchen-liu opened a new pull request, #59276:
URL: https://github.com/apache/spark/pull/59276
<!--
Thanks for sending a pull request! Here are some tips for you:
1. If this is your first time, please read our contributor guidelines:
https://spark.apache.org/contributing.html
2. Ensure you have added or run the appropriate tests for your PR:
https://spark.apache.org/developer-tools.html
3. If the PR is unfinished, add '[WIP]' in your PR title, e.g.,
'[WIP][SPARK-XXXX] Your PR title ...'.
4. Be sure to keep the PR description updated to reflect all changes.
5. Please write your PR title to summarize what this PR proposes.
6. If possible, provide a concise example to reproduce the issue for a
faster review.
7. If you want to add a new configuration, please read the guideline first
for naming configurations in
'common/utils/src/main/scala/org/apache/spark/internal/config/ConfigEntry.scala'.
8. If you want to add or modify an error type or message, please read the
guideline first in
'common/utils/src/main/resources/error/README.md'.
-->
### What changes were proposed in this pull request?
<!--
Please clarify what changes you are proposing. The purpose of this section
is to outline the changes and how this PR fixes the issue.
If possible, please consider writing useful notes for better and faster
reviews in your PR. See the examples below.
1. If you refactor some codes with changing classes, showing the class
hierarchy will help reviewers.
2. If you fix some SQL features, you can provide some references of other
DBMSes.
3. If there is design documentation, please add the link.
4. If there is a discussion in the mailing list, please add the link.
-->
When a streaming query fails, the catch block of `StreamExecution.runStream`
builds a `StreamingQueryException` and assigns it to `streamDeathCause`.
Building it evaluates `toDebugString`, which renders the current offsets, the
sources and the logical plan, and converts the start and end offsets with
`StreamProgress.toOffsets`. This PR makes sure `streamDeathCause` is always
assigned:
- If building the detailed exception fails, the query fails with a
`STREAM_FAILED` `StreamingQueryException` that keeps the original cause but has
no debug string or offsets. The build failure is logged as a warning and
attached as a suppressed exception.
- A fatal build failure is still rethrown to the `UncaughtExceptionHandler`,
but only after `streamDeathCause` is assigned. This is the same handling a
fatal query failure already gets.
- `errorClassOpt` is now assigned before the exception is built, so
`QueryTerminatedEvent` keeps the error class even if building the exception
fails fatally.
### Why are the changes needed?
<!--
Please clarify why the changes are needed. For instance,
1. If you propose a new API, clarify the use case for a new API.
2. If you fix a bug, you can clarify why it is a bug.
-->
If anything throws while the exception is being built, the new exception
escapes the catch block before `streamDeathCause` is assigned. The query then
terminates as if it had stopped cleanly:
- `StreamingQuery.exception` is `None`.
- `awaitTermination()` and `StreamingQueryManager.awaitAnyTermination()`
return normally.
- `QueryTerminatedEvent.exception` is null.
Applications and orchestrators that rely on these to detect failures treat
the failed query as one that stopped successfully. The original failure only
shows up in the logs, through the stream thread's uncaught-exception handler.
Examples of what can throw while the exception is built: a source or offset
whose `toString` throws, a plan whose string rendering fails, or a source
missing from the source id map during offset conversion.
### Does this PR introduce _any_ user-facing change?
<!--
Note that it means *any* user-facing change including all aspects such as
new features, bug fixes, or other behavior changes. Documentation-only updates
are not considered user-facing changes.
If yes, please clarify the previous behavior and the change this PR proposes
- provide the console output, description and/or an example to show the
behavior difference if possible.
If possible, please also clarify if this is a user-facing change compared to
the released Spark versions or within the unreleased branches such as master.
If no, write 'No'.
-->
Yes. A streaming query that fails, and whose exception can't be fully built,
now fails with a `StreamingQueryException` (error class `STREAM_FAILED`)
carrying the original cause, instead of terminating without an exception. In
that case the exception message has no query debug string.
### How was this patch tested?
<!--
If tests were added, say they were added here. Please make sure to add some
test cases that check the changes thoroughly including negative and positive
cases if possible.
If it was tested in a way different from regular unit tests, please clarify
how you tested step by step, ideally copy and paste-able, so that other
reviewers can test and check, and descendants can verify in the future.
If tests were not added, please describe why they were not added and/or why
it was difficult to add.
If benchmark tests were added, please run the benchmarks in GitHub Actions
for the consistent environment, and the instructions could accord to:
https://spark.apache.org/developer-tools.html#github-workflow-benchmarks.
-->
New tests in `StreamSuite`. A source's `getBatch` fails, after which its
`toString` throws, so building the query debug string fails. The `toString`
failure is either a non-fatal `IllegalStateException` or a
`StackOverflowError`. The tests check that the query fails with the original
cause and the build failure suppressed, and that only the fatal build failure
reaches the stream thread's `UncaughtExceptionHandler`.
Without the change, both tests fail with `Expected exception
StreamingQueryException to be thrown, but no exception was thrown`; with it,
both pass:
```
build/sbt "sql/testOnly org.apache.spark.sql.streaming.StreamSuite -- -z
\"building the detailed exception fails\""
```
`sql/scalastyle` and `sql/Test/scalastyle` also pass.
### Was this patch authored or co-authored using generative AI tooling?
<!--
If generative AI tooling has been used in the process of authoring this
patch, please include the
phrase: 'Generated-by: ' followed by the name of the tool and its version.
If no, write 'No'.
Please refer to the [ASF Generative Tooling
Guidance](https://www.apache.org/legal/generative-tooling.html) for details.
-->
Generated-by: Isaac (Claude Code, Claude Opus 5.5)
This pull request and its description were written by Isaac.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
