Skip to content

Avoid caching when add-on config API call fails#168

Merged
frenck merged 1 commit intohassio-addons:mainfrom
lmagyar:pr-avoid-caching-if-api-call-fails
Jul 9, 2025
Merged

Avoid caching when add-on config API call fails#168
frenck merged 1 commit intohassio-addons:mainfrom
lmagyar:pr-avoid-caching-if-api-call-fails

Conversation

@lmagyar
Copy link
Contributor

@lmagyar lmagyar commented Jul 9, 2025 •
edited by coderabbitai bot
Loading

Proposed Changes

In #164 this location was missed.

Related Issues

Summary by CodeRabbit

  • Bug Fixes
    • Improved error handling when retrieving add-on configuration, providing clearer error messages if the operation fails.
    • Removed unnecessary trailing whitespace for cleaner output.

@coderabbitai
Copy link

coderabbitai bot commented Jul 9, 2025 •
edited
Loading

Walkthrough

This update to lib/addons.sh removes an unnecessary trailing whitespace and introduces explicit error handling in the bashio::addon.config() function, ensuring failures in retrieving add-on configuration from the Supervisor API are logged and handled with an early exit.

Changes

File(s) Change Summary
lib/addons.sh Removed trailing whitespace in bashio::addon.option(); added error handling in addon.config()

Possibly related PRs

Suggested labels

bugfix

Suggested reviewers

  • frenck

Poem

A bunny hopped through bashio code,
Tidying lines where errors strode.
Now configs fail with grace and flair,
And trailing spaces vanish in air.
With logs and checks, the script’s robust—
In bash, as always, rabbits trust! 🐇✨

✨ 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 page 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 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.

frenck
frenck approved these changes Jul 9, 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 catch! Thanks, 👍

../Frenck

@frenck frenck merged commit 0d0a2f7 into hassio-addons:main Jul 9, 2025
4 checks passed
coderabbitai[bot]
coderabbitai bot reviewed Jul 9, 2025
View reviewed changes
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
lib/addons.sh (1)

578-581: Typo in comment: “emtpty” → “empty”

-    # emtpty JSON object instead.
+    # empty JSON object instead.
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7308cf0 and a8eb0f3.

📒 Files selected for processing (1)
  • lib/addons.sh (2 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
lib/addons.sh (1)
lib/log.sh (1)
  • bashio::log.error (190-195)
🔇 Additional comments (2)
lib/addons.sh (2)

548-548: Trailing whitespace removal is 👍

No functional impact; just eliminates diff noise.

571-575: Good call: prevent caching on Supervisor API failure

Early exit with an error log mirrors the pattern used in nearby helpers and avoids persisting corrupt data in the cache.
Implementation looks solid.

@frenck frenck added the bugfix Inconsistencies or issues which will cause a problem for users or implementors. label Jul 9, 2025
@lmagyar lmagyar mentioned this pull request Jul 9, 2025
Closed
@lmagyar lmagyar deleted the pr-avoid-caching-if-api-call-fails branch July 9, 2025 14:18
@github-actions github-actions bot locked and limited conversation to collaborators Dec 30, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@frenck frenck frenck approved these changes

Assignees

No one assigned

Labels

bugfix Inconsistencies or issues which will cause a problem for users or implementors.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@lmagyar @frenck