Skip to content

Raise ConfigEntryNotReady when Tuya setup hits a network error - #176124

Merged
joostlek merged 2 commits into
home-assistant:devfrom
David-Wu1119:tuya-config-entry-not-ready
Jul 10, 2026
Merged

Raise ConfigEntryNotReady when Tuya setup hits a network error#176124
joostlek merged 2 commits into
home-assistant:devfrom
David-Wu1119:tuya-config-entry-not-ready

Conversation

@David-Wu1119

@David-Wu1119 David-Wu1119 commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

Proposed change

Tuya setup errors from manager.update_device_cache() propagated as unhandled exceptions: only the sign invalid case was mapped (to ConfigEntryAuthFailed), so starting Home Assistant while the network/DNS was down left the Tuya config entry permanently failed until a manual reload or restart (see the reproduction steps in the issue).

This maps requests transport errors to ConfigEntryNotReady, so Home Assistant retries setup automatically and the integration recovers on its own once connectivity returns. The sign invalid reauth path is unchanged (the new branch only catches requests.exceptions.RequestException and runs first).

Regression test: a ConnectionError from update_device_cache puts the entry in SETUP_RETRY; it fails on the unpatched code (unhandled exception → permanent SETUP_ERROR).

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Deprecation (breaking change to happen in the future)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

Checklist

  • I understand the code I am submitting and can explain how it works.
  • 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
  • I have followed the perfect PR recommendations
  • The code has been formatted using Ruff (ruff format homeassistant tests)
  • Tests have been added to verify that the new code works.
  • Any generated code has been carefully reviewed for correctness and compliance with project standards.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies a diff between library versions and ideally a link to the changelog/release notes is added to the PR description.

Setup errors from update_device_cache propagated as unhandled
exceptions, so starting Home Assistant without network connectivity
left the Tuya config entry permanently failed until a manual reload.
Map requests transport errors to ConfigEntryNotReady so setup is
retried automatically and recovers once connectivity returns.
Copilot AI review requested due to automatic review settings July 9, 2026 15:19
@home-assistant home-assistant Bot added bugfix cla-signed has-tests integration: tuya small-pr PRs with less than 30 lines. Top 100 Integration is ranked within the top 100 by usage Top 200 Integration is ranked within the top 200 by usage Top 50 Integration is ranked within the top 50 by usage labels Jul 9, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@home-assistant

home-assistant Bot commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

Hey there @tuya, @zlinoliver, mind taking a look at this pull request as it has been labeled with an integration (tuya) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of tuya can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant mark-draft Mark the pull request as draft.
  • @home-assistant ready-for-review Remove the draft status from the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign tuya Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant update-branch Update the pull request branch with the base branch.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component, problem in config, problem in device, feature-request) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component, problem in config, problem in device, feature-request) on the pull request.

# Get all devices from Tuya, makes blocking web calls
try:
manager.update_device_cache()
except requests.exceptions.RequestException as exc:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I don't think it should handle all RequestException errors.
I suggest to start with just ConnectionError:

Suggested change
except requests.exceptions.RequestException as exc:
except requests.exceptions.ConnectionError as exc:

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Done — narrowed to requests.exceptions.ConnectionError. Thanks for the review!

balloob
balloob previously requested changes Jul 9, 2026

@balloob balloob left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Address comment by epenet.

@home-assistant
home-assistant Bot marked this pull request as draft July 9, 2026 15:32
@home-assistant

home-assistant Bot commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

Copilot AI review requested due to automatic review settings July 9, 2026 15:33

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@David-Wu1119
David-Wu1119 marked this pull request as ready for review July 9, 2026 15:35
@home-assistant
home-assistant Bot requested a review from balloob July 9, 2026 15:35

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: c521abb7a7

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

# Get all devices from Tuya, makes blocking web calls
try:
manager.update_device_cache()
except requests.exceptions.ConnectionError as exc:

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Retry Tuya setup after read timeouts

When the Tuya endpoint accepts the connection but stops responding, the SDK's requests call with its timeout raises requests.exceptions.ReadTimeout/Timeout, which is not a subclass of ConnectionError. That still falls through to the broad exception handler and leaves the entry in SETUP_ERROR instead of SETUP_RETRY, so a common transient network failure still requires a manual reload despite this retry handling.

Useful? React with 👍 / 👎.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Deliberately scoped: epenet asked above to start with just ConnectionError rather than the broader RequestException family (#176124 (comment)). Note connect-phase timeouts are covered (ConnectTimeout subclasses ConnectionError); read timeouts can be widened in a follow-up if the maintainers want it.

🤖 Addressed by Claude Code

@joostlek
joostlek merged commit ab4ab83 into home-assistant:dev Jul 10, 2026
33 checks passed
@github-actions github-actions Bot locked and limited conversation to collaborators Jul 11, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

bugfix cla-signed has-tests integration: tuya Quality Scale: No score small-pr PRs with less than 30 lines. Top 50 Integration is ranked within the top 50 by usage Top 100 Integration is ranked within the top 100 by usage Top 200 Integration is ranked within the top 200 by usage

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Tuya config entry does not retry after network becomes available following offline startup

5 participants