buz 2.16.0__py3-none-any.whl → 2.17.0rc2__py3-none-any.whl

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/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/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/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/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/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/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/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/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/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)

{buz-2.16.0.dist-info → buz-2.17.0rc2.dist-info}/METADATA

@@ -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.dist-info → buz-2.17.0rc2.dist-info}/RECORD

@@ -121,18 +121,18 @@ buz/event/sync/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3h
 buz/event/sync/models/sync_delivery_context.py,sha256=LHjrS6gV-19NEKwtAXVmefjPd-Dsp_Ym8RZb84T3lm8,190
 buz/event/sync/sync_event_bus.py,sha256=LTJHNKy8LrbygO343AA4Zt_hmgTP9uY6TLdjKs8LuHM,1821
 buz/event/transactional_outbox/__init__.py,sha256=k8ZBWCi12pWKXchHfgW_Raw4sVR8XkBLuPNW9jB9X2k,1381
-buz/event/transactional_outbox/event_to_outbox_record_translator.py,sha256=oSn1iQuW-cZLvlXYIJPnSwm3JYUwGMm9f1pqnlF0cJI,534
+buz/event/transactional_outbox/event_to_outbox_record_translator.py,sha256=d20JOeKIrCcpPEV66TzWiQmYqoyZGyL7J1ys0dUfHFs,615
 buz/event/transactional_outbox/fqn_to_event_mapper.py,sha256=ujcq6CfYqRJtM8f3SEEltbWN0Ru7NM5JfrbNdh4nvhQ,773
 buz/event/transactional_outbox/outbox_criteria/__init__.py,sha256=_9YjtbyYdqvDKEAwSQUyOn46Fc2pSNzTl2I7AqisEoc,594
 buz/event/transactional_outbox/outbox_criteria/deliverable_records_outbox_criteria_factory.py,sha256=vnaf6OPBAiw78RJZ8iOtaISbvuDIj4gN31aR-5k3BL8,347
 buz/event/transactional_outbox/outbox_criteria/outbox_criteria.py,sha256=HlD7tt3V-qVdPrq4H0idvyDnP7ncD0ZYQJ_XkwLNg-o,695
 buz/event/transactional_outbox/outbox_criteria/outbox_criteria_factory.py,sha256=XvqOfd7coi2veXyAvAthIBYRxS0Gpfb70nnkq9igvVM,220
 buz/event/transactional_outbox/outbox_criteria/outbox_sorting_criteria.py,sha256=-ckCLHvHlkuabI0TZ4Tw-qAQhU1hFLAgCOwuvIs_vpI,89
-buz/event/transactional_outbox/outbox_record.py,sha256=r8V8eQpuyS5UMS8r7viR2Z-mmEq-ZiakhO7f8TApd5E,1151
+buz/event/transactional_outbox/outbox_record.py,sha256=0lK9cG0wmP-t9JD8erxtcFFH9VoqXclRox3VIp-iSo8,1203
 buz/event/transactional_outbox/outbox_record_finder/__init__.py,sha256=HdW8GTIaxYExlUWeXugFmkRDyHcBiOlAVwh17dpPOfQ,344
 buz/event/transactional_outbox/outbox_record_finder/outbox_record_stream_finder.py,sha256=RjCetETAggQ5arXI4Terpyvh7xfz0eXXZon2-C1gXgw,239
 buz/event/transactional_outbox/outbox_record_finder/polling_outbox_record_stream_finder.py,sha256=qdCsqPQaS6cJ7li0veA2bY17iUG7fd84MzIywG7cPHw,1078
-buz/event/transactional_outbox/outbox_record_to_event_translator.py,sha256=StGyBfJsvRP9nJGckxufO2zVAd8xNIjdLVlfCZ2WAd4,746
+buz/event/transactional_outbox/outbox_record_to_event_translator.py,sha256=NIu4HpuRwA8-qW_qjTEIxNd681uRMtW-cueWNZL9oyI,801
 buz/event/transactional_outbox/outbox_record_validation/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 buz/event/transactional_outbox/outbox_record_validation/abstract_outbox_record_validator.py,sha256=brOrVum-1bOTU-mTXqQ1WdaPzoVJdQa58sSPQ3U0XcY,610
 buz/event/transactional_outbox/outbox_record_validation/outbox_record_size_not_allowed_exception.py,sha256=kHvQXgYwJbvF3ZW558NzbdydqsuggnDCcjgesi0G9W8,749
@@ -179,13 +179,13 @@ buz/kafka/infrastructure/aiokafka/translators/__init__.py,sha256=47DEQpj8HBSa-_T
 buz/kafka/infrastructure/aiokafka/translators/consumer_initial_offset_position_translator.py,sha256=WmxkQfoXeTy9mIJtGGhM0eDKeQxhcJczeVAGCbtonVI,617
 buz/kafka/infrastructure/cdc/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 buz/kafka/infrastructure/cdc/cdc_message.py,sha256=Cpv2nA19SG3HZGBLH-wIJbuokzTTZKT_HNFm1VwGSk4,585
-buz/kafka/infrastructure/cdc/cdc_payload.py,sha256=tQ_HdiREkORHlDoQQraj-KQj0x5MRuV8vP-C4x3cgHY,793
-buz/kafka/infrastructure/cdc/cdc_schema.py,sha256=JVSj6MSWNh2aaoWp1LL8UNJtjBvKggoBgMtOOT0vkQQ,940
+buz/kafka/infrastructure/cdc/cdc_payload.py,sha256=0dIsni7Z_Cy625op5SCAW3PLSJ1mBA9ty7LYP-aLUa4,1045
+buz/kafka/infrastructure/cdc/cdc_schema.py,sha256=s6Ab0Ccztnl63_jjZC1xXxsmE4ajr6KtkDDyEm_ssAU,1159
 buz/kafka/infrastructure/deserializers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 buz/kafka/infrastructure/deserializers/byte_deserializer.py,sha256=4fc6t-zvcFx6F5eoyEixH2uN0cM6aB0YRGwowIzz1RA,211
 buz/kafka/infrastructure/deserializers/bytes_to_message_deserializer.py,sha256=r40yq67DIElPi6ClmElbtR3VGrG2grNwgwuflXWOh20,345
 buz/kafka/infrastructure/deserializers/implementations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-buz/kafka/infrastructure/deserializers/implementations/cdc/cdc_record_bytes_to_event_deserializer.py,sha256=iMTx9zI_QzHcHvCbpfUkq6Hp67O_LXK5iYE1nzt_mqA,1913
+buz/kafka/infrastructure/deserializers/implementations/cdc/cdc_record_bytes_to_event_deserializer.py,sha256=JwtO0K1uJ1RmCw1Dd8rspPGBI-S-9j08GfczPXnN00s,2196
 buz/kafka/infrastructure/deserializers/implementations/cdc/not_valid_cdc_message_exception.py,sha256=hgLLwTcC-C2DuJSOWUhmQsrd1bO9I1469869IqfAPOk,414
 buz/kafka/infrastructure/deserializers/implementations/json_byte_deserializer.py,sha256=L4b164-KweiQUwyRONhTMIGnAz48UPk0btLqjGOTNdk,373
 buz/kafka/infrastructure/deserializers/implementations/json_bytes_to_message_deserializer.py,sha256=YwugXkmOudMNtkVfCC4BFe3pFVpbM8rAL9bT88bZMRk,756
@@ -200,8 +200,8 @@ buz/kafka/infrastructure/kafka_python/kafka_python_producer.py,sha256=DkqqLSSXHB
 buz/kafka/infrastructure/kafka_python/translators/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 buz/kafka/infrastructure/kafka_python/translators/consumer_initial_offset_position_translator.py,sha256=hJ48_eyMcnbFL_Y5TOiMbGXrQSryuKk9CvP59MdqNOY,620
 buz/kafka/infrastructure/serializers/byte_serializer.py,sha256=T83sLdX9V5Oh1mzjRwHi_1DsTFI7KefFj7kmnz7JVy4,207
-buz/kafka/infrastructure/serializers/implementations/cdc_record_bytes_to_event_serializer.py,sha256=Cw6kbzCMHC2PwHf6DNCIKZB2H-WCEZ-HeIDNxQbkTow,1601
-buz/kafka/infrastructure/serializers/implementations/json_byte_serializer.py,sha256=KGkTQE7lq8VB048zCew_IlYgoWPozkmERYKg0t4DjOA,1510
+buz/kafka/infrastructure/serializers/implementations/cdc_record_bytes_to_event_serializer.py,sha256=w75PNn3rsi-eUpsvzCHwirWU7FvMKF74FfoGINbqxA4,1819
+buz/kafka/infrastructure/serializers/implementations/json_byte_serializer.py,sha256=yCPlZ-TNoF5Jh0WUlhseC8rTnHk-IJgmAHmU58ninyA,1523
 buz/kafka/infrastructure/serializers/kafka_header_serializer.py,sha256=ws9xr5lsJF6J-uVIplPym7vboo00KtXHfLJf8JjG0lo,649
 buz/locator/__init__.py,sha256=my8qfHL5htIT9RFFjzV4zGIPVW72tu4SMQbKKqBeSKo,293
 buz/locator/handler_fqn_not_found_exception.py,sha256=HfQb8gwqEpG1YfOc_IQlSCjRg0Ete0Aj_z3s7GPC-RM,206
@@ -216,7 +216,8 @@ buz/locator/sync/__init__.py,sha256=OljGqPXBPuxHzWcn-tQ0P-ObLRHbhoCmmXhsSIgVxJM,
 buz/locator/sync/handler_already_registered_exception.py,sha256=7DAnkGD97OIC9gc7604dTMBtVUl8KereUvTMicK7FD0,245
 buz/locator/sync/handler_not_registered_exception.py,sha256=cYKtKET1fHXaMvbBFJNLtvNF6-yp8pixUV62_CdTS54,234
 buz/locator/sync/instance_locator.py,sha256=HGQ6uRIwrTruhax2i8L6clfJUywgHCHC3k2rwYqjApo,2076
-buz/message.py,sha256=HpcFeAcYPfhyXNS8T0VokAp6XW8nHYCAHm8d0dOk0_o,2402
+buz/message.py,sha256=d9CMiVSlQVX7xXHi60NSHwqd9cLFoulKIlmlBqLqzaA,2779
+buz/metadata.py,sha256=F0-zp_6Tplr2L3euZtuZR3jZ1qb2mW0X99I5ZvQE9Yg,250
 buz/middleware/__init__.py,sha256=ndg9oGa4p8zOYC3i0nikfmSe3Ny5ug9RBwb9vZ7YhKM,176
 buz/middleware/middleware.py,sha256=XNSlfSTyBAfHzvuFrjM0IOVtz35lP_f-xWbkfdMYltA,54
 buz/middleware/middleware_chain_builder.py,sha256=D9zl5XSF5P65QpnPcbtyFaaVHqBTb6hX75aKI7CtiPU,1010
@@ -257,7 +258,7 @@ buz/serializer/message_to_json_bytes_serializer.py,sha256=RGZJ64t4t4Pz2FCASZZCv-
 buz/wrapper/__init__.py,sha256=GnRdJFcncn-qp0hzDG9dBHLmTJSbHFVjE_yr-MdW_n4,77
 buz/wrapper/async_to_sync.py,sha256=OfK-vrVUhuN-LLLvekLdMbQYtH0ue5lfbvuasj6ovMI,698
 buz/wrapper/event_loop.py,sha256=pfBJ1g-8A2a3YgW8Gf9Fg0kkewoh3-wgTy2KIFDyfHk,266
-buz-2.16.0.dist-info/LICENSE,sha256=jcLgcIIVaBqaZNwe0kzGWSU99YgwMcI0IGv142wkYSM,1062
-buz-2.16.0.dist-info/METADATA,sha256=NUJDqpVmTFd9vDNXIhjiaN1N9jKAiUOisQfBFUB6q_Y,12679
-buz-2.16.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-buz-2.16.0.dist-info/RECORD,,
+buz-2.17.0rc2.dist-info/LICENSE,sha256=jcLgcIIVaBqaZNwe0kzGWSU99YgwMcI0IGv142wkYSM,1062
+buz-2.17.0rc2.dist-info/METADATA,sha256=1gFRXIis0nVeEJ3CS1im64qJuzyFJx-Y_3c7PIjFsQg,12682
+buz-2.17.0rc2.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+buz-2.17.0rc2.dist-info/RECORD,,