Fix a bug when retrieving all metrics for a sensor

When no metric filter was passed to `stream_sensor_data()` the transform
callback failed because the `metrics` argument wasn't passed when
calling `sensor_data_samples_from_proto()` internally, making the
gRPC streaming task stop with an unhandled exception.

This commit makes the `metrics` argument optional for
`sensor_data_samples_from_proto()` to fix that.

A test case with no metric filters is added too.

Signed-off-by: Leandro Lucarella <[email protected]>

Author: llucax

src/frequenz/client/microgrid/_sensor_proto.py

@@ -106,13 +106,14 @@ def sensor_from_proto_with_issues(
 
 def sensor_data_samples_from_proto(
     message: microgrid_pb2.ComponentData,
-    metrics: Set[sensor_pb2.SensorMetric.ValueType],
+    metrics: Set[sensor_pb2.SensorMetric.ValueType] | None = None,
 ) -> SensorDataSamples:
     """Convert a protobuf component data message to a sensor data object.
 
     Args:
         message: The protobuf message to convert.
-        metrics: A set of metrics to filter the samples.
+        metrics: If not `None`, only the specified metrics will be retrieved.
+            Otherwise all available metrics will be retrieved.
 
     Returns:
         The resulting `SensorDataSamples` object.
@@ -128,7 +129,7 @@ def sensor_data_samples_from_proto(
         metrics=[
             sensor_metric_sample_from_proto(ts, sample)
             for sample in message.sensor.data.sensor_data
-            if sample.sensor_metric in metrics
+            if metrics is None or sample.sensor_metric in metrics
         ],
         states=[sensor_state_sample_from_proto(ts, message.sensor)],
     )

tests/test_client.py

@@ -964,6 +964,57 @@ async def stream_data_impl(
     ]
 
 
+async def test_stream_sensor_data_all_metrics(
+    sensor201: microgrid_pb2.Component, client: _TestClient
+) -> None:
+    """Test successful streaming of sensor data."""
+    now = datetime.now(timezone.utc)
+
+    async def stream_data_impl(
+        *_: Any, **__: Any
+    ) -> AsyncIterator[microgrid_pb2.ComponentData]:
+        yield microgrid_pb2.ComponentData(
+            id=int(sensor201.id),
+            ts=conversion.to_timestamp(now),
+            sensor=sensor_pb2.Sensor(
+                state=sensor_pb2.State(
+                    component_state=sensor_pb2.ComponentState.COMPONENT_STATE_OK
+                ),
+                data=sensor_pb2.Data(
+                    sensor_data=[
+                        sensor_pb2.SensorData(
+                            value=1.0,
+                            sensor_metric=sensor_pb2.SensorMetric.SENSOR_METRIC_TEMPERATURE,
+                        ),
+                        sensor_pb2.SensorData(
+                            value=2.0,
+                            sensor_metric=sensor_pb2.SensorMetric.SENSOR_METRIC_PRESSURE,
+                        ),
+                    ],
+                ),
+            ),
+        )
+
+    client.mock_stub.StreamComponentData.side_effect = stream_data_impl
+    receiver = client.stream_sensor_data(SensorId(sensor201.id))
+    sample = await receiver.receive()
+
+    assert isinstance(sample, SensorDataSamples)
+    assert int(sample.sensor_id) == sensor201.id
+    assert sample.states == [
+        SensorStateSample(
+            sampled_at=now,
+            states=frozenset({SensorStateCode.ON}),
+            warnings=frozenset(),
+            errors=frozenset(),
+        )
+    ]
+    assert sample.metrics == [
+        SensorMetricSample(sampled_at=now, metric=SensorMetric.TEMPERATURE, value=1.0),
+        SensorMetricSample(sampled_at=now, metric=SensorMetric.PRESSURE, value=2.0),
+    ]
+
+
 async def test_stream_sensor_data_grpc_error(
     sensor201: microgrid_pb2.Component, caplog: pytest.LogCaptureFixture
 ) -> None: