core icon indicating copy to clipboard operation
core copied to clipboard

Reset UniFi bandwidth sensor when client misses heartbeat

Open wittypluck opened this issue 1 year ago • 3 comments

Proposed change

The aim of this PR is to reset Unifi bandwidth sensor to 0 when a client disconnect is detected through the heartbeat mechanism. Currently bandwidth sensors keep the last value before disconnect, which corrupts graphs and statistics.

This is an alternate implementation to #104459 based on heartbeats instead of events, as discussed with code owner in the linked issue.

Type of change

  • [ ] Dependency upgrade
  • [x] 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

  • This PR fixes or closes issue: fixes #102007
  • This PR is related to issue:
  • Link to documentation pull request:

Checklist

  • [x] The code change is tested and works locally.
  • [x] Local tests pass. Your PR cannot be merged unless tests pass
  • [x] There is no commented out code in this PR.
  • [x] I have followed the development checklist
  • [x] I have followed the perfect PR recommendations
  • [x] 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:

wittypluck avatar Nov 25 '23 19:11 wittypluck

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

Code owner commands

Code owners of unifi 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 unifi Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

home-assistant[bot] avatar Nov 25 '23 19:11 home-assistant[bot]

First draft PR. Still need to

  • add unit tests
  • maybe deduplicate code with device_tracker.py like async_client_is_connected_fn

wittypluck avatar Nov 25 '23 19:11 wittypluck

Thanks for the review ! I can't test the changes as much as I would like right now, but I'll implement your suggestions in the next few days.

wittypluck avatar Dec 25 '23 20:12 wittypluck

Hi @Kane610 , all tests ok on my side :)

wittypluck avatar Dec 27 '23 17:12 wittypluck

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

Learn more about our pull request process.

home-assistant[bot] avatar Dec 30 '23 11:12 home-assistant[bot]

Thanks @Kane610 ! I have added the two missing checks.

wittypluck avatar Jan 13 '24 18:01 wittypluck

Great, thank you!

wittypluck avatar Jan 14 '24 16:01 wittypluck