Add safe mode option to core rebuild

[mdegat01]

Proposed change

Add a safe mode option to the /core/rebuild API

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: Document safe mode option for /core/rebuild developers.home-assistant#2204
• Link to cli pull request: Add safe mode option to core rebuild cli#495

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 of add-on configuration are added/changed:

• Documentation added/updated for developers.home-assistant.io

Summary by CodeRabbit

• New Features

  • Added support for rebuilding Home Assistant in safe mode, allowing for safer updates and troubleshooting.

• Tests

  • Introduced new test scenarios to validate the rebuilding process, including tests for safe mode functionality.

[coderabbitai]

Warning

Rate limit exceeded

@mdegat01 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 52 minutes and 48 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 7ee6bb8 and 9681067.

Walkthrough

The recent update enhances the Home Assistant Supervisor by allowing the rebuild method to accept additional parameters, specifically a safe_mode option. This modification ensures that the rebuilding process can handle various operational modes, improving flexibility and robustness. Corresponding tests have been added to verify the new functionality, ensuring that both normal and safe mode rebuilds are correctly implemented and validated.

Changes

File	Change Summary
supervisor/api/homeassistant.py	Modified the rebuild method to accept additional parameters and updated its signature.
supervisor/homeassistant/core.py	Added an optional safe_mode parameter to the restart method and updated the rebuild method to handle safe mode.
tests/api/test_homeassistant.py	Added a new test function test_api_rebuild to verify the rebuilding functionality with and without safe mode.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant User
    participant API
    participant Core
    participant Docker

    User->>API: Send rebuild request (safe_mode)
    API->>Core: Call rebuild(safe_mode)
    Core->>Core: Create safe mode marker (if safe_mode)
    Core->>Docker: Stop Home Assistant container
    Docker-->>Core: Container stopped
    Core->>Docker: Start Home Assistant container
    Docker-->>Core: Container started
    Core-->>API: Rebuild complete
    API-->>User: Rebuild response

Loading

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

[coderabbitai]

Actionable comments posted: 1