Explicitly declare spill codec dependency#21917
Open
kosiew wants to merge 5 commits intoapache:mainfrom
Open
Conversation
…ec contract - Cleaned up alphabetical ordering in Cargo.toml. - Added comments to clarify feature-only dependencies related to IPCStreamWriter in spill/mod.rs. - Documented codec contract requirement in IPCStreamWriter::new for better understanding of feature dependencies.
- Changed `ignored = "serde_json"` to `ignored = ["serde_json"]` to comply with TOML array requirements. - Fixed additional TOML parse errors. - Added `arrow-ipc` to the `cargo-machete` ignore list with a comment on its necessity for spill compression codec support.
kosiew
added a commit
to kosiew/datafusion
that referenced
this pull request
Apr 29, 2026
- Clarified spill codec comments in Cargo.toml:50 and Cargo.toml:99 to explain that arrow-ipc is consumed only via the arrow::ipc re-export, addressing potential unused flags from cargo-machete. - Revised writer doc comment in mod.rs:295 to specify "build-visible during Cargo feature resolution" instead of "compiler-visible." - Replaced bare commit hash reference with PR apache#21917 for clarity. - Added brief notes to the opportunistic serde_json cargo-machete cleanup in Cargo.toml:85 and Cargo.toml:97 to indicate they are unrelated to the spill contract.
- Clarified spill codec comments in Cargo.toml:50 and Cargo.toml:99 to explain that arrow-ipc is consumed only via the arrow::ipc re-export, addressing potential unused flags from cargo-machete. - Revised writer doc comment in mod.rs:295 to specify "build-visible during Cargo feature resolution" instead of "compiler-visible." - Replaced bare commit hash reference with PR apache#21917 for clarity. - Added brief notes to the opportunistic serde_json cargo-machete cleanup in Cargo.toml:85 and Cargo.toml:97 to indicate they are unrelated to the spill contract.
kosiew
force-pushed
the
codecissue-21914
branch
from
cf9228a to
7ba281a
Compare
github-actions
Bot
added
the
development-process
kosiew
changed the title
arrow-ipc (lz4, zstd) and document contract
Contributor
|
Can we please split the breaking_change refactor from the codec depedendcy work? They seem separtae and having two PRs would be easier to review |
kosiew
force-pushed
the
codecissue-21914
branch
from
7e54a70 to
7ba281a
Compare
github-actions
Bot
removed
the
development-process
Contributor
Author
|
split the breaking_change refactor into #21951 |
Member
|
merged with main since the breaking change detector is now fixed |
kosiew
force-pushed
the
codecissue-21914
branch
from
fe58db3 to
0e927a6
Compare
Member
|
can you update the title as well? |
kosiew
changed the title
Contributor
Author
|
@rluvaton |
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
3 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.
Which issue does this PR close?
Rationale for this change
The spill subsystem implicitly relied on workspace-level Cargo feature unification (e.g.,
arrow-ipc/zstd), which made codec availability fragile and prone to silent regressions when features were altered elsewhere. This change establishes an explicit, crate-local contract for required codecs, improving correctness, maintainability, and debuggability.What changes are included in this PR?
arrow-ipcdependency (withlz4andzstdfeatures) todatafusion-physical-planto guarantee codec availability for spill compression.IPCStreamWriter, clarifying runtime expectations and failure modes.arrow-ipctoCargo.lock.cargo-macheteignore entries where dependencies are feature-only (e.g.,arrow-ipc,serde_json) to avoid false positives.Are these changes tested?
No new tests are included in this PR.
Are there any user-facing changes?
No user-facing changes. This PR only makes an internal dependency contract explicit and improves developer-facing documentation.
LLM-generated code disclosure
This PR includes LLM-generated code and comments. All LLM-generated content has been manually reviewed and tested.