Fix cleanup and missing location metadata #145
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
We also use a fixture to always clean the client used for test appropriately. Signed-off-by: Leandro Lucarella <[email protected]>
Signed-off-by: Leandro Lucarella <[email protected]>
Signed-off-by: Leandro Lucarella <[email protected]>
Signed-off-by: Leandro Lucarella <[email protected]>
github-actions
bot
added
part:docs
There was a problem hiding this comment.
Pull Request Overview
This PR fixes how missing microgrid location metadata is handled (avoiding a default 0,0), ensures that background broadcasters are stopped when the client disconnects, and adds/refactors tests around metadata and client cleanup.
- Use
HasField("location")to detect absent location instead of relying on truthiness. - Implement
__aexit__override to stop all broadcasters and clean up the gRPC channel. - Refactor tests to use a shared
clientfixture and add tests for successful, missing, empty, and error metadata responses.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| tests/test_client.py | Added client fixture, imported Empty and MicrogridId, refactored existing tests to use the fixture, and added metadata tests. |
| src/frequenz/client/microgrid/_client.py | Added __aexit__ override to stop broadcasters, updated metadata() to check HasField("location"). |
| RELEASE_NOTES.md | Documented bug fixes for metadata location handling and client cleanup behavior. |
Comments suppressed due to low confidence (1)
src/frequenz/client/microgrid/_client.py:113
- The implementation of aexit calls asyncio.gather but
asynciois not imported in this file, causing a NameError at runtime. Please addimport asyncioat the top of the file.
async def __aexit__(
shsms
approved these changes
May 15, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR resolves an issue where microgrid metadata would incorrectly default to a
(0,0)location if the actual location was missing.If also ensures that broadcasters are properly stopped and cleaned up during client disconnection or exit, preventing potential resource leaks.
Finally, it adds some tests for retrieving microgrid metadata.