Summary Command (#194)

.github/ISSUE_TEMPLATE/feature_request.md

@@ -8,10 +8,10 @@ assignees: ''
 ---
 
 ## Issue
-A clear and concise description of what the problem/feature is.
+A clear and concise description of what the problem/feature is. PLease describe it as best as possible.
 
 ## Solution
-* Provide steps or ideals to how to implement or investigate this new feature.
+* Provide steps or ideas to how to implement or investigate this new feature.
 
 ## References
 * Provide additional context and external references here

.github/workflows/build.yml

@@ -1,75 +1,75 @@
-name: Builds
-run-name: Validate Node and Docker Builds
-on:
-  push:
-    branches:
-      - master # runs after Pull Request is merged
-
-jobs:
-  Discord-Node-Build: # test if the node install and run
-    runs-on: ubuntu-latest
-    timeout-minutes: 2
-    steps:
-      - name: Checkout Repository
-        uses: actions/checkout@v4
-
-      - name: Set up Node Environment lts/jod
-        uses: actions/setup-node@v4
-        with:
-          node-version: lts/jod
-          cache: "npm"
-
-      - name: Install Project Dependencies
-        run: |
-          npm install
-
-      - name: Build Application
-        run: |
-          npm run build
-
-      - name: Create Environment Variables
-        run: |
-          touch .env
-          echo CLIENT_TOKEN = ${{ secrets.BOT_TOKEN }} >> .env
-          echo OLLAMA_IP = ${{ secrets.OLLAMA_IP }} >> .env
-          echo OLLAMA_PORT = ${{ secrets.OLLAMA_PORT }} >> .env
-          echo MODEL = ${{ secrets.MODEL }} >> .env
-
-        # set -e ensures if nohup fails, this section fails
-      - name: Startup Discord Bot Client
-        run: |
-          set -e
-          nohup npm run prod &
-
-  Discord-Ollama-Container-Build: # test docker build and run
-    runs-on: ubuntu-latest
-    timeout-minutes: 2
-    steps:
-      - name: Checkout Repository
-        uses: actions/checkout@v4
-
-      - name: Set up Node Environment lts/jod
-        uses: actions/setup-node@v4
-        with:
-          node-version: lts/jod
-          cache: "npm"
-
-      - name: Create Environment Variables
-        run: |
-          touch .env
-          echo CLIENT_TOKEN = ${{ secrets.BOT_TOKEN }} >> .env
-          echo OLLAMA_IP = ${{ secrets.OLLAMA_IP }} >> .env
-          echo OLLAMA_PORT = ${{ secrets.OLLAMA_PORT }} >> .env
-          echo MODEL = ${{ secrets.MODEL }} >> .env
-
-      - name: Setup Docker Network and Images
-        run: |
-          npm run docker:start-cpu
-
-      - name: Check Images Exist
-        run: |
-          (docker images | grep -q 'kevinthedang/discord-ollama' && docker images | grep -qE 'ollama/ollama') || exit 1
-
-      - name: Check Containers Exist
-        run: |
-          (docker ps | grep -q 'ollama' && docker ps | grep -q 'discord') || exit 1
+name: Builds
+run-name: Validate Node and Docker Builds
+on:
+  push:
+    branches:
+      - master # runs after Pull Request is merged
+
+jobs:
+  Discord-Node-Build: # test if the node install and run
+    runs-on: ubuntu-latest
+    timeout-minutes: 2
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - name: Set up Node Environment lts/jod
+        uses: actions/setup-node@v4
+        with:
+          node-version: lts/jod
+          cache: "npm"
+
+      - name: Install Project Dependencies
+        run: |
+          npm install
+
+      - name: Build Application
+        run: |
+          npm run build
+
+      - name: Create Environment Variables
+        run: |
+          touch .env
+          echo CLIENT_TOKEN = ${{ secrets.BOT_TOKEN }} >> .env
+          echo OLLAMA_IP = ${{ secrets.OLLAMA_IP }} >> .env
+          echo OLLAMA_PORT = ${{ secrets.OLLAMA_PORT }} >> .env
+          echo MODEL = ${{ secrets.MODEL }} >> .env
+
+        # set -e ensures if nohup fails, this section fails
+      - name: Startup Discord Bot Client
+        run: |
+          set -e
+          nohup npm run prod &
+
+  Discord-Ollama-Container-Build: # test docker build and run
+    runs-on: ubuntu-latest
+    timeout-minutes: 2
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - name: Set up Node Environment lts/jod
+        uses: actions/setup-node@v4
+        with:
+          node-version: lts/jod
+          cache: "npm"
+
+      - name: Create Environment Variables
+        run: |
+          touch .env
+          echo CLIENT_TOKEN = ${{ secrets.BOT_TOKEN }} >> .env
+          echo OLLAMA_IP = ${{ secrets.OLLAMA_IP }} >> .env
+          echo OLLAMA_PORT = ${{ secrets.OLLAMA_PORT }} >> .env
+          echo MODEL = ${{ secrets.MODEL }} >> .env
+
+      - name: Setup Docker Network and Images
+        run: |
+          npm run docker:start-cpu
+
+      - name: Check Images Exist
+        run: |
+          (docker images | grep -q 'kevinthedang/discord-ollama' && docker images | grep -qE 'ollama/ollama') || exit 1
+
+      - name: Check Containers Exist
+        run: |
+          (docker ps | grep -q 'ollama' && docker ps | grep -q 'discord') || exit 1

.github/workflows/deploy.yml

@@ -1,9 +1,10 @@
 name: Deploy
 run-name: Deploy Application Latest
-on:
-  push:
-    tags:
-      - 'v*'
+# on:
+#   push:
+#     tags:
+#       - 'v*'
+on: workflow_dispatch
 
 jobs:
   Deploy-Application:

.github/workflows/test.yml

@@ -1,48 +1,48 @@
-name: Tests
-run-name: Unit Tests
-on:
-  pull_request:
-    branches:
-      - master
-    paths:
-      - '*'
-      - 'package*.json'
-      - 'src/**'
-      - 'tests/**'
-      - '!docs/**'
-      - '!imgs/**'
-      - '!.github/**'
-      - '.github/workflows/**'
-      - '!.gitignore'
-      - '!LICENSE'
-      - '!README'
-
-jobs:
-  Discord-Node-Test:
-    runs-on: ubuntu-latest
-    timeout-minutes: 2
-    steps:
-      - name: Checkout Repository
-        uses: actions/checkout@v4
-
-      - name: Set up Node Environment lts/jod
-        uses: actions/setup-node@v4
-        with:
-          node-version: lts/jod
-          cache: "npm"
-
-      - name: Install Project Dependencies
-        run: |
-          npm install
-
-      - name: Create Environment Variables
-        run: |
-          touch .env
-          echo CLIENT_TOKEN = ${{ secrets.BOT_TOKEN }} >> .env
-          echo OLLAMA_IP = ${{ secrets.OLLAMA_IP }} >> .env
-          echo OLLAMA_PORT = ${{ secrets.OLLAMA_PORT }} >> .env
-          echo MODEL = ${{ secrets.MODEL }} >> .env
-
-      - name: Test Application
-        run: |
-          npm run tests
+name: Tests
+run-name: Unit Tests
+on:
+  pull_request:
+    branches:
+      - master
+    paths:
+      - '*'
+      - 'package*.json'
+      - 'src/**'
+      - 'tests/**'
+      - '!docs/**'
+      - '!imgs/**'
+      - '!.github/**'
+      - '.github/workflows/**'
+      - '!.gitignore'
+      - '!LICENSE'
+      - '!README'
+
+jobs:
+  Discord-Node-Test:
+    runs-on: ubuntu-latest
+    timeout-minutes: 2
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - name: Set up Node Environment lts/jod
+        uses: actions/setup-node@v4
+        with:
+          node-version: lts/jod
+          cache: "npm"
+
+      - name: Install Project Dependencies
+        run: |
+          npm install
+
+      - name: Create Environment Variables
+        run: |
+          touch .env
+          echo CLIENT_TOKEN = ${{ secrets.BOT_TOKEN }} >> .env
+          echo OLLAMA_IP = ${{ secrets.OLLAMA_IP }} >> .env
+          echo OLLAMA_PORT = ${{ secrets.OLLAMA_PORT }} >> .env
+          echo MODEL = ${{ secrets.MODEL }} >> .env
+
+      - name: Test Application
+        run: |
+          npm run tests

README.md

@@ -4,9 +4,9 @@
     <h3><a href="#"></a>Ollama as your Discord AI Assistant</h3>
     <p><a href="#"></a><a href="https://creativecommons.org/licenses/by/4.0/"><img alt="License" src="https://img.shields.io/badge/License-CC_BY_4.0-darkgreen.svg" /></a>
     <a href="#"></a><a href="https://github.com/kevinthedang/discord-ollama/releases/latest"><img alt="Release" src="https://img.shields.io/github/v/release/kevinthedang/discord-ollama?logo=github" /></a>
-    <a href="#"></a><a href="https://github.com/kevinthedang/discord-ollama/actions/workflows/build.yml"><img alt="Build Status" src="https://github.com/kevinthedang/discord-ollama/actions/workflows/build.yml/badge.svg" /></a>
-    <a href="#"></a><a href="https://github.com/kevinthedang/discord-ollama/actions/workflows/deploy.yml"><img alt="Deploy Status" src="https://github.com/kevinthedang/discord-ollama/actions/workflows/deploy.yml/badge.svg" /></a>
-    <a href="#"></a><a href="https://github.com/kevinthedang/discord-ollama/actions/workflows/test.yml"><img alt="Testing Status" src="https://github.com/kevinthedang/discord-ollama/actions/workflows/test.yml/badge.svg" /></a>
+    <a href="#"></a><a href="https://github.com/kevinthedang/discord-ollama/actions/workflows/build.yml"><img alt="Builds" src="https://github.com/kevinthedang/discord-ollama/actions/workflows/build.yml/badge.svg" /></a>
+    <!-- <a href="#"></a><a href="https://github.com/kevinthedang/discord-ollama/actions/workflows/deploy.yml"><img alt="Deploy Status" src="https://github.com/kevinthedang/discord-ollama/actions/workflows/deploy.yml/badge.svg" /></a> -->
+    <a href="#"></a><a href="https://github.com/kevinthedang/discord-ollama/actions/workflows/test.yml"><img alt="Tests" src="https://github.com/kevinthedang/discord-ollama/actions/workflows/test.yml/badge.svg" /></a>
     <a href="#"></a><a href="https://github.com/kevinthedang/discord-ollama/actions/workflows/coverage.yml"><img alt="Code Coverage" src="https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/kevinthedang/bc7b5dcfa16561ab02bb3df67a99b22d/raw/coverage.json"></a>
 </div>
 
@@ -18,7 +18,7 @@ The project aims to:
   * [x] Message Persistance
   * [x] Containerization with Docker
   * [x] Slash Commands Compatible
-    * [ ] Summary Command
+    * [x] Summary Command
     * [ ] Model Info Command
     * [ ] List Models Command
     * [x] Pull Model Command

docker-compose.yml

@@ -7,7 +7,7 @@ services:
     build: ./                     # find docker file in designated path
     container_name: discord
     restart: always               # rebuild container always
-    image: kevinthedang/discord-ollama:0.8.7
+    image: kevinthedang/discord-ollama:0.9.0
     environment:
       CLIENT_TOKEN: ${CLIENT_TOKEN}
       OLLAMA_IP: ${OLLAMA_IP}

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "discord-ollama",
-  "version": "0.8.7",
+  "version": "0.9.0",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "discord-ollama",
-      "version": "0.8.7",
+      "version": "0.9.0",
       "license": "ISC",
       "dependencies": {
         "discord.js": "^14.20.0",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "discord-ollama",
-  "version": "0.8.7",
+  "version": "0.9.0",
   "description": "Ollama Integration into discord",
   "main": "build/index.js",
   "exports": "./build/index.js",

src/client.ts

@@ -1,44 +1,44 @@
-import { Client, GatewayIntentBits } from 'discord.js'
-import { Ollama } from 'ollama'
-import { Queue } from './queues/queue.js'
-import { UserMessage, registerEvents } from './utils/index.js'
-import Events from './events/index.js'
-import Keys from './keys.js'
-
-// initialize the client with the following permissions when logging in
-const client = new Client({
-    intents: [
-        GatewayIntentBits.Guilds,
-        GatewayIntentBits.GuildMembers,
-        GatewayIntentBits.GuildMessages,
-        GatewayIntentBits.MessageContent
-    ]
-})
-
-// initialize connection to ollama container
-export const ollama = new Ollama({
-    host: `http://${Keys.ipAddress}:${Keys.portAddress}`,
-})
-
-// Create Queue managed by Events
-const messageHistory: Queue<UserMessage> = new Queue<UserMessage>
-
-// Create Channel History Queue managed by Events
-const channelMessageHistory: Queue<UserMessage> = new Queue<UserMessage>
-
-// register all events
-registerEvents(client, Events, messageHistory, channelMessageHistory, ollama, Keys.defaultModel)
-
-// Try to log in the client
-await client.login(Keys.clientToken)
-    .catch((error) => {
-        console.error('[Login Error]', error)
-        process.exit(1)
-    })
-
-// queue up bots name
-messageHistory.enqueue({
-    role: 'assistant',
-    content: `My name is ${client.user?.username}`,
-    images: []
+import { Client, GatewayIntentBits } from 'discord.js'
+import { Ollama } from 'ollama'
+import { Queue } from './queues/queue.js'
+import { UserMessage, registerEvents } from './utils/index.js'
+import Events from './events/index.js'
+import Keys from './keys.js'
+
+// initialize the client with the following permissions when logging in
+const client = new Client({
+    intents: [
+        GatewayIntentBits.Guilds,
+        GatewayIntentBits.GuildMembers,
+        GatewayIntentBits.GuildMessages,
+        GatewayIntentBits.MessageContent
+    ]
+})
+
+// initialize connection to ollama container
+export const ollama = new Ollama({
+    host: `http://${Keys.ipAddress}:${Keys.portAddress}`,
+})
+
+// Create Queue managed by Events
+const messageHistory: Queue<UserMessage> = new Queue<UserMessage>
+
+// Create Channel History Queue managed by Events
+const channelMessageHistory: Queue<UserMessage> = new Queue<UserMessage>
+
+// register all events
+registerEvents(client, Events, messageHistory, channelMessageHistory, ollama, Keys.defaultModel)
+
+// Try to log in the client
+await client.login(Keys.clientToken)
+    .catch((error) => {
+        console.error('[Login Error]', error)
+        process.exit(1)
+    })
+
+// queue up bots name
+messageHistory.enqueue({
+    role: 'assistant',
+    content: `My name is ${client.user?.username}`,
+    images: []
 })

src/commands/index.ts

@@ -9,6 +9,7 @@ import { ClearUserChannelHistory } from './cleanUserChannelHistory.js'
 import { PullModel } from './pullModel.js'
 import { SwitchModel } from './switchModel.js'
 import { DeleteModel } from './deleteModel.js'
+import { Summary } from './summary.js'
 
 export default [
     ThreadCreate,
@@ -20,5 +21,6 @@ export default [
     ClearUserChannelHistory,
     PullModel,
     SwitchModel,
-    DeleteModel
+    DeleteModel,
+    Summary
 ] as SlashCommand[]

src/commands/summary.ts

@@ -0,0 +1,50 @@
+import { Client, CommandInteraction, Message, MessageFlags, SendableChannels } from "discord.js";
+import { accessChannelContext, normalMessage, SlashCommand, summarizeContextHistory, UserCommand, UserMessage } from "../utils/index.js";
+import { ollama } from "../client.js"
+
+export const Summary: SlashCommand = {
+    name: 'summary',
+    description: 'provides a summary of the chat history.',
+
+    // Generate Summary from additional context
+    run: async (client: Client, interaction: CommandInteraction) => {
+        // fetch channel
+        const channel = await client.channels.fetch(interaction.channelId)
+        if (!channel || !UserCommand.includes(channel.type)) return
+
+        // Defer
+        await interaction.deferReply({ flags: MessageFlags.Ephemeral })
+
+        // create summary using context
+        let channelContext: UserMessage[] = await new Promise((resolve) => {
+            accessChannelContext(interaction.channelId, (additionalContext) => {
+                if (additionalContext?.messages)
+                    resolve(additionalContext.messages)
+                else 
+                    resolve([])
+            })
+        })
+
+        if (channelContext.length === 0) {
+            interaction.reply({
+                content: `There are no recent chat messages in this channel.`,
+                flags: MessageFlags.Ephemeral
+            })
+            return
+        }
+
+        // Push summarize prompt
+        channelContext.push({
+            role: "user",
+            content: "Please Summarize everything from the prior messages, provide in bullet point fashion on what people have said prior. For example: \"Someone mentioned/talked about ...\"",
+            images: []
+        })
+
+        // todo: instead of a default of codellama, we can user default model somehow. Look into later.
+        const response: string = await summarizeContextHistory(ollama, "codellama", channelContext)
+
+        console.log(response)
+
+        interaction.editReply({ content: response })
+    }
+}

src/index.ts

@@ -1 +1 @@
-import('./client.js')
+import('./client.js')

src/keys.ts

@@ -1,10 +1,10 @@
-import { getEnvVar } from './utils/index.js'
-
-export const Keys = {
-    clientToken: getEnvVar('CLIENT_TOKEN'),
-    ipAddress: getEnvVar('OLLAMA_IP', '127.0.0.1'), // default ollama ip if none
-    portAddress: getEnvVar('OLLAMA_PORT', '11434'), // default ollama port if none
-    defaultModel: getEnvVar('MODEL', 'llama3.2')
-} as const // readonly keys
-
+import { getEnvVar } from './utils/index.js'
+
+export const Keys = {
+    clientToken: getEnvVar('CLIENT_TOKEN'),
+    ipAddress: getEnvVar('OLLAMA_IP', '127.0.0.1'), // default ollama ip if none
+    portAddress: getEnvVar('OLLAMA_PORT', '11434'), // default ollama port if none
+    defaultModel: getEnvVar('MODEL', 'llama3.2')
+} as const // readonly keys
+
 export default Keys

src/utils/handlers/chatHistoryHandler.ts

@@ -89,6 +89,21 @@ export async function addToChannelContext(filename: string, channel : TextChanne
     }
 }
 
+export async function accessChannelContext(filename: string, callback: (config: Channel | undefined) => void): Promise<void> {
+    const fullFileName = `data/${filename}-context.json`
+    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
+    }
+}
+
 /**
  * Method to open the channel history
  * 

src/utils/messageNormal.ts

@@ -90,6 +90,38 @@ export async function normalMessage(
     return result
 }
 
+export async function summarizeContextHistory(
+    ollama: Ollama, 
+    model: string, 
+    msgHist: UserMessage[], 
+): Promise<string> {
+    // todo: this stuff to create a response in a simpler way!
+    try {
+            const params: ChatParams = {
+            model: model,
+            ollama: ollama,
+            msgHist: msgHist
+        }
+        const response: ChatResponse = await blockResponse(params)
+        let result = response.message.content
+
+        if (hasThinking(result))
+            result = result.replace(/<think>[\s\S]*?<\/think>/g, '').trim()
+
+        return result
+    } catch (error: any) {
+        console.log(`[Util: messageNormal] Error creating message: ${error.message}`)
+        if (error.message.includes('fetch failed'))
+            error.message = 'Missing ollama service on machine'
+        else if (error.message.includes('try pulling it first'))
+            error.message = `You do not have the ${model} downloaded. Ask an admin to pull it using the \`pull-model\` command.`
+        return `**Response generation failed.**\n\nReason: ${error.message}`
+    }
+}
+    
+
+// Region: Helpers
 function hasThinking(message: string): boolean {
     return /<think>[\s\S]*?<\/think>/i.test(message)
 }
+// End Region: Helpers

tests/commands.test.ts

@@ -1,78 +1,78 @@
-// describe marks a test suite
-// expect takes a value from an expression
-// it marks a test case
-import { describe, expect, it, vi } from 'vitest'
-import commands from '../src/commands/index.js'
-
-/**
- * Mocking client.ts because of the commands
- */
-vi.mock('../src/client.js', () => ({}))
-
-/**
- * Commands test suite, tests the commands object
- * Each command is to be tested elsewhere, this file
- * is to ensure that the commands object is defined.
- * 
- * @param name name of the test suite
- * @param fn function holding tests to run
- */
-describe('Commands Existence', () => {
-    // test definition of commands object
-    it('references defined object', () => {
-        // toBe compares the value to the expected value
-        expect(typeof commands).toBe('object')
-    })
-
-    // test specific commands in the object
-    it('references specific commands', () => {
-        const commandsString = commands.map(e => e.name).join(', ')
-        const expectedCommands = ['thread', 'private-thread', 'message-stream', 'toggle-chat', 'shutoff', 'modify-capacity', 'clear-user-channel-history', 'pull-model', 'switch-model', 'delete-model']
-        expect(commandsString).toBe(expectedCommands.join(', '))
-    })
-})
-
-/**
- * User Commands Test suite for testing out commands
- * that would be run by users when using the application.
- */
-describe('User Command Tests', () => {
-    // test capacity command
-    it('run modify-capacity command', () => {
-
-    })
-
-    it('run clear-user-channel-history command', () => {
-
-    })
-
-    it('run message-stream command', () => {
-
-    })
-
-    it('run message-style command', () => {
-
-    })
-
-    it('run thread command', () => {
-
-    })
-
-    it('run private-thread command', () => {
-
-    })
-})
-
-/**
- * Admin Commands Test suite for running administrative 
- * commands with the application.
- */
-describe('Admin Command Tests', () => {
-    it('run shutoff command', () => {
-
-    })
-
-    it('run toggle-chat command', () => {
-
-    })
+// describe marks a test suite
+// expect takes a value from an expression
+// it marks a test case
+import { describe, expect, it, vi } from 'vitest'
+import commands from '../src/commands/index.js'
+
+/**
+ * Mocking client.ts because of the commands
+ */
+vi.mock('../src/client.js', () => ({}))
+
+/**
+ * Commands test suite, tests the commands object
+ * Each command is to be tested elsewhere, this file
+ * is to ensure that the commands object is defined.
+ * 
+ * @param name name of the test suite
+ * @param fn function holding tests to run
+ */
+describe('Commands Existence', () => {
+    // test definition of commands object
+    it('references defined object', () => {
+        // toBe compares the value to the expected value
+        expect(typeof commands).toBe('object')
+    })
+
+    // test specific commands in the object
+    it('references specific commands', () => {
+        const commandsString = commands.map(e => e.name).join(', ')
+        const expectedCommands = ['thread', 'private-thread', 'message-stream', 'toggle-chat', 'shutoff', 'modify-capacity', 'clear-user-channel-history', 'pull-model', 'switch-model', 'delete-model', 'summary']
+        expect(commandsString).toBe(expectedCommands.join(', '))
+    })
+})
+
+/**
+ * User Commands Test suite for testing out commands
+ * that would be run by users when using the application.
+ */
+describe('User Command Tests', () => {
+    // test capacity command
+    it('run modify-capacity command', () => {
+
+    })
+
+    it('run clear-user-channel-history command', () => {
+
+    })
+
+    it('run message-stream command', () => {
+
+    })
+
+    it('run message-style command', () => {
+
+    })
+
+    it('run thread command', () => {
+
+    })
+
+    it('run private-thread command', () => {
+
+    })
+})
+
+/**
+ * Admin Commands Test suite for running administrative 
+ * commands with the application.
+ */
+describe('Admin Command Tests', () => {
+    it('run shutoff command', () => {
+
+    })
+
+    it('run toggle-chat command', () => {
+
+    })
 })