Update: fix imports based on last pkg fix

* switch coverage to codecov

* reset node, increment ver

* remove auto-pass job var

* remove coverage 'env' note

* set badge with new action

* add fqvn for action

* fix step name

* make badge commit explicit

.github/workflows/build.yml

@@ -1,5 +1,6 @@
 name: Builds
 run-name: Validate Node and Docker Builds
+
 on:
   push:
     branches:
@@ -9,15 +10,16 @@ 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
+      - name: Set up Node Environment
         uses: actions/setup-node@v4
         with:
           node-version: lts/jod
-          cache: "npm"
+          cache: npm
 
       - name: Install Project Dependencies
         run: |
@@ -48,11 +50,11 @@ jobs:
       - name: Checkout Repository
         uses: actions/checkout@v4
 
-      - name: Set up Node Environment lts/jod
+      - name: Set up Node Environment
         uses: actions/setup-node@v4
         with:
           node-version: lts/jod
-          cache: "npm"
+          cache: npm
 
       - name: Create Environment Variables
         run: |

.github/workflows/coverage.yml

@@ -1,50 +0,0 @@
-name: Coverage
-run-name: Code Coverage
-on:
-  push:
-    branches:
-      - master
-
-jobs:
-  Discord-Node-Coverage:
-    runs-on: ubuntu-latest
-    environment: coverage
-    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: Collect Code Coverage
-        run: |
-          LINE_PCT=$(npm run coverage | tail -2 | head -1 | awk '{print $3}')
-          echo "COVERAGE=$LINE_PCT" >> $GITHUB_ENV
-      
-      - name: Upload Code Coverage
-        uses: schneegans/dynamic-badges-action@v1.7.0
-        with:
-          auth: ${{ secrets.GIST_SECRET }}
-          gistID: ${{ vars.GIST_ID }}
-          filename: coverage.json
-          label: Coverage
-          message: ${{ env.COVERAGE }}
-          valColorRange: ${{ env.COVERAGE }}
-          maxColorRange: 100
-          minColorRange: 0

.github/workflows/deploy.yml

@@ -1,9 +1,6 @@
 name: Deploy
 run-name: Deploy Application Latest
-# on:
+
-#   push:
-#     tags:
-#       - 'v*'
 on: workflow_dispatch
 
 jobs:
@@ -11,6 +8,7 @@ jobs:
     runs-on: self-hosted
     environment: deploy
     timeout-minutes: 5
+    
     steps:
       - name: Checkout Repo
         uses: actions/checkout@v4
@@ -40,7 +38,7 @@ jobs:
           git clone https://github.com/kevinthedang/discord-ollama.git ${{ secrets.PATH }}
           cd ${{ secrets.PATH }}
       
-      - name: Install nvm and Node.js lts/jod
+      - name: Install nvm and Node.js
         run: |
           curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash
           export NVM_DIR="$HOME/.nvm"

.github/workflows/test.yml

@@ -1,5 +1,6 @@
 name: Tests
 run-name: Unit Tests
+
 on:
   pull_request:
     branches:
@@ -21,15 +22,16 @@ 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
+      - name: Set up Node Environment
         uses: actions/setup-node@v4
         with:
           node-version: lts/jod
-          cache: "npm"
+          cache: npm
 
       - name: Install Project Dependencies
         run: |

.gitignore

@@ -37,16 +37,6 @@ pids
 *.seed
 *.pid.lock
 
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-*.lcov
-
-# nyc test coverage
-.nyc_output
-
 # Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
 .grunt
 

CODEOWNERS

@@ -12,7 +12,7 @@
 # Technical/Business Code Ownership
 /src/ @kevinthedang @JT2M0L3Y
 /tests/ @JT2M0L3Y
-/.github/ @kevinthedang
+/.github/ @kevinthedang @JT2M0L3Y
 
 # Docker Ownership
 Dockerfile @kevinthedang

README.md

@@ -5,9 +5,7 @@
     <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="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>
 
 ## About/Goals

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.9.0
+    image: kevinthedang/discord-ollama:0.9.1
     environment:
       CLIENT_TOKEN: ${CLIENT_TOKEN}
       OLLAMA_IP: ${OLLAMA_IP}

package.json

@@ -1,12 +1,11 @@
 {
   "name": "discord-ollama",
-  "version": "0.9.0",
+  "version": "0.9.1",
   "description": "Ollama Integration into discord",
   "main": "build/index.js",
   "exports": "./build/index.js",
   "scripts": {
     "tests": "vitest run",
-    "coverage": "vitest run --coverage",
     "watch": "tsx watch src",
     "build": "tsc",
     "prod": "node .",
@@ -32,7 +31,6 @@
   },
   "devDependencies": {
     "@types/node": "^22.13.14",
-    "@vitest/coverage-v8": "^3.0.9",
     "ts-node": "^10.9.2",
     "tsx": "^4.19.3",
     "typescript": "^5.8.2",

src/client.ts

@@ -1,6 +1,6 @@
 import { Client, GatewayIntentBits } from 'discord.js'
 import { Ollama } from 'ollama'
-import { Queue } from './queues/queue.js'
+import { Queue } from './components/index.js'
 import { UserMessage, registerEvents } from './utils/index.js'
 import Events from './events/index.js'
 import Keys from './keys.js'

src/components/binder.ts

@@ -0,0 +1,46 @@
+
+/**
+ * @class Logger
+ * @description A class to handle logging messages
+ * @method log
+ */
+export class Logger {
+    private logPrefix: string = ''
+    private type: string = 'log'
+
+    private constructPrefix(component?: string, method?: string): string {
+        let prefix = this.type.toUpperCase()
+
+        if (component) {
+            prefix += ` [${component}`
+            if (method) prefix += `: ${method}`
+            prefix += ']'
+        }
+
+        return prefix
+    }
+
+    public bind(component?: string, method?: string): CallableFunction {
+        let tempPrefix = this.constructPrefix(component, method)
+
+        if (tempPrefix !== this.logPrefix) this.logPrefix = tempPrefix
+
+        switch (this.type) {
+            case 'warn':
+                return console.warn.bind(console, this.logPrefix)
+            case 'error':
+                return console.error.bind(console, this.logPrefix)
+            case 'log':
+            default:
+                return console.log.bind(console, this.logPrefix)
+        }
+    }
+
+    public log(type: string, message: unknown, component?: string, method?: string): void {
+        if (type && type !== this.type) this.type = type
+
+        let log = this.bind(component, method)
+
+        log(message)
+    }
+}

src/components/index.ts

@@ -0,0 +1,2 @@
+export * from './queue.js'
+export * from './binder.js'

src/events/messageCreate.ts

@@ -1,6 +1,6 @@
 import { TextChannel } from 'discord.js'
-import { event, Events, normalMessage, UserMessage, clean, addToChannelContext } from '../utils/index.js'
 import {
+    event, Events, normalMessage, UserMessage, clean,
     getChannelInfo, getServerConfig, getUserConfig, openChannelInfo,
     openConfig, UserConfig, getAttachmentData, getTextFileAttachmentData
 } from '../utils/index.js'

src/utils/events.ts

@@ -1,6 +1,6 @@
 import type { ClientEvents, Awaitable, Client } from 'discord.js'
 import { Ollama } from 'ollama'
-import { Queue } from '../queues/queue.js'
+import { Queue } from '../components/index.js'
 
 // Export events through here to reduce amount of imports
 export { Events } from 'discord.js'

src/utils/handlers/chatHistoryHandler.ts

@@ -112,7 +112,7 @@ export async function accessChannelContext(filename: string, callback: (config:
  * @param user the user's name
  * @param messages their messages
  */
-export async function openChannelInfo(filename: string, channel: TextChannel | ThreadChannel, user: string, messages: UserMessage[] = []): Promise<void> {
+export async function openChannelInfo(this: any, filename: string, channel: TextChannel | ThreadChannel, user: string, messages: UserMessage[] = []): Promise<void> {
     const fullFileName = `data/${filename}-${user}.json`
     if (fs.existsSync(fullFileName)) {
         fs.readFile(fullFileName, 'utf8', (error, data) => {
@@ -143,7 +143,7 @@ export async function openChannelInfo(filename: string, channel: TextChannel | T
 
         // 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`)
+        console.log(`[Util: ${this.name}] Created '${fullFileName}' in working directory`)
     }
 }
 

src/utils/handlers/configHandler.ts

@@ -10,7 +10,7 @@ import path from 'path'
  * @param value new value to assign
  */
 // add type of change (server, user)
-export function openConfig(filename: string, key: string, value: any) {
+export function openConfig(this: any, filename: string, key: string, value: any) {
     const fullFileName = `data/${filename}`
 
     // check if the file exists, if not then make the config file
@@ -41,7 +41,7 @@ export function openConfig(filename: string, key: string, value: any) {
             fs.mkdirSync(directory, { recursive: true })
 
         fs.writeFileSync(`data/${filename}`, JSON.stringify(object, null, 2))
-        console.log(`[Util: openConfig] Created '${filename}' in working directory`)
+        console.log(`[Util: ${this.name}] Created '${filename}' in working directory`)
     }
 }
 

src/utils/handlers/streamHandler.ts

@@ -1,6 +1,5 @@
-import { ChatResponse } from "ollama"
+import { ChatResponse, AbortableAsyncIterator } from "ollama"
 import { ChatParams } from "../index.js"
-import { AbortableAsyncIterator } from "ollama/src/utils.js"
 
 /**
  * Method to query the Ollama client for async generation

src/utils/messageNormal.ts

@@ -1,8 +1,7 @@
 import { Message, SendableChannels } from 'discord.js'
-import { ChatResponse, Ollama } from 'ollama'
+import { ChatResponse, Ollama, AbortableAsyncIterator } from 'ollama'
 import { ChatParams, UserMessage, streamResponse, blockResponse } from './index.js'
-import { Queue } from '../queues/queue.js'
+import { Queue } from '../components/index.js'
-import { AbortableAsyncIterator } from 'ollama/src/utils.js'
 
 /**
  * Method to send replies as normal text on discord like any other user
@@ -11,6 +10,7 @@ import { AbortableAsyncIterator } from 'ollama/src/utils.js'
  * @param msgHist message history between user and model
  */
 export async function normalMessage(
+    this: any,
     message: Message,
     ollama: Ollama,
     model: string,
@@ -77,11 +77,10 @@ export async function normalMessage(
                     sentMessage.edit(result)
             }
         } catch (error: any) {
-            console.log(`[Util: messageNormal] Error creating message: ${error.message}`)
+            console.log(`[Util: ${this.name}] Error creating message: ${error.message}`)
-            if (error.message.includes('fetch failed'))
+            if (error.message.includes('try pulling it first'))
-                error.message = 'Missing ollama service on machine'
+                sentMessage.edit(`**Response generation failed.**\n\nReason: You do not have the ${model} downloaded. Ask an admin to pull it using the \`pull-model\` command.`)
-            else if (error.message.includes('try pulling it first'))
+            else
-                error.message = `You do not have the ${model} downloaded. Ask an admin to pull it using the \`pull-model\` command.`
                 sentMessage.edit(`**Response generation failed.**\n\nReason: ${error.message}`)
         }
     })

tests/queue.test.ts

@@ -1,5 +1,5 @@
 import { describe, expect, it } from 'vitest'
-import { Queue } from '../src/queues/queue.js'
+import { Queue } from '../src/components/index.js'
 
 /**
  * Queue test suite, tests the Queue class

tsconfig.json

@@ -18,9 +18,8 @@
     // Decompile .ts to .js into a folder named build
     "outDir": "build",
     "rootDir": "src",
-    "baseUrl": ".",
     "paths": {
-      "*": ["node_modules/"]
+      "*": ["./node_modules/"]
     }
   },
   // environment for env vars

vitest.config.ts

@@ -1,13 +1,9 @@
-import { defineConfig, configDefaults } from 'vitest/config'
+import { defineConfig } from 'vitest/config'
 
 // config for vitest
 export default defineConfig({
     test: {
         globals: true, // <-- reduces test file imports
-        reporters: ['verbose'], // <-- verbose output
+        reporters: ['verbose'] // <-- verbose output
-        coverage: {
-            exclude: [...configDefaults.exclude, 'build/*', 'tests/*'], // <-- exclude JS build
-            reporter: ['text-summary'] // <-- report in text-summary
-        }
     }
 })