hexkit 3.1.0__tar.gz → 3.2.1__tar.gz

{hexkit-3.1.0/src/hexkit.egg-info → hexkit-3.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: hexkit
-Version: 3.1.0
+Version: 3.2.1
 Summary: A Toolkit for Building Microservices using the Hexagonal Architecture
 Author-email: "German Human Genome Phenome Archive (GHGA)" <contact@ghga.de>
 License: Apache 2.0

{hexkit-3.1.0 → hexkit-3.2.1}/pyproject.toml

@@ -23,7 +23,7 @@ classifiers = [
     "Intended Audience :: Developers",
 ]
 name = "hexkit"
-version = "3.1.0"
+version = "3.2.1"
 description = "A Toolkit for Building Microservices using the Hexagonal Architecture"
 dependencies = [
     "pydantic >=2, <3",

{hexkit-3.1.0 → hexkit-3.2.1}/src/hexkit/correlation.py

@@ -29,6 +29,7 @@ correlation_id_var: ContextVar[str] = ContextVar("correlation_id", default="")
 
 __all__ = [
     "set_correlation_id",
+    "set_new_correlation_id",
     "get_correlation_id",
     "new_correlation_id",
     "validate_correlation_id",
@@ -40,6 +41,9 @@ __all__ = [
 class CorrelationIdContextError(RuntimeError):
     """Raised when the correlation ID ContextVar is unexpectedly not set."""
 
+    def __init__(self):
+        super().__init__("No correlation ID has been set.")
+
 
 class InvalidCorrelationIdError(RuntimeError):
     """Raised when a correlation ID fails validation."""
@@ -68,7 +72,7 @@ def validate_correlation_id(correlation_id: str):
 
 @asynccontextmanager
 async def set_correlation_id(correlation_id: str):
-    """Set the correlation ID for the life of the context.
+    """Set the given correlation ID for the life of the context.
 
     Raises:
         InvalidCorrelationIdError: when the correlation ID is empty or invalid.
@@ -80,6 +84,16 @@ async def set_correlation_id(correlation_id: str):
         yield
 
 
+@asynccontextmanager
+async def set_new_correlation_id():
+    """Set a new correlation ID for the life of the context."""
+    correlation_id = new_correlation_id()
+
+    async with set_context_var(correlation_id_var, correlation_id):
+        log.info("Set context correlation ID to %s", correlation_id)
+        yield correlation_id
+
+
 def get_correlation_id() -> str:
     """Get the correlation ID.
 

{hexkit-3.1.0 → hexkit-3.2.1}/src/hexkit/protocols/daopub.py

@@ -62,7 +62,7 @@ class DaoPublisherFactoryProtocol(DaoFactoryBase, ABC):
         dto_model: type[Dto],
         id_field: str,
         fields_to_index: Optional[Collection[str]] = None,
-        dto_to_event: Callable[[Dto], JsonObject],
+        dto_to_event: Callable[[Dto], Optional[JsonObject]],
         event_topic: str,
         autopublish: bool = True,
     ) -> DaoPublisher[Dto]:
@@ -82,6 +82,7 @@ class DaoPublisherFactoryProtocol(DaoFactoryBase, ABC):
                 `id_field`. Defaults to None.
             dto_to_event:
                 A function that takes a DTO and returns the payload for an event.
+                If the returned payload is None, the event will not be published.
             event_topic:
                 The topic to which events should be published.
             autopublish:
@@ -120,7 +121,7 @@ class DaoPublisherFactoryProtocol(DaoFactoryBase, ABC):
         dto_model: type[Dto],
         id_field: str,
         fields_to_index: Optional[Collection[str]],
-        dto_to_event: Callable[[Dto], JsonObject],
+        dto_to_event: Callable[[Dto], Optional[JsonObject]],
         event_topic: str,
         autopublish: bool,
     ) -> DaoPublisher[Dto]:

{hexkit-3.1.0 → hexkit-3.2.1}/src/hexkit/providers/mongokafka/provider.py

@@ -28,6 +28,7 @@ from aiokafka import AIOKafkaProducer
 from motor.core import AgnosticCollection
 from motor.motor_asyncio import AsyncIOMotorClient
 
+from hexkit.correlation import get_correlation_id, set_correlation_id
 from hexkit.custom_types import JsonObject
 from hexkit.protocols.dao import (
     DaoNaturalId,
@@ -86,7 +87,13 @@ def dto_to_document(
     """
     document = json.loads(dto.model_dump_json())
     document["_id"] = document.pop(id_field)
-    document["__metadata__"] = {"deleted": False, "published": published}
+
+    correlation_id = get_correlation_id()
+    document["__metadata__"] = {
+        "deleted": False,
+        "published": published,
+        "correlation_id": correlation_id,
+    }
 
     return document
 
@@ -94,7 +101,7 @@ def dto_to_document(
 def get_change_publish_func(
     id_field: str,
     event_topic: str,
-    dto_to_event: Callable[[Dto], JsonObject],
+    dto_to_event: Callable[[Dto], Optional[JsonObject]],
     event_publisher: EventPublisherProtocol,
     collection: AgnosticCollection,
 ) -> Callable[[Dto], Awaitable[None]]:
@@ -103,12 +110,13 @@ def get_change_publish_func(
     async def publish_change(dto: Dto) -> None:
         """Publishes a change event and marks the change as published."""
         payload = dto_to_event(dto)
-        await event_publisher.publish(
-            payload=payload,
-            type_=CHANGE_EVENT_TYPE,
-            key=getattr(dto, id_field),
-            topic=event_topic,
-        )
+        if payload is not None:
+            await event_publisher.publish(
+                payload=payload,
+                type_=CHANGE_EVENT_TYPE,
+                key=getattr(dto, id_field),
+                topic=event_topic,
+            )
 
         document = dto_to_document(dto, id_field=id_field, published=True)
         await collection.replace_one({"_id": document["_id"]}, document, upsert=True)
@@ -134,7 +142,15 @@ def get_delete_publish_func(
             topic=event_topic,
         )
 
-        document = {"_id": id_, "__metadata__": {"deleted": True, "published": True}}
+        correlation_id = get_correlation_id()  # Get active correlation first
+        document = {
+            "_id": id_,
+            "__metadata__": {
+                "deleted": True,
+                "published": True,
+                "correlation_id": correlation_id,
+            },
+        }
         await collection.replace_one({"_id": document["_id"]}, document)
 
     return publish_deletion
@@ -233,7 +249,9 @@ class MongoKafkaDaoPublisher(Generic[Dto]):
             ResourceNotFoundError:
                 when resource with the id specified in the dto was not found
         """
+        correlation_id = get_correlation_id()
         document = self._dao._dto_to_document(dto)
+        document["__metadata__.correlation_id"] = correlation_id
         result = await self._collection.replace_one(
             {"_id": document["_id"], "__metadata__.deleted": False}, document
         )
@@ -252,9 +270,14 @@ class MongoKafkaDaoPublisher(Generic[Dto]):
         Raises:
             ResourceNotFoundError: when resource with the specified id_ was not found
         """
+        correlation_id = get_correlation_id()
         document = {
             "_id": id_,
-            "__metadata__": {"deleted": True, "published": False},
+            "__metadata__": {
+                "deleted": True,
+                "published": False,
+                "correlation_id": correlation_id,
+            },
         }
         result = await self._collection.replace_one(
             {"_id": document["_id"], "__metadata__.deleted": False}, document
@@ -343,13 +366,15 @@ class MongoKafkaDaoPublisher(Generic[Dto]):
 
     async def publish_document(self, document: dict[str, Any]) -> None:
         """Publishes a document"""
-        if document.get("__metadata__", {}).get("deleted", False):
-            await self._publish_delete(document["_id"])
-        else:
-            dto = document_to_dto(
-                document, id_field=self._id_field, dto_model=self._dto_model
-            )
-            await self._publish_change(dto)
+        correlation_id = document.get("__metadata__", {}).get("correlation_id", "")
+        async with set_correlation_id(correlation_id=correlation_id):
+            if document.get("__metadata__", {}).get("deleted", False):
+                await self._publish_delete(document["_id"])
+            else:
+                dto = document_to_dto(
+                    document, id_field=self._id_field, dto_model=self._dto_model
+                )
+                await self._publish_change(dto)
 
     async def publish_pending(self) -> None:
         """Publishes all non-published changes."""
@@ -422,7 +447,7 @@ class MongoKafkaDaoPublisherFactory(DaoPublisherFactoryProtocol):
         dto_model: type[Dto],
         id_field: str,
         fields_to_index: Optional[Collection[str]],
-        dto_to_event: Callable[[Dto], JsonObject],
+        dto_to_event: Callable[[Dto], Optional[JsonObject]],
         event_topic: str,
         autopublish: bool,
     ) -> DaoPublisher[Dto]:

{hexkit-3.1.0 → hexkit-3.2.1/src/hexkit.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: hexkit
-Version: 3.1.0
+Version: 3.2.1
 Summary: A Toolkit for Building Microservices using the Hexagonal Architecture
 Author-email: "German Human Genome Phenome Archive (GHGA)" <contact@ghga.de>
 License: Apache 2.0