Fix #1421 Update SlackApiError exception handling for web client (#1423)

vinceta · web-flow · commit 2afeba6b1c2e · 2023-11-13T17:56:52.000+09:00
* Update exception handling for SlackApiError

* Correct lint error for import
diff --git a/README.md b/README.md
@@ -107,6 +107,9 @@ except SlackApiError as e:
     assert e.response["ok"] is False
     assert e.response["error"]  # str like 'invalid_auth', 'channel_not_found'
     print(f"Got an error: {e.response['error']}")
+    # Also receive a corresponding status_code
+    assert isinstance(e.response.status_code, int)
+    print(f"Received a response status_code: {e.response.status_code}")
 ```
 
 Here we also ensure that the response back from Slack is a successful one and that the message is the one we sent by using the `assert` statement.
diff --git a/slack_sdk/web/base_client.py b/slack_sdk/web/base_client.py
@@ -19,7 +19,6 @@
 from urllib.parse import urlencode
 from urllib.request import Request, urlopen, OpenerDirector, ProxyHandler, HTTPSHandler
 
-import slack_sdk.errors as err
 from slack_sdk.errors import SlackRequestError
 from .deprecation import show_deprecation_warning_if_any
 from .internal_utils import (
@@ -299,7 +298,8 @@ def convert_params(values: dict) -> dict:
                     response_body_data = json.loads(response["body"])
                 except json.decoder.JSONDecodeError:
                     message = _build_unexpected_body_error_message(response.get("body", ""))
-                    raise err.SlackApiError(message, response)
+                    self._logger.error(f"Failed to decode Slack API response: {message}")
+                    response_body_data = {"ok": False, "error": message}
 
             all_params: Dict[str, Any] = copy.copy(body_params) if body_params is not None else {}
             if query_params:
diff --git a/tests/slack_sdk/web/test_web_client.py b/tests/slack_sdk/web/test_web_client.py
@@ -150,7 +150,7 @@ def test_html_response_body_issue_718(self):
             self.fail("SlackApiError expected here")
         except err.SlackApiError as e:
             self.assertTrue(
-                str(e).startswith("Received a response in a non-JSON format: <!DOCTYPE HTML PUBLIC"),
+                str(e).startswith("The request to the Slack API failed. (url: http://"),
                 e,
             )
 
diff --git a/tests/slack_sdk/web/test_web_client_http_retry_server_error.py b/tests/slack_sdk/web/test_web_client_http_retry_server_error.py
@@ -51,7 +51,16 @@ def test_html_response_body_issue_829(self):
             client.users_list(token="xoxb-error_html_response")
             self.fail("SlackApiError expected here")
         except err.SlackApiError as e:
-            self.assertTrue(str(e).startswith("Received a response in a non-JSON format: "), e)
+            self.assertTrue(
+                str(e).startswith("The request to the Slack API failed. (url: http://"),
+                e,
+            )
+            self.assertIsInstance(e.response.status_code, int)
+            self.assertFalse(e.response["ok"])
+            self.assertTrue(
+                e.response["error"].startswith("Received a response in a non-JSON format: <!DOCTYPE "),
+                e.response["error"],
+            )
 
         self.assertEqual(2, retry_handlers[0].call_count)
 
diff --git a/tests/slack_sdk/web/test_web_client_issue_829.py b/tests/slack_sdk/web/test_web_client_issue_829.py
@@ -21,4 +21,13 @@ def test_html_response_body_issue_829(self):
             client.users_list(token="xoxb-error_html_response")
             self.fail("SlackApiError expected here")
         except err.SlackApiError as e:
-            self.assertTrue(str(e).startswith("Received a response in a non-JSON format: "), e)
+            self.assertTrue(
+                str(e).startswith("The request to the Slack API failed. (url: http://"),
+                e,
+            )
+            self.assertIsInstance(e.response.status_code, int)
+            self.assertFalse(e.response["ok"])
+            self.assertTrue(
+                e.response["error"].startswith("Received a response in a non-JSON format: <!DOCTYPE "),
+                e.response["error"],
+            )

Original file line number	Diff line number	Diff line change
`@@ -150,7 +150,7 @@ def test_html_response_body_issue_718(self):`
`150`	`150`	`self.fail("SlackApiError expected here")`
`151`	`151`	`except err.SlackApiError as e:`
`152`	`152`	`self.assertTrue(`
`153`		`- str(e).startswith("Received a response in a non-JSON format: <!DOCTYPE HTML PUBLIC"),`
	`153`	`+ str(e).startswith("The request to the Slack API failed. (url: http://"),`
`154`	`154`	`e,`
`155`	`155`	`)`
`156`	`156`