Let Home Assistant retry after integration setup fails

[mvdwetering]

Summary by CodeRabbit

• Bug Fixes

  • Improved error handling during setup by changing the raised exception to better reflect when the system is not ready, enhancing the user's ability to understand and respond to setup issues.

• Tests

  • Updated test cases to align with the new error handling logic, ensuring that the system behaves as expected during setup retries.

[coderabbitai]

Walkthrough

The changes involve updating exception handling in a Home Assistant custom component, specifically for the Hue Sync Box integration. Instead of signaling a permanent error, the integration will now indicate that setup should be retried, suggesting a less fatal approach to connectivity or configuration issues.

Changes

File Path	Change Summary
.../huesyncbox/__init__.py	Replaced ConfigEntryError with ConfigEntryNotReady to defer setup failure.
tests/test_init.py	Updated test to expect SETUP_RETRY state instead of SETUP_ERROR.

Related issues

• Issue #70 by Oliviakrkk: The changes in this PR might address Objective 4 by allowing the integration to retry initialization after a container restart, which could potentially mitigate timeout errors and the need to manually re-add sync boxes.

Poem

In the code where hues dance with light,
A rabbit tweaked the flow just right.
🛠️ With errors soft as a retry's embrace,
The sync box finds its steadfast place. 🎵

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 X ?

---

Tips

Chat with CodeRabbit Bot (@coderabbitai)

• You can reply to a review comment made by CodeRabbit.
• You can tag CodeRabbit on specific lines of code or files in the PR by tagging @coderabbitai in a comment.
• You can tag @coderabbitai in a PR comment and ask one-off questions about the PR and the codebase. Use quoted replies to pass the context for follow-up questions.

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 a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @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.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

[coderabbitai]

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 3fc7225 and 6a1a992.

Files selected for processing (2)

• custom_components/huesyncbox/init.py (2 hunks)
• tests/test_init.py (1 hunks)

Additional comments: 3

custom_components/huesyncbox/__init__.py (2)

• 9-9: The change in the import statement from ConfigEntryError to ConfigEntryNotReady aligns with the PR's objective to enable retry behavior instead of immediate failure.

• 47-53: The change in the exception raised from ConfigEntryError to ConfigEntryNotReady in the async_setup_entry function is consistent with the PR's objective to implement a retry mechanism for the setup process.

Verification successful

---

The change from ConfigEntryError to ConfigEntryNotReady in the async_setup_entry function does not seem to affect other parts of the codebase since ConfigEntryError is not used elsewhere. The PR's changes are consistent with the objective to implement a retry mechanism for the setup process.

Scripts Executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Verify that the change in exception type is handled appropriately elsewhere in the codebase.
rg 'ConfigEntryError' --type py

Length of output: 31

tests/test_init.py (1)

• 54-58: The change in the assertion from ConfigEntryState.SETUP_ERROR to ConfigEntryState.SETUP_RETRY correctly reflects the new expected behavior of the integration setup process. This aligns with the PR objective to handle temporary issues by retrying the setup instead of failing immediately.