Merge branch 'feature/vcnotifyRefactor' into develop

Author: EleosOS

src/Modules/Bot.ts

@@ -90,85 +90,8 @@ InteractionBot.client.on("guildUpdate", (guildUpdate) => {
     }
 });
 
-// VCNotify
 InteractionBot.client.on("voiceStateUpdate", async (vsu) => {
-    if (!vsu.joinedChannel || VCNotifyManager.watchers.length === 0) return;
-
-    // Get the channel to post the notification in, if it's unavailable don't continue
-    let notifyChannel = getGuild().channels.get(Config.vcNotifyPingChannelId);
-    if (!notifyChannel) {
-        Signale.warn({
-            prefix: "vcnotify",
-            message: "The specified channel for VC notifications couldn't be accessed! No notifications were processed.",
-        });
-
-        return;
-    }
-
-    // Set up an embed for logging
-    const embed = new Embed({
-        title: "VC Notification Triggered",
-        fields: [
-            {
-                name: "Triggered by",
-                value: `<@${vsu.voiceState.userId}>`,
-                inline: true,
-            },
-        ],
-    });
-
-    // Loop through all waiting notifications, remove any that match and generate the first part of the message
-    let notifyString = "";
-    let logUserListString = "";
-    let j = 0;
-
-    for (var i = VCNotifyManager.watchers.length; i--; ) {
-        const [watchedId, notifiedId] = VCNotifyManager.watchers[i];
-
-        if (vsu.voiceState.userId === watchedId) {
-            j++;
-            notifyString += `<@${notifiedId}> `;
-            logUserListString += `<@${notifiedId}>\n`;
-            VCNotifyManager.watchers.splice(i, 1);
-        }
-    }
-
-    // Nobody wanted to be notified for that user
-    if (j === 0) return;
-
-    // If more than two people were waiting, format notifyString differently
-    if (j <= 2) {
-        notifyString += "- ";
-    } else {
-        notifyString += "\n\n";
-    }
-
-    notifyString += `<@${vsu.voiceState.userId}> has joined <#${vsu.voiceState.channelId}>. (You will not be notified again.)`;
-
-    notifyChannel.createMessage({
-        content: notifyString,
-        components: [
-            {
-                type: MessageComponentTypes.ACTION_ROW,
-                components: [new VCNotifyToggleButtonComponent(vsu.voiceState.userId, true)],
-            },
-        ],
-    });
-
-    // Logging
-    Signale.info({
-        prefix: "vcnotify",
-        message: `VC Notification triggered by ${vsu.voiceState.member!.name}#${vsu.voiceState.member!.discriminator}`,
-    });
-
-    const client = (InteractionBot.client as ClusterClient).shards.first()!;
-
-    embed.addField("Notified Users", logUserListString, true);
-
-    Webhooks.execute(Webhooks.ids.vcNotifyLog, {
-        avatarUrl: client.user!.avatarUrl,
-        embed,
-    });
+    VCNotifyManager.handleVoiceStateUpdate(vsu);
 });
 
 // Helper Functions

src/Modules/VCNotifyManager.ts

@@ -1,5 +1,9 @@
+import { ClusterClient, GatewayClientEvents } from "detritus-client";
+import { MessageComponentTypes } from "detritus-client/lib/constants";
 import { User } from "detritus-client/lib/structures";
-import { Signale, Webhooks } from ".";
+import { Embed } from "detritus-client/lib/utils";
+import { Config, getGuild, InteractionBot, Signale, Webhooks } from ".";
+import { VCNotifyToggleButtonComponent } from "./Components";
 
 /**
  * @key userId of the user to watch out for
@@ -33,10 +37,12 @@ class VCNotifyManagerClass {
         // If a user is already watching for this person, disable the notification
         if (typeof vswIndex !== "undefined") {
             this.watchers.splice(vswIndex, 1);
+            this.logToggle(watchedId, notifiedId, false);
 
             return false;
         } else {
             this.watchers.push([watchedId, notifiedId]);
+            this.logToggle(watchedId, notifiedId, true);
 
             return true;
         }
@@ -59,14 +65,51 @@ class VCNotifyManagerClass {
         }
     }
 
-    logToggle(watched: User, notified: User, active: boolean) {
+    logToggle(watchedId: string, notifiedId: string, active: boolean) {
+        const client = (InteractionBot.client as ClusterClient).shards.first()!;
+        const watched = client.users.get(watchedId);
+        const notified = client.users.get(notifiedId);
+
+        if (!watched || !notified) {
+            Signale.info({
+                prefix: "vcNotify",
+                message: `${notifiedId} - VC Notification toggled to "${active}" for ${watchedId}`,
+            });
+
+            Webhooks.execute(Webhooks.ids.vcNotifyLog, {
+                avatarUrl: client.user!.avatarUrl,
+                embed: {
+                    title: `VC Notification Toggled`,
+                    fields: [
+                        {
+                            name: "Active",
+                            value: String(active),
+                            inline: true,
+                        },
+                        {
+                            name: "User",
+                            value: `<@${notifiedId}>`,
+                            inline: true,
+                        },
+                        {
+                            name: "Watching for",
+                            value: `<@${watchedId}>`,
+                            inline: true,
+                        },
+                    ],
+                },
+            });
+
+            return;
+        }
+
         Signale.info({
             prefix: "vcNotify",
             message: `${notified.name}#${notified.discriminator} - VC Notification toggled to "${active}" for ${watched.name}#${watched.discriminator}`,
         });
 
         Webhooks.execute(Webhooks.ids.vcNotifyLog, {
-            avatarUrl: watched.client.user?.avatarUrl,
+            avatarUrl: client.user!.avatarUrl,
             embed: {
                 title: `VC Notification Toggled`,
                 author: {
@@ -88,6 +131,92 @@ class VCNotifyManagerClass {
             },
         });
     }
+
+    /**
+     * Resolves everything related to VC notifications with the given VoiceStateUpdate event
+     *
+     * @param {GatewayClientEvents.VoiceStateUpdate} vsu
+     * @returns void
+     */
+    handleVoiceStateUpdate(vsu: GatewayClientEvents.VoiceStateUpdate) {
+        if (!vsu.joinedChannel || VCNotifyManager.watchers.length === 0) return;
+
+        // Get the channel to post the notification in, if it's unavailable don't continue
+        let notifyChannel = getGuild().channels.get(Config.vcNotifyPingChannelId);
+        if (!notifyChannel) {
+            Signale.warn({
+                prefix: "vcnotify",
+                message: "The specified channel for VC notifications couldn't be accessed! No notifications were processed.",
+            });
+
+            return;
+        }
+
+        // Set up an embed for logging
+        const embed = new Embed({
+            title: "VC Notification Triggered",
+            fields: [
+                {
+                    name: "Triggered by",
+                    value: `<@${vsu.voiceState.userId}>`,
+                    inline: true,
+                },
+            ],
+        });
+
+        // Loop through all waiting notifications, remove any that match and generate the first part of the message
+        let notifyString = "";
+        let logUserListString = "";
+        let j = 0;
+
+        for (var i = VCNotifyManager.watchers.length; i--; ) {
+            const [watchedId, notifiedId] = VCNotifyManager.watchers[i];
+
+            if (vsu.voiceState.userId === watchedId) {
+                j++;
+                notifyString += `<@${notifiedId}> `;
+                logUserListString += `<@${notifiedId}>\n`;
+                VCNotifyManager.watchers.splice(i, 1);
+            }
+        }
+
+        // Nobody wanted to be notified for that user
+        if (j === 0) return;
+
+        // If more than two people were waiting, format notifyString differently
+        if (j <= 2) {
+            notifyString += "- ";
+        } else {
+            notifyString += "\n\n";
+        }
+
+        notifyString += `<@${vsu.voiceState.userId}> has joined <#${vsu.voiceState.channelId}>. (You will not be notified again.)`;
+
+        notifyChannel.createMessage({
+            content: notifyString,
+            components: [
+                {
+                    type: MessageComponentTypes.ACTION_ROW,
+                    components: [new VCNotifyToggleButtonComponent(vsu.voiceState.userId, true)],
+                },
+            ],
+        });
+
+        // Logging
+        Signale.info({
+            prefix: "vcnotify",
+            message: `VC Notification triggered by ${vsu.voiceState.member!.name}#${vsu.voiceState.member!.discriminator}`,
+        });
+
+        const client = (InteractionBot.client as ClusterClient).shards.first()!;
+
+        embed.addField("Notified Users", logUserListString, true);
+
+        Webhooks.execute(Webhooks.ids.vcNotifyLog, {
+            avatarUrl: client.user!.avatarUrl,
+            embed,
+        });
+    }
 }
 
 export const VCNotifyManager = new VCNotifyManagerClass();