Merge pull request #185 from minos-framework/0.5.3

0.5.3

Author: Sergio García Prado

README.md

@@ -104,7 +104,7 @@ services:
     depends_on:
       - zookeeper
     environment:
-      KAFKA_ADVERTISED_HOST_NAME: kafka
+      KAFKA_ADVERTISED_HOST_NAME: localhost
       KAFKA_ZOOKEEPER_CONNECT: zookeeper:2181
   postgres:
     restart: always
@@ -715,7 +715,7 @@ Execute the following command to start the microservice:
 python foo/main.py
 ```
 
-Now, if a new instance is created (with a rest call, like in the [previous section](#Expose a Command)), the `FooCreated` event will be handled and the microservice's console will print something like:
+Now, if a new instance is created (with a rest call, like in the [previous section](#expose-a-command)), the `FooCreated` event will be handled and the microservice's console will print something like:
 
 ```
 A Foo was created: Event(...)

packages/core/minos-microservice-aggregate/HISTORY.md

@@ -76,4 +76,12 @@
 * Add `get_all` method to `RootEntity` and `SnapshotRepository` to get all the stored instance on the repository. 
 * Rename `SnapshotService` command topics to avoid collisions with application-level topics. 
 * Rename `TransactionService` command topics to avoid collisions with application-level topics. 
-* Minor changes.
+* Minor changes.
+
+0.5.3 (2022-03-04)
+------------------
+
+* Add `RefException` to be raised when some reference cannot be resolved.
+* Improve attribute and item accessors of `Ref`, `Event` and `FieldDiffContainer`
+* Deprecate `Event.get_one` in favor of `Event.get_field`.
+* Deprecate `Event.get_all` in favor of `Event.get_fields`.

packages/core/minos-microservice-aggregate/Makefile

@@ -1,4 +1,4 @@
-.PHONY: docs
+.PHONY: docs dist
 
 lint:
 	poetry run flake8

packages/core/minos-microservice-aggregate/minos/aggregate/__init__.py

@@ -1,6 +1,6 @@
 __author__ = "Minos Framework Devs"
 __email__ = "[email protected]"
-__version__ = "0.5.2"
+__version__ = "0.5.3"
 
 from .actions import (
     Action,
@@ -42,6 +42,7 @@
     EventRepositoryConflictException,
     EventRepositoryException,
     NotFoundException,
+    RefException,
     SnapshotRepositoryConflictException,
     SnapshotRepositoryException,
     TransactionNotFoundException,

packages/core/minos-microservice-aggregate/minos/aggregate/entities/models.py

@@ -349,7 +349,7 @@ def from_diff(cls: Type[T], event: Event, *args, **kwargs) -> T:
             version=event.version,
             created_at=event.created_at,
             updated_at=event.created_at,
-            **event.get_all(),
+            **event.get_fields(),
             **kwargs,
         )
 

packages/core/minos-microservice-aggregate/minos/aggregate/entities/refs/models.py

@@ -2,6 +2,7 @@
     annotations,
 )
 
+import logging
 from typing import (
     Any,
     Generic,
@@ -39,7 +40,11 @@
 from ...contextvars import (
     IS_REPOSITORY_SERIALIZATION_CONTEXT_VAR,
 )
+from ...exceptions import (
+    RefException,
+)
 
+logger = logging.getLogger(__name__)
 MT = TypeVar("MT", bound=Model)
 
 
@@ -56,13 +61,55 @@ def __init__(self, data: Union[MT, UUID], *args, broker_pool: BrokerClientPool =
 
         self._broker_pool = broker_pool
 
+    def __setitem__(self, key: str, value: Any) -> None:
+        try:
+            return super().__setitem__(key, value)
+        except KeyError as exc:
+            if key == "uuid":
+                self.data = value
+                return
+
+            try:
+                self.data[key] = value
+            except Exception:
+                raise exc
+
+    def __getitem__(self, item: str) -> Any:
+        try:
+            return super().__getitem__(item)
+        except KeyError as exc:
+            if item == "uuid":
+                return self.uuid
+
+            try:
+                return self.data[item]
+            except Exception:
+                raise exc
+
+    def __setattr__(self, key: str, value: Any) -> None:
+        try:
+            return super().__setattr__(key, value)
+        except AttributeError as exc:
+            if key == "uuid":
+                self.data = value
+                return
+
+            try:
+                setattr(self.data, key, value)
+            except Exception:
+                raise exc
+
     def __getattr__(self, item: str) -> Any:
         try:
             return super().__getattr__(item)
         except AttributeError as exc:
-            if item != "data":
+            if item == "data":
+                raise exc
+
+            try:
                 return getattr(self.data, item)
-            raise exc
+            except Exception:
+                raise exc
 
     @property
     def int(self) -> int:
@@ -146,6 +193,14 @@ def uuid(self) -> UUID:
             return self.data
         return self.data.uuid
 
+    @uuid.setter
+    def uuid(self, value: UUID) -> None:
+        """Set the uuid that identifies the ``Model``.
+
+        :return: This method does not return anything.
+        """
+        raise RuntimeError("The 'uuid' must be set through the '__setattr__' method.")  # pragma: no cover
+
     @property
     def data_cls(self) -> Optional[type]:
         """Get data class if available.
@@ -178,6 +233,8 @@ async def resolve(self, force: bool = False, **kwargs) -> None:
     @staticmethod
     async def _get_response(broker: BrokerClient, **kwargs) -> MT:
         message = await broker.receive(**kwargs)
+        if not message.ok:
+            raise RefException(f"The received message is not ok: {message!r}")
         return message.content
 
     @property

packages/core/minos-microservice-aggregate/minos/aggregate/entities/refs/resolvers.py

@@ -1,3 +1,4 @@
+import logging
 from asyncio import (
     gather,
 )
@@ -29,13 +30,18 @@
     BrokerMessageV1Payload,
 )
 
+from ...exceptions import (
+    RefException,
+)
 from .extractors import (
     RefExtractor,
 )
 from .injectors import (
     RefInjector,
 )
 
+logger = logging.getLogger(__name__)
+
 
 class RefResolver:
     """Ref Resolver class."""
@@ -76,5 +82,10 @@ async def _query(self, references: dict[str, set[UUID]]) -> dict[UUID, Model]:
 
     @staticmethod
     async def _get_response(broker: BrokerClient, count: int, **kwargs) -> Iterable[Model]:
-        messages = [message async for message in broker.receive_many(count, **kwargs)]
+        messages = list()
+        async for message in broker.receive_many(count, **kwargs):
+            if not message.ok:
+                raise RefException(f"The received message is not ok: {message!r}")
+            messages.append(message)
+
         return chain(*(message.content for message in messages))

packages/core/minos-microservice-aggregate/minos/aggregate/events/fields.py

@@ -93,10 +93,10 @@ def __init__(
 
         self._mapper = _build_mapper(self._fields)
 
-    def __getattr__(self, item: str) -> Any:
+    def __getitem__(self, item: str) -> Any:
         try:
-            return super().__getattr__(item)
-        except AttributeError as exc:
+            return super().__getitem__(item)
+        except KeyError as exc:
             try:
                 return self.get_one(item)
             except Exception:

packages/core/minos-microservice-aggregate/minos/aggregate/events/models.py

@@ -3,6 +3,7 @@
 )
 
 import logging
+import warnings
 from datetime import (
     datetime,
 )
@@ -64,20 +65,40 @@ def simplified_name(self) -> str:
     def __lt__(self, other: Any) -> bool:
         return isinstance(other, type(self)) and self.version < other.version
 
-    def __getattr__(self, item: str) -> Any:
+    def __getitem__(self, item: str) -> Any:
         try:
-            return super().__getattr__(item)
-        except AttributeError as exc:
+            return super().__getitem__(item)
+        except KeyError as exc:
             if item != "fields_diff":
                 try:
-                    return self.get_one(item)
+                    return self.get_field(item)
                 except Exception:
                     raise exc
             raise exc
 
+    def __getattr__(self, item: str) -> Any:
+        try:
+            return super().__getattr__(item)
+        except AttributeError as exc:
+            try:
+                return self[item]
+            except Exception:
+                raise exc
+
     def get_one(self, name: str, return_diff: bool = False) -> Union[FieldDiff, Any, list[FieldDiff], list[Any]]:
         """Get first field diff with given name.
 
+        :param name: The name of the field diff.
+        :param return_diff: If ``True`` the result is returned as field diff instances, otherwise the result is
+            returned as value instances.
+        :return: A ``FieldDiff`` instance.
+        """
+        warnings.warn("get_one() method is deprecated by get_field() and will be removed soon.", DeprecationWarning)
+        return self.get_field(name, return_diff)
+
+    def get_field(self, name: str, return_diff: bool = False) -> Union[FieldDiff, Any, list[FieldDiff], list[Any]]:
+        """Get first field diff with given name.
+
         :param name: The name of the field diff.
         :param return_diff: If ``True`` the result is returned as field diff instances, otherwise the result is
             returned as value instances.
@@ -88,6 +109,16 @@ def get_one(self, name: str, return_diff: bool = False) -> Union[FieldDiff, Any,
     def get_all(self, return_diff: bool = False) -> dict[str, Union[FieldDiff, Any, list[FieldDiff], list[Any]]]:
         """Get all field diffs with given name.
 
+        :param return_diff: If ``True`` the result is returned as field diff instances, otherwise the result is
+            returned as value instances.
+        :return: A list of ``FieldDiff`` instances.
+        """
+        warnings.warn("get_all() method is deprecated by get_fields() and will be removed soon.", DeprecationWarning)
+        return self.get_fields(return_diff)
+
+    def get_fields(self, return_diff: bool = False) -> dict[str, Union[FieldDiff, Any, list[FieldDiff], list[Any]]]:
+        """Get all field diffs with given name.
+
         :param return_diff: If ``True`` the result is returned as field diff instances, otherwise the result is
             returned as value instances.
         :return: A list of ``FieldDiff`` instances.

packages/core/minos-microservice-aggregate/minos/aggregate/exceptions.py

@@ -14,7 +14,7 @@
     from .entities import (
         RootEntity,
     )
-    from .models import (
+    from .events import (
         Event,
     )
 
@@ -73,3 +73,7 @@ class AlreadyDeletedException(SnapshotRepositoryException):
 
 class ValueObjectException(AggregateException):
     """If an attribute of an immutable class is modified, this exception will be raised"""
+
+
+class RefException(AggregateException):
+    """Exception to be raised when some reference can not be resolved."""