fastapi-factory-utilities 0.3.6__py3-none-any.whl → 0.9.1__py3-none-any.whl

fastapi_factory_utilities/core/plugins/odm_plugin/__init__.py

@@ -1,168 +1,25 @@
-"""Oriented Data Model (ODM) plugin package."""
+"""ODM Plugin Module."""
 
-from logging import INFO, Logger, getLogger
-from typing import Any
-
-from beanie import init_beanie  # pyright: ignore[reportUnknownVariableType]
-from motor.motor_asyncio import AsyncIOMotorClient
-from reactivex import Subject
-from structlog.stdlib import BoundLogger, get_logger
-
-from fastapi_factory_utilities.core.plugins import PluginState
-from fastapi_factory_utilities.core.protocols import ApplicationAbstractProtocol
-from fastapi_factory_utilities.core.services.status.enums import (
-    ComponentTypeEnum,
-    HealthStatusEnum,
-    ReadinessStatusEnum,
-)
-from fastapi_factory_utilities.core.services.status.services import StatusService
-from fastapi_factory_utilities.core.services.status.types import (
-    ComponentInstanceType,
-    Status,
-)
-
-from .builder import ODMBuilder
 from .depends import depends_odm_client, depends_odm_database
 from .documents import BaseDocument
-from .exceptions import OperationError, UnableToCreateEntityDueToDuplicateKeyError
+from .exceptions import (
+    ODMPluginBaseException,
+    ODMPluginConfigError,
+    OperationError,
+    UnableToCreateEntityDueToDuplicateKeyError,
+)
+from .helpers import PersistedEntity
+from .plugins import ODMPlugin
 from .repositories import AbstractRepository
 
-_logger: BoundLogger = get_logger()
-
-
-def pre_conditions_check(application: ApplicationAbstractProtocol) -> bool:
-    """Check the pre-conditions for the OpenTelemetry plugin.
-
-    Args:
-        application (BaseApplicationProtocol): The application.
-
-    Returns:
-        bool: True if the pre-conditions are met, False otherwise.
-    """
-    del application
-    return True
-
-
-def on_load(
-    application: ApplicationAbstractProtocol,
-) -> list["PluginState"] | None:
-    """Actions to perform on load for the OpenTelemetry plugin.
-
-    Args:
-        application (BaseApplicationProtocol): The application.
-    """
-    del application
-    # Configure the pymongo logger to INFO level
-    pymongo_logger: Logger = getLogger("pymongo")
-    pymongo_logger.setLevel(INFO)
-    _logger.debug("ODM plugin loaded.")
-
-
-async def on_startup(
-    application: ApplicationAbstractProtocol,
-) -> list["PluginState"] | None:
-    """Actions to perform on startup for the ODM plugin.
-
-    Args:
-        application (BaseApplicationProtocol): The application.
-        odm_config (ODMConfig): The ODM configuration.
-
-    Returns:
-        None
-    """
-    states: list[PluginState] = []
-
-    status_service: StatusService = application.get_status_service()
-    component_instance: ComponentInstanceType = ComponentInstanceType(
-        component_type=ComponentTypeEnum.DATABASE, identifier="MongoDB"
-    )
-    monitoring_subject: Subject[Status] = status_service.register_component_instance(
-        component_instance=component_instance
-    )
-
-    try:
-        odm_factory: ODMBuilder = ODMBuilder(application=application).build_all()
-        await odm_factory.wait_ping()
-    except Exception as exception:  # pylint: disable=broad-except
-        _logger.error(f"ODM plugin failed to start. {exception}")
-        # TODO: Report the error to the status_service
-        # this will report the application as unhealthy
-        monitoring_subject.on_next(
-            value=Status(health=HealthStatusEnum.UNHEALTHY, readiness=ReadinessStatusEnum.NOT_READY)
-        )
-        return states
-
-    if odm_factory.odm_database is None or odm_factory.odm_client is None:
-        _logger.error(
-            f"ODM plugin failed to start. Database: {odm_factory.odm_database} - " f"Client: {odm_factory.odm_client}"
-        )
-        # TODO: Report the error to the status_service
-        # this will report the application as unhealthy
-        monitoring_subject.on_next(
-            value=Status(health=HealthStatusEnum.UNHEALTHY, readiness=ReadinessStatusEnum.NOT_READY)
-        )
-        return states
-
-    # Add the ODM client and database to the application state
-    states.append(
-        PluginState(key="odm_client", value=odm_factory.odm_client),
-    )
-    states.append(
-        PluginState(
-            key="odm_database",
-            value=odm_factory.odm_database,
-        ),
-    )
-
-    # TODO: Find a better way to initialize beanie with the document models of the concrete application
-    # through an hook in the application, a dynamis import ?
-    try:
-        await init_beanie(
-            database=odm_factory.odm_database,
-            document_models=application.ODM_DOCUMENT_MODELS,
-        )
-    except Exception as exception:  # pylint: disable=broad-except
-        _logger.error(f"ODM plugin failed to start. {exception}")
-        # TODO: Report the error to the status_service
-        # this will report the application as unhealthy
-        monitoring_subject.on_next(
-            value=Status(health=HealthStatusEnum.UNHEALTHY, readiness=ReadinessStatusEnum.NOT_READY)
-        )
-        return states
-
-    _logger.info(
-        f"ODM plugin started. Database: {odm_factory.odm_database.name} - "
-        f"Client: {odm_factory.odm_client.address} - "
-        f"Document models: {application.ODM_DOCUMENT_MODELS}"
-    )
-
-    monitoring_subject.on_next(value=Status(health=HealthStatusEnum.HEALTHY, readiness=ReadinessStatusEnum.READY))
-
-    return states
-
-
-async def on_shutdown(application: ApplicationAbstractProtocol) -> None:
-    """Actions to perform on shutdown for the ODM plugin.
-
-    Args:
-        application (BaseApplicationProtocol): The application.
-
-    Returns:
-        None
-    """
-    # Skip if the ODM plugin was not started correctly
-    if not hasattr(application.get_asgi_app().state, "odm_client"):
-        return
-
-    client: AsyncIOMotorClient[Any] = application.get_asgi_app().state.odm_client
-    client.close()
-    _logger.debug("ODM plugin shutdown.")
-
-
 __all__: list[str] = [
-    "BaseDocument",
     "AbstractRepository",
+    "BaseDocument",
+    "ODMPlugin",
+    "ODMPluginBaseException",
+    "ODMPluginConfigError",
     "OperationError",
+    "PersistedEntity",
     "UnableToCreateEntityDueToDuplicateKeyError",
     "depends_odm_client",
     "depends_odm_database",

fastapi_factory_utilities/core/plugins/odm_plugin/builder.py

@@ -3,7 +3,8 @@
 from typing import Any, ClassVar, Self
 
 from bson import CodecOptions
-from motor.motor_asyncio import AsyncIOMotorClient, AsyncIOMotorDatabase
+from pymongo.asynchronous.database import AsyncDatabase
+from pymongo.asynchronous.mongo_client import AsyncMongoClient
 from pymongo.server_api import ServerApi, ServerApiVersion
 from structlog.stdlib import get_logger
 
@@ -45,22 +46,22 @@ class ODMBuilder:
         self,
         application: ApplicationAbstractProtocol,
         odm_config: ODMConfig | None = None,
-        odm_client: AsyncIOMotorClient[Any] | None = None,
-        odm_database: AsyncIOMotorDatabase[Any] | None = None,
+        odm_client: AsyncMongoClient[Any] | None = None,
+        odm_database: AsyncDatabase[Any] | None = None,
     ) -> None:
         """Initialize the ODMFactory.
 
         Args:
             application (BaseApplicationProtocol): The application.
             odm_config (ODMConfig): The ODM configuration for injection. (Default is None)
-            odm_client (AsyncIOMotorClient): The ODM client for injection. (Default is None)
-            odm_database (AsyncIOMotorDatabase): The ODM database for injection. (Default is None)
+            odm_client (AsyncMongoClient): The ODM client for injection. (Default is None)
+            odm_database (AsyncDatabase): The ODM database for injection. (Default is None)
 
         """
         self._application: ApplicationAbstractProtocol = application
         self._config: ODMConfig | None = odm_config
-        self._odm_client: AsyncIOMotorClient[Any] | None = odm_client
-        self._odm_database: AsyncIOMotorDatabase[Any] | None = odm_database
+        self._odm_client: AsyncMongoClient[Any] | None = odm_client
+        self._odm_database: AsyncDatabase[Any] | None = odm_database
 
     @property
     def config(self) -> ODMConfig | None:
@@ -72,20 +73,20 @@ class ODMBuilder:
         return self._config
 
     @property
-    def odm_client(self) -> AsyncIOMotorClient[Any] | None:
+    def odm_client(self) -> AsyncMongoClient[Any] | None:
         """Provide the ODM client.
 
         Returns:
-            AsyncIOMotorClient | None: The ODM client.
+            AsyncMongoClient | None: The ODM client.
         """
         return self._odm_client
 
     @property
-    def odm_database(self) -> AsyncIOMotorDatabase[Any] | None:
+    def odm_database(self) -> AsyncDatabase[Any] | None:
         """Provide the ODM database.
 
         Returns:
-            AsyncIOMotorDatabase | None: The ODM database.
+            AsyncDatabase | None: The ODM database.
         """
         return self._odm_database
 
@@ -174,7 +175,7 @@ class ODMBuilder:
                 "build_odm_config method or through parameter."
             )
 
-        self._odm_client = AsyncIOMotorClient(
+        self._odm_client = AsyncMongoClient(
             host=self._config.uri,
             connect=True,
             connectTimeoutMS=self._config.connection_timeout_ms,
@@ -215,7 +216,7 @@ class ODMBuilder:
 
         if self._odm_client is None:
             raise ODMPluginConfigError(
-                "ODM client is not set. Provide the ODM client using " "build_client method or through parameter."
+                "ODM client is not set. Provide the ODM client using build_client method or through parameter."
             )
 
         self._odm_database = self._odm_client.get_database(
@@ -241,19 +242,3 @@ class ODMBuilder:
         self.build_database()
 
         return self
-
-    async def wait_ping(self):
-        """Wait for the ODM client to be ready.
-
-        Returns:
-            Self: The ODM factory.
-        """
-        if self._odm_client is None:
-            raise ODMPluginConfigError(
-                "ODM client is not set. Provide the ODM client using " "build_client method or through parameter."
-            )
-
-        try:
-            await self._odm_client.admin.command("ping")
-        except Exception as exception:  # pylint: disable=broad-except
-            raise ODMPluginConfigError("Unable to ping the ODM client.") from exception

fastapi_factory_utilities/core/plugins/odm_plugin/configs.py

@@ -12,4 +12,4 @@ class ODMConfig(BaseModel):
 
     database: str = "test"
 
-    connection_timeout_ms: int = 1000
+    connection_timeout_ms: int = 4000

fastapi_factory_utilities/core/plugins/odm_plugin/depends.py

@@ -3,10 +3,11 @@
 from typing import Any
 
 from fastapi import Request
-from motor.motor_asyncio import AsyncIOMotorClient, AsyncIOMotorDatabase
+from pymongo.asynchronous.database import AsyncDatabase
+from pymongo.asynchronous.mongo_client import AsyncMongoClient
 
 
-def depends_odm_client(request: Request) -> AsyncIOMotorClient[Any]:
+def depends_odm_client(request: Request) -> AsyncMongoClient[Any]:
     """Acquire the ODM client from the request.
 
     Args:
@@ -18,7 +19,7 @@ def depends_odm_client(request: Request) -> AsyncIOMotorClient[Any]:
     return request.app.state.odm_client
 
 
-def depends_odm_database(request: Request) -> AsyncIOMotorDatabase[Any]:
+def depends_odm_database(request: Request) -> AsyncDatabase[Any]:
     """Acquire the ODM database from the request.
 
     Args:

fastapi_factory_utilities/core/plugins/odm_plugin/documents.py

@@ -13,7 +13,7 @@ class BaseDocument(Document):
     """Base document class."""
 
     # To be agnostic of MongoDN, we use UUID as the document ID.
-    id: UUID = Field(  # pyright: ignore[reportIncompatibleVariableOverride]
+    id: UUID = Field(  # type: ignore
         default_factory=uuid4, description="The document ID."
     )
 

fastapi_factory_utilities/core/plugins/odm_plugin/helpers.py

@@ -0,0 +1,16 @@
+"""Helper functions for ODM plugins."""
+
+import datetime
+import uuid
+
+from pydantic import BaseModel, Field
+
+
+class PersistedEntity(BaseModel):
+    """Base class for persisted entities."""
+
+    id: uuid.UUID = Field(default_factory=uuid.uuid4)
+
+    revision_id: uuid.UUID | None = Field(default=None)
+    created_at: datetime.datetime = Field(default_factory=datetime.datetime.now)
+    updated_at: datetime.datetime = Field(default_factory=datetime.datetime.now)

fastapi_factory_utilities/core/plugins/odm_plugin/plugins.py

@@ -0,0 +1,153 @@
+"""Oriented Data Model (ODM) plugin package."""
+
+from logging import INFO, Logger, getLogger
+from typing import Any, Self, cast
+
+from beanie import Document, init_beanie  # pyright: ignore[reportUnknownVariableType]
+from pymongo.asynchronous.database import AsyncDatabase
+from pymongo.asynchronous.mongo_client import AsyncMongoClient
+from reactivex import Subject
+from structlog.stdlib import BoundLogger, get_logger
+
+from fastapi_factory_utilities.core.plugins.abstracts import PluginAbstract
+from fastapi_factory_utilities.core.protocols import ApplicationAbstractProtocol
+from fastapi_factory_utilities.core.services.status.enums import (
+    ComponentTypeEnum,
+    HealthStatusEnum,
+    ReadinessStatusEnum,
+)
+from fastapi_factory_utilities.core.services.status.services import StatusService
+from fastapi_factory_utilities.core.services.status.types import (
+    ComponentInstanceType,
+    Status,
+)
+
+from .builder import ODMBuilder
+from .configs import ODMConfig
+from .depends import depends_odm_client, depends_odm_database
+from .documents import BaseDocument
+from .exceptions import OperationError, UnableToCreateEntityDueToDuplicateKeyError
+from .helpers import PersistedEntity
+from .repositories import AbstractRepository
+
+_logger: BoundLogger = get_logger()
+
+
+class ODMPlugin(PluginAbstract):
+    """ODM plugin."""
+
+    def __init__(
+        self, document_models: list[type[Document]] | None = None, odm_config: ODMConfig | None = None
+    ) -> None:
+        """Initialize the ODM plugin."""
+        super().__init__()
+        self._component_instance: ComponentInstanceType | None = None
+        self._monitoring_subject: Subject[Status] | None = None
+        self._document_models: list[type[Document]] | None = document_models
+        self._odm_config: ODMConfig | None = odm_config
+        self._odm_client: AsyncMongoClient[Any] | None = None
+        self._odm_database: AsyncDatabase[Any] | None = None
+
+    def set_application(self, application: ApplicationAbstractProtocol) -> Self:
+        """Set the application."""
+        self._document_models = self._document_models or application.ODM_DOCUMENT_MODELS
+        return super().set_application(application)
+
+    def on_load(self) -> None:
+        """Actions to perform on load for the ODM plugin."""
+        # Configure the pymongo logger to INFO level
+
+        pymongo_logger: Logger = getLogger("pymongo")
+        pymongo_logger.setLevel(INFO)
+        _logger.debug("ODM plugin loaded.")
+
+    def _setup_status(self) -> None:
+        assert self._application is not None
+        status_service: StatusService = self._application.get_status_service()
+        self._component_instance = ComponentInstanceType(
+            component_type=ComponentTypeEnum.DATABASE, identifier="MongoDB"
+        )
+        self._monitoring_subject = status_service.register_component_instance(
+            component_instance=self._component_instance
+        )
+
+    async def _setup_beanie(self) -> None:
+        assert self._application is not None
+        assert self._odm_database is not None
+        assert self._document_models is not None
+        assert self._monitoring_subject is not None
+        # TODO: Find a better way to initialize beanie with the document models of the concrete application
+        # through an hook in the application, a dynamis import ?
+        try:
+            await init_beanie(
+                database=self._odm_database,
+                document_models=self._document_models,
+            )
+        except Exception as exception:  # pylint: disable=broad-except
+            _logger.error(f"ODM plugin failed to start. {exception}")
+            # TODO: Report the error to the status_service
+            # this will report the application as unhealthy
+            self._monitoring_subject.on_next(
+                value=Status(health=HealthStatusEnum.UNHEALTHY, readiness=ReadinessStatusEnum.NOT_READY)
+            )
+
+    async def on_startup(self) -> None:
+        """Actions to perform on startup for the ODM plugin."""
+        host: str
+        port: int
+        assert self._application is not None
+        self._setup_status()
+        assert self._monitoring_subject is not None
+        assert self._component_instance is not None
+
+        try:
+            odm_factory: ODMBuilder = ODMBuilder(application=self._application, odm_config=self._odm_config).build_all()
+            assert odm_factory.odm_client is not None
+            assert odm_factory.odm_database is not None
+            assert (await odm_factory.odm_client.address) is not None
+            host, port = cast(tuple[str, int], await odm_factory.odm_client.address)
+            await odm_factory.odm_client.aconnect()
+            self._odm_database = odm_factory.odm_database
+            self._odm_client = odm_factory.odm_client
+        except Exception as exception:  # pylint: disable=broad-except
+            _logger.error(f"ODM plugin failed to start. {exception}")
+            # TODO: Report the error to the status_service
+            # this will report the application as unhealthy
+            self._monitoring_subject.on_next(
+                value=Status(health=HealthStatusEnum.UNHEALTHY, readiness=ReadinessStatusEnum.NOT_READY)
+            )
+            return None
+
+        self._add_to_state(key="odm_client", value=odm_factory.odm_client)
+        self._add_to_state(key="odm_database", value=odm_factory.odm_database)
+
+        await self._setup_beanie()
+
+        assert self._odm_client is not None
+
+        _logger.info(
+            f"ODM plugin started. Database: {self._odm_database.name} - "
+            f"Client: {host}:{port} - "
+            f"Document models: {self._application.ODM_DOCUMENT_MODELS}"
+        )
+
+        self._monitoring_subject.on_next(
+            value=Status(health=HealthStatusEnum.HEALTHY, readiness=ReadinessStatusEnum.READY)
+        )
+
+    async def on_shutdown(self) -> None:
+        """Actions to perform on shutdown for the ODM plugin."""
+        if self._odm_client is not None:
+            await self._odm_client.close()
+        _logger.debug("ODM plugin shutdown.")
+
+
+__all__: list[str] = [
+    "AbstractRepository",
+    "BaseDocument",
+    "OperationError",
+    "PersistedEntity",
+    "UnableToCreateEntityDueToDuplicateKeyError",
+    "depends_odm_client",
+    "depends_odm_database",
+]

fastapi_factory_utilities/core/plugins/odm_plugin/repositories.py

@@ -8,8 +8,9 @@ from typing import Any, Generic, TypeVar, get_args
 from uuid import UUID
 
 from beanie import SortDirection
-from motor.motor_asyncio import AsyncIOMotorClientSession, AsyncIOMotorDatabase
 from pydantic import BaseModel
+from pymongo.asynchronous.client_session import AsyncClientSession
+from pymongo.asynchronous.database import AsyncDatabase
 from pymongo.errors import DuplicateKeyError, PyMongoError
 from pymongo.results import DeleteResult
 
@@ -43,28 +44,30 @@ def managed_session() -> Callable[[Callable[..., Any]], Callable[..., Any]]:
 class AbstractRepository(ABC, Generic[DocumentGenericType, EntityGenericType]):
     """Abstract class for the repository."""
 
-    def __init__(self, database: AsyncIOMotorDatabase[Any]) -> None:
+    def __init__(self, database: AsyncDatabase[Any]) -> None:
         """Initialize the repository."""
         super().__init__()
-        self._database: AsyncIOMotorDatabase[Any] = database
+        self._database: AsyncDatabase[Any] = database
         # Retrieve the generic concrete types
         generic_args: tuple[Any, ...] = get_args(self.__orig_bases__[0])  # type: ignore
         self._document_type: type[DocumentGenericType] = generic_args[0]
         self._entity_type: type[EntityGenericType] = generic_args[1]
 
     @asynccontextmanager
-    async def get_session(self) -> AsyncGenerator[AsyncIOMotorClientSession, None]:
+    async def get_session(self) -> AsyncGenerator[AsyncClientSession, None]:
         """Yield a new session."""
+        session: AsyncClientSession | None = None
         try:
-            async with await self._database.client.start_session() as session:
-                yield session
+            session = self._database.client.start_session()
+            yield session
         except PyMongoError as error:
             raise OperationError(f"Failed to create session: {error}") from error
+        finally:
+            if session is not None:
+                await session.end_session()
 
     @managed_session()
-    async def insert(
-        self, entity: EntityGenericType, session: AsyncIOMotorClientSession | None = None
-    ) -> EntityGenericType:
+    async def insert(self, entity: EntityGenericType, session: AsyncClientSession | None = None) -> EntityGenericType:
         """Insert the entity into the database.
 
         Args:
@@ -104,9 +107,7 @@ class AbstractRepository(ABC, Generic[DocumentGenericType, EntityGenericType]):
         return entity_created
 
     @managed_session()
-    async def update(
-        self, entity: EntityGenericType, session: AsyncIOMotorClientSession | None = None
-    ) -> EntityGenericType:
+    async def update(self, entity: EntityGenericType, session: AsyncClientSession | None = None) -> EntityGenericType:
         """Update the entity in the database.
 
         Args:
@@ -145,7 +146,7 @@ class AbstractRepository(ABC, Generic[DocumentGenericType, EntityGenericType]):
     async def get_one_by_id(
         self,
         entity_id: UUID,
-        session: AsyncIOMotorClientSession | None = None,
+        session: AsyncClientSession | None = None,
     ) -> EntityGenericType | None:
         """Get the entity by its ID.
 
@@ -179,7 +180,7 @@ class AbstractRepository(ABC, Generic[DocumentGenericType, EntityGenericType]):
 
     @managed_session()
     async def delete_one_by_id(
-        self, entity_id: UUID, raise_if_not_found: bool = False, session: AsyncIOMotorClientSession | None = None
+        self, entity_id: UUID, raise_if_not_found: bool = False, session: AsyncClientSession | None = None
     ) -> None:
         """Delete a document by its ID.
 
@@ -224,7 +225,7 @@ class AbstractRepository(ABC, Generic[DocumentGenericType, EntityGenericType]):
         skip: int | None = None,
         limit: int | None = None,
         sort: None | str | list[tuple[str, SortDirection]] = None,
-        session: AsyncIOMotorClientSession | None = None,
+        session: AsyncClientSession | None = None,
         ignore_cache: bool = False,
         fetch_links: bool = False,
         lazy_parse: bool = False,
@@ -268,6 +269,7 @@ class AbstractRepository(ABC, Generic[DocumentGenericType, EntityGenericType]):
                 lazy_parse=lazy_parse,
                 nesting_depth=nesting_depth,
                 nesting_depths_per_field=nesting_depths_per_field,
+                **pymongo_kwargs,
             ).to_list()
         except PyMongoError as error:
             raise OperationError(f"Failed to find documents: {error}") from error