fastapi-factory-utilities 0.3.6__py3-none-any.whl → 0.8.2__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

@@ -215,7 +215,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(
@@ -242,7 +242,7 @@ class ODMBuilder:
 
         return self
 
-    async def wait_ping(self):
+    async def wait_ping(self) -> None:
         """Wait for the ODM client to be ready.
 
         Returns:
@@ -250,7 +250,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."
             )
 
         try:

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/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,155 @@
+"""Oriented Data Model (ODM) plugin package."""
+
+from logging import INFO, Logger, getLogger
+from typing import Any, Self
+
+from beanie import Document, init_beanie  # pyright: ignore[reportUnknownVariableType]
+from motor.motor_asyncio import AsyncIOMotorClient, AsyncIOMotorDatabase
+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: AsyncIOMotorClient[Any] | None = None
+        self._odm_database: AsyncIOMotorDatabase[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."""
+        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()
+            await odm_factory.wait_ping()
+            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
+
+        if self._odm_database is None or self._odm_client is None:
+            _logger.error(
+                f"ODM plugin failed to start. Database: {odm_factory.odm_database} - Client: {odm_factory.odm_client}"
+            )
+            # 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()
+
+        _logger.info(
+            f"ODM plugin started. Database: {self._odm_database.name} - "
+            f"Client: {self._odm_client.address} - "
+            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:
+            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

@@ -268,6 +268,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

fastapi_factory_utilities/core/plugins/opentelemetry_plugin/__init__.py

@@ -1,124 +1,17 @@
 """OpenTelemetry Plugin Module."""
 
-import asyncio
-from typing import cast
-
-from opentelemetry.instrumentation.fastapi import (  # pyright: ignore[reportMissingTypeStubs]
-    FastAPIInstrumentor,
-)
-from opentelemetry.sdk.metrics import MeterProvider
-from opentelemetry.sdk.trace import TracerProvider
-from structlog.stdlib import BoundLogger, get_logger
-
-from fastapi_factory_utilities.core.protocols import ApplicationAbstractProtocol
-
-from .builder import OpenTelemetryPluginBuilder
-from .configs import OpenTelemetryConfig
+from .configs import OpenTelemetryConfig, OpenTelemetryMeterConfig, OpenTelemetryTracerConfig
 from .exceptions import OpenTelemetryPluginBaseException, OpenTelemetryPluginConfigError
+from .plugins import OpenTelemetryPlugin, depends_meter_provider, depends_otel_config, depends_tracer_provider
 
 __all__: list[str] = [
     "OpenTelemetryConfig",
+    "OpenTelemetryMeterConfig",
+    "OpenTelemetryPlugin",
     "OpenTelemetryPluginBaseException",
     "OpenTelemetryPluginConfigError",
-    "OpenTelemetryPluginBuilder",
+    "OpenTelemetryTracerConfig",
+    "depends_meter_provider",
+    "depends_otel_config",
+    "depends_tracer_provider",
 ]
-
-_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,
-) -> None:
-    """Actions to perform on load for the OpenTelemetry plugin.
-
-    Args:
-        application (BaseApplicationProtocol): The application.
-    """
-    # Build the OpenTelemetry Resources, TracerProvider and MeterProvider
-    try:
-        otel_builder: OpenTelemetryPluginBuilder = OpenTelemetryPluginBuilder(application=application).build_all()
-    except OpenTelemetryPluginBaseException as exception:
-        _logger.error(f"OpenTelemetry plugin failed to start. {exception}")
-        return
-    # Configuration is never None at this point (checked in the builder and raises an exception)
-    otel_config: OpenTelemetryConfig = cast(OpenTelemetryConfig, otel_builder.config)
-    # Save as state in the FastAPI application
-    application.get_asgi_app().state.tracer_provider = otel_builder.tracer_provider
-    application.get_asgi_app().state.meter_provider = otel_builder.meter_provider
-    application.get_asgi_app().state.otel_config = otel_config
-    # Instrument the FastAPI application
-    FastAPIInstrumentor.instrument_app(  # pyright: ignore[reportUnknownMemberType]
-        app=application.get_asgi_app(),
-        tracer_provider=otel_builder.tracer_provider,
-        meter_provider=otel_builder.meter_provider,
-        excluded_urls=otel_config.excluded_urls,
-    )
-
-    _logger.debug(f"OpenTelemetry plugin loaded. {otel_config.activate=}")
-
-
-async def on_startup(
-    application: ApplicationAbstractProtocol,
-) -> None:
-    """Actions to perform on startup for the OpenTelemetry plugin.
-
-    Args:
-        application (BaseApplicationProtocol): The application.
-
-    Returns:
-        None
-    """
-    del application
-    _logger.debug("OpenTelemetry plugin started.")
-
-
-async def on_shutdown(application: ApplicationAbstractProtocol) -> None:
-    """Actions to perform on shutdown for the OpenTelemetry plugin.
-
-    Args:
-        application (BaseApplicationProtocol): The application.
-
-    Returns:
-        None
-    """
-    tracer_provider: TracerProvider = application.get_asgi_app().state.tracer_provider
-    meter_provider: MeterProvider = application.get_asgi_app().state.meter_provider
-    otel_config: OpenTelemetryConfig = application.get_asgi_app().state.otel_config
-
-    seconds_to_ms_multiplier: int = 1000
-
-    async def close_tracer_provider() -> None:
-        """Close the tracer provider."""
-        tracer_provider.force_flush(timeout_millis=otel_config.closing_timeout * seconds_to_ms_multiplier)
-        # No Delay for the shutdown of the tracer provider
-        tracer_provider.shutdown()
-
-    async def close_meter_provider() -> None:
-        """Close the meter provider.
-
-        Split the timeout in half for the flush and shutdown.
-        """
-        meter_provider.force_flush(timeout_millis=int(otel_config.closing_timeout / 2) * seconds_to_ms_multiplier)
-        meter_provider.shutdown(timeout_millis=int(otel_config.closing_timeout / 2) * seconds_to_ms_multiplier)
-
-    _logger.debug("OpenTelemetry plugin stop requested. Flushing and closing...")
-
-    await asyncio.gather(
-        close_tracer_provider(),
-        close_meter_provider(),
-    )
-
-    _logger.debug("OpenTelemetry plugin closed.")

fastapi_factory_utilities/core/plugins/opentelemetry_plugin/instruments/__init__.py

@@ -0,0 +1,85 @@
+"""Instruments for the OpenTelemetry plugin."""
+
+# pyright: reportMissingTypeStubs=false
+
+from collections.abc import Callable
+from importlib.util import find_spec
+from typing import Any
+
+from opentelemetry.sdk.metrics import MeterProvider
+from opentelemetry.sdk.trace import TracerProvider
+
+from fastapi_factory_utilities.core.plugins.opentelemetry_plugin.configs import OpenTelemetryConfig
+from fastapi_factory_utilities.core.protocols import ApplicationAbstractProtocol
+
+
+def instrument_fastapi(
+    application: ApplicationAbstractProtocol,
+    config: OpenTelemetryConfig,
+    meter_provider: MeterProvider,
+    tracer_provider: TracerProvider,
+) -> None:
+    """Instrument the FastAPI application."""
+    if find_spec(name="fastapi") and find_spec(name="opentelemetry.instrumentation.fastapi"):
+        from opentelemetry.instrumentation.fastapi import (  # pylint: disable=import-outside-toplevel # noqa: PLC0415
+            FastAPIInstrumentor,
+        )
+
+        excluded_urls_str: str | None = None if len(config.excluded_urls) == 0 else ",".join(config.excluded_urls)
+        FastAPIInstrumentor.instrument_app(  # pyright: ignore[reportUnknownMemberType]
+            app=application.get_asgi_app(),
+            tracer_provider=tracer_provider,
+            meter_provider=meter_provider,
+            excluded_urls=excluded_urls_str,
+        )
+
+
+def instrument_aiohttp(
+    application: ApplicationAbstractProtocol,  # pylint: disable=unused-argument
+    config: OpenTelemetryConfig,  # pylint: disable=unused-argument
+    meter_provider: MeterProvider,
+    tracer_provider: TracerProvider,
+) -> None:
+    """Instrument the Aiohttp application.
+
+    Args:
+        application (ApplicationAbstractProtocol): The application.
+        config (OpenTelemetryConfig): The configuration.
+        meter_provider (MeterProvider): The meter provider.
+        tracer_provider (TracerProvider): The tracer provider.
+
+    Returns:
+        None
+    """
+    if find_spec(name="aiohttp") and find_spec(name="opentelemetry.instrumentation.aiohttp_client"):
+        from opentelemetry.instrumentation.aiohttp_client import (  # pylint: disable=import-outside-toplevel # noqa: PLC0415
+            AioHttpClientInstrumentor,
+        )
+
+        AioHttpClientInstrumentor().instrument(  # pyright: ignore[reportUnknownMemberType]
+            tracer_provider=tracer_provider,
+            meter_provider=meter_provider,
+        )
+
+
+def instrument_aio_pika(
+    application: ApplicationAbstractProtocol,  # pylint: disable=unused-argument
+    config: OpenTelemetryConfig,  # pylint: disable=unused-argument
+    meter_provider: MeterProvider,
+    tracer_provider: TracerProvider,
+) -> None:
+    """Instrument the AioPika application."""
+    if find_spec(name="aio_pika") and find_spec(name="opentelemetry.instrumentation.aio_pika"):
+        from opentelemetry.instrumentation.aio_pika import (  # pylint: disable=import-outside-toplevel # noqa: PLC0415
+            AioPikaInstrumentor,
+        )
+
+        AioPikaInstrumentor().instrument(  # pyright: ignore[reportUnknownMemberType]
+            tracer_provider=tracer_provider,
+            meter_provider=meter_provider,
+        )
+
+
+INSTRUMENTS: list[Callable[..., Any]] = [instrument_fastapi, instrument_aiohttp, instrument_aio_pika]
+
+__all__: list[str] = ["INSTRUMENTS"]