Integrate BaseClient into reporting client

Signed-off-by: Flora <[email protected]>

Author: flora-hofmann-frequenz

RELEASE_NOTES.md

@@ -10,7 +10,7 @@
 
 ## New Features
 
-<!-- Here goes the main new features and examples or instructions on how to use them -->
+* Integration of the base client v0.5
 
 ## Bug Fixes
 

pyproject.toml

@@ -33,6 +33,7 @@ dependencies = [
   "grpcio >= 1.54.2, < 2",
   "grpcio-tools >= 1.54.2, < 2",
   "protobuf >= 4.25.3, < 6",
+  "frequenz-client-base[grpcio] >= 0.5.0, < 0.6.0",
 ]
 dynamic = ["version"]
 

src/frequenz/client/reporting/_client.py

@@ -7,9 +7,8 @@
 from collections.abc import AsyncIterator, Iterator
 from dataclasses import dataclass
 from datetime import datetime
-from typing import Any, cast
+from typing import cast
 
-import grpc
 import grpc.aio as grpcaio
 
 # pylint: disable=no-name-in-module
@@ -27,11 +26,10 @@
 )
 from frequenz.api.reporting.v1.reporting_pb2 import TimeFilter as PBTimeFilter
 from frequenz.api.reporting.v1.reporting_pb2_grpc import ReportingStub
+from frequenz.client.base.client import BaseApiClient
 from frequenz.client.common.metric import Metric
 from google.protobuf.timestamp_pb2 import Timestamp as PBTimestamp
 
-# pylint: enable=no-name-in-module
-
 MetricSample = namedtuple(
     "MetricSample", ["timestamp", "microgrid_id", "component_id", "metric", "value"]
 )
@@ -98,20 +96,18 @@ def __iter__(self) -> Iterator[MetricSample]:
                 )
 
 
-class ReportingApiClient:
+class ReportingApiClient(BaseApiClient[ReportingStub, grpcaio.Channel]):
     """A client for the Reporting service."""
 
-    def __init__(self, service_address: str, key: str | None = None) -> None:
+    def __init__(self, server_url: str, key: str | None = None) -> None:
         """Create a new Reporting client.
 
         Args:
-            service_address: The address of the Reporting service.
+            server_url: The URL of the Reporting service.
             key: The API key for the authorization.
         """
-        self._grpc_channel = grpcaio.secure_channel(
-            service_address, grpc.ssl_channel_credentials()
-        )
-        self._stub = ReportingStub(self._grpc_channel)
+        super().__init__(server_url, ReportingStub, grpcaio.Channel)
+
         self._metadata = (("key", key),) if key else ()
 
     # pylint: disable=too-many-arguments
@@ -244,48 +240,15 @@ def dt2ts(dt: datetime) -> PBTimestamp:
         try:
             stream = cast(
                 AsyncIterator[PBReceiveMicrogridComponentsDataStreamResponse],
-                self._stub.ReceiveMicrogridComponentsDataStream(
+                self.stub.ReceiveMicrogridComponentsDataStream(
                     request, metadata=self._metadata
                 ),
             )
-            # grpc.aio is missing types and mypy thinks this is not
-            # async iterable, but it is.
             async for response in stream:
                 if not response:
                     break
-
                 yield ComponentsDataBatch(response)
 
         except grpcaio.AioRpcError as e:
             print(f"RPC failed: {e}")
             return
-
-    async def close(self) -> None:
-        """Close the client and cancel any pending requests immediately."""
-        await self._grpc_channel.close(grace=None)
-
-    async def __aenter__(self) -> "ReportingApiClient":
-        """Enter the async context."""
-        return self
-
-    async def __aexit__(
-        self,
-        _exc_type: type[BaseException] | None,
-        _exc_val: BaseException | None,
-        _exc_tb: Any | None,
-    ) -> bool | None:
-        """
-        Exit the asynchronous context manager.
-
-        Note that exceptions are not handled here, but are allowed to propagate.
-
-        Args:
-            _exc_type: Type of exception raised in the async context.
-            _exc_val: Exception instance raised.
-            _exc_tb: Traceback object at the point where the exception occurred.
-
-        Returns:
-            None, allowing any exceptions to propagate.
-        """
-        await self.close()
-        return None

tests/test_client_reporting.py

@@ -2,27 +2,25 @@
 # Copyright © 2024 Frequenz Energy-as-a-Service GmbH
 
 """Tests for the frequenz.client.reporting package."""
-from typing import Generator
-from unittest.mock import ANY, MagicMock, patch
+from unittest.mock import MagicMock, patch
 
+import grpc.aio as grpcaio
 import pytest
+from frequenz.api.reporting.v1.reporting_pb2_grpc import ReportingStub
+from frequenz.client.base.client import BaseApiClient
 
 from frequenz.client.reporting import ReportingApiClient
 from frequenz.client.reporting._client import ComponentsDataBatch
 
 
-@pytest.fixture
-def mock_channel() -> Generator[MagicMock, None, None]:
-    """Fixture for grpc.aio.secure_channel."""
-    with patch("grpc.aio.secure_channel") as mock:
-        yield mock
-
-
 @pytest.mark.asyncio
-async def test_client_initialization(mock_channel: MagicMock) -> None:
-    """Test that the client initializes the channel."""
-    client = ReportingApiClient("localhost:50051")  # noqa: F841
-    mock_channel.assert_called_once_with("localhost:50051", ANY)
+async def test_client_initialization() -> None:
+    """Test that the client initializes the BaseApiClient with grpcaio.Channel."""
+    with patch.object(BaseApiClient, "__init__", return_value=None) as mock_base_init:
+        client = ReportingApiClient("gprc://localhost:50051")  # noqa: F841
+        mock_base_init.assert_called_once_with(
+            "gprc://localhost:50051", ReportingStub, grpcaio.Channel
+        )
 
 
 def test_components_data_batch_is_empty_true() -> None: