Channel/Thread Chat Toggle (#75)

* Add: Some Commands work in GuildText

* Add: Channel Toggle Command

* Add: Channel History handler by user

* Update: version increment

* Update: Testing scope

* Update: env sample

* Update: Readme goal checks

* Update: builds run on PR to validate them

.env.sample

@@ -10,11 +10,11 @@ MODEL = MODEL_NAME
 # discord bot user id for mentions
 CLIENT_UID = BOT_USER_ID
 
-# ip/port address of docker container, I use 172.18.X.X for docker, 127.0.0.1 for local
+# ip/port address of docker container, I use 172.18.0.3 for docker, 127.0.0.1 for local
 OLLAMA_IP = IP_ADDRESS
 OLLAMA_PORT = PORT
 
-# ip address for discord bot container, I use 172.18.X.X, use different IP than ollama_ip
+# ip address for discord bot container, I use 172.18.0.2, use different IP than ollama_ip
 DISCORD_IP = IP_ADDRESS
 
 # subnet address, ex. 172.18.0.0 as we use /16.

.github/workflows/build.yml

@@ -1,9 +1,18 @@
 name: Builds
 run-name: Validate Node and Docker Builds
 on:
-  push:
+  pull_request:
     branches:
       - master
+    paths:
+      - '/'
+      - '!docs/**'
+      - '!imgs/**'
+      - '!.github/**'
+      - '.github/workflows/**'
+      - '!.gitignore'
+      - '!LICENSE'
+      - '!README'
 
 jobs:
   Discord-Node-Build: # test if the node install and run
@@ -13,10 +22,10 @@ jobs:
       - name: Checkout Repository
         uses: actions/checkout@v4
 
-      - name: Set up Node Environment v18.18.2
+      - name: Set up Node Environment lts/hydrogen
         uses: actions/setup-node@v4
         with:
-          node-version: 18.18.2
+          node-version: lts/hydrogen
           cache: "npm"
 
       - name: Install Project Dependencies
@@ -50,10 +59,10 @@ jobs:
       - name: Checkout Repository
         uses: actions/checkout@v4
 
-      - name: Set up Node Environment v18.18.2
+      - name: Set up Node Environment lts/hydrogen
         uses: actions/setup-node@v4
         with:
-          node-version: 18.18.2
+          node-version: lts/hydrogen
           cache: "npm"
 
       - name: Create Environment Variables

.github/workflows/test.yml

@@ -4,6 +4,15 @@ on:
   pull_request:
     branches:
       - master
+    paths:
+      - '/'
+      - '!docs/**'
+      - '!imgs/**'
+      - '!.github/**'
+      - '.github/workflows/**'
+      - '!.gitignore'
+      - '!LICENSE'
+      - '!README'
 
 jobs:
   Discord-Node-Test:
@@ -13,10 +22,10 @@ jobs:
       - name: Checkout Repository
         uses: actions/checkout@v4
 
-      - name: Set up Node Environment v18.18.2
+      - name: Set up Node Environment lts/hydrogen
         uses: actions/setup-node@v4
         with:
-          node-version: 18.18.2
+          node-version: lts/hydrogen
           cache: "npm"
 
       - name: Install Project Dependencies
@@ -44,10 +53,10 @@ jobs:
       - name: Checkout Repository
         uses: actions/checkout@v4
 
-      - name: Set up Node Environment v18.18.2
+      - name: Set up Node Environment lts/hydrogen
         uses: actions/setup-node@v4
         with:
-          node-version: 18.18.2
+          node-version: lts/hydrogen
           cache: "npm"
 
       - name: Create Environment Variables

Dockerfile

@@ -1,5 +1,5 @@
 # use node LTS image for version 18
-FROM node:18.18.2
+FROM node:hydrogen-alpine
 
 # set working directory inside container
 WORKDIR /app

README.md

@@ -13,10 +13,12 @@ Ollama is an AI model management tool that allows users to install and use custo
 The project aims to:
 * [x] Create a Discord bot that will utilize Ollama and chat to chat with users! 
   * [ ] User Preferences on Chat
-  * [ ] Message Persistance on Channels and Threads
+  * [x] Message Persistance on Channels and Threads
+    * [x] Threads
+    * [x] Channels
   * [x] Containerization with Docker
   * [x] Slash Commands Compatible
-  * [x] Generated Token Length Handling for >2000 ~~or >6000 characters~~
+  * [x] Generated Token Length Handling for >2000
     * [x] Token Length Handling of any message size
   * [ ] External WebUI Integration
   * [x] Administrator Role Compatible
@@ -28,20 +30,29 @@ The project aims to:
 * Clone this repo using `git clone https://github.com/kevinthedang/discord-ollama.git` or just use [GitHub Desktop](https://desktop.github.com/) to clone the repo.
 * You will need a `.env` file in the root of the project directory with the bot's token. There is a `.env.sample` is provided for you as a reference for what environment variables.
     * For example, `CLIENT_TOKEN = [Bot Token]`
-* Please refer to the docs for bot setup. **NOTE**: These guides assume you already know how to setup a bot account for discord.
+* Please refer to the docs for bot setup.
     * [Local Machine Setup](./docs/setup-local.md)
     * [Docker Setup for Servers and Local Machines](./docs/setup-docker.md)
         * Local use is not recommended.
 
+> [!NOTE]
+> These guides assume you already know how to setup a bot account for discord. Documentation will be added later.
+
 ## Resources
 * [NodeJS](https://nodejs.org/en)
     * This project uses `v20.10.0+` (npm `10.2.5`). Consider using [nvm](https://github.com/nvm-sh/nvm) for multiple NodeJS versions.
-        * To run dev in `ts-node`, using `v18.18.2` is recommended. **CAUTION**: `v18.19.0` or `lts/hydrogen` will not run properly.
+        * To run dev in `ts-node`, using `v18.18.2` is recommended. 
         * To run dev with `tsx`, you can use `v20.10.0` or earlier.
     * This project supports any NodeJS version above `16.x.x` to only allow ESModules.
 * [Ollama](https://ollama.ai/)
     * [Ollama Docker Image](https://hub.docker.com/r/ollama/ollama)
-    * **IMPORTANT**: For Nvidia GPU setup, **install** `nvidia container toolkit/runtime` then **configure** it with Docker to utilize Nvidia driver.
+
+> [!NOTE]
+> For Nvidia GPU setup, **install** `nvidia container toolkit/runtime` then **configure** it with Docker to utilize Nvidia driver.
+
+> [!CAUTION]
+> `v18.X.X` or `lts/hydrogen` will not run properly for `npm run dev-mon`.
+
 * [Discord Developer Portal](https://discord.com/developers/docs/intro)
 * [Discord.js Docs](https://discord.js.org/docs/packages/discord.js/main)
 * [Setting up Docker (Ubuntu 20.04)](https://www.digitalocean.com/community/tutorials/how-to-install-and-use-docker-on-ubuntu-20-04)

docker-compose.yml

@@ -8,7 +8,7 @@ services:
     build: ./                     # find docker file in designated path
     container_name: discord
     restart: always               # rebuild container always
-    image: discord/bot:0.5.1
+    image: discord/bot:0.5.2
     environment:
       CLIENT_TOKEN: ${CLIENT_TOKEN}
       GUILD_ID: ${GUILD_ID}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "discord-ollama",
-  "version": "0.5.1",
+  "version": "0.5.2",
   "description": "Ollama Integration into discord",
   "main": "build/index.js",
   "exports": "./build/index.js",
@@ -16,7 +16,7 @@
     "start": "docker compose build --no-cache && docker compose up -d",
     "docker:start": "npm run docker:network && npm run docker:build && npm run docker:client && npm run docker:ollama",
     "docker:start-cpu": "npm run docker:network && npm run docker:build && npm run docker:client && npm run docker:ollama-cpu",
-    "docker:clean": "docker rmi $(docker images --filter \"dangling=true\" -q --no-trunc)",
+    "docker:clean": "docker rm -f discord && docker rm -f ollama && docker rmi $(docker images --filter \"dangling=true\" -q --no-trunc)",
     "docker:network": "docker network create --subnet=172.18.0.0/16 ollama-net",
     "docker:build": "docker build --no-cache -t discord/bot:$(node -p \"require('./package.json').version\") .",
     "docker:test": "docker run -d --rm -v discord:/src/app --name test discord/bot:$(node -p \"require('./package.json').version\") npm run test:run",
@@ -27,17 +27,17 @@
   "author": "Kevin Dang",
   "license": "ISC",
   "dependencies": {
-    "discord.js": "^14.14.1",
-    "dotenv": "^16.3.1",
-    "ollama": "^0.5.0"
+    "discord.js": "^14.15.3",
+    "dotenv": "^16.4.5",
+    "ollama": "^0.5.2"
   },
   "devDependencies": {
-    "@types/node": "^20.10.5",
+    "@types/node": "^20.14.2",
     "@vitest/coverage-v8": "^1.6.0",
-    "nodemon": "^3.0.2",
+    "nodemon": "^3.1.3",
     "ts-node": "^10.9.2",
-    "tsx": "^4.6.2",
-    "typescript": "^5.3.3",
+    "tsx": "^4.15.5",
+    "typescript": "^5.4.5",
     "vitest": "^1.6.0"
   },
   "type": "module",

src/commands/capacity.ts

@@ -20,7 +20,7 @@ export const Capacity: SlashCommand = {
     run: async (client: Client, interaction: CommandInteraction) => {
         // fetch channel and message
         const channel = await client.channels.fetch(interaction.channelId)
-        if (!channel || channel.type !== ChannelType.PublicThread) return
+        if (!channel || channel.type !== (ChannelType.PublicThread && ChannelType.GuildText)) return
 
         // set state of bot chat features
         openConfig('config.json', interaction.commandName, interaction.options.get('context-capacity')?.value)

src/commands/channelToggle.ts

@@ -0,0 +1,34 @@
+import { ApplicationCommandOptionType, ChannelType, Client, CommandInteraction } from 'discord.js'
+import { SlashCommand } from '../utils/commands.js'
+import { openConfig } from '../utils/jsonHandler.js'
+
+export const ChannelToggle: SlashCommand = {
+    name: 'channel-toggle',
+    description: 'toggles channel or thread usage.',
+
+    // set user option for toggling
+    options: [
+        {
+            name: 'toggle-channel',
+            description: 'toggle channel usage, otherwise threads',
+            type: ApplicationCommandOptionType.Boolean,
+            required: true
+        }
+    ],
+
+    // Query for chatting preference
+    run: async (client: Client, interaction: CommandInteraction) => {
+        // fetch channel location
+        const channel = await client.channels.fetch(interaction.channelId)
+        if (!channel || channel.type !== (ChannelType.PublicThread && ChannelType.GuildText)) return
+
+
+        // set state of bot channel preferences
+        openConfig('config.json', interaction.commandName, interaction.options.get('toggle-channel')?.value)
+
+        interaction.reply({
+            content: `Channel Preferences have for Regular Channels set to \`${interaction.options.get('toggle-channel')?.value}\``,
+            ephemeral: true
+        })
+    }
+}

src/commands/index.ts

@@ -6,6 +6,7 @@ import { Disable } from './disable.js'
 import { Shutoff } from './shutoff.js'
 import { Capacity } from './capacity.js'
 import { PrivateThreadCreate } from './threadPrivateCreate.js'
+import { ChannelToggle } from './channelToggle.js'
 
 export default [
     ThreadCreate,
@@ -14,5 +15,6 @@ export default [
     MessageStream,
     Disable,
     Shutoff,
-    Capacity
+    Capacity,
+    ChannelToggle
 ] as SlashCommand[]

src/commands/messageStream.ts

@@ -20,13 +20,13 @@ export const MessageStream: SlashCommand = {
     run: async (client: Client, interaction: CommandInteraction) => {
         // verify channel
         const channel = await client.channels.fetch(interaction.channelId)
-        if (!channel || channel.type !== ChannelType.PublicThread) return
+        if (!channel || channel.type !== (ChannelType.PublicThread && ChannelType.GuildText)) return
 
         // save value to json and write to it
         openConfig('config.json', interaction.commandName, interaction.options.get('stream')?.value)
 
         interaction.reply({
-            content: `Message streaming preferences for embed set to: \`${interaction.options.get('stream')?.value}\``,
+            content: `Message streaming preferences set to: \`${interaction.options.get('stream')?.value}\``,
             ephemeral: true
         })
     }

src/commands/messageStyle.ts

@@ -20,7 +20,7 @@ export const MessageStyle: SlashCommand = {
     run: async (client: Client, interaction: CommandInteraction) => {
         // fetch channel and message
         const channel = await client.channels.fetch(interaction.channelId)
-        if (!channel || channel.type !== ChannelType.PublicThread) return
+        if (!channel || channel.type !== (ChannelType.PublicThread && ChannelType.GuildText)) return
 
         // set the message style
         openConfig('config.json', interaction.commandName, interaction.options.get('embed')?.value)

src/events/messageCreate.ts

@@ -1,7 +1,7 @@
 import { embedMessage, event, Events, normalMessage, UserMessage } from '../utils/index.js'
-import { Configuration, getConfig, getThread, openConfig, openThreadInfo } from '../utils/jsonHandler.js'
+import { Configuration, getChannelInfo, getConfig, getThread, openChannelInfo, openConfig, openThreadInfo } from '../utils/jsonHandler.js'
 import { clean } from '../utils/mentionClean.js'
-import { ThreadChannel } from 'discord.js'
+import { TextChannel, ThreadChannel } from 'discord.js'
 
 /** 
  * Max Message length for free users is 2000 characters (bot or not).
@@ -10,17 +10,6 @@ import { ThreadChannel } from 'discord.js'
 export default event(Events.MessageCreate, async ({ log, msgHist, tokens, ollama, client }, message) => {
     log(`Message \"${clean(message.content)}\" from ${message.author.tag} in channel/thread ${message.channelId}.`)
 
-    // need new check for "open/active" threads here!
-    const threadMessages: UserMessage[] = await new Promise((resolve) => {
-        // set new queue to modify
-        getThread(`${message.channelId}.json`, (threadInfo) => {
-            if (threadInfo?.messages)
-                resolve(threadInfo.messages)
-            else
-                log(`Channel/Thread ${message.channelId} does not exist.`)
-        }) 
-    })
-
     // Do not respond if bot talks in the chat
     if (message.author.tag === message.client.user.tag) return
 
@@ -45,6 +34,14 @@ export default event(Events.MessageCreate, async ({ log, msgHist, tokens, ollama
                     return
                 }
 
+                // ensure channel json exists, if not create it
+                if (config.options['channel-toggle']) {
+                    openChannelInfo(message.channelId,
+                        message.channel as TextChannel, 
+                        message.author.tag
+                    )
+                }
+
                 // check if there is a set capacity in config
                 if (typeof config.options['modify-capacity'] !== 'number')
                     log(`Capacity is undefined, using default capacity of ${msgHist.capacity}.`)
@@ -62,11 +59,31 @@ export default event(Events.MessageCreate, async ({ log, msgHist, tokens, ollama
             })
         })
 
+        // need new check for "open/active" threads/channels here!
+        const chatMessages: UserMessage[] = await new Promise((resolve) => {
+            // set new queue to modify
+            if (config.options['channel-toggle']) {
+                getChannelInfo(`${message.channelId}-${message.author.tag}.json`, (channelInfo) => {
+                    if (channelInfo?.messages)
+                        resolve(channelInfo.messages)
+                    else
+                        log(`Channel ${message.channel}-${message.author.tag} does not exist.`)
+                })
+            } else {
+                getThread(`${message.channelId}.json`, (threadInfo) => {
+                    if (threadInfo?.messages)
+                        resolve(threadInfo.messages)
+                    else
+                        log(`Thread ${message.channelId} does not exist.`)
+                }) 
+            }
+        })
+
         // response string for ollama to put its response
         let response: string
 
         // set up new queue
-        msgHist.setQueue(threadMessages)
+        msgHist.setQueue(chatMessages)
 
         // check if we can push, if not, remove oldest
         while (msgHist.size() >= msgHist.capacity) msgHist.dequeue()
@@ -96,10 +113,18 @@ export default event(Events.MessageCreate, async ({ log, msgHist, tokens, ollama
         })
 
         // only update the json on success
-        openThreadInfo(`${message.channelId}.json`, 
-            client.channels.fetch(message.channelId) as unknown as ThreadChannel, 
-            msgHist.getItems()
-        )
+        if (config.options['channel-toggle']) {
+            openChannelInfo(message.channelId, 
+                message.channel as TextChannel, 
+                message.author.tag, 
+                msgHist.getItems()
+            )
+        } else {
+            openThreadInfo(`${message.channelId}.json`, 
+                client.channels.fetch(message.channelId) as unknown as ThreadChannel, 
+                msgHist.getItems()
+            )
+        }
     } catch (error: any) {
         msgHist.pop() // remove message because of failure
         openConfig('config.json', 'message-style', false)

src/utils/jsonHandler.ts

@@ -1,4 +1,4 @@
-import { ThreadChannel } from 'discord.js'
+import { TextChannel, ThreadChannel } from 'discord.js'
 import { UserMessage } from './events.js'
 import fs from 'fs'
 import path from 'path'
@@ -9,7 +9,8 @@ export interface Configuration {
         'message-stream'?: boolean,
         'message-style'?: boolean,
         'toggle-chat'?: boolean,
-        'modify-capacity'?: number
+        'modify-capacity'?: number,
+        'channel-toggle'?: boolean
     }
 }
 
@@ -19,6 +20,13 @@ export interface Thread {
     messages: UserMessage[]
 }
 
+export interface Channel {
+    readonly id: string
+    readonly name: string
+    readonly user: string
+    messages: UserMessage[]
+}
+
 /**
  * Method to open a file in the working directory and modify/create it
  * 
@@ -85,7 +93,7 @@ export function openThreadInfo(filename: string, thread: ThreadChannel, messages
     if (fs.existsSync(fullFileName)) {
         fs.readFile(fullFileName, 'utf8', (error, data) => {
             if (error)
-                console.log(`[Error: openConfig] Incorrect file format`)
+                console.log(`[Error: openThreadInfo] Incorrect file format`)
             else {
                 const object = JSON.parse(data)
                 object['messages'] = messages as []
@@ -125,4 +133,74 @@ export async function getThread(filename: string, callback: (config: Thread | un
     } else {
         callback(undefined) // file not found
     }
+}
+
+/**
+ * Method to open the channel history
+ * 
+ * @param filename name of the json file for the channel by user
+ * @param channel the text channel info
+ * @param user the user's name
+ * @param messages their messages
+ */
+export async function openChannelInfo(filename: string, channel: TextChannel, user: string, messages: UserMessage[] = []): Promise<void> {
+    // thread exist handler
+    const isThread: boolean = await new Promise((resolve) => {
+        getThread(`${channel.id}.json`, (threadInfo) => {
+            if (threadInfo?.messages)
+                resolve(true)
+            else
+                resolve(false)
+        })
+    })
+
+    // This is an existing thread, don't create another json
+    if (isThread) return
+
+    const fullFileName = `data/${filename}-${user}.json`
+    if (fs.existsSync(fullFileName)) {
+        fs.readFile(fullFileName, 'utf8', (error, data) => {
+            if (error)
+                console.log(`[Error: openChannelInfo] Incorrect file format`)
+            else {
+                const object = JSON.parse(data)
+                if (object['messages'].length === 0)
+                    object['messages'] = messages as []
+                else if (object['messages'].length !== 0 && messages.length !== 0)
+                    object['messages'] = messages as []
+                fs.writeFileSync(fullFileName, JSON.stringify(object, null, 2))
+            }
+        })
+    } else { // file doesn't exist, create it
+        const object: Configuration = JSON.parse(`{ \"id\": \"${channel?.id}\", \"name\": \"${channel?.name}\", \"user\": \"${user}\", \"messages\": []}`)
+
+        const directory = path.dirname(fullFileName)
+        if (!fs.existsSync(directory))
+            fs.mkdirSync(directory, { recursive: true })
+
+        // only creating it, no need to add anything
+        fs.writeFileSync(fullFileName, JSON.stringify(object, null, 2))
+        console.log(`[Util: openChannelInfo] Created '${fullFileName}' in working directory`)
+    }
+}
+
+/**
+ * Method to get the channel information/history
+ * 
+ * @param filename name of the json file for the channel by user
+ * @param callback function to handle resolving message history
+ */
+export async function getChannelInfo(filename: string, callback: (config: Channel | undefined) => void): Promise<void> {
+    const fullFileName = `data/${filename}`
+    if (fs.existsSync(fullFileName)) {
+        fs.readFile(fullFileName, 'utf8', (error, data) => {
+            if (error) {
+                callback(undefined) 
+                return // something went wrong... stop
+            }
+            callback(JSON.parse(data))
+        })
+    } else {
+        callback(undefined) // file not found
+    }
 }

src/utils/messageEmbed.ts

@@ -2,6 +2,7 @@ import { EmbedBuilder, Message } from 'discord.js'
 import { ChatResponse, Ollama } from 'ollama'
 import { ChatParams, UserMessage, streamResponse, blockResponse } from './index.js'
 import { Queue } from '../queues/queue.js'
+import { AbortableAsyncIterator } from 'ollama/src/utils.js'
 
 /**
  * Method to send replies as normal text on discord like any other user
@@ -19,7 +20,7 @@ export async function embedMessage(
     stream: boolean
 ): Promise<string> {
     // bot response
-    let response: ChatResponse | AsyncGenerator<ChatResponse, any, unknown>
+    let response: ChatResponse | AbortableAsyncIterator<ChatResponse>
     let result: string = ''
 
     // initial message to client

src/utils/messageNormal.ts

@@ -2,6 +2,7 @@ import { Message } from 'discord.js'
 import { ChatResponse, Ollama } from 'ollama'
 import { ChatParams, UserMessage, streamResponse, blockResponse } from './index.js'
 import { Queue } from '../queues/queue.js'
+import { AbortableAsyncIterator } from 'ollama/src/utils.js'
 
 /**
  * Method to send replies as normal text on discord like any other user
@@ -19,7 +20,7 @@ export async function normalMessage(
     stream: boolean
 ): Promise<string> {
     // bot's respnse
-    let response: ChatResponse | AsyncGenerator<ChatResponse, any, unknown>
+    let response: ChatResponse | AbortableAsyncIterator<ChatResponse>
     let result: string = ''
 
     await message.channel.send('Generating Response . . .').then(async sentMessage => {

src/utils/streamHandler.ts

@@ -1,12 +1,13 @@
 import { ChatResponse } from "ollama"
 import { ChatParams } from "./index.js"
+import { AbortableAsyncIterator } from "ollama/src/utils.js"
 
 /**
  * Method to query the Ollama client for async generation
  * @param params 
  * @returns Asyn
  */
-export async function streamResponse(params: ChatParams): Promise<AsyncGenerator<ChatResponse, any, unknown>> {
+export async function streamResponse(params: ChatParams): Promise<AbortableAsyncIterator<ChatResponse>> {
     return await params.ollama.chat({
         model: params.model,
         messages: params.msgHist,
@@ -16,7 +17,7 @@ export async function streamResponse(params: ChatParams): Promise<AsyncGenerator
             top_k: 70
         },
         stream: true
-    })
+    }) as unknown as AbortableAsyncIterator<ChatResponse>
 }
 
 /**

tests/commands.test.ts

@@ -22,6 +22,6 @@ describe('#commands', () => {
     // test specific commands in the object
     it('references specific commands', () => {
         const commandsString = commands.map(e => e.name).join(', ')
-        expect(commandsString).toBe('thread, private-thread, message-style, message-stream, toggle-chat, shutoff, modify-capacity')
+        expect(commandsString).toBe('thread, private-thread, message-style, message-stream, toggle-chat, shutoff, modify-capacity, channel-toggle')
     })
 })

tsconfig.json

@@ -2,8 +2,8 @@
   "compilerOptions": {
     // Dependent on node version
     "target": "ES2020",
-    "module": "Node16",
-    "moduleResolution": "Node16",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
     "strict": true,
     // We must set the type
     "noImplicitAny": true,
@@ -13,11 +13,17 @@
     "strictNullChecks": true,
     // We can import json files like JavaScript
     "resolveJsonModule": true,
-    // Decompile .ts to .js into a folder named dist
+    "skipLibCheck": true,
+    "esModuleInterop": true,
+    // Decompile .ts to .js into a folder named build
     "outDir": "build",
-    "rootDir": "src"
+    "rootDir": "src",
+    "baseUrl": ".",
+    "paths": {
+      "*": ["node_modules/"]
+    }
   },
   // environment for env vars
-  "include": ["src/**/*"],
+  "include": ["src/**/*.ts"],
   "exclude": ["node_modules"]
 }