Skip to content

Improve setup exception handling in ruckus_unleashed#168014

Open
lanrat wants to merge 1 commit intohome-assistant:devfrom
lanrat:ruckus_exception_handling
Open

Improve setup exception handling in ruckus_unleashed#168014
lanrat wants to merge 1 commit intohome-assistant:devfrom
lanrat:ruckus_exception_handling

Conversation

@lanrat
Copy link
Copy Markdown
Contributor

@lanrat lanrat commented Apr 12, 2026

Breaking change

Proposed change

Wrap post-login API calls (first refresh, system info, AP list) in try-except to catch ConnectionError/SchemaError and re-raise as ConfigEntryNotReady.

Addresses: #164706 (comment)

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.

To help with the load of incoming pull requests:

Wrap post-login API calls (first refresh, system info, AP list) in
try-except to catch ConnectionError/SchemaError and re-raise as
ConfigEntryNotReady.
@home-assistant
Copy link
Copy Markdown

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

Code owner commands

Code owners of ruckus_unleashed 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 ruckus_unleashed 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.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Improves ruckus_unleashed config entry setup resiliency by converting post-login connection/schema failures during initial API calls into ConfigEntryNotReady so Home Assistant can retry setup cleanly.

Changes:

  • Wrapes initial refresh + get_system_info() + get_aps() in a try/except that converts connection/schema errors into ConfigEntryNotReady.
  • Closes the Ruckus client on these failures to avoid leaving resources open.

system_info = await ruckus.api.get_system_info()
system_info = await ruckus.api.get_system_info()
aps = await ruckus.api.get_aps()
except (ConnectionError, SchemaError) as err:
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.

Do we have tests to support these exceptions?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants