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

Catch missing inverter in Enphase Envoy #106730

Merged
merged 4 commits into from Jan 8, 2024

Conversation

catsmanac
Copy link
Contributor

Proposed change

Some envoy fw versions return an empty inverter array
every 4 hours when no production is taking place.
Prevent collection failure due to this as other data
seems fine. Inverters will show unknown during this one cycle.

Log file will now show warning when this occurs:

Inverter xyz not in returned inverters array (size: 0)

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:

Some envoy fw versions return an empty inverter array
every 4 hours when no production is taking place.
Prevent collection failure due to this as other data
seems fine. Inveretrs will show unknown during this cycle.
@home-assistant
Copy link

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

Code owner commands

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

Copy link
Member

@joostlek joostlek left a comment

Choose a reason for hiding this comment

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

Do we need the warning for the user? Can we maybe work with surpress (check #97617 for an example)?

I can't remember the state of the integration tests, but can we maybe have a testcase for this? (if we have tests)

@home-assistant home-assistant bot marked this pull request as draft December 30, 2023 15:55
@home-assistant
Copy link

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.

@joostlek joostlek changed the title bug: prevent invalid key when empty invereter arrays is returned. Catch missing inverter in Enphase Envoy Dec 30, 2023
@joostlek
Copy link
Member

Oh and an alternative: check if the inverter is in the list, if not, return None. This would at least prevent us from using a try catch

@catsmanac
Copy link
Contributor Author

Do we need the warning for the user? Can we maybe work with surpress (check #97617 for an example)?

We can make it like a debug or none at all. But if user has like a state change detection that would fire, there's no lead on what is going on. Hence the choice for a warning. But debug can work too, they would have to enable debug and then wait for it again.

I can't remember the state of the integration tests, but can we maybe have a testcase for this? (if we have tests)

This is like a blip during collection cycles. Current tests focus on single collection to configure all entities. Didn't find a decent way to do tests. Locally I used a simulator that would just insert an empty array during a 'life' test.

@catsmanac
Copy link
Contributor Author

Oh and an alternative: check if the inverter is in the list, if not, return None. This would at least prevent us from using a try catch

Done and changed warning to debug.

@catsmanac catsmanac marked this pull request as ready for review December 30, 2023 16:34
homeassistant/components/enphase_envoy/sensor.py Outdated Show resolved Hide resolved
homeassistant/components/enphase_envoy/sensor.py Outdated Show resolved Hide resolved
@joostlek joostlek merged commit e8acccc into home-assistant:dev Jan 8, 2024
23 checks passed
@joostlek joostlek added this to the 2024.1.3 milestone Jan 8, 2024
@catsmanac catsmanac deleted the EnphaseEnvoyInvalidKey branch January 8, 2024 22:02
tomaszsluszniak pushed a commit to tomaszsluszniak/core that referenced this pull request Jan 9, 2024
* bug: prevent invalid key when empty invereter arrays is returned.

Some envoy fw versions return an empty inverter array
every 4 hours when no production is taking place.
Prevent collection failure due to this as other data
seems fine. Inveretrs will show unknown during this cycle.

* refactor: replace try/catch with test and make warning debug

* Update homeassistant/components/enphase_envoy/sensor.py

* Update homeassistant/components/enphase_envoy/sensor.py

---------

Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com>
@github-actions github-actions bot locked and limited conversation to collaborators Jan 9, 2024
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.

Enphase Envoy integration KeyError
6 participants