docs: added error handling design rules

Author: GalvinPython

README.md

@@ -46,6 +46,31 @@ Feedr requires Bun in order to work
 2. Fill out all the required values in `.env.example` and rename it to `.env` once done
 3. To run in developer mode, just run `bun --watch . --dev`, otherwise `bun run .`
 
+## Design Rules
+
+These rules are what to follow when working and developing on Feedr. There aren't a lot, but important for error handling.
+
+### Database Function Return Guidelines
+
+Each database function should **always** return a success indicator (`true`/`false`) along with associated data. To avoid confusion, here are the expected return types:
+
+- **Success with data:** `true` should always return populated data, even if the data is not used. For example:
+    ```ts
+    return { success: true, data: Data as Data };
+    ```
+
+- **Success without data:** `true` can also indicate a successful operation where no data is returned. In this case, an empty array (`[]`) should be provided:
+    ```ts
+    return { success: true, data: [] };
+    ```
+
+- **Failure:** `false` should indicate an error or unsuccessful operation. This should always return an empty array (`[]`) to ensure consistency:
+    ```ts
+    return { success: false, data: [] };
+    ```
+
+These guidelines ensure predictable behavior and simplify error handling across the application.
+
 # Changelog
 
 ## 1.4.0

src/commands.ts

@@ -16,7 +16,6 @@ import { PermissionFlagsBits } from "discord-api-types/v8";
 import checkIfChannelIdIsValid from "./utils/youtube/checkIfChannelIdIsValid";
 import {
     addNewGuildToTrackChannel,
-    checkIfGuildIsTrackingChannelAlready,
     getAllTrackedInGuild,
     stopGuildTrackingChannel,
     twitchAddNewChannelToTrack,
@@ -32,6 +31,8 @@ import {
     addNewChannelToTrack,
 } from "./utils/db/youtube";
 import search from "./utils/youtube/search";
+import { checkIfGuildIsTrackingUserAlready } from "./utils/db/discord";
+import { Platform } from "./types/types.d";
 
 import client from ".";
 
@@ -363,13 +364,15 @@ const commands: Record<string, Command> = {
                     }
 
                     const trackedChannels =
-                        await checkIfGuildIsTrackingChannelAlready(
+                        await checkIfGuildIsTrackingUserAlready(
+                            Platform.YouTube,
                             platformUserId,
                             guildId,
                         );
 
                     // Check if the channel is already being tracked in the guild
-                    if (trackedChannels.length) {
+                    console.log(trackedChannels);
+                    if (trackedChannels) {
                         await interaction.reply({
                             flags: MessageFlags.Ephemeral,
                             content: `This channel is already being tracked in ${trackedChannels.map((channel, index) => `${index > 0 && index === trackedChannels.length - 1 ? "and " : ""}<#${channel.guild_channel_id}>`).join(", ")}!`,
@@ -434,7 +437,7 @@ const commands: Record<string, Command> = {
                     }
 
                     const trackedChannels =
-                        await checkIfGuildIsTrackingChannelAlready(
+                        await checkIfGuildIsTrackingUserAlready(
                             platformUserId,
                             guildId,
                         );
@@ -624,7 +627,7 @@ const commands: Record<string, Command> = {
                 case "youtube":
                     // Check if the channel is not being tracked in the guild
                     if (
-                        !(await checkIfGuildIsTrackingChannelAlready(
+                        !(await checkIfGuildIsTrackingUserAlready(
                             youtubeChannelId,
                             guildId,
                         ))
@@ -673,7 +676,7 @@ const commands: Record<string, Command> = {
 
                     // check if the channel is not being tracked in the guild
                     if (
-                        !(await checkIfGuildIsTrackingChannelAlready(
+                        !(await checkIfGuildIsTrackingUserAlready(
                             streamerId,
                             guildId,
                         ))

src/utils/database.ts

@@ -27,26 +27,6 @@ export const pool: Pool = new Pool({
 });
 
 // #region YouTube
-export async function checkIfGuildIsTrackingChannelAlready(
-    channelId: string,
-    guild_id: string,
-): Promise<dbDiscordTable[]> {
-    const query = `SELECT * FROM discord WHERE platform_user_id = ? AND guild_id = ?`;
-
-    try {
-        const statement = db.prepare(query);
-        const result = statement.all(channelId, guild_id);
-
-        return result;
-    } catch (err) {
-        console.error(
-            "Error checking if guild is tracking channel already:",
-            err,
-        );
-        throw err;
-    }
-}
-
 export async function addNewGuildToTrackChannel(
     guild_id: string,
     channelId: string,

src/utils/db/audit.ts

@@ -0,0 +1,18 @@
+export enum AuditResolution {
+    AUDIT_RESOLUTION_FAIL = "fail",
+    AUDIT_RESOLUTION_SUCCESS = "success",
+    AUDIT_RESOLUTION_ERROR = "error",
+    AUDIT_RESOLUTION_NULL = "null",
+}
+
+export enum AuditType {
+    GUILD_CHECKED_YOUTUBE_CHANNEL = "guild_checked_youtube_channel",
+}
+
+export async function addAuditEntry(
+    type: AuditType,
+    resolution: AuditResolution,
+) {
+    console.log("Adding audit entry:", type, resolution);
+    throw new Error("Not implemented");
+}

src/utils/db/discord.ts

@@ -1,11 +1,11 @@
-import { Platform } from "../../types/types";
+import { Platform } from "../../types/types.d";
 import { pool } from "../database";
 
 export async function checkIfGuildIsTrackingUserAlready(
     platform: Platform,
     userId: string,
     guildId: string,
-): Promise<boolean> {
+): Promise<{ success: boolean; data: any[] | null }> {
     console.log(
         `Checking if guild ${guildId} is tracking user ${userId} on platform ${platform}`,
     );
@@ -15,19 +15,19 @@ export async function checkIfGuildIsTrackingUserAlready(
     if (platform === Platform.YouTube) {
         query = `
             SELECT * FROM guild_youtube_subscriptions
-            WHERE youtube_channel_id = ? AND guild_id = ?
+            WHERE youtube_channel_id = $1 AND guild_id = $2
         `;
     } else if (platform === Platform.Twitch) {
         query = `
             SELECT * FROM guild_twitch_subscriptions
-            WHERE twitch_user_id = ? AND guild_id = ?
+            WHERE twitch_user_id = $1 AND guild_id = $2
         `;
     }
 
     if (!query) {
         console.error("Invalid platform provided for tracking check.");
 
-        return false;
+        return { success: false, data: null };
     }
 
     try {
@@ -36,10 +36,14 @@ export async function checkIfGuildIsTrackingUserAlready(
 
         client.release();
 
-        return result.rows.length > 0;
+        if (result.rows.length > 0) {
+            return { success: true, data: result.rows };
+        } else {
+            return { success: false, data: null };
+        }
     } catch (error) {
         console.error("Error checking if guild is tracking user:", error);
 
-        return false;
+        return { success: false, data: null };
     }
 }