[DISC-120] Implementation of Various Features

.github/workflows/docker.yml

@@ -9,10 +9,10 @@ jobs:
         runs-on: ubuntu-latest
         steps:
             - name: Checkout repository
-              uses: actions/checkout@v3
-            - uses: actions/setup-node@v3
+              uses: actions/checkout@v4
+            - uses: actions/setup-node@v4
               with:
-                  node-version: 16
+                  node-version: 20
             - run: npm ci
             - run: npm run format:check
             - run: npm run lint
@@ -25,7 +25,7 @@ jobs:
             packages: write
         steps:
             - name: Checkout repository
-              uses: actions/checkout@v3
+              uses: actions/checkout@v4
             - name: Set up QEMU
               uses: docker/setup-qemu-action@v2
               with:
@@ -59,12 +59,12 @@ jobs:
             name: production (projects-bot)
         steps:
             - name: Checkout repository
-              uses: actions/checkout@v3
+              uses: actions/checkout@v4
               with:
                   repository: csesoc/deployment
                   token: ${{ secrets.GH_TOKEN }}
             - name: Install yq - portable yaml processor
-              uses: mikefarah/yq@v4.27.5
+              uses: mikefarah/yq@v4.44.2
             - name: Determine file to update
               id: get_manifest
               env:

Dockerfile

@@ -1,5 +1,5 @@
 # Build layer template for an eventual TS migration
-FROM node:16.17.0-slim as builder
+FROM node:20.15.0-slim AS builder
 ENV NODE_ENV=production
 
 # Set working directory
@@ -9,9 +9,11 @@ WORKDIR /app
 COPY package.json package-lock.json ./
 RUN npm ci --omit=dev
 
-FROM node:16.17.0-slim
+FROM ghcr.io/puppeteer/puppeteer:22.12.1
 ENV NODE_ENV=production
 
+USER root
+
 # Set working directory
 WORKDIR /app
 
@@ -23,5 +25,7 @@ COPY . .
 
 RUN chmod +x entrypoint.sh
 
+USER pptruser
+
 # Run bot
 ENTRYPOINT [ "./entrypoint.sh" ]

README.md

@@ -8,5 +8,11 @@
     -   `DISCORD_TOKEN` with the token of the bot
     -   `APP_ID` with the ID of the bot application
 -   Install dependencies with `npm install`
--   Register slash commands with `node deploy-commands.js`
+-   Register slash commands with `npm run deploy` or `node deploy-commands.js`
+-   Ensure a PostgreSQL database is setup according to "config/database.yml"
 -   Start the bot with `node index.js`
+
+## Running the bot with Nodemon
+
+-   Nodemon has been installed, this addition allows for continuous integration with and hot reloads the bot upon saving.
+-   Run the bot with Nodemon using `npm run server`

commands/admin-standup.js

@@ -1,5 +1,5 @@
 const { SlashCommandBuilder } = require("@discordjs/builders");
-const { MessageEmbed, MessageButton, Permissions } = require("discord.js");
+const { EmbedBuilder, ButtonBuilder, Permissions } = require("discord.js");
 const paginationEmbed = require("discordjs-button-pagination");
 
 module.exports = {
@@ -104,7 +104,7 @@ module.exports = {
                 if (notDone.length == 0) {
                     standupEmbeded.forEach((el) => {
                         embedList.push(
-                            new MessageEmbed()
+                            new EmbedBuilder()
                                 .setTitle("Standups (" + role.name + ")")
                                 .setDescription(
                                     el + "\n\n" + "_Everyone has done their standup_\n",
@@ -114,7 +114,7 @@ module.exports = {
                 } else {
                     standupEmbeded.forEach((el) => {
                         embedList.push(
-                            new MessageEmbed()
+                            new EmbedBuilder()
                                 .setTitle("Standups (" + role.name + ")")
                                 .setDescription(
                                     el +
@@ -127,7 +127,7 @@ module.exports = {
                 }
 
                 if (thisTeamStandups.length == 0) {
-                    const embed = new MessageEmbed()
+                    const embed = new EmbedBuilder()
                         .setTitle("Standups (" + role.name + ")")
                         .setDescription(
                             "No standups recorded\n\n" +
@@ -138,11 +138,11 @@ module.exports = {
                 }
 
                 const buttonList = [
-                    new MessageButton()
+                    new ButtonBuilder()
                         .setCustomId("previousbtn")
                         .setLabel("Previous")
                         .setStyle("DANGER"),
-                    new MessageButton().setCustomId("nextbtn").setLabel("Next").setStyle("SUCCESS"),
+                    new ButtonBuilder().setCustomId("nextbtn").setLabel("Next").setStyle("SUCCESS"),
                 ];
 
                 paginationEmbed(interaction, embedList, buttonList);

commands/anonymouspost.js

@@ -2,7 +2,7 @@ const { SlashCommandBuilder } = require("@discordjs/builders");
 const { allowedChannels } = require("../config/anon_channel.json");
 const paginationEmbed = require("discordjs-button-pagination");
 const fs = require("fs");
-const { Util, MessageEmbed, MessageButton, Permissions } = require("discord.js");
+const { Util, EmbedBuilder, ButtonBuilder, Permissions } = require("discord.js");
 module.exports = {
     data: new SlashCommandBuilder()
         .setName("anonymouspost")
@@ -223,7 +223,7 @@ module.exports = {
         } else if (interaction.options.getSubcommand() === "whitelist") {
             // No allowed roles
             if (allowedChannels.length == 0) {
-                const embed = new MessageEmbed()
+                const embed = new EmbedBuilder()
                     .setTitle("Allowed Channels")
                     .setDescription("No allowed channels");
                 return await interaction.reply({ embeds: [embed] });
@@ -239,7 +239,7 @@ module.exports = {
             }
 
             if (channels.length == 0) {
-                const embed = new MessageEmbed()
+                const embed = new EmbedBuilder()
                     .setTitle("Allowed Channels")
                     .setDescription("No allowed channels");
                 return await interaction.reply({ embeds: [embed] });
@@ -250,18 +250,18 @@ module.exports = {
             const embedList = [];
             for (let i = 0; i < channels.length; i += channelsPerPage) {
                 embedList.push(
-                    new MessageEmbed()
+                    new EmbedBuilder()
                         .setTitle("Allowed Channels")
                         .setDescription(channels.slice(i, i + channelsPerPage).join("\n")),
                 );
             }
 
             const buttonList = [
-                new MessageButton()
+                new ButtonBuilder()
                     .setCustomId("previousbtn")
                     .setLabel("Previous")
                     .setStyle("DANGER"),
-                new MessageButton().setCustomId("nextbtn").setLabel("Next").setStyle("SUCCESS"),
+                new ButtonBuilder().setCustomId("nextbtn").setLabel("Next").setStyle("SUCCESS"),
             ];
 
             paginationEmbed(interaction, embedList, buttonList);

commands/coinFlip.js

@@ -1,5 +1,5 @@
 const { SlashCommandBuilder } = require("@discordjs/builders");
-const { MessageEmbed } = require("discord.js");
+const { EmbedBuilder } = require("discord.js");
 
 module.exports = {
     data: new SlashCommandBuilder().setName("coinflip").setDescription("Tosses a coin 💰"),
@@ -13,7 +13,7 @@ module.exports = {
         : 'http://assets.stickpng.com/thumbs/5a521f522f93c7a8d5137fc7.png';
     */
         const img = coinNum === 0 ? "attachment://heads.png" : "attachment://tails.png";
-        const embed = new MessageEmbed().setTitle(`it's ${coin}!`).setImage(img);
+        const embed = new EmbedBuilder().setTitle(`it's ${coin}!`).setImage(img);
         if (coinNum == 0) {
             return await interaction.reply({
                 embeds: [embed],

commands/course.js

@@ -1,4 +1,5 @@
 const { SlashCommandBuilder } = require("@discordjs/builders");
+const { ChannelType } = require("discord.js");
 
 const COMMAND_JOIN = "join";
 const COMMAND_LEAVE = "leave";
@@ -35,20 +36,26 @@ const get_real_course_name = (course) => {
 };
 
 const is_valid_course = (course) => {
-    const reg_comp_course = /^comp\d{4}$/;
-    const reg_math_course = /^math\d{4}$/;
-    const reg_binf_course = /^binf\d{4}$/;
-    const reg_engg_course = /^engg\d{4}$/;
-    const reg_seng_course = /^seng\d{4}$/;
-    const reg_desn_course = /^desn\d{4}$/;
+    const reg_valid_course = /^[a-zA-Z]{4}\d{4}$/;
+
+    return reg_valid_course.test(course);
+};
+
+const is_supported_course = (course) => {
+    const reg_comp_course = /^comp\d{4}$/i;
+    const reg_math_course = /^math\d{4}$/i;
+    const reg_binf_course = /^binf\d{4}$/i;
+    const reg_engg_course = /^engg\d{4}$/i;
+    const reg_seng_course = /^seng\d{4}$/i;
+    const reg_desn_course = /^desn\d{4}$/i;
 
     return (
-        reg_comp_course.test(course.toLowerCase()) ||
-        reg_math_course.test(course.toLowerCase()) ||
-        reg_binf_course.test(course.toLowerCase()) ||
-        reg_engg_course.test(course.toLowerCase()) ||
-        reg_seng_course.test(course.toLowerCase()) ||
-        reg_desn_course.test(course.toLowerCase())
+        reg_comp_course.test(course) ||
+        reg_math_course.test(course) ||
+        reg_binf_course.test(course) ||
+        reg_engg_course.test(course) ||
+        reg_seng_course.test(course) ||
+        reg_desn_course.test(course)
     );
 };
 
@@ -87,20 +94,20 @@ module.exports = {
                 const input_course = await interaction.options.getString("course").toLowerCase();
                 const course = get_real_course_name(input_course);
 
-                const other_courses = /^[a-zA-Z]{4}\d{4}$/;
                 const is_valid = is_valid_course(course);
+                const is_supported = is_supported_course(course);
 
                 const course_with_alias =
                     course != input_course
                         ? `${course} (same course chat as ${input_course})`
                         : `${course}`;
 
-                if (!is_valid && other_courses.test(course.toLowerCase())) {
+                if (!is_supported && is_valid) {
                     return await interaction.reply({
                         content: `❌ | Course chats for other faculties are not supported.`,
                         ephemeral: true,
                     });
-                } else if (!is_valid) {
+                } else if (!is_supported) {
                     return await interaction.reply({
                         content: `❌ | You are not allowed to join this channel using this command.`,
                         ephemeral: true,
@@ -120,9 +127,14 @@ module.exports = {
                             ephemeral: true,
                         });
                     }
+                    // // Add it to the existing database to track.
+                    /** @type {DBuser} */
+                    const userDB = global.userDB;
+                    await userDB.add_user_role(interaction.user.id, role.name);
 
                     // If they don't, let's add the role to them
                     await interaction.member.roles.add(role);
+
                     return await interaction.reply({
                         content: `✅ | Added you to the chat for \`${course_with_alias}\`.`,
                         ephemeral: true,
@@ -138,7 +150,7 @@ module.exports = {
                 const input_course = await interaction.options.getString("course");
                 const course = get_real_course_name(input_course);
 
-                if (!is_valid_course(course)) {
+                if (!is_supported_course(course)) {
                     return await interaction.reply({
                         content: `❌ | Not a valid course.`,
                         ephemeral: true,
@@ -155,7 +167,7 @@ module.exports = {
                         content: `❌ | The course chat for \`${course}\` does not exist.`,
                         ephemeral: true,
                     });
-                } else if (channel.type !== "GUILD_TEXT") {
+                } else if (channel.type !== ChannelType.GuildText) {
                     return await interaction.reply({
                         content: `❌ | The course chat for \`${course}\` is not a text channel.`,
                         ephemeral: true,
@@ -183,6 +195,10 @@ module.exports = {
                         in_overwrites(permissions, role.id)
                     ) {
                         // If they do remove the role
+                        /** @type {DBuser} */
+                        const userDB = global.userDB;
+                        userDB.remove_user_role(interaction.user.id, role.name);
+
                         await interaction.member.roles.remove(role);
                         return await interaction.reply({
                             content: `✅ | Removed you from the role and chat for \`${course}\`.`,