Compare commits

..
Author SHA1 Message Date
JT2M0L3Y e0888c4d7c remove coverage 'env' note 2026-07-03 11:27:04 -07:00
JT2M0L3Y 0124da5027 remove auto-pass job var 2026-07-03 11:21:45 -07:00
JT2M0L3Y effcc1fd15 reset node, increment ver 2026-07-03 11:16:09 -07:00
JT2M0L3Y b492d8f62f switch coverage to codecov 2026-07-03 11:07:20 -07:00
49 changed files with 2112 additions and 1843 deletions
+4 -6
View File
@@ -4,13 +4,11 @@ CLIENT_TOKEN = BOT_TOKEN
# Default model for new users
MODEL = DEFAULT_MODEL
# ip/port address of the LLM server (ollama, llmman, ...), I use 172.18.0.3 for docker, 127.0.0.1 for local
# ollama listens on 11434, llmman (https://github.com/llmmanorg/llmman) on 17434
# OLLAMA_IP / OLLAMA_PORT are still accepted as deprecated aliases
LLM_ENDPOINT = IP_ADDRESS
LLM_PORT = PORT
# 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.0.2, use different IP than llm_endpoint
# 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.
+7 -7
View File
@@ -18,7 +18,7 @@ jobs:
- name: Set up Node Environment
uses: actions/setup-node@v4
with:
node-version: lts/krypton
node-version: lts/jod
cache: npm
- name: Install Project Dependencies
@@ -33,8 +33,8 @@ jobs:
run: |
touch .env
echo CLIENT_TOKEN = ${{ secrets.BOT_TOKEN }} >> .env
echo LLM_ENDPOINT = ${{ secrets.OLLAMA_IP }} >> .env
echo LLM_PORT = ${{ secrets.OLLAMA_PORT }} >> .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
@@ -45,7 +45,7 @@ jobs:
Discord-Ollama-Container-Build: # test docker build and run
runs-on: ubuntu-latest
timeout-minutes: 3
timeout-minutes: 2
steps:
- name: Checkout Repository
uses: actions/checkout@v4
@@ -53,15 +53,15 @@ jobs:
- name: Set up Node Environment
uses: actions/setup-node@v4
with:
node-version: lts/krypton
node-version: lts/jod
cache: npm
- name: Create Environment Variables
run: |
touch .env
echo CLIENT_TOKEN = ${{ secrets.BOT_TOKEN }} >> .env
echo LLM_ENDPOINT = ${{ secrets.OLLAMA_IP }} >> .env
echo LLM_PORT = ${{ secrets.OLLAMA_PORT }} >> .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
+46
View File
@@ -0,0 +1,46 @@
name: Coverage
run-name: Code Coverage
on:
pull_request:
branches:
- master
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
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: Run tests with coverage
run: npm run coverage
- name: Upload Coverage to Codecov
uses: codecov/codecov-action@v5
with:
files: coverage/lcov.info
fail_ci_if_error: true
+2 -2
View File
@@ -18,8 +18,8 @@ jobs:
run: |
touch .env
echo CLIENT_TOKEN = ${{ secrets.CLIENT }} >> .env
echo LLM_ENDPOINT = ${{ secrets.OLLAMA_IP }} >> .env
echo LLM_PORT = ${{ secrets.OLLAMA_PORT }} >> .env
echo OLLAMA_IP = ${{ secrets.OLLAMA_IP }} >> .env
echo OLLAMA_PORT = ${{ secrets.OLLAMA_PORT }} >> .env
echo MODEL = ${{ secrets.MODEL }} >> .env
echo DISCORD_IP = ${{ secrets.DISCORD_IP }} >> .env
echo SUBNET_ADDRESS = ${{ secrets.SUBNET_ADDRESS }} >> .env
-47
View File
@@ -1,47 +0,0 @@
name: Tests (Fork PRs)
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-Fork:
if: ${{ github.event.pull_request.head.repo.fork == true }}
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 'lts/jod'
cache: npm
- name: Install Project Dependencies
run: |
npm install
- name: Create Dummy Env
run: |
echo CLIENT_TOKEN=test-token >> .env
echo LLM_ENDPOINT=127.0.0.1 >> .env
echo LLM_PORT=11434 >> .env
echo MODEL=dummy-model >> .env
- name: Test Application
run: |
npm run tests
+2 -3
View File
@@ -20,7 +20,6 @@ on:
jobs:
Discord-Node-Test:
if: ${{ github.event.pull_request.head.repo.fork == false }}
runs-on: ubuntu-latest
timeout-minutes: 2
@@ -42,8 +41,8 @@ jobs:
run: |
touch .env
echo CLIENT_TOKEN = ${{ secrets.BOT_TOKEN }} >> .env
echo LLM_ENDPOINT = ${{ secrets.OLLAMA_IP }} >> .env
echo LLM_PORT = ${{ secrets.OLLAMA_PORT }} >> .env
echo OLLAMA_IP = ${{ secrets.OLLAMA_IP }} >> .env
echo OLLAMA_PORT = ${{ secrets.OLLAMA_PORT }} >> .env
echo MODEL = ${{ secrets.MODEL }} >> .env
- name: Test Application
+10
View File
@@ -37,6 +37,16 @@ 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
+1 -1
View File
@@ -12,7 +12,7 @@
# Technical/Business Code Ownership
/src/ @kevinthedang @JT2M0L3Y
/tests/ @JT2M0L3Y
/.github/ @kevinthedang @JT2M0L3Y
/.github/ @kevinthedang
# Docker Ownership
Dockerfile @kevinthedang
+2 -2
View File
@@ -1,5 +1,5 @@
# use node LTS image for version 24
FROM node:krypton-alpine
# use node LTS image for version 22
FROM node:jod-alpine
# set working directory inside container
WORKDIR /app
+31 -28
View File
@@ -5,47 +5,51 @@
<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="https://codecov.io/gh/kevinthedang/discord-ollama"><img src="https://img.shields.io/codecov/c/github/kevinthedang/discord-ollama?logo=codecov" alt="coverage" /></a>
</div>
## About
Discord Ollama is a Discord bot that lets users interact with locally hosted
Ollama language models directly from Discord.
## About/Goals
Ollama is an AI model management tool that allows users to install and use custom large language models locally.
The project aims to:
* [x] Create a Discord bot that will utilize Ollama and chat to chat with users!
* [x] User and Server Preferences
* [x] Message Persistance
* [x] Containerization with Docker
* [x] Slash Commands Compatible
* [x] Summary Command
* [ ] Model Info Command
* [ ] List Models Command
* [x] Pull Model Command
* [x] Switch Model Command
* [x] Delete Model Command
* [x] Create Thread Command
* [x] Create Private Thread Command
* [x] Message Stream Command
* [x] Change Message History Size Command
* [x] Clear Channel History Command (User Only)
* [x] Administrator Role Compatible
* [x] Generated Token Length Handling for >2000
* [x] Token Length Handling of any message size
* [x] Multi-User Chat Generation - This was built in from Ollama `v0.2.1+`
* [ ] Ollama Tool Support Implementation
* [ ] Enhanced Channel Context Awareness
* [ ] Improved User Replied Triggers
The bot supports model management, streamed responses, conversation history,
private threads, and configurable server controls. Because Ollama runs locally,
you retain control over the models and data used by the bot.
See the [setup guides](./docs/setup-local.md) to get started.
Further, Ollama provides the functionality to utilize custom models or provide context for the top-layer of any model available through the Ollama model library.
* [Customize a model](https://github.com/ollama/ollama#customize-a-model)
* [Modelfile Docs](https://github.com/ollama/ollama/blob/main/docs/modelfile.md)
## Documentation
These are guides to the features and capabilities of this app.
* [User Slash Commands](./docs/commands-guide.md)
* [Client Events](./docs/events-guide.md)
## Logging
The application uses Pino child loggers with structured component metadata.
Outside production, `pino-caller` adds the source file and line to each log
entry. Set `LOG_LEVEL` to configure the minimum level (defaults to `info`).
```ts
import { createLogger } from './components/index.js'
const logger = createLogger({ component: 'request', requestId })
logger.info('Request started')
```
Log entries are JSON and include the structured fields provided to the log
method, along with `component` and (outside production) `caller`. The root Pino
instance is shared; create one child when entering a context, then pass that
same child logger through the context's work. Create another child only when
you need to add more scoped bindings; child creation does not mutate its parent.
## Environment Setup
* 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]`
* The LLM server is configured with `LLM_ENDPOINT` / `LLM_PORT` (`OLLAMA_IP` / `OLLAMA_PORT` still work as deprecated aliases).
* Please refer to the docs for bot setup.
* [Creating a Discord App](./docs/setup-discord-app.md)
* [Local Machine Setup](./docs/setup-local.md)
@@ -59,7 +63,6 @@ you need to add more scoped bindings; child creation does not mutate its parent.
* This project requires the use of npm version `10.9.0` or above.
* [Ollama](https://ollama.com/)
* [Ollama Docker Image](https://hub.docker.com/r/ollama/ollama)
* [llmman](https://github.com/llmmanorg/llmman) also serves the Ollama API (on port `17434`) and can be used in its place, see [Local Machine Setup](./docs/setup-local.md#using-with-llmman-alternative-to-ollama).
* [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)
* [Setting up Nvidia Container Toolkit](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html)
+5 -5
View File
@@ -7,11 +7,11 @@ services:
build: ./ # find docker file in designated path
container_name: discord
restart: always # rebuild container always
image: kevinthedang/discord-ollama:0.9.3
image: kevinthedang/discord-ollama:0.9.1
environment:
CLIENT_TOKEN: ${CLIENT_TOKEN}
LLM_ENDPOINT: ${LLM_ENDPOINT:-${OLLAMA_IP}} # OLLAMA_IP is a deprecated alias
LLM_PORT: ${LLM_PORT:-${OLLAMA_PORT}} # OLLAMA_PORT is a deprecated alias
OLLAMA_IP: ${OLLAMA_IP}
OLLAMA_PORT: ${OLLAMA_PORT}
MODEL: ${MODEL}
networks:
ollama-net:
@@ -26,14 +26,14 @@ services:
restart: always
networks:
ollama-net:
ipv4_address: ${LLM_ENDPOINT:-${OLLAMA_IP}}
ipv4_address: ${OLLAMA_IP}
runtime: nvidia # use Nvidia Container Toolkit for GPU support
devices:
- /dev/nvidia0
volumes:
- ollama:/root/.ollama
ports:
- ${LLM_PORT:-${OLLAMA_PORT}}:${LLM_PORT:-${OLLAMA_PORT}}
- ${OLLAMA_PORT}:${OLLAMA_PORT}
# create a network that supports giving addresses withing a specific subnet
networks:
+3 -3
View File
@@ -43,10 +43,10 @@ sudo systemctl restart docker
* [GitHub repository](https://github.com/NVIDIA/nvidia-container-toolkit?tab=readme-ov-file) for Nvidia Container Toolkit
## To Run (with Docker and Docker Compose)
* With the inclusion of subnets in the `docker-compose.yml`, you will need to set the `SUBNET_ADDRESS`, `LLM_ENDPOINT`, `LLM_PORT`, and `DISCORD_IP`. Here are some default values if you don't care:
* With the inclusion of subnets in the `docker-compose.yml`, you will need to set the `SUBNET_ADDRESS`, `OLLAMA_IP`, `OLLAMA_PORT`, and `DISCORD_IP`. Here are some default values if you don't care:
* `SUBNET_ADDRESS = 172.18.0.0`
* `LLM_ENDPOINT = 172.18.0.2`
* `LLM_PORT = 11434`
* `OLLAMA_IP = 172.18.0.2`
* `OLLAMA_PORT = 11434`
* `DISCORD_IP = 172.18.0.3`
* Don't understand any of this? watch a Networking video to understand subnetting.
* You also need all environment variables shown in [`.env.sample`](../.env.sample)
+3 -10
View File
@@ -14,18 +14,11 @@
> [!NOTE]
> You can now pull models directly from the Discord client using `/pull-model <model-name>` or `/switch-model <model-name>`. They must exist from your local model library or from the [Ollama Model Library](https://ollama.com/library)
## Using with llmman (alternative to Ollama)
* [llmman](https://github.com/llmmanorg/llmman) is a local model runner that serves the Ollama API on port `17434`. The bot talks to it exactly as it would to Ollama, only the port differs.
* Install it with `curl -fsSL https://raw.githubusercontent.com/llmmanorg/llmman/main/install.sh | sh` (Linux/macOS) or `irm https://raw.githubusercontent.com/llmmanorg/llmman/main/install.ps1 | iex` (Windows).
* Start the server with `llmman serve` and pull a model with `llmman pull [model name]`, for example `llmman pull gemma4` or `llmman pull hf.co/unsloth/Qwen3.5-0.8B-GGUF`.
* Point the bot at it by setting `LLM_ENDPOINT = 127.0.0.1` and `LLM_PORT = 17434` in your `.env`, then set `MODEL` to a model you pulled. `/pull-model`, `/switch-model` and `/delete-model` work the same way.
## To Run Locally (without Docker)
* Run `npm install` to install the npm packages.
* Ensure that your [.env](../.env.sample) file's `LLM_ENDPOINT` is `127.0.0.1` to work properly.
* You only need your `CLIENT_TOKEN`, `LLM_ENDPOINT`, `LLM_PORT`.
* The LLM server ip and port should just use it's defaults by nature. If not, utilize `LLM_ENDPOINT = 127.0.0.1` and `LLM_PORT = 11434`.
* The older `OLLAMA_IP` / `OLLAMA_PORT` names are still accepted as deprecated aliases.
* Ensure that your [.env](../.env.sample) file's `OLLAMA_IP` is `127.0.0.1` to work properly.
* You only need your `CLIENT_TOKEN`, `OLLAMA_IP`, `OLLAMA_PORT`.
* The ollama ip and port should just use it's defaults by nature. If not, utilize `OLLAMA_IP = 127.0.0.1` and `OLLAMA_PORT = 11434`.
* Now, you can run the bot by running `npm run client` which will build and run the decompiled typescript and run the setup for ollama.
* **IMPORTANT**: This must be ran in the wsl/Linux instance to work properly! Using Command Prompt/Powershell/Git Bash/etc. will not work on Windows (at least in my experience).
* Refer to the [resources](../README.md#resources) on what node version to use.
+1874 -1352
View File
File diff suppressed because it is too large Load Diff
+7 -7
View File
@@ -1,11 +1,12 @@
{
"name": "discord-ollama",
"version": "0.9.3",
"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 .",
@@ -27,20 +28,19 @@
"dependencies": {
"discord.js": "^14.20.0",
"dotenv": "^16.5.0",
"ollama": "^0.5.15",
"pino": "^10.4.0",
"pino-caller": "^4.0.0"
"ollama": "^0.5.15"
},
"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",
"vitest": "^5.0.1"
"vitest": "^3.0.4"
},
"type": "module",
"engines": {
"npm": ">=10.9.0",
"node": ">=24.0.0"
"node": ">=22.12.0"
}
}
}
+2 -4
View File
@@ -1,12 +1,10 @@
import { Client, GatewayIntentBits } from 'discord.js'
import { Ollama } from 'ollama'
import { Queue, createLogger } from './components/index.js'
import { Queue } from './queues/queue.js'
import { UserMessage, registerEvents } from './utils/index.js'
import Events from './events/index.js'
import Keys from './keys.js'
const logger = createLogger({ component: 'client' })
// initialize the client with the following permissions when logging in
const client = new Client({
intents: [
@@ -34,7 +32,7 @@ registerEvents(client, Events, messageHistory, channelMessageHistory, ollama, Ke
// Try to log in the client
await client.login(Keys.clientToken)
.catch((error) => {
logger.fatal({ err: error }, 'Client login failed')
console.error('[Login Error]', error)
process.exit(1)
})
+2 -3
View File
@@ -1,6 +1,5 @@
import { Client, ChatInputCommandInteraction, ApplicationCommandOptionType, MessageFlags } from 'discord.js'
import { openConfig, SlashCommand, UserCommand } from '../utils/index.js'
import type { Logger as PinoLogger } from 'pino'
export const Capacity: SlashCommand = {
name: 'modify-capacity',
@@ -17,13 +16,13 @@ export const Capacity: SlashCommand = {
],
// Query for message information and set the style
run: async (client: Client, interaction: ChatInputCommandInteraction, logger: PinoLogger) => {
run: async (client: Client, interaction: ChatInputCommandInteraction) => {
// fetch channel and message
const channel = await client.channels.fetch(interaction.channelId)
if (!channel || !UserCommand.includes(channel.type)) return
// set state of bot chat features
openConfig(logger, `${interaction.user.username}-config.json`, interaction.commandName,
openConfig(`${interaction.user.username}-config.json`, interaction.commandName,
interaction.options.getNumber('context-capacity')
)
+1 -3
View File
@@ -1,13 +1,12 @@
import { Channel, Client, CommandInteraction, MessageFlags, TextChannel } from 'discord.js'
import { clearChannelInfo, SlashCommand, UserCommand } from '../utils/index.js'
import type { Logger as PinoLogger } from 'pino'
export const ClearUserChannelHistory: SlashCommand = {
name: 'clear-user-channel-history',
description: 'clears history for user in the current channel',
// Clear channel history for intended user
run: async (client: Client, interaction: CommandInteraction, logger: PinoLogger) => {
run: async (client: Client, interaction: CommandInteraction) => {
// fetch current channel
const channel: Channel | null = await client.channels.fetch(interaction.channelId)
@@ -16,7 +15,6 @@ export const ClearUserChannelHistory: SlashCommand = {
// clear channel info for user
const successfulWipe = await clearChannelInfo(
logger,
interaction.channelId,
interaction.channel as TextChannel,
interaction.user.username
+3 -3
View File
@@ -2,7 +2,6 @@ import { ApplicationCommandOptionType, ChatInputCommandInteraction, Client, Comm
import { UserCommand, SlashCommand } from '../utils/index.js'
import { ollama } from '../client.js'
import { ModelResponse } from 'ollama'
import type { Logger as PinoLogger } from 'pino'
export const DeleteModel: SlashCommand = {
name: 'delete-model',
@@ -19,7 +18,7 @@ export const DeleteModel: SlashCommand = {
],
// Delete Model locally stored
run: async (client: Client, interaction: ChatInputCommandInteraction, logger: PinoLogger) => {
run: async (client: Client, interaction: ChatInputCommandInteraction) => {
// defer reply to avoid timeout
await interaction.deferReply()
const modelInput: string = interaction.options.getString('model-name') as string
@@ -43,7 +42,7 @@ export const DeleteModel: SlashCommand = {
.then(response => response.models.some((model: ModelResponse) => model.name.startsWith(modelInput)))
.catch(error => {
ollamaOffline = true
logger.error({ err: error }, 'Failed to connect to Ollama service')
console.error(`[Command: delete-model] Failed to connect with Ollama service. Error: ${error.message}`)
})
// Validate for any issue or if service is running
@@ -54,6 +53,7 @@ export const DeleteModel: SlashCommand = {
return
}
try {
// call ollama to delete model
if (modelExists) {
+2 -3
View File
@@ -1,6 +1,5 @@
import { Client, ChatInputCommandInteraction, ApplicationCommandOptionType, MessageFlags } from 'discord.js'
import { AdminCommand, openConfig, SlashCommand } from '../utils/index.js'
import type { Logger as PinoLogger } from 'pino'
export const Disable: SlashCommand = {
name: 'toggle-chat',
@@ -17,7 +16,7 @@ export const Disable: SlashCommand = {
],
// Query for message information and set the style
run: async (client: Client, interaction: ChatInputCommandInteraction, logger: PinoLogger) => {
run: async (client: Client, interaction: ChatInputCommandInteraction) => {
// fetch channel and message
const channel = await client.channels.fetch(interaction.channelId)
if (!channel || !AdminCommand.includes(channel.type)) return
@@ -32,7 +31,7 @@ export const Disable: SlashCommand = {
}
// set state of bot chat features
openConfig(logger, `${interaction.guildId}-config.json`, interaction.commandName,
openConfig(`${interaction.guildId}-config.json`, interaction.commandName,
interaction.options.getBoolean('enabled')
)
+2 -3
View File
@@ -1,6 +1,5 @@
import { ApplicationCommandOptionType, Client, ChatInputCommandInteraction, MessageFlags } from 'discord.js'
import { openConfig, SlashCommand, UserCommand } from '../utils/index.js'
import type { Logger as PinoLogger } from 'pino'
export const MessageStream: SlashCommand = {
name: 'message-stream',
@@ -17,13 +16,13 @@ export const MessageStream: SlashCommand = {
],
// change preferences based on command
run: async (client: Client, interaction: ChatInputCommandInteraction, logger: PinoLogger) => {
run: async (client: Client, interaction: ChatInputCommandInteraction) => {
// verify channel
const channel = await client.channels.fetch(interaction.channelId)
if (!channel || !UserCommand.includes(channel.type)) return
// save value to json and write to it
openConfig(logger, `${interaction.user.username}-config.json`, interaction.commandName,
openConfig(`${interaction.user.username}-config.json`, interaction.commandName,
interaction.options.getBoolean('stream')
)
+2 -3
View File
@@ -2,7 +2,6 @@ import { ApplicationCommandOptionType, Client, ChatInputCommandInteraction, Mess
import { ollama } from "../client.js"
import { ModelResponse } from "ollama"
import { UserCommand, SlashCommand } from "../utils/index.js"
import type { Logger as PinoLogger } from 'pino'
export const PullModel: SlashCommand = {
name: 'pull-model',
@@ -19,7 +18,7 @@ export const PullModel: SlashCommand = {
],
// Pull for model from Ollama library
run: async (client: Client, interaction: ChatInputCommandInteraction, logger: PinoLogger) => {
run: async (client: Client, interaction: ChatInputCommandInteraction) => {
// defer reply to avoid timeout
await interaction.deferReply()
const modelInput: string = interaction.options.getString('model-to-pull') as string
@@ -43,7 +42,7 @@ export const PullModel: SlashCommand = {
.then(response => response.models.some((model: ModelResponse) => model.name.startsWith(modelInput)))
.catch(error => {
ollamaOffline = true
logger.error({ err: error }, 'Failed to connect to Ollama service')
console.error(`[Command: pull-model] Failed to connect with Ollama service. Error: ${error.message}`)
})
// Validate for any issue or if service is running
+3 -4
View File
@@ -1,19 +1,18 @@
import { Client, CommandInteraction, MessageFlags } from 'discord.js'
import { AdminCommand, SlashCommand } from '../utils/index.js'
import type { Logger as PinoLogger } from 'pino'
export const Shutoff: SlashCommand = {
name: 'shutoff',
description: 'shutdown the bot. You will need to manually bring it online again. Administrator Only.',
// Query for message information and set the style
run: async (client: Client, interaction: CommandInteraction, logger: PinoLogger) => {
run: async (client: Client, interaction: CommandInteraction) => {
// fetch channel and message
const channel = await client.channels.fetch(interaction.channelId)
if (!channel || !AdminCommand.includes(channel.type)) return
// log this, this will probably be improtant for logging who did this
logger.info({ actor: interaction.user.tag, bot: client.user!!.tag }, 'Shutdown requested')
console.log(`[Command: shutoff] User ${interaction.user.tag} attempting to shutdown ${client.user!!.tag}`)
// check if admin or false on shutdown
if (!interaction.memberPermissions?.has('Administrator')) {
@@ -30,7 +29,7 @@ export const Shutoff: SlashCommand = {
flags: MessageFlags.Ephemeral
})
logger.info({ bot: client.user?.tag }, 'Bot is shutting down')
console.log(`[Command: shutoff] ${client.user?.tag} is shutting down.`)
// clean up client instance and stop
client.destroy()
+5 -6
View File
@@ -1,6 +1,5 @@
import { Client, CommandInteraction, MessageFlags } from "discord.js";
import { accessChannelContext, SlashCommand, summarizeContextHistory, UserCommand, UserMessage } from "../utils/index.js";
import type { Logger as PinoLogger } from 'pino'
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 = {
@@ -8,7 +7,7 @@ export const Summary: SlashCommand = {
description: 'provides a summary of the chat history.',
// Generate Summary from additional context
run: async (client: Client, interaction: CommandInteraction, logger: PinoLogger) => {
run: async (client: Client, interaction: CommandInteraction) => {
// fetch channel
const channel = await client.channels.fetch(interaction.channelId)
if (!channel || !UserCommand.includes(channel.type)) return
@@ -42,9 +41,9 @@ export const Summary: SlashCommand = {
})
// todo: instead of a default of codellama, we can user default model somehow. Look into later.
const response: string = await summarizeContextHistory(logger, ollama, "codellama", channelContext)
const response: string = await summarizeContextHistory(ollama, "codellama", channelContext)
logger.info({ response }, 'Generated channel summary')
console.log(response)
interaction.editReply({ content: response })
}
+4 -5
View File
@@ -2,7 +2,6 @@ import { ApplicationCommandOptionType, Client, ChatInputCommandInteraction } fro
import { ollama } from "../client.js"
import { ModelResponse } from "ollama"
import { openConfig, UserCommand, SlashCommand } from "../utils/index.js"
import type { Logger as PinoLogger } from 'pino'
export const SwitchModel: SlashCommand = {
name: 'switch-model',
@@ -19,7 +18,7 @@ export const SwitchModel: SlashCommand = {
],
// Switch user preferred model if available in local library
run: async (client: Client, interaction: ChatInputCommandInteraction, logger: PinoLogger) => {
run: async (client: Client, interaction: ChatInputCommandInteraction) => {
await interaction.deferReply()
const modelInput: string = interaction.options.getString('model-to-use') as string
@@ -36,7 +35,7 @@ export const SwitchModel: SlashCommand = {
for (const model in response.models) {
const currentModel: ModelResponse = response.models[model]
if (currentModel.name.startsWith(modelInput)) {
openConfig(logger, `${interaction.user.username}-config.json`, interaction.commandName, modelInput)
openConfig(`${interaction.user.username}-config.json`, interaction.commandName, modelInput)
// successful switch
interaction.editReply({
@@ -47,12 +46,12 @@ export const SwitchModel: SlashCommand = {
}
})
.catch(error => {
logger.error({ err: error }, 'Failed to connect to Ollama service')
console.error(`[Command: switch-model] Failed to connect with Ollama service. Error: ${error.message}`)
})
// todo: problem can be here if async messes up
if (switchSuccess) {
// set model now that it exists
openConfig(logger, `${interaction.user.username}-config.json`, interaction.commandName, modelInput)
openConfig(`${interaction.user.username}-config.json`, interaction.commandName, modelInput)
return
}
+2 -3
View File
@@ -1,13 +1,12 @@
import { ChannelType, Client, CommandInteraction, MessageFlags, TextChannel, ThreadChannel } from 'discord.js'
import { AdminCommand, openChannelInfo, SlashCommand } from '../utils/index.js'
import type { Logger as PinoLogger } from 'pino'
export const ThreadCreate: SlashCommand = {
name: 'thread',
description: 'creates a thread and mentions user',
// Query for server information
run: async (client: Client, interaction: CommandInteraction, logger: PinoLogger) => {
run: async (client: Client, interaction: CommandInteraction) => {
// fetch the channel
const channel = await client.channels.fetch(interaction.channelId)
if (!channel || !AdminCommand.includes(channel.type)) return
@@ -22,7 +21,7 @@ export const ThreadCreate: SlashCommand = {
thread.send(`Hello ${interaction.user} and others! \n\nIt's nice to meet you. Please talk to me by typing **@${client.user?.username}** with your message.`)
// handle storing this chat channel
openChannelInfo(logger, thread.id, thread as ThreadChannel, interaction.user.tag)
openChannelInfo(thread.id, thread as ThreadChannel, interaction.user.tag)
// user only reply
return interaction.reply({
+2 -3
View File
@@ -1,13 +1,12 @@
import { ChannelType, Client, CommandInteraction, MessageFlags, TextChannel, ThreadChannel } from 'discord.js'
import { AdminCommand, openChannelInfo, SlashCommand } from '../utils/index.js'
import type { Logger as PinoLogger } from 'pino'
export const PrivateThreadCreate: SlashCommand = {
name: 'private-thread',
description: 'creates a private thread and mentions user',
// Query for server information
run: async (client: Client, interaction: CommandInteraction, logger: PinoLogger) => {
run: async (client: Client, interaction: CommandInteraction) => {
// fetch the channel
const channel = await client.channels.fetch(interaction.channelId)
if (!channel || !AdminCommand.includes(channel.type)) return
@@ -23,7 +22,7 @@ export const PrivateThreadCreate: SlashCommand = {
// handle storing this chat channel
// store: thread.id, thread.name
openChannelInfo(logger, thread.id, thread as ThreadChannel, interaction.user.tag)
openChannelInfo(thread.id, thread as ThreadChannel, interaction.user.tag)
// user only reply
return interaction.reply({
-2
View File
@@ -1,2 +0,0 @@
export * from './queue.js'
export * from './logger.js'
-15
View File
@@ -1,15 +0,0 @@
import 'dotenv/config'
import pino, { type Logger as PinoLogger } from 'pino'
import { pinoCaller } from 'pino-caller'
export const rootLogger = pino({
level: process.env.LOG_LEVEL ?? 'info'
})
export function createLogger(bindings: pino.Bindings, parent: PinoLogger = rootLogger): PinoLogger {
const childLogger = parent.child(bindings)
return process.env.NODE_ENV === 'production'
? childLogger
: pinoCaller(childLogger, { relativeTo: process.cwd() })
}
+3 -10
View File
@@ -1,26 +1,19 @@
import { event, Events } from '../utils/index.js'
import commands from '../commands/index.js'
import { createLogger } from '../components/index.js'
/**
* Interaction creation listener for the client
* @param interaction the interaction received from the server
*/
export default event(Events.InteractionCreate, async ({ logger, client }, interaction) => {
export default event(Events.InteractionCreate, async ({ log, client }, interaction) => {
if (!interaction.isCommand() || !interaction.isChatInputCommand()) return
logger.info({ command: interaction.commandName, user: interaction.user.tag }, 'Interaction received')
log(`Interaction called \'${interaction.commandName}\' from ${interaction.user.tag}.`)
// ensure command exists, otherwise kill event
const command = commands.find(command => command.name === interaction.commandName)
if (!command) return
// the command exists, execute it
const commandLogger = createLogger({
component: 'command',
command: command.name
}, logger)
void Promise.resolve(command.run(client, interaction, commandLogger))
.catch(error => commandLogger.error({ err: error }, 'Command execution failed'))
command.run(client, interaction)
})
+20 -19
View File
@@ -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, addToChannelContext,
getChannelInfo, getServerConfig, getUserConfig, openChannelInfo,
openConfig, UserConfig, getAttachmentData, getTextFileAttachmentData
} from '../utils/index.js'
@@ -11,10 +11,10 @@ import {
*
* @param message the message received from the channel
*/
export default event(Events.MessageCreate, async ({ logger, msgHist, channelHistory, ollama, client, defaultModel }, message) => {
export default event(Events.MessageCreate, async ({ log, msgHist, channelHistory, ollama, client, defaultModel }, message) => {
const clientId = client.user!!.id
let cleanedMessage = clean(message.content, clientId)
logger.info({ author: message.author.tag, channelId: message.channelId, message: cleanedMessage }, 'Received message')
log(`Message \"${cleanedMessage}\" from ${message.author.tag} in channel/thread ${message.channelId}.`)
// Do not respond if bot talks in the chat
if (message.author.username === message.client.user.username) return
@@ -25,7 +25,7 @@ export default event(Events.MessageCreate, async ({ logger, msgHist, channelHist
if (channelInfo?.messages)
resolve(channelInfo.messages)
else {
logger.info({ channelId: message.channelId }, 'Channel context does not exist; creating it')
log(`Channel/Thread ${message.channel}-context does not exist. File will be created shortly...`)
resolve([])
}
})
@@ -33,14 +33,14 @@ export default event(Events.MessageCreate, async ({ logger, msgHist, channelHist
if (channelContextHistory.length === 0) {
channelContextHistory = await new Promise((resolve) => {
addToChannelContext(logger, message.channelId,
addToChannelContext(message.channelId,
message.channel as TextChannel
)
getChannelInfo(`${message.channelId}-context.json`, (channelInfo) => {
if (channelInfo?.messages)
resolve(channelInfo.messages)
else {
logger.info({ channelId: message.channelId }, 'Channel context does not exist; creating it')
log(`Channel/Thread ${message.channel}-context does not exist. File will be created shortly...`)
}
})
})
@@ -61,6 +61,7 @@ export default event(Events.MessageCreate, async ({ logger, msgHist, channelHist
while (channelHistory.size() >= channelHistory.capacity) channelHistory.dequeue()
// push user response to channel history
console.log
channelHistory.enqueue({
role: 'user',
content: cleanedMessage,
@@ -68,7 +69,7 @@ export default event(Events.MessageCreate, async ({ logger, msgHist, channelHist
})
// Store in Channel Context
addToChannelContext(logger, message.channelId,
addToChannelContext(message.channelId,
message.channel as TextChannel,
channelHistory.getItems()
)
@@ -93,7 +94,7 @@ export default event(Events.MessageCreate, async ({ logger, msgHist, channelHist
// check if config.json exists
if (config === undefined) {
// Allowing chat options to be available
openConfig(logger, `${message.guildId}-config.json`, 'toggle-chat', true)
openConfig(`${message.guildId}-config.json`, 'toggle-chat', true)
reject(new Error('Failed to locate or create Server Preferences\n\nPlease try chatting again...'))
}
@@ -108,7 +109,7 @@ export default event(Events.MessageCreate, async ({ logger, msgHist, channelHist
} catch (error) {
++attempt
if (attempt < maxRetries) {
logger.warn({ attempt, delay }, 'Failed to retrieve server preferences; retrying')
log(`Attempt ${attempt} failed for Server Preferences. Retrying in ${delay}ms...`)
await new Promise(ret => setTimeout(ret, delay))
} else
throw new Error(`Could not retrieve Server Preferences, please try chatting again...`)
@@ -125,18 +126,18 @@ export default event(Events.MessageCreate, async ({ logger, msgHist, channelHist
userConfig = await new Promise((resolve, reject) => {
getUserConfig(`${message.author.username}-config.json`, (config) => {
if (config === undefined) {
openConfig(logger, `${message.author.username}-config.json`, 'switch-model', defaultModel)
openConfig(`${message.author.username}-config.json`, 'switch-model', defaultModel)
reject(new Error(`No User Preferences is set up.\n\nCreating new preferences file for ${message.author.username}\nPlease try chatting again.`))
return
}
// check if there is a set capacity in config
else if (typeof config.options['modify-capacity'] !== 'number')
logger.info({ capacity: msgHist.capacity }, 'Capacity is undefined; using default')
log(`Capacity is undefined, using default capacity of ${msgHist.capacity}.`)
else if (config.options['modify-capacity'] === msgHist.capacity)
logger.info({ capacity: msgHist.capacity }, 'Configured capacity matches current capacity')
log(`Capacity matches config as ${msgHist.capacity}, no changes made.`)
else {
logger.info({ capacity: config.options['modify-capacity'] }, 'Updating context capacity')
log(`New Capacity found. Setting Context Capacity to ${config.options['modify-capacity']}.`)
msgHist.capacity = config.options['modify-capacity']
}
@@ -153,7 +154,7 @@ export default event(Events.MessageCreate, async ({ logger, msgHist, channelHist
} catch (error) {
++attempt
if (attempt < maxRetries) {
logger.warn({ attempt, delay }, 'Failed to retrieve user preferences; retrying')
log(`Attempt ${attempt} failed for User Preferences. Retrying in ${delay}ms...`)
await new Promise(ret => setTimeout(ret, delay))
} else
throw new Error(`Could not retrieve User Preferences, please try chatting again...`)
@@ -167,7 +168,7 @@ export default event(Events.MessageCreate, async ({ logger, msgHist, channelHist
if (channelInfo?.messages)
resolve(channelInfo.messages)
else {
logger.info({ channelId: message.channelId, username: message.author.username }, 'User channel history does not exist; creating it')
log(`Channel/Thread ${message.channel}-${message.author.username} does not exist. File will be created shortly...`)
resolve([])
}
})
@@ -175,7 +176,7 @@ export default event(Events.MessageCreate, async ({ logger, msgHist, channelHist
if (chatMessages.length === 0) {
chatMessages = await new Promise((resolve, reject) => {
openChannelInfo(logger, message.channelId,
openChannelInfo(message.channelId,
message.channel as TextChannel,
message.author.tag
)
@@ -183,7 +184,7 @@ export default event(Events.MessageCreate, async ({ logger, msgHist, channelHist
if (channelInfo?.messages)
resolve(channelInfo.messages)
else {
logger.info({ channelId: message.channelId, username: message.author.username }, 'User channel history does not exist; creating it')
log(`Channel/Thread ${message.channel}-${message.author.username} does not exist. File will be created shortly...`)
reject(new Error(`Failed to find ${message.author.username}'s history. Try chatting again.`))
}
})
@@ -209,7 +210,7 @@ export default event(Events.MessageCreate, async ({ logger, msgHist, channelHist
})
// response string for ollama to put its response
const response: string = await normalMessage(logger, message, ollama, model, msgHist, shouldStream)
const response: string = await normalMessage(message, ollama, model, msgHist, shouldStream)
// If something bad happened, remove user query and stop
if (response == undefined) { msgHist.pop(); return }
@@ -225,7 +226,7 @@ export default event(Events.MessageCreate, async ({ logger, msgHist, channelHist
})
// only update the json on success
openChannelInfo(logger, message.channelId,
openChannelInfo(message.channelId,
message.channel as TextChannel,
message.author.tag,
msgHist.getItems()
+3 -3
View File
@@ -3,9 +3,9 @@ import { event, Events, registerCommands } from '../utils/index.js'
import commands from '../commands/index.js'
// Log when the bot successfully logs in and export it
export default event(Events.ClientReady, ({ logger }, client) => {
export default event(Events.ClientReady, ({ log }, client) => {
// Register the commands associated with the bot upon loggin in
registerCommands(client, commands, logger)
registerCommands(client, commands)
// set status of the bot
client.user.setActivity({
@@ -13,5 +13,5 @@ export default event(Events.ClientReady, ({ logger }, client) => {
type: ActivityType.Custom
})
logger.info({ username: client.user.username }, 'Client ready')
log(`Logged in as ${client.user.username}.`)
})
+6 -6
View File
@@ -5,16 +5,16 @@ import fs from 'fs'
/**
* Event to remove the associated .json file for a thread once deleted
*/
export default event(Events.ThreadDelete, async ({ logger }, thread: ThreadChannel) => {
export default event(Events.ThreadDelete, async ({ log }, thread: ThreadChannel) => {
// iterate through every guild member in the thread and delete their history, except the bot
try {
logger.info({ memberCount: thread.memberCount!! - 1 }, 'Deleting thread history')
log(`Number of User Guild Members in Thread being deleted: ${thread.memberCount!! - 1}`)
const dirPath = 'data/'
// read all files in data/
fs.readdir(dirPath, (error, files) => {
if (error) {
logger.error({ err: error, directory: dirPath }, 'Failed to read history directory')
log(`Error reading directory ${dirPath}`, error)
return
}
@@ -28,13 +28,13 @@ export default event(Events.ThreadDelete, async ({ logger }, thread: ThreadChann
const filePath = dirPath + file
fs.unlink(filePath, error => {
if (error)
logger.error({ err: error, file: filePath }, 'Failed to delete thread history file')
log(`Error deleting file ${filePath}`, error)
else
logger.info({ file: filePath }, 'Deleted thread history file')
log(`Successfully deleted ${filePath} thread information`)
})
})
})
} catch (error) {
logger.error({ err: error, threadId: thread.id }, 'Failed to delete user history files')
log(`Issue deleting user history files from ${thread.id}`)
}
})
+2 -2
View File
@@ -2,8 +2,8 @@ import { getEnvVar } from './utils/index.js'
export const Keys = {
clientToken: getEnvVar('CLIENT_TOKEN'),
ipAddress: getEnvVar('LLM_ENDPOINT', process.env.OLLAMA_IP ?? '127.0.0.1'), // OLLAMA_IP is a deprecated alias
portAddress: getEnvVar('LLM_PORT', process.env.OLLAMA_PORT ?? '11434'), // OLLAMA_PORT is a deprecated alias
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
+8 -19
View File
@@ -1,5 +1,4 @@
import { ChatInputCommandInteraction, ChatInputApplicationCommandData, Client, type Awaitable } from 'discord.js'
import type { Logger as PinoLogger } from 'pino'
import { ChatInputCommandInteraction, ChatInputApplicationCommandData, Client, ApplicationCommandOption } from 'discord.js'
/**
* interface for how slash commands should be run
@@ -8,8 +7,8 @@ export interface SlashCommand extends ChatInputApplicationCommandData {
run: (
client: Client,
interaction: ChatInputCommandInteraction,
logger: PinoLogger
) => Awaitable<unknown>
options?: ApplicationCommandOption[]
) => void
}
/**
@@ -17,7 +16,7 @@ export interface SlashCommand extends ChatInputApplicationCommandData {
* @param client the bot reference
* @param commands commands to register to the bot
*/
export function registerCommands(client: Client, commands: SlashCommand[], logger: PinoLogger): void {
export function registerCommands(client: Client, commands: SlashCommand[]): void {
// ensure the bot is online before registering
if (!client.application) return
@@ -28,15 +27,10 @@ export function registerCommands(client: Client, commands: SlashCommand[], logge
client.application.commands.fetch().then((fetchedCommands) => {
for (const command of fetchedCommands.values()) {
if (!commandsToRegister.includes(command.name)) {
command.delete().then(() => {
logger.info({ command: command.name }, 'Removed command from Discord')
}).catch(error => {
logger.error({ err: error, command: command.name }, 'Failed to remove command from Discord')
})
command.delete().catch(console.error)
console.log(`[Command: ${command.name}] Removed from Discord`)
}
}
}).catch(error => {
logger.error({ err: error }, 'Failed to fetch registered commands')
})
// clear the cache of the commands
@@ -47,12 +41,7 @@ export function registerCommands(client: Client, commands: SlashCommand[], logge
client.application.commands
.create(command)
.then((c) => {
logger.info({
command: c.name,
options: c.options?.map(option => option.name) ?? []
}, 'Registered command on Discord')
})
.catch(error => {
logger.error({ err: error, command: command.name }, 'Failed to register command on Discord')
console.log(`[Command: ${c.name}] Registered on Discord`)
c.options?.forEach((o) => console.log(` - ${o.name}`))
})
}
+1 -1
View File
@@ -26,7 +26,7 @@ export function getEnvVar(name: string, fallback?: string): string {
This is probably an invalid token unless Discord updated their token policy. Please provide a valid token.`)
// validate IPv4 address found in environment variables
if ((name.endsWith("_IP") || name.endsWith("_ADDRESS") || name.endsWith("_ENDPOINT")) && !ipValidate.test(value))
if ((name.endsWith("_IP") || name.endsWith("_ADDRESS")) && !ipValidate.test(value))
throw new Error(`Environment variable ${name} does not follow IPv4 formatting.`)
// return env variable
+7 -8
View File
@@ -1,12 +1,11 @@
import type { ClientEvents, Awaitable, Client } from 'discord.js'
import { Ollama } from 'ollama'
import { Queue, createLogger } from '../components/index.js'
import type { Logger as PinoLogger } from 'pino'
import { Queue } from '../queues/queue.js'
// Export events through here to reduce amount of imports
export { Events } from 'discord.js'
export type LogMethod = PinoLogger
export type LogMethod = (...args: unknown[]) => void
export type EventKeys = keyof ClientEvents // only wants keys of ClientEvents object
/**
@@ -36,7 +35,7 @@ export type UserMessage = {
// Event properties
export interface EventProps {
client: Client,
logger: LogMethod,
log: LogMethod,
msgHist: Queue<UserMessage>,
channelHistory: Queue<UserMessage>,
ollama: Ollama,
@@ -86,14 +85,14 @@ export function registerEvents(
): void {
for (const { key, callback } of events) {
client.on(key, (...args) => {
const logger = createLogger({ component: 'event', event: key })
// Create a new log method for this event
const log = console.log.bind(console, `[Event: ${key}]`)
// Handle Errors, call callback, log errors as needed
try {
void Promise.resolve(callback({ client, logger, msgHist, channelHistory, ollama, defaultModel }, ...args))
.catch(error => logger.error({ err: error }, 'Uncaught event error'))
callback({ client, log, msgHist, channelHistory, ollama, defaultModel }, ...args)
} catch (error) {
logger.error({ err: error }, 'Uncaught event error')
log('[Uncaught Error]', error)
}
})
}
+8 -9
View File
@@ -2,7 +2,6 @@ import { TextChannel, ThreadChannel } from 'discord.js'
import { Configuration, Channel, UserMessage } from '../index.js'
import fs from 'fs'
import path from 'path'
import type { Logger as PinoLogger } from 'pino'
/**
* Method to check if a thread history file exists
@@ -30,7 +29,7 @@ async function checkChannelInfoExists(channel: TextChannel, user: string) {
* @param user username of user
* @returns nothing
*/
export async function clearChannelInfo(logger: PinoLogger, filename: string, channel: TextChannel, user: string): Promise<boolean> {
export async function clearChannelInfo(filename: string, channel: TextChannel, user: string): Promise<boolean> {
const channelInfoExists: boolean = await checkChannelInfoExists(channel, user)
// If thread does not exist, file can't be found
@@ -41,7 +40,7 @@ export async function clearChannelInfo(logger: PinoLogger, filename: string, cha
const cleanedHistory: boolean = await new Promise((resolve) => {
fs.readFile(fullFileName, 'utf8', (error, data) => {
if (error)
logger.error({ err: error, file: fullFileName }, 'Failed to read channel history')
console.log(`[Error: openChannelInfo] Incorrect file format`)
else {
const object = JSON.parse(data)
if (object['messages'].length === 0) // already empty, let user know
@@ -57,12 +56,12 @@ export async function clearChannelInfo(logger: PinoLogger, filename: string, cha
return cleanedHistory
}
export async function addToChannelContext(logger: PinoLogger, filename: string, channel: TextChannel | ThreadChannel, messages: UserMessage[] = []): Promise<void> {
export async function addToChannelContext(filename: string, channel : TextChannel | ThreadChannel, messages: UserMessage[] = []): Promise<void> {
const fullFileName = `data/${filename}-context.json`
if (fs.existsSync(fullFileName)) {
fs.readFile(fullFileName, 'utf8', (error, data) => {
if (error)
logger.error({ err: error, file: fullFileName }, 'Failed to read channel context')
console.log(`[Error: addToChannelContext] Incorrect file format`)
else {
const object = JSON.parse(data)
if (object['messages'].length === 0)
@@ -86,7 +85,7 @@ export async function addToChannelContext(logger: PinoLogger, filename: string,
fs.mkdirSync(directory, { recursive: true })
fs.writeFileSync(fullFileName, JSON.stringify(object, null, 2))
logger.info({ file: fullFileName }, 'Created channel context')
console.log(`[Util: addToChannelContext] Created '${fullFileName}' in working directory`)
}
}
@@ -113,12 +112,12 @@ export async function accessChannelContext(filename: string, callback: (config:
* @param user the user's name
* @param messages their messages
*/
export async function openChannelInfo(logger: PinoLogger, filename: string, channel: TextChannel | ThreadChannel, user: string, messages: UserMessage[] = []): Promise<void> {
export async function openChannelInfo(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) => {
if (error)
logger.error({ err: error, file: fullFileName }, 'Failed to read channel history')
console.log(`[Error: openChannelInfo] Incorrect file format`)
else {
const object = JSON.parse(data)
if (object['messages'].length === 0)
@@ -144,7 +143,7 @@ export async function openChannelInfo(logger: PinoLogger, filename: string, chan
// only creating it, no need to add anything
fs.writeFileSync(fullFileName, JSON.stringify(object, null, 2))
logger.info({ file: fullFileName }, 'Created channel history')
console.log(`[Util: openChannelInfo] Created '${fullFileName}' in working directory`)
}
}
+3 -4
View File
@@ -1,7 +1,6 @@
import { Configuration, ServerConfig, UserConfig, isServerConfigurationKey } from '../index.js'
import fs from 'fs'
import path from 'path'
import type { Logger as PinoLogger } from 'pino'
/**
* Method to open a file in the working directory and modify/create it
@@ -11,14 +10,14 @@ import type { Logger as PinoLogger } from 'pino'
* @param value new value to assign
*/
// add type of change (server, user)
export function openConfig(logger: PinoLogger, filename: string, key: string, value: any) {
export function openConfig(filename: string, key: string, value: any) {
const fullFileName = `data/${filename}`
// check if the file exists, if not then make the config file
if (fs.existsSync(fullFileName)) {
fs.readFile(fullFileName, 'utf8', (error, data) => {
if (error)
logger.error({ err: error, file: fullFileName }, 'Failed to read configuration file')
console.log(`[Error: openConfig] Incorrect file format`)
else {
const object = JSON.parse(data)
object['options'][key] = value
@@ -42,7 +41,7 @@ export function openConfig(logger: PinoLogger, filename: string, key: string, va
fs.mkdirSync(directory, { recursive: true })
fs.writeFileSync(`data/${filename}`, JSON.stringify(object, null, 2))
logger.info({ file: fullFileName }, 'Created configuration file')
console.log(`[Util: openConfig] Created '${filename}' in working directory`)
}
}
+2 -1
View File
@@ -1,5 +1,6 @@
import { ChatResponse, AbortableAsyncIterator } from "ollama"
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
+11 -12
View File
@@ -1,8 +1,8 @@
import { Message, SendableChannels } from 'discord.js'
import { ChatResponse, Ollama, AbortableAsyncIterator } from 'ollama'
import type { Logger as PinoLogger } from 'pino'
import { ChatResponse, Ollama } from 'ollama'
import { ChatParams, UserMessage, streamResponse, blockResponse } from './index.js'
import { Queue } from '../components/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
@@ -11,7 +11,6 @@ import { Queue } from '../components/index.js'
* @param msgHist message history between user and model
*/
export async function normalMessage(
logger: PinoLogger,
message: Message,
ollama: Ollama,
model: string,
@@ -50,7 +49,7 @@ export async function normalMessage(
if (result.length > 5)
messageBlock.edit(result)
}
logger.debug({ response: result }, 'Received response chunk')
console.log(result)
}
}
else {
@@ -78,11 +77,12 @@ export async function normalMessage(
sentMessage.edit(result)
}
} catch (error: any) {
logger.error({ err: error, model }, 'Failed to create message response')
if (error.message.includes('try pulling it first'))
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
sentMessage.edit(`**Response generation failed.**\n\nReason: ${error.message}`)
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.`
sentMessage.edit(`**Response generation failed.**\n\nReason: ${error.message}`)
}
})
@@ -91,7 +91,6 @@ export async function normalMessage(
}
export async function summarizeContextHistory(
logger: PinoLogger,
ollama: Ollama,
model: string,
msgHist: UserMessage[],
@@ -111,7 +110,7 @@ export async function summarizeContextHistory(
return result
} catch (error: any) {
logger.error({ err: error, model }, 'Failed to summarize channel history')
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'))
+1 -1
View File
@@ -26,6 +26,6 @@ describe('Events Existence', () => {
// test specific events in the object
it('references specific events', () => {
const eventsString = events.map(e => e.key.toString()).join(', ')
expect(eventsString).toBe('clientReady, messageCreate, interactionCreate, threadDelete')
expect(eventsString).toBe('ready, messageCreate, interactionCreate, threadDelete')
})
})
-24
View File
@@ -47,28 +47,4 @@ describe('Environment Setup', () => {
it('throws an error if key is not found', () => {
expect(() => getEnvVar('NON_EXISTENT_KEY')).toThrowError()
})
// test that *_ENDPOINT keys are validated as IPv4 addresses like *_IP keys
it('validates *_ENDPOINT keys as IPv4', () => {
expect(getEnvVar('UNSET_TEST_ENDPOINT', '127.0.0.1')).toBe('127.0.0.1')
expect(() => getEnvVar('UNSET_TEST_ENDPOINT', 'not-an-ip')).toThrowError()
})
// test the deprecated alias lookup used in src/keys.ts
it('falls back to the deprecated OLLAMA_IP / OLLAMA_PORT aliases', () => {
const saved = { LLM_ENDPOINT: process.env.LLM_ENDPOINT, LLM_PORT: process.env.LLM_PORT }
delete process.env.LLM_ENDPOINT
delete process.env.LLM_PORT
process.env.OLLAMA_IP = '10.0.0.5'
process.env.OLLAMA_PORT = '17434'
try {
expect(getEnvVar('LLM_ENDPOINT', process.env.OLLAMA_IP ?? '127.0.0.1')).toBe('10.0.0.5')
expect(getEnvVar('LLM_PORT', process.env.OLLAMA_PORT ?? '11434')).toBe('17434')
} finally {
delete process.env.OLLAMA_IP
delete process.env.OLLAMA_PORT
if (saved.LLM_ENDPOINT !== undefined) process.env.LLM_ENDPOINT = saved.LLM_ENDPOINT
if (saved.LLM_PORT !== undefined) process.env.LLM_PORT = saved.LLM_PORT
}
})
})
-64
View File
@@ -1,64 +0,0 @@
import { Writable } from 'node:stream'
import pino from 'pino'
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
import { createLogger } from '../src/components/logger.js'
describe('Pino logger', () => {
let output = ''
const destination = new Writable({
write(chunk, _encoding, callback) {
output += chunk.toString()
callback()
}
})
const parentLogger = pino({ level: 'trace' }, destination)
beforeEach(() => {
vi.stubEnv('NODE_ENV', 'test')
})
afterEach(() => {
vi.unstubAllEnvs()
})
it('creates a child logger with component and caller metadata', () => {
output = ''
const logger = createLogger({ component: 'test' }, parentLogger)
logger.info('bound message')
const entry = JSON.parse(output)
expect(entry.msg).toBe('bound message')
expect(entry.component).toBe('test')
expect(entry.caller).toMatch(/logger\.test\.ts:\d+:\d+/)
})
it('supports native Pino levels and structured log fields', () => {
output = ''
const logger = createLogger({ component: 'test' }, parentLogger)
logger.warn({ answer: 42 }, 'warning')
const entry = JSON.parse(output)
expect(entry.level).toBe(40)
expect(entry.answer).toBe(42)
expect(entry.msg).toBe('warning')
})
it('preserves parent context when adding command bindings', () => {
output = ''
const eventLogger = createLogger({
component: 'event',
event: 'InteractionCreate'
}, parentLogger)
const commandLogger = createLogger({
component: 'command',
command: 'summary'
}, eventLogger)
commandLogger.info('command started')
const entry = JSON.parse(output)
expect(entry.component).toBe('command')
expect(entry.event).toBe('InteractionCreate')
expect(entry.command).toBe('summary')
})
})
-123
View File
@@ -1,123 +0,0 @@
import { mkdtempSync, rmSync } from 'node:fs'
import { tmpdir } from 'node:os'
import { join } from 'node:path'
import { Writable } from 'node:stream'
import { ChannelType, type ChatInputCommandInteraction, type Client, type TextChannel } from 'discord.js'
import pino from 'pino'
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
import { createLogger } from '../src/components/logger.js'
import { Capacity } from '../src/commands/capacity.js'
import { openChannelInfo } from '../src/utils/handlers/chatHistoryHandler.js'
import { registerCommands, type SlashCommand } from '../src/utils/commands.js'
describe('logger context integration', () => {
let output = ''
const destination = new Writable({
write(chunk, _encoding, callback) {
output += chunk.toString()
callback()
}
})
const parentLogger = pino({ level: 'trace' }, destination)
let workingDirectory: string
let tempDirectory: string | undefined
beforeEach(() => {
output = ''
workingDirectory = process.cwd()
vi.stubEnv('NODE_ENV', 'test')
})
afterEach(() => {
process.chdir(workingDirectory)
if (tempDirectory)
rmSync(tempDirectory, { recursive: true, force: true })
vi.unstubAllEnvs()
})
it('retains event and command context in registration and handler logs', async () => {
const readyLogger = createLogger({
component: 'event',
event: 'ClientReady'
}, parentLogger)
const commandsApi = {
fetch: vi.fn().mockResolvedValue(new Map()),
cache: { clear: vi.fn() },
create: vi.fn(async (command: SlashCommand) => ({
name: command.name,
options: []
}))
}
const client = {
application: { commands: commandsApi }
} as unknown as Client
const mockCommand = {
name: 'test-command',
description: 'test command',
run: vi.fn()
} as unknown as SlashCommand
registerCommands(client, [mockCommand], readyLogger)
const commandLogger = createLogger({
component: 'command',
command: 'modify-capacity'
}, createLogger({
component: 'event',
event: 'InteractionCreate'
}, parentLogger))
const interaction = {
channelId: 'test-channel',
commandName: 'modify-capacity',
user: { username: 'test-user' },
options: {
getNumber: () => 8,
get: () => ({ value: 8 })
},
reply: vi.fn()
} as unknown as ChatInputCommandInteraction
const commandClient = {
channels: {
fetch: vi.fn().mockResolvedValue({ type: ChannelType.GuildText })
}
} as unknown as Client
tempDirectory = mkdtempSync(join(tmpdir(), 'discord-ollama-logger-'))
process.chdir(tempDirectory)
await Capacity.run(commandClient, interaction, commandLogger)
await openChannelInfo(commandLogger, 'test-channel', {
id: 'test-channel',
name: 'test'
} as TextChannel, 'test-user')
await new Promise(resolve => setImmediate(resolve))
const entries = output.trim().split('\n').map(line => JSON.parse(line))
const registration = entries.find(entry => entry.msg === 'Registered command on Discord')
expect(registration).toMatchObject({
event: 'ClientReady',
command: 'test-command',
msg: 'Registered command on Discord'
})
const configuration = entries.find(entry => entry.msg === 'Created configuration file')
expect(configuration).toMatchObject({
event: 'InteractionCreate',
component: 'command',
command: 'modify-capacity',
msg: 'Created configuration file'
})
expect(configuration.caller).toMatch(/configHandler\.ts:\d+:\d+/)
const history = entries.find(entry => entry.msg === 'Created channel history')
expect(history).toMatchObject({
event: 'InteractionCreate',
component: 'command',
command: 'modify-capacity',
msg: 'Created channel history'
})
expect(history.caller).toMatch(/chatHistoryHandler\.ts:\d+:\d+/)
})
})
+1 -1
View File
@@ -1,5 +1,5 @@
import { describe, expect, it } from 'vitest'
import { Queue } from '../src/components/index.js'
import { Queue } from '../src/queues/queue.js'
/**
* Queue test suite, tests the Queue class
+2 -1
View File
@@ -18,8 +18,9 @@
// Decompile .ts to .js into a folder named build
"outDir": "build",
"rootDir": "src",
"baseUrl": ".",
"paths": {
"*": ["./node_modules/"]
"*": ["node_modules/"]
}
},
// environment for env vars
+7 -2
View File
@@ -1,9 +1,14 @@
import { defineConfig } from 'vitest/config'
import { defineConfig, configDefaults } 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: {
include: ['src/**/*.ts'],
reporter: 'lcov',
reportsDirectory: './coverage'
}
}
})