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

Disable backup complete ws message #5452

Merged
merged 1 commit into from
Nov 26, 2024
Merged

Disable backup complete ws message #5452

merged 1 commit into from
Nov 26, 2024

Conversation

mdegat01
Copy link
Contributor

@mdegat01 mdegat01 commented Nov 25, 2024

Proposed change

Core does not understand the backup complete WS message since the cloud backup work did not make it in. Disable the message for now so it stops giving false errors on dev systems. Will update prior to actual release of cloud backup features.

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

  • New Features

    • Updated minimum version requirement for backup completion events to enhance compatibility.
    • Expanded test coverage for the BackupManager, aligning with the new Home Assistant API version.
  • Bug Fixes

    • Improved error handling for backup failures and refined logic for excluding the Home Assistant database during backups.

@mdegat01 mdegat01 added the bugfix A bug fix label Nov 25, 2024
@mdegat01 mdegat01 requested a review from agners November 25, 2024 22:05
Copy link

coderabbitai bot commented Nov 25, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The changes in this pull request involve updates to the MIN_VERSION dictionary in the supervisor/homeassistant/websocket.py file, specifically changing the version for WSType.BACKUP_COMPLETE to a newer version. Additionally, the test suite for the BackupManager class in tests/backups/test_manager.py has been updated to align with this new version, including modifications to the Home Assistant API version used in the tests and adjustments to assertions related to backup completion messages.

Changes

File Change Summary
supervisor/homeassistant/websocket.py Updated MIN_VERSION for WSType.BACKUP_COMPLETE from "2024.11.99" to "2025.11.99".
tests/backups/test_manager.py Updated test suite for BackupManager to use ha_version "2025.12.0" and adjusted assertions for backup completion messages to reflect this new version.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant BackupManager
    participant WebSocket

    User->>BackupManager: Initiate Backup
    BackupManager->>WebSocket: Send Backup Request
    WebSocket->>BackupManager: Acknowledge Backup Request
    BackupManager->>User: Backup in Progress
    BackupManager->>WebSocket: Check Backup Status
    WebSocket->>BackupManager: Backup Complete
    BackupManager->>User: Backup Completed
Loading

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between f758306 and f75a61d.

📒 Files selected for processing (2)
  • supervisor/homeassistant/websocket.py (1 hunks)
  • tests/backups/test_manager.py (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • supervisor/homeassistant/websocket.py
  • tests/backups/test_manager.py

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.
    • 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 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 merged commit 11ca772 into main Nov 26, 2024
20 checks passed
@agners agners deleted the disable-backup-complete-ws branch November 26, 2024 08:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants