Add error logging (#14)

vexuas · web-flow · commit bcb71a2ee33b · 2023-04-08T23:10:37.000+08:00
* Create send error helper

* Add commandname

* Install uuid

* Add uuid to error embed

* Add metadata to error log

* Edit reply of command with error

* Add error handling to relevant functions

* Log error to console
diff --git a/package.json b/package.json
@@ -18,12 +18,14 @@
     "lodash": "^4.17.21",
     "mixpanel": "^0.17.0",
     "pg": "^8.10.0",
-    "topgg-autoposter": "^2.0.1"
+    "topgg-autoposter": "^2.0.1",
+    "uuid": "^9.0.0"
   },
   "devDependencies": {
     "@types/jest": "^29.5.0",
     "@types/lodash": "^4.14.191",
     "@types/pg": "^8.6.6",
+    "@types/uuid": "^9.0.1",
     "auto": "^10.43.0",
     "eslint": "^8.36.0",
     "eslint-plugin-unused-imports": "^2.0.0",
diff --git a/src/App.ts b/src/App.ts
@@ -1,6 +1,7 @@
 import { Client, GatewayIntentBits } from 'discord.js';
 import { BOT_TOKEN } from './config/environment';
 import { registerEventHandlers } from './events/events';
+import { sendErrorLog } from './utils/helpers';
 
 const app: Client = new Client({
   intents: [GatewayIntentBits.Guilds],
@@ -11,7 +12,7 @@ const initialize = async (): Promise<void> => {
     await app.login(BOT_TOKEN);
     registerEventHandlers({ app });
   } catch (error) {
-    throw error;
+    sendErrorLog({ error });
   }
 };
 
diff --git a/src/commands/hello/index.ts b/src/commands/hello/index.ts
@@ -1,4 +1,5 @@
 import { SlashCommandBuilder } from 'discord.js';
+import { sendErrorLog } from '../../utils/helpers';
 import { AppCommand, AppCommandOptions } from '../commands';
 
 export default {
@@ -8,7 +9,7 @@ export default {
       await interaction.deferReply();
       await interaction.editReply('Hello!');
     } catch (error) {
-      console.log(error);
+      sendErrorLog({ error, interaction });
     }
   },
 } as AppCommand;
diff --git a/src/events/events.ts b/src/events/events.ts
@@ -2,6 +2,7 @@ import { Client } from 'discord.js';
 import fs from 'fs';
 import path from 'path';
 import { AppCommands, getApplicationCommands } from '../commands/commands';
+import { sendErrorLog } from '../utils/helpers';
 
 const appCommands = getApplicationCommands();
 
@@ -19,8 +20,7 @@ export function registerEventHandlers({ app }: Props): void {
   const loadModules = (directoryPath: string) => {
     fs.readdir(directoryPath, { withFileTypes: true }, (error, files) => {
       if (error) {
-        //TODO: Replace with error handling
-        console.log(error);
+        sendErrorLog({ error });
       }
       files &&
         files.forEach((file) => {
diff --git a/src/events/guildCreate/index.ts b/src/events/guildCreate/index.ts
@@ -2,7 +2,7 @@ import { Guild, WebhookClient } from 'discord.js';
 import { isEmpty } from 'lodash';
 import { GUILD_NOTIFICATION_WEBHOOK_URL, USE_DATABASE } from '../../config/environment';
 import { insertNewGuild } from '../../services/database';
-import { serverNotificationEmbed } from '../../utils/helpers';
+import { sendErrorLog, serverNotificationEmbed } from '../../utils/helpers';
 import { EventModule } from '../events';
 
 export default function ({ app }: EventModule) {
@@ -19,8 +19,7 @@ export default function ({ app }: EventModule) {
         });
       }
     } catch (error) {
-      //TODO: Add error handling
-      console.log(error);
+      sendErrorLog({ error });
     }
   });
 }
diff --git a/src/events/guildDelete/index.ts b/src/events/guildDelete/index.ts
@@ -2,7 +2,7 @@ import { Guild, WebhookClient } from 'discord.js';
 import { isEmpty } from 'lodash';
 import { GUILD_NOTIFICATION_WEBHOOK_URL, USE_DATABASE } from '../../config/environment';
 import { deleteGuild } from '../../services/database';
-import { serverNotificationEmbed } from '../../utils/helpers';
+import { sendErrorLog, serverNotificationEmbed } from '../../utils/helpers';
 import { EventModule } from '../events';
 
 export default function ({ app }: EventModule) {
@@ -19,8 +19,7 @@ export default function ({ app }: EventModule) {
         });
       }
     } catch (error) {
-      //TODO: Add error handling
-      console.log(error);
+      sendErrorLog({ error });
     }
   });
 }
diff --git a/src/events/interactionCreate/index.ts b/src/events/interactionCreate/index.ts
@@ -1,5 +1,6 @@
 import { CacheType, Interaction } from 'discord.js';
 import { AppCommands } from '../../commands/commands';
+import { sendErrorLog } from '../../utils/helpers';
 import { EventModule } from '../events';
 
 export default function ({ app, appCommands }: EventModule) {
@@ -13,9 +14,8 @@ export default function ({ app, appCommands }: EventModule) {
         command && (await command.execute({ interaction, app }));
       }
       //Maybe add buttons, selections and modal handlers here eventually
-    } catch (errors) {
-      //TODO: Add error handling
-      console.log(errors);
+    } catch (error) {
+      sendErrorLog({ error });
     }
   });
 }
diff --git a/src/events/ready/index.ts b/src/events/ready/index.ts
@@ -2,6 +2,7 @@ import { REST, Routes } from 'discord.js';
 import { AppCommands } from '../../commands/commands';
 import { BOT_TOKEN, ENV, GUILD_IDS, USE_DATABASE } from '../../config/environment';
 import { createGuildTable, populateGuilds } from '../../services/database';
+import { sendErrorLog } from '../../utils/helpers';
 import { EventModule } from '../events';
 
 const rest = new REST({ version: '9' }).setToken(BOT_TOKEN);
@@ -32,8 +33,7 @@ const registerApplicationCommands = async (commands?: AppCommands) => {
       console.log('Successfully registered global application commands');
     }
   } catch (error) {
-    //TODO: Add error handling
-    console.log(error);
+    sendErrorLog({ error });
   }
 };
 
diff --git a/src/services/database.ts b/src/services/database.ts
@@ -1,6 +1,7 @@
 import { Collection, Guild } from 'discord.js';
 import { Pool, PoolClient } from 'pg';
 import { databaseConfig } from '../config/database';
+import { sendErrorLog } from '../utils/helpers';
 const pool: Pool = new Pool(databaseConfig);
 
 type GuildRecord = {
@@ -21,8 +22,7 @@ export async function createGuildTable() {
       await client.query('COMMIT');
     } catch (error) {
       await client.query('ROLLBACK');
-      console.log(error);
-      //TODO: Add error handling
+      sendErrorLog({ error });
     } finally {
       client.release();
     }
@@ -38,8 +38,7 @@ export async function getGuilds() {
       return allGuilds;
     } catch (error) {
       await client.query('ROLLBACK');
-      console.log(error);
-      //TODO: Add error handling
+      sendErrorLog({ error });
     } finally {
       client.release();
     }
@@ -57,8 +56,7 @@ export async function populateGuilds(existingGuilds: Collection<string, Guild>)
       }
     });
   } catch (error) {
-    console.log(error);
-    //TODO: Add error handling
+    sendErrorLog({ error });
   }
 }
 export async function insertNewGuild(newGuild: Guild) {
@@ -77,8 +75,7 @@ export async function insertNewGuild(newGuild: Guild) {
       await client.query('COMMIT');
     } catch (error) {
       await client.query('ROLLBACK');
-      console.log(error);
-      //TODO: Add error handling
+      sendErrorLog({ error });
     } finally {
       client.release();
     }
@@ -94,7 +91,7 @@ export async function deleteGuild(existingGuild: Guild) {
       await client.query('COMMIT');
     } catch (error) {
       await client.query('ROLLBACK');
-      console.log(error);
+      sendErrorLog({ error });
     } finally {
       client.release();
     }
diff --git a/src/utils/helpers.ts b/src/utils/helpers.ts
@@ -1,4 +1,18 @@
-import { APIEmbed, Client, Guild } from 'discord.js';
+import {
+  APIEmbed,
+  Client,
+  CommandInteraction,
+  Guild,
+  GuildChannel,
+  WebhookClient,
+} from 'discord.js';
+import { capitalize, isEmpty } from 'lodash';
+import { ERROR_NOTIFICATION_WEBHOOK_URL } from '../config/environment';
+import { v4 as uuid } from 'uuid';
+
+export const codeMark = (text: string) => {
+  return '`' + text + '`';
+};
 
 export const serverNotificationEmbed = async ({
   app,
@@ -44,3 +58,71 @@ export const serverNotificationEmbed = async ({
   };
   return embed;
 };
+
+export const sendErrorLog = async ({
+  error,
+  interaction,
+}: {
+  error: any;
+  interaction?: CommandInteraction;
+}) => {
+  console.error(error);
+  const errorID = uuid();
+  if (interaction) {
+    const errorEmbed = {
+      description: `Oops something went wrong! D:\n\nError: ${
+        error.message ? codeMark(error.message) : codeMark('Unexpected Error')
+      }\nError ID: ${codeMark(errorID)}`,
+      color: 16711680,
+    };
+    await interaction.editReply({ embeds: [errorEmbed] });
+  }
+  if (ERROR_NOTIFICATION_WEBHOOK_URL && !isEmpty(ERROR_NOTIFICATION_WEBHOOK_URL)) {
+    const interactionChannel = interaction?.channel as GuildChannel | undefined;
+    const notificationEmbed: APIEmbed = {
+      title: interaction ? `Error | ${capitalize(interaction.commandName)} Command` : 'Error',
+      color: 16711680,
+      description: `uuid: ${errorID}\nError: ${error.message ? error.message : 'Unexpected Error'}`,
+      fields: interaction
+        ? [
+            {
+              name: 'User',
+              value: interaction.user.username,
+              inline: true,
+            },
+            {
+              name: 'User ID',
+              value: interaction.user.id,
+              inline: true,
+            },
+            {
+              name: 'Channel',
+              value: interactionChannel ? interactionChannel.name : '-',
+              inline: true,
+            },
+            {
+              name: 'Channel ID',
+              value: interaction.channelId,
+              inline: true,
+            },
+            {
+              name: 'Guild',
+              value: interaction.guild ? interaction.guild.name : '-',
+              inline: true,
+            },
+            {
+              name: 'Guild ID',
+              value: interaction.guildId ? interaction.guildId : '-',
+              inline: true,
+            },
+          ]
+        : undefined,
+    };
+    const notificationWebhook = new WebhookClient({ url: ERROR_NOTIFICATION_WEBHOOK_URL });
+    await notificationWebhook.send({
+      embeds: [notificationEmbed],
+      username: 'My App Error Notification',
+      avatarURL: '',
+    });
+  }
+};
diff --git a/yarn.lock b/yarn.lock
@@ -1101,6 +1101,11 @@
   resolved "https://registry.yarnpkg.com/@types/stack-utils/-/stack-utils-2.0.1.tgz#20f18294f797f2209b5f65c8e3b5c8e8261d127c"
   integrity sha512-Hl219/BT5fLAaz6NDkSuhzasy49dwQS/DSdu4MdggFB8zcXv7vflBI3xp7FEmkmdDkBUI2bPUNeMttp2knYdxw==
 
+"@types/uuid@^9.0.1":
+  version "9.0.1"
+  resolved "https://registry.yarnpkg.com/@types/uuid/-/uuid-9.0.1.tgz#98586dc36aee8dacc98cc396dbca8d0429647aa6"
+  integrity sha512-rFT3ak0/2trgvp4yYZo5iKFEPsET7vKydKF+VRCxlQ9bpheehyAJH89dAkaLEq/j/RZXJIqcgsmPJKUP1Z28HA==
+
 "@types/ws@^8.5.4":
   version "8.5.4"
   resolved "https://registry.yarnpkg.com/@types/ws/-/ws-8.5.4.tgz#bb10e36116d6e570dd943735f86c933c1587b8a5"
@@ -4014,6 +4019,11 @@ util-deprecate@^1.0.1:
   resolved "https://registry.yarnpkg.com/util-deprecate/-/util-deprecate-1.0.2.tgz#450d4dc9fa70de732762fbd2d4a28981419a0ccf"
   integrity sha512-EPD5q1uXyFxJpCrLnCc1nHnq3gOa6DZBocAIiI2TaSCA7VCJ1UJDMagCzIkXNsUYfD1daK//LTEQ8xiIbrHtcw==
 
+uuid@^9.0.0:
+  version "9.0.0"
+  resolved "https://registry.yarnpkg.com/uuid/-/uuid-9.0.0.tgz#592f550650024a38ceb0c562f2f6aa435761efb5"
+  integrity sha512-MXcSTerfPa4uqyzStbRoTgt5XIe3x5+42+q1sDuy3R5MDk66URdLMOZe5aPX/SQd+kuYAh0FdP/pO28IkQyTeg==
+
 v8-compile-cache-lib@^3.0.1:
   version "3.0.1"
   resolved "https://registry.yarnpkg.com/v8-compile-cache-lib/-/v8-compile-cache-lib-3.0.1.tgz#6336e8d71965cb3d35a1bbb7868445a7c05264bf"

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@ import { Guild, WebhookClient } from 'discord.js';`
`2`	`2`	`import { isEmpty } from 'lodash';`
`3`	`3`	`import { GUILD_NOTIFICATION_WEBHOOK_URL, USE_DATABASE } from '../../config/environment';`
`4`	`4`	`import { insertNewGuild } from '../../services/database';`
`5`		`-import { serverNotificationEmbed } from '../../utils/helpers';`
	`5`	`+import { sendErrorLog, serverNotificationEmbed } from '../../utils/helpers';`
`6`	`6`	`import { EventModule } from '../events';`
`7`	`7`
`8`	`8`	`export default function ({ app }: EventModule) {`
`@@ -19,8 +19,7 @@ export default function ({ app }: EventModule) {`
`19`	`19`	`});`
`20`	`20`	`}`
`21`	`21`	`} catch (error) {`
`22`		`- //TODO: Add error handling`
`23`		`- console.log(error);`
	`22`	`+ sendErrorLog({ error });`
`24`	`23`	`}`
`25`	`24`	`});`
`26`	`25`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`import { CacheType, Interaction } from 'discord.js';`
`2`	`2`	`import { AppCommands } from '../../commands/commands';`
	`3`	`+import { sendErrorLog } from '../../utils/helpers';`
`3`	`4`	`import { EventModule } from '../events';`
`4`	`5`
`5`	`6`	`export default function ({ app, appCommands }: EventModule) {`
`@@ -13,9 +14,8 @@ export default function ({ app, appCommands }: EventModule) {`
`13`	`14`	`command && (await command.execute({ interaction, app }));`
`14`	`15`	`}`
`15`	`16`	`//Maybe add buttons, selections and modal handlers here eventually`
`16`		`- } catch (errors) {`
`17`		`- //TODO: Add error handling`
`18`		`- console.log(errors);`
	`17`	`+ } catch (error) {`
	`18`	`+ sendErrorLog({ error });`
`19`	`19`	`}`
`20`	`20`	`});`
`21`	`21`	`}`