buz 2.16.0__tar.gz → 2.17.0rc2__tar.gz

{buz-2.16.0 → buz-2.17.0rc2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: buz
-Version: 2.16.0
+Version: 2.17.0rc2
 Summary: Buz is a set of light, simple and extensible implementations of event, command and query buses.
 License: MIT
 Author: Luis Pintado Lozano

{buz-2.16.0 → buz-2.17.0rc2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "buz"
-version = "2.16.0"
+version = "2.17.0-rc2"
 description = "Buz is a set of light, simple and extensible implementations of event, command and query buses."
 readme = "README.md"
 authors = [

{buz-2.16.0 → buz-2.17.0rc2}/src/buz/event/transactional_outbox/event_to_outbox_record_translator.py

@@ -10,9 +10,11 @@ class EventToOutboxRecordTranslator:
         payload = dataclasses.asdict(event)
         payload.pop("id")
         payload.pop("created_at")
+        payload.pop("metadata")
         return OutboxRecord(
             event_id=UUID(event.id),
             event_fqn=event.fqn(),
             created_at=event.parsed_created_at(),
             event_payload=payload,
+            event_metadata=dict(event.metadata),
         )

{buz-2.16.0 → buz-2.17.0rc2}/src/buz/event/transactional_outbox/outbox_record.py

@@ -12,6 +12,7 @@ class OutboxRecord:  # type: ignore[misc]
     event_fqn: str
     event_payload: dict[str, Any]  # type: ignore[misc]
     created_at: datetime
+    event_metadata: Optional[dict[str, Any]] = None
     delivered_at: Optional[datetime] = None
     delivery_errors: int = 0
     delivery_paused_at: Optional[datetime] = None

{buz-2.16.0 → buz-2.17.0rc2}/src/buz/event/transactional_outbox/outbox_record_to_event_translator.py

@@ -16,6 +16,7 @@ class OutboxRecordToEventTranslator:
             event_klass.restore(
                 id=str(outbox_record.event_id),
                 created_at=outbox_record.parsed_created_at(),
+                metadata=outbox_record.event_metadata,
                 **outbox_record.event_payload,
             ),
         )

{buz-2.16.0 → buz-2.17.0rc2}/src/buz/kafka/infrastructure/cdc/cdc_payload.py

@@ -1,4 +1,5 @@
 from dataclasses import dataclass
+from typing import Optional
 
 
 @dataclass(frozen=True)
@@ -9,6 +10,7 @@ class CDCPayload:
     event_id: str  # uuid
     created_at: str
     event_fqn: str
+    event_metadata: Optional[str] = None  # json encoded
 
     def validate(self) -> None:
         if not isinstance(self.payload, str):
@@ -19,6 +21,8 @@ class CDCPayload:
             raise ValueError("The created_at value is not a value")
         if not isinstance(self.event_fqn, str):
             raise ValueError("The event_fqn value is not a valid value")
+        if self.event_metadata is not None and not isinstance(self.event_metadata, str):
+            raise ValueError("The event_metadata value is not a valid value")
 
     def __post_init__(self) -> None:
         self.validate()

{buz-2.16.0 → buz-2.17.0rc2}/src/buz/kafka/infrastructure/cdc/cdc_schema.py

@@ -22,6 +22,13 @@ def generate_cdc_schema(message: Message) -> dict:
                 "optional": False,
                 "field": "event_fqn",
             },
+            {
+                "type": "string",
+                "optional": True,
+                "name": "io.debezium.data.Json",
+                "version": 1,
+                "field": "event_metadata",
+            },
             {
                 "type": "string",
                 "optional": False,

{buz-2.16.0 → buz-2.17.0rc2}/src/buz/kafka/infrastructure/deserializers/implementations/cdc/cdc_record_bytes_to_event_deserializer.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from datetime import datetime
-from typing import TypeVar, Type, Generic
+from typing import Optional, TypeVar, Type, Generic
 
 import orjson
 from dacite import from_dict
@@ -29,6 +29,7 @@ class CDCRecordBytesToEventDeserializer(BytesToMessageDeserializer[Event], Gener
             return self.__event_class.restore(
                 id=cdc_payload.event_id,
                 created_at=self.__get_created_at_in_event_format(cdc_payload.created_at),
+                metadata=self.__deserialize_event_metadata(cdc_payload.event_metadata),
                 **orjson.loads(cdc_payload.payload),
             )
         except Exception as exception:
@@ -47,3 +48,8 @@ class CDCRecordBytesToEventDeserializer(BytesToMessageDeserializer[Event], Gener
             raise ValueError("The provided payload value is not valid")
 
         return from_dict(CDCPayload, payload)
+
+    def __deserialize_event_metadata(self, event_metadata: Optional[str]) -> dict:
+        if event_metadata is None:
+            return {}
+        return orjson.loads(event_metadata)

{buz-2.16.0 → buz-2.17.0rc2}/src/buz/kafka/infrastructure/serializers/implementations/cdc_record_bytes_to_event_serializer.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 from dataclasses import asdict
 from datetime import datetime
+from typing import Optional
 
 from buz.event import Event
 from buz.kafka.infrastructure.cdc.cdc_message import CDCMessage, CDCPayload
@@ -21,6 +22,7 @@ class CDCRecordBytesToEventSerializer(ByteSerializer):
                 created_at=self.__adapt_created_to_cdc_format(data.created_at),
                 event_fqn=data.fqn(),
                 payload=self.__serialize_payload(data),
+                event_metadata=self.__serialize_event_metadata(data),
             ),
             schema=generate_cdc_schema(data),
         )
@@ -31,8 +33,11 @@ class CDCRecordBytesToEventSerializer(ByteSerializer):
         return created_at_datetime.strftime(CDCPayload.DATE_TIME_FORMAT)
 
     def __serialize_payload(self, event: Event) -> str:
-        # Remove id and created at, because Transactional outbox is not adding them
         payload = asdict(event)
         del payload["id"]
         del payload["created_at"]
+        del payload["metadata"]
         return self.__json_serializer.serialize_as_json(payload)
+
+    def __serialize_event_metadata(self, event: Event) -> Optional[str]:
+        return self.__json_serializer.serialize_as_json(event.metadata)  # type: ignore[arg-type]

{buz-2.16.0 → buz-2.17.0rc2}/src/buz/kafka/infrastructure/serializers/implementations/json_byte_serializer.py

@@ -15,7 +15,9 @@ ALLOWED_SERIALIZABLE_DICTIONARY_KEYS = str
 
 JSON_SERIALIZABLE_VALUE = Union[PRIMITIVES, list[PRIMITIVES], dict[ALLOWED_SERIALIZABLE_DICTIONARY_KEYS, PRIMITIVES]]
 
-JSON_SERIALIZABLE = dict[ALLOWED_SERIALIZABLE_DICTIONARY_KEYS, Union[JSON_SERIALIZABLE_VALUE, "JSON_SERIALIZABLE"]]
+JSON_SERIALIZABLE = Union[
+    dict[ALLOWED_SERIALIZABLE_DICTIONARY_KEYS, Union[JSON_SERIALIZABLE_VALUE, "JSON_SERIALIZABLE"]]
+]
 
 
 class JSONByteSerializer(ByteSerializer[JSON_SERIALIZABLE]):

{buz-2.16.0 → buz-2.17.0rc2}/src/buz/message.py

@@ -8,6 +8,8 @@ from typing_extensions import Self
 
 from uuid_utils.compat import uuid7
 
+from buz.metadata import Metadata
+
 
 @dataclass(frozen=True)
 class Message(ABC):
@@ -17,6 +19,7 @@ class Message(ABC):
     created_at: str = field(
         init=False, default_factory=lambda: datetime.strftime(datetime.now(), Message.DATE_TIME_FORMAT)
     )
+    metadata: Metadata = field(init=False, default_factory=lambda: Metadata())
 
     @classmethod
     def fqn(cls) -> str:
@@ -26,11 +29,14 @@ class Message(ABC):
     def restore(cls, **kwargs: Any) -> Self:
         message_id = kwargs.pop("id")
         created_at = kwargs.pop("created_at")
+        metadata_kwargs = kwargs.pop("metadata", None) or {}
+        metadata = Metadata(**metadata_kwargs)
 
         instance = cls.__from_dict(kwargs)  # type: ignore
 
         object.__setattr__(instance, "id", message_id)
         object.__setattr__(instance, "created_at", created_at)
+        object.__setattr__(instance, "metadata", metadata)
         return instance
 
     @classmethod
@@ -61,3 +67,6 @@ class Message(ABC):
 
     def parsed_created_at(self) -> datetime:
         return datetime.strptime(self.created_at, self.DATE_TIME_FORMAT)
+
+    def add_metadata(self, metadata: Metadata) -> None:
+        self.metadata.update(metadata)

buz-2.17.0rc2/src/buz/metadata.py

@@ -0,0 +1,8 @@
+from typing import Any, TypedDict
+
+
+class Metadata(TypedDict):
+    def __init__(self, **kwargs: dict[str, Any]) -> None:  # type: ignore[misc]
+        super().__init__()
+        for key, value in kwargs.items():
+            setattr(self, key, value)