generated from nhcarrigan/template
Naomi Carrigan
296a50fedd
### 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>
53 lines
1.9 KiB
TypeScript
53 lines
1.9 KiB
TypeScript
/**
|
|
* @copyright nhcarrigan
|
|
* @license Naomi's Public License
|
|
* @author Naomi Carrigan
|
|
*/
|
|
import {
|
|
EmbedBuilder,
|
|
SnowflakeUtil,
|
|
type ChatInputCommandInteraction,
|
|
} from "discord.js";
|
|
import { sendDebugLog } from "./sendDebugLog.js";
|
|
import type { Bot } from "../interfaces/bot.js";
|
|
|
|
/**
|
|
* Parses an error event (re: from a catch block). If it
|
|
* is a proper Error object, extrapolates data. Sends information
|
|
* to the debug webhook, and assigns the error a Snowflake ID.
|
|
* Optionally forwards the ID to the user through a reply function.
|
|
* @param bot -- The bot object, containing the webhook client.
|
|
* @param context -- A brief description of the code module that threw the error.
|
|
* @param error -- The error payload, typed as unknown to comply with TypeScript's typedef.
|
|
* @param reply - OPTIONAL: A function to use to send the ID back to the user.
|
|
* @returns The Snowflake ID assigned to the error.
|
|
*/
|
|
export const errorHandler = async(
|
|
bot: Bot,
|
|
context: string,
|
|
error: unknown,
|
|
reply?:
|
|
| ChatInputCommandInteraction["reply"]
|
|
| ChatInputCommandInteraction["editReply"],
|
|
// eslint-disable-next-line @typescript-eslint/max-params
|
|
): Promise<string> => {
|
|
const id = SnowflakeUtil.generate();
|
|
const embed = new EmbedBuilder();
|
|
embed.setFooter({ text: `Error ID: ${id.toString()}` });
|
|
embed.setTitle(`Error: ${context}`);
|
|
if (error instanceof Error) {
|
|
embed.setDescription(error.message);
|
|
embed.addFields([
|
|
{ name: "Stack", value: `\`\`\`\n${String(error.stack).slice(0, 1000)}` },
|
|
]);
|
|
} else {
|
|
embed.setDescription(String(error).slice(0, 2000));
|
|
}
|
|
await sendDebugLog(bot, { embeds: [ embed ] });
|
|
if (reply) {
|
|
const content = `Oops! Something went wrong! Please reach out to us in our [support server](https://chat.nhcarrigan.com) and bring this error ID: ${id.toString()}`;
|
|
await reply({ content: content, ephemeral: true });
|
|
}
|
|
return id.toString();
|
|
};
|