chore: refactor to simplify progress bar code in `forest-cli snapshot export` #5911

hanabi1224 · 2025-08-07T13:28:35Z

Summary of changes

This PR uses indicatif ::ProgressBar to simplify progress bar logic in forest-cli snapshot export, as a follow-up of

@hanabi1224 I think instead of using this whole block we can do this just by using:

let pb = ProgressBar::new_spinner().with_style(
        indicatif::ProgressStyle::with_template(
            "{spinner} Merging snapshot... {total_bytes} written in {elapsed} ({binary_bytes_per_sec})",
        )
        .expect("indicatif template must be valid"),
    );
    pb.enable_steady_tick(std::time::Duration::from_millis(100));
    let mut writer = pb.wrap_async_write(writer);

Originally posted by @akaladarshi in #5886 (comment)

Changes introduced in this pull request:

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

New Features
- Snapshot export progress now features a visual spinner progress bar for clearer and more informative feedback during export.
Style
- Replaced manual terminal output with a structured and user-friendly progress indicator for snapshot exports.

coderabbitai · 2025-08-07T13:28:41Z

Walkthrough

The changes update the snapshot export progress reporting in the CLI. Manual terminal output and custom throughput calculations are replaced by an indicatif spinner progress bar, improving progress feedback during snapshot exports. Redundant imports and manual print logic are removed, and progress bar updates are handled asynchronously using Tokio.

Changes

Cohort / File(s)	Change Summary
Snapshot Export Progress Reporting `src/cli/subcommands/snapshot_cmd.rs`	Replaced manual terminal print loop for snapshot export progress with an `indicatif` spinner progress bar, updated asynchronously via a Tokio task. Removed custom throughput calculation, manual print statements, and related imports.
Redundant Import Cleanup `src/cli/subcommands/mod.rs`	Removed unused import statement `use std::io::Write;`. No other changes.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CLI
    participant ProgressBar
    participant TokioTask
    participant SnapshotExporter

    User->>CLI: Initiate snapshot export
    CLI->>ProgressBar: Create spinner progress bar
    CLI->>TokioTask: Spawn async task to update progress bar
    CLI->>SnapshotExporter: Start export RPC call
    loop Every second
        TokioTask->>ProgressBar: Update position with file size
    end
    SnapshotExporter-->>CLI: Export complete
    CLI->>ProgressBar: Finish and clear
    CLI->>TokioTask: Await task completion
    CLI-->>User: Snapshot export done

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

feat: print average speed in forest-cli snapshot export #5869: Modifies the same snapshot export progress reporting logic, but with a different approach to displaying average speed and progress, indicating overlap in the affected code.

Note

🔌 MCP (Model Context Protocol) integration is now available in Early Access!

Pro users can now connect to remote MCP servers under the Integrations page to get reviews and chat conversations that understand additional development context.

📜 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 9bab49b and e18ec44.

📒 Files selected for processing (1)

src/cli/subcommands/snapshot_cmd.rs (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

src/cli/subcommands/snapshot_cmd.rs

⏰ 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). (9)

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

✨ 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/refactor-snap-export-progress-bar

🪧 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.

… export`

akaladarshi

One small comment and a suggestion

akaladarshi · 2025-08-08T16:08:08Z

src/cli/subcommands/snapshot_cmd.rs

+                    )
+                    .expect("indicatif template must be valid"),
+                ).with_message(format!("Exporting {} ...", output_path.display()));
+                let pb = std::sync::Arc::new(pb);


I don't think this is needed, ProgressBar is already thread safe.

But you can add this pb.enable_steady_tick(std::time::Duration::from_millis(80)); to make the the progress bar animation little bit smoother.

The progress bar is an Arc around its internal state.

Fixed.

chore: refactor to simplify progress bar code in `forest-cli snapshot…

9bab49b

… export`

hanabi1224 force-pushed the hm/refactor-snap-export-progress-bar branch from 0d48d06 to 9bab49b Compare August 7, 2025 13:37

hanabi1224 marked this pull request as ready for review August 7, 2025 13:38

hanabi1224 requested a review from a team as a code owner August 7, 2025 13:38

hanabi1224 requested review from akaladarshi and elmattic and removed request for a team August 7, 2025 13:38

Merge branch 'main' into hm/refactor-snap-export-progress-bar

afdce14

akaladarshi requested changes Aug 8, 2025

View reviewed changes

resolve comments

e18ec44

akaladarshi approved these changes Aug 11, 2025

View reviewed changes

elmattic approved these changes Aug 11, 2025

View reviewed changes

elmattic added this pull request to the merge queue Aug 11, 2025

Merged via the queue into main with commit 7589e92 Aug 11, 2025
43 checks passed

elmattic deleted the hm/refactor-snap-export-progress-bar branch August 11, 2025 09:06

coderabbitai bot mentioned this pull request Aug 22, 2025

fix: improve forest-tool snapshot validate error message #5969

Merged

4 tasks

coderabbitai bot mentioned this pull request Sep 17, 2025

feat: forest-cli snapshot export-diff #6074

Merged

4 tasks

coderabbitai bot mentioned this pull request Oct 8, 2025

Add new subcommands for forest-cli snasphot #6128

Merged

4 tasks

coderabbitai bot mentioned this pull request Nov 3, 2025

fix: improve export status output and CI #6221

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

chore: refactor to simplify progress bar code in `forest-cli snapshot export` #5911

chore: refactor to simplify progress bar code in `forest-cli snapshot export` #5911

Uh oh!

hanabi1224 commented Aug 7, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Aug 7, 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!

akaladarshi left a comment

Uh oh!

akaladarshi Aug 8, 2025

Uh oh!

hanabi1224 Aug 10, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

chore: refactor to simplify progress bar code in forest-cli snapshot export #5911

chore: refactor to simplify progress bar code in forest-cli snapshot export #5911

Uh oh!

Conversation

hanabi1224 commented Aug 7, 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 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Possibly related PRs

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

akaladarshi left a comment

Choose a reason for hiding this comment

Uh oh!

akaladarshi Aug 8, 2025

Choose a reason for hiding this comment

Uh oh!

hanabi1224 Aug 10, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

chore: refactor to simplify progress bar code in `forest-cli snapshot export` #5911

chore: refactor to simplify progress bar code in `forest-cli snapshot export` #5911

hanabi1224 commented Aug 7, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Aug 7, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)