.gitignore

@@ -2,9 +2,10 @@
 .idea
 node_modules
 build
-auth.*
+config.json
 *.js
 ./W*/
 _bot.json
 bot.json
 backup
+scratch

.gitmodules

@@ -1,11 +1,3 @@
-[submodule "wheatley-private"]
-	path = src/wheatley-private
-	url = https://github.com/TCCPP/empty.git
-	# url = git@github.com:TCCPP/wheatley-private.git
-
-# [submodule "dyno-import"]
-# 	path = dyno-import
-# 	url = git@github.com:TCCPP/dyno-import.git
 [submodule "wiki"]
 	path = wiki
 	url = git@github.com:TCCPP/wiki-articles.git

Makefile

@@ -30,7 +30,7 @@ format: prereqs  ## Formats source files
 	$(NPM) run format
 
 .PHONY: test
-test: prereqs  ## Formats source files
+test: prereqs  ## Runs all tests
 	$(NPM) run test
 
 .PHONY: clean
@@ -53,10 +53,24 @@ deploy: ts-check  ## Deploys code
 prod: format deploy  ## Deploys code and restarts the bot
 	ssh $(SERVER) "export NVM_DIR=\"$$HOME/.nvm\"; source $$NVM_DIR/nvm.sh; screen -XS _Wheatley quit; cd projects/wheatley; ./start.sh"
 
-.PHONY: npm-update
-npm-update:  ## Updates npm packages
+.PHONY: update
+update:  ## Updates npm packages
 	./scripts/update_packages.sh
 
 .PHONY: mongo
-mongo:
+mongo:  ## Port forward mongo
 	ssh -L 27017:127.0.0.1:27017 x0 -N
+
+PODMAN=podman
+
+.PHONY: build-dev-container
+build-dev-container:  ## Build dev container container
+	$(PODMAN) build -t wheatley-dev -f dev-container/Dockerfile .
+
+.PHONY: run-dev-container
+run-dev-container: build-dev-container  ## Runs the dev container container
+	$(PODMAN) run --user=wheatley --cap-drop=all -it wheatley-dev
+
+.PHONY: dev
+dev: build  ## Runs in dev mode
+	node build/src/main.js

README.md

@@ -22,6 +22,25 @@ The bot is very modular and most components are completely independent of other
 
 ## Local Development
 
+In order to run the bot locally you'll need to create a bot and setup some basic information for Wheatley:
+
+1. Go to https://discord.com/developers/applications and create an application
+2. Move or copy `config.default.json` to `config.json`
+3. Go to Application Settings > Bot
+   1. Request or reset your bot's token, copy it to `token` in `config.json`
+   2. Under Privileged Gateway Intents, select presence intent, server members intent, and the message content intent
+4. Go to Application Settings > Installation
+   1. Select "Guild Install"
+   2. Select "Discord Provided Link"
+   3. Select scopes: `applications.commands` and `bot`
+   4. Select permissions: `Administrator`
+5. Setup a test server (ask on TCCPP for help if needed)
+6. Install your bot on a test server
+
+Once that is setup, the easiest way to get started with local bot development is to run `make run-dev-container`, builds
+a container and runs it with podman. Once the container builds, run `make dev` in the container's shell and you should
+be good to go.
+
 The bot relies on a lot of server-specific information, such as IDs for channels and roles. Components which do not rely
 on any server-specific information are marked as freestanding. When developing locally, configure the bot as
 freestanding (see below). If you are working on a component which relies on server specific information, the best
@@ -39,9 +58,9 @@ solution currently is the following:
     }
 ```
 
-## auth.json
+## config.json
 
-Secrets and other bot info must be configured in the `auth.json` file. An example looks like:
+Secrets and other bot info must be configured in the `config.json` file. An example looks like:
 
 ```json
 {
@@ -52,17 +71,21 @@ Secrets and other bot info must be configured in the `auth.json` file. An exampl
     "user": "wheatley",
     "password": "<mongo password>",
     "host": "127.0.0.1", // optional
-    "port": 27017        // optional
+    "port": 27017 // optional
   },
-  "freestanding": false, // optional
-  "passive": false       // optional
+  "freestanding": false, // optional,
+  "exclude": [
+    // optional
+    "components/the-button.js",
+    "modules/tccpp/components/buzzwords.js",
+    "modules/tccpp/private/**"
+  ]
 }
 ```
 
 Mongo credentials can be omitted locally if you don't need to work on components that use mongo. `freestanding: true`
 can be specified to turn on only components which don't rely on channels etc. specific to Together C & C++ to exist.
 Freestanding mode also disables connecting to MongoDB.
-`passive: true` can be specified to run the bot in passive mode, where it will not advertise or react to commands, and only load components that are marked as passive (useful for testing new features in a second instance without interfering with a running primary instance).
 
 ## Bot Component Abstraction
 
@@ -73,19 +96,8 @@ export class BotComponent {
   static get is_freestanding() {
     return false;
   }
-  static get is_passive() {
-    return false;
-  }
-  // Add a command
-  add_command<T extends unknown[]>(
-    command:
-      | TextBasedCommandBuilder<T, true, true>
-      | TextBasedCommandBuilder<T, true, false, true>
-      | MessageContextMenuCommandBuilder<true>
-      | ModalHandler<true>,
-  );
-  // Called after all components are constructed and the bot logs in, but before bot commands are finalized
-  async setup();
+  // Called after all components are constructed and the bot logs in, commands can be added here
+  async setup(commands: CommandSetBuilder);
   // Called when Wheatley is ready
   async on_ready();
   // General discord events
@@ -126,10 +138,8 @@ export default class Echo extends BotComponent {
     return true;
   }
 
-  constructor(wheatley: Wheatley) {
-    super(wheatley);
-
-    this.add_command(
+  override async setup(commands: CommandSetBuilder) {
+    commands.add(
       new TextBasedCommandBuilder("echo")
         .set_description("echo")
         .add_string_option({
@@ -171,39 +181,5 @@ is read or a regex can be specified.
 
 ## Database
 
-The bot uses MongoDB. It previously used a giant json file (the migration script is located in the scripts folder). For
-local development you likely won't need to setup a mongo database, depending on the components you're working on.
-However, if you are contributing to components that do need the database here are the installation steps for ubuntu:
-
-https://www.mongodb.com/docs/manual/tutorial/install-mongodb-on-ubuntu/
-
-```sh
-sudo apt-get install gnupg curl
-curl -fsSL https://pgp.mongodb.com/server-6.0.asc | \
-   sudo gpg -o /usr/share/keyrings/mongodb-server-6.0.gpg \
-   --dearmor
-echo "deb [ arch=amd64,arm64 signed-by=/usr/share/keyrings/mongodb-server-6.0.gpg ] https://repo.mongodb.org/apt/ubuntu focal/mongodb-org/6.0 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-6.0.list
-sudo apt-get update
-sudo apt-get install -y mongodb-org
-sudo systemctl start mongod
-sudo systemctl status mongod
-sudo systemctl enable mongod
-sudo ufw deny 27017
-mongosh
-# use admin
-# db.createUser({user:'mongoadmin', pwd: '<password>', roles:['userAdminAnyDatabase']})
-# db.auth('mongoadmin', '<password>') # test that authentication works
-# use wheatley
-# db.createUser({user:'wheatley', pwd: '<password>', roles:[{db:'wheatley', role:'readWrite'}]})
-# use wheatley
-sudo vim /etc/mongod.conf
-# net:
-#   port: 27017
-#   bindIp: 127.0.0.1
-# security:
-#   authorization: enabled
-sudo systemctl restart mongod
-```
-
-To connect with [compass](https://www.mongodb.com/try/download/compass) to a mongo server setup on another server:
-`ssh -L 27017:127.0.0.1:27017 <server> -N`.
+The bot uses MongoDB. It previously used a giant json file (the migration script is located in the scripts folder). The
+development docker container sets up and orchestrates a mongodb server for the bot to use.

config.default.json

@@ -0,0 +1,17 @@
+{
+    "id": "<bot id>",
+    "guild": "<guild id>",
+    "token": "<token>",
+    "mongo": {
+        "user": "wheatley",
+        "password": "wheatley",
+        "host": "127.0.0.1",
+        "port": 27017
+    },
+    "freestanding": true,
+    "exclude": [
+        "modules/tccpp/components/anti-self-star.js",
+        "modules/tccpp/components/buzzwords.js",
+        "modules/tccpp/private/**"
+    ]
+}

dev-container/Dockerfile

@@ -0,0 +1,38 @@
+FROM ubuntu:22.04
+
+ENV DEBIAN_FRONTEND noninteractive
+
+# Basic software setup
+RUN apt update
+RUN apt install -y curl wget vim git make build-essential net-tools gnupg expect
+
+# node
+RUN curl --proto "=https" -fsSL https://deb.nodesource.com/setup_21.x | bash -
+RUN apt install -y nodejs
+
+# Mongodb
+RUN curl --proto "=https" -fsSL https://www.mongodb.org/static/pgp/server-8.0.asc | \
+    gpg -o /usr/share/keyrings/mongodb-server-8.0.gpg \
+    --dearmor
+RUN echo "deb [ arch=amd64,arm64 signed-by=/usr/share/keyrings/mongodb-server-8.0.gpg ] https://repo.mongodb.org/apt/ubuntu jammy/mongodb-org/8.0 multiverse" | \
+    tee /etc/apt/sources.list.d/mongodb-org-8.0.list
+RUN apt update
+RUN apt install -y mongodb-org
+
+# Cleanup apt stuff
+RUN apt-get clean
+RUN rm -rf /var/lib/apt/lists/*
+
+# Setup a user
+RUN groupadd wheatley
+RUN useradd -m -g wheatley -s /bin/bash wheatley
+RUN mkdir /opt/wheatley/ && chown wheatley:wheatley /opt/wheatley/
+RUN mkdir /opt/mongo/ && mkdir /opt/mongo/data && chown -R wheatley:wheatley /opt/mongo/
+USER wheatley
+
+COPY --chmod=755 dev-container/entry.sh /entry.sh
+
+WORKDIR /opt/wheatley
+COPY --chown=wheatley:wheatley . .
+
+ENTRYPOINT ["/entry.sh"]

dev-container/entry.sh

@@ -0,0 +1,40 @@
+#!/bin/sh
+
+/usr/bin/mongod -f /etc/mongod.conf --logpath /opt/mongo/mongod.log --dbpath /opt/mongo/data &
+
+PORT=27017
+TIMEOUT=10
+INTERVAL=1
+SECONDS_ELAPSED=0
+
+echo "Waiting for mongo to start..."
+
+while [ $SECONDS_ELAPSED -lt $TIMEOUT ]; do
+    if netstat -ntlp | grep -q ":$PORT"; then
+        echo "Mongo now started"
+        break
+    fi
+    sleep $INTERVAL
+    SECONDS_ELAPSED=$((SECONDS_ELAPSED + INTERVAL))
+done
+
+if [ $SECONDS_ELAPSED -eq $TIMEOUT ]; then
+    echo "Timeout reached while waiting for mongodb, $PORT was never listed in netstat"
+    exit 1
+fi
+
+mongosh --eval << END
+use admin
+if (db.getUser("mongoadmin") == null) {
+    db.createUser({user:"mongoadmin", pwd: "password", roles:["userAdminAnyDatabase"]})
+}
+db.auth("mongoadmin", "password")
+use wheatley
+if (db.getUser("wheatley") == null) {
+    db.createUser({user:"wheatley", pwd: "wheatley", roles:[{db:"wheatley", role:"readWrite"}]})
+}
+END
+
+npm i
+
+exec /bin/bash

docker/bot/.dockerignore

@@ -0,0 +1,34 @@
+**/.dockerignore
+**/.env
+**/.git
+**/.github
+**/.gitignore
+**/.gitmodules
+**/.husky
+**/.project
+**/.settings
+**/.toolstarget
+**/.vs
+**/.vscode
+**/node_modules
+**/npm-debug.log
+**/build
+.eslintrc.yml
+.git-blame-ignore-revs
+.prettierignore
+.prettierrc.cjs
+docker
+indexes
+LICENSE.txt
+lint-staged.config.mjs
+Makefile
+package-lock.json
+package.json
+README.md
+run-persist.sh
+scripts
+SECURITY.md
+start.sh
+test
+tsconfig.json
+vitest.config.ts

docker/bot/Dockerfile

@@ -0,0 +1,20 @@
+# syntax=docker/dockerfile:1
+
+FROM node:current-alpine
+
+RUN --mount=type=bind,source=./package.json,target=package.json \
+    --mount=type=bind,source=./package-lock.json,target=package-lock.json \
+    --mount=type=cache,target=/root/.npm \
+    npm ci
+
+RUN adduser -s /bin/bash -D wheatley;echo 'wheatley:wheatley' | chpasswd
+
+USER wheatley
+
+WORKDIR /home/wheatley/bot
+
+COPY . .
+
+RUN npm run build
+
+CMD ["node", "build/src/main.js"]

docker/compose.yaml

@@ -0,0 +1,33 @@
+name: wheatley
+
+services:
+  bot:
+    container_name: wheatley_bot
+    image: TCCPP/wheatley
+    build:
+      context: ../
+      dockerfile: docker/bot/Dockerfile
+    # pull_policy: build
+    depends_on:
+      - db
+    # restart: always
+
+  db:
+    container_name: wheatley_db
+    image: mongo:latest
+    environment:
+      - MONGO_INITDB_ROOT_USERNAME=admin
+      - MONGO_INITDB_ROOT_PASSWORD=password
+      - MONGO_INITDB_DATABASE=wheatley
+    volumes:
+      - ./db/mongo-init.js:/docker-entrypoint-initdb.d/mongo-init.js:ro
+      - ./db/mongod.conf:/etc/mongod.conf:ro
+      - wheatley_data:/data/db
+    # expose:
+    #   - 27017
+    ports:
+      - 127.0.0.1:27017:27017
+    # restart: always
+
+volumes:
+  wheatley_data:

docker/db/mongo-init.js

@@ -0,0 +1,7 @@
+
+
+// https://stackoverflow.com/a/68253550
+db = db.getSiblingDB('admin');
+db.auth("admin", "password");
+db = db.getSiblingDB('wheatley');
+db.createUser({user:'wheatley', pwd: 'wheatley', roles:[{db:'wheatley', role:'readWrite'}]});