Add timeout arg to WebhookClient

Author: seratch

slack/webhook/client.py

@@ -16,13 +16,15 @@ class WebhookClient:
     logger = logging.getLogger(__name__)
 
     def __init__(
-        self, url: str, default_headers: Dict[str, str] = {},
+        self, url: str, timeout: int = 30, default_headers: Dict[str, str] = {}
     ):
         """API client for Incoming Webhooks and response_url
         :param url: a complete URL to send data (e.g., https://hooks.slack.com/XXX)
+        :param timeout: request timeout (in seconds)
         :param default_headers: request headers to add to all requests
         """
         self.url = url
+        self.timeout = timeout
         self.default_headers = default_headers
 
     def send(
@@ -65,11 +67,11 @@ def send_dict(
         body = convert_bool_to_0_or_1(body)
         self._parse_web_class_objects(body)
         return self._perform_http_request(
-            url=self.url, body=body, headers=self._build_request_headers(headers),
+            body=body, headers=self._build_request_headers(headers)
         )
 
     def _perform_http_request(
-        self, *, url: str, body: Dict[str, any], headers: Dict[str, str]
+        self, *, body: Dict[str, any], headers: Dict[str, str]
     ) -> WebhookResponse:
         """Performs an HTTP request and parses the response.
         :param url: a complete URL to send data (e.g., https://hooks.slack.com/XXX)
@@ -85,6 +87,7 @@ def _perform_http_request(
                 f"Sending a request - url: {self.url}, body: {body}, headers: {headers}"
             )
         try:
+            url = self.url
             # for security
             if url.lower().startswith("http"):
                 req = Request(
@@ -93,11 +96,11 @@ def _perform_http_request(
             else:
                 raise SlackRequestError(f"Invalid URL detected: {url}")
 
-            resp: HTTPResponse = urlopen(req)
+            resp: HTTPResponse = urlopen(req, timeout=self.timeout)
             charset: str = resp.headers.get_content_charset() or "utf-8"
             response_body: str = resp.read().decode(charset)
             resp = WebhookResponse(
-                url=self.url,
+                url=url,
                 status_code=resp.status,
                 body=response_body,
                 headers=resp.headers,
@@ -109,7 +112,7 @@ def _perform_http_request(
             charset: str = e.headers.get_content_charset() or "utf-8"
             response_body: str = resp.read().decode(charset)
             resp = WebhookResponse(
-                url=self.url, status_code=e.code, body=response_body, headers=e.headers,
+                url=url, status_code=e.code, body=response_body, headers=e.headers,
             )
             if e.code == 429:
                 # for backward-compatibility with WebClient (v.2.5.0 or older)

tests/webhook/mock_web_api_server.py

@@ -1,7 +1,7 @@
-import json
 import logging
 import re
 import threading
+import time
 from http import HTTPStatus
 from http.server import HTTPServer, SimpleHTTPRequestHandler
 from typing import Type
@@ -28,6 +28,9 @@ def set_common_headers(self):
 
     def do_POST(self):
         try:
+            if self.path == "/timeout":
+                time.sleep(2)
+
             body = "ok"
 
             self.send_response(HTTPStatus.OK)

tests/webhook/test_webhook.py

@@ -1,4 +1,5 @@
 import unittest
+import socket
 
 from slack.web.classes.attachments import Attachment, AttachmentField
 from slack.web.classes.blocks import SectionBlock, ImageBlock
@@ -154,3 +155,8 @@ def test_send_dict(self):
         resp: WebhookResponse = client.send_dict({"text": "hello!"})
         self.assertEqual(200, resp.status_code)
         self.assertEqual("ok", resp.body)
+
+    def test_timeout_issue_712(self):
+        client = WebhookClient(url="http://localhost:8888/timeout", timeout=1)
+        with self.assertRaises(socket.timeout):
+            client.send_dict({"text": "hello!"})