fix: updated logging for validators

mariusbegby · Aug 26, 2023 · 57fc1e3 · 57fc1e3
1 parent 2210982
commit 57fc1e3
Show file tree

Hide file tree

Showing 23 changed files with 118 additions and 70 deletions.
diff --git a/src/commands/info/help.js b/src/commands/info/help.js
@@ -9,7 +9,7 @@ module.exports = {
         .setDescription('Show a list of commands and their usage.')
         .setDMPermission(false)
         .setNSFW(false),
-    execute: async ({ interaction, client }) => {
+    execute: async ({ interaction, client, executionId }) => {
         const commandList = client.commands
             .filter((command) => {
                 // don't include system commands

diff --git a/src/commands/info/status.js b/src/commands/info/status.js
@@ -14,7 +14,7 @@ module.exports = {
         .setDescription('Show the bot and system status.')
         .setDMPermission(false)
         .setNSFW(false),
-    execute: async ({ interaction, client }) => {
+    execute: async ({ interaction, client, executionId }) => {
         const uptimeString = await getUptimeFormatted();
         const usedMemoryInMB = Math.ceil((await osu.mem.info()).usedMemMb).toLocaleString('en-US');
         const cpuUsage = await osu.cpu.usage();

diff --git a/src/commands/player/filters.js b/src/commands/player/filters.js
@@ -29,15 +29,15 @@ module.exports = {
 
         const queue = useQueue(interaction.guild.id);
 
-        if (await queueDoesNotExist(interaction, queue)) {
+        if (await queueDoesNotExist({ interaction, queue, executionId })) {
             return;
         }
 
         if (await notInSameVoiceChannel({ interaction, queue, executionId })) {
             return;
         }
 
-        if (await queueNoCurrentTrack(interaction, queue)) {
+        if (await queueNoCurrentTrack({ interaction, queue, executionId })) {
             return;
         }
 

diff --git a/src/commands/player/loop.js b/src/commands/player/loop.js
@@ -34,7 +34,7 @@ module.exports = {
 
         const queue = useQueue(interaction.guild.id);
 
-        if (await queueDoesNotExist(interaction, queue)) {
+        if (await queueDoesNotExist({ interaction, queue, executionId })) {
             return;
         }
 

diff --git a/src/commands/player/lyrics.js b/src/commands/player/lyrics.js
@@ -96,15 +96,15 @@ module.exports = {
                 return;
             }
 
-            if (await queueDoesNotExist(interaction, queue)) {
+            if (await queueDoesNotExist({ interaction, queue, executionId })) {
                 return;
             }
 
             if (await notInSameVoiceChannel({ interaction, queue, executionId })) {
                 return;
             }
 
-            if (await queueNoCurrentTrack(interaction, queue)) {
+            if (await queueNoCurrentTrack({ interaction, queue, executionId })) {
                 return;
             }
             geniusSearchQuery = queue.currentTrack.title.slice(0, 50);

diff --git a/src/commands/player/nowplaying.js b/src/commands/player/nowplaying.js
@@ -22,15 +22,15 @@ module.exports = {
 
         const queue = useQueue(interaction.guild.id);
 
-        if (await queueDoesNotExist(interaction, queue)) {
+        if (await queueDoesNotExist({ interaction, queue, executionId })) {
             return;
         }
 
         if (await notInSameVoiceChannel({ interaction, queue, executionId })) {
             return;
         }
 
-        if (await queueNoCurrentTrack(interaction, queue)) {
+        if (await queueNoCurrentTrack({ interaction, queue, executionId })) {
             return;
         }
 

diff --git a/src/commands/player/pause.js b/src/commands/player/pause.js
@@ -21,15 +21,15 @@ module.exports = {
 
         const queue = useQueue(interaction.guild.id);
 
-        if (await queueDoesNotExist(interaction, queue)) {
+        if (await queueDoesNotExist({ interaction, queue, executionId })) {
             return;
         }
 
         if (await notInSameVoiceChannel({ interaction, queue, executionId })) {
             return;
         }
 
-        if (await queueNoCurrentTrack(interaction, queue)) {
+        if (await queueNoCurrentTrack({ interaction, queue, executionId })) {
             return;
         }
 

diff --git a/src/commands/player/play.js b/src/commands/player/play.js
@@ -95,7 +95,7 @@ module.exports = {
             return;
         }
 
-        if (await cannotJoinVoiceOrTalk(interaction)) {
+        if (await cannotJoinVoiceOrTalk({ interaction, executionId })) {
             return;
         }
 
@@ -107,7 +107,7 @@ module.exports = {
         const player = useMainPlayer();
         const query = interaction.options.getString('query');
 
-        const transformedQuery = await transformQuery(query);
+        const transformedQuery = await transformQuery({ query, executionId });
 
         let searchResult;
 

diff --git a/src/commands/player/remove.js b/src/commands/player/remove.js
@@ -28,7 +28,7 @@ module.exports = {
 
         const queue = useQueue(interaction.guild.id);
 
-        if (await queueDoesNotExist(interaction, queue)) {
+        if (await queueDoesNotExist({ interaction, queue, executionId })) {
             return;
         }
 

diff --git a/src/commands/player/seek.js b/src/commands/player/seek.js
@@ -27,15 +27,15 @@ module.exports = {
 
         const queue = useQueue(interaction.guild.id);
 
-        if (await queueDoesNotExist(interaction, queue)) {
+        if (await queueDoesNotExist({ interaction, queue, executionId })) {
             return;
         }
 
         if (await notInSameVoiceChannel({ interaction, queue, executionId })) {
             return;
         }
 
-        if (await queueNoCurrentTrack(interaction, queue)) {
+        if (await queueNoCurrentTrack({ interaction, queue, executionId })) {
             return;
         }
 

diff --git a/src/commands/player/shuffle.js b/src/commands/player/shuffle.js
@@ -21,15 +21,15 @@ module.exports = {
 
         const queue = useQueue(interaction.guild.id);
 
-        if (await queueDoesNotExist(interaction, queue)) {
+        if (await queueDoesNotExist({ interaction, queue, executionId })) {
             return;
         }
 
         if (await notInSameVoiceChannel({ interaction, queue, executionId })) {
             return;
         }
 
-        if (await queueIsEmpty(interaction, queue)) {
+        if (await queueIsEmpty({ interaction, queue, executionId })) {
             return;
         }
 

diff --git a/src/commands/player/skip.js b/src/commands/player/skip.js
@@ -24,15 +24,15 @@ module.exports = {
 
         const queue = useQueue(interaction.guild.id);
 
-        if (await queueDoesNotExist(interaction, queue)) {
+        if (await queueDoesNotExist({ interaction, queue, executionId })) {
             return;
         }
 
         if (await notInSameVoiceChannel({ interaction, queue, executionId })) {
             return;
         }
 
-        if (await queueNoCurrentTrack(interaction, queue)) {
+        if (await queueNoCurrentTrack({ interaction, queue, executionId })) {
             return;
         }
 

diff --git a/src/commands/player/volume.js b/src/commands/player/volume.js
@@ -28,7 +28,7 @@ module.exports = {
 
         const queue = useQueue(interaction.guild.id);
 
-        if (await queueDoesNotExist(interaction, queue)) {
+        if (await queueDoesNotExist({ interaction, queue, executionId })) {
             return;
         }
 

diff --git a/src/commands/system/guilds.js b/src/commands/system/guilds.js
@@ -13,8 +13,8 @@ module.exports = {
         .setDescription('Show list of guilds where bot is added.')
         .setDMPermission(false)
         .setNSFW(false),
-    execute: async ({ interaction, client }) => {
-        if (await notValidGuildId(interaction)) {
+    execute: async ({ interaction, client, executionId }) => {
+        if (await notValidGuildId({ interaction, executionId })) {
             logger.debug('Not a valid guild id.');
             return;
         }

diff --git a/src/commands/system/reload.js b/src/commands/system/reload.js
@@ -13,8 +13,8 @@ module.exports = {
         .setDescription('Reload the bot commands.')
         .setDMPermission(false)
         .setNSFW(false),
-    execute: async ({ interaction, client }) => {
-        if (await notValidGuildId(interaction)) {
+    execute: async ({ interaction, client, executionId }) => {
+        if (await notValidGuildId({ interaction, executionId })) {
             logger.debug('Not a valid guild id.');
             return;
         }

diff --git a/src/commands/system/shards.js b/src/commands/system/shards.js
@@ -30,8 +30,8 @@ module.exports = {
         )
 
         .addNumberOption((option) => option.setName('page').setDescription('Page number to show').setMinValue(1)),
-    execute: async ({ interaction, client }) => {
-        if (await notValidGuildId(interaction)) {
+    execute: async ({ interaction, client, executionId }) => {
+        if (await notValidGuildId({ interaction, executionId })) {
             return;
         }
 

diff --git a/src/commands/system/systemstatus.js b/src/commands/system/systemstatus.js
@@ -16,8 +16,8 @@ module.exports = {
         .setDescription('Show the bot and system status.')
         .setDMPermission(false)
         .setNSFW(false),
-    execute: async ({ interaction, client }) => {
-        if (await notValidGuildId(interaction)) {
+    execute: async ({ interaction, client, executionId }) => {
+        if (await notValidGuildId({ interaction, executionId })) {
             return;
         }
 

diff --git a/src/events/interactions/interactionCreate.js b/src/events/interactions/interactionCreate.js
@@ -59,7 +59,7 @@ module.exports = {
             try {
                 await interaction.deferReply();
 
-                if (await cannotSendMessageInChannel(interaction)) {
+                if (await cannotSendMessageInChannel({ interaction, executionId })) {
                     return;
                 }
 
@@ -69,9 +69,7 @@ module.exports = {
                 const outputTime = new Date();
                 const executionTime = outputTime - inputTime;
 
-                logger.info(
-                    `Command '${interaction}' executed in ${executionTime} ms.`
-                );
+                logger.info(`Command '${interaction}' executed in ${executionTime} ms.`);
             } catch (error) {
                 logger.warn(
                     error,
@@ -86,19 +84,15 @@ module.exports = {
                     return;
                 } else {
                     if (!interaction.deferred || !interaction.replied) {
-                        logger.warn(
-                            'Interaction was not deferred or replied to, and an error was thrown.'
-                        );
+                        logger.warn('Interaction was not deferred or replied to, and an error was thrown.');
                         return;
                     }
 
                     if (interaction.replied) {
                         // If the interaction has already been replied to, most likely command executed successfully or error is already handled.
                         return;
                     } else if (interaction.deferred) {
-                        logger.info(
-                            'Interaction was deferred, editing reply and sending Uh-oh message.'
-                        );
+                        logger.info('Interaction was deferred, editing reply and sending Uh-oh message.');
                         await interaction.editReply({
                             embeds: [
                                 new EmbedBuilder()
@@ -109,9 +103,7 @@ module.exports = {
                             ]
                         });
                     } else {
-                        logger.info(
-                            'Interaction was not deferred or replied, sending new reply with Uh-oh message.'
-                        );
+                        logger.info('Interaction was not deferred or replied, sending new reply with Uh-oh message.');
                         await interaction.reply({
                             embeds: [
                                 new EmbedBuilder()
@@ -125,10 +117,7 @@ module.exports = {
                 }
             }
         } else {
-            logger.warn(
-                interaction,
-                'Interaction created but was not a chat input or autocomplete interaction.'
-            );
+            logger.warn(interaction, 'Interaction created but was not a chat input or autocomplete interaction.');
         }
     }
 };
diff --git a/src/utils/validation/permissionValidator.js b/src/utils/validation/permissionValidator.js
@@ -1,9 +1,17 @@
-const logger = require('../../services/logger');
 const config = require('config');
 const embedOptions = config.get('embedOptions');
 const { EmbedBuilder } = require('discord.js');
 
-exports.cannotJoinVoiceOrTalk = async (interaction) => {
+exports.cannotJoinVoiceOrTalk = async ({ interaction, executionId }) => {
+    const logger = require('../../services/logger').child({
+        source: 'permissionValidator.js',
+        module: 'validator',
+        name: 'cannotJoinVoiceOrTalk',
+        executionId: executionId,
+        shardId: interaction.guild.shardId,
+        guildId: interaction.guild.id
+    });
+
     const channel = interaction.member.voice.channel;
 
     if (!channel.joinable || !channel.speakable) {
@@ -18,21 +26,30 @@ exports.cannotJoinVoiceOrTalk = async (interaction) => {
         });
 
         logger.debug(
-            `User tried to use command ${interaction.commandName} but the bot had no permission to join/speak in the voice channel.`
+            `User tried to use command '${interaction.commandName}' but the bot had no permission to join/speak in the voice channel.`
         );
         return true;
     }
 
     return false;
 };
 
-exports.cannotSendMessageInChannel = async (interaction) => {
+exports.cannotSendMessageInChannel = async ({ interaction, executionId }) => {
+    const logger = require('../../services/logger').child({
+        source: 'permissionValidator.js',
+        module: 'validator',
+        name: 'cannotSendMessageInChannel',
+        executionId: executionId,
+        shardId: interaction.guild.shardId,
+        guildId: interaction.guild.id
+    });
+
     const channel = interaction.channel;
 
     // only checks if channel is viewable, as bot will have permission to send interaction replies if channel is viewable
     if (!channel.viewable) {
         logger.info(
-            `User tried to use command ${interaction.commandName} but the bot had no permission to send reply in text channel.`
+            `User tried to use command '${interaction.commandName}' but the bot had no permission to send reply in text channel.`
         );
 
         try {
@@ -51,8 +68,10 @@ exports.cannotSendMessageInChannel = async (interaction) => {
                 ephemeral: true
             });
         } catch (error) {
-            if(error.message == 'The reply to this interaction has already been sent or deferred.') {
-                logger.warn('Error while sending ephemereal message about insufficient permissions to send message in channel.');
+            if (error.message == 'The reply to this interaction has already been sent or deferred.') {
+                logger.warn(
+                    'Error while sending ephemereal message about insufficient permissions to send message in channel.'
+                );
                 logger.debug(error);
             } else {
                 logger.error(