Merge pull request #84 from en3sis/feat/guildsPluginCache

feat: guild plugin cache, deps update, prepares messageReaction

.env.template

@@ -3,6 +3,7 @@ DISCORD_TOKEN=
 DISCORD_CLIENT_ID=
 
 SUPABASE_URL=
+SUPABASE_ANON_KEY=
 SUPABASE_SERVICE_ROL=
 
 #=========== 👾 BOT CONFIGURATION ===========#

package.json

@@ -1,6 +1,6 @@
 {
   "name": "hans",
-  "version": "v2.0.4",
+  "version": "v2.1.1",
   "description": "An open-source Discord bot built with Discord.JS & TypeScript",
   "author": "en3sis",
   "repository": {
@@ -11,7 +11,7 @@
   "main": "src/index.ts",
   "scripts": {
     "start": "node build/utils/deploy-commands.js && node build/index.js",
-    "dev": "docker-compose -f docker-compose.dev.yaml up -d &&ISDEV=true nodemon hans",
+    "dev": "docker-compose -f docker-compose.dev.yaml up -d && ISDEV=true nodemon hans",
     "build": "tsc --project ./",
     "types:local": "supabase gen types typescript --local --schema public > src/types/database.types.ts",
     "build_dev": "rm -rf ./build && tsc --project ./",
@@ -25,21 +25,21 @@
   "devDependencies": {
     "@discordjs/rest": "^2.0.1",
     "@jest/globals": "^29.7.0",
-    "@types/jest": "^29.5.4",
-    "@types/lodash": "^4.14.184",
-    "@types/node": "^20.5.9",
-    "@types/node-cron": "^3.0.4",
-    "@types/sentiment": "^5.0.1",
-    "@types/ws": "^8.5.3",
+    "@types/jest": "^29.5.12",
+    "@types/lodash": "^4.14.202",
+    "@types/node": "^20.11.17",
+    "@types/node-cron": "^3.0.11",
+    "@types/sentiment": "^5.0.4",
+    "@types/ws": "^8.5.10",
     "@typescript-eslint/eslint-plugin": "^6.5.0",
     "@typescript-eslint/parser": "^6.5.0",
     "eslint": "^8.48.0",
     "eslint-config-prettier": "^9.0.0",
     "husky": "^8.0.1",
     "jest": "^29.7.0",
-    "nodemon": "^3.0.1",
+    "nodemon": "^3.0.3",
     "prettier": "^3.0.3",
-    "ts-node": "^10.9.1",
+    "ts-node": "^10.9.2",
     "tslib": "^2.6.2",
     "typescript": "^5.2.2"
   },

src/controllers/bot/guilds.controller.ts

@@ -46,6 +46,7 @@ export const insertAllGuilds = async (Hans: Client) => {
       })
       .select()
 
+    // Set the guild plugins to the default values.
     if (data)
       guilds.forEach(async (guild) => {
         try {
@@ -59,7 +60,8 @@ export const insertAllGuilds = async (Hans: Client) => {
       throw error
     }
 
-    console.log(`🪯  Initial ${data.length} guilds inserted/updated`)
+    console.info(`🪯  Initial ${data.length} guilds inserted/updated`)
+
     return data
   } catch (error) {
     console.error('❌ ERROR: insertAllGuilds(): ', error)

src/controllers/bot/plugins.controller.ts

@@ -1,4 +1,5 @@
 import { CommandInteraction } from 'discord.js'
+import { getFromCache, setToCache } from '../../libs/node-cache'
 import supabase from '../../libs/supabase'
 import { initialGuildPluginState, pluginsList } from '../../models/plugins.model'
 import {
@@ -82,6 +83,13 @@ export const resolveGuildPlugins = async (
   pluginName: string,
 ): Promise<GuildPluginData> => {
   try {
+    // Return the cached data if it exists
+    const cachedData = getFromCache(`guilds_plugins:${guild_id}:${pluginName}`)
+
+    if (cachedData) {
+      return cachedData as GuildPluginData
+    }
+
     const { data: guildPluginResult } = await supabase
       .from('guilds')
       .select('*, guilds_plugins(*, plugins(enabled, description, premium, name))')
@@ -93,15 +101,19 @@ export const resolveGuildPlugins = async (
     const guildPlugin = guildPluginResult?.guilds_plugins.find(
       (ele: GuildPlugin) => ele.name === pluginName,
     )
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const globalPluginSettings: Record<string, any> = guildPlugin?.plugins
 
-    const botPlugin: Record<string, any> = guildPlugin?.plugins
-
-    if (guildPlugin && guildPlugin.enabled && botPlugin.enabled) {
-      return {
+    if (guildPlugin && guildPlugin.enabled && globalPluginSettings.enabled) {
+      const pluginData = {
         enabled: guildPlugin?.enabled || false,
         metadata: JSON.parse(JSON.stringify(guildPlugin?.metadata)),
         data: guildPlugin,
       }
+
+      setToCache(`guilds_plugins:${guild_id}:${pluginName}`, pluginData, 60 * 5)
+
+      return pluginData
     } else {
       return {
         enabled: false,
@@ -160,7 +172,7 @@ export const updateMetadataGuildPlugin = async (metadata: any, name: string, gui
  * Returns an array of plugin names and values for use in a select menu.
  * @returns {Array<{name: string, value: string}>} - An array of plugin names and values.
  */
-export const pluginsListNames = () => {
+export const pluginsListNames = (): Array<{ name: string; value: string }> => {
   return Object.entries(pluginsList).reduce((acc, [key]) => {
     return [...acc, { name: key, value: key }]
   }, [])
@@ -210,11 +222,9 @@ export const pluginChatGPTSettings = async (
 
 // =+=+=+ Threads Plugin =+=+=+
 
-/**
- * Updates the metadata for the "threads" plugin in the database for the current guild.
+/** Updates the metadata for the "threads" plugin in the database for the current guild.
  * @param {PluginsThreadsSettings} options - The options object containing the interaction and metadata.
  */
-
 export const pluginThreadsSettings = async ({ interaction, metadata }: PluginsThreadsSettings) => {
   try {
     const { data: guildsPlugins, error } = await supabase

src/events/messageCreate.ts

@@ -8,8 +8,6 @@ module.exports = {
   async execute(Hans: Client, message: Message) {
     try {
       if (message.author.bot) return
-      // const args = message.content.slice(1).trim().split(/ +/g)
-      // const command = args.shift().toLowerCase()
 
       // Server outage
       if (!message.guild?.available) return
@@ -24,9 +22,14 @@ module.exports = {
       // +=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=+
       // ==-=-=-=-=-=-=-=-=             DEVELOPMENT                    =-=-=-=-=-=-=-= +
       // +=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=+
-      // Uncomment for development and do your tests/debug there, !!!DON'T COMMIT!!!
-      // TODO: Requires refactor, find a way to dynamically load the file if in development
-      // _messageCreate(Hans, message, command, args)
+      // INFO: This is a development feature that allows to run commands without the need of a bot slash command, it will only work in development mode and it will try to run the command from the messageCreate.ts file. Make sure you duplicate and rename messageCreate.template.ts file.
+      if (!!process.env.ISDEV) {
+        const args = message.content.slice(1).trim().split(/ +/g)
+        const command = args.shift().toLowerCase()
+
+        const module = await import('../controllers/_development/messageCreate')
+        module.default(Hans, message, command, args)
+      }
     } catch (error) {
       console.log('❌ messageCreate(): ', error)
     }

src/events/messageReactionAdd.ts

@@ -1,8 +1,8 @@
 import { Client, GuildMember, MessageReaction } from 'discord.js'
 
 module.exports = {
-  name: 'ready',
-  once: true,
+  name: 'messageReactionAdd',
+  once: false,
   enabled: false,
   async execute(Hans: Client, reaction: MessageReaction, member: GuildMember) {
     if (reaction.partial) {
@@ -15,6 +15,8 @@ module.exports = {
         return
       }
     }
+
+    // TODO @en3sis: Implement the messageReactionAdd event
     console.log('', {
       reaction,
       member,

src/events/messageReactionRemove.ts

@@ -0,0 +1,26 @@
+import { Client, GuildMember, MessageReaction } from 'discord.js'
+
+module.exports = {
+  name: 'messageReactionRemove',
+  once: false,
+  enabled: false,
+  async execute(Hans: Client, reaction: MessageReaction, member: GuildMember) {
+    if (reaction.partial) {
+      // If the message this reaction belongs to was removed, the fetching might result in an API error which should be handled
+      try {
+        await reaction.fetch()
+      } catch (error) {
+        console.error('Something went wrong when fetching the message:', error)
+        // Return as `reaction.message.author` may be undefined/null
+        return
+      }
+    }
+
+    // TODO @en3sis: Implement the messageReactionAdd event
+    console.log('💢', {
+      reaction,
+      foo: reaction.emoji.id,
+      member,
+    })
+  },
+}

src/index.ts

@@ -19,7 +19,9 @@ export const Hans = new Client({
   intents: [
     GatewayIntentBits.Guilds,
     GatewayIntentBits.GuildMessages,
+    GatewayIntentBits.GuildMessageReactions,
     GatewayIntentBits.GuildMembers,
+    GatewayIntentBits.MessageContent,
   ],
   partials: [Partials.Message, Partials.Channel, Partials.Reaction],
 })

src/realtime/presence.realtime.ts

@@ -1,8 +1,10 @@
 import { setPresence } from '../controllers/bot/config.controller'
+import { deleteFromCache } from '../libs/node-cache'
 import supabase from '../libs/supabase'
 
 export const configsRealtime = () => {
-  return supabase
+  // Listen for changes in the configs table
+  supabase
     .channel('table-db-changes')
     .on(
       'postgres_changes',
@@ -16,4 +18,20 @@ export const configsRealtime = () => {
       },
     )
     .subscribe()
+
+  // Listen for changes in the guilds plugins table and delete the cached data
+  supabase
+    .channel('table-db-changes')
+    .on(
+      'postgres_changes',
+      {
+        event: 'UPDATE',
+        schema: 'public',
+        table: 'guilds_plugins',
+      },
+      async (payload) => {
+        deleteFromCache(`guildPlugins:${payload.new.owner}:${payload.new.name}`)
+      },
+    )
+    .subscribe()
 }