Updating channel creation to remove Slack admin if wanted (WIP)

Author: stefdworschak

accounts/migrations/0021_slacksitesettings_remove_admin_from_channel.py

@@ -0,0 +1,18 @@
+# Generated by Django 3.1.13 on 2023-01-23 16:25
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('accounts', '0020_auto_20230104_1655'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='slacksitesettings',
+            name='remove_admin_from_channel',
+            field=models.BooleanField(default=True, help_text='The user linked to the ADMIN_BOT_TOKEN will automatically be added to any new channels. If this is ticked, the user will be removed from private team channels if they are not part of the team, facilitator or the slack admins'),
+        ),
+    ]

accounts/models.py

@@ -203,6 +203,12 @@ class SlackSiteSettings(SingletonModel):
     communication_channel_type = models.CharField(
         max_length=50, choices=COMMUNICATION_CHANNEL_TYPES,
         default='slack_private_channel')
+    remove_admin_from_channel = models.BooleanField(
+        default=True,
+        help_text=("The user linked to the ADMIN_BOT_TOKEN will automatically "
+                   "be added to any new channels. If this is ticked, the user " 
+                   "will be removed from private team channels if they are not "
+                   "part of the team, facilitator or the slack admins"))
 
     def __str__(self):
         return "Slack Settings"

custom_slack_provider/slack.py

@@ -1,8 +1,11 @@
+import logging
 import re
 import requests
 from requests.auth import AuthBase
 
-from django.conf import settings
+
+logger = logging.getLogger(__name__)
+logger.setLevel(logging.INFO)
 
 
 class AuthBearer(AuthBase):
@@ -25,12 +28,16 @@ class CustomSlackClient():
     user_detail_url = 'https://slack.com/api/users.info'
     create_conversation_url = 'https://slack.com/api/conversations.create'
     invite_conversation_url = 'https://slack.com/api/conversations.invite'
+    leave_conversation_url = 'https://slack.com/api/conversations.leave'
 
     def __init__(self, token):
         self.token = token
 
     def _make_slack_get_request(self, url, params=None):
         resp = requests.get(url, auth=AuthBearer(self.token), params=params)
+        if resp.status_code != 200:
+            raise SlackException(resp.get("error"))
+
         resp = resp.json()
 
         if not resp.get('ok'):
@@ -40,31 +47,60 @@ def _make_slack_get_request(self, url, params=None):
 
     def _make_slack_post_request(self, url, data):
         resp = requests.post(url, auth=AuthBearer(self.token), data=data)
-        resp = resp.json()
-
-        if not resp.get('ok'):
-            raise SlackException(resp.get("error"))
-
-        return resp
+        if resp.status_code != 200:
+            return {
+                'ok': False,
+                'error': resp.get("error")
+            }
+        return resp.json()
 
     def get_identity(self):
         return self._make_slack_get_request(self.identity_url)
 
+    def leave_channel(self, channel):
+        data = {
+            'channel': channel
+        }
+        leave_channel = self._make_slack_post_request(
+            self.leave_conversation_url, data=data)
+
+        if not leave_channel.get('ok'):
+            print(('An error occurred adding users to the Private Slack Channel. '
+                   f'Error code: {leave_channel.get("error")}'))
+
+        return leave_channel
+
     def get_user_info(self, userid):
         params = {"user": userid}
         response = self._make_slack_get_request(self.user_detail_url,
                                                 params=params)
         return response.get('user', {})
 
-    def create_slack_channel(self, channel_name, is_private=True):
+    def create_slack_channel(self, channel_name, team_id, is_private=True):
         data = {
+            "team_id": team_id,
             "name": channel_name,
             "is_private": is_private,
-            "team_id": settings.SLACK_TEAM_ID,
         }
         new_channel = self._make_slack_post_request(
             self.create_conversation_url, data=data)
-        return new_channel.get('channel', {})
+
+        if not new_channel.get('ok'):
+            if new_channel.get('error') == 'name_taken':
+                error_msg = (f'An error occurred creating the Private Slack Channel. '
+                             f'A channel with the name "{channel_name}" already '
+                             f'exists. Please change your team name and try again '
+                             f'or contact an administrator')
+            else:
+                error_msg = (f'An error occurred creating the Private Slack Channel. '
+                             f'Error code: {new_channel.get("error")}')
+            return {
+                'ok': False,
+                'error': error_msg
+            }
+
+        logger.info(f"Successfully created {channel_name} ({new_channel.get('channel', {}).get('id')}).")
+        return new_channel
 
     def _extract_userid_from_username(self, username):
         """ Extracts the Slack userid from a hackathon platform userid
@@ -74,11 +110,36 @@ def _extract_userid_from_username(self, username):
             raise SlackException('Error adding user to channel')
         return username.split('_')[0]
 
-    def add_user_to_slack_channel(self, username, channel_id):
+    def invite_users_to_slack_channel(self, users, channel):
+        data = {
+            "users": users,
+            "channel": channel,
+        }
+        user_added = self._make_slack_post_request(
+            self.invite_conversation_url, data=data)
+
+        if not user_added.get('ok'):
+            return {
+                'ok': False,
+                'error': ('An error occurred adding users to Private Slack Channel {channel}. '
+                          f'Error code: {user_added.get("error")}')
+            }
+
+        return user_added
+
+    def kick_user_from_slack_channel(self, user, channel):
         data = {
-            "user": self._extract_userid_from_username(username),
-            "channel": channel_id,
+            "user": user,
+            "channel": channel,
         }
         user_added = self._make_slack_post_request(
             self.invite_conversation_url, data=data)
+
+        if not user_added.get('ok'):
+            return {
+                'ok': False,
+                'error': (f'An error occurred kicking user {user} from Private Slack Channel {channel}. '
+                          f'Error code: {user_added.get("error")}')
+            }
+
         return user_added

custom_slack_provider/tests.py

@@ -7,7 +7,6 @@
 from .provider import SlackProvider
 from custom_slack_provider.slack import CustomSlackClient, SlackException
 from django.core.management import call_command
-from 
 
 
 class SlackOAuth2Tests(OAuth2TestsMixin, TestCase):
@@ -36,6 +35,7 @@ def setUp(self):
     def test__make_slack_get_request(self, get):
         mock_response = Mock()
         mock_response.json.return_value = {'ok': True}
+        mock_response.status_code = 200
         get.return_value = mock_response
         client = CustomSlackClient(self.token)
         response = client._make_slack_get_request(url='test')
@@ -53,6 +53,7 @@ def test__make_slack_get_request(self, get):
     def test__make_slack_post_request(self, post):
         mock_response = Mock()
         mock_response.json.return_value = {'ok': True}
+        mock_response.status_code = 200
         post.return_value = mock_response
         client = CustomSlackClient(self.token)
         response = client._make_slack_post_request(url='test', data={})
@@ -86,12 +87,12 @@ def test__extract_userid_from_username(self):
             self.assertEquals(e.message, 'Error adding user to channel')
 
     @patch('custom_slack_provider.slack.CustomSlackClient._make_slack_post_request')  # noqa: 501
-    def test_add_user_to_slack_channel(self, _make_slack_post_request):
+    def test_invite_users_to_slack_channel(self, _make_slack_post_request):
         _make_slack_post_request.return_value = {
             'ok': True,
             'channel': {'id': 'CH123123'}
         }
         client = CustomSlackClient(self.token)
-        response = client.add_user_to_slack_channel(username='UA123123_T15666',
-                                                    channel_id='CH123123')
+        response = client.invite_users_to_slack_channel(users='UA123123_T15666',
+                                                        channel='CH123123')
         self.assertEqual(response['channel']['id'], 'CH123123')

hackathon/tasks.py

@@ -1,5 +1,5 @@
 import logging
-import os
+import re
 
 from celery import shared_task
 from django.conf import settings
@@ -12,9 +12,10 @@
 from celery import shared_task
 from django.conf import settings
 
-from accounts.models import CustomUser as User
+from custom_slack_provider.slack import CustomSlackClient
 from hackathon.models import Hackathon
-from custom_slack_provider.slack import CustomSlackClient, SlackException
+from teams.tasks import remove_admin_from_channel
+
 
 logger = logging.getLogger(__name__)
 logger.setLevel(logging.INFO)
@@ -45,37 +46,69 @@ def send_email_from_template(user_email, user_name, hackathon_display_name, temp
 
 
 @shared_task
-def create_new_slack_channel(hackathon_id, channel_name):
+def create_new_hackathon_slack_channel(hackathon_id, channel_name):
     """ Create a new Slack Channel/Conversation in an existing Workspace """
-    if not settings.SLACK_ENABLED:
-        logger.info("Slack not enabled.")
+    slack_site_settings = SlackSiteSettings.objects.first()
+    if (not (settings.SLACK_ENABLED or settings.SLACK_BOT_TOKEN or settings.SLACK_ADMIN_TOKEN
+             or settings.SLACK_WORKSPACE or not slack_site_settings)):
+        logger.info("This feature is not enabeled.")
         return
 
     hackathon = Hackathon.objects.get(id=hackathon_id)
     logger.info(
         (f"Creating new Slack channel {channel_name} for hackathon "
          f"{hackathon.display_name} in Slack Workspace "
          f"{settings.SLACK_WORKSPACE}({settings.SLACK_TEAM_ID})"))
-    slack_client = CustomSlackClient(settings.SLACK_BOT_TOKEN)
-    channel = slack_client.create_slack_channel(
-        channel_name, is_private=True)
 
-    channel_id = channel.get('id')
-    logger.info(f"Channel with id {channel_id} created.")
+    admin_client = CustomSlackClient(settings.SLACK_ADMIN_TOKEN)
+    channel_response = admin_client.create_slack_channel(
+        team_id=settings.SLACK_TEAM_ID,
+        channel_name=channel_name,
+        is_private=True,
+    )
 
-    if not channel_id:
-        logger.error("No Channel Id found.")
-        return
+    if not channel_response['ok']:
+        logger.error(channel_response['error'])
 
-    channel_url = f'https://{settings.SLACK_WORKSPACE}.slack.com/archives/{channel_id}'  # noqa: E501
+    channel = channel_response.get('channel', {}).get('id')
+    channel_url = f'https://{settings.SLACK_WORKSPACE}.slack.com/archives/{channel}'
     hackathon.channel_url = channel_url
     hackathon.save()
-    logger.info(f"Hackathon {hackathon.display_name} updated successfully.")
-
-    logger.info("Adding channel admins")
-    for admin in hackathon.channel_admins.all():
-        try:
-            slack_client.add_user_to_slack_channel(admin.username, channel_id)
-        except SlackException:
-            logger.exception((f"Could not add user with id {admin.id} "
-                              f"to channel {channel_id}."))
+    logger.info(f"Channel with id {channel} created.")
+
+    # Add admins to channel for administration purposes
+    users = [admin.username for admin in slack_site_settings.slack_admins.all()]
+    # First need to add Slack Bot to then add users to channel
+    response = admin_client.invite_users_to_slack_channel(
+        users=settings.SLACK_BOT_ID,
+        channel=channel,
+    )
+    if not response['ok']:
+        logger.error(response['error'])
+        return
+
+    bot_client = CustomSlackClient(settings.SLACK_BOT_TOKEN)
+    pattern = re.compile(r'^U[a-zA-Z0-9]*[_]T[a-zA-Z0-9]*$')
+    users_to_invite = ','.join([user.split('_')[0]
+                                for user in users if pattern.match(user)])
+    bot_client.invite_users_to_slack_channel(
+        users=users_to_invite,
+        channel=channel,
+    )
+
+    if not response['ok']:
+        logger.error(response['error'])
+        return
+
+    if slack_site_settings.remove_admin_from_channel:
+        remove_admin_from_channel(users_to_invite, channel)
+
+
+@shared_task
+def invite_user_to_hackathon_slack_channel(hackathon_id, user_id):
+    bot_client = CustomSlackClient(settings.SLACK_BOT_TOKEN)
+
+
+@shared_task
+def kick_user_to_hackathon_slack_channel(user, channel):
+    pass

hackathon/tests/task_tests.py

@@ -7,7 +7,7 @@
 
 from accounts.models import Organisation, CustomUser as User
 from hackathon.models import Hackathon
-from hackathon.tasks import create_new_slack_channel
+from hackathon.tasks import create_new_hackathon_slack_channel
 
 
 class TaskTests(TestCase):
@@ -29,15 +29,15 @@ def setUp(self):
     @override_settings(CELERY_EAGER_PROPAGATES_EXCEPTIONS=True,
                        CELERY_ALWAYS_EAGER=True,
                        BROKER_BACKEND='memory')
-    def test_create_new_slack_channel(self):
+    def test_create_new_hackathon_slack_channel(self):
         channel_id = 'CH123123'
         responses.add(
             responses.POST, 'https://slack.com/api/conversations.create',
             json={'ok': True, 'channel': {'id': channel_id}}, status=200)
         responses.add(
             responses.POST, 'https://slack.com/api/conversations.invite',
             json={'ok': True}, status=200)
-        create_new_slack_channel.apply_async(args=[
+        create_new_hackathon_slack_channel.apply_async(args=[
             self.hackathon.id, self.user.username])
 
         import time; time.sleep(3)