mirror of
https://github.com/kevinthedang/discord-ollama.git
synced 2026-11-08 10:51:18 -05:00
Compare commits
1
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
 snyk-bot
|
029e018dae |
+8
-6
@@ -4,14 +4,16 @@ 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.
|
||||
SUBNET_ADDRESS = ADDRESS
|
||||
|
||||
# redis port and ip, default redis port is 6379
|
||||
REDIS_IP = IP_ADDRESS
|
||||
REDIS_PORT = PORT
|
||||
@@ -8,10 +8,10 @@ assignees: ''
|
||||
---
|
||||
|
||||
## Issue
|
||||
A clear and concise description of what the problem/feature is. PLease describe it as best as possible.
|
||||
A clear and concise description of what the problem/feature is.
|
||||
|
||||
## Solution
|
||||
* Provide steps or ideas to how to implement or investigate this new feature.
|
||||
* Provide steps or ideals to how to implement or investigate this new feature.
|
||||
|
||||
## References
|
||||
* Provide additional context and external references here
|
||||
|
||||
+17
-15
@@ -1,6 +1,5 @@
|
||||
name: Builds
|
||||
run-name: Validate Node and Docker Builds
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
@@ -10,16 +9,15 @@ 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
|
||||
- name: Set up Node Environment lts/jod
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: lts/krypton
|
||||
cache: npm
|
||||
node-version: lts/jod
|
||||
cache: "npm"
|
||||
|
||||
- name: Install Project Dependencies
|
||||
run: |
|
||||
@@ -33,9 +31,11 @@ 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
|
||||
echo REDIS_IP = ${{ secrets.REDIS_IP }} >> .env
|
||||
echo REDIS_PORT = ${{ secrets.REDIS_PORT }} >> .env
|
||||
|
||||
# set -e ensures if nohup fails, this section fails
|
||||
- name: Startup Discord Bot Client
|
||||
@@ -45,24 +45,26 @@ 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
|
||||
|
||||
- name: Set up Node Environment
|
||||
- name: Set up Node Environment lts/jod
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: lts/krypton
|
||||
cache: npm
|
||||
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
|
||||
echo REDIS_IP = ${{ secrets.REDIS_IP }} >> .env
|
||||
echo REDIS_PORT = ${{ secrets.REDIS_PORT }} >> .env
|
||||
|
||||
- name: Setup Docker Network and Images
|
||||
run: |
|
||||
@@ -70,8 +72,8 @@ jobs:
|
||||
|
||||
- name: Check Images Exist
|
||||
run: |
|
||||
(docker images | grep -q 'kevinthedang/discord-ollama' && docker images | grep -qE 'ollama/ollama') || exit 1
|
||||
(docker images | grep -q 'kevinthedang/discord-ollama' && docker images | grep -qE 'ollama/ollama' | docker images | grep -qE 'redis') || exit 1
|
||||
|
||||
- name: Check Containers Exist
|
||||
run: |
|
||||
(docker ps | grep -q 'ollama' && docker ps | grep -q 'discord') || exit 1
|
||||
(docker ps | grep -q 'ollama' && docker ps | grep -q 'discord' && docker ps | grep -q 'redis') || exit 1
|
||||
|
||||
@@ -0,0 +1,52 @@
|
||||
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
|
||||
echo REDIS_IP = ${{ secrets.REDIS_IP }} >> .env
|
||||
echo REDIS_PORT = ${{ secrets.REDIS_PORT }} >> .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
|
||||
@@ -1,14 +1,15 @@
|
||||
name: Deploy
|
||||
run-name: Deploy Application Latest
|
||||
|
||||
on: workflow_dispatch
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- 'v*'
|
||||
|
||||
jobs:
|
||||
Deploy-Application:
|
||||
runs-on: self-hosted
|
||||
environment: deploy
|
||||
timeout-minutes: 5
|
||||
|
||||
steps:
|
||||
- name: Checkout Repo
|
||||
uses: actions/checkout@v4
|
||||
@@ -18,11 +19,13 @@ 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
|
||||
echo REDIS_IP = ${{ secrets.REDIS_IP }} >> .env
|
||||
echo REDIS_PORT = ${{ secrets.REDIS_PORT }} >> .env
|
||||
|
||||
- name: Check if directory exists and delete it
|
||||
run: |
|
||||
@@ -38,7 +41,7 @@ jobs:
|
||||
git clone https://github.com/kevinthedang/discord-ollama.git ${{ secrets.PATH }}
|
||||
cd ${{ secrets.PATH }}
|
||||
|
||||
- name: Install nvm and Node.js
|
||||
- name: Install nvm and Node.js lts/jod
|
||||
run: |
|
||||
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash
|
||||
export NVM_DIR="$HOME/.nvm"
|
||||
@@ -56,6 +59,7 @@ jobs:
|
||||
npm install
|
||||
|
||||
IMAGE="kevinthedang/discord-ollama"
|
||||
REDIS="redis"
|
||||
OLLAMA="ollama/ollama"
|
||||
|
||||
if docker images | grep -q $IMAGE; then
|
||||
@@ -71,6 +75,19 @@ jobs:
|
||||
echo "Old $IMAGE Image Removed"
|
||||
fi
|
||||
|
||||
if docker images | grep -q $REDIS; then
|
||||
IMAGE_ID=$(docker images -q $REDIS)
|
||||
CONTAINER_IDS=$(docker ps -q --filter "ancestor=$IMAGE_ID")
|
||||
|
||||
if [ ! -z "$CONTAINER_IDS" ]; then
|
||||
# Stop and remove the running containers
|
||||
docker stop $CONTAINER_IDS
|
||||
echo "Stopped and removed the containers using the image $REDIS"
|
||||
fi
|
||||
docker rmi $IMAGE_ID
|
||||
echo "Old $REDIS Image Removed"
|
||||
fi
|
||||
|
||||
if docker images | grep -q $OLLAMA; then
|
||||
IMAGE_ID=$(docker images -q $OLLAMA)
|
||||
CONTAINER_IDS=$(docker ps -q --filter "ancestor=$IMAGE_ID")
|
||||
@@ -100,6 +117,14 @@ jobs:
|
||||
--ip ${{ secrets.OLLAMA_IP }} \
|
||||
ollama/ollama:latest
|
||||
|
||||
docker run --rm -d \
|
||||
-v redis:/root/.redis \
|
||||
-p ${{ secrets.REDIS_PORT }}:${{ secrets.REDIS_PORT }} \
|
||||
--name redis \
|
||||
--network ollama-net \
|
||||
--ip ${{ secrets.REDIS_IP }} \
|
||||
redis:latest
|
||||
|
||||
docker run --rm -d \
|
||||
-v discord:/src/app \
|
||||
--name discord \
|
||||
|
||||
@@ -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
|
||||
@@ -1,6 +1,5 @@
|
||||
name: Tests
|
||||
run-name: Unit Tests
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
branches:
|
||||
@@ -20,19 +19,17 @@ on:
|
||||
|
||||
jobs:
|
||||
Discord-Node-Test:
|
||||
if: ${{ github.event.pull_request.head.repo.fork == false }}
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 2
|
||||
|
||||
steps:
|
||||
- name: Checkout Repository
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Node Environment
|
||||
- name: Set up Node Environment lts/jod
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: lts/jod
|
||||
cache: npm
|
||||
cache: "npm"
|
||||
|
||||
- name: Install Project Dependencies
|
||||
run: |
|
||||
@@ -42,9 +39,11 @@ 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
|
||||
echo REDIS_IP = ${{ secrets.REDIS_IP }} >> .env
|
||||
echo REDIS_PORT = ${{ secrets.REDIS_PORT }} >> .env
|
||||
|
||||
- name: Test Application
|
||||
run: |
|
||||
|
||||
+10
@@ -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
@@ -12,7 +12,7 @@
|
||||
# Technical/Business Code Ownership
|
||||
/src/ @kevinthedang @JT2M0L3Y
|
||||
/tests/ @JT2M0L3Y
|
||||
/.github/ @kevinthedang @JT2M0L3Y
|
||||
/.github/ @kevinthedang
|
||||
|
||||
# Docker Ownership
|
||||
Dockerfile @kevinthedang
|
||||
|
||||
+2
-2
@@ -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
|
||||
|
||||
@@ -4,48 +4,43 @@
|
||||
<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="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/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/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/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
|
||||
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 Preferences on Chat
|
||||
* [x] Message Persistance on Channels and Threads
|
||||
* [x] Threads
|
||||
* [x] Channels
|
||||
* [x] Containerization with Docker
|
||||
* [x] Slash Commands Compatible
|
||||
* [x] Generated Token Length Handling for >2000
|
||||
* [x] Token Length Handling of any message size
|
||||
* [x] User vs. Server Preferences
|
||||
* [ ] Redis Caching
|
||||
* [x] Administrator Role Compatible
|
||||
* [x] Multi-User Chat Generation (Multiple users chatting at the same time) - This was built in from Ollama `v0.2.1+`
|
||||
* [x] Automatic and Manual model pulling through the Discord client
|
||||
|
||||
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 +54,8 @@ 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).
|
||||
* [Redis](https://redis.io/)
|
||||
* [Redis Docker Image](https://hub.docker.com/_/redis)
|
||||
* [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)
|
||||
|
||||
+21
-5
@@ -7,12 +7,14 @@ 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.8.5
|
||||
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}
|
||||
REDIS_IP: ${REDIS_IP}
|
||||
REDIS_PORT: ${REDIS_PORT}
|
||||
networks:
|
||||
ollama-net:
|
||||
ipv4_address: ${DISCORD_IP}
|
||||
@@ -26,14 +28,27 @@ 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}
|
||||
|
||||
# setup redis container
|
||||
redis:
|
||||
image: redis:latest
|
||||
container_name: redis
|
||||
restart: always
|
||||
networks:
|
||||
ollama-net:
|
||||
ipv4_address: ${REDIS_IP}
|
||||
volumes:
|
||||
- redis:/root/.redis
|
||||
ports:
|
||||
- ${REDIS_PORT}:${REDIS_PORT}
|
||||
|
||||
# create a network that supports giving addresses withing a specific subnet
|
||||
networks:
|
||||
@@ -47,3 +62,4 @@ networks:
|
||||
volumes:
|
||||
ollama:
|
||||
discord:
|
||||
redis:
|
||||
|
||||
@@ -43,11 +43,13 @@ 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`, `REDIS_IP`, `REDIS_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`
|
||||
* `REDIS_IP = 172.18.0.4`
|
||||
* `REDIS_PORT = 6379`
|
||||
* 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)
|
||||
* Otherwise, there is no need to install any npm packages for this, you just need to run `npm run start` to pull the containers and spin them up.
|
||||
|
||||
+3
-10
@@ -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.
|
||||
|
||||
Generated
+1952
-1429
File diff suppressed because it is too large
Load Diff
+11
-9
@@ -1,46 +1,48 @@
|
||||
{
|
||||
"name": "discord-ollama",
|
||||
"version": "0.9.3",
|
||||
"version": "0.8.5",
|
||||
"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 .",
|
||||
"client": "npm run build && npm run prod",
|
||||
"clean": "docker compose down && docker rmi $(docker images | grep kevinthedang | tr -s ' ' | cut -d ' ' -f 3) && docker rmi $(docker images --filter \"dangling=true\" -q --no-trunc)",
|
||||
"start": "docker compose build --no-cache && docker compose up -d",
|
||||
"docker:clean": "docker rm -f discord && docker rm -f ollama && docker network prune -f && docker rmi $(docker images | grep kevinthedang | tr -s ' ' | cut -d ' ' -f 3) && docker rmi $(docker images --filter \"dangling=true\" -q --no-trunc)",
|
||||
"docker:clean": "docker rm -f discord && docker rm -f ollama && docker rm -f redis && docker network prune -f && docker rmi $(docker images | grep kevinthedang | tr -s ' ' | cut -d ' ' -f 3) && docker rmi $(docker images --filter \"dangling=true\" -q --no-trunc)",
|
||||
"docker:network": "docker network create --subnet=172.18.0.0/16 ollama-net",
|
||||
"docker:build": "docker build --no-cache -t kevinthedang/discord-ollama:$(node -p \"require('./package.json').version\") .",
|
||||
"docker:build-latest": "docker build --no-cache -t kevinthedang/discord-ollama:latest .",
|
||||
"docker:client": "docker run -d -v discord:/src/app --name discord --network ollama-net --ip 172.18.0.3 kevinthedang/discord-ollama:$(node -p \"require('./package.json').version\")",
|
||||
"docker:redis": "docker run -d -v redis:/root/.redis -p 6379:6379 --name redis --network ollama-net --ip 172.18.0.4 redis:latest",
|
||||
"docker:ollama": "docker run -d --gpus=all -v ollama:/root/.ollama -p 11434:11434 --name ollama --network ollama-net --ip 172.18.0.2 ollama/ollama:latest",
|
||||
"docker:ollama-cpu": "docker run -d -v ollama:/root/.ollama -p 11434:11434 --name ollama --network ollama-net --ip 172.18.0.2 ollama/ollama:latest",
|
||||
"docker:start": "docker network prune -f && npm run docker:network && npm run docker:build && npm run docker:client && npm run docker:ollama",
|
||||
"docker:start-cpu": "docker network prune -f && npm run docker:network && npm run docker:build && npm run docker:client && npm run docker:ollama-cpu"
|
||||
"docker:start": "docker network prune -f && npm run docker:network && npm run docker:build && npm run docker:redis && npm run docker:client && npm run docker:ollama",
|
||||
"docker:start-cpu": "docker network prune -f && npm run docker:network && npm run docker:build && npm run docker:redis && npm run docker:client && npm run docker:ollama-cpu"
|
||||
},
|
||||
"author": "Kevin Dang",
|
||||
"license": "ISC",
|
||||
"dependencies": {
|
||||
"discord.js": "^14.20.0",
|
||||
"discord.js": "^14.19.3",
|
||||
"dotenv": "^16.5.0",
|
||||
"ollama": "^0.5.15",
|
||||
"pino": "^10.4.0",
|
||||
"pino-caller": "^4.0.0"
|
||||
"redis": "^4.7.0"
|
||||
},
|
||||
"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"
|
||||
}
|
||||
}
|
||||
+21
-8
@@ -1,12 +1,11 @@
|
||||
import { Client, GatewayIntentBits } from 'discord.js'
|
||||
import { Ollama } from 'ollama'
|
||||
import { Queue, createLogger } from './components/index.js'
|
||||
import { createClient } from 'redis'
|
||||
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: [
|
||||
@@ -17,6 +16,11 @@ const client = new Client({
|
||||
]
|
||||
})
|
||||
|
||||
// initialize connection to redis
|
||||
const redis = createClient({
|
||||
url: `redis://${Keys.redisHost}:${Keys.redisPort}`,
|
||||
})
|
||||
|
||||
// initialize connection to ollama container
|
||||
export const ollama = new Ollama({
|
||||
host: `http://${Keys.ipAddress}:${Keys.portAddress}`,
|
||||
@@ -25,16 +29,25 @@ export const ollama = new Ollama({
|
||||
// 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)
|
||||
registerEvents(client, Events, messageHistory, ollama, Keys.defaultModel)
|
||||
|
||||
// Try to connect to redis
|
||||
await redis.connect()
|
||||
.then(response => {
|
||||
console.log('[Redis] Successfully Connected')
|
||||
})
|
||||
.catch(error => {
|
||||
console.error('[Redis] Connection Error. See error below:\n', error)
|
||||
console.warn('[Redis] Failed to connect to Redis Database, using local system')
|
||||
// TODO: create boolean flag that will probably be used in messageCreate.ts if redis database is down
|
||||
// When implementing this boolean flag, move connection to database BEFORE the registerEvents method
|
||||
})
|
||||
|
||||
// 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)
|
||||
})
|
||||
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
import { Client, ChatInputCommandInteraction, ApplicationCommandOptionType, MessageFlags } from 'discord.js'
|
||||
import { Client, CommandInteraction, 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,14 +16,14 @@ 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: CommandInteraction) => {
|
||||
// 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,
|
||||
interaction.options.getNumber('context-capacity')
|
||||
openConfig(`${interaction.user.username}-config.json`, interaction.commandName,
|
||||
interaction.options.get('context-capacity')?.value
|
||||
)
|
||||
|
||||
interaction.reply({
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -1,8 +1,7 @@
|
||||
import { ApplicationCommandOptionType, ChatInputCommandInteraction, Client, CommandInteraction, MessageFlags } from 'discord.js'
|
||||
import { ApplicationCommandOptionType, Client, CommandInteraction, MessageFlags } from 'discord.js'
|
||||
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,11 +18,10 @@ export const DeleteModel: SlashCommand = {
|
||||
],
|
||||
|
||||
// Delete Model locally stored
|
||||
run: async (client: Client, interaction: ChatInputCommandInteraction, logger: PinoLogger) => {
|
||||
run: async (client: Client, interaction: CommandInteraction) => {
|
||||
// defer reply to avoid timeout
|
||||
await interaction.deferReply()
|
||||
const modelInput: string = interaction.options.getString('model-name') as string
|
||||
let ollamaOffline: boolean = false
|
||||
const modelInput: string = interaction.options.get('model-name')!!.value as string
|
||||
|
||||
// fetch channel and message
|
||||
const channel = await client.channels.fetch(interaction.channelId)
|
||||
@@ -42,18 +40,18 @@ export const DeleteModel: SlashCommand = {
|
||||
const modelExists = await ollama.list()
|
||||
.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
|
||||
if (ollamaOffline) {
|
||||
if (!modelExists) {
|
||||
interaction.editReply({
|
||||
content: `The Ollama service is not running. Please turn on/download the [service](https://ollama.com/).`
|
||||
})
|
||||
return
|
||||
}
|
||||
|
||||
|
||||
try {
|
||||
// call ollama to delete model
|
||||
if (modelExists) {
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
import { Client, ChatInputCommandInteraction, ApplicationCommandOptionType, MessageFlags } from 'discord.js'
|
||||
import { Client, CommandInteraction, 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: CommandInteraction) => {
|
||||
// fetch channel and message
|
||||
const channel = await client.channels.fetch(interaction.channelId)
|
||||
if (!channel || !AdminCommand.includes(channel.type)) return
|
||||
@@ -32,12 +31,12 @@ export const Disable: SlashCommand = {
|
||||
}
|
||||
|
||||
// set state of bot chat features
|
||||
openConfig(logger, `${interaction.guildId}-config.json`, interaction.commandName,
|
||||
interaction.options.getBoolean('enabled')
|
||||
openConfig(`${interaction.guildId}-config.json`, interaction.commandName,
|
||||
interaction.options.get('enabled')?.value
|
||||
)
|
||||
|
||||
interaction.reply({
|
||||
content: `${client.user?.username} is now **${interaction.options.getBoolean('enabled') ? "enabled" : "disabled"}**.`,
|
||||
content: `${client.user?.username} is now **${interaction.options.get('enabled')?.value ? "enabled" : "disabled"}**.`,
|
||||
flags: MessageFlags.Ephemeral
|
||||
})
|
||||
}
|
||||
|
||||
@@ -9,7 +9,6 @@ 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,
|
||||
@@ -21,6 +20,5 @@ export default [
|
||||
ClearUserChannelHistory,
|
||||
PullModel,
|
||||
SwitchModel,
|
||||
DeleteModel,
|
||||
Summary
|
||||
DeleteModel
|
||||
] as SlashCommand[]
|
||||
@@ -1,6 +1,5 @@
|
||||
import { ApplicationCommandOptionType, Client, ChatInputCommandInteraction, MessageFlags } from 'discord.js'
|
||||
import { ApplicationCommandOptionType, Client, CommandInteraction, 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,18 +16,18 @@ export const MessageStream: SlashCommand = {
|
||||
],
|
||||
|
||||
// change preferences based on command
|
||||
run: async (client: Client, interaction: ChatInputCommandInteraction, logger: PinoLogger) => {
|
||||
run: async (client: Client, interaction: CommandInteraction) => {
|
||||
// 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,
|
||||
interaction.options.getBoolean('stream')
|
||||
openConfig(`${interaction.user.username}-config.json`, interaction.commandName,
|
||||
interaction.options.get('stream')?.value
|
||||
)
|
||||
|
||||
interaction.reply({
|
||||
content: `Message streaming is now set to: \`${interaction.options.getBoolean('stream')}\``,
|
||||
content: `Message streaming is now set to: \`${interaction.options.get('stream')?.value}\``,
|
||||
flags: MessageFlags.Ephemeral
|
||||
})
|
||||
}
|
||||
|
||||
@@ -1,8 +1,7 @@
|
||||
import { ApplicationCommandOptionType, Client, ChatInputCommandInteraction, MessageFlags } from "discord.js"
|
||||
import { ApplicationCommandOptionType, Client, CommandInteraction, MessageFlags } from "discord.js"
|
||||
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,11 +18,10 @@ export const PullModel: SlashCommand = {
|
||||
],
|
||||
|
||||
// Pull for model from Ollama library
|
||||
run: async (client: Client, interaction: ChatInputCommandInteraction, logger: PinoLogger) => {
|
||||
run: async (client: Client, interaction: CommandInteraction) => {
|
||||
// defer reply to avoid timeout
|
||||
await interaction.deferReply()
|
||||
const modelInput: string = interaction.options.getString('model-to-pull') as string
|
||||
let ollamaOffline: boolean = false
|
||||
const modelInput: string = interaction.options.get('model-to-pull')!!.value as string
|
||||
|
||||
// fetch channel and message
|
||||
const channel = await client.channels.fetch(interaction.channelId)
|
||||
@@ -42,12 +40,11 @@ export const PullModel: SlashCommand = {
|
||||
const modelExists = await ollama.list()
|
||||
.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
|
||||
if (ollamaOffline) {
|
||||
if (!modelExists) {
|
||||
interaction.editReply({
|
||||
content: `The Ollama service is not running. Please turn on/download the [service](https://ollama.com/).`
|
||||
})
|
||||
|
||||
@@ -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()
|
||||
|
||||
@@ -1,51 +0,0 @@
|
||||
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 { 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, logger: PinoLogger) => {
|
||||
// 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(logger, ollama, "codellama", channelContext)
|
||||
|
||||
logger.info({ response }, 'Generated channel summary')
|
||||
|
||||
interaction.editReply({ content: response })
|
||||
}
|
||||
}
|
||||
@@ -1,8 +1,7 @@
|
||||
import { ApplicationCommandOptionType, Client, ChatInputCommandInteraction } from "discord.js"
|
||||
import { ApplicationCommandOptionType, Client, CommandInteraction } from "discord.js"
|
||||
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,10 +18,10 @@ 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: CommandInteraction) => {
|
||||
await interaction.deferReply()
|
||||
|
||||
const modelInput: string = interaction.options.getString('model-to-use') as string
|
||||
const modelInput: string = interaction.options.get('model-to-use')!!.value as string
|
||||
|
||||
// fetch channel and message
|
||||
const channel = await client.channels.fetch(interaction.channelId)
|
||||
@@ -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
|
||||
}
|
||||
|
||||
|
||||
@@ -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({
|
||||
|
||||
@@ -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({
|
||||
|
||||
@@ -1,2 +0,0 @@
|
||||
export * from './queue.js'
|
||||
export * from './logger.js'
|
||||
@@ -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() })
|
||||
}
|
||||
@@ -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)
|
||||
})
|
||||
+24
-69
@@ -1,6 +1,6 @@
|
||||
import { TextChannel } from 'discord.js'
|
||||
import { event, Events, normalMessage, UserMessage, clean } from '../utils/index.js'
|
||||
import {
|
||||
event, Events, normalMessage, UserMessage, clean, addToChannelContext,
|
||||
getChannelInfo, getServerConfig, getUserConfig, openChannelInfo,
|
||||
openConfig, UserConfig, getAttachmentData, getTextFileAttachmentData
|
||||
} from '../utils/index.js'
|
||||
@@ -11,68 +11,14 @@ 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, 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
|
||||
|
||||
// Save User Chat even if not for the bot
|
||||
let channelContextHistory: UserMessage[] = await new Promise((resolve) => {
|
||||
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')
|
||||
resolve([])
|
||||
}
|
||||
})
|
||||
})
|
||||
|
||||
if (channelContextHistory.length === 0) {
|
||||
channelContextHistory = await new Promise((resolve) => {
|
||||
addToChannelContext(logger, 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')
|
||||
}
|
||||
})
|
||||
})
|
||||
}
|
||||
|
||||
// Set Channel History Queue
|
||||
channelHistory.setQueue(channelContextHistory)
|
||||
|
||||
// get message attachment if exists
|
||||
const attachment = message.attachments.first()
|
||||
let messageAttachment: string[] = []
|
||||
|
||||
if (attachment && attachment.name?.endsWith(".txt"))
|
||||
cleanedMessage += ' ' + await getTextFileAttachmentData(attachment)
|
||||
else if (attachment)
|
||||
messageAttachment = await getAttachmentData(attachment)
|
||||
|
||||
while (channelHistory.size() >= channelHistory.capacity) channelHistory.dequeue()
|
||||
|
||||
// push user response to channel history
|
||||
channelHistory.enqueue({
|
||||
role: 'user',
|
||||
content: cleanedMessage,
|
||||
images: messageAttachment || []
|
||||
})
|
||||
|
||||
// Store in Channel Context
|
||||
addToChannelContext(logger, message.channelId,
|
||||
message.channel as TextChannel,
|
||||
channelHistory.getItems()
|
||||
)
|
||||
|
||||
// Only respond if message mentions the bot
|
||||
if (!message.mentions.has(clientId)) return
|
||||
|
||||
@@ -93,7 +39,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 +54,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 +71,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 +99,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 +113,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 +121,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 +129,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.`))
|
||||
}
|
||||
})
|
||||
@@ -193,6 +139,15 @@ export default event(Events.MessageCreate, async ({ logger, msgHist, channelHist
|
||||
if (!userConfig)
|
||||
throw new Error(`Failed to initialize User Preference for **${message.author.username}**.\n\nIt's likely you do not have a model set. Please use the \`switch-model\` command to do that.`)
|
||||
|
||||
// get message attachment if exists
|
||||
const attachment = message.attachments.first()
|
||||
let messageAttachment: string[] = []
|
||||
|
||||
if (attachment && attachment.name?.endsWith(".txt"))
|
||||
cleanedMessage += await getTextFileAttachmentData(attachment)
|
||||
else if (attachment)
|
||||
messageAttachment = await getAttachmentData(attachment)
|
||||
|
||||
const model: string = userConfig.options['switch-model']
|
||||
|
||||
// set up new queue
|
||||
@@ -209,7 +164,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 +180,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
@@ -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}.`)
|
||||
})
|
||||
@@ -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}`)
|
||||
}
|
||||
})
|
||||
+5
-3
@@ -2,9 +2,11 @@ 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
|
||||
defaultModel: getEnvVar('MODEL', 'llama3.2')
|
||||
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'),
|
||||
redisHost: getEnvVar('REDIS_IP', '172.18.0.4'), // default redis host if none
|
||||
redisPort: parseInt(getEnvVar('REDIS_PORT', '6379')) // default redis port if none
|
||||
} as const // readonly keys
|
||||
|
||||
export default Keys
|
||||
+9
-20
@@ -1,5 +1,4 @@
|
||||
import { ChatInputCommandInteraction, ChatInputApplicationCommandData, Client, type Awaitable } from 'discord.js'
|
||||
import type { Logger as PinoLogger } from 'pino'
|
||||
import { CommandInteraction, ChatInputApplicationCommandData, Client, ApplicationCommandOption } from 'discord.js'
|
||||
|
||||
/**
|
||||
* interface for how slash commands should be run
|
||||
@@ -7,9 +6,9 @@ import type { Logger as PinoLogger } from 'pino'
|
||||
export interface SlashCommand extends ChatInputApplicationCommandData {
|
||||
run: (
|
||||
client: Client,
|
||||
interaction: ChatInputCommandInteraction,
|
||||
logger: PinoLogger
|
||||
) => Awaitable<unknown>
|
||||
interaction: CommandInteraction,
|
||||
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
@@ -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
-10
@@ -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,9 +35,8 @@ export type UserMessage = {
|
||||
// Event properties
|
||||
export interface EventProps {
|
||||
client: Client,
|
||||
logger: LogMethod,
|
||||
log: LogMethod,
|
||||
msgHist: Queue<UserMessage>,
|
||||
channelHistory: Queue<UserMessage>,
|
||||
ollama: Ollama,
|
||||
defaultModel: String
|
||||
}
|
||||
@@ -80,20 +78,19 @@ export function registerEvents(
|
||||
client: Client,
|
||||
events: Event[],
|
||||
msgHist: Queue<UserMessage>,
|
||||
channelHistory: Queue<UserMessage>,
|
||||
ollama: Ollama,
|
||||
defaultModel: String
|
||||
): 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, ollama, defaultModel }, ...args)
|
||||
} catch (error) {
|
||||
logger.error({ err: error }, 'Uncaught event error')
|
||||
log('[Uncaught Error]', error)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
@@ -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,54 +56,6 @@ 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> {
|
||||
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')
|
||||
else {
|
||||
const object = JSON.parse(data)
|
||||
if (object['messages'].length === 0)
|
||||
object['messages'] = messages as []
|
||||
else if (object['messages'].length !== 0 && messages.length !== 0)
|
||||
object['messages'] = messages as []
|
||||
fs.writeFileSync(fullFileName, JSON.stringify(object, null, 2))
|
||||
}
|
||||
})
|
||||
} else { // channel context does not exist, create it
|
||||
const object: Configuration = JSON.parse(
|
||||
`{
|
||||
\"id\": \"${channel?.id}\",
|
||||
\"name\": \"${channel?.name}\",
|
||||
\"messages\": []
|
||||
}`
|
||||
)
|
||||
|
||||
const directory = path.dirname(fullFileName)
|
||||
if (!fs.existsSync(directory))
|
||||
fs.mkdirSync(directory, { recursive: true })
|
||||
|
||||
fs.writeFileSync(fullFileName, JSON.stringify(object, null, 2))
|
||||
logger.info({ file: fullFileName }, 'Created channel context')
|
||||
}
|
||||
}
|
||||
|
||||
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
|
||||
*
|
||||
@@ -113,12 +64,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 +95,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`)
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -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`)
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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,17 +49,13 @@ export async function normalMessage(
|
||||
if (result.length > 5)
|
||||
messageBlock.edit(result)
|
||||
}
|
||||
logger.debug({ response: result }, 'Received response chunk')
|
||||
console.log(result)
|
||||
}
|
||||
}
|
||||
else {
|
||||
response = await blockResponse(params)
|
||||
result = response.message.content
|
||||
|
||||
// check if there is a <think>...</think> sequence from the bot.
|
||||
if (hasThinking(result))
|
||||
result = result.replace(/<think>[\s\S]*?<\/think>/g, '').trim()
|
||||
|
||||
// check if message length > discord max for normal messages
|
||||
if (result.length > 2000) {
|
||||
sentMessage.edit(result.slice(0, 2000))
|
||||
@@ -78,10 +73,11 @@ 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
|
||||
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}`)
|
||||
}
|
||||
})
|
||||
@@ -89,40 +85,3 @@ export async function normalMessage(
|
||||
// return the string representation of ollama query response
|
||||
return result
|
||||
}
|
||||
|
||||
export async function summarizeContextHistory(
|
||||
logger: PinoLogger,
|
||||
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) {
|
||||
logger.error({ err: error, model }, 'Failed to summarize channel history')
|
||||
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
|
||||
|
||||
+10
-3
@@ -5,9 +5,16 @@ import { describe, expect, it, vi } from 'vitest'
|
||||
import commands from '../src/commands/index.js'
|
||||
|
||||
/**
|
||||
* Mocking client.ts because of the commands
|
||||
* Mocking redis found in client.ts because of the commands
|
||||
*/
|
||||
vi.mock('../src/client.js', () => ({}))
|
||||
vi.mock('../src/client.js', () => ({
|
||||
redis: {
|
||||
createClient: vi.fn(),
|
||||
connect: vi.fn(),
|
||||
get: vi.fn(),
|
||||
set: vi.fn()
|
||||
}
|
||||
}))
|
||||
|
||||
/**
|
||||
* Commands test suite, tests the commands object
|
||||
@@ -27,7 +34,7 @@ describe('Commands Existence', () => {
|
||||
// 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']
|
||||
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(', '))
|
||||
})
|
||||
})
|
||||
|
||||
@@ -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')
|
||||
})
|
||||
})
|
||||
@@ -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
|
||||
}
|
||||
})
|
||||
})
|
||||
|
||||
@@ -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')
|
||||
})
|
||||
})
|
||||
@@ -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
@@ -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
@@ -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
|
||||
|
||||
+6
-2
@@ -1,9 +1,13 @@
|
||||
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: {
|
||||
exclude: [...configDefaults.exclude, 'build/*', 'tests/*'], // <-- exclude JS build
|
||||
reporter: ['text-summary'] // <-- report in text-summary
|
||||
}
|
||||
}
|
||||
})
|
||||
Reference in New Issue
Block a user