django-queuebie 0.2.0__tar.gz → 0.3.1__tar.gz

django_queuebie-0.3.1/CHANGES.md

@@ -0,0 +1,13 @@
+# Changelog
+
+* *0.3.1* (2025-03-19)
+  * Added a paranoid-ish test to check that the import logic isn't breaking any testing functionality
+
+* *0.3.0* (2025-03-19)
+  * The whole queue iteration now is wrapped in a transaction atomic
+
+* *0.2.0* (2025-03-17)
+  * Extend strict mode to prohibit event (!) handlers to talk to the database
+
+* *0.1.0* (2025-01-29)
+  * Project init

{django_queuebie-0.2.0 → django_queuebie-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: django-queuebie
-Version: 0.2.0
+Version: 0.3.1
 Summary: Simple message queue for commands and events (CQRS)
 Author-email: Ambient Digital <hello@ambient.digital>
 Description-Content-Type: text/markdown

{django_queuebie-0.2.0 → django_queuebie-0.3.1}/queuebie/__init__.py

@@ -1,6 +1,6 @@
 """Simple message queue for commands and events (CQRS)"""
 
-__version__ = "0.2.0"
+__version__ = "0.3.1"
 
 from queuebie.registry import MessageRegistry
 

django_queuebie-0.3.1/queuebie/runner.py

@@ -0,0 +1,63 @@
+import importlib
+from contextlib import nullcontext
+
+from django.db import transaction
+
+from queuebie import message_registry
+from queuebie.database_blocker import BlockDatabaseAccess
+from queuebie.exceptions import InvalidMessageTypeError
+from queuebie.logger import get_logger
+from queuebie.messages import Command, Event, Message
+from queuebie.settings import get_queuebie_strict_mode
+
+
+def handle_message(messages: Message | list[Message]) -> None:
+    queue: list[Message] = messages if isinstance(messages, list) else [messages]
+
+    for message in queue:
+        if not isinstance(message, (Command, Event)):
+            raise InvalidMessageTypeError(class_name=message.__class__.__name__)
+
+    # Run auto-registry
+    message_registry.autodiscover()
+
+    with transaction.atomic():
+        while queue:
+            message = queue.pop(0)
+            if isinstance(message, Command):
+                handler_list = message_registry.command_dict.get(message.module_path(), [])
+                block_db_access = False
+            else:
+                handler_list = message_registry.event_dict.get(message.module_path(), [])
+                block_db_access = True if get_queuebie_strict_mode() else False
+
+            new_messages = _process_message(handler_list=handler_list, message=message, block_db_access=block_db_access)
+            queue.extend(new_messages)
+
+
+def _process_message(*, handler_list: list, message: [Command, Event], block_db_access: bool) -> list[Message]:
+    """
+    Handler to process messages of type "Command"
+    """
+    logger = get_logger()
+    messages = []
+
+    for handler in handler_list:
+        try:
+            logger.debug(
+                f"Handling command '{message.module_path()}' ({message.uuid}) with handler '{handler['name']}'."
+            )
+            module = importlib.import_module(handler["module"])
+            handler_function = getattr(module, handler["name"])
+            with BlockDatabaseAccess() if block_db_access else nullcontext():
+                handler_messages = handler_function(context=message) or []
+            handler_messages = handler_messages if isinstance(handler_messages, list) else [handler_messages]
+            if len(handler_messages) > 0:
+                messages.extend(handler_messages)
+            uuid_list = [f"{m!s}" for m in handler_messages]
+            logger.debug(f"New messages: {uuid_list!s}")
+        except Exception as e:
+            logger.debug(f"Exception handling command {message.module_path()}: {e!s}")
+            raise e from e
+
+    return messages

{django_queuebie-0.2.0 → django_queuebie-0.3.1}/testapp/handlers/commands/testapp.py

@@ -5,7 +5,13 @@ from django.contrib.auth.models import User
 from queuebie import message_registry
 from queuebie.logger import get_logger
 from queuebie.messages import Event
-from testapp.messages.commands.my_commands import CriticalCommand, DoSomething, PersistSomething
+from testapp.messages.commands.my_commands import (
+    CreateUser,
+    CriticalCommand,
+    DoSomething,
+    PersistSomething,
+    RaiseRuntimeError,
+)
 from testapp.messages.events.my_events import SomethingHappened, SomethingHappenedThatWantsToBePersisted
 
 
@@ -17,7 +23,7 @@ def handle_my_command(*, context: DoSomething) -> list[Event] | Event:
 
 
 @message_registry.register_command(command=PersistSomething)
-def handle_something_that_needs_persistance(*, context: PersistSomething) -> Event:
+def handle_something_that_needs_persistence(*, context: PersistSomething) -> Event:
     User.objects.create(username="testuser" + str(randint(1, 100)))
 
     return SomethingHappenedThatWantsToBePersisted(any_var=1)
@@ -29,9 +35,21 @@ def handle_critical_command(*, context: CriticalCommand) -> None:
         raise RuntimeError("Handler is broken.")  # noqa: TRY003
 
 
-def create_user(*args, **kwargs):
-    return User.objects.create_user(username="username")
+@message_registry.register_command(command=CreateUser)
+def create_user(context: CreateUser):
+    User.objects.create_user(username=context.username)
 
 
-def raise_exception(*args, **kwargs):
-    raise RuntimeError("Something is broken.")  # noqa: TRY003
+@message_registry.register_command(command=RaiseRuntimeError)
+def raise_exception(context: RaiseRuntimeError):
+    raise RuntimeError(context.error_msg)
+
+
+class MyClass:
+    """
+    This is a test class since we observed the behaviour that in a similar setup, the "forced"
+    import was breaking mocking.
+    """
+
+    def process(self):
+        return 42

{django_queuebie-0.2.0 → django_queuebie-0.3.1}/testapp/messages/commands/my_commands.py

@@ -21,3 +21,13 @@ class SameNameCommand(Command):
 @dataclass(kw_only=True)
 class PersistSomething(Command):
     any_var: str
+
+
+@dataclass(kw_only=True)
+class CreateUser(Command):
+    username: str
+
+
+@dataclass(kw_only=True)
+class RaiseRuntimeError(Command):
+    error_msg: str

{django_queuebie-0.2.0 → django_queuebie-0.3.1}/tests/test_registry.py

@@ -9,6 +9,7 @@ from django.test import override_settings
 from queuebie import MessageRegistry
 from queuebie.exceptions import RegisterOutOfScopeCommandError
 from queuebie.settings import get_queuebie_cache_key
+from testapp.handlers.commands.testapp import MyClass
 from testapp.messages.commands.my_commands import CriticalCommand, DoSomething
 from testapp.messages.events.my_events import (
     SomethingHappened,
@@ -124,7 +125,7 @@ def test_message_autodiscover_regular():
     message_registry.autodiscover()
 
     # Assert one command registered
-    assert len(message_registry.command_dict) == 3  # noqa: PLR2004
+    assert len(message_registry.command_dict) == 5  # noqa: PLR2004
     assert DoSomething.module_path() in message_registry.command_dict.keys()
     assert CriticalCommand.module_path() in message_registry.command_dict.keys()
 
@@ -191,3 +192,16 @@ def test_message_autodiscover_load_handlers_from_cache_dummy_cache(*args):
 
     assert len(commands) == 0
     assert len(events) == 0
+
+
+@mock.patch.object(MyClass, "process")
+def test_registry_forced_import_doesnt_break_mocking(mocked_process):
+    """
+    This is a test for ensuring that the "forced" import isn't breaking mocking features.
+    """
+
+    def my_func():
+        return MyClass().process()
+
+    my_func()
+    mocked_process.assert_called_once()

{django_queuebie-0.2.0 → django_queuebie-0.3.1}/tests/test_runner.py

@@ -8,8 +8,15 @@ from django.test import override_settings
 from queuebie import MessageRegistry
 from queuebie.database_blocker import DatabaseAccessDeniedError
 from queuebie.exceptions import InvalidMessageTypeError
-from queuebie.runner import _process_message, handle_message
-from testapp.messages.commands.my_commands import CriticalCommand, DoSomething, PersistSomething, SameNameCommand
+from queuebie.runner import handle_message
+from testapp.messages.commands.my_commands import (
+    CreateUser,
+    CriticalCommand,
+    DoSomething,
+    PersistSomething,
+    RaiseRuntimeError,
+    SameNameCommand,
+)
 from testapp.messages.events.my_events import (
     SomethingHappened,
     SomethingHappenedThatWantsToBePersistedViaEvent,
@@ -125,15 +132,8 @@ def test_handle_message_other_command_with_same_name(mocked_handle_command, *arg
 
 @pytest.mark.django_db
 @mock.patch("queuebie.registry.get_queuebie_strict_mode", return_value=False)
-def test_process_message_atomic_works(mocked_handle_command, *args):
-    handler_list = [
-        {"module": "testapp.handlers.commands.testapp", "name": "create_user"},
-        {"module": "testapp.handlers.commands.testapp", "name": "raise_exception"},
-    ]
-
-    message = DoSomething(my_var=1)
-
+def test_handle_message_atomic_works(*args):
     with pytest.raises(RuntimeError, match="Something is broken."):
-        _process_message(handler_list=handler_list, message=message, block_db_access=False)
+        handle_message([CreateUser(username="username"), RaiseRuntimeError(error_msg="Something is broken.")])
 
     assert User.objects.filter(username="username").exists() is False

django_queuebie-0.2.0/CHANGES.md

@@ -1,7 +0,0 @@
-# Changelog
-
-* *0.2.0* (2025-03-17)
-  * Extend strict mode to prohibit event (!) handlers to talk to the database
-
-* *0.1.0* (2025-01-29)
-  * Project init

django_queuebie-0.2.0/queuebie/runner.py

@@ -1,64 +0,0 @@
-import importlib
-from contextlib import nullcontext
-
-from django.db import transaction
-
-from queuebie import message_registry
-from queuebie.database_blocker import BlockDatabaseAccess
-from queuebie.exceptions import InvalidMessageTypeError
-from queuebie.logger import get_logger
-from queuebie.messages import Command, Event, Message
-from queuebie.settings import get_queuebie_strict_mode
-
-
-def handle_message(messages: Message | list[Message]) -> None:
-    queue: list[Message] = messages if isinstance(messages, list) else [messages]
-
-    for message in queue:
-        if not isinstance(message, (Command, Event)):
-            raise InvalidMessageTypeError(class_name=message.__class__.__name__)
-
-    # Run auto-registry
-    message_registry.autodiscover()
-
-    while queue:
-        message = queue.pop(0)
-        if isinstance(message, Command):
-            handler_list = message_registry.command_dict.get(message.module_path(), [])
-            block_db_access = False
-        else:
-            handler_list = message_registry.event_dict.get(message.module_path(), [])
-            block_db_access = True if get_queuebie_strict_mode() else False
-
-        new_messages = _process_message(handler_list=handler_list, message=message, block_db_access=block_db_access)
-        queue.extend(new_messages)
-
-
-def _process_message(*, handler_list: list, message: [Command, Event], block_db_access: bool) -> list[Message]:
-    """
-    Handler to process messages of type "Command"
-    """
-    logger = get_logger()
-    messages = []
-
-    # TODO: should the whole chain be atomic and not just the handler?
-    with transaction.atomic():
-        for handler in handler_list:
-            try:
-                logger.debug(
-                    f"Handling command '{message.module_path()}' ({message.uuid}) with handler '{handler['name']}'."
-                )
-                module = importlib.import_module(handler["module"])
-                handler_function = getattr(module, handler["name"])
-                with BlockDatabaseAccess() if block_db_access else nullcontext():
-                    handler_messages = handler_function(context=message) or []
-                handler_messages = handler_messages if isinstance(handler_messages, list) else [handler_messages]
-                if len(handler_messages) > 0:
-                    messages.extend(handler_messages)
-                uuid_list = [f"{m!s}" for m in handler_messages]
-                logger.debug(f"New messages: {uuid_list!s}")
-            except Exception as e:
-                logger.debug(f"Exception handling command {message.module_path()}: {e!s}")
-                raise e from e
-
-    return messages