Add Drop Rarity test command (#73)

# 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 `/droprarity` test command to help test random rarities
- Remove no-longer-needed `DROP_RARITY` environment variable

#16

## 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

- [x] My code follows the style guidelines of this project
- [x] 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
- [x] 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/73
Reviewed-by: VylpesTester <tester@vylpes.com>
Co-authored-by: Ethan Lane <ethan@vylpes.com>
Co-committed-by: Ethan Lane <ethan@vylpes.com>

.dev.env

@@ -16,8 +16,6 @@ BOT_ENV=4
 ABOUT_FUNDING=
 ABOUT_REPO=
 
-DROP_RARITY=-1
-
 DB_HOST=127.0.0.1
 DB_PORT=3301
 DB_NAME=carddrop

.prod.env

@@ -16,8 +16,6 @@ BOT_ENV=1
 ABOUT_FUNDING=
 ABOUT_REPO=
 
-DROP_RARITY=-1
-
 DB_HOST=127.0.0.1
 DB_PORT=3321
 DB_NAME=carddrop

.stage.env

@@ -16,8 +16,6 @@ BOT_ENV=2
 ABOUT_FUNDING=
 ABOUT_REPO=
 
-DROP_RARITY=-1
-
 DB_HOST=127.0.0.1
 DB_PORT=3311
 DB_NAME=carddrop

src/commands/drop.ts

@@ -17,11 +17,7 @@ export default class Drop extends Command {
     }
 
     public override async execute(interaction: CommandInteraction) {
-        let randomCard = await CardDropHelper.GetRandomCard();
-
-        if (process.env.DROP_RARITY && Number(process.env.DROP_RARITY) > 0) {
-            randomCard = await CardDropHelper.GetRandomCardByRarity(Number(process.env.DROP_RARITY));
-        }
+        const randomCard = await CardDropHelper.GetRandomCard();
 
         const image = readFileSync(randomCard.Path);
 

src/commands/stage/droprarity.ts

@@ -0,0 +1,81 @@
+import { AttachmentBuilder, CacheType, CommandInteraction, DiscordAPIError, SlashCommandBuilder } from "discord.js";
+import { Command } from "../../type/command";
+import { CardRarity, CardRarityParse } from "../../constants/CardRarity";
+import CardDropHelper from "../../helpers/CardDropHelper";
+import { readFileSync } from "fs";
+import Inventory from "../../database/entities/app/Inventory";
+import { v4 } from "uuid";
+import { CoreClient } from "../../client/client";
+
+export default class Droprarity extends Command {
+    constructor() {
+        super();
+
+        super.CommandBuilder = new SlashCommandBuilder()
+            .setName('droprarity')
+            .setDescription('(TEST) Summon a random card of a specific rarity')
+            .addStringOption(x =>
+                x
+                    .setName('rarity')
+                    .setDescription('The rarity you want to summon')
+                    .setRequired(true));
+    }
+
+    public override async execute(interaction: CommandInteraction<CacheType>) {
+        if (!interaction.isChatInputCommand()) return;
+
+        const rarity = interaction.options.get('rarity');
+
+        if (!rarity || !rarity.value) {
+            await interaction.reply('Rarity is required');
+            return;
+        }
+
+        const rarityType = CardRarityParse(rarity.value.toString());
+
+        if (rarityType == CardRarity.Unknown) {
+            await interaction.reply('Invalid rarity');
+            return;
+        }
+
+        const card = await CardDropHelper.GetRandomCardByRarity(rarityType);
+
+        if (!card) {
+            await interaction.reply('Card not found');
+            return;
+        }
+
+        const image = readFileSync(card.Path);
+
+        await interaction.deferReply();
+
+        const attachment = new AttachmentBuilder(image, { name: card.FileName });
+
+        const inventory = await Inventory.FetchOneByCardNumberAndUserId(interaction.user.id, card.CardNumber);
+        const quantityClaimed = inventory ? inventory.Quantity : 0;
+
+        const embed = CardDropHelper.GenerateDropEmbed(card, quantityClaimed || 0);
+
+        const claimId = v4();
+
+        const row = CardDropHelper.GenerateDropButtons(card, claimId, interaction.user.id);
+
+        try {
+            await interaction.editReply({
+                embeds: [ embed ],
+                files: [ attachment ],
+                components: [ row ],
+            });
+        } catch (e) {
+            console.error(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}`);
+            } else {
+                await interaction.editReply(`Unable to send next drop. Please try again, and report this if it keeps happening. Code: UNKNOWN`);
+            }
+        }
+
+        CoreClient.ClaimId = claimId;
+    }
+}

src/constants/CardRarity.ts

@@ -41,4 +41,21 @@ export function CardRarityToColour(rarity: CardRarity): number {
         case CardRarity.Manga:
             return EmbedColours.MangaCard;
     }
+}
+
+export function CardRarityParse(rarity: string): CardRarity {
+    switch (rarity.toLowerCase()) {
+        case "bronze":
+            return CardRarity.Bronze;
+        case "silver":
+            return CardRarity.Silver;
+        case "gold":
+            return CardRarity.Gold;
+        case "legendary":
+            return CardRarity.Legendary;
+        case "manga":
+            return CardRarity.Manga;
+        default:
+            return CardRarity.Unknown;
+    }
 }

src/registry.ts

@@ -6,6 +6,7 @@ import Drop from "./commands/drop";
 
 // Test Command Imports
 import Dropnumber from "./commands/stage/dropnumber";
+import Droprarity from "./commands/stage/droprarity";
 
 // Button Event Imports
 import Claim from "./buttonEvents/Claim";
@@ -20,6 +21,7 @@ export default class Registry {
 
         // Test Commands
         CoreClient.RegisterCommand('dropnumber', new Dropnumber(), Environment.Test);
+        CoreClient.RegisterCommand('droprarity', new Droprarity(), Environment.Test);
     }
 
     public static RegisterEvents() {