Remove unused JUNCTION and LOAD component categories (#467)

These component categories are deprecated, and are no longer used in
production, and have been removed from the microgrid API v0.15.1, which
we will update to soon.

This PR also fixes a protobuf generated type getting leaked outside the
MicrogridClient.

Author: shsms

RELEASE_NOTES.md

@@ -24,6 +24,8 @@
   capacity: float = soc_sample.value.as_watt_hours()
   ```
 
+- `MicrogridApiClient.set_power` no longer returns a `protobuf.Empty` result, but a `None`.  This won't affect you unless you are using the low level APIs of the SDK.
+
 <!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
 
 ## New Features

src/frequenz/sdk/actor/power_distributing/power_distributing.py

@@ -25,7 +25,6 @@
 
 import grpc
 from frequenz.channels import Peekable, Receiver, Sender
-from google.protobuf.empty_pb2 import Empty  # pylint: disable=no-name-in-module
 
 from ...actor import ChannelRegistry
 from ...actor._decorator import actor
@@ -674,8 +673,7 @@ async def _create_channels(self) -> None:
 
     def _parse_result(
         self,
-        # type comment to quiet pylint and mypy `unused-import` error
-        tasks,  # type: Dict[int, asyncio.Task[Empty]]
+        tasks: Dict[int, asyncio.Task[None]],
         distribution: Dict[int, float],
         request_timeout_sec: float,
     ) -> Tuple[float, Set[int]]:

src/frequenz/sdk/microgrid/_graph.py

@@ -502,7 +502,6 @@ def validate(self) -> None:
         self._validate_graph_root()
         self._validate_grid_endpoint()
         self._validate_intermediary_components()
-        self._validate_junctions()
         self._validate_leaf_components()
 
     def is_pv_inverter(self, component: Component) -> bool:
@@ -747,7 +746,6 @@ def _validate_graph_root(self) -> None:
         valid_root_types = {
             ComponentCategory.NONE,
             ComponentCategory.GRID,
-            ComponentCategory.JUNCTION,
         }
 
         valid_roots = list(
@@ -822,24 +820,6 @@ def _validate_intermediary_components(self) -> None:
                 f"{missing_predecessors}"
             )
 
-    def _validate_junctions(self) -> None:
-        """Check that junctions are configured correctly in the graph.
-
-        Raises:
-            InvalidGraphError: if any junction has no successors (it is allowed
-                for a single junction to be the root of the component graph, in
-                which case it will have no predecessors: this is taken care of
-                by the `_validate_graph_root` check)
-        """
-        junctions = self.components(component_category={ComponentCategory.JUNCTION})
-        no_successors = list(
-            filter(lambda c: self._graph.out_degree(c.component_id) == 0, junctions)
-        )
-        if len(no_successors) > 0:
-            raise InvalidGraphError(
-                f"Junctions missing graph successors: {no_successors}"
-            )
-
     def _validate_leaf_components(self) -> None:
         """Check that leaf components (e.g. batteries) are configured correctly.
 

src/frequenz/sdk/microgrid/client/_client.py

@@ -169,7 +169,7 @@ async def ev_charger_data(
         """
 
     @abstractmethod
-    async def set_power(self, component_id: int, power_w: float) -> Empty:
+    async def set_power(self, component_id: int, power_w: float) -> None:
         """Send request to the Microgrid to set power for component.
 
         If power > 0, then component will be charged with this power.
@@ -180,9 +180,6 @@ async def set_power(self, component_id: int, power_w: float) -> Empty:
         Args:
             component_id: id of the component to set power.
             power_w: power to set for the component.
-
-        Returns:
-            Empty response.
         """
 
     @abstractmethod
@@ -247,10 +244,7 @@ async def components(self) -> Iterable[Component]:
             )
         components_only = filter(
             lambda c: c.category
-            not in (
-                microgrid_pb.ComponentCategory.COMPONENT_CATEGORY_SENSOR,
-                microgrid_pb.ComponentCategory.COMPONENT_CATEGORY_LOAD,
-            ),
+            is not microgrid_pb.ComponentCategory.COMPONENT_CATEGORY_SENSOR,
             component_list.components,
         )
         result: Iterable[Component] = map(
@@ -567,7 +561,7 @@ async def ev_charger_data(
             EVChargerData.from_proto,
         ).new_receiver(maxsize=maxsize)
 
-    async def set_power(self, component_id: int, power_w: float) -> Empty:
+    async def set_power(self, component_id: int, power_w: float) -> None:
         """Send request to the Microgrid to set power for component.
 
         If power > 0, then component will be charged with this power.
@@ -579,9 +573,6 @@ async def set_power(self, component_id: int, power_w: float) -> Empty:
             component_id: id of the component to set power.
             power_w: power to set for the component.
 
-        Returns:
-            Empty response.
-
         Raises:
             AioRpcError: if connection to Microgrid API cannot be established or
                 when the api call exceeded timeout
@@ -590,7 +581,7 @@ async def set_power(self, component_id: int, power_w: float) -> Empty:
             if power_w >= 0:
                 # grpc.aio is missing types and mypy thinks this is not
                 # async iterable, but it is
-                result: Empty = await self.api.Charge(
+                await self.api.Charge(
                     microgrid_pb.PowerLevelParam(
                         component_id=component_id, power_w=math.floor(power_w)
                     ),
@@ -600,7 +591,7 @@ async def set_power(self, component_id: int, power_w: float) -> Empty:
                 # grpc.aio is missing types and mypy thinks this is not
                 # async iterable, but it is
                 power_w *= -1
-                result = await self.api.Discharge(
+                await self.api.Discharge(
                     microgrid_pb.PowerLevelParam(
                         component_id=component_id, power_w=math.floor(power_w)
                     ),
@@ -615,7 +606,6 @@ async def set_power(self, component_id: int, power_w: float) -> Empty:
                 details=msg,
                 debug_error_string=err.debug_error_string(),
             )
-        return result
 
     async def set_bounds(
         self,

src/frequenz/sdk/microgrid/component/_component.py

@@ -58,12 +58,10 @@ class ComponentCategory(Enum):
 
     NONE = microgrid_pb.ComponentCategory.COMPONENT_CATEGORY_UNSPECIFIED
     GRID = microgrid_pb.ComponentCategory.COMPONENT_CATEGORY_GRID
-    JUNCTION = microgrid_pb.ComponentCategory.COMPONENT_CATEGORY_JUNCTION
     METER = microgrid_pb.ComponentCategory.COMPONENT_CATEGORY_METER
     INVERTER = microgrid_pb.ComponentCategory.COMPONENT_CATEGORY_INVERTER
     BATTERY = microgrid_pb.ComponentCategory.COMPONENT_CATEGORY_BATTERY
     EV_CHARGER = microgrid_pb.ComponentCategory.COMPONENT_CATEGORY_EV_CHARGER
-    LOAD = microgrid_pb.ComponentCategory.COMPONENT_CATEGORY_LOAD
     CHP = microgrid_pb.ComponentCategory.COMPONENT_CATEGORY_CHP
 
     # types not yet supported by the API but which can be inferred

tests/actor/test_battery_status.py

@@ -116,7 +116,6 @@ def component_graph() -> Tuple[Set[Component], Set[Connection]]:
     components = {
         Component(1, ComponentCategory.GRID),
         Component(2, ComponentCategory.METER),
-        Component(3, ComponentCategory.JUNCTION),
         Component(104, ComponentCategory.METER),
         Component(105, ComponentCategory.INVERTER),
         Component(106, ComponentCategory.BATTERY),
@@ -130,14 +129,13 @@ def component_graph() -> Tuple[Set[Component], Set[Connection]]:
 
     connections = {
         Connection(1, 2),
-        Connection(2, 3),
-        Connection(3, 104),
+        Connection(2, 104),
         Connection(104, 105),
         Connection(105, 106),
-        Connection(3, 204),
+        Connection(2, 204),
         Connection(204, 205),
         Connection(205, 206),
-        Connection(3, 304),
+        Connection(2, 304),
         Connection(304, 305),
         Connection(305, 306),
     }

tests/actor/test_data_sourcing.py

@@ -30,9 +30,6 @@ async def test_data_sourcing_actor(self) -> None:
         servicer.add_component(
             1, microgrid_pb2.ComponentCategory.COMPONENT_CATEGORY_GRID
         )
-        servicer.add_component(
-            3, microgrid_pb2.ComponentCategory.COMPONENT_CATEGORY_JUNCTION
-        )
         servicer.add_component(
             4, microgrid_pb2.ComponentCategory.COMPONENT_CATEGORY_METER
         )
@@ -46,9 +43,8 @@ async def test_data_sourcing_actor(self) -> None:
             9, microgrid_pb2.ComponentCategory.COMPONENT_CATEGORY_BATTERY
         )
 
-        servicer.add_connection(1, 3)
-        servicer.add_connection(3, 4)
-        servicer.add_connection(3, 7)
+        servicer.add_connection(1, 4)
+        servicer.add_connection(1, 7)
         servicer.add_connection(7, 8)
         servicer.add_connection(8, 9)
 

tests/actor/test_power_distributing.py

@@ -53,7 +53,6 @@ def component_graph(self) -> tuple[set[Component], set[Connection]]:
         components = {
             Component(1, ComponentCategory.GRID),
             Component(2, ComponentCategory.METER),
-            Component(3, ComponentCategory.JUNCTION),
             Component(104, ComponentCategory.METER),
             Component(105, ComponentCategory.INVERTER),
             Component(106, ComponentCategory.BATTERY),
@@ -67,14 +66,13 @@ def component_graph(self) -> tuple[set[Component], set[Connection]]:
 
         connections = {
             Connection(1, 2),
-            Connection(2, 3),
-            Connection(3, 104),
+            Connection(2, 104),
             Connection(104, 105),
             Connection(105, 106),
-            Connection(3, 204),
+            Connection(2, 204),
             Connection(204, 205),
             Connection(205, 206),
-            Connection(3, 304),
+            Connection(2, 304),
             Connection(304, 305),
             Connection(305, 306),
         }

tests/microgrid/test_client.py

@@ -74,13 +74,10 @@ async def test_components(self) -> None:
                 Component(0, ComponentCategory.METER),
             }
 
-            # sensors/loads are not counted as components by the API client
+            # sensors are not counted as components by the API client
             servicer.add_component(
                 1, microgrid_pb.ComponentCategory.COMPONENT_CATEGORY_SENSOR
             )
-            servicer.add_component(
-                2, microgrid_pb.ComponentCategory.COMPONENT_CATEGORY_LOAD
-            )
             assert set(await microgrid.components()) == {
                 Component(0, ComponentCategory.METER),
                 Component(0, ComponentCategory.BATTERY),
@@ -91,7 +88,6 @@ async def test_components(self) -> None:
                 [
                     (9, microgrid_pb.ComponentCategory.COMPONENT_CATEGORY_METER),
                     (99, microgrid_pb.ComponentCategory.COMPONENT_CATEGORY_INVERTER),
-                    (66, microgrid_pb.ComponentCategory.COMPONENT_CATEGORY_LOAD),
                     (666, microgrid_pb.ComponentCategory.COMPONENT_CATEGORY_SENSOR),
                     (999, microgrid_pb.ComponentCategory.COMPONENT_CATEGORY_BATTERY),
                 ]
@@ -104,14 +100,12 @@ async def test_components(self) -> None:
 
             servicer.set_components(
                 [
-                    (66, microgrid_pb.ComponentCategory.COMPONENT_CATEGORY_LOAD),
                     (99, microgrid_pb.ComponentCategory.COMPONENT_CATEGORY_SENSOR),
                     (
                         100,
                         microgrid_pb.ComponentCategory.COMPONENT_CATEGORY_UNSPECIFIED,
                     ),
                     (101, microgrid_pb.ComponentCategory.COMPONENT_CATEGORY_GRID),
-                    (103, microgrid_pb.ComponentCategory.COMPONENT_CATEGORY_JUNCTION),
                     (104, microgrid_pb.ComponentCategory.COMPONENT_CATEGORY_METER),
                     (105, microgrid_pb.ComponentCategory.COMPONENT_CATEGORY_INVERTER),
                     (106, microgrid_pb.ComponentCategory.COMPONENT_CATEGORY_BATTERY),
@@ -122,7 +116,6 @@ async def test_components(self) -> None:
             assert set(await microgrid.components()) == {
                 Component(100, ComponentCategory.NONE),
                 Component(101, ComponentCategory.GRID),
-                Component(103, ComponentCategory.JUNCTION),
                 Component(104, ComponentCategory.METER),
                 Component(105, ComponentCategory.INVERTER, InverterType.NONE),
                 Component(106, ComponentCategory.BATTERY),

tests/microgrid/test_component.py

@@ -28,13 +28,6 @@ def test_component_category_from_protobuf() -> None:
         == cp.ComponentCategory.GRID
     )
 
-    assert (
-        cp._component_category_from_protobuf(
-            microgrid_pb.ComponentCategory.COMPONENT_CATEGORY_JUNCTION
-        )
-        == cp.ComponentCategory.JUNCTION
-    )
-
     assert (
         cp._component_category_from_protobuf(
             microgrid_pb.ComponentCategory.COMPONENT_CATEGORY_METER
@@ -80,9 +73,6 @@ def test_Component() -> None:
     c1 = cp.Component(1, cp.ComponentCategory.GRID)
     assert c1.is_valid()
 
-    c3 = cp.Component(3, cp.ComponentCategory.JUNCTION)
-    assert c3.is_valid()
-
     c4 = cp.Component(4, cp.ComponentCategory.METER)
     assert c4.is_valid()