normalize business event attributes

changes/next_release.md

@@ -0,0 +1,2 @@
+
+- Added normalization to business event attributes.

ffun/ffun/core/logging.py

@@ -7,6 +7,7 @@
 import logging
 import time
 import uuid
+from collections import abc
 from typing import Any, Callable, ContextManager, Iterable, Iterator, Protocol, TypeVar
 
 import pydantic_settings
@@ -170,6 +171,9 @@ def measure_block_time(  # type: ignore
     ) -> ContextManager[dict[str, LabelValue]]:
         pass
 
+    def _normalize_value(self, value: Any) -> Any:
+        pass
+
     def business_event(self, event: str, user_id: UserId | None, **attributes: Any) -> Any:
         pass
 
@@ -210,9 +214,25 @@ class BusinessBoundLoggerMixin:
     This mixin is required to work with business events in 100% the same way as with logs.
     """
 
+    def _normalize_value(self, value: Any) -> Any:
+        if isinstance(value, int | str | float | None):
+            return value
+
+        if isinstance(value, abc.Mapping):
+            return {str(k): self._normalize_value(v) for k, v in value.items()}
+
+        if isinstance(value, abc.Sequence):
+            return [self._normalize_value(v) for v in value]
+
+        return str(value)
+
     def business_event(self, event: str, user_id: UserId | None, **attributes: LabelValue) -> Any:
         return self.info(  # type: ignore
-            event, b_kind="event", b_user_id=user_id, b_uid=uuid.uuid4(), b_attributes=attributes
+            event,
+            b_kind="event",
+            b_user_id=str(user_id),
+            b_uid=str(uuid.uuid4()),
+            b_attributes=self._normalize_value(attributes),
         )
 
 

ffun/ffun/core/tests/helpers.py

@@ -232,6 +232,10 @@ def capture_logs() -> Generator[list[EventDict], None, None]:
 def assert_logs_has_business_event(  # noqa: CCR001
     logs: list[MutableMapping[str, Any]], name: str, user_id: UserId | None, **atributes: Any
 ) -> None:
+
+    if user_id is not None:
+        user_id = str(user_id)  # type: ignore
+
     for record in logs:
 
         if not (record.get("b_kind") == "event" and record["event"] == name and record.get("b_user_id") == user_id):
@@ -240,7 +244,10 @@ def assert_logs_has_business_event(  # noqa: CCR001
         assert "b_uid" in record, "b_uid not found in record"
 
         for key, value in atributes.items():
-            assert record["b_attributes"][key] == value, f"Key {key} = {record.get(key)} not equal to expected {value}"
+            assert key in record["b_attributes"], f"Key {key} not found in record"
+            assert (
+                record["b_attributes"][key] == value
+            ), f"Key {key} = {record["b_attributes"][key]!r} not equal to expected {value!r}"
 
         break
     else:

ffun/ffun/core/tests/test_logging.py

@@ -1,5 +1,6 @@
 import asyncio
 import uuid
+from typing import Any
 
 import pytest
 
@@ -141,14 +142,14 @@ def test_business_event(self) -> None:
                 "module": "ffun.core.tests.test_logging",
                 "event": "my_event",
                 "log_level": "info",
-                "b_user_id": user_id,
+                "b_user_id": str(user_id),
                 "b_kind": "event",
                 "b_uid": logs[0]["b_uid"],
                 "b_attributes": {"a": "b"},
             }
         ]
 
-        assert isinstance(logs[0]["b_uid"], uuid.UUID)
+        assert uuid.UUID(logs[0]["b_uid"])
 
         assert_logs_has_business_event(logs, "my_event", user_id=user_id, a="b")
         assert_logs_has_business_event(logs, "my_event", user_id=user_id)
@@ -178,6 +179,21 @@ def test_business_event__helper_expected_to_fail_because_event_name(self) -> Non
 
         assert_logs_has_business_event(logs, "wrong_event", user_id=user_id, a="b")
 
+    @pytest.mark.parametrize(
+        "in_attrs, expected",
+        [
+            ({}, {}),
+            ({"a": "b", "c": 1, 13: 2.5, "e": None}, {"a": "b", "c": 1, "13": 2.5, "e": None}),
+            ({"a": uuid.UUID("12345678-1234-5678-1234-567812345678")}, {"a": "12345678-1234-5678-1234-567812345678"}),
+            (
+                {"a": {"b": {"c": 1}, "d": [2, {"e": 3}]}, "f": [4, None, 6]},
+                {"a": {"b": {"c": 1}, "d": [2, {"e": 3}]}, "f": [4, None, 6]},
+            ),
+        ],
+    )
+    def test_normalize_value(self, in_attrs: dict[str, Any], expected: dict[str, Any]) -> None:
+        assert logger._normalize_value(in_attrs) == expected
+
 
 class TestIdentityConstructor:
 

ffun/ffun/feeds_links/tests/test_operations.py

@@ -25,7 +25,7 @@ async def test_add_link(self, internal_user_id: UserId, saved_feed_id: FeedId) -
             async with TableSizeDelta("fl_links", delta=1):
                 await add_link(internal_user_id, saved_feed_id)
 
-        assert_logs_has_business_event(logs, "feed_linked", user_id=internal_user_id, feed_id=saved_feed_id)
+        assert_logs_has_business_event(logs, "feed_linked", user_id=internal_user_id, feed_id=str(saved_feed_id))
 
         links = await get_linked_feeds(internal_user_id)
 
@@ -90,7 +90,7 @@ async def test_remove_link(self, internal_user_id: UserId, saved_feed_id: FeedId
             async with TableSizeDelta("fl_links", delta=-1):
                 await remove_link(internal_user_id, saved_feed_id)
 
-        assert_logs_has_business_event(logs, "feed_unlinked", user_id=internal_user_id, feed_id=saved_feed_id)
+        assert_logs_has_business_event(logs, "feed_unlinked", user_id=internal_user_id, feed_id=str(saved_feed_id))
 
         links = await get_linked_feeds(internal_user_id)
 

ffun/ffun/markers/tests/test_operations.py

@@ -32,7 +32,7 @@ async def test_set_marker(self, internal_user_id: UserId, new_entry: Entry) -> N
                 await set_marker(internal_user_id, Marker.read, new_entry.id)
 
         assert_logs_has_business_event(
-            logs, "marker_set", user_id=internal_user_id, entry_id=new_entry.id, marker=Marker.read
+            logs, "marker_set", user_id=internal_user_id, entry_id=str(new_entry.id), marker=Marker.read
         )
 
     @pytest.mark.asyncio
@@ -57,7 +57,7 @@ async def test_remove_marker(self, internal_user_id: UserId, new_entry: Entry) -
                 await remove_marker(internal_user_id, Marker.read, new_entry.id)
 
         assert_logs_has_business_event(
-            logs, "marker_removed", user_id=internal_user_id, entry_id=new_entry.id, marker=Marker.read
+            logs, "marker_removed", user_id=internal_user_id, entry_id=str(new_entry.id), marker=Marker.read
         )
 
     @pytest.mark.asyncio

ffun/ffun/scores/tests/test_operations.py

@@ -32,7 +32,7 @@ async def test_create_new_rule(self, internal_user_id: UserId, three_tags_ids: t
             logs,
             "rule_created",
             user_id=internal_user_id,
-            rule_id=created_rule.id,
+            rule_id=str(created_rule.id),
             tags=list(three_tags_ids),
             score=13,
         )
@@ -74,7 +74,7 @@ async def test_update_scores_of_existed_rule(
             logs,
             "rule_updated",
             user_id=internal_user_id,
-            rule_id=updated_rule.id,
+            rule_id=str(updated_rule.id),
             tags=list(three_tags_ids),
             score=17,
         )
@@ -125,7 +125,7 @@ async def test_delete_rule(
             async with TableSizeDelta("s_rules", delta=-1):
                 await operations.delete_rule(internal_user_id, rule_to_delete.id)
 
-        assert_logs_has_business_event(logs, "rule_deleted", user_id=internal_user_id, rule_id=rule_to_delete.id)
+        assert_logs_has_business_event(logs, "rule_deleted", user_id=internal_user_id, rule_id=str(rule_to_delete.id))
 
         rules = await domain.get_rules(internal_user_id)
 
@@ -179,7 +179,7 @@ async def test_update_rule(self, internal_user_id: UserId, three_tags_ids: tuple
             logs,
             "rule_updated",
             user_id=internal_user_id,
-            rule_id=rule_to_update.id,
+            rule_id=str(rule_to_update.id),
             tags=list(three_tags_ids[:2]),
             score=17,
         )