fastapi-factory-utilities 0.2.1__tar.gz → 0.2.2__tar.gz

{fastapi_factory_utilities-0.2.1 → fastapi_factory_utilities-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: fastapi_factory_utilities
-Version: 0.2.1
+Version: 0.2.2
 Summary: Consolidate libraries and utilities to create microservices in Python with FastAPI, Beanie, Httpx, AioPika and OpenTelemetry.
 License: MIT
 Keywords: python,fastapi,beanie,httpx,opentelemetry,microservices

{fastapi_factory_utilities-0.2.1 → fastapi_factory_utilities-0.2.2}/pyproject.toml

@@ -3,7 +3,7 @@ name = "fastapi_factory_utilities"
 homepage = "https://github.com/miragecentury/fastapi_factory_utilities"
 repository = "https://github.com/miragecentury/fastapi_factory_utilities"
 keywords = ["python", "fastapi", "beanie", "httpx", "opentelemetry", "microservices"]
-version = "0.2.1"
+version = "0.2.2"
 description = "Consolidate libraries and utilities to create microservices in Python with FastAPI, Beanie, Httpx, AioPika and OpenTelemetry."
 authors = ["miragecentury <victorien.vanroye@gmail.com>"]
 maintainers = ["miragecentury <victorien.vanroye@gmail.com>"]

{fastapi_factory_utilities-0.2.1 → fastapi_factory_utilities-0.2.2}/src/fastapi_factory_utilities/core/app/builder.py

@@ -21,6 +21,7 @@ class ApplicationGenericBuilder(Generic[T]):
 
     def __init__(self, plugins_activation_list: list[PluginsEnum] | None = None) -> None:
         """Instanciate the ApplicationGenericBuilder."""
+        self._uvicorn_utils: UvicornUtils | None = None
         self._root_config: RootConfig | None = None
         self._plugin_manager: PluginManager | None = None
         self._fastapi_builder: FastAPIBuilder | None = None
@@ -109,11 +110,12 @@ class ApplicationGenericBuilder(Generic[T]):
 
     def build_as_uvicorn_utils(self) -> UvicornUtils:
         """Build the application and provide UvicornUtils."""
-        return UvicornUtils(app=self.build())
+        self._uvicorn_utils = UvicornUtils(app=self.build())
+        return self._uvicorn_utils
 
     def build_and_serve(self) -> None:
         """Build the application and serve it with Uvicorn."""
-        uvicorn_utils: UvicornUtils = self.build_as_uvicorn_utils()
+        uvicorn_utils: UvicornUtils = self._uvicorn_utils or self.build_as_uvicorn_utils()
 
         setup_log(mode=LogModeEnum.CONSOLE)
 

{fastapi_factory_utilities-0.2.1 → fastapi_factory_utilities-0.2.2}/src/fastapi_factory_utilities/core/plugins/odm_plugin/__init__.py

@@ -78,6 +78,7 @@ async def on_startup(
 
     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

{fastapi_factory_utilities-0.2.1 → fastapi_factory_utilities-0.2.2}/src/fastapi_factory_utilities/core/plugins/odm_plugin/builder.py

@@ -1,9 +1,9 @@
 """Provides the module for the ODM plugin."""
 
-import time
 from typing import Any, ClassVar, Self
 
 from motor.motor_asyncio import AsyncIOMotorClient, AsyncIOMotorDatabase
+from pymongo.server_api import ServerApi, ServerApiVersion
 from structlog.stdlib import get_logger
 
 from fastapi_factory_utilities.core.protocols import ApplicationAbstractProtocol
@@ -124,31 +124,34 @@ class ODMBuilder:
             raise ODMPluginConfigError("Unable to create the application configuration model.") from exception
         return self
 
-    @classmethod
-    def _wait_client_to_be_ready(cls, client: AsyncIOMotorClient[Any], timeout_s: int) -> None:
-        """Wait for the ODM client to be ready.
-
-        Args:
-            client (AsyncIOMotorClient): The ODM client.
-            timeout_s (int): The timeout in seconds.
-
-        Raises:
-            TimeoutError: If the ODM client is not ready in the given timeout.
-        """
-        start_time: float = time.time()
-        message_time: float = time.time()
-        while (time.time() - start_time) < (timeout_s):
-            if len(client.nodes) > 0:  # type: ignore
-                _logger.info(f"Waiting {(time.time() - start_time)*cls.MS_TO_S}ms for the ODM client to be ready.")
-                return
-
-            if (time.time() - message_time) > 1:
-                elaps_time: float = time.time() - start_time
-                _logger.debug(f"Waiting for the ODM client to be ready. (from {int(elaps_time)}s) ")
-                message_time = time.time()
-            time.sleep(cls.SLEEP_TIME_S)
-
-        raise TimeoutError("The ODM client is not ready in the given timeout.")
+    # ======
+    # KEEP IT, Waiting for additional tests
+    # @classmethod
+    # def _wait_client_to_be_ready(cls, client: AsyncIOMotorClient[Any], timeout_s: int) -> None:
+    #     """Wait for the ODM client to be ready.
+
+    #     Args:
+    #         client (AsyncIOMotorClient): The ODM client.
+    #         timeout_s (int): The timeout in seconds.
+
+    #     Raises:
+    #         TimeoutError: If the ODM client is not ready in the given timeout.
+    #     """
+    #     start_time: float = time.time()
+    #     message_time: float = time.time()
+    #     while (time.time() - start_time) < (timeout_s):
+    #         if len(client.nodes) > 0:  # type: ignore
+    #             _logger.info(f"Waiting {(time.time() - start_time)*cls.MS_TO_S}ms for the ODM client to be ready.")
+    #             return
+
+    #         if (time.time() - message_time) > 1:
+    #             elaps_time: float = time.time() - start_time
+    #             _logger.debug(f"Waiting for the ODM client to be ready. (from {int(elaps_time)}s) ")
+    #             message_time = time.time()
+    #         time.sleep(cls.SLEEP_TIME_S)
+
+    #     raise TimeoutError("The ODM client is not ready in the given timeout.")
+    # ======
 
     def build_client(
         self,
@@ -173,11 +176,13 @@ class ODMBuilder:
         self._odm_client = AsyncIOMotorClient(
             host=self._config.uri,
             connect=True,
-            connectTimeoutMS=self._config.connection_timeout_s,
-            serverSelectionTimeoutMS=self._config.connection_timeout_s,
+            connectTimeoutMS=self._config.connection_timeout_ms,
+            serverSelectionTimeoutMS=self._config.connection_timeout_ms,
+            server_api=ServerApi(version=ServerApiVersion.V1),
         )
 
-        self._wait_client_to_be_ready(client=self._odm_client, timeout_s=self._config.connection_timeout_s)
+        # KEEP IT, Waiting for additional tests
+        # self._wait_client_to_be_ready(client=self._odm_client, timeout_s=self._config.connection_timeout_s)
 
         return self
 
@@ -229,3 +234,19 @@ 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-0.2.1 → fastapi_factory_utilities-0.2.2}/src/fastapi_factory_utilities/core/plugins/odm_plugin/configs.py

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

{fastapi_factory_utilities-0.2.1 → fastapi_factory_utilities-0.2.2}/src/fastapi_factory_utilities/core/utils/uvicorn.py

@@ -1,5 +1,8 @@
 """Provides utilities for the application."""
 
+import os
+from typing import Any
+
 import uvicorn
 import uvicorn.server
 
@@ -20,6 +23,29 @@ class UvicornUtils:
             None
         """
         self._app: ApplicationAbstractProtocol = app
+        self._ssl_keyfile: str | os.PathLike[str] | None = None
+        self._ssl_certfile: str | os.PathLike[str] | None = None
+        self._ssl_keyfile_password: str | None = None
+
+    def add_ssl_certificates(
+        self,
+        ssl_keyfile: str | os.PathLike[str] | None = None,
+        ssl_certfile: str | os.PathLike[str] | None = None,
+        ssl_keyfile_password: str | None = None,
+    ) -> None:
+        """Add SSL certificates to the application.
+
+        Args:
+            ssl_keyfile (str | os.PathLike[str] | None): The SSL key file.
+            ssl_certfile (str | os.PathLike[str] | None): The SSL certificate file.
+            ssl_keyfile_password (str | None): The SSL key file password.
+
+        Returns:
+            None
+        """
+        self._ssl_keyfile = ssl_keyfile
+        self._ssl_certfile = ssl_certfile
+        self._ssl_keyfile_password = ssl_keyfile_password
 
     def build_uvicorn_config(self) -> uvicorn.Config:
         """Build the Uvicorn configuration.
@@ -27,12 +53,22 @@ class UvicornUtils:
         Returns:
             uvicorn.Config: The Uvicorn configuration.
         """
+        kwargs: dict[str, Any] = {}
+
+        if self._ssl_keyfile:
+            kwargs["ssl_keyfile"] = self._ssl_keyfile
+        if self._ssl_certfile:
+            kwargs["ssl_certfile"] = self._ssl_certfile
+        if self._ssl_keyfile_password:
+            kwargs["ssl_keyfile_password"] = self._ssl_keyfile_password
+
         config = uvicorn.Config(
             app=self._app.get_asgi_app(),
             host=self._app.get_config().server.host,
             port=self._app.get_config().server.port,
             reload=self._app.get_config().development.reload,
             workers=self._app.get_config().server.workers,
+            **kwargs,
         )
         clean_uvicorn_logger()
         return config