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

Add hard-coded image fallback for plugins for offline start #5204

Merged
merged 1 commit into from
Jul 25, 2024

Conversation

mdegat01
Copy link
Contributor

@mdegat01 mdegat01 commented Jul 24, 2024

Proposed change

Plugins need a hard-coded string to use as a fallback. That way when an HAOS system is first started offline it can function and get to the landing page even though we cannot fetch the latest versions file with all the image names and latest versions.

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:

Summary by CodeRabbit

  • New Features

    • Enhanced the default image retrieval process across multiple plugins to ensure more robust handling of unavailable images.
    • Added a test case to verify the fallback mechanism for the default image.
  • Bug Fixes

    • Improved error handling by implementing conditional checks in the default image property across various plugins to prevent returning invalid values.
  • Tests

    • Refactored test cases for better readability and maintainability.
    • Introduced new tests to ensure the correct functionality of the updated default image logic.

@mdegat01 mdegat01 added the bugfix A bug fix label Jul 24, 2024
@mdegat01 mdegat01 requested a review from agners July 24, 2024 17:30
Copy link

coderabbitai bot commented Jul 24, 2024

Walkthrough

Walkthrough

The recent changes across multiple plugin files enhance the robustness of the default_image property by implementing conditional checks before returning image values from system updaters. If the specified image is None or falsy, the methods now defer to the superclass's implementation, ensuring that a valid image is always returned. Additionally, test cases have been restructured for clarity, and new tests have been added to cover fallback scenarios for the default images.

Changes

Files Change Summary
supervisor/plugins/audio.py Enhanced default_image logic with a conditional check for self.sys_updater.image_audio to ensure it's not falsy before falling back to superclass default.
supervisor/plugins/cli.py Modified default_image to check if self.sys_updater.image_cli is truthy, with a fallback to superclass's implementation if not.
supervisor/plugins/dns.py Updated default_image to verify self.sys_updater.image_dns is valid, falling back to superclass if it’s not set.
supervisor/plugins/multicast.py Added a conditional check in default_image for self.sys_updater.image_multicast, returning the superclass's image if the check fails.
supervisor/plugins/observer.py Revised default_image to include a check for self.sys_updater.image_observer, falling back to superclass if the value is falsy.
tests/plugins/test_plugin_base.py Refactored test cases for better readability using grouped context managers; added test_default_image_fallback to ensure fallback mechanisms work as intended.

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

Copy link
Member

@agners agners left a comment

Choose a reason for hiding this comment

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

Thanks, LGTM!

@agners agners merged commit 5ee7d16 into main Jul 25, 2024
20 checks passed
@agners agners deleted the fallback-images-plugins branch July 25, 2024 11:45
@github-actions github-actions bot locked and limited conversation to collaborators Jul 27, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants