Skip to content
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.

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

feat: do not display backup size of 0 for in-progress backup #892

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

houhoucoop
Copy link
Contributor

@houhoucoop houhoucoop commented Mar 14, 2025

What this PR does / why we need it

  • do not display 0 size for in-progress backups until completion

Issue

[IMPROVEMENT] Do not display backup size of 0 for in-progress backup #9783

Test Result

  • Create a backup and hover over the camera icon to view the tooltip
  • The tooltip should not display Size: 0 Bi
  • It should show the correct size once the backup is complete
Screen.Recording.2025-03-14.at.10.17.47.AM.mov

Additional documentation or context

N/A

Summary by CodeRabbit

  • Bug Fixes
    • Improved the snapshot size display to show the size only when it is a positive value, resulting in clearer and more accurate information for users.

@houhoucoop houhoucoop self-assigned this Mar 14, 2025
Copy link

coderabbitai bot commented Mar 14, 2025

Walkthrough

The pull request updates the SnapshotIcon function in the Snapshot component. It replaces a basic size display with a conditional rendering block that checks whether backupStatusObject.size or snapshotObject.size is greater than zero before displaying the size. If the condition is met, the size is rendered using the formatMib function, with preference given to backupStatusObject.size. There are no changes to the exported or public entities.

Changes

File Summary
src/components/.../Snapshot.js Modified the SnapshotIcon function to conditionally render the snapshot size. The change verifies if either backupStatusObject.size or snapshotObject.size is > 0, and uses formatMib to format the size, prioritizing backupStatusObject.size.

Sequence Diagram(s)

sequenceDiagram
    participant UI
    participant SnapshotIcon
    participant FormatMib

    UI->>SnapshotIcon: Render SnapshotIcon
    SnapshotIcon->>SnapshotIcon: Check if backupStatusObject.size or snapshotObject.size > 0
    alt Condition met
        SnapshotIcon->>FormatMib: Call formatMib(size)
        FormatMib-->>SnapshotIcon: Return formatted size
        SnapshotIcon-->>UI: Display size paragraph with formatted value
    else Condition not met
        SnapshotIcon-->>UI: Display without size
    end
Loading

Suggested reviewers

  • derekbit
  • a110605

Poem

I’m a little rabbit, hopping through the code,
Making size render with a conditional mode.
If the number is greater than zero, I display,
With neat logic in every array.
Hopping on to a clearer, brighter day! 🐇✨


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between dc9cb31 and dc09e6a.

📒 Files selected for processing (1)
  • src/components/Snapshot/Snapshot.js (1 hunks)

🪧 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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

Comment on lines +171 to +175
{(backupStatusObject?.size || snapshotObject?.size) > 0 && (
<p className="snapshot-name">
Size: {backupStatusObject?.size ? formatMib(backupStatusObject.size) : formatMib(snapshotObject.size)}
</p>
)}
Copy link
Member

Choose a reason for hiding this comment

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

What if the backup size is really 0 after completing the backup?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

In what scenario can the backup size be 0?

Signed-off-by: Yi-Ya Chen <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants