chore: Setup smart logger (#38)

Author: siderai

app/bot/bot.py

@@ -2,11 +2,11 @@
 
 from pybotx import Bot
 from pybotx_fsm import FSMMiddleware
-from pybotx_smart_logger import BotXSmartLoggerMiddleware
 
 from app.bot.commands import common
 from app.bot.commands.tasks import create_task, delete_task, get_tasks
 from app.bot.error_handlers.internal_error import internal_error_handler
+from app.bot.middlewares.smart_logger import smart_logger_middleware
 from app.settings import settings
 
 
@@ -21,9 +21,9 @@ def get_bot() -> Bot:
         bot_accounts=settings.BOT_CREDENTIALS,
         exception_handlers={Exception: internal_error_handler},
         middlewares=[
+            smart_logger_middleware,
             FSMMiddleware(
                 [create_task.fsm, get_tasks.fsm], state_repo_key="redis_repo"
             ),
-            BotXSmartLoggerMiddleware(debug_enabled_for_message=True).dispatch,
         ],
     )

app/bot/middlewares/smart_logger.py

@@ -0,0 +1,18 @@
+"""Middlewares to log all requests using smart logger wrapper."""
+
+from pybotx import Bot, IncomingMessage, IncomingMessageHandlerFunc
+from pybotx_smart_logger.wrapper import wrap_smart_logger
+
+from app.services.log_formatters import format_raw_command
+from app.settings import settings
+
+
+async def smart_logger_middleware(
+    message: IncomingMessage, bot: Bot, call_next: IncomingMessageHandlerFunc
+) -> None:
+    async with wrap_smart_logger(
+        log_source="Incoming message",
+        context_func=lambda: format_raw_command(message.raw_command),
+        debug=settings.DEBUG,
+    ):
+        await call_next(message, bot)

app/services/log_formatters.py

@@ -0,0 +1,17 @@
+"""Helpers to format log messages in smart logger wrapper."""
+
+from pprint import pformat
+from typing import Any, Dict, Optional
+
+from pybotx.logger import trim_file_data_in_incoming_json
+
+from app.logger import logger
+
+
+def format_raw_command(raw_command: Optional[Dict[str, Any]]) -> str:
+    if raw_command is None:
+        logger.warning("Empty `raw_command`")
+        return "<empty `raw_command`>"
+
+    trimmed_raw_command = trim_file_data_in_incoming_json(raw_command)
+    return pformat(trimmed_raw_command)

app/settings.py

@@ -4,16 +4,43 @@
 from uuid import UUID
 
 from pybotx import BotAccountWithSecret
-from pydantic import BaseSettings, validator
+from pydantic import BaseSettings
 
 
 class AppSettings(BaseSettings):
     class Config:  # noqa: WPS431
         env_file = ".env"
 
+        @classmethod
+        def parse_env_var(cls, field_name: str, raw_val: str) -> Any:
+            if field_name == "BOT_CREDENTIALS":
+                if not raw_val:
+                    return []
+
+                return [
+                    cls._build_credentials_from_string(credentials_str)
+                    for credentials_str in raw_val.replace(",", " ").split()
+                ]
+
+            return cls.json_loads(raw_val)  # type: ignore
+
+        @classmethod
+        def _build_credentials_from_string(
+            cls, credentials_str: str
+        ) -> BotAccountWithSecret:
+            credentials_str = credentials_str.replace("|", "@")
+            assert credentials_str.count("@") == 2, "Have you forgot to add `bot_id`?"
+
+            host, secret_key, bot_id = [
+                str_value.strip() for str_value in credentials_str.split("@")
+            ]
+            return BotAccountWithSecret(
+                id=UUID(bot_id), host=host, secret_key=secret_key
+            )
+
     # TODO: Change type to `list[BotAccountWithSecret]` after closing:
     # https://github.com/samuelcolvin/pydantic/issues/1458
-    BOT_CREDENTIALS: Any
+    BOT_CREDENTIALS: List[BotAccountWithSecret]
 
     # base kwargs
     DEBUG: bool = False
@@ -25,32 +52,5 @@ class Config:  # noqa: WPS431
     # redis
     REDIS_DSN: str
 
-    @validator("BOT_CREDENTIALS", pre=True)
-    @classmethod
-    def parse_bot_credentials(cls, raw_credentials: Any) -> List[BotAccountWithSecret]:
-        """Parse bot credentials separated by comma.
-
-        Each entry must be separated by "@" or "|".
-        """
-        if not raw_credentials:
-            raise ValueError("`BOT_CREDENTIALS` can't be empty")
-
-        return [
-            cls._build_credentials_from_string(credentials_str)
-            for credentials_str in raw_credentials.replace(",", " ").split()
-        ]
-
-    @classmethod
-    def _build_credentials_from_string(
-        cls, credentials_str: str
-    ) -> BotAccountWithSecret:
-        credentials_str = credentials_str.replace("|", "@")
-        assert credentials_str.count("@") == 2, "Have you forgot to add `bot_id`?"
-
-        host, secret_key, bot_id = [
-            str_value.strip() for str_value in credentials_str.split("@")
-        ]
-        return BotAccountWithSecret(id=UUID(bot_id), host=host, secret_key=secret_key)
-
 
 settings = AppSettings()

poetry.lock

@@ -11,7 +11,7 @@ authors = []
 python = ">=3.8,<3.10"
 
 pybotx-smart-logger = "~0.10.1"
-pybotx = "~0.55.2"
+pybotx = "0.55.2"
 pybotx-fsm = "~0.4.2"
 
 fastapi = "0.95.2"
@@ -24,7 +24,7 @@ pydantic = { version = "~1.10.5", extras = ["dotenv"] }
 
 alembic = "~1.7.6"
 SQLAlchemy = "~1.4.31"
-asyncpg = "~0.25.0"  # DB backend for application
+asyncpg = "0.26.0"  # DB backend for application
 psycopg2-binary = "~2.9.2"  # DB backend for alembic (migration tool)
 importlib-resources = { version = "^5.4.0", python = "<3.9" }
 zipp = { version = "^3.7.0", python = "<3.9" }