generated from nhcarrigan/template
feat: first version of bot (#2)
### Explanation This should set up everything we need for our initial launch. Test coverage is at 100% to ensure nothing breaks. ### Issue _No response_ ### Attestations - [x] I have read and agree to the [Code of Conduct](https://docs.nhcarrigan.com/community/coc/) - [x] I have read and agree to the [Community Guidelines](https://docs.nhcarrigan.com/community/guide/). - [x] My contribution complies with the [Contributor Covenant](https://docs.nhcarrigan.com/dev/covenant/). ### Dependencies - [x] I have pinned the dependencies to a specific patch version. ### Style - [x] I have run the linter and resolved any errors. - [x] My pull request uses an appropriate title, matching the conventional commit standards. - [x] My scope of feat/fix/chore/etc. correctly matches the nature of changes in my pull request. ### Tests - [x] My contribution adds new code, and I have added tests to cover it. - [ ] My contribution modifies existing code, and I have updated the tests to reflect these changes. - [x] All new and existing tests pass locally with my changes. - [x] Code coverage remains at or above the configured threshold. ### Documentation Coming soon - I'm working on the infra for docs next ### Versioning Major - My pull request introduces a breaking change. Reviewed-on: https://codeberg.org/nhcarrigan/rig-task-bot/pulls/2 Co-authored-by: Naomi Carrigan <commits@nhcarrigan.com> Co-committed-by: Naomi Carrigan <commits@nhcarrigan.com>
This commit is contained in:
Naomi the Technomancer
@@ -0,0 +1,24 @@
|
||||
/**
|
||||
* @copyright nhcarrigan
|
||||
* @license Naomi's Public License
|
||||
* @author Naomi Carrigan
|
||||
*/
|
||||
|
||||
import { describe, it, expect, vi } from "vitest";
|
||||
import { defaultCommand } from "../../src/modules/defaultCommand.js";
|
||||
|
||||
describe("defaultCommand", () => {
|
||||
it("should respond with expected values", async() => {
|
||||
expect.assertions(1);
|
||||
const mockInteraction = {
|
||||
commandName: "test",
|
||||
reply: vi.fn(),
|
||||
};
|
||||
await defaultCommand({} as never, mockInteraction as never);
|
||||
expect(mockInteraction.reply, "should reply with correct body").
|
||||
toHaveBeenCalledWith({
|
||||
content: "Interaction test not found.",
|
||||
ephemeral: true,
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,491 @@
|
||||
/**
|
||||
* @copyright nhcarrigan
|
||||
* @license Naomi's Public License
|
||||
* @author Naomi Carrigan
|
||||
*/
|
||||
|
||||
import { describe, it, expect, vi } from "vitest";
|
||||
import {
|
||||
createModal,
|
||||
defaultModal,
|
||||
updateModal,
|
||||
} from "../../src/modules/modalHandlers.ts";
|
||||
import { errorHandler } from "../../src/utils/errorHandler.ts";
|
||||
|
||||
describe("default modal", () => {
|
||||
it("should send the expected response", async() => {
|
||||
expect.assertions(1);
|
||||
const mockInteraction = {
|
||||
customId: "test",
|
||||
reply: vi.fn(),
|
||||
};
|
||||
await defaultModal({} as never, mockInteraction as never);
|
||||
expect(
|
||||
mockInteraction.reply,
|
||||
"should reply with correct body",
|
||||
).toHaveBeenCalledWith({
|
||||
content: "Modal test has no handler.",
|
||||
ephemeral: true,
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe("create modal", () => {
|
||||
it("should send the expected response and save to the database", async() => {
|
||||
expect.assertions(4);
|
||||
const mockInteraction = {
|
||||
customId: "create-modal",
|
||||
deferReply: vi.fn(),
|
||||
editReply: vi.fn(),
|
||||
fields: {
|
||||
getTextInputValue: vi.fn().mockImplementation((value: string) => {
|
||||
return value === "dueDate"
|
||||
? "September 5, 2000"
|
||||
: value;
|
||||
}),
|
||||
},
|
||||
reply: vi.fn(),
|
||||
};
|
||||
const mockBot = {
|
||||
database: {
|
||||
tasks: {
|
||||
count: vi.fn().mockReturnValue(1),
|
||||
create: vi.fn().mockImplementation((data: { data: unknown }) => {
|
||||
return data.data;
|
||||
}),
|
||||
},
|
||||
},
|
||||
};
|
||||
await createModal(mockBot as never, mockInteraction as never);
|
||||
expect(
|
||||
mockInteraction.deferReply,
|
||||
"should defer reply",
|
||||
).toHaveBeenCalledWith({ ephemeral: true });
|
||||
expect(
|
||||
mockBot.database.tasks.count,
|
||||
"should generate an id",
|
||||
).toHaveBeenCalledOnce();
|
||||
expect(
|
||||
mockBot.database.tasks.create,
|
||||
"should save to the database",
|
||||
).toHaveBeenCalledWith({
|
||||
data: {
|
||||
description: "description",
|
||||
dueAt: expect.any(Date),
|
||||
numericalId: 2,
|
||||
title: "title",
|
||||
},
|
||||
});
|
||||
expect(
|
||||
mockInteraction.editReply,
|
||||
"should reply with correct body",
|
||||
).toHaveBeenCalledWith({
|
||||
content: "Task 2 created.",
|
||||
});
|
||||
});
|
||||
|
||||
it("should handle the fallback date", async() => {
|
||||
expect.assertions(4);
|
||||
const mockInteraction = {
|
||||
customId: "create-modal",
|
||||
deferReply: vi.fn(),
|
||||
editReply: vi.fn(),
|
||||
fields: {
|
||||
getTextInputValue: vi.fn().mockImplementation((value: string) => {
|
||||
return value;
|
||||
}),
|
||||
},
|
||||
reply: vi.fn(),
|
||||
};
|
||||
const mockBot = {
|
||||
database: {
|
||||
tasks: {
|
||||
count: vi.fn().mockReturnValue(1),
|
||||
create: vi.fn().mockImplementation((data: { data: unknown }) => {
|
||||
return data.data;
|
||||
}),
|
||||
},
|
||||
},
|
||||
};
|
||||
await createModal(mockBot as never, mockInteraction as never);
|
||||
expect(
|
||||
mockInteraction.deferReply,
|
||||
"should defer reply",
|
||||
).toHaveBeenCalledWith({ ephemeral: true });
|
||||
expect(
|
||||
mockBot.database.tasks.count,
|
||||
"should generate an id",
|
||||
).toHaveBeenCalledOnce();
|
||||
expect(
|
||||
mockBot.database.tasks.create,
|
||||
"should save to the database",
|
||||
).toHaveBeenCalledWith({
|
||||
data: {
|
||||
description: "description",
|
||||
dueAt: expect.any(Date),
|
||||
numericalId: 2,
|
||||
title: "title",
|
||||
},
|
||||
});
|
||||
expect(
|
||||
mockInteraction.editReply,
|
||||
"should reply with correct body",
|
||||
).toHaveBeenCalledWith({
|
||||
content: "Task 2 created.",
|
||||
});
|
||||
});
|
||||
|
||||
it("should call the error handler if an error is thrown", async() => {
|
||||
expect.assertions(1);
|
||||
const mockInteraction = {
|
||||
commandName: "test",
|
||||
inCachedGuild: vi.fn().mockReturnValue(true),
|
||||
isChatInputCommand: vi.fn().mockImplementation(() => {
|
||||
throw new Error("Test error");
|
||||
}),
|
||||
reply: vi.fn(),
|
||||
};
|
||||
vi.mock("../../src/utils/errorHandler.ts", () => {
|
||||
return {
|
||||
errorHandler: vi.fn(),
|
||||
};
|
||||
});
|
||||
await createModal({} as never, mockInteraction as never);
|
||||
expect(errorHandler, "should call error handler").toHaveBeenCalledTimes(1);
|
||||
});
|
||||
|
||||
it("should call the error handler if replied and is thrown", async() => {
|
||||
expect.assertions(1);
|
||||
vi.clearAllMocks();
|
||||
const mockInteraction = {
|
||||
commandName: "test",
|
||||
deferReply: vi.fn().mockImplementation(() => {
|
||||
throw new Error("Test error");
|
||||
}),
|
||||
editReply: vi.fn(),
|
||||
replied: true,
|
||||
};
|
||||
const mockBot = {
|
||||
env: {
|
||||
debugHook: {
|
||||
send: vi.fn(),
|
||||
},
|
||||
},
|
||||
};
|
||||
vi.mock("../../src/utils/errorHandler.ts", () => {
|
||||
return {
|
||||
errorHandler: vi.fn(),
|
||||
};
|
||||
});
|
||||
await createModal(mockBot as never, mockInteraction as never);
|
||||
expect(errorHandler, "should call error handler").toHaveBeenCalledTimes(1);
|
||||
});
|
||||
});
|
||||
|
||||
describe("update modal", () => {
|
||||
it("should respond when the number input is invalid", async() => {
|
||||
expect.assertions(3);
|
||||
const mockInteraction = {
|
||||
customId: "create-modal",
|
||||
deferReply: vi.fn(),
|
||||
editReply: vi.fn(),
|
||||
fields: {
|
||||
getTextInputValue: vi.fn().mockImplementation((value: string) => {
|
||||
return value === "dueDate"
|
||||
? "September 5, 2000"
|
||||
: value;
|
||||
}),
|
||||
},
|
||||
reply: vi.fn(),
|
||||
};
|
||||
const mockBot = {
|
||||
database: {
|
||||
tasks: {
|
||||
findFirst: vi.fn().mockReturnValue(null),
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
await updateModal(mockBot as never, mockInteraction as never);
|
||||
expect(
|
||||
mockInteraction.deferReply,
|
||||
"should defer reply",
|
||||
).toHaveBeenCalledWith({ ephemeral: true });
|
||||
expect(
|
||||
mockBot.database.tasks.findFirst,
|
||||
"should find the task",
|
||||
).not.toHaveBeenCalledOnce();
|
||||
expect(
|
||||
mockInteraction.editReply,
|
||||
"should reply with correct body",
|
||||
).toHaveBeenCalledWith({
|
||||
content: "Invalid task number.",
|
||||
});
|
||||
});
|
||||
|
||||
it("should respond when the task number is not found", async() => {
|
||||
expect.assertions(3);
|
||||
const mockInteraction = {
|
||||
customId: "create-modal",
|
||||
deferReply: vi.fn(),
|
||||
editReply: vi.fn(),
|
||||
fields: {
|
||||
getTextInputValue: vi.fn().mockImplementation((value: string) => {
|
||||
// eslint-disable-next-line no-nested-ternary
|
||||
return value === "dueDate"
|
||||
? "September 5, 2000"
|
||||
: value === "taskNumber"
|
||||
? "1"
|
||||
: value;
|
||||
}),
|
||||
},
|
||||
reply: vi.fn(),
|
||||
};
|
||||
const mockBot = {
|
||||
database: {
|
||||
tasks: {
|
||||
findFirst: vi.fn().mockReturnValue(null),
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
await updateModal(mockBot as never, mockInteraction as never);
|
||||
expect(
|
||||
mockInteraction.deferReply,
|
||||
"should defer reply",
|
||||
).toHaveBeenCalledWith({ ephemeral: true });
|
||||
expect(
|
||||
mockBot.database.tasks.findFirst,
|
||||
"should find the task",
|
||||
).toHaveBeenCalledWith({ where: { numericalId: 1 } });
|
||||
expect(
|
||||
mockInteraction.editReply,
|
||||
"should reply with correct body",
|
||||
).toHaveBeenCalledWith({
|
||||
content: "Task 1 not found.",
|
||||
});
|
||||
});
|
||||
|
||||
it("should update the task", async() => {
|
||||
expect.assertions(4);
|
||||
const mockInteraction = {
|
||||
customId: "create-modal",
|
||||
deferReply: vi.fn(),
|
||||
editReply: vi.fn(),
|
||||
fields: {
|
||||
getTextInputValue: vi.fn().mockImplementation((value: string) => {
|
||||
// eslint-disable-next-line no-nested-ternary
|
||||
return value === "dueDate"
|
||||
? "September 5, 2000"
|
||||
: value === "taskNumber"
|
||||
? "1"
|
||||
: value;
|
||||
}),
|
||||
},
|
||||
reply: vi.fn(),
|
||||
};
|
||||
const mockBot = {
|
||||
database: {
|
||||
tasks: {
|
||||
findFirst: vi.fn().mockReturnValue({
|
||||
description: "Naomi's test description",
|
||||
dueAt: new Date("October 1, 2000"),
|
||||
numericalId: 1,
|
||||
title: "Naomi's test task",
|
||||
}),
|
||||
update: vi.fn(),
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
await updateModal(mockBot as never, mockInteraction as never);
|
||||
expect(
|
||||
mockInteraction.deferReply,
|
||||
"should defer reply",
|
||||
).toHaveBeenCalledWith({ ephemeral: true });
|
||||
expect(
|
||||
mockBot.database.tasks.findFirst,
|
||||
"should find the task",
|
||||
).toHaveBeenCalledWith({ where: { numericalId: 1 } });
|
||||
expect(
|
||||
mockBot.database.tasks.update,
|
||||
"should update the task",
|
||||
).toHaveBeenCalledWith({
|
||||
data: {
|
||||
description: "description",
|
||||
dueAt: new Date("September 5, 2000"),
|
||||
title: "title",
|
||||
},
|
||||
where: { numericalId: 1 },
|
||||
});
|
||||
expect(
|
||||
mockInteraction.editReply,
|
||||
"should reply with correct body",
|
||||
).toHaveBeenCalledWith({
|
||||
content: "Task 1 updated.",
|
||||
});
|
||||
});
|
||||
|
||||
it("should handle invalid dates", async() => {
|
||||
expect.assertions(4);
|
||||
const mockInteraction = {
|
||||
customId: "create-modal",
|
||||
deferReply: vi.fn(),
|
||||
editReply: vi.fn(),
|
||||
fields: {
|
||||
getTextInputValue: vi.fn().mockImplementation((value: string) => {
|
||||
return value === "taskNumber"
|
||||
? "1"
|
||||
: value;
|
||||
}),
|
||||
},
|
||||
reply: vi.fn(),
|
||||
};
|
||||
const mockBot = {
|
||||
database: {
|
||||
tasks: {
|
||||
findFirst: vi.fn().mockReturnValue({
|
||||
description: "Naomi's test description",
|
||||
dueAt: new Date("October 1, 2000"),
|
||||
numericalId: 1,
|
||||
title: "Naomi's test task",
|
||||
}),
|
||||
update: vi.fn(),
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
await updateModal(mockBot as never, mockInteraction as never);
|
||||
expect(
|
||||
mockInteraction.deferReply,
|
||||
"should defer reply",
|
||||
).toHaveBeenCalledWith({ ephemeral: true });
|
||||
expect(
|
||||
mockBot.database.tasks.findFirst,
|
||||
"should find the task",
|
||||
).toHaveBeenCalledWith({ where: { numericalId: 1 } });
|
||||
expect(
|
||||
mockBot.database.tasks.update,
|
||||
"should update the task",
|
||||
).toHaveBeenCalledWith({
|
||||
data: {
|
||||
description: "description",
|
||||
dueAt: expect.any(Date),
|
||||
title: "title",
|
||||
},
|
||||
where: { numericalId: 1 },
|
||||
});
|
||||
expect(
|
||||
mockInteraction.editReply,
|
||||
"should reply with correct body",
|
||||
).toHaveBeenCalledWith({
|
||||
content: "Task 1 updated.",
|
||||
});
|
||||
});
|
||||
|
||||
it("should update the task with all fallback values", async() => {
|
||||
expect.assertions(4);
|
||||
const mockInteraction = {
|
||||
customId: "create-modal",
|
||||
deferReply: vi.fn(),
|
||||
editReply: vi.fn(),
|
||||
fields: {
|
||||
getTextInputValue: vi.fn().mockImplementation((value: string) => {
|
||||
return value === "taskNumber"
|
||||
? "1"
|
||||
: "";
|
||||
}),
|
||||
},
|
||||
reply: vi.fn(),
|
||||
};
|
||||
const mockBot = {
|
||||
database: {
|
||||
tasks: {
|
||||
findFirst: vi.fn().mockReturnValue({
|
||||
description: "Naomi's test description",
|
||||
dueAt: new Date("October 1, 2000"),
|
||||
numericalId: 1,
|
||||
title: "Naomi's test task",
|
||||
}),
|
||||
update: vi.fn(),
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
await updateModal(mockBot as never, mockInteraction as never);
|
||||
expect(
|
||||
mockInteraction.deferReply,
|
||||
"should defer reply",
|
||||
).toHaveBeenCalledWith({ ephemeral: true });
|
||||
expect(
|
||||
mockBot.database.tasks.findFirst,
|
||||
"should find the task",
|
||||
).toHaveBeenCalledWith({ where: { numericalId: 1 } });
|
||||
expect(
|
||||
mockBot.database.tasks.update,
|
||||
"should update the task",
|
||||
).toHaveBeenCalledWith({
|
||||
data: {},
|
||||
where: { numericalId: 1 },
|
||||
});
|
||||
expect(
|
||||
mockInteraction.editReply,
|
||||
"should reply with correct body",
|
||||
).toHaveBeenCalledWith({
|
||||
content: "Task 1 updated.",
|
||||
});
|
||||
});
|
||||
|
||||
it("should call the error handler if an error is thrown", async() => {
|
||||
expect.assertions(1);
|
||||
vi.clearAllMocks();
|
||||
const mockInteraction = {
|
||||
commandName: "test",
|
||||
deferReply: vi.fn().mockImplementation(() => {
|
||||
throw new Error("Test error");
|
||||
}),
|
||||
reply: vi.fn(),
|
||||
};
|
||||
const mockBot = {
|
||||
env: {
|
||||
debugHook: {
|
||||
send: vi.fn(),
|
||||
},
|
||||
},
|
||||
};
|
||||
vi.mock("../../src/utils/errorHandler.ts", () => {
|
||||
return {
|
||||
errorHandler: vi.fn(),
|
||||
};
|
||||
});
|
||||
await updateModal(mockBot as never, mockInteraction as never);
|
||||
expect(errorHandler, "should call error handler").toHaveBeenCalledTimes(1);
|
||||
});
|
||||
|
||||
it("should call the error handler if replied and is thrown", async() => {
|
||||
expect.assertions(1);
|
||||
vi.clearAllMocks();
|
||||
const mockInteraction = {
|
||||
commandName: "test",
|
||||
deferReply: vi.fn().mockImplementation(() => {
|
||||
throw new Error("Test error");
|
||||
}),
|
||||
editReply: vi.fn(),
|
||||
replied: true,
|
||||
};
|
||||
const mockBot = {
|
||||
env: {
|
||||
debugHook: {
|
||||
send: vi.fn(),
|
||||
},
|
||||
},
|
||||
};
|
||||
vi.mock("../../src/utils/errorHandler.ts", () => {
|
||||
return {
|
||||
errorHandler: vi.fn(),
|
||||
};
|
||||
});
|
||||
await updateModal(mockBot as never, mockInteraction as never);
|
||||
expect(errorHandler, "should call error handler").toHaveBeenCalledTimes(1);
|
||||
});
|
||||
});
|
||||
Reference in New Issue
Block a user