Refactor to reduce the amount of calls to the component data cache

Signed-off-by: Sahas Subramanian <[email protected]>

Author: shsms

src/frequenz/sdk/actor/power_distributing/power_distributing.py

@@ -226,20 +226,18 @@ def __init__(
             bat_id: None for bat_id, _ in self._bat_inv_map.items()
         }
 
-    def _get_bounds(self, batteries: abc.Set[int], include_broken: bool) -> PowerBounds:
+    def _get_bounds(
+        self,
+        pairs_data: list[InvBatPair],
+    ) -> PowerBounds:
         """Get power bounds for given batteries.
 
         Args:
-            batteries: List of batteries
-            include_broken: whether all batteries in the batteries set in the
-                request must be used regardless the status.
+            pairs_data: list of battery and adjacent inverter data pairs.
 
         Returns:
             Power bounds for given batteries.
         """
-        pairs_data: List[InvBatPair] = self._get_components_data(
-            batteries, include_broken
-        )
         return PowerBounds(
             inclusion_lower=sum(
                 max(
@@ -352,11 +350,6 @@ async def run(self) -> None:
         await asyncio.sleep(self._wait_for_data_sec)
 
         async for request in self._requests_receiver:
-            error = self._check_request(request)
-            if error:
-                await self._send_result(request.namespace, error)
-                continue
-
             try:
                 pairs_data: List[InvBatPair] = self._get_components_data(
                     request.batteries, request.include_broken_batteries
@@ -374,6 +367,11 @@ async def run(self) -> None:
                 )
                 continue
 
+            error = self._check_request(request, pairs_data)
+            if error:
+                await self._send_result(request.namespace, error)
+                continue
+
             try:
                 distribution = self._get_power_distribution(request, pairs_data)
             except ValueError as err:
@@ -497,11 +495,16 @@ def _get_power_distribution(
 
         return result
 
-    def _check_request(self, request: Request) -> Optional[Result]:
+    def _check_request(
+        self,
+        request: Request,
+        pairs_data: List[InvBatPair],
+    ) -> Optional[Result]:
         """Check whether the given request if correct.
 
         Args:
             request: request to check
+            pairs_data: list of battery and adjacent inverter data pairs.
 
         Returns:
             Result for the user if the request is wrong, None otherwise.
@@ -517,7 +520,7 @@ def _check_request(self, request: Request) -> Optional[Result]:
                 )
                 return Error(request=request, msg=msg)
 
-        bounds = self._get_bounds(request.batteries, request.include_broken_batteries)
+        bounds = self._get_bounds(pairs_data)
         if request.adjust_power:
             # Automatic power adjustments can only bring down the requested power down
             # to the inclusion bounds.

tests/actor/test_power_distributing.py

@@ -397,7 +397,7 @@ async def test_power_distributor_invalid_battery_id(
         result: Result = done.pop().result()
         assert isinstance(result, Error)
         assert result.request == request
-        err_msg = re.search(r"^No battery 100, available batteries:", result.msg)
+        err_msg = re.search(r"No battery 100, available batteries:", result.msg)
         assert err_msg is not None
 
     async def test_power_distributor_one_user_adjust_power_consume(