chore: refactor and simplify `stream_graph` and `unordered_stream_graph` #5893

hanabi1224 · 2025-08-04T11:57:31Z

Summary of changes

(Originally part of #5867 use small PR to make review easier)

Changes introduced in this pull request:

refactor stream_graph and unordered_stream_graph to avoid repetitive code

Reference issue to close (if applicable)

Closes

Change checklist

I have performed a self-review of my own code,
I have made corresponding changes to the documentation. All new code adheres to the team's documentation standards,
I have added tests that prove my fix is effective or that my feature works (if possible),
I have made sure the CHANGELOG is up-to-date. All user-facing changes should be reflected in this document.

Summary by CodeRabbit

Refactor
- Improved consistency and maintainability in how dead link handling is configured for chain streaming features.
- Reduced redundant logic and streamlined internal setup for both ordered and unordered streaming modes.
Style
- Minor formatting improvements for code readability.

coderabbitai · 2025-08-04T11:57:38Z

Walkthrough

The changes refactor the handling of the fail_on_dead_links flag in IPLD chain streaming utilities. A builder-style method is introduced for ChainStream, and a private helper function centralizes logic for unordered streaming. Function signatures are updated to delegate flag handling, and minor code cleanups are performed.

Changes

Cohort / File(s)	Change Summary
ChainStream flag refactor `src/ipld/util.rs`	Adds builder-style `fail_on_dead_links` method to `ChainStream`; updates `stream_graph` to use this method.
UnorderedChainStream consolidation `src/ipld/util.rs`	Introduces private helper `unordered_stream_chain_inner`; updates public functions to use it, removing redundancy.
Formatting and cleanup `src/ipld/util.rs`	Adds tuple formatting spaces, removes an unused variable, and applies minor code cleanups.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Suggested reviewers

elmattic
akaladarshi

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ca67546 and 0400e11.

📒 Files selected for processing (1)

src/ipld/util.rs (6 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (8)

GitHub Check: Build forest binaries on Linux AMD64
GitHub Check: tests
GitHub Check: tests-release
GitHub Check: All lint checks
GitHub Check: cargo-publish-dry-run
GitHub Check: Build Ubuntu
GitHub Check: Analyze (go)
GitHub Check: Analyze (rust)

🔇 Additional comments (6)

src/ipld/util.rs (6)

122-130: LGTM! Well-implemented builder pattern methods.

The new builder-style methods with_seen and fail_on_dead_links follow Rust conventions perfectly, enabling method chaining and improving the API usability. This aligns well with the refactoring objectives to simplify the implementation.

171-171: Excellent refactoring that eliminates code duplication.

The refactored stream_graph function now delegates to stream_chain and uses the new builder method to configure fail_on_dead_links. This is a perfect example of DRY principle application and significantly improves maintainability.

289-289: Good formatting improvement.

Adding space after the comma in the tuple type improves readability and follows Rust formatting conventions.

310-342: Excellent consolidation of duplicate logic.

The new private helper function unordered_stream_chain_inner successfully consolidates the previously duplicated logic for creating UnorderedChainStream instances. Parameterizing fail_on_dead_links eliminates code duplication and centralizes the worker setup logic.

344-365: Perfect refactoring with improved documentation.

The refactored unordered_stream_chain function successfully delegates to the helper while maintaining API compatibility. The comprehensive documentation comments are an excellent addition that clearly explains the function's behavior and parameters.

378-378: Refactoring completed successfully.

The refactored unordered_stream_graph function now uses the helper with fail_on_dead_links = false, completing the consolidation of duplicate logic. This maintains the correct behavior of ignoring dead links during graph streaming.

✨ Finishing Touches

📝 Generate Docstrings

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch hm/simplify-stream-graph

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai generate unit tests to generate unit tests for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

LesnyRumcajs · 2025-08-04T12:15:17Z

src/ipld/util.rs

+/// * `db` - A database that implements [`Blockstore`] interface.
+/// * `tipset_iter` - An iterator of [`Tipset`], descending order `$child -> $parent`.
+/// * `stateroot_limit` - An epoch that signifies how far back we need to inspect tipsets, in-depth.
+///   This has to be pre-calculated using this formula: `$cur_epoch - $depth`, where `$depth` is the


what's with $? what does it do?

I think it indicates a variable in the pseudo code (It's copied over without modification). Any suggestions?

Copied from where?

@LesnyRumcajs It's moved from line 331 https://github.com/ChainSafe/forest/pull/5893/files#diff-9681c5597f88efdc9a51e8257554e0c2e764c00970b651390d7e1ffee4050e92L311

Ah okay, sorry. I didn't look at the left side of the diff it seems. 😅

chore: refactor and simplify stream_graph and unordered_stream_graph

0400e11

hanabi1224 marked this pull request as ready for review August 4, 2025 11:58

hanabi1224 requested a review from a team as a code owner August 4, 2025 11:58

hanabi1224 requested review from LesnyRumcajs and elmattic and removed request for a team August 4, 2025 11:58

LesnyRumcajs reviewed Aug 4, 2025

View reviewed changes

elmattic approved these changes Aug 4, 2025

View reviewed changes

LesnyRumcajs approved these changes Aug 4, 2025

View reviewed changes

hanabi1224 added this pull request to the merge queue Aug 4, 2025

Merged via the queue into main with commit c0ec5b7 Aug 4, 2025
47 checks passed

hanabi1224 deleted the hm/simplify-stream-graph branch August 4, 2025 13:05

coderabbitai bot mentioned this pull request Aug 7, 2025

feat: add --unordered to forest-cli snapshot export #5867

Merged

4 tasks

coderabbitai bot mentioned this pull request Aug 28, 2025

chore: remove unordered chain traversal #6014

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

chore: refactor and simplify `stream_graph` and `unordered_stream_graph` #5893

chore: refactor and simplify `stream_graph` and `unordered_stream_graph` #5893

Uh oh!

hanabi1224 commented Aug 4, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Aug 4, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

LesnyRumcajs Aug 4, 2025

Uh oh!

hanabi1224 Aug 4, 2025

Uh oh!

LesnyRumcajs Aug 4, 2025

Uh oh!

hanabi1224 Aug 4, 2025 •

edited

Loading

Uh oh!

LesnyRumcajs Aug 4, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

chore: refactor and simplify stream_graph and unordered_stream_graph #5893

chore: refactor and simplify stream_graph and unordered_stream_graph #5893

Uh oh!

Conversation

hanabi1224 commented Aug 4, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary of changes

Reference issue to close (if applicable)

Other information and links

Change checklist

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Aug 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Suggested reviewers

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

LesnyRumcajs Aug 4, 2025

Choose a reason for hiding this comment

Uh oh!

hanabi1224 Aug 4, 2025

Choose a reason for hiding this comment

Uh oh!

LesnyRumcajs Aug 4, 2025

Choose a reason for hiding this comment

Uh oh!

hanabi1224 Aug 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

LesnyRumcajs Aug 4, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

chore: refactor and simplify `stream_graph` and `unordered_stream_graph` #5893

chore: refactor and simplify `stream_graph` and `unordered_stream_graph` #5893

hanabi1224 commented Aug 4, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Aug 4, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

hanabi1224 Aug 4, 2025 •

edited

Loading