Refactor mentor request form to use slack "blocks"

Author: AllenAnthes

pybot/endpoints/slack/actions/__init__.py

@@ -1,3 +1,5 @@
+from sirbot.plugins.slack import SlackPlugin
+
 from .general_actions import claimed, reset_claim
 from .help_ticket import open_ticket, ticket_status
 from .mentor_request import (
@@ -23,7 +25,7 @@
 from .report_message import open_report_dialog, send_report
 
 
-def create_endpoints(plugin):
+def create_endpoints(plugin: SlackPlugin):
     # simple actions that can be used in multiple scenarios
     plugin.on_action("claimed", claimed, name="claimed", wait=False)
     plugin.on_action("claimed", reset_claim, name="reset_claim", wait=False)
@@ -44,31 +46,27 @@ def create_endpoints(plugin):
     plugin.on_action("ticket_status", ticket_status, wait=False)
 
     # mentorship related interactive actions
-    plugin.on_action(
-        "mentor_request_submit", mentor_request_submit, name="submit", wait=False
-    )
-    plugin.on_action(
-        "mentor_request_submit", cancel_mentor_request, name="cancel", wait=False
-    )
-
-    plugin.on_action("mentor_request_update", add_skillset, name="skillset", wait=False)
-    plugin.on_action(
-        "mentor_request_update", clear_skillsets, name="clearSkills", wait=False
-    )
-    plugin.on_action(
-        "mentor_request_update", clear_mentor, name="clearMentor", wait=False
+    plugin.on_block(
+        "mentor_service",
+        set_requested_service,
+        wait=False,
+        action_id="mentor_service_select",
     )
-    plugin.on_action(
-        "mentor_request_update", open_details_dialog, name="addDetails", wait=False
+    plugin.on_block("skillset", add_skillset, action_id="skillset_select", wait=False)
+    plugin.on_block(
+        "clear_skillsets", clear_skillsets, action_id="clear_skillsets_btn", wait=False
     )
-    plugin.on_action(
-        "mentor_request_update", set_requested_mentor, name="mentor", wait=False
+    plugin.on_block("mentor", set_requested_mentor, action_id="mentor_select", wait=False)
+    plugin.on_block("comments", open_details_dialog, action_id="comments_btn", wait=False)
+    plugin.on_block("mentor_details_submit", mentor_details_submit, wait=False)
+    plugin.on_block("affiliation", set_group, action_id="affiliation_select", wait=False)
+    plugin.on_block(
+        "submission", mentor_request_submit, action_id="submit_btn", wait=False
     )
-    plugin.on_action(
-        "mentor_request_update", set_requested_service, name="service", wait=False
+    plugin.on_block(
+        "submission", cancel_mentor_request, action_id="cancel_btn", wait=False
     )
-    plugin.on_action("mentor_request_update", set_group, name="group", wait=False)
 
-    plugin.on_action("mentor_details_submit", mentor_details_submit, wait=False)
+    # mentorship claims
     plugin.on_action("claim_mentee", claim_mentee, wait=False)
     plugin.on_action("reset_claim_mentee", claim_mentee, wait=False)

pybot/endpoints/slack/actions/mentor_request.py

@@ -20,6 +20,7 @@ async def mentor_request_submit(action: Action, app: SirBot):
     request = MentorRequest(action)
 
     if not request.validate_self():
+        request.add_errors()
         await request.update_message(slack)
         return
 
@@ -36,8 +37,9 @@ async def mentor_request_submit(action: Action, app: SirBot):
 
 
 async def cancel_mentor_request(action: Action, app: SirBot):
-    response = {"ts": action["message_ts"], "channel": action["channel"]["id"]}
-    await app.plugins["slack"].api.query(methods.CHAT_DELETE, response)
+    slack = app.plugins["slack"].api
+    request = MentorRequest(action)
+    await request.delete_self(slack)
 
 
 async def mentor_details_submit(action: Action, app: SirBot):
@@ -50,7 +52,7 @@ async def mentor_details_submit(action: Action, app: SirBot):
     search = {"inclusive": True, "channel": channel, "oldest": ts, "latest": ts}
 
     history = await slack.query(methods.IM_HISTORY, search)
-    request["original_message"] = history["messages"][0]
+    request["message"] = history["messages"][0]
     request.details = action["submission"]["details"]
 
     await request.update_message(slack)
@@ -80,9 +82,8 @@ async def clear_mentor(action: Action, app: SirBot):
 
 
 async def set_group(action: Action, app: SirBot):
-    group = MentorRequest.selected_option(action)
     request = MentorRequest(action)
-    request.certify_group = group
+    request.affiliation = request.selected_option
 
     slack = app.plugins["slack"].api
     await request.update_message(slack)
@@ -91,26 +92,24 @@ async def set_group(action: Action, app: SirBot):
 async def set_requested_service(action: Action, app: SirBot):
     request = MentorRequest(action)
 
-    service = MentorRequest.selected_option(action)
-    request.service = service
+    request.service = request.selected_option
 
     slack = app.plugins["slack"].api
     await request.update_message(slack)
 
 
 async def set_requested_mentor(action: Action, app: SirBot):
-    mentor = MentorRequest.selected_option(action)
     request = MentorRequest(action)
-    request.mentor = mentor
+    request.mentor = request.selected_option
 
     slack = app.plugins["slack"].api
     await request.update_message(slack)
 
 
 async def add_skillset(action: Action, app: SirBot):
-    selected_skill = MentorRequest.selected_option(action)
     request = MentorRequest(action)
-    request.add_skillset(selected_skill)
+    selected_skill = request.selected_option
+    request.add_skillset(selected_skill["value"])
 
     slack = app.plugins["slack"].api
     await request.update_message(slack)

pybot/endpoints/slack/commands.py

@@ -7,7 +7,7 @@
 from pybot.endpoints.slack.message_templates.commands import (
     mentor_request_attachments,
     ticket_dialog,
-)
+    new_mentor_request_attachment)
 from pybot.endpoints.slack.utils import MODERATOR_CHANNEL
 from pybot.endpoints.slack.utils.action_messages import not_claimed_attachment
 from pybot.endpoints.slack.utils.command_utils import get_slash_repeat_messages
@@ -35,15 +35,14 @@ async def slash_mentor(command: Command, app: SirBot):
     mentors = await airtable.get_all_records("Mentors", "Full Name")
     skillsets = await airtable.get_all_records("Skillsets", "Name")
 
-    dialog = mentor_request_attachments(services, mentors, skillsets)
+    blocks = new_mentor_request_attachment(services, mentors, skillsets)
 
     response = {
-        "attachments": dialog,
+        "text": "Mentor Request Form",
+        "blocks": blocks,
         "channel": command["user_id"],
         "as_user": True,
-        "text": "Thank you for signing up for a 30 minute mentoring session. Please fill out the form below:",
     }
-
     await app.plugins["slack"].api.query(methods.CHAT_POST_MESSAGE, response)
 
 

pybot/endpoints/slack/message_templates/commands.py

@@ -129,3 +129,129 @@ def mentor_request_attachments(services, mentors, skillsets):
             ],
         },
     ]
+
+
+def new_mentor_request_attachment(services, mentors, skillsets):
+    return [
+        {
+            "type": "section",
+            "text": {"type": "mrkdwn", "text": "👨‍🏫 Mentor Request Form 👩‍🏫"},
+        },
+        {"type": "divider"},
+        {
+            "type": "section",
+            "block_id": "mentor_service",
+            "text": {"type": "mrkdwn", "text": "*Service (Required)*"},
+            "accessory": {
+                "action_id": "mentor_service_select",
+                "type": "static_select",
+                "placeholder": {"type": "plain_text", "text": "Service"},
+                "options": [
+                    {"text": {"type": "plain_text", "text": service}, "value": service}
+                    for service in services
+                ],
+            },
+        },
+        {
+            "type": "section",
+            "block_id": "skillset",
+            "text": {"type": "mrkdwn", "text": "*Mentor Skillsets*\n"},
+            "accessory": {
+                "type": "static_select",
+                "action_id": "skillset_select",
+                "placeholder": {"type": "plain_text", "text": "Skillset"},
+                "options": [
+                    {
+                        "text": {"type": "plain_text", "text": skillset},
+                        "value": skillset,
+                    }
+                    for skillset in skillsets
+                ],
+            },
+        },
+        {
+            "type": "section",
+            "block_id": "clear_skillsets",
+            "text": {"type": "mrkdwn", "text": "*Selected Skillsets*"},
+            "accessory": {
+                "type": "button",
+                "action_id": "clear_skillsets_btn",
+                "text": {"type": "plain_text", "text": "Reset Skillsets"},
+                "value": "reset_skillsets",
+            },
+        },
+        {
+            "type": "section",
+            "block_id": "mentor",
+            "text": {"type": "mrkdwn", "text": "*Select a specific mentor*"},
+            "accessory": {
+                "type": "static_select",
+                "action_id": "mentor_select",
+                "placeholder": {"type": "plain_text", "text": "Mentor"},
+                "options": [
+                    {"text": {"type": "plain_text", "text": mentor}, "value": mentor}
+                    for mentor in mentors
+                ],
+            },
+        },
+        {
+            "type": "section",
+            "block_id": "comments",
+            "text": {"type": "mrkdwn", "text": "*Add additional comments*"},
+            "accessory": {
+                "type": "button",
+                "action_id": "comments_btn",
+                "text": {"type": "plain_text", "text": "Add details"},
+                "value": "addDetails",
+            },
+            "fields": [{"type": "plain_text", "text": " "}],
+        },
+        {
+            "type": "section",
+            "block_id": "affiliation",
+            "text": {
+                "type": "mrkdwn",
+                "text": "*I certify that I am a member of the following group (Required)*",
+            },
+            "accessory": {
+                "type": "static_select",
+                "action_id": "affiliation_select",
+                "placeholder": {"type": "plain_text", "text": "Military affiliation"},
+                "options": [
+                    {
+                        "text": {"type": "plain_text", "text": "Veteran"},
+                        "value": "Veteran",
+                    },
+                    {
+                        "text": {"type": "plain_text", "text": "Active Duty"},
+                        "value": "Active Duty",
+                    },
+                    {
+                        "text": {"type": "plain_text", "text": "Military Spouse"},
+                        "value": "Military Spouse",
+                    },
+                ],
+            },
+        },
+        {"type": "divider"},
+        {
+            "type": "actions",
+            "block_id": "submission",
+            "elements": [
+                {
+                    "type": "button",
+                    "action_id": "submit_btn",
+                    "text": {"type": "plain_text", "text": "Submit"},
+                    "style": "primary",
+                    "value": "submit",
+                },
+                {
+                    "type": "button",
+                    "action_id": "cancel_btn",
+                    "text": {"type": "plain_text", "text": "Cancel"},
+                    "style": "danger",
+                    "value": "cancel",
+                },
+            ],
+        },
+    ]