No update available if update cannot be installed on system

[mdegat01]

Proposed change

If there is an update for the addon but it cannot be installed because the system does not meet the requirements for it, API should not specify that an update is available.

Note: This PR will have an immediate impact on the addons info panel in frontend as it looks to this field to determine when to show UI about the update. It will not affect core currently since core update entities are true any time latest version != current version. They have no current support for the concept that an update is out there but it can't be installed here.

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:

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

  • Enhanced update logic to check for the latest version before updating add-ons.

• Tests

  • Added a new test to validate update availability based on version compatibility.

[coderabbitai]

Walkthrough

Walkthrough

The recent changes enhance the need_update property in the Addon class to include version validation logic. This ensures updates are only flagged when a new version is available and validated. Additionally, a new test function has been added to verify this version-based update logic using AwesomeVersion and pytest.

Changes

Files	Change Summary
supervisor/addons/addon.py	Updated need_update property to include version validation logic.
tests/api/test_addons.py	Added test_api_update_available_validates_version function to test update availability based on version compatibility.
tests/api/test_addons.py	Added imports for pytest and AwesomeVersion.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Addon
    participant DataStore

    User->>Addon: Check need_update
    Addon->>DataStore: Fetch latest version
    DataStore-->>Addon: Return latest version
    Addon->>Addon: Validate availability with self._validate_availability
    Addon-->>User: Return update status

sequenceDiagram
    participant TestSuite
    participant Addon
    participant DataStore
    participant AwesomeVersion

    TestSuite->>Addon: Call need_update
    Addon->>DataStore: Fetch latest version
    DataStore-->>Addon: Return latest version
    Addon->>AwesomeVersion: Compare versions
    AwesomeVersion-->>Addon: Return comparison result
    Addon-->>TestSuite: Return update status

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between b684c86 and b7c53d9.

Files selected for processing (2)

• supervisor/addons/addon.py (1 hunks)
• tests/api/test_addons.py (2 hunks)

Additional comments not posted (2)

tests/api/test_addons.py (1)

292-323: The new test function test_api_update_available_validates_version effectively simulates the scenario where an update is available but cannot be installed due to version incompatibility. This aligns well with the PR's objective to handle such cases in the Home Assistant supervisor.

supervisor/addons/addon.py (1)

288-294: The modification to the need_update property introduces a check to ensure that updates are only indicated as available if they can be installed. This is a critical improvement for user experience, preventing scenarios where updates appear available but cannot be installed due to system incompatibilities.

---

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.

[mdegat01]

Ok so I just checked. After this PR if there is an update but it cannot be installed on the system then the frontend says nothing about it in the addon info panel. No update panel with the changelog or any info about there being a newer version, just doesn't acknowledge it.

That's functional but it would be ideal if the frontend acknowledged that there was an update and said its not available on this system. Although it would need more info if we wanted to tell the user why there is no update (home assistant version, platform/machine not supported, etc.)

[agners]

Note: This PR will have an immediate impact on the addons info panel in frontend as it looks to this field to determine when to show UI about the update. It will not affect core currently since core update entities are true any time latest version != current version. They have no current support for the concept that an update is out there but it can't be installed here.

In discussions, we kinda agreed that hiding it completely is not good UX either. Ideally, we'd have a flag to tell the UI that the update is there, but can't be applied. But this is missing for update entities in general.

This wasn't really a user driven effort, and it doesn't seem a very important/urgent issue. So we decided to stay with status quo.