Merge pull request #47 from amckenna-pinterest/slack_sdk

Add async support for handle_event in plugins

Author: amckenna-pinterest

slackminion/bot.py

@@ -290,7 +290,7 @@ def _add_event_handlers(self):
     # generic handler for handling event types registered by plugins via notify_event_types class attribute
     async def _event_plugin(self, **payload):
         event_type, data = self._unpack_payload(**payload)
-        self.plugin_manager.broadcast_event(event_type, data)
+        await self.plugin_manager.broadcast_event(event_type, data)
 
     # when the bot is invited to a channel, add the channel to self.channels
     async def _event_channel_joined(self, **payload):
@@ -336,9 +336,9 @@ def _prepare_and_send_output(self, cmd, msg, cmd_options, output):
             self.send_message(msg.channel, output, thread=thread_ts,
                               reply_broadcast=cmd_options.get('reply_broadcast'), parse=parse)
 
-    def _event_error(self, **payload):
+    async def _event_error(self, **payload):
         event_type, data = self._unpack_payload(**payload)
-        self.plugin_manager.broadcast_event(event_type, data)
+        await self.plugin_manager.broadcast_event(event_type, data)
         self.log.error(f"Received an error response from Slack: {payload}")
 
     def get_channel_by_name(self, channel_name):

slackminion/plugin/manager.py

@@ -1,5 +1,6 @@
 import json
 import logging
+import inspect
 from datetime import datetime
 
 
@@ -73,13 +74,16 @@ def load(self):
     # Broadcasts a slack event to handlers that have registered for the
     # event type via notify_event_types class attribute
     # Plugin MUST implement a handle_event method to handle these events.
-    def broadcast_event(self, event_type, data):
+    async def broadcast_event(self, event_type, data):
         for plugin in self.plugins:
             if event_type in plugin.notify_event_types:
                 self.log.debug(
                     f'Sending event of type {event_type} to plugin {plugin.__class__.__name__}.  Data: {data}')
                 try:
-                    plugin.handle_event(event_type, data)
+                    if inspect.iscoroutinefunction(plugin.handle_event):
+                        await plugin.handle_event(event_type, data)
+                    else:
+                        plugin.handle_event(event_type, data)
                 # The plugin is expected to handle its own exceptions.
                 except Exception:  # noqa
                     self.log.exception("Unhandled exception!")

slackminion/plugins/core/__init__.py

@@ -1 +1 @@
-version = '1.1.4'
+version = '1.1.5'

slackminion/tests/test_bot.py

@@ -208,8 +208,9 @@ def test_prepare_and_send_output_with_cmd_options(self):
         self.object.send_message.assert_called_with(self.test_event.channel, test_output, thread=test_thread_ts,
                                                     reply_broadcast=None, parse=None)
 
-    def test_event_error(self):
-        self.object._event_error(**test_payload)
+    @async_test
+    async def test_event_error(self):
+        await self.object._event_error(**test_payload)
         self.object.log.error.assert_called_with(f"Received an error response from Slack: {test_payload}")
 
     def test_get_channel_by_name(self):
@@ -243,19 +244,18 @@ def test_unpack_payload(self):
         self.assertEqual(event_type, test_payload['data']['type'])
         self.assertEqual(data, test_payload['data'])
 
-
     @mock.patch('slackminion.bot.MyRTMClient')
     @async_test
     async def test_handle_plugin_event(self, mock_rtm):
         self.object.plugin_manager = mock.Mock()
         plugin = PluginWithEvents(self.object)
         plugin.handle_event = mock.Mock()
-        self.object.plugin_manager.broadcast_event = mock.Mock()
+        self.object.plugin_manager.broadcast_event = AsyncMock()
         self.object.plugin_manager.plugins = [plugin]
         self.object._add_event_handlers()
         self.assertEqual(mock_rtm.on.call_count, 4)
         mock_rtm.on.assert_called_with(event=test_event_type,
-                                                 callback=self.object._event_plugin)
+                                       callback=self.object._event_plugin)
         await self.object._event_plugin(**test_payload)
         self.object.plugin_manager.broadcast_event.assert_called_with(test_event_type, test_payload['data'])
 

slackminion/tests/test_plugin/test_manager.py

@@ -21,9 +21,10 @@ def test_on_unload(self):
         self.object.unload_all()
         fake_plugin.on_unload.assert_called()
 
-    def test_broadcast_event(self):
+    @async_test
+    async def test_broadcast_event(self):
         plugin = PluginWithEvents(mock.Mock())
         plugin.handle_event = mock.Mock()
         self.object.plugins = [plugin]
-        self.object.broadcast_event(test_event_type, test_payload['data'])
+        await self.object.broadcast_event(test_event_type, test_payload['data'])
         plugin.handle_event.assert_called_with(test_event_type, test_payload['data'])