Add Dispatch.end_time and print it in dispatch-cli (#142)

Author: Marenz

RELEASE_NOTES.md

@@ -1,6 +1,9 @@
 # Frequenz Dispatch Client Library Release Notes
 
+## Features
+
+* `Dispatch.end_time` has been added to the `Dispatch` class, which is the time when the dispatch ended as calculated by the server. `dispatch-cli` will also print this time.
+
 ## Bug Fixes
 
-* Fix that duration=0 was sent & received as None.
 * Fix that `dispatch-cli stream` would try to print an event as dispatch, causing an exception.

src/frequenz/client/dispatch/__main__.py

@@ -148,6 +148,7 @@ def format_line(key: str, value: str, color: str = "cyan") -> str:
         lines.append(format_line("Recurrence", "None"))
     lines.append(format_line("Create Time", format_datetime(dispatch.create_time)))
     lines.append(format_line("Update Time", format_datetime(dispatch.update_time)))
+    lines.append(format_line("End    Time", format_datetime(dispatch.end_time)))
 
     # Combine all lines
     dispatch_info: str = "\n".join(lines)

src/frequenz/client/dispatch/types.py

@@ -158,6 +158,12 @@ class Dispatch:  # pylint: disable=too-many-instance-attributes
     update_time: datetime
     """The last update time of the dispatch in UTC. Set when a dispatch is modified."""
 
+    end_time: datetime | None = None
+    """The end time of the dispatch in UTC.
+
+    Calculated and sent by the backend service.
+    """
+
     @property
     def started(self) -> bool:
         """Check if the dispatch has started.
@@ -290,6 +296,7 @@ def from_protobuf(cls, pb_object: PBDispatch) -> "Dispatch":
             type=pb_object.data.type,
             create_time=to_datetime(pb_object.metadata.create_time),
             update_time=to_datetime(pb_object.metadata.modification_time),
+            end_time=to_datetime(pb_object.metadata.end_time),
             start_time=to_datetime(pb_object.data.start_time),
             duration=(
                 timedelta(seconds=pb_object.data.duration)
@@ -317,6 +324,7 @@ def to_protobuf(self) -> PBDispatch:
                 dispatch_id=self.id,
                 create_time=to_timestamp(self.create_time),
                 modification_time=to_timestamp(self.update_time),
+                end_time=to_timestamp(self.end_time),
             ),
             data=DispatchData(
                 type=self.type,

tests/test_client.py

@@ -7,6 +7,7 @@
 import random
 from dataclasses import replace
 from datetime import timedelta
+from functools import partial
 
 import grpc
 from pytest import raises
@@ -38,6 +39,7 @@ def _update_metadata(dispatch: Dispatch, created: Dispatch) -> Dispatch:
         id=created.id,
         create_time=created.create_time,
         update_time=created.update_time,
+        end_time=created.end_time,
     )
 
 
@@ -97,7 +99,16 @@ async def test_list_dispatches(
     dispatches = client.list(microgrid_id=1)
     async for page in dispatches:
         for dispatch in page:
-            assert dispatch in client.dispatches(microgrid_id=1)
+            # First find matching id in client.dispatches, then compare
+            service_side_dispatch = next(
+                filter(
+                    partial(lambda d, md: d.id == md.id, md=dispatch),
+                    client.dispatches(microgrid_id=1),
+                ),
+                None,
+            )
+
+            assert dispatch == service_side_dispatch
 
 
 async def test_list_dispatches_no_duration(

tests/test_proto.py

@@ -97,6 +97,7 @@ def test_dispatch() -> None:
             create_time=datetime(2023, 1, 1, tzinfo=timezone.utc),
             update_time=datetime(2023, 1, 1, tzinfo=timezone.utc),
             start_time=datetime(2024, 10, 10, tzinfo=timezone.utc),
+            end_time=datetime(2024, 10, 20, tzinfo=timezone.utc),
             duration=timedelta(days=10),
             target=[1, 2, 3],
             active=True,
@@ -117,6 +118,7 @@ def test_dispatch() -> None:
             create_time=datetime(2024, 3, 10, tzinfo=timezone.utc),
             update_time=datetime(2024, 3, 11, tzinfo=timezone.utc),
             start_time=datetime(2024, 11, 10, tzinfo=timezone.utc),
+            end_time=datetime(2024, 11, 20, tzinfo=timezone.utc),
             duration=timedelta(seconds=20),
             target=[ComponentCategory.BATTERY],
             active=False,