refactor: update webhook interface

Author: pipech

raven/omni_channel_chat/api/webhooks.py

@@ -2,7 +2,7 @@
 from werkzeug.wrappers import Response
 
 from raven.omni_channel_chat.doctype.omni_channel_chat_provider.omni_channel_chat_provider import (
-	get_omni_channel_chat,
+	get_omni_channel_chat_provider,
 )
 
 
@@ -26,7 +26,10 @@ def extract_provider_slug() -> str:
 
 @frappe.whitelist(allow_guest=True, methods=["POST", "GET"])
 def handle() -> Response:
+	"""
+	Endpoint:
+		/api/method/raven.omni_channel_chat.api.webhooks.handle
+	"""
 	slug = extract_provider_slug()
-	omni_channel_chat = get_omni_channel_chat(slug=slug)
-	provider = omni_channel_chat.get_provider()
+	provider = get_omni_channel_chat_provider(slug=slug)
 	return provider.handle_frappe_api()

raven/omni_channel_chat/doctype/omni_channel_chat_provider/omni_channel_chat_provider.py

@@ -53,5 +53,10 @@ def get_provider(self) -> Provider:
 			frappe.throw(_("Provider not implemented."))
 
 
-def get_omni_channel_chat(slug: str) -> OmniChannelChatProvider:
-	return frappe.get_doc("Omni Channel Chat Provider", slug)
+def get_omni_channel_chat_provider(slug: str) -> Provider:
+	doc = frappe.get_doc("Omni Channel Chat Provider", slug)
+
+	if not doc:
+		frappe.throw(_("Omni Channel Chat Provider not found."))
+
+	return doc.get_provider()

raven/omni_channel_chat/doctype/omni_channel_chat_provider/provider/base_provider.py

@@ -23,13 +23,14 @@ def push_message_to_raven(self, messages: list[dict]) -> None:
 		for message in messages:
 			handler.receive_from_provider(message)
 
-	def handle_webhook(self, body: bytes, headers: dict) -> None:
+	def handle_webhook(self, body: bytes, headers: dict) -> Response:
 		messages = self.extract_messages(body=body, headers=headers)
 		self.push_message_to_raven(messages=messages)
+		return Response("ok", status=200, content_type="text/plain")
 
 	@abstractmethod
 	def handle_frappe_api(self) -> Response:
-		"""Extract data from frappe request and pass to handle webhook."""
+		"""Extract data from frappe request and pass to `handle_webhook`."""
 
 	@abstractmethod
 	def get_user_info(self, user_id: str) -> dict: