fix: fix order book client

The client object acts as a stateful manager for data streams.

The public order book stream was cached using a key that only includes
the filter parameters (delivery_area, side, etc.) and completely ignores
the start_time and end_time.

This has been fixed by including start and end time parameters in the
cache.

Signed-off-by: Matthias Wende <[email protected]>

Author: matthias-wende-frequenz

src/frequenz/client/electricity_trading/_client.py

@@ -241,7 +241,9 @@ def __init__(
         ] = {}
 
         self._public_orders_streams: dict[
-            PublicOrderBookFilter,
+            tuple[
+                PublicOrderBookFilter, tuple[int, int] | None, tuple[int, int] | None
+            ],
             GrpcStreamBroadcaster[
                 electricity_trading_pb2.ReceivePublicOrderBookStreamResponse,
                 list[PublicOrder],
@@ -1057,28 +1059,32 @@ def receive_public_order_book(
         start_time_utc = dt_to_pb_timestamp_utc(start_time) if start_time else None
         end_time_utc = dt_to_pb_timestamp_utc(end_time) if end_time else None
 
+        cache_key = (
+            public_order_filter,
+            (start_time_utc.seconds, start_time_utc.nanos) if start_time_utc else None,
+            (end_time_utc.seconds, end_time_utc.nanos) if end_time_utc else None,
+        )
+
         if (
-            public_order_filter not in self._public_orders_streams
-            or not self._public_orders_streams[public_order_filter].is_running
+            cache_key not in self._public_orders_streams
+            or not self._public_orders_streams[cache_key].is_running
         ):
             try:
-                self._public_orders_streams[public_order_filter] = (
-                    GrpcStreamBroadcaster(
-                        f"electricity-trading-{public_order_filter}",
-                        lambda: self.stub.ReceivePublicOrderBookStream(
-                            electricity_trading_pb2.ReceivePublicOrderBookStreamRequest(
-                                filter=public_order_filter.to_pb(),
-                                start_time=start_time_utc,
-                                end_time=end_time_utc,
-                            ),
+                self._public_orders_streams[cache_key] = GrpcStreamBroadcaster(
+                    f"electricity-trading-{cache_key}",
+                    lambda: self.stub.ReceivePublicOrderBookStream(
+                        electricity_trading_pb2.ReceivePublicOrderBookStreamRequest(
+                            filter=public_order_filter.to_pb(),
+                            start_time=start_time_utc,
+                            end_time=end_time_utc,
                         ),
-                        lambda response: [
-                            PublicOrder.from_pb(public_order)
-                            for public_order in response.public_order_book_records
-                        ],
-                    )
+                    ),
+                    lambda response: [
+                        PublicOrder.from_pb(public_order)
+                        for public_order in response.public_order_book_records
+                    ],
                 )
             except grpc.RpcError as e:
                 _logger.exception("Error occurred while streaming public orders: %s", e)
                 raise
-        return self._public_orders_streams[public_order_filter]
+        return self._public_orders_streams[cache_key]