card-drop/tests/helpers/EffectHelper.test.ts
Ethan Lane 5089ad6ab6
All checks were successful
Deploy To Stage / build (push) Successful in 54s
Deploy To Stage / deploy (push) Successful in 16s
Command to allow the user to buy more effects (#424)
# Description

- Create a command to generate an embed for the user to be able to buy more effects
- This embed will contain the details about the effect as well as 2 buttons; Confirm and Cancel
- The confirm button will call the button event to:
    - Remove the currency from the user
    - Give the user the effect to their inventory
- The cancel button will just disable the buttons, so the user can't accidentally use it if they don't want to.

#381

## Type of change

Please delete options that are not relevant.

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

# How Has This Been Tested?

- Have created unit tests and tested locally

# 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: #424
Reviewed-by: VylpesTester <tester@vylpes.com>
Co-authored-by: Ethan Lane <ethan@vylpes.com>
Co-committed-by: Ethan Lane <ethan@vylpes.com>
2025-03-26 18:30:16 +00:00

127 lines
No EOL
3.5 KiB
TypeScript

import EffectHelper from "../../src/helpers/EffectHelper";
import UserEffect from "../../src/database/entities/app/UserEffect";
jest.mock("../../src/database/entities/app/UserEffect");
describe("GenerateEffectListEmbed", () => {
test("GIVEN user has an effect, EXPECT detailed embed to be returned", async () => {
// Arrange
(UserEffect.FetchAllByUserIdPaginated as jest.Mock).mockResolvedValue([
[
{
Name: "unclaimed",
Unused: 1,
}
],
1,
]);
// Act
const result = await EffectHelper.GenerateEffectListEmbed("userId", 1);
// Assert
expect(result).toMatchSnapshot();
});
test("GIVEN user has more than 1 page of effects, EXPECT pagination enabled", async () => {
const effects: {
Name: string,
Unused: number,
}[] = [];
for (let i = 0; i < 15; i++) {
effects.push({
Name: "unclaimed",
Unused: 1,
});
}
// Arrange
(UserEffect.FetchAllByUserIdPaginated as jest.Mock).mockResolvedValue([
effects,
15,
]);
// Act
const result = await EffectHelper.GenerateEffectListEmbed("userId", 1);
// Assert
expect(result).toMatchSnapshot();
});
test("GIVEN user is on a page other than 1, EXPECT pagination enabled", async () => {
const effects: {
Name: string,
Unused: number,
}[] = [];
for (let i = 0; i < 15; i++) {
effects.push({
Name: "unclaimed",
Unused: 1,
});
}
// Arrange
(UserEffect.FetchAllByUserIdPaginated as jest.Mock).mockResolvedValue([
effects,
15,
]);
// Act
const result = await EffectHelper.GenerateEffectListEmbed("userId", 2);
// Assert
expect(result).toMatchSnapshot();
});
test("GIVEN user does NOT have an effect, EXPECT empty embed to be returned", async () => {
// Arrange
(UserEffect.FetchAllByUserIdPaginated as jest.Mock).mockResolvedValue([
[],
0,
]);
// Act
const result = await EffectHelper.GenerateEffectListEmbed("userId", 1);
// Assert
expect(result).toMatchSnapshot();
});
test("GIVEN there is an active effect, EXPECT field added", async () => {
// Arrange
(UserEffect.FetchAllByUserIdPaginated as jest.Mock).mockResolvedValue([
[
{
Name: "unclaimed",
Unused: 1,
}
],
1,
]);
(UserEffect.FetchActiveEffectByUserId as jest.Mock).mockResolvedValue({
Name: "unclaimed",
WhenExpires: new Date(1738174052),
});
// Act
const result = await EffectHelper.GenerateEffectListEmbed("userId", 1);
// Assert
expect(result).toMatchSnapshot();
});
});
describe("GenerateEffectBuyEmbed", () => {
test.todo("GIVEN Effect Details are not found, EXPECT error");
test.todo("GIVEN user is not in database, EXPECT blank user created");
test.todo("GIVEN user does not have enough currency, EXPECT error");
test.todo("GIVEN user does have enough currency, EXPECT embed returned");
test.todo("GIVEN disabled boolean is true, EXPECT buttons to be disabled");
});