feat: add handler for synchronous smartapp requests (#36)

Author: alexhook

app/api/endpoints/botx.py

@@ -8,75 +8,44 @@
     Bot,
     BotXMethodCallbackNotFoundError,
     UnknownBotAccountError,
-    UnsupportedBotAPIVersionError,
     UnverifiedRequestError,
     build_bot_disabled_response,
     build_command_accepted_response,
     build_unverified_request_response,
 )
-from pybotx.constants import BOT_API_VERSION
 
 from app.api.dependencies.bot import bot_dependency
+from app.api.exceptions.botx import handle_exceptions
 from app.logger import logger
-from app.settings import settings
 
 router = APIRouter()
 
 
 @router.post("/command")
+@handle_exceptions
 async def command_handler(request: Request, bot: Bot = bot_dependency) -> JSONResponse:
     """Receive commands from users. Max timeout - 5 seconds."""
-
-    try:  # noqa: WPS225
-        bot.async_execute_raw_bot_command(
-            await request.json(),
-            request_headers=request.headers,
-        )
-    except ValueError:
-        error_label = "Bot command validation error"
-
-        if settings.DEBUG:
-            logger.exception(error_label)
-        else:
-            logger.warning(error_label)
-
-        return JSONResponse(
-            build_bot_disabled_response(error_label),
-            status_code=HTTPStatus.SERVICE_UNAVAILABLE,
-        )
-    except UnknownBotAccountError as exc:
-        error_label = f"No credentials for bot {exc.bot_id}"
-        logger.warning(error_label)
-
-        return JSONResponse(
-            build_bot_disabled_response(error_label),
-            status_code=HTTPStatus.SERVICE_UNAVAILABLE,
-        )
-    except UnsupportedBotAPIVersionError as exc:
-        error_label = (
-            f"Unsupported Bot API version: `{exc.version}`. "
-            f"Set protocol version to `{BOT_API_VERSION}` in Admin panel."
-        )
-        logger.warning(error_label)
-
-        return JSONResponse(
-            build_bot_disabled_response(error_label),
-            status_code=HTTPStatus.SERVICE_UNAVAILABLE,
-        )
-    except UnverifiedRequestError as exc:
-        logger.warning(f"UnverifiedRequestError: {exc.args[0]}")
-        return JSONResponse(
-            content=build_unverified_request_response(
-                status_message=exc.args[0],
-            ),
-            status_code=HTTPStatus.UNAUTHORIZED,
-        )
-
+    bot.async_execute_raw_bot_command(
+        await request.json(),
+        request_headers=request.headers,
+    )
     return JSONResponse(
         build_command_accepted_response(), status_code=HTTPStatus.ACCEPTED
     )
 
 
+@router.post("/smartapps/request")
+@handle_exceptions
+async def sync_smartapp_event_handler(
+    request: Request, bot: Bot = bot_dependency
+) -> JSONResponse:
+    response = await bot.sync_execute_raw_smartapp_event(
+        await request.json(),
+        request_headers=request.headers,
+    )
+    return JSONResponse(response.jsonable_dict(), status_code=HTTPStatus.OK)
+
+
 @router.get("/status")
 async def status_handler(request: Request, bot: Bot = bot_dependency) -> JSONResponse:
     """Show bot status and commands list."""

app/api/exceptions/__init__.py

@@ -0,0 +1,66 @@
+"""Handlers for BotX request exceptions."""
+
+from functools import wraps
+from http import HTTPStatus
+from typing import Any, Callable
+
+from fastapi.responses import JSONResponse
+from pybotx import (
+    UnknownBotAccountError,
+    UnsupportedBotAPIVersionError,
+    UnverifiedRequestError,
+    build_bot_disabled_response,
+    build_unverified_request_response,
+)
+from pybotx.constants import BOT_API_VERSION
+
+from app.logger import logger
+from app.settings import settings
+
+
+def handle_exceptions(func: Callable) -> Callable:  # noqa: WPS212
+    @wraps(func)
+    async def wrapper(*args: Any, **kwargs: Any) -> JSONResponse:
+        try:  # noqa: WPS225
+            return await func(*args, **kwargs)
+        except ValueError:
+            error_label = "Bot command validation error"
+
+            if settings.DEBUG:
+                logger.exception(error_label)
+            else:
+                logger.warning(error_label)
+
+            return JSONResponse(
+                build_bot_disabled_response(error_label),
+                status_code=HTTPStatus.SERVICE_UNAVAILABLE,
+            )
+        except UnknownBotAccountError as exc:
+            error_label = f"No credentials for bot {exc.bot_id}"
+            logger.warning(error_label)
+
+            return JSONResponse(
+                build_bot_disabled_response(error_label),
+                status_code=HTTPStatus.SERVICE_UNAVAILABLE,
+            )
+        except UnsupportedBotAPIVersionError as exc:
+            error_label = (
+                f"Unsupported Bot API version: `{exc.version}`. "
+                f"Set protocol version to `{BOT_API_VERSION}` in Admin panel."
+            )
+            logger.warning(error_label)
+
+            return JSONResponse(
+                build_bot_disabled_response(error_label),
+                status_code=HTTPStatus.SERVICE_UNAVAILABLE,
+            )
+        except UnverifiedRequestError as exc:
+            logger.warning(f"UnverifiedRequestError: {exc.args[0]}")
+            return JSONResponse(
+                content=build_unverified_request_response(
+                    status_message=exc.args[0],
+                ),
+                status_code=HTTPStatus.UNAUTHORIZED,
+            )
+
+    return wrapper

app/api/exceptions/botx.py

@@ -1,7 +1,12 @@
 """Handlers for default bot commands and system events."""
 
-
-from pybotx import Bot, HandlerCollector, IncomingMessage, SmartAppEvent
+from pybotx import (
+    Bot,
+    HandlerCollector,
+    IncomingMessage,
+    SmartAppEvent,
+    SyncSmartAppEventResponsePayload,
+)
 
 from app.smartapp.smartapp import smartapp
 
@@ -13,6 +18,13 @@ async def handle_smartapp_event(event: SmartAppEvent, bot: Bot) -> None:
     await smartapp.handle_smartapp_event(event, bot)
 
 
+@collector.sync_smartapp_event
+async def handle_sync_smartapp_event(
+    event: SmartAppEvent, bot: Bot
+) -> SyncSmartAppEventResponsePayload:
+    return await smartapp.handle_sync_smartapp_event(event, bot)
+
+
 @collector.command("/_test-redis-callback-repo", visible=False)
 async def test_redis_callback_repo(message: IncomingMessage, bot: Bot) -> None:
     """Testing redis callback."""

app/bot/commands/common.py

@@ -10,8 +10,8 @@ authors = []
 [tool.poetry.dependencies]
 python = ">=3.8,<3.12"
 
-pybotx = "~0.65.0"
-pybotx-smartapp-rpc = "~0.8.0"
+pybotx = ">=0.67.1"
+pybotx-smartapp-rpc = ">=0.9.0"
 pybotx-smart-logger = "~0.10.1"
 
 fastapi = "~0.110.1"

poetry.lock

@@ -81,6 +81,8 @@ per-file-ignores =
     app/db/sqlalchemy.py:WPS442,WPS323
 # too complex function
     app/services/openapi.py:WPS211,WPS210,WPS231,WPS234,WPS221,WPS110,WPS111
+# found module cognitive complexity that is too high
+    app/api/exceptions/botx.py:WPS232
 
 no-accept-encodings = True
 inline-quotes = double