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

Fix ESPHome BLE client raising confusing error when not connected #104146

Merged
merged 3 commits into from Nov 20, 2023

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented Nov 17, 2023

Proposed change

The @verify_connected decorator should have checked self._is_connected before trying to make the request to the aioesphomeapi lib so it could raise a helpful error instead of hitting an error inside the lib about the connection not being established

It was discovered in #102188 that some libraries will incorrectly reuse the client after the disconnected callback has fired which lead to this state and left the user wondering what had gone wrong.

I cleaned up the logging a bit so it will be more obvious what has gone wrong to developers.

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

  • 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 Black (black --fast homeassistant tests)
  • Tests have been added to verify that the new code works.

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 link to the changelog, or at minimum a diff between library versions is added to the PR description.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

The @verify_connected decorator should have checked self._is_connected
before trying to make the request to the aioesphomeapi lib so it could
raise a helpful error instead of hitting an error inside the lib about
the connection not being established

It was discovered in #102188 that some libraries will reuse the client
after the disconnected callback has fired which lead to this state and
left the user wondering what had gone wrong.
@home-assistant
Copy link

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

Code owner commands

Code owners of esphome can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign esphome Removes the current integration label and assignees on the pull request, add the integration domain after the command.

@bdraco bdraco marked this pull request as ready for review November 17, 2023 23:10
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.

Thanks, @bdraco 👍

../Frenck

@frenck frenck merged commit a9384d6 into dev Nov 20, 2023
23 checks passed
@frenck frenck deleted the esphome_ble_client_fixes branch November 20, 2023 09:08
@bdraco
Copy link
Member Author

bdraco commented Nov 20, 2023

thanks

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants