Change the specification of synchronous requests (#476)

Author: alexhook

README.md

@@ -234,16 +234,11 @@ collector = HandlerCollector()
 @collector.sync_smartapp_event
 async def handle_sync_smartapp_event(
     event: SmartAppEvent, bot: Bot,
-) -> SyncSmartAppEventResponsePayload:
+) -> BotAPISyncSmartAppEventResultResponse:
     print(f"Got sync smartapp event: {event}")
-    return SyncSmartAppEventResponsePayload.from_domain(
-        ref=event.ref,
-        smartapp_id=event.bot.id,
-        chat_id=event.chat.id,
+    return BotAPISyncSmartAppEventResultResponse.from_domain(
         data={},
-        opts={},
         files=[],
-        encrypted=True,
     )
 ```
 

pybotx/__init__.py

@@ -64,9 +64,6 @@
     SmartappManifest,
     SmartappManifestWebParams,
 )
-from pybotx.client.smartapps_api.sync_smartapp_event import (
-    SyncSmartAppEventResponsePayload,
-)
 from pybotx.client.stickers_api.exceptions import (
     InvalidEmojiError,
     InvalidImageError,
@@ -126,6 +123,11 @@
 from pybotx.models.smartapps import SmartApp
 from pybotx.models.status import BotMenu, StatusRecipient
 from pybotx.models.stickers import Sticker, StickerPack
+from pybotx.models.sync_smartapp_event import (
+    BotAPISyncSmartAppEventErrorResponse,
+    BotAPISyncSmartAppEventResponse,
+    BotAPISyncSmartAppEventResultResponse,
+)
 from pybotx.models.system_events.added_to_chat import AddedToChatEvent
 from pybotx.models.system_events.chat_created import ChatCreatedEvent, ChatCreatedMember
 from pybotx.models.system_events.chat_deleted_by_user import ChatDeletedByUserEvent
@@ -152,6 +154,9 @@
     "BotAPIBotDisabledErrorData",
     "BotAPIBotDisabledResponse",
     "BotAPIMethodFailedCallback",
+    "BotAPISyncSmartAppEventErrorResponse",
+    "BotAPISyncSmartAppEventResponse",
+    "BotAPISyncSmartAppEventResultResponse",
     "BotAPIUnverifiedRequestErrorData",
     "BotAPIUnverifiedRequestResponse",
     "BotAccount",
@@ -228,7 +233,6 @@
     "RequestHeadersNotProvidedError",
     "SmartApp",
     "SmartAppEvent",
-    "SyncSmartAppEventResponsePayload",
     "SmartappManifest",
     "SmartappManifestWebLayoutChoices",
     "SmartappManifestWebParams",

pybotx/bot/bot.py

@@ -148,9 +148,6 @@
     BotXAPISmartAppsListRequestPayload,
     SmartAppsListMethod,
 )
-from pybotx.client.smartapps_api.sync_smartapp_event import (
-    SyncSmartAppEventResponsePayload,
-)
 from pybotx.client.smartapps_api.upload_file import (
     UploadFileMethod as SmartappsUploadFileMethod,
 )
@@ -221,7 +218,7 @@
     ensure_file_content_is_png,
     ensure_sticker_image_size_valid,
 )
-from pybotx.logger import logger, pformat_jsonable_obj, trim_file_data_in_incoming_json
+from pybotx.logger import log_incoming_request, logger, pformat_jsonable_obj
 from pybotx.missing import Missing, MissingOptional, Undefined
 from pybotx.models.async_files import File
 from pybotx.models.attachments import IncomingFileAttachment, OutgoingAttachment
@@ -245,10 +242,11 @@
     build_bot_status_response,
 )
 from pybotx.models.stickers import Sticker, StickerPack, StickerPackFromList
-from pybotx.models.system_events.smartapp_event import (
-    BotAPISmartAppEvent,
-    SmartAppEvent,
+from pybotx.models.sync_smartapp_event import (
+    BotAPISyncSmartAppEvent,
+    BotAPISyncSmartAppEventResponse,
 )
+from pybotx.models.system_events.smartapp_event import SmartAppEvent
 from pybotx.models.users import UserFromCSV, UserFromSearch
 
 MissingOptionalAttachment = MissingOptional[
@@ -299,16 +297,9 @@ def async_execute_raw_bot_command(
         logging_command: bool = True,
     ) -> None:
         if logging_command:
-            logger.opt(lazy=True).debug(
-                "Got command: {command}",
-                command=lambda: pformat_jsonable_obj(
-                    trim_file_data_in_incoming_json(raw_bot_command),
-                ),
-            )
+            log_incoming_request(raw_bot_command, message="Got command: ")
 
         if verify_request:
-            if request_headers is None:
-                raise RequestHeadersNotProvidedError
             self._verify_request(request_headers)
 
         try:
@@ -338,23 +329,19 @@ async def sync_execute_raw_smartapp_event(
         verify_request: bool = True,
         request_headers: Optional[Mapping[str, str]] = None,
         logging_command: bool = True,
-    ) -> SyncSmartAppEventResponsePayload:
+    ) -> BotAPISyncSmartAppEventResponse:
         if logging_command:
-            logger.opt(lazy=True).debug(
-                "Got sync smartapp event: {command}",
-                command=lambda: pformat_jsonable_obj(
-                    trim_file_data_in_incoming_json(raw_smartapp_event),
-                ),
+            log_incoming_request(
+                raw_smartapp_event,
+                message="Got sync smartapp event: ",
             )
 
         if verify_request:
-            if request_headers is None:
-                raise RequestHeadersNotProvidedError
             self._verify_request(request_headers)
 
         try:
-            bot_api_smartapp_event: BotAPISmartAppEvent = parse_obj_as(
-                BotAPISmartAppEvent,
+            bot_api_smartapp_event: BotAPISyncSmartAppEvent = parse_obj_as(
+                BotAPISyncSmartAppEvent,
                 raw_smartapp_event,
             )
         except ValidationError as validation_exc:
@@ -368,7 +355,7 @@ async def sync_execute_raw_smartapp_event(
     async def sync_execute_smartapp_event(
         self,
         smartapp_event: SmartAppEvent,
-    ) -> SyncSmartAppEventResponsePayload:
+    ) -> BotAPISyncSmartAppEventResponse:
         self._bot_accounts_storage.ensure_bot_id_exists(smartapp_event.bot.id)
         return await self._handler_collector.handle_sync_smartapp_event(
             self,
@@ -2028,7 +2015,13 @@ async def collect_metric(
         )
         await method.execute(payload)
 
-    def _verify_request(self, headers: Mapping[str, str]) -> None:  # noqa: WPS238
+    def _verify_request(  # noqa: WPS231, WPS238
+        self,
+        headers: Optional[Mapping[str, str]],
+    ) -> None:
+        if headers is None:
+            raise RequestHeadersNotProvidedError
+
         authorization_header = headers.get("authorization")
         if not authorization_header:
             raise UnverifiedRequestError("The authorization token was not provided.")

pybotx/bot/handler.py

@@ -2,12 +2,10 @@
 from functools import partial
 from typing import TYPE_CHECKING, Awaitable, Callable, List, Literal, TypeVar, Union
 
-from pybotx.client.smartapps_api.sync_smartapp_event import (
-    SyncSmartAppEventResponsePayload,
-)
 from pybotx.models.commands import BotCommand
 from pybotx.models.message.incoming_message import IncomingMessage
 from pybotx.models.status import StatusRecipient
+from pybotx.models.sync_smartapp_event import BotAPISyncSmartAppEventResponse
 from pybotx.models.system_events.added_to_chat import AddedToChatEvent
 from pybotx.models.system_events.chat_created import ChatCreatedEvent
 from pybotx.models.system_events.chat_deleted_by_user import ChatDeletedByUserEvent
@@ -29,7 +27,7 @@
 
 SyncSmartAppEventHandlerFunc = Callable[
     [SmartAppEvent, "Bot"],
-    Awaitable[SyncSmartAppEventResponsePayload],
+    Awaitable[BotAPISyncSmartAppEventResponse],
 ]
 
 IncomingMessageHandlerFunc = HandlerFunc[IncomingMessage]

pybotx/bot/handler_collector.py

@@ -33,14 +33,12 @@
     ExceptionMiddleware,
 )
 from pybotx.client.smartapps_api.exceptions import SyncSmartAppEventHandlerNotFoundError
-from pybotx.client.smartapps_api.sync_smartapp_event import (
-    SyncSmartAppEventResponsePayload,
-)
 from pybotx.converters import optional_sequence_to_list
 from pybotx.logger import logger
 from pybotx.models.commands import BotCommand, SystemEvent
 from pybotx.models.message.incoming_message import IncomingMessage
 from pybotx.models.status import BotMenu, StatusRecipient
+from pybotx.models.sync_smartapp_event import BotAPISyncSmartAppEventResponse
 from pybotx.models.system_events.added_to_chat import AddedToChatEvent
 from pybotx.models.system_events.chat_created import ChatCreatedEvent
 from pybotx.models.system_events.chat_deleted_by_user import ChatDeletedByUserEvent
@@ -126,7 +124,7 @@ async def handle_sync_smartapp_event(
         self,
         bot: "Bot",
         smartapp_event: SmartAppEvent,
-    ) -> SyncSmartAppEventResponsePayload:
+    ) -> BotAPISyncSmartAppEventResponse:
         if not isinstance(smartapp_event, SmartAppEvent):
             raise NotImplementedError(
                 f"Unsupported event type for sync smartapp event: `{smartapp_event}`",

pybotx/client/smartapps_api/smartapp_event.py

@@ -1,4 +1,4 @@
-from typing import Any, Dict, List, Literal, Type, TypeVar
+from typing import Any, Dict, List, Literal
 from uuid import UUID
 
 from pybotx.client.authorized_botx_method import AuthorizedBotXMethod
@@ -7,11 +7,6 @@
 from pybotx.models.api_base import UnverifiedPayloadBaseModel, VerifiedPayloadBaseModel
 from pybotx.models.async_files import APIAsyncFile, File, convert_async_file_from_domain
 
-TBotXAPISmartAppEventRequestPayload = TypeVar(
-    "TBotXAPISmartAppEventRequestPayload",
-    bound="BotXAPISmartAppEventRequestPayload",
-)
-
 
 class BotXAPISmartAppEventRequestPayload(UnverifiedPayloadBaseModel):
     ref: MissingOptional[UUID]
@@ -25,15 +20,15 @@ class BotXAPISmartAppEventRequestPayload(UnverifiedPayloadBaseModel):
 
     @classmethod
     def from_domain(
-        cls: Type[TBotXAPISmartAppEventRequestPayload],
+        cls,
         ref: MissingOptional[UUID],
         smartapp_id: UUID,
         chat_id: UUID,
         data: Dict[str, Any],
         opts: Missing[Dict[str, Any]],
         files: Missing[List[File]],
         encrypted: bool,
-    ) -> TBotXAPISmartAppEventRequestPayload:
+    ) -> "BotXAPISmartAppEventRequestPayload":
         api_async_files: Missing[List[APIAsyncFile]] = Undefined
         if files:
             api_async_files = [convert_async_file_from_domain(file) for file in files]

pybotx/client/smartapps_api/sync_smartapp_event.py

@@ -41,6 +41,15 @@ def trim_file_data_in_incoming_json(json_body: Dict[str, Any]) -> Dict[str, Any]
     return json_body
 
 
+def log_incoming_request(request: Dict[str, Any], *, message: str = "") -> None:
+    logger.opt(lazy=True).debug(
+        message + "{command}",
+        command=lambda: pformat_jsonable_obj(
+            trim_file_data_in_incoming_json(request),
+        ),
+    )
+
+
 def setup_logger() -> "Logger":
     return _logger
 

pybotx/logger.py

@@ -1,5 +1,6 @@
 from dataclasses import dataclass
 from functools import cached_property
+from typing import Optional
 from urllib.parse import urlparse
 from uuid import UUID
 
@@ -9,7 +10,7 @@
 @dataclass
 class BotAccount:
     id: UUID
-    host: str
+    host: Optional[str]
 
 
 class BotAccountWithSecret(BaseModel):