Send logs to Matrix asynchronously

Author: Marc-Andrieu

app/core/utils/log.py

@@ -7,6 +7,7 @@
 from typing import Any
 
 import uvicorn
+from fastapi import BackgroundTasks
 
 from app.core.utils.config import Settings
 
@@ -78,7 +79,7 @@ class console_color:
 
     # Logging config
     # See https://docs.python.org/3/library/logging.config.html#logging-config-dictschema
-    def get_config_dict(self, settings: Settings):
+    def _get_config_dict(self, settings: Settings):
         # We can't use a dependency to access settings as this function is not an endpoint. The object must thus be passed as a parameter.
 
         # /!\ WARNING /!\
@@ -121,6 +122,7 @@ def get_config_dict(self, settings: Settings):
                     # Send error to a Matrix server. If credentials are not set in settings, the handler will be disabled
                     "formatter": "matrix",
                     "class": "app.utils.loggers_tools.matrix_handler.MatrixHandler",
+                    "background_tasks": BackgroundTasks,
                     "room_id": settings.MATRIX_LOG_ERROR_ROOM_ID,
                     "token": settings.MATRIX_TOKEN,
                     "server_base_url": settings.MATRIX_SERVER_BASE_URL,
@@ -133,6 +135,7 @@ def get_config_dict(self, settings: Settings):
                     # Send error to a Matrix server. If credentials are not set in settings, the handler will be disabled
                     "formatter": "matrix",
                     "class": "app.utils.loggers_tools.matrix_handler.MatrixHandler",
+                    "background_tasks": BackgroundTasks,
                     "room_id": settings.MATRIX_LOG_AMAP_ROOM_ID,
                     "token": settings.MATRIX_TOKEN,
                     "server_base_url": settings.MATRIX_SERVER_BASE_URL,
@@ -398,7 +401,7 @@ def initialize_loggers(self, settings: Settings):
         # If logs/ folder does not exist, the logging module won't be able to create file handlers
         Path("logs/").mkdir(parents=True, exist_ok=True)
 
-        config_dict = self.get_config_dict(settings=settings)
+        config_dict = self._get_config_dict(settings=settings)
         logging.config.dictConfig(config_dict)
 
         loggers = [logging.getLogger(name) for name in config_dict["loggers"]]

app/utils/communication/matrix.py

@@ -1,6 +1,6 @@
 from typing import Any
 
-import requests
+import httpx
 
 from app.types.exceptions import MatrixRequestError, MatrixSendMessageError
 
@@ -24,7 +24,7 @@ def __init__(
 
         self.access_token = token
 
-    def post(
+    async def post(
         self,
         url: str,
         json: dict[str, Any],
@@ -43,15 +43,21 @@ def post(
         if "Authorization" not in headers:
             headers["Authorization"] = "Bearer " + self.access_token
 
-        response = requests.post(url, json=json, headers=headers, timeout=10)
         try:
+            async with httpx.AsyncClient() as client:
+                response = await client.post(
+                    url,
+                    json=json,
+                    headers=headers,
+                    timeout=10,
+                )
             response.raise_for_status()
-        except requests.exceptions.HTTPError as err:
+        except httpx.RequestError as err:
             raise MatrixRequestError() from err
 
         return response.json()
 
-    def send_message(self, room_id: str, formatted_body: str) -> None:
+    async def send_message(self, room_id: str, formatted_body: str) -> None:
         """
         Send a message to the room `room_id`.
         `formatted_body` can contain html formatted text
@@ -71,6 +77,6 @@ def send_message(self, room_id: str, formatted_body: str) -> None:
         }
 
         try:
-            self.post(url, json=data, headers=None)
+            await self.post(url, json=data, headers=None)
         except MatrixRequestError as error:
             raise MatrixSendMessageError(room_id=room_id) from error

app/utils/loggers_tools/matrix_handler.py

@@ -1,6 +1,7 @@
 import logging
 from logging import StreamHandler
 
+from fastapi import BackgroundTasks
 from typing_extensions import override
 
 from app.utils.communication.matrix import Matrix
@@ -21,6 +22,7 @@ class MatrixHandler(StreamHandler):
 
     def __init__(
         self,
+        background_tasks: BackgroundTasks,
         room_id: str,
         token: str,
         server_base_url: str | None,
@@ -30,6 +32,7 @@ def __init__(
         super().__init__()
         self.setLevel(level)
 
+        self.background_tasks = background_tasks
         self.room_id = room_id
         self.enabled = enabled
         if self.enabled:
@@ -42,9 +45,12 @@ def __init__(
     def emit(self, record):
         if self.enabled:
             msg = self.format(record)
-
             try:
-                self.matrix.send_message(self.room_id, msg)
+                self.background_tasks.add_task(
+                    self.matrix.send_message,
+                    room_id=self.room_id,
+                    formatted_body=msg,
+                )
             # We should catch and log any error, as Python may discarded them in production
             except Exception as err:
                 # We use warning level so that the message is not sent to matrix again