From a92f00e5453f0fe9edd851b231c9f4ea858aa027 Mon Sep 17 00:00:00 2001 From: Aster Fialla Date: Sat, 14 Feb 2026 12:55:36 -0500 Subject: [PATCH] better error handling --- bot.js | 17 +++----- enums.js | 16 ++++--- helpers/memberHelper.js | 95 +++++++++++++++++++++-------------------- sequelize.js | 2 +- 4 files changed, 67 insertions(+), 63 deletions(-) diff --git a/bot.js b/bot.js index 984d650..661609f 100644 --- a/bot.js +++ b/bot.js @@ -2,6 +2,7 @@ import { Client, Events, GatewayOpcodes } from '@fluxerjs/core'; import { messageHelper } from "./helpers/messageHelper.js"; import {enums} from "./enums.js"; import {commands} from "./commands.js"; +import {webhookHelper} from "./helpers/webhookHelper.js"; const token = process.env.FLUXER_BOT_TOKEN; @@ -23,9 +24,7 @@ client.on(Events.MessageCreate, async (message) => { // If message doesn't start with the bot prefix, it could still be a message with a proxy tag if (!content.startsWith(messageHelper.prefix)) { - // wait until webhooks exist lol - //const successful = await webhookHelper.sendMessageAsMember(message, content); - // if (!successful) return; + await webhookHelper.sendMessageAsMember(client, message, content); return; } @@ -37,15 +36,11 @@ client.on(Events.MessageCreate, async (message) => { const command = commands.get(commandName); if (command) { - try { - await command.execute(message, client, args); - } catch (err) { - console.error(`Error executing ${commandName}:`, err); - await message.reply('An error occurred while running that command.').catch(() => { - }); - } + await command.execute(message, client, args).catch(async () => { + await message.reply('An error occurred while running that command.') + throw new Error(`Error executing ${commandName}:`); + }); } - } catch(error) { return await message.reply(error); diff --git a/enums.js b/enums.js index 7a3bea0..ccbfa09 100644 --- a/enums.js +++ b/enums.js @@ -11,15 +11,21 @@ helperEnums.err = { PROXY_EXISTS: "A duplicate proxy already exists for one of your members. Please pick a new one, or change the old one first.", NO_SUCH_COMMAND: "No such command exists.", PROPIC_FAILS_REQUIREMENTS: "Profile picture must be in JPG or PNG format.", - PROPIC_CANNOT_LOAD: "Profile picture could not be loaded from URL." + PROPIC_CANNOT_LOAD: "Profile picture could not be loaded from URL.", + NO_WEBHOOKS_ALLOWED: "Channel does not support webhooks.", + NOT_IN_SERVER: "You can only proxy in a server.", + NO_MESSAGE_SENT_WITH_PROXY: 'Proxied message has no content.' } helperEnums.help = { - PLURALFLUX: "PluralFlux is a proxybot akin to PluralKit and Tupperbot, but for Fluxer. All commands are prefixed by `pf;`. Add ` --help` to the end of a command to find out more about it, or just send it without arguments.\n\nThe current commands are: `pf;member` and `pf;help`.", - MEMBER: "You can shorten this command to `pf;m`. The available subcommands for `pf;member` are `add`, `remove`, `displayname`, `proxy`, and `propic`. Add ` --help` to the end of a subcommand to find out more about it, or just send it without arguments.", - ADD: "Creates a new member to proxy with, for example: `pf;member jane`. The member name should ideally be short so you can write other commands with it. \n\nYou can optionally add a display name after the member name, for example: `pf;member new jane \"Jane Doe | ze/hir\"`. If it has spaces, put it in **double quotes**. The length limit is 32 characters.", + SHORT_DESC_HELP: "Lists available commands.", + SHORT_DESC_MEMBER: "Commands and sub-commands related to proxy members.", + SHORT_DESC_PLURALFLUX: "PluralFlux is a proxybot akin to PluralKit and Tupperbot, but for Fluxer. All commands are prefixed by `pf;`. Type `pf;help` for info on the bot itself.", + PLURALFLUX: "PluralFlux is a proxybot akin to PluralKit and Tupperbot, but for Fluxer. All commands are prefixed by `pf;`. Add ` --help` to the end of a command to find out more about it, or just send it without arguments.", + MEMBER: "Accesses the sub-commands related to editing proxy members. The available subcommands are `add`, `remove`, `displayname`, `proxy`, and `propic`. Add ` --help` to the end of a subcommand to find out more about it, or just send it without arguments.", + ADD: "Creates a new member to proxy with, for example: `pf;member jane`. The member name should ideally be short so you can write other commands with it. \n\nYou can optionally add a display name after the member name, for example: `pf;member new jane \"Jane Doe | ze/hir\"`. If it has spaces, put it in __double quotes__. The length limit is 32 characters.", REMOVE: "Removes a member based on their name, for example: `pf;member remove jane`.", - DISPLAY_NAME: "Updates the display name for a specific member based on their name, for example: `pf;member jane \"Jane Doe | ze/hir\"`.This can be up to 32 characters long. If it has spaces, put it in quotes.", + DISPLAY_NAME: "Updates the display name for a specific member based on their name, for example: `pf;member jane \"Jane Doe | ze/hir\"`.This can be up to 32 characters long. If it has spaces, put it in __double quotes__.", PROXY: "Updates the proxy tag for a specific member based on their name, for example: `pf;member jane proxy Jane:` or `pf;member amal proxy A=`. This is put at *the start* of a message to allow it to be proxied. Proxies that wrap around text or go at the end are *not* currently supported.", PROPIC: "Updates the profile picture for the member. Must be in JPG or PNG format. The two options are:\n1. Pass in a direct remote image URL, for example: `pf;member jane propic `. You can upload images on sites like .\n2. Upload an attachment directly.\n\n**NOTE:** Fluxer does not save your attachments forever, so option #1 is recommended.", } diff --git a/helpers/memberHelper.js b/helpers/memberHelper.js index 7e60b42..4f9575d 100644 --- a/helpers/memberHelper.js +++ b/helpers/memberHelper.js @@ -1,6 +1,7 @@ import { db } from '../sequelize.js'; import {enums} from "../enums.js"; import { loadImage } from "canvas"; +import {EmptyResultError, InstanceError} from "sequelize"; const mh = {}; @@ -12,18 +13,15 @@ const commandList = ['--help', 'add', 'remove', 'displayName', 'proxy', 'propic' * * @param {string} authorId - The author of the message * @param {string[]} args - The message arguments - * @param {string} attachment - The message attachments + * @param {string} attachmentUrl - The message attachments * @returns {Promise} A message. */ -mh.parseMemberCommand = async function(authorId, args, attachment){ +mh.parseMemberCommand = async function(authorId, args, attachmentUrl){ console.log(authorId, args); let member; // checks whether command is in list, otherwise assumes it's a name if(!commandList.includes(args[0])) { member = await getMemberInfo(authorId, args[0]); - if (member === enums.err.NO_MEMBER) { - return member; - } } switch(args[0]) { case '--help': @@ -49,7 +47,7 @@ mh.parseMemberCommand = async function(authorId, args, attachment){ case 'proxy': return await updateProxy(authorId, args); case 'propic': - return await updatePropic(authorId, args, attachment) + return await updatePropic(authorId, args, attachmentUrl) default: return member; } @@ -60,7 +58,8 @@ mh.parseMemberCommand = async function(authorId, args, attachment){ * * @param {string} authorId - The author of the message * @param {string[]} args - The message arguments - * @returns {Promise} A successful addition, or an error message. + * @returns {Promise} A successful addition. + * @throws {Error} When creating a member doesn't work. */ async function addNewMember(authorId, args) { if (args[1] && args[1] === "--help" || !args[1]) { @@ -70,9 +69,6 @@ async function addNewMember(authorId, args) { const displayName = args[2]; const member = await getMemberInfo(authorId, memberName); - if (member && member !== enums.err.NO_MEMBER) { - return enums.err.MEMBER_EXISTS; - } const trimmedName = displayName ? displayName.replaceAll(' ', '') : null; return await db.members.create({ name: memberName, @@ -83,7 +79,7 @@ async function addNewMember(authorId, args) { success += displayName ? `\nDisplay name: ${m.dataValues.displayname}` : ""; return success; }).catch(e => { - return `${enums.err.ADD_ERROR}: ${e.message}`; + throw new Error(`${enums.err.ADD_ERROR}: ${e.message}`) }) } @@ -92,7 +88,8 @@ async function addNewMember(authorId, args) { * * @param {string} authorId - The author of the message * @param {string[]} args - The message arguments - * @returns {Promise} A successful update, or an error message. + * @returns {Promise} A successful update. + * @throws {RangeError} When the display name is too long or doesn't exist. */ async function updateDisplayName(authorId, args) { if (args[1] && args[1] === "--help" || !args[1]) { @@ -108,12 +105,11 @@ async function updateDisplayName(authorId, args) { if (member.displayname) { return `Display name for ${memberName} is: \"${member.displayname}\".`; } - return `Display name ${enums.err.NO_VALUE}` + throw new RangeError(`Display name ${enums.err.NO_VALUE}`); } else if (displayName.length > 32) { - return enums.err.DISPLAY_NAME_TOO_LONG; + throw new RangeError(enums.err.DISPLAY_NAME_TOO_LONG); } - console.log(displayName); return updateMember(authorId, args); } @@ -123,6 +119,7 @@ async function updateDisplayName(authorId, args) { * @param {string} authorId - The author of the message * @param {string[]} args - The message arguments * @returns {Promise } A successful update, or an error message. + * @throws {RangeError | Error} When an empty proxy was provided, or no proxy exists. */ async function updateProxy(authorId, args) { if (args[1] && args[1] === "--help" || !args[1]) { @@ -132,13 +129,13 @@ async function updateProxy(authorId, args) { const trimmedProxy = proxy ? proxy.replaceAll(' ', '') : null; if (trimmedProxy == null) { - return `Proxy ${enums.err.NO_VALUE}`; + throw new RangeError(`Proxy ${enums.err.NO_VALUE}`); } const members = await mh.getMembersByAuthor(authorId); const proxyExists = members.some(member => member.proxy === proxy); if (proxyExists) { - return enums.err.PROXY_EXISTS; + throw new Error(enums.err.PROXY_EXISTS); } return updateMember(authorId, args); } @@ -149,7 +146,8 @@ async function updateProxy(authorId, args) { * @param {string} authorId - The author of the message * @param {string[]} args - The message arguments * @param {string} attachment - The url of the first attachment in the message - * @returns {Promise } A successful update, or an error message. + * @returns {Promise} A successful update. + * @throws {Error} When loading the profile picture from a URL doesn't work. */ async function updatePropic(authorId, args, attachment) { if (args[1] && args[1] === "--help") { @@ -170,7 +168,7 @@ async function updatePropic(authorId, args, attachment) { return await loadImage(img).then(() => { return updateMember(authorId, updatedArgs); }).catch((err) => { - return `${enums.err.PROPIC_CANNOT_LOAD}: ${err.message}`; + throw new Error(`${enums.err.PROPIC_CANNOT_LOAD}: ${err.message}`); }); } @@ -179,21 +177,19 @@ async function updatePropic(authorId, args, attachment) { * * @param {string} authorId - The author of the message * @param {string[]} args - The message arguments - * @returns {Promise} A successful removal, or an error message. + * @returns {Promise} A successful removal. + * @throws {EmptyResultError} When there is no member to remove. */ async function removeMember(authorId, args) { - if (args[1] && args[1] === "--help") { + if (args[1] && args[1] === "--help" || !args[1]) { return enums.help.REMOVE; } const memberName = args[1]; - if (!memberName) { - return `${enums.err.NO_NAME_PROVIDED} deletion.`; - } return await db.members.destroy({ where: { name: memberName, userid: authorId } }).then(() => { return `Member "${memberName}" has been deleted.`; }).catch(e => { - return `${enums.err.NO_MEMBER}: ${e.message}`; + throw new EmptyResultError(`${enums.err.NO_MEMBER}: ${e.message}`); }); } @@ -204,7 +200,8 @@ async function removeMember(authorId, args) { * * @param {string} authorId - The author of the message * @param {string[]} args - The message arguments - * @returns {Promise} A successful update, or an error message. + * @returns {Promise} A successful update. + * @throws {EmptyResultError | Error} When the member is not found, or catchall error. */ async function updateMember(authorId, args) { const memberName = args[0]; @@ -220,7 +217,12 @@ async function updateMember(authorId, args) { return await db.members.update({[columnName]: value}, { where: { name: memberName, userid: authorId } }).then(() => { return `Updated ${columnName} for ${memberName} to "${value}"${fluxerPropicWarning ?? ''}.`; }).catch(e => { - return `${enums.err.NO_MEMBER}: ${e.message}`; + if (e === EmptyResultError) { + throw new EmptyResultError(`${enums.err.NO_MEMBER}: ${e.message}`); + } + else { + throw new Error(e.message); + } }); } @@ -228,11 +230,10 @@ async function updateMember(authorId, args) { * Sets the warning for an expiration date. * * @param {string} expirationString - An expiration date string. - * @returns {string} A successful update, or an error message. + * @returns {string} A description of the expiration, interpolating the expiration string. */ function setExpirationWarning(expirationString) { let expirationDate = new Date(expirationString); - console.log(expirationDate, expirationDate instanceof Date); if (!isNaN(expirationDate.valueOf())) { expirationDate = expirationDate.toDateString(); return `\n**NOTE:** Because this profile picture was uploaded via Fluxer, it will currently expire on *${expirationDate}*. To avoid this, upload the picture to another website like and link to it directly.` @@ -244,18 +245,18 @@ function setExpirationWarning(expirationString) { * * @param {string} authorId - The author of the message * @param {string} memberName - The message arguments - * @returns {Promise} The member's info, or an error message. + * @returns {Promise} The member's info. + * @throws { EmptyResultError } When the member is not found. */ async function getMemberInfo(authorId, memberName) { - let member = await db.members.findOne({ where: { name: memberName, userid: authorId } }); - if (member) { - let member_info = `Member name: ${member.name}`; - member_info += member.displayname ? `\nDisplay name: ${member.displayname}` : '\nDisplay name: unset'; - member_info += member.proxy ? `\nProxy Tag: ${member.proxy}` : '\nProxy tag: unset'; - member_info += member.propic ? `\nProfile pic: ${member.propic}` : '\nProfile pic: unset'; - return member_info; - } - return enums.err.NO_MEMBER; + let member = await db.members.findOne({ where: { name: memberName, userid: authorId } }).catch(e => { + throw new EmptyResultError(`${enums.err.NO_MEMBER}: ${e.message}`); + }); + let member_info = `Member name: ${member.name}`; + member_info += member.displayname ? `\nDisplay name: ${member.displayname}` : '\nDisplay name: unset'; + member_info += member.proxy ? `\nProxy Tag: ${member.proxy}` : '\nProxy tag: unset'; + member_info += member.propic ? `\nProfile pic: ${member.propic}` : '\nProfile pic: unset'; + return member_info; } /** @@ -263,11 +264,12 @@ async function getMemberInfo(authorId, memberName) { * * @param {string} authorId - The author of the message. * @param {string} name - The member's name. - * @returns {Promise | Promise} The member object, or an error message. + * @returns {Promise} The member object. + * @throws { EmptyResultError } When the member is not found. */ mh.getMemberByName = async function(authorId, name) { return await db.members.findOne({ where: { userid: authorId, name: name } }).catch(e => { - return `${enums.err.NO_MEMBER}: ${e.message}`; + throw new EmptyResultError(`${enums.err.NO_MEMBER}: ${e.message}`); }); } @@ -276,11 +278,12 @@ mh.getMemberByName = async function(authorId, name) { * * @param {string} authorId - The author of the message * @param {string} proxy - The proxy tag - * @returns {Promise | Promise} The member object, or an error message. + * @returns {Promise} The member object. + * @throws { EmptyResultError } When the member is not found. */ mh.getMemberByProxy = async function(authorId, proxy) { return await db.members.findOne({ where: { userid: authorId, proxy: proxy } }).catch(e => { - return `${enums.err.NO_MEMBER}: ${e.message}`; + throw new EmptyResultError(`${enums.err.NO_MEMBER}: ${e.message}`); }); } @@ -288,12 +291,12 @@ mh.getMemberByProxy = async function(authorId, proxy) { * Gets all members belonging to the author. * * @param {string} authorId - The author of the message - * @returns {Promise | Promise} The member object, or an error message. + * @returns {Promise} The member object array. + * @throws { EmptyResultError } When no members are found. */ mh.getMembersByAuthor = async function(authorId) { return await db.members.findAll({ where: { userid: authorId } }).catch(e => { - // I have no idea how this could possibly happen but better safe than sorry - return `${enums.err.USER_NO_MEMBERS}: ${e.message}`; + throw new EmptyResultError(`${enums.err.USER_NO_MEMBERS}: ${e.message}`); }); } diff --git a/sequelize.js b/sequelize.js index 386bfc3..fd7bb75 100644 --- a/sequelize.js +++ b/sequelize.js @@ -48,7 +48,7 @@ database.check_connection = async function() { } async function syncModels() { - await sequelize.sync().then((result) => { + await sequelize.sync().then(() => { console.log('Models synced successfully.'); }).catch((err) => { console.error('Syncing models did not work', err);