feature: implement PostgreSQL for storage of per-server settings

.dockerignore

@@ -1,21 +1,23 @@
-**/node_modules/*
+**/.git/*
+**/.github/*
+**/.vscode/*
 **/dist/*
+**/media/*
+**/node_modules/*
+**/secrets/*
 
-.git/
-.github/
-.vscode/
-media/
-src/util
+**/.env*
+**/.eslint*
+**/.gitattributes
+**/.gitignore
+**/.pre-commit-config.yaml
+**/.prettier*
+**/docker-compose*.y*ml
 
+docs/*
+src/cli/*
+
+*.gz
 *.log
+*.sql
 *.tar
-*.gz
-
-.env*
-docker-compose*.y*ml
-
-.gitattributes
-.gitignore
-
-.pre-commit-config.yaml
-.prettierrc

.env.example

@@ -1,4 +1,10 @@
-DISCORD_BOT_TOKEN=put.your.token.here
+DISCORD_APP_ID=385950397493280805
+# Note this should be set to /run/secrets/discord-bot-token for Docker instances
+DISCORD_BOT_TOKEN_FILE=./secrets/discord-bot-token.txt
+
+POSTGRES_USER=linkfix
+# Note this should be set to /run/secrets/postgres-password for Docker instances
+POSTGRES_PASSWORD_FILE=./secrets/postgres-password.txt
 
 LINKFIX_DEBUG=0
 

.eslintrc.js

@@ -7,6 +7,9 @@ module.exports = {
   },
   root: true,
   ignorePatterns: ["/dist"],
+  rules: {
+    "sort-imports": "error",
+  },
   overrides: [
     {
       files: ["*.ts"],

.github/workflows/_lint.yml

@@ -16,7 +16,7 @@ jobs:
 
       - run: npm ci
 
-      - run: npm run prettier
+      - run: npm run prettier-check
 
   eslint:
     runs-on: ubuntu-latest

.pre-commit-config.yaml

@@ -13,7 +13,7 @@ repos:
     rev: v3.1.0
     hooks:
       - id: prettier
-        exclude: \.(json|md|mts|sql)$
+        exclude: \.(json|md|sql)$
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.5.0

.prettierignore

@@ -1,12 +1,8 @@
-# ignore folders
 .vscode
 dist
 media
 secrets
 
-# ignore files
 **/*.json
 **/*.md
-# .mts files are generated by PgTyped. Shouldn't be touched otherwise.
-**/*.mts
 **/*.sql

Dockerfile

@@ -18,5 +18,6 @@ RUN [ "npm", "ci", "--omit=dev" ]
 COPY . .
 RUN [ "npm", "run", "build-prod" ]
 
-# Fire 'er up!
-CMD [ "node", "dist/index.js" ]
+ENV RUNNING_IN_DOCKER "true"
+
+CMD [ "/usr/local/bin/node", "./dist/bot/index.js" ]

docker-compose.example.yml

@@ -1,19 +1,54 @@
-# 1) Copy this file from docker-compose.example.yml to docker-compose.yml
-# 2) Edit the `environment` section to use your bot's token
-#     i.e. `DISCORD_BOT_TOKEN=123456.789.10`
-# 3) execute `docker compose up` to start the bot
+# 1. Copy this file from docker-compose.example.yml to docker-compose.yml
+# 2. In the 'secrets/' directory, create two files:
+#     - discord-bot-token.txt
+#     - postgres-password.txt
+# 3. Populate files with the following:
+#     - discord-bot-token.txt: your bot's Discord token
+#     - postgres-password.txt: a secure password for Postgres
+# 4. execute `docker compose up [-d]` to start the bot
+
+version: "3.8"
+
+x-db-config: &db-config
+  POSTGRES_USER: linkfix
+  POSTGRES_PASSWORD: change.me.please
 
 services:
   linkfix_bot:
+    # replace `image: <image>` with `build: .` for local dev environments
     image: ghcr.io/podaboutlist/linkfix-for-discord:latest
-    # Use SIGKILL to emulate Ctrl+C (discord.js does not handle SIGTERM)
-    stop_signal: SIGKILL
     environment:
-      - DISCORD_BOT_TOKEN=your.bot.token.here
-      - LINKFIX_DEBUG=0
-      - INSTAGRAM_FIX_URL=ddinstagram.com
-      - PIXIV_FIX_URL=phixiv.net
-      - REDDIT_FIX_URL=vxreddit.com
-      - TIKTOK_FIX_URL=vxtiktok.com
-      - TWITTER_FIX_URL=fxtwitter.com
-      - YOUTUBE_FIX_URL=youtu.be
+      <<: *db-config
+      DISCORD_BOT_TOKEN: your.token.here
+      LINKFIX_DEBUG: 0
+      INSTAGRAM_FIX_URL: ddinstagram.com
+      PIXIV_FIX_URL: phixiv.net
+      REDDIT_FIX_URL: vxreddit.com
+      TIKTOK_FIX_URL: vxtiktok.com
+      TWITTER_FIX_URL: fxtwitter.com
+      YOUTUBE_FIX_URL: youtu.be
+    depends_on:
+      postgres:
+        condition: service_healthy
+    links:
+      - "postgres:postgres.docker"
+
+  postgres:
+    image: postgres:16-alpine
+    restart: always
+    environment:
+      <<: *db-config
+    volumes:
+      - pgdata:/var/lib/postgresql/data
+      - ./src/bot/database/initdb/:/docker-entrypoint-initdb.d
+    ports:
+      - "127.0.0.1:15432:5432"
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -d $${POSTGRES_USER} -U $${POSTGRES_USER}"]
+      interval: 5s
+      timeout: 2s
+      retries: 3
+      start_period: 5s
+
+volumes:
+  pgdata: