Add exception handling for slack channel_not_found error

Author: AllenAnthes

pybot/__main__.py

@@ -14,7 +14,7 @@
 from pybot.endpoints.slack.utils import PORT, HOST
 from pybot.endpoints.slack.utils import slack_configs
 
-VERSION = "0.2.0"
+VERSION = "1.0"
 logger = logging.getLogger(__name__)
 
 
@@ -56,4 +56,4 @@ def make_sentry_logger():
     bot.router.add_get("/health", lambda request: Response(status=200))
     logging.getLogger('aiohttp.access').setLevel(logging.WARNING)
 
-    bot.start(host=HOST, port=PORT, print=False)
+    bot.start(host=HOST, port=PORT, print=logger.info)

pybot/endpoints/slack/commands.py

@@ -1,9 +1,12 @@
-import logging, random
+import functools
+import logging
+import random
 
 from sirbot import SirBot
 from sirbot.plugins.slack import SlackPlugin
 from slack import methods
 from slack.commands import Command
+from slack.exceptions import SlackAPIError
 
 from pybot.endpoints.slack.message_templates.commands import ticket_dialog, mentor_request_attachments
 from pybot.endpoints.slack.utils import PYBACK_HOST, PYBACK_PORT, PYBACK_TOKEN, MODERATOR_CHANNEL
@@ -14,12 +17,6 @@
 logger = logging.getLogger(__name__)
 
 
-# TODO: write input-serializer for the input from the slash command. see repeated code in each slash command
-
-
-# TODO: write test to ensure these functions exist at compile time -unit
-# TODO: write test to ensure that the slack api that is being targeted has the slash commands - integration
-# TODO: write functionality to automatically add the slash command to slack api - integration
 def create_endpoints(plugin: SlackPlugin):
     plugin.on_command('/here', slash_here, wait=False)
     plugin.on_command('/lunch', slash_lunch, wait=False)
@@ -30,6 +27,38 @@ def create_endpoints(plugin: SlackPlugin):
     # plugin.on_command('/mentor', slash_mentor, wait=False)
 
 
+def catch_slack_error(func):
+    """
+    Decorator for wrapping/catching exceptions thrown by
+    the slack client and displaying an error to the user.
+
+    Only necessary (for now) for functions that post messages to
+    slack channels
+    """
+
+    @functools.wraps(func)
+    async def handler(command: Command, app: SirBot, *args, **kwargs):
+        try:
+            await func(command, app, *args, **kwargs)
+
+        except SlackAPIError:
+            channel_id = command['channel_id']
+            slash_command = command['command']
+            slack_id = command['user_id']
+            slack = app['plugins']['slack']
+
+            await slack.api.query(methods.CHAT_POST_EPHEMERAL, dict(
+                user=slack_id,
+                channel=slack_id,
+                as_user=True,
+                text=(f'Could not post result of `{slash_command}` '
+                      f'to channel <#{channel_id}>')
+            ))
+
+    return handler
+
+
+@catch_slack_error
 async def slash_mentor(command: Command, app: SirBot):
     airtable = app.plugins['airtable'].api
     services = await airtable.get_all_records('Services', 'Name')
@@ -43,9 +72,10 @@ async def slash_mentor(command: Command, app: SirBot):
         'channel': command['user_id'],
         'as_user': True,
     }
-    await app.plugins["slack"].api.query(methods.CHAT_POST_MESSAGE, response)
+    await app.plugins['slack'].api.query(methods.CHAT_POST_MESSAGE, response)
 
 
+@catch_slack_error
 async def slash_ticket(command: Command, app: SirBot):
     trigger_id = command['trigger_id']
     user_id = command['user_id']
@@ -55,13 +85,14 @@ async def slash_ticket(command: Command, app: SirBot):
     clicker_email = user_info['user']['profile']['email']
 
     response = {
-        "trigger_id": trigger_id,
-        "dialog": ticket_dialog(clicker_email, command['text'])
+        'trigger_id': trigger_id,
+        'dialog': ticket_dialog(clicker_email, command['text'])
     }
 
-    await app.plugins["slack"].api.query(methods.DIALOG_OPEN, response)
+    await app.plugins['slack'].api.query(methods.DIALOG_OPEN, response)
 
 
+@catch_slack_error
 async def slash_report(command: Command, app: SirBot):
     """
     Sends text supplied with the /report command to the moderators channel along
@@ -70,7 +101,7 @@ async def slash_report(command: Command, app: SirBot):
     slack_id = command['user_id']
     text = command['text']
 
-    slack = app["plugins"]["slack"].api
+    slack = app['plugins']['slack'].api
 
     message = f'<@{slack_id}> sent report: {text}'
 
@@ -83,14 +114,15 @@ async def slash_report(command: Command, app: SirBot):
     await slack.query(methods.CHAT_POST_MESSAGE, response)
 
 
+@catch_slack_error
 async def slash_here(command: Command, app: SirBot):
     """
     /here allows admins to give non-admins the ability to use @here-esque functionality for specific channels.
     Queries pyback to determine if user is authorized
     """
     channel_id = command['channel_id']
     slack_id = command['user_id']
-    slack = app["plugins"]["slack"].api
+    slack = app['plugins']['slack'].api
 
     params = {'slack_id': slack_id, 'channel_id': channel_id}
     headers = {'Authorization': f'Token {PYBACK_TOKEN}'}
@@ -115,6 +147,7 @@ async def slash_here(command: Command, app: SirBot):
     await slack.query(methods.CHAT_POST_MESSAGE, {'channel': channel_id, 'text': member_list, 'thread_ts': timestamp})
 
 
+@catch_slack_error
 async def slash_lunch(command: Command, app: SirBot):
     """
     Provides the user with a random restaurant in their area.
@@ -123,7 +156,7 @@ async def slash_lunch(command: Command, app: SirBot):
     lunch = LunchCommand(command['channel_id'], command['user_id'],
                          command.get('text'), command['user_name'])
 
-    slack = app["plugins"]["slack"].api
+    slack = app['plugins']['slack'].api
 
     request = lunch.get_yelp_request()
     async with app.http_session.get(**request) as r:
@@ -133,26 +166,25 @@ async def slash_lunch(command: Command, app: SirBot):
         await slack.query(methods.CHAT_POST_EPHEMERAL, message_params)
 
 
+@catch_slack_error
 async def slash_repeat(command: Command, app: SirBot):
     logger.info(f'repeat command data incoming {command}')
     channel_id = command['channel_id']
     slack_id = command['user_id']
-    slack = app["plugins"]["slack"].api
+    slack = app['plugins']['slack'].api
 
     method_type, message = get_slash_repeat_messages(slack_id, channel_id, command['text'])
+
     await slack.query(method_type, message)
 
 
+@catch_slack_error
 async def slash_roll(command: Command, app: SirBot):
-    """
-    Sends text supplied with the /report command to the moderators channel along
-    with a button to claim the issue
-    """
     slack_id = command['user_id']
     channel_id = command['channel_id']
     text = command['text']
 
-    slack = app["plugins"]["slack"].api
+    slack = app['plugins']['slack'].api
 
     # parse the type of die and number to roll
     try:
@@ -165,7 +197,7 @@ async def slash_roll(command: Command, app: SirBot):
         if typedice <= 0 or typedice > 20:
             raise ValueError
     except ValueError:
-        logger.debug("invalid input to roll: %s", text)
+        logger.debug('invalid input to roll: %s', text)
         await slack.query(methods.CHAT_POST_EPHEMERAL,
                           {'user': slack_id, 'channel': channel_id,
                            'text': "Sorry, I didn't understand your input. Should be XDYY where X is the number of dice, and YY is the number of sides"})