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

Avoid Exception on Glances missing key #114628

Merged
merged 4 commits into from
Aug 11, 2024

Conversation

wittypluck
Copy link
Contributor

@wittypluck wittypluck commented Apr 2, 2024

Proposed change

The aim of this PR is to handle gracefully the case where a Glances sensor is removed server side.
In that case, HA should stop updating this sensor and mark it as Unavailable.
Today, the code breaks (exception in logs).

In more detail, there are three cases where Glances data can become unavailable after the inital setup completes correctly:

  1. Request to the server fails, no data available at all => already handled by existing code
  2. Configuration changes server side to remove a whole module (eg: fs, network) => currently provokes a missing key error, now handled by this PR to mark sensors as Unavailable
  3. Configuration changes server side to remove an item in a module (eg: hide a filesystem in fs module, or hide a network adapter in network module) => currently provokes a missing key error, now handled by this PR to mark sensors as Unavailable

The PR adds systematic checks that the keys used are present in the data provided by python-glances-api. If not, the value is set to None.
It also updates the logic of available() to check for None values.

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 Ruff (ruff format 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:

@home-assistant
Copy link

home-assistant bot commented Apr 2, 2024

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

Code owner commands

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

@wittypluck wittypluck changed the title Glances missing key Avoid Exception on Glances missing key Apr 2, 2024
@wittypluck wittypluck marked this pull request as ready for review April 2, 2024 10:16
@home-assistant home-assistant bot marked this pull request as draft April 2, 2024 18:14
@home-assistant
Copy link

home-assistant bot commented Apr 2, 2024

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.

@wittypluck wittypluck force-pushed the glances-missing-key branch 2 times, most recently from 580f043 to 449c422 Compare April 7, 2024 14:03
@wittypluck
Copy link
Contributor Author

wittypluck commented Apr 20, 2024

Hello @gjohansson-ST , have you had time to look at my answers to your questions ?
(Not sure if I should mark them as resolved as I haven't made changes to the code)
Thanks !

@wittypluck
Copy link
Contributor Author

I have also updated the PR description to explain in more detail why this change is useful.

@wittypluck wittypluck marked this pull request as ready for review May 17, 2024 19:17
@frenck frenck added the smash Indicator this PR is close to finish for merging or closing label Jun 20, 2024
@gjohansson-ST gjohansson-ST dismissed their stale review July 31, 2024 16:51

Fine to leave as is

@emontnemery
Copy link
Contributor

@wittypluck OK! I've marked the PR as draft, please click the "Ready for review" button when you've addressed the comment.

@emontnemery emontnemery marked this pull request as draft August 2, 2024 11:51
@wittypluck wittypluck marked this pull request as ready for review August 9, 2024 11:54
@wittypluck
Copy link
Contributor Author

wittypluck commented Aug 9, 2024

Thank you! I have rebased, made the change and resubmitted for review.

Copy link
Member

@gjohansson-ST gjohansson-ST left a comment

Choose a reason for hiding this comment

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

Thanks @wittypluck 👍

@gjohansson-ST gjohansson-ST added this to the 2024.8.2 milestone Aug 11, 2024
@gjohansson-ST gjohansson-ST merged commit 766733b into home-assistant:dev Aug 11, 2024
26 checks passed
@wittypluck
Copy link
Contributor Author

Thank you @gjohansson-ST and @emontnemery !

@wittypluck wittypluck deleted the glances-missing-key branch August 12, 2024 17:54
@github-actions github-actions bot locked and limited conversation to collaborators Aug 13, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bugfix cherry-picked cla-signed has-tests integration: glances Quality Scale: No score small-pr PRs with less than 30 lines. smash Indicator this PR is close to finish for merging or closing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Glances regularly reports KeyError: 'disk_use'
4 participants