[SPARK-57504][CORE] Avoid a potential NullPointerException in IndexShuffleBlockResolver.getChecksums when the checksum file cannot be opened#56564
Open
LuciferYang wants to merge 1 commit into
Conversation
…uffleBlockResolver.getChecksums when the checksum file cannot be opened
### What changes were proposed in this pull request?
`IndexShuffleBlockResolver.getChecksums` opens the checksum file with
`var in: DataInputStream = null` inside a `try` and closes it in
`finally { in.close() }`. The method already catches `IOException`/`EOFException`
to return `null`, so it is meant to degrade gracefully when the file cannot be
read. But the `finally` is not null-safe: if the failure originates in the stream
constructor (before `in` is assigned), it dereferences `null` and throws a
`NullPointerException` that masks the original error.
The two sibling methods in the same file already handle constructor failure
correctly: `checkIndexAndDataFile` constructs the stream in its own `try/catch`,
and `getMergedBlockData` uses `Utils.tryWithResource`. This change makes
`getChecksums` consistent by using `Utils.tryWithResource`, which evaluates the
constructor before its own `try`, so a constructor `IOException` reaches the
existing `catch` and the method returns `null` as intended.
### Why are the changes needed?
`getChecksums` has a latent `NullPointerException`: the non-null-safe
`finally { in.close() }` would mask the real error if opening the checksum file
fails at construction time, which is inconsistent with the rest of the file. No
common code path is known to trigger it today; this is a robustness and
consistency improvement that removes the latent NPE and aligns the method with
its siblings.
### Does this PR introduce _any_ user-facing change?
No.
### How was this patch tested?
Added a unit test in `IndexShuffleBlockResolverSuite` that forces the stream
constructor to fail (a checksum file whose `exists()` returns true but which
cannot be opened) and asserts `getChecksums` returns `null` instead of throwing.
The test fails on the old code (NPE) and passes with the fix.
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
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?
IndexShuffleBlockResolver.getChecksumsopens the checksum file withvar in: DataInputStream = nullinside atryand closes it infinally { in.close() }. The method already catchesIOException/EOFExceptionto returnnull, so it is meant to degrade gracefully when the file cannot be read. But thefinallyis not null-safe: if the failure originates in the stream constructor (beforeinis assigned), it dereferencesnulland throws aNullPointerExceptionthat masks the original error.The two sibling methods in the same file already handle constructor failure correctly:
checkIndexAndDataFileconstructs the stream in its owntry/catch, andgetMergedBlockDatausesUtils.tryWithResource. This change makesgetChecksumsconsistent by usingUtils.tryWithResource, which evaluates the constructor before its owntry, so a constructorIOExceptionreaches the existingcatchand the method returnsnullas intended.Why are the changes needed?
getChecksumshas a latentNullPointerException: the non-null-safefinally { in.close() }would mask the real error if opening the checksum file fails at construction time, which is inconsistent with the rest of the file. No common code path is known to trigger it today; this is a robustness and consistency improvement that removes the latent NPE and aligns the method with its siblings.Does this PR introduce any user-facing change?
No.
How was this patch tested?
Added a unit test in
IndexShuffleBlockResolverSuitethat forces the stream constructor to fail (a checksum file whoseexists()returns true but which cannot be opened) and assertsgetChecksumsreturnsnullinstead of throwing. The test fails on the old code (NPE) and passes with the fix.Was this patch authored or co-authored using generative AI tooling?
Generated-by: Claude Code (Claude Opus 4.8)