You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Ogg, xtask: check packet ranges against the source first; stats skips directory links - #1796
What was wrong: the public OggFile::read_packet sized and zero-filled its buffer from the stored packet ranges before checking they exist in the source it was handed (ranges recorded from a scan of a different or shorter source). The xtask stats walker followed directory symlinks with no visited set, so a small branching link tree is walked exponentially.
Changed: read_parts validates every range against src.len() first and returns Error::Invalid; the stats walker uses DirEntry::file_type (which does not follow links) and skips symlinks.
Blast radius: crates/ogg read_parts (only caller path is read_packet) and xtask/src/stats.rs (a dev tool). Behavior change: read_packet on a mismatched source now errors up front instead of failing partway; symlinked directories are no longer counted by xtask stats.
Checks run: cargo fmt --check, clippy -p deckcraft-ogg -p xtask --all-targets -D warnings, cargo test -p deckcraft-ogg (new test with a truncated source). Not run: workspace tests, xtask run.
Summary by CodeRabbit
Bug Fixes
Invalid packet ranges, including ranges that overflow or extend beyond the source, are now rejected instead of being read.
Statistics scans now skip symbolic links and recurse only into directories.
No actionable merge-blocking risk is established in the reviewed changes. The reported CI failures are infrastructure/authentication failures rather than PR defects.
Pre-merge checks: 4 · 1
Failed checks: 1 warning
Check name
Status
Explanation
Resolution
Docstring Coverage
Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Write docstrings for the functions missing them to satisfy the coverage threshold.
Passed checks: 4 passed
Check name
Status
Explanation
Description Check
Check skipped - CodeRabbit’s high-level summary is enabled.
Title check
The title names both changes in the PR: the Ogg read_parts change that checks packet ranges against the source before allocating, and the xtask stats change that skips directory symlinks. It is long…
Linked Issues check
Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check
Check skipped because no linked issues were found for this pull request.
Full details: Title check
Explanation
The title names both changes in the PR: the Ogg read_parts change that checks packet ranges against the source before allocating, and the xtask stats change that skips directory symlinks. It is long and uses a semicolon to join two unrelated changes, but it describes real, on-topic changes and does not mislead.
Full details: Docstring Coverage
Explanation
Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 2 functions across 3 files.
Resolution
Write docstrings for the functions missing them to satisfy the coverage threshold.
Finishing Touches
Generate docstrings
Commit to this branch
Create a new PR
Generate unit tests (beta)
Commit to this branch
Create a new PR
Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
Reviewing files that changed from the base of the PR and between 19dceff and b3cebb9.
Files selected for processing: 3
crates/ogg/src/lib.rs
crates/ogg/src/tests.rs
xtask/src/stats.rs
Included review availability: This review used your included allowance. Your plan provides up to 8 included reviews per hour; 5 remain after this review.
Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.
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
bugfixFixes something that is broken: wrong result, crash, data losssecurity
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 was wrong: the public OggFile::read_packet sized and zero-filled its buffer from the stored packet ranges before checking they exist in the source it was handed (ranges recorded from a scan of a different or shorter source). The xtask stats walker followed directory symlinks with no visited set, so a small branching link tree is walked exponentially.
Changed: read_parts validates every range against src.len() first and returns Error::Invalid; the stats walker uses DirEntry::file_type (which does not follow links) and skips symlinks.
Blast radius: crates/ogg read_parts (only caller path is read_packet) and xtask/src/stats.rs (a dev tool). Behavior change: read_packet on a mismatched source now errors up front instead of failing partway; symlinked directories are no longer counted by xtask stats.
Checks run: cargo fmt --check, clippy -p deckcraft-ogg -p xtask --all-targets -D warnings, cargo test -p deckcraft-ogg (new test with a truncated source). Not run: workspace tests, xtask run.
Summary by CodeRabbit