buz 2.22.0__py3-none-any.whl → 2.23.0__py3-none-any.whl

buz/command/synchronous/command_handler.py

@@ -3,11 +3,18 @@ from typing import Generic, Type, TypeVar
 
 from buz import Handler
 from buz.command import Command
+from buz.wrapper.async_unsafe import async_unsafe
 
 TCommand = TypeVar("TCommand", bound=Command)
 
 
 class CommandHandler(Generic[TCommand], Handler[TCommand], ABC):
+    def __new__(cls, *args, **kwargs):
+        instance = super().__new__(cls)
+        original_handle = instance.handle
+        instance.handle = async_unsafe()(original_handle)
+        return instance
+
     @classmethod
     @abstractmethod
     def handles(cls) -> Type[TCommand]:

buz/event/infrastructure/buz_kafka/buz_kafka_event_bus.py

@@ -16,6 +16,8 @@ from buz.kafka.domain.models.auto_create_topic_configuration import AutoCreateTo
 from buz.kafka.domain.models.create_kafka_topic import CreateKafkaTopic
 from buz.kafka.domain.services.kafka_admin_client import KafkaAdminClient
 from buz.kafka.domain.services.kafka_producer import KafkaProducer
+from buz.kafka.infrastructure.serializers.implementations.cdc_partition_key_serializer import CDCPartitionKeySerializer
+from buz.kafka.infrastructure.serializers.partitiion_key_generator import PartitionKeySerializer
 
 
 class BuzKafkaEventBus(EventBus):
@@ -28,6 +30,7 @@ class BuzKafkaEventBus(EventBus):
         kafka_admin_client: Optional[KafkaAdminClient] = None,
         publish_middlewares: Optional[list[PublishMiddleware]] = None,
         auto_create_topic_configuration: Optional[AutoCreateTopicConfiguration] = None,
+        partition_key_generator: Optional[PartitionKeySerializer] = None,
     ):
         self.__publish_middleware_chain_resolver = PublishMiddlewareChainResolver(publish_middlewares or [])
         self.__publish_strategy = publish_strategy
@@ -36,6 +39,7 @@ class BuzKafkaEventBus(EventBus):
         self.__kafka_admin_client = kafka_admin_client
         self.__auto_create_topic_configuration = auto_create_topic_configuration
         self.__logger = logger
+        self.__partition_key_generator: PartitionKeySerializer = partition_key_generator or CDCPartitionKeySerializer()
         self.__check_kafka_admin_client_is_needed()
 
     def __check_kafka_admin_client_is_needed(self) -> None:
@@ -74,7 +78,7 @@ class BuzKafkaEventBus(EventBus):
                 message=event,
                 headers=headers,
                 topic=topic,
-                partition_key=event.partition_key(),
+                partition_key=self.__partition_key_generator.generate_key(event),
             )
         except Exception as exc:
             raise EventNotPublishedException(event) from exc

buz/kafka/infrastructure/serializers/implementations/cdc_partition_key_serializer.py

@@ -0,0 +1,19 @@
+from __future__ import annotations
+
+from buz.event.event import Event
+from buz.kafka.infrastructure.serializers.implementations.json_byte_serializer import JSONByteSerializer
+from buz.kafka.infrastructure.serializers.partitiion_key_generator import PartitionKeySerializer
+
+# This is a static string because the order matters and we can not trust that json encoder libraries are deterministic
+PAYLOAD_CDC_SCHEMA = r"""{"schema":{"type":"string","optional":true},"payload":"[partition_key]"}"""
+
+
+class CDCPartitionKeySerializer(PartitionKeySerializer):
+    def __init__(self) -> None:
+        self.__json_serializer = JSONByteSerializer()
+
+    def __generate_payload_schema(self, partition_key: str) -> str:
+        return PAYLOAD_CDC_SCHEMA.replace("[partition_key]", partition_key)
+
+    def generate_key(self, event: Event) -> str:
+        return self.__generate_payload_schema(event.partition_key())

buz/kafka/infrastructure/serializers/partitiion_key_generator.py

@@ -0,0 +1,9 @@
+from abc import ABC, abstractmethod
+
+from buz.event.event import Event
+
+
+class PartitionKeySerializer(ABC):
+    @abstractmethod
+    def generate_key(self, event: Event) -> str:
+        pass

buz/query/synchronous/query_handler.py

@@ -3,12 +3,19 @@ from typing import Generic, Type, TypeVar
 
 from buz import Handler
 from buz.query import Query, QueryResponse
+from buz.wrapper.async_unsafe import async_unsafe
 
 TQuery = TypeVar("TQuery", bound=Query)
 TQueryResponse = TypeVar("TQueryResponse", bound=QueryResponse)
 
 
 class QueryHandler(Generic[TQuery, TQueryResponse], Handler[TQuery], ABC):
+    def __new__(cls, *args, **kwargs):
+        instance = super().__new__(cls)
+        original_handle = instance.handle
+        instance.handle = async_unsafe()(original_handle)
+        return instance
+
     @classmethod
     @abstractmethod
     def handles(cls) -> Type[TQuery]:

buz/wrapper/async_unsafe.py

@@ -0,0 +1,67 @@
+import logging
+import os
+from asyncio import get_running_loop
+from functools import wraps
+from typing import Callable, Any
+
+from buz.wrapper.synchronous_only_operation_exception import SynchronousOnlyOperationException
+
+logger = logging.getLogger(__name__)
+
+
+def async_unsafe() -> Callable[[Callable], Callable]:
+    """
+    Copy-paste from Django source code. If BUZ_SYNC_HANDLERS_FAIL_ON_ASYNC env var is True then an exception is raised to
+    prevent event loop from being blocked. If the env var is False, a warning is logged.
+    """
+
+    def decorator(func: Callable) -> Callable:
+        @wraps(func)
+        def inner(*args: Any, **kwargs: Any) -> Any:
+            try:
+                get_running_loop()
+            except RuntimeError:
+                pass
+            else:
+                if __get_bool_env("BUZ_SYNC_HANDLERS_FAIL_ON_ASYNC") is True:
+                    raise SynchronousOnlyOperationException()
+
+                logger.warning(
+                    f"You should not call this from an async context - use a thread or sync_to_async. Class {__get_class_name(func, args)}"
+                )
+
+            return func(*args, **kwargs)
+
+        return inner
+
+    return decorator
+
+
+def __get_bool_env(var_name: str) -> bool:
+    """
+    >>> get_bool_env("MY_BOOL_VAR")
+    False
+    >>> os.environ["MY_BOOL_VAR"] = "1"
+    >>> get_bool_env("MY_BOOL_VAR")
+    True
+    >>> os.environ["MY_BOOL_VAR"] = "true"
+    >>> get_bool_env("MY_BOOL_VAR")
+    True
+    >>> os.environ["MY_BOOL_VAR"] = "True"
+    >>> get_bool_env("MY_BOOL_VAR")
+    True
+    >>> os.environ["MY_BOOL_VAR"] = "0"
+    >>> get_bool_env("MY_BOOL_VAR")
+    False
+    >>> os.environ["MY_BOOL_VAR"] = "false"
+    >>> get_bool_env("MY_BOOL_VAR")
+    False
+    """
+    return os.environ.get(var_name, "0").lower() in ("true", "1")
+
+
+def __get_class_name(func: Callable, args: tuple) -> str:
+    if hasattr(func, "__self__"):
+        return func.__self__.__class__.__name__
+
+    return args[0].__class__.__name__ if len(args) > 0 else "Unknown"

buz/wrapper/synchronous_only_operation_exception.py

@@ -0,0 +1,3 @@
+class SynchronousOnlyOperationException(Exception):
+    def __init__(self):
+        super().__init__("You cannot call this from an async context - use a thread or sync_to_async.")

{buz-2.22.0.dist-info → buz-2.23.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: buz
-Version: 2.22.0
+Version: 2.23.0
 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.22.0.dist-info → buz-2.23.0.dist-info}/RECORD

@@ -15,7 +15,7 @@ buz/command/more_than_one_command_handler_related_exception.py,sha256=dNCMXCAKVc
 buz/command/synchronous/__init__.py,sha256=ZAH35jpte6zpxb70iQfZfGSg_OsXqVNYwNkCJy7Qnzk,268
 buz/command/synchronous/base_command_handler.py,sha256=GkmxttA1_Wu2X5O7iR-tLRdnmT-JDgeyURPwkjLPGhg,1393
 buz/command/synchronous/command_bus.py,sha256=FHJH4lerThu5fWRISM0VIK8ebyfqgDGqNNCqItbmGPI,175
-buz/command/synchronous/command_handler.py,sha256=pP11Njbth89NQiVPqlALtKmabVtOX4sucdbiCp-sceI,422
+buz/command/synchronous/command_handler.py,sha256=M9nQhW9Ilkix09U6Pv6ZpoqA-gezrm7H_gqjoLDc_A4,676
 buz/command/synchronous/middleware/__init__.py,sha256=wE97veOW2cCGpTZ-3bvc3aU6NdQmSOYfdX9kAUETJ0w,406
 buz/command/synchronous/middleware/base_handle_middleware.py,sha256=qHnbucL7j6Dnw7E8ACBf32pzDD9squYPp6UiK2heb5A,774
 buz/command/synchronous/middleware/handle_middleware.py,sha256=oIsmB30mu-Cd9IQc1qMKbUIaIMHipSEXOw2swVrtbkk,420
@@ -50,7 +50,7 @@ buz/event/infrastructure/buz_kafka/async_buz_kafka_event_bus.py,sha256=kxqXCf80L
 buz/event/infrastructure/buz_kafka/base_buz_aiokafka_async_consumer.py,sha256=7ZhaKaFXBpD3HVkuQMpAJvY8lfy7__1wxftLIwCmnMQ,21284
 buz/event/infrastructure/buz_kafka/buz_aiokafka_async_consumer.py,sha256=GmmuAZboDkrpNOLF8cE_F0t4I7ZnMiGsiGw4SYIvKGc,7303
 buz/event/infrastructure/buz_kafka/buz_aiokafka_multi_threaded_consumer.py,sha256=ZRLRoBRomqrXAiePSMn4gePF59AWPn6VQpQui1UVnyM,7246
-buz/event/infrastructure/buz_kafka/buz_kafka_event_bus.py,sha256=_CLD4gU7KikVTEydSMtPE3meFhlOtAx0km4cS6Q3tno,4654
+buz/event/infrastructure/buz_kafka/buz_kafka_event_bus.py,sha256=bfxdwUh33yFIo0NCm_S_AMrfnLvTCL9dGZZXDaOkKNM,5094
 buz/event/infrastructure/buz_kafka/consume_strategy/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 buz/event/infrastructure/buz_kafka/consume_strategy/consume_strategy.py,sha256=RqlXe5W2S6rH3FTr--tcxzFJTAVLb-Dhl7m6qjgNz2M,331
 buz/event/infrastructure/buz_kafka/consume_strategy/kafka_on_fail_strategy.py,sha256=elNeyTubDuhHsLlTtDA1Nqz2hZe12PUcO9kz8upPby8,136
@@ -205,9 +205,11 @@ buz/kafka/infrastructure/kafka_python/kafka_python_producer.py,sha256=McH_YNQcte
 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_partition_key_serializer.py,sha256=TNN1H5AndGvpxkfBTOHGSH94mZocQ4n3JApQnvp7TNw,902
 buz/kafka/infrastructure/serializers/implementations/cdc_record_bytes_to_event_serializer.py,sha256=c5VmnuTOIZJ_tjfOl_BQnPdr7D1OAOxGYVFE4O4X8Tk,1801
 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/kafka/infrastructure/serializers/partitiion_key_generator.py,sha256=4FQmTuqrLp9xmaYg9qv42x5fPMQFaC4OmDnmuszGf94,190
 buz/locator/__init__.py,sha256=my8qfHL5htIT9RFFjzV4zGIPVW72tu4SMQbKKqBeSKo,293
 buz/locator/handler_fqn_not_found_exception.py,sha256=HfQb8gwqEpG1YfOc_IQlSCjRg0Ete0Aj_z3s7GPC-RM,206
 buz/locator/locator.py,sha256=1RqxXSkTw5PgwSB_AME3gYzYgN8ySV0FrUwW5N_0cAQ,512
@@ -248,7 +250,7 @@ buz/query/synchronous/middleware/base_handle_middleware.py,sha256=4lqJB2C-GHl3T5
 buz/query/synchronous/middleware/handle_middleware.py,sha256=Xr2HSlRrW3slluyUiJ6zH0Rw0oeWD3uMN-1hjuFbC_k,433
 buz/query/synchronous/middleware/handle_middleware_chain_resolver.py,sha256=OIpGLJ_2a8cGsp-LmA3Q1Lvb1pB65MIuA-geiPrQKHM,1070
 buz/query/synchronous/query_bus.py,sha256=eYl_sGH5TcELkOXc4RnV4Tkmcs-VLc1vzd-YMduQ1YI,189
-buz/query/synchronous/query_handler.py,sha256=q8zqXjU9btid_q4wbL73QgaiWjMzGDFvwZ5AQN4q0CA,505
+buz/query/synchronous/query_handler.py,sha256=NuolVPZelmjOe6-q_hFC3Y0gm7ih2A6aanKufo6wHR0,759
 buz/query/synchronous/self_process/__init__.py,sha256=fU1OoXXXH5dMGKz8y7mwTVvyhNj6BCKDTxuxH_q-leM,125
 buz/query/synchronous/self_process/self_process_query_bus.py,sha256=pKGJxXBWtqU4i0fzb30OCNhAVPCkUh7IlfNzgAhCUC8,1157
 buz/query/synchronous/synced_async/__init__.py,sha256=TdFmIBeFIpl3Tvmh_FJpJMXJdPdfRxOstVqnPUi23mo,125
@@ -262,8 +264,10 @@ buz/serializer/message_to_bytes_serializer.py,sha256=uQ6JSTn24mLQvN48alwVXa6lfgf
 buz/serializer/message_to_json_bytes_serializer.py,sha256=RGZJ64t4t4Pz2FCASZZCv-2LiWnertC8scE9ZzQkBsU,764
 buz/wrapper/__init__.py,sha256=GnRdJFcncn-qp0hzDG9dBHLmTJSbHFVjE_yr-MdW_n4,77
 buz/wrapper/async_to_sync.py,sha256=OfK-vrVUhuN-LLLvekLdMbQYtH0ue5lfbvuasj6ovMI,698
+buz/wrapper/async_unsafe.py,sha256=vg-BM8Dh7MqKiMAc8qsMPexLUuHI1bn4APzMXeSrBgk,2026
 buz/wrapper/event_loop.py,sha256=pfBJ1g-8A2a3YgW8Gf9Fg0kkewoh3-wgTy2KIFDyfHk,266
-buz-2.22.0.dist-info/LICENSE,sha256=jcLgcIIVaBqaZNwe0kzGWSU99YgwMcI0IGv142wkYSM,1062
-buz-2.22.0.dist-info/METADATA,sha256=A_w-t53670N0vP0iwVhKBEbIx1z14OhHNSyS5F4urHs,12580
-buz-2.22.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-buz-2.22.0.dist-info/RECORD,,
+buz/wrapper/synchronous_only_operation_exception.py,sha256=qCTaNSuIY7_HXTOmzlNGhks1nRApeW5K8W5aHC-dL-4,180
+buz-2.23.0.dist-info/LICENSE,sha256=jcLgcIIVaBqaZNwe0kzGWSU99YgwMcI0IGv142wkYSM,1062
+buz-2.23.0.dist-info/METADATA,sha256=YxHyoXLE0SlA_UxWPBACGbNIeXkeOnEW9_gfe6yDOo8,12580
+buz-2.23.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+buz-2.23.0.dist-info/RECORD,,