Skip to content

Latest commit

 

History

History
executable file
·
222 lines (158 loc) · 12.5 KB

README.md

File metadata and controls

executable file
·
222 lines (158 loc) · 12.5 KB
Raw

SUTD What The Hack Automation Slack Bot

Code style: black

This Slack bot assists with administration, registration and judging for the purposes of SUTD What The Hack.

This codebase is made open to the public to prove that the score processing during judging is not rigged. 😉

More formally/rigorously, the objectives of this bot are to:

  • Automate collection, tabulation, and calculation of scoring submissions by the judges
  • Automate generation of the overall final score leaderboard to cut off processing time
  • Ensure tamper-proof scores through judge authentication (except for veto powers of the organizer)
  • (TODO) Assist with document and details management of the participants, judges, and Slack workspace for the hackathon

Other simpler alternatives are definitely available, such as using Google Sheets, Microsoft Excel, or just sheets of paper. Such alternative methods can be utilized as backup solutions in the case of errors/failures of this bot.

Table of Contents

Description

For the Slack bot side, we are using the Slackers Python Library, which follows the Pydantic philosophy. We built the Slack bot from the ground up (quite low-level) instead of using certain bot frameworks that currently already exist since it provides us with more flexibility with the whole FastAPI server setup and database management (considering that Slack's API changes quite rapidly). We are using FastAPI equipped with an ASGI server since it provides easier asynchronous management and speedier service for the Slack bot (by using Starlette and Uvicorn). Thus, please take note that at the moment, Windows does not support uvloop, which is used by this Slack bot.

The design of this bot allows it to be run either as a standalone module (without the database and both of OComm's backend and frontend modules) or in tandem with the rest of the automation modules. The database will be set up by this bot's SQLAlchemy's side, if it has not currently existed anyway.

This bot uses SQLAlchemy for the database side. This is just nice since FastAPI integrates nicely with SQLAlchemy. It may be replaced by any equivalent SQL database (feel free to modify dbhelper.py). It is also possible to generate an SQLAlchemy model from an existing database by using sqlacodegen. Data is collected through Microsoft Forms (due to PDPA reasons) and stored in a local SUTD server. This same database copy will be used by the bot running on the same local server (using another port, different from the OComm backend module). Traffic introspection service and redirection tools can be utilized to make this process of serving multiple software on different ports easier.

Since this bot is only for our private Slack workspace (and not for public distribution), we do not need to use an HTTPS certificate (take note that Slack does not allow self-signed certificates for an HTTPS-based Request URL).

This Slack bot was originally developed before this Slack Bolt for Python library was created. For future developments, we can either stay and stick to the current slackers library or perform a migration to use Bolt instead. Either way, the overall structure of this Slack bot's codebase should remain largely similar.

Installation

After cloning this repo, just populate the necessary constants in settings.py and run deploy.sh from the scripts folder as the current working directory before the hackathon starts to initialize all configurations. It provides an automated setting-up of:

  • The initialization of the isolated Python virtual environment
  • The required Python dependencies needed to run the bot properly
  • The SQL database and its corresponding configurations
  • The bot server configuration files & environment variables
  • The execution of the bot's code

Post-hackathon, do a proper clean-up by running shutdown.sh, also from the scripts folder as the current working directory.

Slack App Configuration

With the current app design, the corresponding various Request URL endpoints are protected with the secret key (Bot User OAuth Token, instead of User OAuth Token) for additional security purposes. Hence, the URL link structure would roughly be: https://subdomain.domain.tld/<secret-key>/<endpoint>.

  • Settings: SUTD WTH Bot - Automated service provider for SUTD What The Hack

  • Features:

    1. @sutdwthbot is always shown as online

    2. Both OAuth Access Token and Bot User OAuth Access Token are utilized

    3. Messages Tab enabled

    4. Incoming Webhooks activated (with only one existing Webhook URL)

    5. Interactivity enabled with the appropriate Request URL (/actions endpoint)

    6. Slash Commands enabled for the respective commands with the appropriate Request URL (/commands endpoint) and the Escape channels, users, and links sent to your app option enabled

    7. Bot Token Scopes:

      • channels:history
      • channels:read
      • chat:write
      • commands
      • files:read
      • files:write
      • groups:history
      • groups:read
      • groups.write
      • im:history
      • im:read
      • im:write
      • incoming-webhook
      • links:read
      • links:write
      • mpim:history
      • mpim:read
      • mpim:write
      • remote_files:read
      • remote_files:share
      • remote_files:write
      • team:read
      • users:read
      • users:read.email
      • users:write

    8. User Token Scopes:

      • chat:write

    9. Events enabled with the appropriate Request URL (/events endpoint) and subscribed to these corresponding bot events:

      • message.channels
      • message.groups
      • message.im
      • message.mpim

Usage

List of features that this bot provides:

  • Judging workflow for judges
  • Score editing for judges
  • Overall leaderboard view by main organizer (WIP)

Available slash commands to be used:

General Commands Description
/start Start the bot! 🤖
Organizer Commands Description
/leaderboard Display the leaderboard 🏅
/viewdb Display an overall view of the whole database (WIP)
/randomize Execute the group randomizer algorithm 🔀
Judge Commands Description
/judge Begin judging sequence 👨‍⚖️
/edit Edit previous judging decision 📝
/cancel Abandon current conversation ❌
/summary View scoring progress so far 📄

Directory listing:

  • app
    • main.py: Code command center
    • config.py: Global variables holders
    • settings.py: Credentials and necessary tokens
    • databases
      • firebaser.py: Cloud Firestore helper functions
      • dbhelper.py: SQLAlchemy helper functions
    • handlers
      • admin: Command handlers that are related to administrative matters
      • editing: Command handlers that are related to editing purposes
      • fablab: Command handlers that are related to the SUTD Fabrication Laboratory matters
      • grouping: Command handlers that are related to group matters
      • housekeeping: Command handlers that are related to housekeeping purposes
      • judging: Command handlers that are related to judging purposes
      • registration: Command handlers that are related to registration matters
      • utils: Command handlers that are related to other miscellaneous purposes
      • viewing: Command handlers that are related to database viewing purposes
  • assets: Other useful assets
  • scripts: Folder of useful scripts
  • tests: Test package

__init__.py files were added to initialize the different folders as modules.

Acknowledgements

SUTD What The Hack Automation Crew:

Useful Documentations:

TODO

  1. Fix the issue whereby the trigger_id is occasionally expired (too slow response?) and catch server connection problems ("Oops! Something went wrong.") to prevent duplicate score submissions.

  2. Add the capability for the main organizer to have an overall view dashboard over the whole backend SQL database (/viewdb slash command).

  3. Add the capability for the judge to modify a specific score (using buttons on the summary table).

  4. Make JUDGE_LIST and CATEGORY_LIST dynamic (since these changes every year). Possible to integrate this with setup scripts (and database structure). Perhaps add the capability for an admin to add these dynamically to the MySQL database through the Slack bot, as well as assigning categories to judges dynamically as well?

  5. Add a housekeeping feature to interface with and modify more database entries from the Slack workspace. This includes changing hack submission status and DevPost submission links/URLs of selected groups, changing details of participants, groups, and judges, etc.

  6. Create different wrappers (one for each payload type) to check whether user_id is in JUDGE_LIST or not.

  7. Improve documentation and unit testing coverage.

  8. Incorporate document preparation and registration features for both participating teams and judges (later development phase).

  9. Add FabLab tool booking features (both general calendar view and item list view), with reminders being sent once a set maximum amount of loan time is reached, a status indicator, and the capability for OComm staff to dynamically add/edit FabLab materials/tools (and set their maximum loan time and maximum number of tools borrowed per individual person and per group).

  10. Add feature to create private channels for individual groups, once all the groups are confirmed (#<group-name>). All the respective members of each group should be automatically added to their own group channel.

  11. Add command to do group creation.

  12. Add command to list all currently-logged group names, both complete and partial. Each group entry includes information like its group leader's contact number, allocated room space, and hack submission status.

  13. Add command to find a participant's group (along with the same corresponding aforementioned details: its group leader's contact number, allocated room space, and hack submission status).

  14. Add command to get ownself's participant UUID (generated in MySQL, not the Slack's user ID).

  15. Add command to get ownself's group UUID (generated in MySQL).

  16. Change all UUIDv1 to UUIDv4.

  17. Add Foreign Key constraints for certain columns, as well as any other relevant relationships in the SQLAlchemy database model.

  18. Add a randomizer feature to randomly create groups from people in a specific channel (#matchmaking), taking into account their technology of interest, role/field of expertise & category/problem theme preferences (either use graph partitioning with a recursive Kernighan-Lin algorithm or discrete constrained optimization). Might be difficult to implement.

  19. Add feature to assign people to rooms, where people with similar dietary preferences will be assigned to rooms in closer proximity to each other (maybe use a modified Gale-Shapley algorithm). Might be difficult to implement.

Cheers!

—⭐—

Crafted, designed and built with ❤️ by @jamestiotio in Singapore. (◕‿◕✿)