paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-09 00:18:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

outgoing_webhook: Join build_bot_request and send_data_to_server.

Browse Source 
The existing organization, of returning an opaque blob from
`build_bot_request`, which was later consumed by
`send_data_to_server`, is not particularly sensible; the steps become
oddly split between the OutgoingWebhookWorker, `do_rest_call`, and the
`OutgoingWebhookServiceInterface`.

Make the `OutgoingWebhookServiceInterface` in charge of building,
making, and returning the request in one method; another method
handles extracting content from a successful response.  `do_rest_call`
is responsible for calling both halves of this, and doing common error
handling.
This commit is contained in:
Alex Vandiver
2021-03-26 19:11:40 -07:00
committed by Tim Abbott
parent be706ea7a1
commit a280905a89
4 changed files with 82 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
zerver/lib/outgoing_webhook.py
View File

@@ -32,11 +32,7 @@ class OutgoingWebhookServiceInterface(metaclass=abc.ABCMeta):
self.service_name: str = service_name
@abc.abstractmethod
def build_bot_request(self, event: Dict[str, Any]) -> Optional[Any]:
raise NotImplementedError
@abc.abstractmethod
def send_data_to_server(self, base_url: str, request_data: Any) -> Response:
def make_request(self, base_url: str, event: Dict[str, Any]) -> Optional[Response]:
raise NotImplementedError
@abc.abstractmethod
@@ -45,7 +41,7 @@ class OutgoingWebhookServiceInterface(metaclass=abc.ABCMeta):
class GenericOutgoingWebhookService(OutgoingWebhookServiceInterface):
def build_bot_request(self, event: Dict[str, Any]) -> Optional[Any]:
def make_request(self, base_url: str, event: Dict[str, Any]) -> Optional[Response]:
"""
We send a simple version of the message to outgoing
webhooks, since most of them really only need
@@ -69,9 +65,7 @@ class GenericOutgoingWebhookService(OutgoingWebhookServiceInterface):
"token": self.token,
"trigger": event["trigger"],
}
return json.dumps(request_data)
def send_data_to_server(self, base_url: str, request_data: Any) -> Response:
user_agent = "ZulipOutgoingWebhook/" + ZULIP_VERSION
headers = {
"User-Agent": user_agent,
@@ -99,7 +93,7 @@ class GenericOutgoingWebhookService(OutgoingWebhookServiceInterface):
class SlackOutgoingWebhookService(OutgoingWebhookServiceInterface):
def build_bot_request(self, event: Dict[str, Any]) -> Optional[Any]:
def make_request(self, base_url: str, event: Dict[str, Any]) -> Optional[Response]:
if event["message"]["type"] == "private":
failure_message = "Slack outgoing webhooks don't support private messages."
fail_with_message(event, failure_message)
@@ -118,12 +112,7 @@ class SlackOutgoingWebhookService(OutgoingWebhookServiceInterface):
("trigger_word", event["trigger"]),
("service_id", event["user_profile_id"]),
]
return request_data
def send_data_to_server(self, base_url: str, request_data: Any) -> Response:
response = requests.request("POST", base_url, data=request_data)
return response
return requests.request("POST", base_url, data=request_data)
def process_success(self, response_json: Dict[str, Any]) -> Optional[Dict[str, Any]]:
if "text" in response_json:
@@ -311,14 +300,16 @@ def process_success_response(
def do_rest_call(
base_url: str, request_data: Any, event: Dict[str, Any], service_handler: Any
base_url: str, event: Dict[str, Any], service_handler: Any
) -> Optional[Response]:
"""Returns response of call if no exception occurs."""
try:
response = service_handler.send_data_to_server(
base_url=base_url,
request_data=request_data,
response = service_handler.make_request(
base_url,
event,
)
if not response:
return None
if str(response.status_code).startswith("2"):
process_success_response(event, service_handler, response)
else: