Add -data option to /slack debug error to print rtm event data

1 files changed, 36 insertions, 5 deletions

diff --git a/slack/error.py b/slack/error.py
index 8817759..c978584 100644
--- a/slack/error.py
+++ b/slack/error.py
@@ -5,10 +5,12 @@ from datetime import datetime
 from typing import TYPE_CHECKING, Dict, Mapping, Sequence, Union
 from uuid import uuid4
 
+from slack.python_compatibility import format_exception_only
 from slack.shared import shared
 
 if TYPE_CHECKING:
     from slack_api.slack_common import SlackErrorResponse
+    from slack_rtm.slack_rtm_message import SlackRtmMessage
 
     from slack.slack_workspace import SlackWorkspace
 
@@ -51,6 +53,22 @@ class SlackApiError(Exception):
         self.response = response
 
 
+class SlackRtmError(Exception):
+    def __init__(
+        self,
+        workspace: SlackWorkspace,
+        exception: BaseException,
+        message_json: SlackRtmMessage,
+    ):
+        super().__init__(
+            f"{self.__class__.__name__}: workspace={workspace}, exception=`{format_exception_only_str(exception)}`"
+        )
+        super().with_traceback(exception.__traceback__)
+        self.workspace = workspace
+        self.exception = exception
+        self.message_json = message_json
+
+
 class SlackError(Exception):
     def __init__(self, workspace: SlackWorkspace, error: str):
         super().__init__(
@@ -70,22 +88,35 @@ class UncaughtError:
         self.time = datetime.now()
 
 
+def format_exception_only_str(exc: BaseException) -> str:
+    return format_exception_only(exc)[-1].strip()
+
+
 def store_and_format_exception(e: BaseException):
     uncaught_error = UncaughtError(e)
     shared.uncaught_errors.append(uncaught_error)
-    stack_msg = f"(run /slack debug error {uncaught_error.id} for stack trace)"
+    stack_msg_command = f"/slack debug error {uncaught_error.id}"
+    stack_msg = f"run `{stack_msg_command}` for the stack trace"
 
     if isinstance(e, HttpError):
         return (
             f"Error calling URL {e.url}: return code: {e.return_code}, "
-            f"http status code: {e.http_status_code}, error: {e.error} {stack_msg}"
+            f"http status code: {e.http_status_code}, error: {e.error} ({stack_msg})"
         )
     elif isinstance(e, SlackApiError):
         return (
             f"Error from Slack API method {e.method} with params {e.params} for workspace "
-            f"{e.workspace.name}: {e.response} {stack_msg}"
+            f"{e.workspace.name}: {e.response} ({stack_msg})"
+        )
+    elif isinstance(e, SlackRtmError):
+        return (
+            f"Error while handling Slack event of type '{e.message_json['type']}' for workspace "
+            f"{e.workspace.name}: {format_exception_only_str(e.exception)} ({stack_msg}, "
+            f"run `{stack_msg_command} -data` for the event data)"
         )
     elif isinstance(e, SlackError):
-        return f"Error occurred in workspace {e.workspace.name}: {e.error} {stack_msg}"
+        return (
+            f"Error occurred in workspace {e.workspace.name}: {e.error} ({stack_msg})"
+        )
     else:
-        return f"Unknown error occurred: {e.__class__.__name__}: {e} {stack_msg}"
+        return f"Unknown error occurred: {format_exception_only_str(e)} ({stack_msg})"