Skip to content

feat: print average speed in forest-cli snapshot export #5869

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
hanabi1224 merged 2 commits into from
Jul 28, 2025
Merged

feat: print average speed in forest-cli snapshot export #5869

hanabi1224 merged 2 commits into from
Jul 28, 2025

Conversation

@hanabi1224
Copy link
Contributor

@hanabi1224 hanabi1224 commented Jul 28, 2025 •
edited by coderabbitai bot
Loading

Summary of changes

(Originally part of #5867)

Changes introduced in this pull request:

  • print average speed in forest-cli snapshot export
  • lower output refresh rate

Reference issue to close (if applicable)

Closes

Other information and links

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

    • The snapshot export command now displays the average write speed during its operation, providing real-time throughput information.

  • Documentation

    • Updated changelog to reflect the addition of average speed reporting in the snapshot export command.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 28, 2025 •
edited
Loading

Walkthrough

The changes introduce a new feature to the forest-cli snapshot export command, enabling it to display the average write speed during snapshot export. This is achieved by capturing the start time, updating the progress interval, and printing the current file size along with the calculated average speed in a human-readable format.

Changes

Cohort / File(s) Change Summary
Changelog Update
CHANGELOG.md		 Added an entry documenting the new average speed display for forest-cli snapshot export.
Snapshot Export Progress Enhancement
src/cli/subcommands/snapshot_cmd.rs		 Modified snapshot export to show average write speed and adjusted progress update interval.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~6 minutes

✨ 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/print-export-speed-in-snapshot-export
🪧 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.
    • @coderabbitai modularize this function.
  • 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.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

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

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

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.

@hanabi1224 hanabi1224 mentioned this pull request Jul 28, 2025
Merged
4 tasks
@hanabi1224 hanabi1224 marked this pull request as ready for review July 28, 2025 13:23
@hanabi1224 hanabi1224 requested a review from a team as a code owner July 28, 2025 13:23
@hanabi1224 hanabi1224 requested review from akaladarshi and sudo-shashank and removed request for a team July 28, 2025 13:23
coderabbitai[bot]
coderabbitai bot reviewed Jul 28, 2025
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
CHANGELOG.md (1)

32-35: Place the entry under the “Added” header, not “Changed”.

Printing a new metric is a feature addition; nothing existing was modified or broken. Move the bullet to the “Added” subsection to match the project’s own changelog guidelines.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 19c11c8 and 4d07e13.

📒 Files selected for processing (2)
  • CHANGELOG.md (1 hunks)
  • src/cli/subcommands/snapshot_cmd.rs (3 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). (7)
  • GitHub Check: tests-release
  • GitHub Check: tests
  • GitHub Check: Build forest binaries on Linux AMD64
  • GitHub Check: Build MacOS
  • GitHub Check: Build Ubuntu
  • GitHub Check: cargo-publish-dry-run
  • GitHub Check: All lint checks
🔇 Additional comments (4)
src/cli/subcommands/snapshot_cmd.rs (4)

15-19: LGTM: Clean import additions

The new imports for timing functionality (Instant) and zero checking (num::Zero) are properly organized and necessary for the speed calculation feature.

98-98: LGTM: Proper timing initialization

Capturing the start time with Instant::now() at the beginning of the export process is the correct approach for measuring elapsed time.

103-103: LGTM: Reasonable interval adjustment

Increasing the progress update interval from 0.25s to 0.5s reduces overhead while maintaining adequate user feedback for long-running snapshot exports.

115-126: LGTM: Well-implemented speed calculation with proper safety checks

The speed calculation logic is robust:

  • Proper division-by-zero protection using num::Zero trait
  • Accurate elapsed time calculation with floating-point precision
  • Consistent human-readable formatting for both file size and speed
  • Clear output format showing progress and performance metrics

The implementation enhances user experience by providing real-time throughput feedback during long-running snapshot exports.

@hanabi1224 hanabi1224 added this pull request to the merge queue Jul 28, 2025
Merged via the queue into main with commit ec25ca9 Jul 28, 2025
51 checks passed
@hanabi1224 hanabi1224 deleted the hm/print-export-speed-in-snapshot-export branch July 28, 2025 21:20
@coderabbitai coderabbitai bot mentioned this pull request Aug 7, 2025
Merged
4 tasks
This was referenced Sep 17, 2025
Merged
Merged
This was referenced Oct 9, 2025
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@LesnyRumcajs LesnyRumcajs LesnyRumcajs approved these changes

@akaladarshi akaladarshi akaladarshi approved these changes

@sudo-shashank sudo-shashank Awaiting requested review from sudo-shashank sudo-shashank is a code owner automatically assigned from ChainSafe/forest

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@hanabi1224 @LesnyRumcajs @akaladarshi