ORC-1942: Fix PhysicalFsWriter not to change ZstdCodec's default option
#2304
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
dongjoon-hyun
commented
Jun 30, 2025
| @Override | ||
| public Options getDefaultOptions() { | ||
| return DEFAULT_OPTIONS; | ||
| return DEFAULT_OPTIONS.copy(); |
Member
Author
There was a problem hiding this comment.
In addition, this PR makes this return a copied one to make it sure.
dongjoon-hyun
changed the title
PhysicalFsWriter to change tempOptions directlyPhysicalFsWriter not to change ZstdCodec's default option
Member
Author
|
cc @cxzl25 |
dongjoon-hyun
added a commit
that referenced
this pull request
Jun 30, 2025
…option ### What changes were proposed in this pull request? This PR aims to fix `PhysicalFsWriter` to change `tempOptions` directly. ### Why are the changes needed? In the following code path, `tempOptions` is supposed to be updated and used. However, `codec.getDefaultOptions() instanceof ZstdCodec.ZstdOptions options` code is currently updating the return value of `codec.getDefaultOptions()` via a variable `options`. https://github.com/apache/orc/blob/d3843bc043bea97bdd81a0f8e1fab3329efc7308/java/core/src/java/org/apache/orc/impl/PhysicalFsWriter.java#L118-L127 Technically, `ZstdCodec.getDefaultOptions()` returns the final static variable. This AS-IS code is trying to change this static object which leads unintended side-effects. We should avoid this code pattern. https://github.com/apache/orc/blob/d3843bc043bea97bdd81a0f8e1fab3329efc7308/java/core/src/java/org/apache/orc/impl/ZstdCodec.java#L150-L156 ### How was this patch tested? Pass the CIs with a newly added test case. ### Was this patch authored or co-authored using generative AI tooling? No. Closes #2304 from dongjoon-hyun/ORC-1942. Authored-by: Dongjoon Hyun <[email protected]> Signed-off-by: Dongjoon Hyun <[email protected]> (cherry picked from commit 3c63bf7) Signed-off-by: Dongjoon Hyun <[email protected]>
dongjoon-hyun
added a commit
that referenced
this pull request
Jun 30, 2025
…option ### What changes were proposed in this pull request? This PR aims to fix `PhysicalFsWriter` to change `tempOptions` directly. ### Why are the changes needed? In the following code path, `tempOptions` is supposed to be updated and used. However, `codec.getDefaultOptions() instanceof ZstdCodec.ZstdOptions options` code is currently updating the return value of `codec.getDefaultOptions()` via a variable `options`. https://github.com/apache/orc/blob/d3843bc043bea97bdd81a0f8e1fab3329efc7308/java/core/src/java/org/apache/orc/impl/PhysicalFsWriter.java#L118-L127 Technically, `ZstdCodec.getDefaultOptions()` returns the final static variable. This AS-IS code is trying to change this static object which leads unintended side-effects. We should avoid this code pattern. https://github.com/apache/orc/blob/d3843bc043bea97bdd81a0f8e1fab3329efc7308/java/core/src/java/org/apache/orc/impl/ZstdCodec.java#L150-L156 ### How was this patch tested? Pass the CIs with a newly added test case. ### Was this patch authored or co-authored using generative AI tooling? No. Closes #2304 from dongjoon-hyun/ORC-1942. Authored-by: Dongjoon Hyun <[email protected]> Signed-off-by: Dongjoon Hyun <[email protected]> (cherry picked from commit 3c63bf7) Signed-off-by: Dongjoon Hyun <[email protected]>
Member
Author
|
Merged to main/2.1/2.0. |
This was referenced Jun 30, 2025
cxzl25
reviewed
Jul 1, 2025
Contributor
cxzl25
left a comment
cxzl25
left a comment
There was a problem hiding this comment.
Late LGTM. Thank you @dongjoon-hyun
Member
Author
|
Thank you for reviewing, @cxzl25 ! |
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.
What changes were proposed in this pull request?
This PR aims to fix
PhysicalFsWriterto changetempOptionsdirectly.Why are the changes needed?
In the following code path,
tempOptionsis supposed to be updated and used. However,codec.getDefaultOptions() instanceof ZstdCodec.ZstdOptions optionscode is currently updating the return value ofcodec.getDefaultOptions()via a variableoptions.orc/java/core/src/java/org/apache/orc/impl/PhysicalFsWriter.java
Lines 118 to 127 in d3843bc
Technically,
ZstdCodec.getDefaultOptions()returns the final static variable. This AS-IS code is trying to change this static object which leads unintended side-effects. We should avoid this code pattern.orc/java/core/src/java/org/apache/orc/impl/ZstdCodec.java
Lines 150 to 156 in d3843bc
How was this patch tested?
Pass the CIs with a newly added test case.
Was this patch authored or co-authored using generative AI tooling?
No.