refactor: Adapt code to v1alpha8 API of frequenz-client-common #197

Marenz · 2025-08-13T13:28:23Z

The frequenz-client-common dependency has been updated, which introduced breaking changes from the new v1alpha8 API. This commit adapts the codebase to these changes, resolving the resulting nox failures across mypy, pytest, and formatters.

Key changes include:

Replacing the deprecated ComponentCategory with v1alpha8's ElectricalComponentCategory.
Updating enum members to match the new API, such as ElectricalComponentCategory.GRID to GRID_CONNECTION_POINT and InverterType.PV to InverterType.SOLAR.

llucax

LGTM, but this introduces breaking changes, which we want to avoid as much as possible from now on.

Maybe for this time, since this applies what are hopefully the last (major) breaking changes in the underlying protocol, we could ship the breaking changes, and help users upgrade their code.

src/frequenz/client/dispatch/_cli_types.py

src/frequenz/client/dispatch/types.py

llucax · 2025-08-19T11:58:46Z

src/frequenz/client/dispatch/types.py

-class Event(Enum):
-    """Enum representing the type of event that occurred during a dispatch operation."""
-
-    UNSPECIFIED = StreamMicrogridDispatchesResponse.Event.EVENT_UNSPECIFIED
-    CREATED = StreamMicrogridDispatchesResponse.Event.EVENT_CREATED
-    UPDATED = StreamMicrogridDispatchesResponse.Event.EVENT_UPDATED
-    DELETED = StreamMicrogridDispatchesResponse.Event.EVENT_DELETED


We should also re-export the event in common here for backwards compatibility (or leave this class as deprecated).

Just re-exporting is not enough as the member names also changed. I added the new names to this enum for now

Yeah, I'm not sure why we added the prefixes in common, that was a mistake.

Marenz · 2025-08-19T16:09:08Z

Updated to be backwards compatible and working with 0.3.5 common-api
Added a commit to add back the init key parameter for backwards compabilty.

Copilot

Pull Request Overview

This PR adapts the codebase to breaking changes introduced by the frequenz-client-common v1alpha8 API update. The changes ensure compatibility with the new API while maintaining backward compatibility.

Updated imports to use ElectricalComponentCategory from the new API structure
Replaced deprecated enum members with their v1alpha8 equivalents
Modified Event enum usage to match the new API naming conventions

Reviewed Changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
`tests/test_proto.py`	Updates test cases to use new component categories and function names
`tests/test_dispatch.py`	Updates dispatch test to use `ElectricalComponentCategory.BATTERY`
`tests/test_client.py`	Updates event enum usage to use `EVENT_` prefixed names
`tests/test_cli.py`	Updates CLI tests to use new electrical component categories
`src/frequenz/client/dispatch/types.py`	Major refactoring to support both old and new API categories with backward compatibility
`src/frequenz/client/dispatch/test/generator.py`	Updates test generator to use new electrical component categories
`src/frequenz/client/dispatch/test/_service.py`	Updates service implementation for new API structure
`src/frequenz/client/dispatch/_client.py`	Updates client to support new protobuf structure and deprecation warnings
`src/frequenz/client/dispatch/_cli_types.py`	Updates CLI type handling for new electrical component categories
`pyproject.toml`	Updates dependency versions to match v1alpha8 requirements
`RELEASE_NOTES.md`	Documents the breaking changes and new features

Comments suppressed due to low confidence (1)

src/frequenz/client/dispatch/types.py:50

The test is using InverterType.PV but the corresponding change shows InverterType.SOLAR being replaced with InverterType.PV. This suggests the test should use InverterType.SOLAR to test the deprecated name, or the comment should indicate this is testing the new name.

    UNSPECIFIED = StreamEvent.EVENT_UNSPECIFIED

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-08-19T16:09:48Z

src/frequenz/client/dispatch/types.py

    """Solar inverter."""

+    SOLAR = PBInverterType.INVERTER_TYPE_PV
+    """Deprecated, Solar inverter."""


The deprecation comment should include information about when this will be removed and recommend using PV instead.

Suggested change

"""Deprecated, Solar inverter."""

"""Deprecated: will be removed in v2.0.0. Use `PV` instead."""

RELEASE_NOTES.md

llucax · 2025-08-20T06:18:45Z

RELEASE_NOTES.md

 ## New Features

+* **`ElectricalComponentCategory`**: The client now uses the more specific `frequenz.client.common.microgrid.electrical_components.ElectricalComponentCategory` for targeting components.
+  * The new property `TargetCategory.ecategory` will return an `ElectricalComponentCategory`.


I would call this category2, as recommended in the v0.x.x version guideline. On the first glance I didn't even notice the leading e. Also using a standard name make it more obvious that this property should be renamed back to just category in the future, in the next breaking release.

Ah, I didn't know it was an actual guideline recommendation too

This commit adapts the client to the latest changes in the `frequenz-api-dispatch` and `frequenz-client-common` libraries. Key changes include: - Updated `frequenz-api-dispatch` dependency to `v1.0.0-rc3`. - Updated `frequenz-client-common` dependency to `v0.3.6`. - Introduced `ElectricalComponentCategory` from the new `v1alpha8` API for more specific component targeting. The old `ComponentCategory` is preserved for backward compatibility. - `InverterType.SOLAR` is now deprecated in favor of `InverterType.PV`. - Time interval filters now use `start_time` and `end_time` instead of `from_time` and `to_time`. Signed-off-by: Mathias L. Baumann <[email protected]>

Signed-off-by: Mathias L. Baumann <[email protected]>

llucax

Just one last minor optional comment.

llucax · 2025-08-20T12:41:18Z

src/frequenz/client/dispatch/types.py


+# Re-export Event for backwards compatibility
+__all__ = [
+    "Event",


To mark the import location as deprecated you could also instead of re-export it here, add a class like:

@deprecated("Use from frequenz.client.common.streaming.Event instead") class Event(streaming.Event): pass

src/frequenz/client/dispatch/test/_service.py:202: error: Argument "event" to "DispatchEvent" has incompatible type "frequenz.client.common.streaming.Event"; expected "frequenz.client.dispatch.types.Event" [arg-type]

That doesn't seem to be equivalent at least

Marenz · 2025-08-20T12:55:02Z

Removed tmp commit and will force merge

Copilot AI review requested due to automatic review settings August 13, 2025 13:28

Marenz requested review from a team as code owners August 13, 2025 13:28

Marenz requested a review from llucax August 13, 2025 13:28

This comment was marked as outdated.

Sign in to view

Marenz force-pushed the update-common-api branch from e46999c to 013527b Compare August 13, 2025 15:48

github-actions bot added the part:docs Affects the documentation label Aug 13, 2025

Marenz force-pushed the update-common-api branch from 013527b to 7a4fd1f Compare August 13, 2025 15:52

Marenz requested review from Copilot and shsms August 13, 2025 15:52

This comment was marked as outdated.

Sign in to view

Marenz force-pushed the update-common-api branch from 7a4fd1f to ee8504e Compare August 18, 2025 09:32

llucax reviewed Aug 19, 2025

View reviewed changes

llucax previously approved these changes Aug 19, 2025

View reviewed changes

Marenz dismissed llucax’s stale review via 05fd8db August 19, 2025 16:06

Marenz force-pushed the update-common-api branch 2 times, most recently from 05fd8db to 57ca451 Compare August 19, 2025 16:06

Marenz requested review from Copilot and llucax August 19, 2025 16:09

Copilot AI reviewed Aug 19, 2025

View reviewed changes

llucax reviewed Aug 20, 2025

View reviewed changes

Marenz force-pushed the update-common-api branch from 57ca451 to 0d7fdea Compare August 20, 2025 12:32

Marenz added 2 commits August 20, 2025 14:33

Fix typo in release notes

111667e

Signed-off-by: Mathias L. Baumann <[email protected]>

feat: Add backwards compatibility for key param

9b008f7

Signed-off-by: Mathias L. Baumann <[email protected]>

Marenz force-pushed the update-common-api branch from 0d7fdea to 0f7532c Compare August 20, 2025 12:33

llucax previously approved these changes Aug 20, 2025

View reviewed changes

Marenz dismissed llucax’s stale review via 9b008f7 August 20, 2025 12:54

Marenz force-pushed the update-common-api branch from 0f7532c to 9b008f7 Compare August 20, 2025 12:54

Marenz merged commit 5b19025 into frequenz-floss:v0.x.x Aug 20, 2025
5 checks passed

	"""Deprecated, Solar inverter."""
	"""Deprecated: will be removed in v2.0.0. Use `PV` instead."""

Uh oh!

refactor: Adapt code to v1alpha8 API of frequenz-client-common #197

refactor: Adapt code to v1alpha8 API of frequenz-client-common #197

Uh oh!

Conversation

Marenz commented Aug 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

llucax left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

llucax Aug 19, 2025

Choose a reason for hiding this comment

Uh oh!

Marenz Aug 19, 2025

Choose a reason for hiding this comment

Uh oh!

llucax Aug 20, 2025

Choose a reason for hiding this comment

Uh oh!

Marenz commented Aug 19, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Aug 19, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

llucax Aug 20, 2025

Choose a reason for hiding this comment

Uh oh!

Marenz Aug 20, 2025

Choose a reason for hiding this comment

Uh oh!

llucax left a comment

Choose a reason for hiding this comment

Uh oh!

llucax Aug 20, 2025

Choose a reason for hiding this comment

Uh oh!

Marenz Aug 20, 2025

Choose a reason for hiding this comment

Uh oh!

Marenz commented Aug 20, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Marenz commented Aug 13, 2025 •

edited

Loading