Upgrade Node to Krypton (#200)

* node 24 and vulnerabilities

* ready is clientReady

* better about section

.env.sample

@@ -4,16 +4,14 @@ CLIENT_TOKEN = BOT_TOKEN
 # Default model for new users
 MODEL = DEFAULT_MODEL
 
-# ip/port address of docker container, I use 172.18.0.3 for docker, 127.0.0.1 for local
+# ip/port address of the LLM server (ollama, llmman, ...), I use 172.18.0.3 for docker, 127.0.0.1 for local
-OLLAMA_IP = IP_ADDRESS
+# ollama listens on 11434, llmman (https://github.com/llmmanorg/llmman) on 17434
-OLLAMA_PORT = PORT
+# OLLAMA_IP / OLLAMA_PORT are still accepted as deprecated aliases
+LLM_ENDPOINT = IP_ADDRESS
+LLM_PORT = PORT
 
-# ip address for discord bot container, I use 172.18.0.2, use different IP than ollama_ip
+# ip address for discord bot container, I use 172.18.0.2, use different IP than llm_endpoint
 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

.github/ISSUE_TEMPLATE/feature_request.md

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

.github/workflows/build.yml

@@ -1,5 +1,6 @@
 name: Builds
 run-name: Validate Node and Docker Builds
+
 on:
   push:
     branches:
@@ -9,15 +10,16 @@ jobs:
   Discord-Node-Build: # test if the node install and run
     runs-on: ubuntu-latest
     timeout-minutes: 2
+    
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v4
 
-      - name: Set up Node Environment lts/jod
+      - name: Set up Node Environment
         uses: actions/setup-node@v4
         with:
-          node-version: lts/jod
+          node-version: lts/krypton
-          cache: "npm"
+          cache: npm
 
       - name: Install Project Dependencies
         run: |
@@ -31,10 +33,9 @@ jobs:
         run: |
           touch .env
           echo CLIENT_TOKEN = ${{ secrets.BOT_TOKEN }} >> .env
-          echo OLLAMA_IP = ${{ secrets.OLLAMA_IP }} >> .env
+          echo LLM_ENDPOINT = ${{ secrets.OLLAMA_IP }} >> .env
-          echo OLLAMA_PORT = ${{ secrets.OLLAMA_PORT }} >> .env
+          echo LLM_PORT = ${{ secrets.OLLAMA_PORT }} >> .env
-          echo REDIS_IP = ${{ secrets.REDIS_IP }} >> .env
+          echo MODEL = ${{ secrets.MODEL }} >> .env
-          echo REDIS_PORT = ${{ secrets.REDIS_PORT }} >> .env
 
         # set -e ensures if nohup fails, this section fails
       - name: Startup Discord Bot Client
@@ -44,25 +45,24 @@ jobs:
 
   Discord-Ollama-Container-Build: # test docker build and run
     runs-on: ubuntu-latest
-    timeout-minutes: 2
+    timeout-minutes: 3
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v4
 
-      - name: Set up Node Environment lts/jod
+      - name: Set up Node Environment
         uses: actions/setup-node@v4
         with:
-          node-version: lts/jod
+          node-version: lts/krypton
-          cache: "npm"
+          cache: npm
 
       - name: Create Environment Variables
         run: |
           touch .env
           echo CLIENT_TOKEN = ${{ secrets.BOT_TOKEN }} >> .env
-          echo OLLAMA_IP = ${{ secrets.OLLAMA_IP }} >> .env
+          echo LLM_ENDPOINT = ${{ secrets.OLLAMA_IP }} >> .env
-          echo OLLAMA_PORT = ${{ secrets.OLLAMA_PORT }} >> .env
+          echo LLM_PORT = ${{ secrets.OLLAMA_PORT }} >> .env
-          echo REDIS_IP = ${{ secrets.REDIS_IP }} >> .env
+          echo MODEL = ${{ secrets.MODEL }} >> .env
-          echo REDIS_PORT = ${{ secrets.REDIS_PORT }} >> .env
 
       - name: Setup Docker Network and Images
         run: |
@@ -70,8 +70,8 @@ jobs:
 
       - name: Check Images Exist
         run: |
-          (docker images | grep -q 'kevinthedang/discord-ollama' && docker images | grep -qE 'ollama/ollama' | docker images | grep -qE 'redis') || exit 1
+          (docker images | grep -q 'kevinthedang/discord-ollama' && docker images | grep -qE 'ollama/ollama') || exit 1
 
       - name: Check Containers Exist
         run: |
-          (docker ps | grep -q 'ollama' && docker ps | grep -q 'discord' && docker ps | grep -q 'redis') || exit 1
+          (docker ps | grep -q 'ollama' && docker ps | grep -q 'discord') || exit 1

.github/workflows/coverage.yml

@@ -1,51 +0,0 @@
-name: Coverage
-run-name: Code Coverage
-on:
-  push:
-    branches:
-      - master
-
-jobs:
-  Discord-Node-Coverage:
-    runs-on: ubuntu-latest
-    environment: coverage
-    timeout-minutes: 2
-    steps:
-      - name: Checkout Repository
-        uses: actions/checkout@v4
-
-      - name: Set up Node Environment lts/jod
-        uses: actions/setup-node@v4
-        with:
-          node-version: lts/jod
-          cache: "npm"
-
-      - name: Install Project Dependencies
-        run: |
-          npm install
-
-      - name: Create Environment Variables
-        run: |
-          touch .env
-          echo CLIENT_TOKEN = ${{ secrets.BOT_TOKEN }} >> .env
-          echo OLLAMA_IP = ${{ secrets.OLLAMA_IP }} >> .env
-          echo OLLAMA_PORT = ${{ secrets.OLLAMA_PORT }} >> .env
-          echo REDIS_IP = ${{ secrets.REDIS_IP }} >> .env
-          echo REDIS_PORT = ${{ secrets.REDIS_PORT }} >> .env
-
-      - name: Collect Code Coverage
-        run: |
-          LINE_PCT=$(npm run test:coverage | tail -2 | head -1 | awk '{print $3}')
-          echo "COVERAGE=$LINE_PCT" >> $GITHUB_ENV
-      
-      - name: Upload Code Coverage
-        uses: schneegans/dynamic-badges-action@v1.7.0
-        with:
-          auth: ${{ secrets.GIST_SECRET }}
-          gistID: ${{ vars.GIST_ID }}
-          filename: coverage.json
-          label: Coverage
-          message: ${{ env.COVERAGE }}
-          valColorRange: ${{ env.COVERAGE }}
-          maxColorRange: 100
-          minColorRange: 0

.github/workflows/deploy.yml

@@ -0,0 +1,108 @@
+name: Deploy
+run-name: Deploy Application Latest
+
+on: workflow_dispatch
+
+jobs:
+  Deploy-Application:
+    runs-on: self-hosted
+    environment: deploy
+    timeout-minutes: 5
+    
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v4
+
+      # Generate Secret File for Compose case
+      - name: Create Environment Variables
+        run: |
+          touch .env
+          echo CLIENT_TOKEN = ${{ secrets.CLIENT }} >> .env
+          echo LLM_ENDPOINT = ${{ secrets.OLLAMA_IP }} >> .env
+          echo LLM_PORT = ${{ secrets.OLLAMA_PORT }} >> .env
+          echo MODEL = ${{ secrets.MODEL }} >> .env
+          echo DISCORD_IP = ${{ secrets.DISCORD_IP }} >> .env
+          echo SUBNET_ADDRESS = ${{ secrets.SUBNET_ADDRESS }} >> .env
+      
+      - name: Check if directory exists and delete it
+        run: |
+          if [ -d "${{ secrets.PATH }}" ]; then
+            echo "Directory exists, deleting old version..."
+            rm -rf ${{ secrets.PATH }}
+          else
+            echo "Directory does not exist."
+          fi
+
+      - name: Clone Repo onto Server
+        run: |
+          git clone https://github.com/kevinthedang/discord-ollama.git ${{ secrets.PATH }}
+          cd ${{ secrets.PATH }}
+      
+      - name: Install nvm and Node.js
+        run: |
+          curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash
+          export NVM_DIR="$HOME/.nvm"
+          [ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
+          echo "NVM installed successfully."
+          nvm install lts/jod
+          nvm alias default lts/jod
+          node -v
+          npm -v
+
+      - name: Build Application
+        run: |
+          export NVM_DIR="$HOME/.nvm"
+          [ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
+          npm install
+
+          IMAGE="kevinthedang/discord-ollama"
+          OLLAMA="ollama/ollama"
+
+          if docker images | grep -q $IMAGE; then
+            IMAGE_ID=$(docker images -q $IMAGE)
+            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 $IMAGE"
+            fi
+            docker rmi $IMAGE_ID
+            echo "Old $IMAGE 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")
+
+            if [ ! -z "$CONTAINER_IDS" ]; then
+              # Stop and remove the running containers
+              docker stop $CONTAINER_IDS
+              echo "Stopped and removed the containers using the image $OLLAMA"
+            fi
+            docker rmi $IMAGE_ID
+            echo "Old $OLLAMA Image Removed"
+          fi
+
+          docker network prune -f
+          docker system prune -a -f
+
+          npm run docker:build-latest
+
+      - name: Start Application
+        run: |
+          docker network create --subnet=${{ secrets.SUBNET_ADDRESS }}/16 ollama-net || true
+          docker run --rm -d \
+            -v ollama:/root/.ollama \
+            -p ${{ secrets.OLLAMA_PORT }}:${{ secrets.OLLAMA_PORT }} \
+            --name ollama \
+            --network ollama-net \
+            --ip ${{ secrets.OLLAMA_IP }} \
+            ollama/ollama:latest
+
+          docker run --rm -d \
+            -v discord:/src/app \
+            --name discord \
+            --network ollama-net \
+            --ip ${{ secrets.DISCORD_IP }} \
+            kevinthedang/discord-ollama

.github/workflows/release.yml

@@ -1,50 +0,0 @@
-name: Deploy
-run-name: Release Docker Image
-on:
-  push:
-    tags:
-      - 'v*'
-
-jobs:
-  Release-Docker-Image:
-    runs-on: ubuntu-latest
-    environment: release
-    timeout-minutes: 3
-    steps:
-      - name: Checkout Repository
-        uses: actions/checkout@v4
-
-      - name: Set up Node Environment lts/jod
-        uses: actions/setup-node@v4
-        with:
-          node-version: lts/jod
-          cache: "npm"
-
-      - name: Create Environment Variables
-        run: |
-          touch .env
-          echo CLIENT_TOKEN = NOT_REAL_TOKEN >> .env
-          echo OLLAMA_IP = ${{ secrets.OLLAMA_IP }} >> .env
-          echo OLLAMA_PORT = ${{ secrets.OLLAMA_PORT }} >> .env
-          echo REDIS_IP = ${{ secrets.REDIS_IP }} >> .env
-          echo REDIS_PORT = ${{ secrets.REDIS_PORT }} >> .env
-
-      - name: Get Version from package.json
-        run: echo "VERSION=$(jq -r '.version' package.json)" >> $GITHUB_ENV
-      
-      - name: Build Image
-        run: |
-          npm run docker:build
-
-      - name: Build Image as Latest
-        run: |
-          npm run docker:build-latest
-      
-      - name: Log into Docker
-        run: |
-          docker login --username ${{ vars.DOCKER_USER }} --password ${{ secrets.DOCKER_PASS }}
-
-      - name: Release Docker Image
-        run: |
-          docker push ${{ vars.DOCKER_USER }}/discord-ollama:${{ env.VERSION }}
-          docker push ${{ vars.DOCKER_USER }}/discord-ollama:latest

.github/workflows/test-fork.yml

@@ -0,0 +1,47 @@
+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

.github/workflows/test.yml

@@ -1,5 +1,6 @@
 name: Tests
 run-name: Unit Tests
+
 on:
   pull_request:
     branches:
@@ -19,17 +20,19 @@ 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 lts/jod
+      - name: Set up Node Environment
         uses: actions/setup-node@v4
         with:
           node-version: lts/jod
-          cache: "npm"
+          cache: npm
 
       - name: Install Project Dependencies
         run: |
@@ -39,11 +42,10 @@ jobs:
         run: |
           touch .env
           echo CLIENT_TOKEN = ${{ secrets.BOT_TOKEN }} >> .env
-          echo OLLAMA_IP = ${{ secrets.OLLAMA_IP }} >> .env
+          echo LLM_ENDPOINT = ${{ secrets.OLLAMA_IP }} >> .env
-          echo OLLAMA_PORT = ${{ secrets.OLLAMA_PORT }} >> .env
+          echo LLM_PORT = ${{ secrets.OLLAMA_PORT }} >> .env
-          echo REDIS_IP = ${{ secrets.REDIS_IP }} >> .env
+          echo MODEL = ${{ secrets.MODEL }} >> .env
-          echo REDIS_PORT = ${{ secrets.REDIS_PORT }} >> .env
 
       - name: Test Application
         run: |
-          npm run test:run
+          npm run tests

.gitignore

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

CODEOWNERS

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

Dockerfile

@@ -1,5 +1,5 @@
-# use node LTS image for version 22
+# use node LTS image for version 24
-FROM node:jod-alpine
+FROM node:krypton-alpine
 
 # set working directory inside container
 WORKDIR /app

README.md

@@ -4,33 +4,19 @@
     <h3><a href="#"></a>Ollama as your Discord AI Assistant</h3>
     <p><a href="#"></a><a href="https://creativecommons.org/licenses/by/4.0/"><img alt="License" src="https://img.shields.io/badge/License-CC_BY_4.0-darkgreen.svg" /></a>
     <a href="#"></a><a href="https://github.com/kevinthedang/discord-ollama/releases/latest"><img alt="Release" src="https://img.shields.io/github/v/release/kevinthedang/discord-ollama?logo=github" /></a>
-    <a href="#"></a><a href="https://github.com/kevinthedang/discord-ollama/actions/workflows/build.yml"><img alt="Build Status" src="https://github.com/kevinthedang/discord-ollama/actions/workflows/build.yml/badge.svg" /></a>
+    <a href="#"></a><a href="https://github.com/kevinthedang/discord-ollama/actions/workflows/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/release.yml"><img alt="Release Status" src="https://github.com/kevinthedang/discord-ollama/actions/workflows/release.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/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/Goals
+## About
-Ollama is an AI model management tool that allows users to install and use custom large language models locally.  
+Discord Ollama is a Discord bot that lets users interact with locally hosted
-The project aims to:
+Ollama language models directly from Discord.
-* [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
 
-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.
+The bot supports model management, streamed responses, conversation history,
-* [Customize a model](https://github.com/ollama/ollama#customize-a-model)
+private threads, and configurable server controls. Because Ollama runs locally,
-* [Modelfile Docs](https://github.com/ollama/ollama/blob/main/docs/modelfile.md)
+you retain control over the models and data used by the bot.
+
+See the [setup guides](./docs/setup-local.md) to get started.
 
 ## Documentation
 These are guides to the features and capabilities of this app.
@@ -41,6 +27,7 @@ These are guides to the features and capabilities of this app.
 * 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)
@@ -54,8 +41,7 @@ These are guides to the features and capabilities of this app.
     * 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)
-* [Redis](https://redis.io/)
+    * [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 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)

docker-compose.yml

@@ -7,13 +7,12 @@ services:
     build: ./                     # find docker file in designated path
     container_name: discord
     restart: always               # rebuild container always
-    image: kevinthedang/discord-ollama:0.8.3
+    image: kevinthedang/discord-ollama:0.9.2
     environment:
       CLIENT_TOKEN: ${CLIENT_TOKEN}
-      OLLAMA_IP: ${OLLAMA_IP}
+      LLM_ENDPOINT: ${LLM_ENDPOINT:-${OLLAMA_IP}}     # OLLAMA_IP is a deprecated alias
-      OLLAMA_PORT: ${OLLAMA_PORT}
+      LLM_PORT: ${LLM_PORT:-${OLLAMA_PORT}}           # OLLAMA_PORT is a deprecated alias
-      REDIS_IP: ${REDIS_IP}
+      MODEL: ${MODEL}
-      REDIS_PORT: ${REDIS_PORT}
     networks:
       ollama-net:
         ipv4_address: ${DISCORD_IP}
@@ -27,27 +26,14 @@ services:
     restart: always
     networks:
       ollama-net:
-        ipv4_address: ${OLLAMA_IP}
+        ipv4_address: ${LLM_ENDPOINT:-${OLLAMA_IP}}
     runtime: nvidia             # use Nvidia Container Toolkit for GPU support
     devices:
       - /dev/nvidia0
     volumes:
       - ollama:/root/.ollama
     ports: 
-      - ${OLLAMA_PORT}:${OLLAMA_PORT}
+      - ${LLM_PORT:-${OLLAMA_PORT}}:${LLM_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:
@@ -61,4 +47,3 @@ networks:
 volumes:
   ollama:
   discord:
-  redis:

docs/setup-docker.md

@@ -43,13 +43,11 @@ 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`, `OLLAMA_IP`, `OLLAMA_PORT`, `REDIS_IP`, `REDIS_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`, `LLM_ENDPOINT`, `LLM_PORT`, and `DISCORD_IP`. Here are some default values if you don't care:
     * `SUBNET_ADDRESS = 172.18.0.0`
-    * `OLLAMA_IP = 172.18.0.2`
+    * `LLM_ENDPOINT = 172.18.0.2`
-    * `OLLAMA_PORT = 11434`
+    * `LLM_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.

docs/setup-local.md

@@ -14,11 +14,18 @@
 > [!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 `OLLAMA_IP` is `127.0.0.1` to work properly.
+* Ensure that your [.env](../.env.sample) file's `LLM_ENDPOINT` is `127.0.0.1` to work properly.
-    * You only need your `CLIENT_TOKEN`, `OLLAMA_IP`, `OLLAMA_PORT`.
+    * You only need your `CLIENT_TOKEN`, `LLM_ENDPOINT`, `LLM_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`.
+    * 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.
 * 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.

package.json

@@ -1,48 +1,44 @@
 {
   "name": "discord-ollama",
-  "version": "0.8.3",
+  "version": "0.9.2",
   "description": "Ollama Integration into discord",
   "main": "build/index.js",
   "exports": "./build/index.js",
   "scripts": {
-    "test:run": "vitest run",
+    "tests": "vitest run",
-    "test: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 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: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: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:redis && npm run docker:client && npm run docker:ollama",
+    "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:redis && npm run docker:client && npm run docker:ollama-cpu"
+    "docker:start-cpu": "docker network prune -f && npm run docker:network && npm run docker:build && npm run docker:client && npm run docker:ollama-cpu"
   },
   "author": "Kevin Dang",
   "license": "ISC",
   "dependencies": {
-    "discord.js": "^14.17.3",
+    "discord.js": "^14.20.0",
-    "dotenv": "^16.4.7",
+    "dotenv": "^16.5.0",
-    "ollama": "^0.5.11",
+    "ollama": "^0.5.15"
-    "redis": "^4.7.0"
   },
   "devDependencies": {
-    "@types/node": "^22.10.2",
+    "@types/node": "^22.13.14",
-    "@vitest/coverage-v8": "^2.1.8",
     "ts-node": "^10.9.2",
-    "tsx": "^4.19.2",
+    "tsx": "^4.19.3",
-    "typescript": "^5.7.2",
+    "typescript": "^5.8.2",
-    "vitest": "^2.1.4"
+    "vitest": "^3.0.4"
   },
   "type": "module",
   "engines": {
     "npm": ">=10.9.0",
-    "node": ">=22.12.0"
+    "node": ">=24.0.0"
   }
 }

src/client.ts

@@ -1,6 +1,5 @@
 import { Client, GatewayIntentBits } from 'discord.js'
 import { Ollama } from 'ollama'
-import { createClient } from 'redis'
 import { Queue } from './queues/queue.js'
 import { UserMessage, registerEvents } from './utils/index.js'
 import Events from './events/index.js'
@@ -16,11 +15,6 @@ 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}`,
@@ -29,16 +23,11 @@ export const ollama = new Ollama({
 // Create Queue managed by Events
 const messageHistory: Queue<UserMessage> = new Queue<UserMessage>
 
-// register all events
+// Create Channel History Queue managed by Events
-registerEvents(client, Events, messageHistory, ollama, Keys.defaultModel)
+const channelMessageHistory: Queue<UserMessage> = new Queue<UserMessage>
 
-// Try to connect to redis
+// register all events
-await redis.connect()
+registerEvents(client, Events, messageHistory, channelMessageHistory, ollama, Keys.defaultModel)
-    .then(() => console.log('[Redis] Connected'))
-    .catch((error) => {
-        console.error('[Redis] Connection Error', error)
-        process.exit(1)
-    })
 
 // Try to log in the client
 await client.login(Keys.clientToken)

src/commands/capacity.ts

@@ -1,4 +1,4 @@
-import { Client, CommandInteraction, ApplicationCommandOptionType, MessageFlags } from 'discord.js'
+import { Client, ChatInputCommandInteraction, ApplicationCommandOptionType, MessageFlags } from 'discord.js'
 import { openConfig, SlashCommand, UserCommand } from '../utils/index.js'
 
 export const Capacity: SlashCommand = {
@@ -16,14 +16,14 @@ export const Capacity: SlashCommand = {
     ],
 
     // Query for message information and set the style
-    run: async (client: Client, interaction: CommandInteraction) => {
+    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(`${interaction.user.username}-config.json`, interaction.commandName,
-            interaction.options.get('context-capacity')?.value
+            interaction.options.getNumber('context-capacity')
         )
 
         interaction.reply({

src/commands/deleteModel.ts

@@ -1,4 +1,4 @@
-import { ApplicationCommandOptionType, Client, CommandInteraction, MessageFlags } from 'discord.js'
+import { ApplicationCommandOptionType, ChatInputCommandInteraction, Client, CommandInteraction, MessageFlags } from 'discord.js'
 import { UserCommand, SlashCommand } from '../utils/index.js'
 import { ollama } from '../client.js'
 import { ModelResponse } from 'ollama'
@@ -18,10 +18,11 @@ export const DeleteModel: SlashCommand = {
     ],
 
     // Delete Model locally stored
-    run: async (client: Client, interaction: CommandInteraction) => {
+    run: async (client: Client, interaction: ChatInputCommandInteraction) => {
         // defer reply to avoid timeout
         await interaction.deferReply()
-        const modelInput: string = interaction.options.get('model-name')!!.value as string
+        const modelInput: string = interaction.options.getString('model-name') as string
+        let ollamaOffline: boolean = false
 
         // fetch channel and message
         const channel = await client.channels.fetch(interaction.channelId)
@@ -37,8 +38,21 @@ export const DeleteModel: SlashCommand = {
         }
 
         // check if model exists
-        const modelExists: boolean = await ollama.list()
+        const modelExists = await ollama.list()
             .then(response => response.models.some((model: ModelResponse) => model.name.startsWith(modelInput)))
+            .catch(error => {
+                ollamaOffline = true
+                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) {
+            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

src/commands/disable.ts

@@ -1,4 +1,4 @@
-import { Client, CommandInteraction, ApplicationCommandOptionType, MessageFlags } from 'discord.js'
+import { Client, ChatInputCommandInteraction, ApplicationCommandOptionType, MessageFlags } from 'discord.js'
 import { AdminCommand, openConfig, SlashCommand } from '../utils/index.js'
 
 export const Disable: SlashCommand = {
@@ -16,7 +16,7 @@ export const Disable: SlashCommand = {
     ],
 
     // Query for message information and set the style
-    run: async (client: Client, interaction: CommandInteraction) => {
+    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,11 +32,11 @@ export const Disable: SlashCommand = {
 
         // set state of bot chat features
         openConfig(`${interaction.guildId}-config.json`, interaction.commandName,
-            interaction.options.get('enabled')?.value
+            interaction.options.getBoolean('enabled')
         )
 
         interaction.reply({
-            content: `${client.user?.username} is now **${interaction.options.get('enabled')?.value ? "enabled" : "disabled"}**.`,
+            content: `${client.user?.username} is now **${interaction.options.getBoolean('enabled') ? "enabled" : "disabled"}**.`,
             flags: MessageFlags.Ephemeral
         })
     }

src/commands/index.ts

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

src/commands/messageStream.ts

@@ -1,4 +1,4 @@
-import { ApplicationCommandOptionType, Client, CommandInteraction, MessageFlags } from 'discord.js'
+import { ApplicationCommandOptionType, Client, ChatInputCommandInteraction, MessageFlags } from 'discord.js'
 import { openConfig, SlashCommand, UserCommand } from '../utils/index.js'
 
 export const MessageStream: SlashCommand = {
@@ -16,18 +16,18 @@ export const MessageStream: SlashCommand = {
     ],
 
     // change preferences based on command
-    run: async (client: Client, interaction: CommandInteraction) => {
+    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(`${interaction.user.username}-config.json`, interaction.commandName,
-            interaction.options.get('stream')?.value
+            interaction.options.getBoolean('stream')
         )
 
         interaction.reply({
-            content: `Message streaming is now set to: \`${interaction.options.get('stream')?.value}\``,
+            content: `Message streaming is now set to: \`${interaction.options.getBoolean('stream')}\``,
             flags: MessageFlags.Ephemeral
         })
     }

src/commands/pullModel.ts

@@ -1,4 +1,4 @@
-import { ApplicationCommandOptionType, Client, CommandInteraction, MessageFlags } from "discord.js"
+import { ApplicationCommandOptionType, Client, ChatInputCommandInteraction, MessageFlags } from "discord.js"
 import { ollama } from "../client.js"
 import { ModelResponse } from "ollama"
 import { UserCommand, SlashCommand } from "../utils/index.js"
@@ -18,10 +18,11 @@ export const PullModel: SlashCommand = {
     ],
 
     // Pull for model from Ollama library
-    run: async (client: Client, interaction: CommandInteraction) => {
+    run: async (client: Client, interaction: ChatInputCommandInteraction) => {
         // defer reply to avoid timeout
         await interaction.deferReply()
-        const modelInput: string = interaction.options.get('model-to-pull')!!.value as string
+        const modelInput: string = interaction.options.getString('model-to-pull') as string
+        let ollamaOffline: boolean = false
 
         // fetch channel and message
         const channel = await client.channels.fetch(interaction.channelId)
@@ -36,9 +37,22 @@ export const PullModel: SlashCommand = {
             return
         }
 
-        // check if model was already pulled
+        // check if model was already pulled, if the ollama service isn't running throw error
-        const modelExists: boolean = await ollama.list()
+        const modelExists = await ollama.list()
             .then(response => response.models.some((model: ModelResponse) => model.name.startsWith(modelInput)))
+            .catch(error => {
+                ollamaOffline = true
+                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) {
+            interaction.editReply({
+                content: `The Ollama service is not running. Please turn on/download the [service](https://ollama.com/).`
+            })
+            return
+        }
+
 
         try {
             // call ollama to pull desired model

src/commands/summary.ts

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

src/commands/switchModel.ts

@@ -1,4 +1,4 @@
-import { ApplicationCommandOptionType, Client, CommandInteraction } from "discord.js"
+import { ApplicationCommandOptionType, Client, ChatInputCommandInteraction } from "discord.js"
 import { ollama } from "../client.js"
 import { ModelResponse } from "ollama"
 import { openConfig, UserCommand, SlashCommand } from "../utils/index.js"
@@ -18,10 +18,10 @@ export const SwitchModel: SlashCommand = {
     ],
 
     // Switch user preferred model if available in local library
-    run: async (client: Client, interaction: CommandInteraction) => {
+    run: async (client: Client, interaction: ChatInputCommandInteraction) => {
         await interaction.deferReply()
 
-        const modelInput: string = interaction.options.get('model-to-use')!!.value as string
+        const modelInput: string = interaction.options.getString('model-to-use') as string
 
         // fetch channel and message
         const channel = await client.channels.fetch(interaction.channelId)
@@ -45,6 +45,9 @@ export const SwitchModel: SlashCommand = {
                         }
                     }
                 })
+                .catch(error => {
+                    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
@@ -56,10 +59,13 @@ export const SwitchModel: SlashCommand = {
             interaction.editReply({
                 content: `Could not find **${modelInput}** in local model library.\n\nPlease contact an server admin for access to this model.`
             })
-        } catch (error) {
+        } catch (error: any) {
             // could not resolve user model switch
+            if (error.message.includes("fetch failed") as string)
+                error.message = "The Ollama service is not running. Please turn on/download the [service](https://ollama.com/)."
+
             interaction.editReply({
-                content: `Unable to switch user preferred model to **${modelInput}**.\n\n${error}\n\nPossible solution is to request an server admin run \`/pull-model ${modelInput}\` and try again.`
+                content: `Unable to switch user preferred model to **${modelInput}**.\n\n${error.message}`
             })
             return
         }

src/events/interactionCreate.ts

@@ -6,15 +6,14 @@ import commands from '../commands/index.js'
  * @param interaction the interaction received from the server
  */
 export default event(Events.InteractionCreate, async ({ log, client }, interaction) => {
-        if (!interaction.isCommand() || !interaction.isChatInputCommand()) return
+    if (!interaction.isCommand() || !interaction.isChatInputCommand()) return
 
-        log(`Interaction called \'${interaction.commandName}\' from ${interaction.user.tag}.`)
+    log(`Interaction called \'${interaction.commandName}\' from ${interaction.user.tag}.`)
 
-        // ensure command exists, otherwise kill event
+    // ensure command exists, otherwise kill event
-        const command = commands.find(command => command.name === interaction.commandName)
+    const command = commands.find(command => command.name === interaction.commandName)
-        if (!command) return
+    if (!command) return
 
-        // the command exists, execute it
+    // the command exists, execute it
-        command.run(client, interaction)
+    command.run(client, interaction)
-    }
+})
-)

src/events/messageCreate.ts

@@ -1,5 +1,5 @@
 import { TextChannel } from 'discord.js'
-import { event, Events, normalMessage, UserMessage, clean } from '../utils/index.js'
+import { event, Events, normalMessage, UserMessage, clean, addToChannelContext } from '../utils/index.js'
 import {
     getChannelInfo, getServerConfig, getUserConfig, openChannelInfo,
     openConfig, UserConfig, getAttachmentData, getTextFileAttachmentData
@@ -11,184 +11,228 @@ import {
  * 
  * @param message the message received from the channel
  */
-export default event(Events.MessageCreate, async ({ log, msgHist, 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)
     log(`Message \"${cleanedMessage}\" from ${message.author.tag} in channel/thread ${message.channelId}.`)
 
-        // Do not respond if bot talks in the chat
+    // Do not respond if bot talks in the chat
-        if (message.author.username === message.client.user.username) return
+    if (message.author.username === message.client.user.username) return
 
-        // Only respond if message mentions the bot
+    // Save User Chat even if not for the bot
-        if (!message.mentions.has(clientId)) return
+    let channelContextHistory: UserMessage[] = await new Promise((resolve) => {
-
+        getChannelInfo(`${message.channelId}-context.json`, (channelInfo) => {
-        // default stream to false
+            if (channelInfo?.messages)
-        let shouldStream = false
+                resolve(channelInfo.messages)
-
+            else {
-        // Params for Preferences Fetching
+                log(`Channel/Thread ${message.channel}-context does not exist. File will be created shortly...`)
-        const maxRetries = 3
+                resolve([])
-        const delay = 1000 // in millisecons
-
-        try {
-            // Retrieve Server/Guild Preferences
-            let attempt = 0
-            while (attempt < maxRetries) {
-                try {
-                    await new Promise((resolve, reject) => {
-                        getServerConfig(`${message.guildId}-config.json`, (config) => {
-                            // check if config.json exists
-                            if (config === undefined) {
-                                // Allowing chat options to be available
-                                openConfig(`${message.guildId}-config.json`, 'toggle-chat', true)
-                                reject(new Error('Failed to locate or create Server Preferences\n\nPlease try chatting again...'))
-                            }
-
-                            // check if chat is disabled
-                            else if (!config.options['toggle-chat'])
-                                reject(new Error('Admin(s) have disabled chat features.\n\n Please contact your server\'s admin(s).'))
-                            else
-                                resolve(config)
-                        })
-                    })
-                    break // successful
-                } catch (error) {
-                    ++attempt
-                    if (attempt < maxRetries) {
-                        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...`)
-                }
             }
+        })
+    })
 
-            // Reset attempts for User preferences
+    if (channelContextHistory.length === 0) {
-            attempt = 0
+        channelContextHistory = await new Promise((resolve) => {
-            let userConfig: UserConfig | undefined
+            addToChannelContext(message.channelId,
+                message.channel as TextChannel
+            )
+            getChannelInfo(`${message.channelId}-context.json`, (channelInfo) => {
+                if (channelInfo?.messages)
+                    resolve(channelInfo.messages)
+                else {
+                    log(`Channel/Thread ${message.channel}-context does not exist. File will be created shortly...`)
+                }
+            })
+        })
+    }
 
-            while (attempt < maxRetries) {
+    // Set Channel History Queue
-                try {
+    channelHistory.setQueue(channelContextHistory)
-                    // Retrieve User Preferences
-                    userConfig = await new Promise((resolve, reject) => {
-                        getUserConfig(`${message.author.username}-config.json`, (config) => {
-                            if (config === undefined) {
-                                openConfig(`${message.author.username}-config.json`, 'message-style', false)
-                                openConfig(`${message.author.username}-config.json`, 'switch-model', defaultModel)
-                                reject(new Error('No User Preferences is set up.\n\nCreating preferences file with \`message-style\` set as \`false\` for regular message style.\nPlease try chatting again.'))
-                                return
-                            }
 
-                            // check if there is a set capacity in config
+    // get message attachment if exists
-                            else if (typeof config.options['modify-capacity'] !== 'number')
+    const attachment = message.attachments.first()
-                                log(`Capacity is undefined, using default capacity of ${msgHist.capacity}.`)
+    let messageAttachment: string[] = []
-                            else if (config.options['modify-capacity'] === msgHist.capacity)
-                                log(`Capacity matches config as ${msgHist.capacity}, no changes made.`)
-                            else {
-                                log(`New Capacity found. Setting Context Capacity to ${config.options['modify-capacity']}.`)
-                                msgHist.capacity = config.options['modify-capacity']
-                            }
 
-                            // set stream state
+    if (attachment && attachment.name?.endsWith(".txt"))
-                            shouldStream = config.options['message-stream'] as boolean || false
+        cleanedMessage += ' ' + await getTextFileAttachmentData(attachment)
+    else if (attachment)
+        messageAttachment = await getAttachmentData(attachment)
 
-                            if (typeof config.options['switch-model'] !== 'string')
+    while (channelHistory.size() >= channelHistory.capacity) channelHistory.dequeue()
-                                reject(new Error(`No Model was set. Please set a model by running \`/switch-model <model of choice>\`.\n\nIf you do not have any models. Run \`/pull-model <model name>\`.`))
 
+    // push user response to channel history
+    console.log
+    channelHistory.enqueue({
+        role: 'user',
+        content: cleanedMessage,
+        images: messageAttachment || []
+    })
+
+    // Store in Channel Context
+    addToChannelContext(message.channelId,
+        message.channel as TextChannel,
+        channelHistory.getItems()
+    )
+
+    // Only respond if message mentions the bot
+    if (!message.mentions.has(clientId)) return
+
+    // default stream to false
+    let shouldStream = false
+
+    // Params for Preferences Fetching
+    const maxRetries = 3
+    const delay = 1000 // in millisecons
+
+    try {
+        // Retrieve Server/Guild Preferences
+        let attempt = 0
+        while (attempt < maxRetries) {
+            try {
+                await new Promise((resolve, reject) => {
+                    getServerConfig(`${message.guildId}-config.json`, (config) => {
+                        // check if config.json exists
+                        if (config === undefined) {
+                            // Allowing chat options to be available
+                            openConfig(`${message.guildId}-config.json`, 'toggle-chat', true)
+                            reject(new Error('Failed to locate or create Server Preferences\n\nPlease try chatting again...'))
+                        }
+
+                        // check if chat is disabled
+                        else if (!config.options['toggle-chat'])
+                            reject(new Error('Admin(s) have disabled chat features.\n\n Please contact your server\'s admin(s).'))
+                        else
                             resolve(config)
-                        })
                     })
-                    break // successful
+                })
-                } catch (error) {
+                break // successful
-                    ++attempt
+            } catch (error) {
-                    if (attempt < maxRetries) {
+                ++attempt
-                        log(`Attempt ${attempt} failed for User Preferences. Retrying in ${delay}ms...`)
+                if (attempt < maxRetries) {
-                        await new Promise(ret => setTimeout(ret, delay))
+                    log(`Attempt ${attempt} failed for Server Preferences. Retrying in ${delay}ms...`)
-                    } else
+                    await new Promise(ret => setTimeout(ret, delay))
-                        throw new Error(`Could not retrieve User Preferences, please try chatting again...`)
+                } else
-                }
+                    throw new Error(`Could not retrieve Server Preferences, please try chatting again...`)
             }
+        }
 
-            // need new check for "open/active" threads/channels here!
+        // Reset attempts for User preferences
-            let chatMessages: UserMessage[] = await new Promise((resolve) => {
+        attempt = 0
-                // set new queue to modify
+        let userConfig: UserConfig | undefined
+
+        while (attempt < maxRetries) {
+            try {
+                // Retrieve User Preferences
+                userConfig = await new Promise((resolve, reject) => {
+                    getUserConfig(`${message.author.username}-config.json`, (config) => {
+                        if (config === undefined) {
+                            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')
+                            log(`Capacity is undefined, using default capacity of ${msgHist.capacity}.`)
+                        else if (config.options['modify-capacity'] === msgHist.capacity)
+                            log(`Capacity matches config as ${msgHist.capacity}, no changes made.`)
+                        else {
+                            log(`New Capacity found. Setting Context Capacity to ${config.options['modify-capacity']}.`)
+                            msgHist.capacity = config.options['modify-capacity']
+                        }
+
+                        // set stream state
+                        shouldStream = config.options['message-stream'] as boolean || false
+
+                        if (typeof config.options['switch-model'] !== 'string')
+                            reject(new Error(`No Model was set. Please set a model by running \`/switch-model <model of choice>\`.\n\nIf you do not have any models. Run \`/pull-model <model name>\`.`))
+
+                        resolve(config)
+                    })
+                })
+                break // successful
+            } catch (error) {
+                ++attempt
+                if (attempt < maxRetries) {
+                    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...`)
+            }
+        }
+
+        // need new check for "open/active" threads/channels here!
+        let chatMessages: UserMessage[] = await new Promise((resolve) => {
+            // set new queue to modify
+            getChannelInfo(`${message.channelId}-${message.author.username}.json`, (channelInfo) => {
+                if (channelInfo?.messages)
+                    resolve(channelInfo.messages)
+                else {
+                    log(`Channel/Thread ${message.channel}-${message.author.username} does not exist. File will be created shortly...`)
+                    resolve([])
+                }
+            })
+        })
+
+        if (chatMessages.length === 0) {
+            chatMessages = await new Promise((resolve, reject) => {
+                openChannelInfo(message.channelId,
+                    message.channel as TextChannel,
+                    message.author.tag
+                )
                 getChannelInfo(`${message.channelId}-${message.author.username}.json`, (channelInfo) => {
                     if (channelInfo?.messages)
                         resolve(channelInfo.messages)
                     else {
                         log(`Channel/Thread ${message.channel}-${message.author.username} does not exist. File will be created shortly...`)
-                        resolve([])
+                        reject(new Error(`Failed to find ${message.author.username}'s history. Try chatting again.`))
                     }
                 })
             })
+        }
 
-            if (chatMessages.length === 0) {
+        if (!userConfig)
-                chatMessages = await new Promise((resolve, reject) => {
+            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.`)
-                    openChannelInfo(message.channelId,
-                        message.channel as TextChannel,
-                        message.author.tag
-                    )
-                    getChannelInfo(`${message.channelId}-${message.author.username}.json`, (channelInfo) => {
-                        if (channelInfo?.messages)
-                            resolve(channelInfo.messages)
-                        else {
-                            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.`))
-                        }
-                    })
-                })
-            }
-
-            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
+        // set up new queue
-            msgHist.setQueue(chatMessages)
+        msgHist.setQueue(chatMessages)
 
-            // check if we can push, if not, remove oldest
+        // check if we can push, if not, remove oldest
-            while (msgHist.size() >= msgHist.capacity) msgHist.dequeue()
+        while (msgHist.size() >= msgHist.capacity) msgHist.dequeue()
 
-            // push user response before ollama query
+        // push user response before ollama query
-            msgHist.enqueue({
+        msgHist.enqueue({
-                role: 'user',
+            role: 'user',
-                content: cleanedMessage,
+            content: cleanedMessage,
-                images: messageAttachment || []
+            images: messageAttachment || []
-            })
+        })
 
-            // response string for ollama to put its response
+        // response string for ollama to put its response
-            const response: string = await normalMessage(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 something bad happened, remove user query and stop
-            if (response == undefined) { msgHist.pop(); return }
+        if (response == undefined) { msgHist.pop(); return }
 
-            // if queue is full, remove the oldest message
+        // if queue is full, remove the oldest message
-            while (msgHist.size() >= msgHist.capacity) msgHist.dequeue()
+        while (msgHist.size() >= msgHist.capacity) msgHist.dequeue()
 
-            // successful query, save it in context history
+        // successful query, save it in context history
-            msgHist.enqueue({
+        msgHist.enqueue({
-                role: 'assistant',
+            role: 'assistant',
-                content: response,
+            content: response,
-                images: messageAttachment || []
+            images: messageAttachment || []
-            })
+        })
 
-            // only update the json on success
+        // only update the json on success
-            openChannelInfo(message.channelId,
+        openChannelInfo(message.channelId,
-                message.channel as TextChannel,
+            message.channel as TextChannel,
-                message.author.tag,
+            message.author.tag,
-                msgHist.getItems()
+            msgHist.getItems()
-            )
+        )
-        } catch (error: any) {
+    } catch (error: any) {
-            msgHist.pop() // remove message because of failure
+        msgHist.pop() // remove message because of failure
-            message.reply(`**Error Occurred:**\n\n**Reason:** *${error.message}*`)
+        message.reply(`**Error Occurred:**\n\n**Reason:** *${error.message}*`)
-        }
     }
-)
+})

src/events/ready.ts

@@ -4,15 +4,14 @@ import commands from '../commands/index.js'
 
 // Log when the bot successfully logs in and export it
 export default event(Events.ClientReady, ({ log }, client) => {
-        // Register the commands associated with the bot upon loggin in
+    // Register the commands associated with the bot upon loggin in
-        registerCommands(client, commands)
+    registerCommands(client, commands)
 
-        // set status of the bot
+    // set status of the bot
-        client.user.setActivity({
+    client.user.setActivity({
-            name: 'Powered by Ollama',
+        name: 'Powered by Ollama',
-            type: ActivityType.Custom
+        type: ActivityType.Custom
-        })
+    })
 
-        log(`Logged in as ${client.user.username}.`)
+    log(`Logged in as ${client.user.username}.`)
-    }
+})
-)

src/events/threadDelete.ts

@@ -6,36 +6,35 @@ import fs from 'fs'
  * Event to remove the associated .json file for a thread once deleted
  */
 export default event(Events.ThreadDelete, async ({ log }, thread: ThreadChannel) => {
-        // iterate through every guild member in the thread and delete their history, except the bot
+    // iterate through every guild member in the thread and delete their history, except the bot
-        try {
+    try {
-            log(`Number of User Guild Members in Thread being deleted: ${thread.memberCount!! - 1}`)
+        log(`Number of User Guild Members in Thread being deleted: ${thread.memberCount!! - 1}`)
-            const dirPath = 'data/'
+        const dirPath = 'data/'
 
-            // read all files in data/
+        // read all files in data/
-            fs.readdir(dirPath, (error, files) => {
+        fs.readdir(dirPath, (error, files) => {
-                if (error) {
+            if (error) {
-                    log(`Error reading directory ${dirPath}`, error)
+                log(`Error reading directory ${dirPath}`, error)
-                    return
+                return
-                }
+            }
 
-                // filter files by thread id being deleted
+            // filter files by thread id being deleted
-                const filesToDiscard = files.filter(
+            const filesToDiscard = files.filter(
-                    file => file.startsWith(`${thread.id}-`) &&
+                file => file.startsWith(`${thread.id}-`) &&
-                        file.endsWith('.json'))
+                    file.endsWith('.json'))
 
-                // remove files by unlinking
+            // remove files by unlinking
-                filesToDiscard.forEach(file => {
+            filesToDiscard.forEach(file => {
-                    const filePath = dirPath + file
+                const filePath = dirPath + file
-                    fs.unlink(filePath, error => {
+                fs.unlink(filePath, error => {
-                        if (error)
+                    if (error)
-                            log(`Error deleting file ${filePath}`, error)
+                        log(`Error deleting file ${filePath}`, error)
-                        else
+                    else
-                            log(`Successfully deleted ${filePath} thread information`)
+                        log(`Successfully deleted ${filePath} thread information`)
-                    })
                 })
             })
-        } catch (error) {
+        })
-            log(`Issue deleting user history files from ${thread.id}`)
+    } catch (error) {
-        }
+        log(`Issue deleting user history files from ${thread.id}`)
     }
-)
+})

src/keys.ts

@@ -2,11 +2,9 @@ import { getEnvVar } from './utils/index.js'
 
 export const Keys = {
     clientToken: getEnvVar('CLIENT_TOKEN'),
-    ipAddress: getEnvVar('OLLAMA_IP', '127.0.0.1'), // default ollama ip if none
+    ipAddress: getEnvVar('LLM_ENDPOINT', process.env.OLLAMA_IP ?? '127.0.0.1'), // OLLAMA_IP is a deprecated alias
-    portAddress: getEnvVar('OLLAMA_PORT', '11434'), // default ollama port if none
+    portAddress: getEnvVar('LLM_PORT', process.env.OLLAMA_PORT ?? '11434'), // OLLAMA_PORT is a deprecated alias
-    defaultModel: getEnvVar('MODEL', 'llama3.2'),
+    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

src/queues/queue.ts

@@ -17,7 +17,7 @@ export class Queue<T> implements IQueue<T> {
      * Set up Queue
      * @param capacity max length of queue
      */
-    constructor(public capacity: number = 5) {}
+    constructor(public capacity: number = 5) { }
 
     /**
      * Put item in front of queue

src/utils/commands.ts

@@ -1,4 +1,4 @@
-import { CommandInteraction, ChatInputApplicationCommandData, Client, ApplicationCommandOption } from 'discord.js'
+import { ChatInputCommandInteraction, ChatInputApplicationCommandData, Client, ApplicationCommandOption } from 'discord.js'
 
 /**
  * interface for how slash commands should be run
@@ -6,7 +6,7 @@ import { CommandInteraction, ChatInputApplicationCommandData, Client, Applicatio
 export interface SlashCommand extends ChatInputApplicationCommandData {
     run: (
         client: Client,
-        interaction: CommandInteraction,
+        interaction: ChatInputCommandInteraction,
         options?: ApplicationCommandOption[]
     ) => void
 }

src/utils/env.ts

@@ -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")) && !ipValidate.test(value))
+    if ((name.endsWith("_IP") || name.endsWith("_ADDRESS") || name.endsWith("_ENDPOINT")) && !ipValidate.test(value))
         throw new Error(`Environment variable ${name} does not follow IPv4 formatting.`)
 
     // return env variable

src/utils/events.ts

@@ -37,6 +37,7 @@ export interface EventProps {
     client: Client,
     log: LogMethod,
     msgHist: Queue<UserMessage>,
+    channelHistory: Queue<UserMessage>,
     ollama: Ollama,
     defaultModel: String
 }
@@ -78,6 +79,7 @@ export function registerEvents(
     client: Client,
     events: Event[],
     msgHist: Queue<UserMessage>,
+    channelHistory: Queue<UserMessage>,
     ollama: Ollama,
     defaultModel: String
 ): void {
@@ -88,7 +90,7 @@ export function registerEvents(
 
             // Handle Errors, call callback, log errors as needed
             try {
-                callback({ client, log, msgHist, ollama, defaultModel }, ...args)
+                callback({ client, log, msgHist, channelHistory, ollama, defaultModel }, ...args)
             } catch (error) {
                 log('[Uncaught Error]', error)
             }

src/utils/handlers/chatHistoryHandler.ts

@@ -56,6 +56,54 @@ export async function clearChannelInfo(filename: string, channel: TextChannel, u
     return cleanedHistory
 }
 
+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)
+                console.log(`[Error: addToChannelContext] Incorrect file format`)
+            else {
+                const object = JSON.parse(data)
+                if (object['messages'].length === 0)
+                    object['messages'] = messages as []
+                else if (object['messages'].length !== 0 && messages.length !== 0)
+                    object['messages'] = messages as []
+                fs.writeFileSync(fullFileName, JSON.stringify(object, null, 2))
+            }
+        })
+    } else { // 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))
+        console.log(`[Util: addToChannelContext] Created '${fullFileName}' in working directory`)
+    }
+}
+
+export async function accessChannelContext(filename: string, callback: (config: Channel | undefined) => void): Promise<void> {
+    const fullFileName = `data/${filename}-context.json`
+    if (fs.existsSync(fullFileName)) {
+        fs.readFile(fullFileName, 'utf8', (error, data) => {
+            if (error) {
+                callback(undefined)
+                return // something went wrong... stop
+            }
+            callback(JSON.parse(data))
+        })
+    } else {
+        callback(undefined) // file not found
+    }
+}
+
 /**
  * Method to open the channel history
  * 

src/utils/messageNormal.ts

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

tests/commands.test.ts

@@ -5,16 +5,9 @@ import { describe, expect, it, vi } from 'vitest'
 import commands from '../src/commands/index.js'
 
 /**
- * Mocking redis found in client.ts because of the commands
+ * Mocking 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
@@ -34,7 +27,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']
+        const expectedCommands = ['thread', 'private-thread', 'message-stream', 'toggle-chat', 'shutoff', 'modify-capacity', 'clear-user-channel-history', 'pull-model', 'switch-model', 'delete-model', 'summary']
         expect(commandsString).toBe(expectedCommands.join(', '))
     })
 })

tests/events.test.ts

@@ -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('ready, messageCreate, interactionCreate, threadDelete')
+        expect(eventsString).toBe('clientReady, messageCreate, interactionCreate, threadDelete')
     })
 })

tests/getEnvVar.test.ts

@@ -47,4 +47,28 @@ 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
+        }
+    })
 })

tsconfig.json

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

vitest.config.ts

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