feat(http-api): Make list_rules an async generator

Author: rnovatorov

src/enapter/cli/http/api/rule_list_command.py

@@ -21,6 +21,6 @@ def register(parent: cli.Subparsers) -> None:
     async def run(args: argparse.Namespace) -> None:
         """Run the command."""
         async with http.api.Client(http.api.Config.from_env()) as client:
-            rules = await client.rule_engine.list_rules(site_id=args.site_id)
-            for rule in rules:
-                print(json.dumps(rule.to_dto()))
+            async with client.rule_engine.list_rules(site_id=args.site_id) as stream:
+                async for rule in stream:
+                    print(json.dumps(rule.to_dto()))

src/enapter/http/api/rule_engine/client.py

@@ -1,10 +1,11 @@
 """Rule Engine HTTP API client."""
 
 import time
-from typing import Any, Callable
+from typing import Any, AsyncGenerator, Callable
 
 import httpx
 
+from enapter import async_
 from enapter.http import api
 
 from .engine import Engine
@@ -45,12 +46,16 @@ async def resume(self, site_id: str | None = None) -> Engine:
         await api.check_error(response)
         return Engine.from_dto(response.json()["engine"])
 
-    async def list_rules(self, site_id: str | None = None) -> list[Rule]:
+    @async_.generator
+    async def list_rules(
+        self, site_id: str | None = None
+    ) -> AsyncGenerator[Rule, None]:
         """List all rules."""
         url = f"{self._url(site_id)}/rules"
         response = await self._client.get(url)
         await api.check_error(response)
-        return [Rule.from_dto(dto) for dto in response.json()["rules"]]
+        for dto in response.json()["rules"]:
+            yield Rule.from_dto(dto)
 
     async def get_rule(self, rule_id: str, site_id: str | None = None) -> Rule:
         """Get a single rule."""

tests/unit/test_http/test_api/test_rule_engine/test_client.py

@@ -113,7 +113,10 @@ async def test_list_rules(client, mock_httpx_client):
     }
     mock_httpx_client.get = AsyncMock(return_value=mock_response)
 
-    rules = await client.list_rules(site_id="site_123")
+    rules = []
+    async with client.list_rules(site_id="site_123") as stream:
+        async for rule in stream:
+            rules.append(rule)
 
     assert len(rules) == 2
     assert rules[0].id == "rule_1"