10000 Delete Backup files on error by agners · Pull Request #5880 · home-assistant/supervisor · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Delete Backup files on error #5880

8000
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
merged 1 commit into from
May 13, 2025
Merged

Delete Backup files on error #5880

merged 1 commit into from
May 13, 2025

Conversation

agners
Copy link
Member
@agners agners commented May 12, 2025 •
edited by coderabbitai bot
Loading

Proposed change

We consider failures during Home Assistatn Core and folder backup as fatal errors. In this case, we don't return a reference to the backup file (if run in forground), hence the backup is really considered fatal. Let's delete the backup files in this case.

Also add unit tests for the backup manager to verify this behavior.

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New feature (which adds functionality to the supervisor)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:
  • Link to cli pull request:
  • Link to client library pull request:

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • The code has been formatted using Ruff (ruff format supervisor tests)
  • Tests have been added to verify that the new code works.

If API endpoints or add-on configuration are added/changed:

Summary by CodeRabbit

  • Bug Fixes

    • Improved backup reliability by ensuring failed or incomplete backup files are automatically deleted if an error occurs during the backup process.

  • Tests

    • Added tests to verify that backup errors are correctly reported and that failed backup files are properly cleaned up.

@agners
Delete Backup files on error
58a4ae3 
We consider failures during Home Assistatn Core and folder backup as
fatal errors. In this case, we don't return a reference to the backup
file (if run in forground), hence the backup is really considered
fatal. Let's delete the backup files in this case.

Also add unit tests for the backup manager to verify this behavior.
@agners agners marked this pull request as ready for review May 13, 2025 12:49
@coderabbitai coderabbitai
Copy link
Contributor
coderabbitai bot commented May 13, 2025
📝 Walkthrough

Walkthrough

The is_new property was removed from the Backup class. The _do_backup method in the backup manager was updated to delete the backup file upon failure and its docstring was clarified. New and updated tests were added to verify error handling and backup file cleanup during the backup process.

Changes

Files/Groups Change Summary
supervisor/backups/backup.py Removed the is_new property method from the Backup class.
supervisor/backups/manager.py Updated _do_backup to delete the backup tarfile on failure and clarified the docstring to reflect this behavior.
tests/backups/test_manager.py Added two new test coroutines for error handling during Home Assistant and folder backup stages, renamed and updated an existing test to check return values and error capture, and updated imports.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant JobScheduler
    participant BackupManager
    participant Backup

    User->>JobScheduler: Schedule full backup job
    JobScheduler->>BackupManager: Call _do_backup(...)
    BackupManager->>Backup: Start backup (store_* methods)
    alt Backup succeeds
        BackupManager->>JobScheduler: Return Backup
    else Backup fails (BackupError or Exception)
        BackupManager->>Backup: Delete tarfile (unlink)
        BackupManager->>JobScheduler: Return None, record error
    end
Loading 
sequenceDiagram
    participant Test
    participant JobScheduler
    participant BackupManager
    participant Backup

    Test->>JobScheduler: Schedule backup job (simulate error)
    JobScheduler->>BackupManager: Call _do_backup(...)
    BackupManager->>Backup: store_* method raises error
    BackupManager->>Backup: Delete tarfile (unlink)
    BackupManager->>JobScheduler: Return None, record error
    JobScheduler->>Test: Test asserts error details and file deletion
Loading

Tip

⚡️ Faster reviews with caching
  • CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.

📜 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 b9bbb99 and 58a4ae3.

📒 Files selected for processing (3)
  • supervisor/backups/backup.py (0 hunks)
  • supervisor/backups/manager.py (2 hunks)
  • tests/backups/test_manager.py (4 hunks)
💤 Files with no reviewable changes (1)
  • supervisor/backups/backup.py
🔇 Additional comments (8)
supervisor/backups/manager.py (3)

521-522: Improved docstring clarity

The docstring now clearly explains that when a backup fails, the backup file is deleted and None is returned, which matches the implementation.

552-553: Good error handling with cleanup

Adding file cleanup when a BackupError occurs prevents orphaned backup files from being left behind, which is a critical improvement for disk space management and user experience.

557-558: Consistent error handling for all exceptions

Ensuring the backup file is also deleted in the generic exception handler maintains consistent behavior across different error types.

tests/backups/test_manager.py (5)

19-19: Import added for BackupJobStage

Properly importing BackupJobStage from supervisor.backups.const to support the new tests.

39-39: Import added for JobSchedulerOptions

Added JobSchedulerOptions import to support the new test scheduling approach.

409-435: Comprehensive test for Home Assistant backup error handling

This new test validates that when a BackupError occurs during Home Assistant backup:

  1. The backup operation returns None
  2. The error is properly captured with the correct type, message, and stage
  3. The backup file is deleted

This test ensures the primary functionality of this PR is working correctly.

437-463: Additional test for folder backup error handling

Adding a separate test for folder backup errors provides good coverage of both critical error paths (Home Assistant and folder backups). The test verifies the same error handling patterns as the Home Assistant test.

465-479: Updated error capture test to verify return value

Renaming the test from test_backup_error to test_backup_error_capture clarifies its purpose. The test now also verifies that the backup operation returns None when an error occurs, ensuring consistency with the updated docstring.

✨ Finishing Touches
  • 📝 Generate Docstrings

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.

❤️ Share
🪧 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 pa 8000 ge 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 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 or @coderabbitai title 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.

@agners agners requested review from emontnemery and removed request for emontnemery May 13, 2025 13:17
frenck
frenck approved these changes May 13, 2025
View reviewed changes
Copy link
Member
@frenck frenck left a comment

Choose a reason for hiding this comment

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

Nice! 👍

../Frenck

@frenck frenck merged commit c855eaa into main May 13, 2025
23 checks passed
@frenck frenck deleted the delete-backups-with-error branch May 13, 2025 18:51
@github-actions github-actions bot locked and limited conversation to collaborators May 15, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@frenck frenck frenck approved these changes

Assignees
No one assigned
Labels
breaking-change cla-signed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@agners @frenck
0