use an enum for message type #330 #338

Author: Hagellach37

mapswipe_workers/mapswipe_workers/definitions.py

@@ -1,17 +1,22 @@
-import logging
 import logging.config
 import os
-
 import sentry_sdk
 from xdg import XDG_DATA_HOME
-
 from mapswipe_workers.config import SENTRY_DSN
+from enum import Enum
 
 
 class CustomError(Exception):
     pass
 
 
+class MessageType(Enum):
+    SUCCESS = 1
+    FAIL = 2
+    NOTIFICATION_90 = 3
+    NOTIFICATION_100 = 4
+
+
 DATA_PATH = os.path.join(XDG_DATA_HOME, "mapswipe_workers")
 if not os.path.exists(DATA_PATH):
     os.makedirs(DATA_PATH)

mapswipe_workers/mapswipe_workers/mapswipe_workers.py

@@ -8,7 +8,7 @@
 
 import click
 from mapswipe_workers import auth
-from mapswipe_workers.definitions import CustomError, logger, sentry
+from mapswipe_workers.definitions import CustomError, logger, sentry, MessageType
 from mapswipe_workers.firebase_to_postgres import (
     archive_project,
     delete_project,
@@ -87,12 +87,12 @@ def run_create_projects():
             project.calc_required_results()
             # Save project and its groups and tasks to Firebase and Postgres.
             project.save_project()
-            send_slack_message("success", project_name, project.projectId)
+            send_slack_message(MessageType.SUCCESS, project_name, project.projectId)
             logger.info("Success: Project Creation ({0})".format(project_name))
         except CustomError:
             ref = fb_db.reference(f"v2/projectDrafts/{project_draft_id}")
             ref.set({})
-            send_slack_message("fail", project_name, project.projectId)
+            send_slack_message(MessageType.FAIL, project_name, project.projectId)
             logger.exception("Failed: Project Creation ({0}))".format(project_name))
             sentry.capture_exception()
         continue

mapswipe_workers/mapswipe_workers/utils/slack_helper.py

@@ -2,9 +2,12 @@
 from mapswipe_workers.definitions import logger
 from mapswipe_workers import auth
 from mapswipe_workers.config import SLACK_CHANNEL, SLACK_TOKEN
+from mapswipe_workers.definitions import MessageType
 
 
-def send_slack_message(message_type: str, project_name: str, project_id: str = None):
+def send_slack_message(
+    message_type: MessageType, project_name: str, project_id: str = None
+):
     """Initialize slack client with values provided in environment."""
     if SLACK_TOKEN is None or SLACK_CHANNEL is None:
         logger.info(
@@ -15,7 +18,7 @@ def send_slack_message(message_type: str, project_name: str, project_id: str = N
 
     slack_client = slack.WebClient(token=SLACK_TOKEN)
 
-    if message_type == "success":
+    if message_type == MessageType.SUCCESS:
         message = (
             "### PROJECT CREATION SUCCESSFUL ###\n"
             + f"Project Name: {project_name}\n"
@@ -24,22 +27,22 @@ def send_slack_message(message_type: str, project_name: str, project_id: str = N
             + "Happy Swiping. :)"
         )
         slack_client.chat_postMessage(channel=SLACK_CHANNEL, text=message)
-    elif message_type == "fail":
+    elif message_type == MessageType.FAIL:
         message = (
             "### PROJECT CREATION FAILED ###\n"
             + f"Project Name: {project_name}\n"
             + "Project draft is deleted."
         )
         slack_client.chat_postMessage(channel=SLACK_CHANNEL, text=message)
-    elif message_type == "notification_90":
+    elif message_type == MessageType.NOTIFICATION_90:
         message = (
             "### ALMOST THERE! PROJECT REACHED 90% ###\n"
             + f"Project Name: {project_name}\n"
             + f"Project Id: {project_id}\n\n"
             + "Get your next projects ready."
         )
         slack_client.chat_postMessage(channel="mapswipe_managers", text=message)
-    elif message_type == "notification_100":
+    elif message_type == MessageType.NOTIFICATION_100:
         message = (
             "### GREAT! PROJECT REACHED 100% ###\n"
             + f"Project Name: {project_name}\n"
@@ -73,10 +76,10 @@ def send_progress_notification(project_id: int):
 
         if progress >= 90 and not notification_90_sent:
             # send notification and set value in firebase
-            send_slack_message("notification_90", project_name, project_id)
+            send_slack_message(MessageType.NOTIFICATION_90, project_name, project_id)
             fb_db.reference(f"v2/projects/{project_id}/notification_90_sent").set(True)
 
         if progress >= 100 and not notification_100_sent:
             # send notification and set value in firebase
-            send_slack_message("notification_100", project_name, project_id)
+            send_slack_message(MessageType.NOTIFICATION_100, project_name, project_id)
             fb_db.reference(f"v2/projects/{project_id}/notification_100_sent").set(True)