Merge pull request #62 from febus982/add_events_support

Add events support

Author: febus982

.coveragerc

@@ -1,6 +1,6 @@
 [run]
 branch = True
-source = http_app, grpc_app, domains, storage
+source = http_app, grpc_app, domains, gateways
 omit = grpc_app/generated/*
 concurrency = multiprocessing
 parallel = true

.idea/bootstrap-fastapi-service.iml

@@ -65,7 +65,7 @@ COPY --chown=nonroot:nonroot pyproject.toml .
 COPY --chown=nonroot:nonroot poetry.lock .
 COPY --chown=nonroot:nonroot alembic ./alembic
 COPY --chown=nonroot:nonroot domains ./domains
-COPY --chown=nonroot:nonroot storage ./storage
+COPY --chown=nonroot:nonroot gateways ./gateways
 COPY --chown=nonroot:nonroot config.py .
 COPY --chown=nonroot:nonroot di_container.py .
 COPY --chown=nonroot:nonroot alembic.ini .

Dockerfile

@@ -5,7 +5,7 @@
 
 from alembic import context
 from config import AppConfig, init_logger
-from storage.SQLAlchemy import init_tables
+from gateways.storage.SQLAlchemy import init_tables
 
 USE_TWOPHASE = False
 

alembic/env.py

@@ -7,36 +7,44 @@ package http_app {
 }
 
 package grpc_app {
-    package services #DDDDDD
+    package servicers #DDDDDD
 }
 
 package domains #DDDDDD {
     package books {
         class Book
         class BookService
-        protocol BookRepositoryInterface
-        class BookModel
+
+        package entities {
+            class BookModel
+        }
+
+        package data_access_interface {
+            protocol BookRepositoryInterface
+            protocol BookEventGatewayInterface
+        }
     }
 }
 
-package storage #DDDDDD {
-    package Repositories {
-        class SQLAlchemyRepository
-    }
+package gateways #DDDDDD {
+    class SQLAlchemyRepository
+    class NullEventGateway
 }
 
+
 'links framework - domains
 routes --> BookService
 routes --> Book
-services --> BookService
-services --> Book
+servicers --> BookService
+servicers --> Book
 
 'links internal to books domain
 BookService -l-> Book
-BookService --> BookModel
-BookService --> BookRepositoryInterface
-BookRepositoryInterface -l-> BookModel
+BookService --> entities
+BookService -r-> data_access_interface
+data_access_interface --> entities
+
+'links domains - gateways
+gateways --|> data_access_interface: implements >
 
-'links domains - storage
-SQLAlchemyRepository --d-|> BookRepositoryInterface: implements >
 @enduml

architecture.png

@@ -4,8 +4,12 @@
 from sqlalchemy_bind_manager._repository import SQLAlchemyAsyncRepository
 
 from config import AppConfig
-from domains.books._data_access_interfaces import BookRepositoryInterface
-from domains.books._models import BookModel
+from domains.books._data_access_interfaces import (
+    BookEventGatewayInterface,
+    BookRepositoryInterface,
+)
+from domains.books.models import BookModel
+from gateways.event import NullEventGateway
 
 
 class Container(DeclarativeContainer):
@@ -17,7 +21,7 @@ class Container(DeclarativeContainer):
 
     wiring_config = WiringConfiguration(
         packages=[
-            "storage",
+            "gateways",
             "domains",
         ]
     )
@@ -61,3 +65,6 @@ def function(
         bind=SQLAlchemyBindManager.provided.get_bind.call(),
         model_class=BookModel,
     )
+    BookEventGatewayInterface: Factory[BookEventGatewayInterface] = Factory(
+        NullEventGateway
+    )

architecture.puml

@@ -27,8 +27,9 @@ def inject_book_repository(f):
     @wraps(f)
     def wrapper(*args, **kwds):
         if "book_repository" not in kwds.keys():
-            from storage.repositories.book_repository import BookRepository
-            kwds["book_repository"] = BookRepository()  # Here we'll have to pass any required dependency for the repository
+            from gateways.storage import BookRepository
+            kwds[
+                "book_repository"] = BookRepository()  # Here we'll have to pass any required dependency for the repository
         elif not isinstance(kwds["book_repository"], BookRepositoryInterface):
             import warnings
             warnings.warn(
@@ -52,6 +53,6 @@ def book_repository_factory(sa_manager: SQLAlchemyBindManager) -> BookRepository
     Returns:
         The book repository.
     """
-    from storage.repositories.book_repository import BookRepository
+    from gateways.storage import BookRepository
     return BookRepository(sa_manager=sa_manager)
 ```

di_container.py

@@ -1,2 +0,0 @@
-from ._dto import Book, BookData
-from ._service import BookService

domains/README.md

@@ -3,7 +3,8 @@
 
 from sqlalchemy_bind_manager.repository import SortDirection
 
-from ._models import BookModel
+from domains.books.models import BookModel
+from domains.cloudevent_base import BaseEvent
 
 
 class BookRepositoryInterface(Protocol):
@@ -16,3 +17,8 @@ async def find(
         order_by: Union[None, Iterable[Union[str, Tuple[str, SortDirection]]]] = None,
     ) -> List[BookModel]:
         ...
+
+
+class BookEventGatewayInterface(Protocol):
+    async def emit(self, event: BaseEvent) -> None:
+        ...