Feature/refactor repo layer (#16)

EdwardPham1615 · web-flow · commit b27980390f5c · 2025-12-12T00:23:29.000+07:00
* update libs

* update libs

* move abstractions and repositories from infrastructure layer to domain layer

* move unit of work from infrastructure layer to patterns

* re-init and reimport new repos and abstractions

* update README.md about new project structure
diff --git a/README.md b/README.md
@@ -34,6 +34,8 @@ By following Clean Architecture, this project ensures that the core business log
 ├──────────────────────────────┤
 │          Use Cases          │  → Encapsulates core business logic
 ├──────────────────────────────┤
+│         Repositories        │  → Acts as an adapter that decouples the business layer from the infrastructure
+├──────────────────────────────┤
 │ Infrastructures (DB, Cache) │  → Handles external dependencies like databases & queues
 └──────────────────────────────┘
 ```
@@ -69,16 +71,16 @@ The **Unit of Work pattern** ensures that multiple repository operations are **e
 internal/
 │── app/              # Defines servers and middlewares (protocols)
 │── controllers/      # Handles requests and responses (endpoints)
-│── domains/          # Core business logic (services, use cases, entities)
+│── domains/          # Core business logic (services, use cases, entities, repositories)
 │── infrastructures/  # External dependencies (databases, caches, queues)
-│── patterns/         # Dependency injection
+│── patterns/         # Dependency injection, Unit Of Work
 └── main.py           # Application entry point
 ```
 
 - **App**: Define servers (protocols) and middlewares.
 - **Controllers**: Define the API endpoints and route requests to services.
-- **Domains**: Contains core business logic, including services and use cases.
-- **Infrastructures**: Houses repositories and database interactions.
+- **Domains**: Contains core business logic, including services, use cases, and repositories.
+- **Infrastructures**: Database interactions, other third-party services.
 - **Patterns**: Implements design patterns like Dependency Injection and Unit of Work.
 - **Main.py**: Initializes the application, including dependency injection and routing setup.
 
diff --git a/internal/domains/repositories/__init__.py b/internal/domains/repositories/__init__.py
diff --git a/internal/domains/repositories/abstraction/__init__.py b/internal/domains/repositories/abstraction/__init__.py
diff --git a/internal/domains/repositories/abstraction/comment.py b/internal/domains/repositories/abstraction/comment.py
diff --git a/internal/domains/repositories/abstraction/post.py b/internal/domains/repositories/abstraction/post.py
diff --git a/internal/domains/repositories/abstraction/user.py b/internal/domains/repositories/abstraction/user.py
diff --git a/internal/domains/repositories/comment.py b/internal/domains/repositories/comment.py
@@ -5,7 +5,7 @@
 from sqlalchemy.ext.asyncio import AsyncSession
 
 from internal.domains.entities import CommentEntity, GetMultiCommentsFilter
-from internal.infrastructures.relational_db.abstraction import AbstractCommentRepo
+from internal.domains.repositories.abstraction.comment import AbstractCommentRepo
 from internal.infrastructures.relational_db.postgres.models import (
     Comment,
     CommentModelMapper,
diff --git a/internal/domains/repositories/post.py b/internal/domains/repositories/post.py
@@ -5,7 +5,7 @@
 from sqlalchemy.ext.asyncio import AsyncSession
 
 from internal.domains.entities import GetMultiPostsFilter, PostEntity
-from internal.infrastructures.relational_db.abstraction import AbstractPostRepo
+from internal.domains.repositories.abstraction.post import AbstractPostRepo
 from internal.infrastructures.relational_db.postgres.models import Post, PostModelMapper
 from utils.time_utils import DATETIME_DEFAULT_FORMAT, from_str_to_dt
 
diff --git a/internal/domains/repositories/user.py b/internal/domains/repositories/user.py
@@ -5,7 +5,7 @@
 from sqlalchemy.ext.asyncio import AsyncSession
 
 from internal.domains.entities import UserEntity
-from internal.infrastructures.relational_db.abstraction import AbstractUserRepo
+from internal.domains.repositories.abstraction.user import AbstractUserRepo
 from internal.infrastructures.relational_db.postgres.models import User, UserModelMapper
 
 
diff --git a/internal/domains/services/authentication.py b/internal/domains/services/authentication.py
@@ -17,9 +17,7 @@
     AbstractAuthenticationUC,
     AbstractUserUC,
 )
-from internal.infrastructures.relational_db.patterns import (
-    AbstractUnitOfWork as RelationalDBUnitOfWork,
-)
+from internal.patterns import AbstractUnitOfWork as RelationalDBUnitOfWork
 from utils.logger_utils import get_shared_logger
 from utils.time_utils import DATETIME_DEFAULT_FORMAT, from_dt_to_str
 
diff --git a/internal/domains/services/comment.py b/internal/domains/services/comment.py
@@ -25,9 +25,7 @@
     AbstractCommentUC,
     AbstractUserUC,
 )
-from internal.infrastructures.relational_db.patterns import (
-    AbstractUnitOfWork as RelationalDBUnitOfWork,
-)
+from internal.patterns import AbstractUnitOfWork as RelationalDBUnitOfWork
 from utils.logger_utils import get_shared_logger
 
 logger = get_shared_logger()
diff --git a/internal/domains/services/post.py b/internal/domains/services/post.py
@@ -31,9 +31,7 @@
     AbstractPostUC,
     AbstractUserUC,
 )
-from internal.infrastructures.relational_db.patterns import (
-    AbstractUnitOfWork as RelationalDBUnitOfWork,
-)
+from internal.patterns import AbstractUnitOfWork as RelationalDBUnitOfWork
 from utils.logger_utils import get_shared_logger
 
 logger = get_shared_logger()
diff --git a/internal/domains/services/user.py b/internal/domains/services/user.py
@@ -33,9 +33,7 @@
     AbstractPostUC,
     AbstractUserUC,
 )
-from internal.infrastructures.relational_db.patterns import (
-    AbstractUnitOfWork as RelationalDBUnitOfWork,
-)
+from internal.patterns import AbstractUnitOfWork as RelationalDBUnitOfWork
 from utils.logger_utils import get_shared_logger
 
 logger = get_shared_logger()
diff --git a/internal/domains/usecases/abstraction/comment.py b/internal/domains/usecases/abstraction/comment.py
@@ -8,9 +8,7 @@
     GetMultiCommentsFilter,
     UpdateCommentPayload,
 )
-from internal.infrastructures.relational_db.patterns import (
-    AbstractUnitOfWork as RelationalDBUnitOfWork,
-)
+from internal.patterns import AbstractUnitOfWork as RelationalDBUnitOfWork
 
 
 class AbstractCommentUC(abc.ABC):
diff --git a/internal/domains/usecases/abstraction/post.py b/internal/domains/usecases/abstraction/post.py
@@ -8,9 +8,7 @@
     PostEntity,
     UpdatePostPayload,
 )
-from internal.infrastructures.relational_db.patterns import (
-    AbstractUnitOfWork as RelationalDBUnitOfWork,
-)
+from internal.patterns import AbstractUnitOfWork as RelationalDBUnitOfWork
 
 
 class AbstractPostUC(abc.ABC):
diff --git a/internal/domains/usecases/abstraction/user.py b/internal/domains/usecases/abstraction/user.py
@@ -2,9 +2,7 @@
 from typing import Optional
 
 from internal.domains.entities import CreateUserPayload, UpdateUserPayload, UserEntity
-from internal.infrastructures.relational_db.patterns import (
-    AbstractUnitOfWork as RelationalDBUnitOfWork,
-)
+from internal.patterns import AbstractUnitOfWork as RelationalDBUnitOfWork
 
 
 class AbstractUserUC(abc.ABC):
diff --git a/internal/domains/usecases/comment.py b/internal/domains/usecases/comment.py
@@ -18,9 +18,7 @@
     UpdateCommentException,
 )
 from internal.domains.usecases.abstraction import AbstractCommentUC
-from internal.infrastructures.relational_db.patterns import (
-    AbstractUnitOfWork as RelationalDBUnitOfWork,
-)
+from internal.patterns import AbstractUnitOfWork as RelationalDBUnitOfWork
 from utils.logger_utils import get_shared_logger
 from utils.time_utils import DATETIME_DEFAULT_FORMAT, from_str_to_dt
 
diff --git a/internal/domains/usecases/post.py b/internal/domains/usecases/post.py
@@ -18,9 +18,7 @@
     UpdatePostException,
 )
 from internal.domains.usecases.abstraction import AbstractPostUC
-from internal.infrastructures.relational_db.patterns import (
-    AbstractUnitOfWork as RelationalDBUnitOfWork,
-)
+from internal.patterns import AbstractUnitOfWork as RelationalDBUnitOfWork
 from utils.logger_utils import get_shared_logger
 from utils.time_utils import DATETIME_DEFAULT_FORMAT, from_str_to_dt
 
diff --git a/internal/domains/usecases/user.py b/internal/domains/usecases/user.py
@@ -12,9 +12,7 @@
     UpdateUserException,
 )
 from internal.domains.usecases.abstraction import AbstractUserUC
-from internal.infrastructures.relational_db.patterns import (
-    AbstractUnitOfWork as RelationalDBUnitOfWork,
-)
+from internal.patterns import AbstractUnitOfWork as RelationalDBUnitOfWork
 from utils.logger_utils import get_shared_logger
 from utils.time_utils import DATETIME_DEFAULT_FORMAT, from_str_to_dt
 
diff --git a/internal/infrastructures/relational_db/__init__.py b/internal/infrastructures/relational_db/__init__.py
@@ -2,7 +2,6 @@
 
 from config import app_config
 
-from .abstraction import AbstractCommentRepo, AbstractPostRepo, AbstractUserRepo
 from .base import Base
 from .postgres import PostgresDatabase
 
@@ -17,12 +16,5 @@ class SupportedDatabaseVendor(str, Enum):
     from internal.infrastructures.relational_db.postgres import (
         PostgresDatabase as Database,
     )
-
-    # repositories
-    from internal.infrastructures.relational_db.postgres.repositories import (
-        CommentRepo,
-        PostRepo,
-        UserRepo,
-    )
 else:
     raise RuntimeError(f"Invalid database vendor {DATABASE_VENDOR}")
diff --git a/internal/infrastructures/relational_db/patterns/__init__.py b/internal/infrastructures/relational_db/patterns/__init__.py
diff --git a/internal/patterns/__init__.py b/internal/patterns/__init__.py
@@ -1 +1,2 @@
 from .dependency_injection import Container, initialize_relational_db
+from .unit_of_work import AbstractUnitOfWork, AsyncSQLAlchemyUnitOfWork
diff --git a/internal/patterns/dependency_injection.py b/internal/patterns/dependency_injection.py
@@ -1,6 +1,7 @@
 from dependency_injector import containers, providers
 
 from config import AppConfig
+from internal.domains.repositories import CommentRepo, PostRepo, UserRepo
 from internal.domains.services import AuthenticationSVC, CommentSVC, PostSVC, UserSVC
 from internal.domains.usecases import (
     AuthenticationUC,
@@ -15,14 +16,9 @@
 from internal.infrastructures.external_rebac_authorization_service import (
     ExternalReBACAuthorizationServiceClient,
 )
-from internal.infrastructures.relational_db import (
-    CommentRepo,
-    Database,
-    PostRepo,
-    UserRepo,
-)
+from internal.infrastructures.relational_db import Database
 from internal.infrastructures.relational_db.base import Base
-from internal.infrastructures.relational_db.patterns import AsyncSQLAlchemyUnitOfWork
+from internal.patterns import AsyncSQLAlchemyUnitOfWork
 
 
 class Container(containers.DeclarativeContainer):
diff --git a/internal/patterns/unit_of_work.py b/internal/patterns/unit_of_work.py
@@ -18,8 +18,8 @@
     wait_exponential,
 )
 
-from internal.infrastructures.relational_db import CommentRepo, PostRepo, UserRepo
-from internal.infrastructures.relational_db.abstraction import (
+from internal.domains.repositories import CommentRepo, PostRepo, UserRepo
+from internal.domains.repositories.abstraction import (
     AbstractCommentRepo,
     AbstractPostRepo,
     AbstractUserRepo,
diff --git a/pyproject.toml b/pyproject.toml
@@ -26,10 +26,10 @@ dependencies = [
     "grpcio-tools",
 ]
 
-[tool.uv]
-dev-dependencies = [
+[dependency-groups]
+dev = [
     "ruff",
-    "isort"
+    "isort",
 ]
 
 [tool.ruff]
diff --git a/uv.lock b/uv.lock
