Тесты на prepare_value (#24)

* Тесты на prepare_value

* Тест на prepare_value и енумы

Author: K1rL3s

aliceio/utils/funcs.py

@@ -1,50 +1,78 @@
 import datetime
 import json
 from enum import Enum
-from typing import Any, Callable, Protocol
+from typing import Any, Callable, Literal, Protocol, Union
 
 from aiohttp import JsonPayload
 
 from aliceio.dispatcher.event.bases import REJECTED, UNHANDLED
 from aliceio.types import InputFile
+from aliceio.types.base import AliceObject
 
 
 class PrepareValue(Protocol):  # pragma: no cover
-    def __call__(self, value: Any, files: dict[str, Any]) -> Any: ...
+    def __call__(
+        self,
+        value: Any,
+        files: dict[str, Any],
+        _dumps_json: Union[Callable[..., str], Literal[False]] = False,
+    ) -> Any: ...
 
 
 # Ключи, у которых значение = None, не пропускаются, потому что иначе не получится
 # установить None в значение хранилища состояний API Алисы
-def prepare_value(value: Any, files: dict[str, Any]) -> Any:
+def prepare_value(
+    value: Any,
+    files: dict[str, Any],
+    _dumps_json: Union[Callable[..., str], Literal[False]] = False,
+) -> Any:
     """Подготовка значения перед отправкой."""
     if value in (None, UNHANDLED, REJECTED):
         return None
     if isinstance(value, str):
         return value
     if isinstance(value, InputFile):
-        key = "file"
+        key = "file"  # aiogram: key = secrets.token_urlsafe(10)
         files[key] = value
         return f"attach://{key}"
     if isinstance(value, dict):
-        return {key: prepare_value(item, files=files) for key, item in value.items()}
+        value = {key: prepare_value(item, files=files) for key, item in value.items()}
+        if _dumps_json:
+            return _dumps_json(value)
+        return value
     if isinstance(value, list):
-        return [prepare_value(item, files=files) for item in value]
+        value = [prepare_value(item, files=files) for item in value]
+        if _dumps_json:
+            return _dumps_json(value)
+        return value
     if isinstance(value, datetime.timedelta):
         now = datetime.datetime.now()
         return str(round((now + value).timestamp()))
     if isinstance(value, datetime.datetime):
         return str(round(value.timestamp()))
     if isinstance(value, Enum):
         return prepare_value(value.value, files=files)
+    if isinstance(value, AliceObject):
+        return prepare_value(
+            value.model_dump(warnings=False),
+            files=files,
+            _dumps_json=_dumps_json,
+        )
+    if _dumps_json:
+        return _dumps_json(value)
     return value
 
 
+# TODO: В prepavre_value_fn не передаётся json_dumps, пофиксить?
 def build_json_payload(
     value: Any,
     prepare_value_fn: PrepareValue = prepare_value,
     json_dumps: Callable[..., str] = json.dumps,
 ) -> JsonPayload:
     return JsonPayload(
-        value=prepare_value_fn(value=value, files={}),
+        value=prepare_value_fn(
+            value=value,
+            files={},
+        ),
         dumps=json_dumps,
     )

aliceio/webhook/aiohttp_server/base.py

@@ -5,7 +5,6 @@
 
 from aiohttp import JsonPayload, web
 from aiohttp.abc import Application
-from pydantic import BaseModel
 
 from aliceio import Dispatcher, Skill
 from aliceio.dispatcher.event.bases import REJECTED, UNHANDLED
@@ -125,7 +124,4 @@ def _build_web_response(self, result: Any) -> web.Response:
         )
 
     def _build_json_response(self, result: Optional[AliceObject]) -> JsonPayload:
-        return build_json_payload(
-            value=result.model_dump() if isinstance(result, BaseModel) else result,
-            json_dumps=self.json_dumps,
-        )
+        return build_json_payload(value=result, json_dumps=self.json_dumps)

tests/test_api/test_client/test_session/test_base_session.py

@@ -2,21 +2,28 @@
 import json
 from collections.abc import AsyncGenerator
 from contextlib import AbstractAsyncContextManager
+from enum import Enum
 from typing import Any, Optional
 from unittest.mock import AsyncMock, patch
 
 import pytest
+from pytz import utc
 
 from aliceio import Skill
 from aliceio.client.alice import PRODUCTION, AliceAPIServer
 from aliceio.client.session.base import AliceType, BaseSession
+from aliceio.enums import CardType
 from aliceio.exceptions import AliceAPIError, ClientDecodeError
 from aliceio.methods import AliceMethod, Status
-from aliceio.types import PreQuota, Quota, SpaceStatus
+from aliceio.types import AnalyticEvent, PreQuota, Quota, SpaceStatus
 from aliceio.utils.funcs import prepare_value
 from tests.mocked.mocked_skill import MockedSkill
 
 
+class _TestEnum(Enum):
+    field = "fieldValue"
+
+
 class CustomSession(BaseSession):
     async def close(self):
         pass
@@ -78,6 +85,47 @@ def test_prepare_value_timedelta(self, skill: MockedSkill):
         value = prepare_value(datetime.timedelta(minutes=2), files={})
         assert isinstance(value, str)
 
+    @pytest.mark.parametrize(
+        "value,result",
+        [
+            [None, None],
+            ["text", "text"],
+            [CardType.BIG_IMAGE, "BigImage"],
+            [_TestEnum.field, "fieldValue"],
+            [42, "42"],
+            [True, "true"],
+            [["test"], '["test"]'],
+            [["test", ["test"]], '["test", ["test"]]'],
+            [[{"test": "pass", "spam": None}], '[{"test": "pass", "spam": null}]'],
+            [
+                {"test": "pass", "number": 42, "spam": None},
+                '{"test": "pass", "number": 42, "spam": null}',
+            ],
+            [
+                {"foo": {"test": "pass", "spam": None}},
+                '{"foo": {"test": "pass", "spam": null}}',
+            ],
+            [
+                datetime.datetime(
+                    year=2017,
+                    month=5,
+                    day=17,
+                    hour=4,
+                    minute=11,
+                    second=42,
+                    tzinfo=utc,
+                ),
+                "1494994302",
+            ],
+            [
+                {"analytic_event": AnalyticEvent(name="John", value={"key": "door"})},
+                '{"analytic_event": {"name": "John", "value": {"key": "door"}}}',
+            ],
+        ],
+    )
+    def test_prepare_value(self, value: Any, result: str, skill: MockedSkill):
+        assert prepare_value(value, files={}, _dumps_json=json.dumps) == result
+
     def test_check_response_json_decode_error(self):
         session = CustomSession()
         skill = MockedSkill()