Add logger to project (#183)

# Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

- Add the winston package to handle logging
- Add logging to the project's logic

#146

## Type of change

Please delete options that are not relevant.

- [x] New feature (non-breaking change which adds functionality)

# How Has This Been Tested?

Please describe the tests that you ran to verify the changes. Provide instructions so we can reproduce. Please also list any relevant details to your test configuration.

# Checklist

- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that provde my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged and published in downstream modules

Reviewed-on: https://gitea.vylpes.xyz/External/card-drop/pulls/183
Reviewed-by: VylpesTester <tester@vylpes.com>
Co-authored-by: Ethan Lane <ethan@vylpes.com>
Co-committed-by: Ethan Lane <ethan@vylpes.com>

src/commands/drop.ts

@@ -7,6 +7,7 @@ import Inventory from "../database/entities/app/Inventory";
 import Config from "../database/entities/app/Config";
 import CardDropHelperMetadata from "../helpers/CardDropHelperMetadata";
 import path from "path";
+import AppLogger from "../client/appLogger";
 
 export default class Drop extends Command {
     constructor() {
@@ -24,6 +25,8 @@ export default class Drop extends Command {
         }
 
         if (await Config.GetValue("safemode") == "true") {
+            AppLogger.LogWarn("Commands/Drop", "Safe Mode is active, refusing to send next drop.");
+
             await interaction.reply("Safe Mode has been activated, please resync to continue.");
             return;
         }
@@ -31,6 +34,8 @@ export default class Drop extends Command {
         const randomCard = CardDropHelperMetadata.GetRandomCard();
 
         if (!randomCard) {
+            AppLogger.LogWarn("Commands/Drop", "Unable to fetch card, please try again. (randomCard is null)");
+
             await interaction.reply("Unable to fetch card, please try again.");
             return;
         }
@@ -61,7 +66,7 @@ export default class Drop extends Command {
             CoreClient.ClaimId = claimId;
 
         } catch (e) {
-            console.error(e);
+            AppLogger.LogError("Commands/Drop", `Error sending next drop for card ${randomCard.card.id}: ${e}`);
 
             await interaction.editReply(`Unable to send next drop. Please try again, and report this if it keeps happening. (${randomCard.card.id})`);
         }

src/commands/gdrivesync.ts

@@ -4,6 +4,7 @@ import { ExecException, exec } from "child_process";
 import { CoreClient } from "../client/client";
 import Config from "../database/entities/app/Config";
 import CardMetadataFunction from "../Functions/CardMetadataFunction";
+import AppLogger from "../client/appLogger";
 
 export default class Gdrivesync extends Command {
     constructor() {
@@ -32,19 +33,28 @@ export default class Gdrivesync extends Command {
 
         CoreClient.AllowDrops = false;
 
+        AppLogger.LogInfo("Commands/GDriveSync", "Syncing google drive to the bot");
+
         exec(`rclone sync card-drop-gdrive: ${process.env.DATA_DIR}/cards`, async (error: ExecException | null) => {
             if (error) {
+                AppLogger.LogError("Commands/GDriveSync", `Error while running sync command: ${error.code}, ${error.message}`);
+                AppLogger.LogWarn("Commands/GDriveSync", "Safe mode activated");
+
                 await interaction.editReply(`Error while running sync command. Safe Mode has been activated. Code: ${error.code}`);
                 await Config.SetValue("safemode", "true");
             } else {
                 const result = await CardMetadataFunction.Execute(true);
 
                 if (result.IsSuccess) {
+                    AppLogger.LogInfo("Commands/GDriveSync", "Synced successfully");
+
                     await interaction.editReply("Synced successfully.");
 
                     CoreClient.AllowDrops = true;
                     await Config.SetValue("safemode", "false");
                 } else {
+                    AppLogger.LogError("Commands/GDriveSync", `Error while running sync command: ${result.ErrorMessage}`);
+
                     await interaction.editReply(`Sync failed \`\`\`${result.ErrorMessage}\`\`\``);
                 }
             }

src/commands/give.ts

@@ -4,6 +4,7 @@ import { CoreClient } from "../client/client";
 import Config from "../database/entities/app/Config";
 import CardDropHelperMetadata from "../helpers/CardDropHelperMetadata";
 import Inventory from "../database/entities/app/Inventory";
+import AppLogger from "../client/appLogger";
 
 export default class Give extends Command {
     constructor() {
@@ -46,6 +47,8 @@ export default class Give extends Command {
         const cardNumber = interaction.options.get("cardnumber", true);
         const user = interaction.options.getUser("user", true);
 
+        AppLogger.LogSilly("Commands/Give", `Parameters: cardNumber=${cardNumber.value}, user=${user.id}`);
+
         const card = CardDropHelperMetadata.GetCardByCardNumber(cardNumber.value!.toString());
 
         if (!card) {

src/commands/inventory.ts

@@ -1,6 +1,7 @@
 import { CommandInteraction, SlashCommandBuilder } from "discord.js";
 import { Command } from "../type/command";
 import InventoryHelper from "../helpers/InventoryHelper";
+import AppLogger from "../client/appLogger";
 
 export default class Inventory extends Command {
     constructor() {
@@ -23,6 +24,8 @@ export default class Inventory extends Command {
         const page = interaction.options.get("page");
         const user = interaction.options.getUser("user") || interaction.user;
 
+        AppLogger.LogSilly("Commands/Inventory", `Parameters: page=${page?.value}, user=${user.id}`);
+
         try {
             let pageNumber = 0;
 
@@ -36,7 +39,9 @@ export default class Inventory extends Command {
                 embeds: [ embed.embed ],
                 components: [ embed.row ],
             });
-        } catch {
+        } catch (e) {
+            AppLogger.LogError("Commands/Inventory", e as string);
+
             await interaction.reply("No page for user found.");
         }
     }

src/commands/resync.ts

@@ -2,6 +2,7 @@ import { CacheType, CommandInteraction, PermissionsBitField, SlashCommandBuilder
 import { Command } from "../type/command";
 import Config from "../database/entities/app/Config";
 import CardMetadataFunction from "../Functions/CardMetadataFunction";
+import AppLogger from "../client/appLogger";
 
 export default class Resync extends Command {
     constructor() {
@@ -23,10 +24,14 @@ export default class Resync extends Command {
             return;
         }
 
+        AppLogger.LogInfo("Commands/Resync", "Resyncing database");
+
         const result = await CardMetadataFunction.Execute(true);
 
         if (result) {
             if (await Config.GetValue("safemode") == "true") {
+                AppLogger.LogInfo("Commands/Resync", "Resync successful, safe mode disabled");
+
                 await Config.SetValue("safemode", "false");
                 await interaction.reply("Resynced database and disabled safe mode.");
 
@@ -34,6 +39,8 @@ export default class Resync extends Command {
             }
             await interaction.reply("Resynced database.");
         } else {
+            AppLogger.LogWarn("Commands/Resync", "Resync failed, safe mode activated");
+
             await interaction.reply("Resync failed, safe mode has been activated until successful resync.");
         }
     }

src/commands/trade.ts

@@ -3,6 +3,7 @@ import { Command } from "../type/command";
 import Inventory from "../database/entities/app/Inventory";
 import { CoreClient } from "../client/client";
 import EmbedColours from "../constants/EmbedColours";
+import AppLogger from "../client/appLogger";
 
 export default class Trade extends Command {
     constructor() {
@@ -33,6 +34,8 @@ export default class Trade extends Command {
         const give = interaction.options.get("give")!;
         const receive = interaction.options.get("receive")!;
 
+        AppLogger.LogSilly("Commands/Trade", `Parameters: user=${user.id}, give=${give.value}, receive=${receive.value}`);
+
         const giveItemEntity = await Inventory.FetchOneByCardNumberAndUserId(interaction.user.id, give.value!.toString());
         const receiveItemEntity = await Inventory.FetchOneByCardNumberAndUserId(user.id, receive.value!.toString());
 
@@ -102,6 +105,8 @@ export default class Trade extends Command {
     }
 
     private async autoDecline(interaction: CommandInteraction, giveUsername: string, receiveUsername: string, giveCardNumber: string, receiveCardNumber: string, giveCardName: string, receiveCardName: string) {
+        AppLogger.LogSilly("Commands/Trade/AutoDecline", `Auto declining trade between ${giveUsername} and ${receiveUsername}`);
+
         const tradeEmbed = new EmbedBuilder()
             .setTitle("Trade Expired")
             .setDescription(`Trade initiated between ${receiveUsername} and ${giveUsername}`)

src/commands/view.ts

@@ -5,6 +5,7 @@ import { readFileSync } from "fs";
 import path from "path";
 import Inventory from "../database/entities/app/Inventory";
 import CardDropHelperMetadata from "../helpers/CardDropHelperMetadata";
+import AppLogger from "../client/appLogger";
 
 export default class View extends Command {
     constructor() {
@@ -23,6 +24,8 @@ export default class View extends Command {
     public override async execute(interaction: CommandInteraction) {
         const cardNumber = interaction.options.get("cardnumber");
 
+        AppLogger.LogSilly("Commands/View", `Parameters: cardNumber=${cardNumber?.value}`);
+
         if (!cardNumber || !cardNumber.value) {
             await interaction.reply("Card number is required.");
             return;
@@ -46,6 +49,8 @@ export default class View extends Command {
         try {
             image = readFileSync(path.join(process.env.DATA_DIR!, "cards", card.path));
         } catch {
+            AppLogger.LogError("Commands/View", `Unable to fetch image for card ${card.id}.`);
+
             await interaction.reply(`Unable to fetch image for card ${card.id}.`);
             return;
         }
@@ -65,7 +70,7 @@ export default class View extends Command {
                 files: [ attachment ],
             });
         } catch (e) {
-            console.error(e);
+            AppLogger.LogError("Commands/View", `Error sending view for card ${card.id}: ${e}`);
 
             if (e instanceof DiscordAPIError) {
                 await interaction.editReply(`Unable to send next drop. Please try again, and report this if it keeps happening. Code: ${e.code}.`);