Update the drop mechanic to take currency on drop instead of claim (#428)

# Description

- Update the drop mechanic to take currency on drop instead of claim
- Update the time until anyone can claim the card to 2 minutes
- Remove the restriction that the last drop can only be claimed by the user who dropped it
    - Now just controlled by the 2 minutes rule

#415

## 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: #428
Reviewed-by: VylpesTester <tester@vylpes.com>
Co-authored-by: Ethan Lane <ethan@vylpes.com>
Co-committed-by: Ethan Lane <ethan@vylpes.com>

tests/__functions__/discord.js/GenerateCommandInteractionMock.ts

@@ -4,9 +4,14 @@ export default function GenerateCommandInteractionMock(options?: {
     subcommand?: string,
 }): CommandInteraction {
     return {
+        deferReply: jest.fn(),
+        editReply: jest.fn(),
         isChatInputCommand: jest.fn().mockReturnValue(true),
         options: {
             getSubcommand: jest.fn().mockReturnValue(options?.subcommand),
         },
+        user: {
+            id: "userId",
+        },
     };
 }

tests/__types__/discord.js.ts

@@ -19,8 +19,13 @@ export type ButtonInteraction = {
 }
 
 export type CommandInteraction = {
+    deferReply: jest.Func,
+    editReply: jest.Func,
     isChatInputCommand: jest.Func,
     options: {
         getSubcommand: jest.Func,
     },
+    user: {
+        id: string,
+    },
 }

tests/buttonEvents/Claim.test.ts

@@ -1,7 +1,6 @@
 import { ButtonInteraction, TextChannel } from "discord.js";
 import Claim from "../../src/buttonEvents/Claim";
 import { ButtonInteraction as ButtonInteractionType } from "../__types__/discord.js";
-import User from "../../src/database/entities/app/User";
 import GenerateButtonInteractionMock from "../__functions__/discord.js/GenerateButtonInteractionMock";
 
 jest.mock("../../src/client/appLogger");
@@ -85,25 +84,7 @@ test("GIVEN interaction.message was created more than 5 minutes ago, EXPECT erro
 
     // Assert
     expect(interaction.channel!.send).toHaveBeenCalledTimes(1);
-    expect(interaction.channel!.send).toHaveBeenCalledWith("[object Object], Cards can only be claimed within 5 minutes of it being dropped!");
-
-    expect(interaction.editReply).not.toHaveBeenCalled();
-});
-
-test("GIVEN user.RemoveCurrency fails, EXPECT error", async () => {
-    // Arrange
-    User.FetchOneById = jest.fn().mockResolvedValue({
-        RemoveCurrency: jest.fn().mockReturnValue(false),
-        Currency: 5,
-    });
-
-    // Act
-    const claim = new Claim();
-    await claim.execute(interaction as unknown as ButtonInteraction);
-
-    // Assert
-    expect(interaction.channel!.send).toHaveBeenCalledTimes(1);
-    expect(interaction.channel!.send).toHaveBeenCalledWith("[object Object], Not enough currency! You need 10 currency, you have 5!");
+    expect(interaction.channel!.send).toHaveBeenCalledWith("[object Object], Cards can only be claimed within 2 minutes of it being dropped!");
 
     expect(interaction.editReply).not.toHaveBeenCalled();
 });

tests/buttonEvents/Reroll.test.ts

@@ -0,0 +1,7 @@
+describe("GIVEN valid conditions", () => {
+    test.todo("EXPECT user.RemoveCurrency to be called");
+
+    test.todo("GIVEN user is saved");
+});
+
+test.todo("GIVEN user.RemoveCurrency fails, EXPECT error replied");

tests/commands/drop.test.ts

@@ -0,0 +1,142 @@
+import { CommandInteraction } from "discord.js";
+import Drop from "../../src/commands/drop";
+import GenerateCommandInteractionMock from "../__functions__/discord.js/GenerateCommandInteractionMock";
+import { CommandInteraction as CommandInteractionMock } from "../__types__/discord.js";
+import { CoreClient } from "../../src/client/client";
+import Config from "../../src/database/entities/app/Config";
+import User from "../../src/database/entities/app/User";
+import GetCardsHelper from "../../src/helpers/DropHelpers/GetCardsHelper";
+import Inventory from "../../src/database/entities/app/Inventory";
+import DropEmbedHelper from "../../src/helpers/DropHelpers/DropEmbedHelper";
+import CardConstants from "../../src/constants/CardConstants";
+import * as uuid from "uuid";
+
+jest.mock("../../src/database/entities/app/Config");
+jest.mock("../../src/database/entities/app/User");
+jest.mock("../../src/helpers/DropHelpers/GetCardsHelper");
+jest.mock("../../src/database/entities/app/Inventory");
+jest.mock("../../src/helpers/DropHelpers/DropEmbedHelper");
+
+jest.mock("uuid");
+
+beforeEach(() => {
+    (Config.GetValue as jest.Mock).mockResolvedValue("false");
+});
+
+describe("execute", () => {
+    describe("GIVEN user is in the database", () => {
+        let interaction: CommandInteractionMock;
+        let user: User;
+        const randomCard = {
+            card: {
+                id: "cardId",
+                path: "https://google.com/",
+            }
+        };
+
+        beforeAll(async () => {
+            // Arrange
+            CoreClient.AllowDrops = true;
+
+            interaction = GenerateCommandInteractionMock();
+
+            user = {
+                Currency: 500,
+                RemoveCurrency: jest.fn().mockReturnValue(true),
+                Save: jest.fn(),
+            } as unknown as User;
+
+            (User.FetchOneById as jest.Mock).mockResolvedValue(user);
+            (GetCardsHelper.FetchCard as jest.Mock).mockResolvedValue(randomCard);
+            (Inventory.FetchOneByCardNumberAndUserId as jest.Mock).mockResolvedValue({
+                Quantity: 1,
+            });
+            (DropEmbedHelper.GenerateDropEmbed as jest.Mock).mockReturnValue({
+                type: "Embed",
+            });
+            (DropEmbedHelper.GenerateDropButtons as jest.Mock).mockReturnValue({
+                type: "Button",
+            });
+
+            (uuid.v4 as jest.Mock).mockReturnValue("uuid");
+
+            // Act
+            const drop = new Drop();
+            await drop.execute(interaction as unknown as CommandInteraction);
+        });
+
+        test("EXPECT user to be fetched", () => {
+            expect(User.FetchOneById).toHaveBeenCalledTimes(1);
+            expect(User.FetchOneById).toHaveBeenCalledWith(User, "userId");
+        });
+
+        test("EXPECT user.RemoveCurrency to be called", () => {
+            expect(user.RemoveCurrency).toHaveBeenCalledTimes(1);
+            expect(user.RemoveCurrency).toHaveBeenCalledWith(CardConstants.ClaimCost);
+        });
+
+        test("EXPECT user to be saved", () => {
+            expect(user.Save).toHaveBeenCalledTimes(1);
+            expect(user.Save).toHaveBeenCalledWith(User, user);
+        });
+
+        test("EXPECT random card to be fetched", () => {
+            expect(GetCardsHelper.FetchCard).toHaveBeenCalledTimes(1);
+            expect(GetCardsHelper.FetchCard).toHaveBeenCalledWith("userId");
+        });
+
+        test("EXPECT interaction to be deferred", () => {
+            expect(interaction.deferReply).toHaveBeenCalledTimes(1);
+        });
+
+        test("EXPECT Inventory.FetchOneByCardNumberAndUserId to be called", () => {
+            expect(Inventory.FetchOneByCardNumberAndUserId).toHaveBeenCalledTimes(1);
+            expect(Inventory.FetchOneByCardNumberAndUserId).toHaveBeenCalledWith("userId", "cardId");
+        });
+
+        test("EXPECT DropEmbedHelper.GenerateDropEmbed to be called", () => {
+            expect(DropEmbedHelper.GenerateDropEmbed).toHaveBeenCalledTimes(1);
+            expect(DropEmbedHelper.GenerateDropEmbed).toHaveBeenCalledWith(randomCard, 1, "", undefined, 500);
+        });
+
+        test("EXPECT DropEmbedHelper.GenerateDropButtons to be called", () => {
+            expect(DropEmbedHelper.GenerateDropButtons).toHaveBeenCalledTimes(1);
+            expect(DropEmbedHelper.GenerateDropButtons).toHaveBeenCalledWith(randomCard, "uuid", "userId");
+        });
+
+        test("EXPECT interaction to be edited", () => {
+            expect(interaction.editReply).toHaveBeenCalledTimes(1);
+            expect(interaction.editReply).toHaveBeenCalledWith({
+                embeds: [ { type: "Embed" } ],
+                files: [],
+                components: [ { type: "Button" } ],
+            });
+        });
+
+        describe("AND randomCard path is not a url", () => {
+            test.todo("EXPECT image read from file system");
+
+            test.todo("EXPECT files on the embed to contain the image as an attachment");
+        });
+    });
+
+    describe("GIVEN user is not in the database", () => {
+        test.todo("EXPECT new user to be created");
+    });
+
+    describe("GIVEN user.RemoveCurrency fails", () => {
+        test.todo("EXPECT error replied");
+    });
+    
+    describe("GIVEN randomCard returns null", () => {
+        test.todo("EXPECT error logged");
+
+        test.todo("EXPECT error replied");
+    });
+
+    describe("GIVEN the code throws an error", () => {
+        test.todo("EXPECT error logged");
+
+        test.todo("EXPECT interaction edited with error");
+    });
+});

tests/helpers/DropHelpers/DropEmbedHelper.test.ts

@@ -0,0 +1,3 @@
+describe("GenerateDropButtons", () => {
+    test.todo("EXPECT row to be returned");
+});

tests/timers/PurgeClaims.test.ts

@@ -0,0 +1,7 @@
+describe("PurgeClaims", () => {
+    test.todo("EXPECT claims to be fetched");
+
+    test.todo("EXPECT Claim.RemoveMany to remove the claims older than 2 minutes");
+
+    test.todo("EXPECT info logged");
+});