Properly await for AddInclusionBounds (#47)

Without this, the function call will never actually run. I'm not sure if
this was working anyways because of some obscure implementation detail
in grpcio, but in normal python a not awaited async function should
never actually run.

Besides this, for sure errors can't be really caught without the await
either.

This was detected while migrating to betterproto, as betterproto has
correct type hints.

Author: llucax

RELEASE_NOTES.md

@@ -16,3 +16,4 @@
 
 - Fix a leakage of `GrpcStreamBroadcaster` instances.
 - The user-passed retry strategy was not properly used by the data streaming methods.
+- The client `set_bounds()` method might have not done anything and if it did, errors were not properly raised.

src/frequenz/client/microgrid/_client.py

@@ -32,6 +32,7 @@
 from frequenz.channels import Receiver
 from frequenz.client.base import retry, streaming
 from google.protobuf.empty_pb2 import Empty  # pylint: disable=no-name-in-module
+from google.protobuf.timestamp_pb2 import Timestamp  # pylint: disable=no-name-in-module
 
 from ._component import (
     Component,
@@ -425,7 +426,7 @@ async def set_power(self, component_id: int, power_w: float) -> None:
         """
         try:
             await cast(
-                Awaitable[PbSetPowerActiveParam],
+                Awaitable[Empty],
                 self.api.SetPowerActive(
                     PbSetPowerActiveParam(component_id=component_id, power=power_w),
                     timeout=int(DEFAULT_GRPC_CALL_TIMEOUT),
@@ -469,11 +470,15 @@ async def set_bounds(
 
         target_metric = PbSetBoundsParam.TargetMetric.TARGET_METRIC_POWER_ACTIVE
         try:
-            self.api.AddInclusionBounds(
-                PbSetBoundsParam(
-                    component_id=component_id,
-                    target_metric=target_metric,
-                    bounds=PbBounds(lower=lower, upper=upper),
+            await cast(
+                Awaitable[Timestamp],
+                self.api.AddInclusionBounds(
+                    PbSetBoundsParam(
+                        component_id=component_id,
+                        target_metric=target_metric,
+                        bounds=PbBounds(lower=lower, upper=upper),
+                    ),
+                    timeout=int(DEFAULT_GRPC_CALL_TIMEOUT),
                 ),
             )
         except grpc.aio.AioRpcError as err:

tests/test_timeout.py

@@ -17,8 +17,10 @@
     ConnectionFilter,
     ConnectionList,
     PowerLevelParam,
+    SetBoundsParam,
 )
 from google.protobuf.empty_pb2 import Empty
+from google.protobuf.timestamp_pb2 import Timestamp
 
 # pylint: enable=no-name-in-module
 from pytest_mock import MockerFixture
@@ -119,3 +121,31 @@ def mock_set_power(
         assert err_ctx.value.code() == grpc.StatusCode.DEADLINE_EXCEEDED
 
     assert await server.graceful_shutdown()
+
+
+async def test_set_bounds_timeout(mocker: MockerFixture) -> None:
+    """Test if the set_power() method properly raises a timeout AioRpcError."""
+    servicer = MockMicrogridServicer()
+
+    def mock_add_inclusion_bounds(
+        request: SetBoundsParam, context: Any  # pylint: disable=unused-argument
+    ) -> Timestamp:
+        time.sleep(GRPC_SERVER_DELAY)
+        return Timestamp()
+
+    mocker.patch.object(servicer, "AddInclusionBounds", mock_add_inclusion_bounds)
+    server = MockGrpcServer(servicer, port=57809)
+    await server.start()
+
+    target = "[::]:57809"
+    grpc_channel = grpc.aio.insecure_channel(target)
+    client = ApiClient(grpc_channel=grpc_channel, target=target)
+
+    bounds_values = [{"lower": 0.0, "upper": 100.0}, {"lower": -10.0, "upper": 1.0}]
+
+    for bounds in bounds_values:
+        with pytest.raises(grpc.aio.AioRpcError) as err_ctx:
+            await client.set_bounds(component_id=1, **bounds)
+        assert err_ctx.value.code() == grpc.StatusCode.DEADLINE_EXCEEDED
+
+    assert await server.graceful_shutdown()