Fix that duration=0 was sent & received as None

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

Author: Marenz

RELEASE_NOTES.md

@@ -2,7 +2,4 @@
 
 ## Bug Fixes
 
-* Fix missing dependency in last release.
-* The `FakeClient.set_dispatches()` method now correctly updates `FakeService._last_id` which is used to generate unique dispatch IDs.
-* Fix that streams were globally shared between all clients.
-
+* Fix that duration=0 was sent & received as None.

src/frequenz/client/dispatch/__main__.py

@@ -128,7 +128,7 @@ def format_line(key: str, value: str, color: str = "cyan") -> str:
     lines.append(format_line("ID", str(dispatch.id)))
     lines.append(format_line("Type", str(dispatch.type)))
     lines.append(format_line("Start Time", format_datetime(dispatch.start_time)))
-    if dispatch.duration:
+    if dispatch.duration is not None:
         lines.append(format_line("Duration", str(dispatch.duration)))
     else:
         lines.append(format_line("Duration", "Infinite"))
@@ -407,7 +407,7 @@ async def create(
     kwargs = {k: v for k, v in kwargs.items() if v is not None}
 
     # Required for client.create
-    if not kwargs.get("duration"):
+    if "duration" not in kwargs:
         kwargs["duration"] = None
 
     dispatch = await ctx.obj["client"].create(

src/frequenz/client/dispatch/_internal_types.py

@@ -125,7 +125,9 @@ def to_protobuf(self) -> PBDispatchCreateRequest:
                     else Timestamp()
                 ),
                 duration=(
-                    round(self.duration.total_seconds()) if self.duration else None
+                    None
+                    if self.duration is None
+                    else round(self.duration.total_seconds())
                 ),
                 target=_target_components_to_protobuf(self.target),
                 is_active=self.active,

src/frequenz/client/dispatch/types.py

@@ -292,9 +292,9 @@ def from_protobuf(cls, pb_object: PBDispatch) -> "Dispatch":
             update_time=to_datetime(pb_object.metadata.modification_time),
             start_time=to_datetime(pb_object.data.start_time),
             duration=(
-                timedelta(seconds=pb_object.data.duration)
-                if pb_object.data.duration
-                else None
+                None
+                if pb_object.data.duration is None
+                else timedelta(seconds=pb_object.data.duration)
             ),
             target=_target_components_from_protobuf(pb_object.data.target),
             active=pb_object.data.is_active,

tests/test_client.py

@@ -74,6 +74,15 @@ async def test_create_duration_none(client: FakeClient, sample: Dispatch) -> Non
     assert dispatch == sample
 
 
+async def test_create_duration_0(client: FakeClient, sample: Dispatch) -> None:
+    """Test creating a dispatch with a 0 duration."""
+    microgrid_id = random.randint(1, 100)
+    sample = replace(sample, duration=timedelta(minutes=0))
+    dispatch = await client.create(**to_create_params(microgrid_id, sample))
+    sample = _update_metadata(sample, dispatch)
+    assert dispatch == sample
+
+
 async def test_list_dispatches(
     client: FakeClient, generator: DispatchGenerator
 ) -> None: