chore: add docker-compose

Include a docker-compose.yml file for running the bot with Redis storage

Author: mloberg

Dockerfile

@@ -14,4 +14,5 @@ RUN mv src/tsconfig.json tsconfig.json && \
 COPY docker/entrypoint.sh /usr/local/bin/
 ENTRYPOINT [ "entrypoint.sh" ]
 
+ENV NODE_ENV production
 CMD [ "node", "dist/index.js" ]

README.md

@@ -35,12 +35,16 @@ The easiest way to run Dwight is via Docker. We host images on
 First you need to register the application commands. You can either do this globally,
 which can take a couple hours to propegate or for a single guild which is instant.
 
-    docker run -e BOT_TOKEN=your-bot-token -e CLIENT_ID=your-client-id ghcr.io/mloberg/dwight-bot [guild]
+    docker run --rm -e BOT_TOKEN=your-bot-token -e CLIENT_ID=your-client-id ghcr.io/mloberg/dwight-bot install [guild]
 
 Once installed, run the app.
 
     docker run -e BOT_TOKEN=your-bot-token ghcr.io/mloberg/dwight-bot
 
+You can also use Docker Compose. Grab [docker-compose.yml](docker-compose.yml),
+create a `.env` from [.env.dist](.env.dist), and run `docker-compose up -d`. To
+register the commands, run `docker-compose run --rm bot install`.
+
 ### Manually
 
 To run Dwight without Docker, you'll need NodeJS 16.
@@ -62,7 +66,7 @@ can either save it to Redis or to disk as a JSON file. To save in redis, pass
 (or set) `DB_URL` to `redis://user:pass@localhost:6379`. To save to disk set
 `file:./path/to/file.json`.
 
-    docker run -e BOT_TOKEN=your-bot-token -e DB_URL=file:.data/store.json -v $PWD/.data:/app.data ghcr.io/mloberg/dwight-bot
+    docker run -e BOT_TOKEN=your-bot-token -e DB_URL=file:.data/store.json -v $PWD/.data:/app/.data ghcr.io/mloberg/dwight-bot
 
 ## Development
 

docker-compose.yml

@@ -0,0 +1,13 @@
+version: '3'
+services:
+  bot:
+    image: ghcr.io/mloberg/dwight-bot
+    env_file: .env
+    environment:
+      DB_URL: redis://redis:6379
+  redis:
+    image: redis:alpine
+    volumes:
+      - persist:/data
+volumes:
+  persist:

docker/entrypoint.sh

@@ -1,8 +1,8 @@
 #!/bin/sh
 set -e
 
-if [ "${1}" = "install" ]; then
-    GUILD_ID="${2}" node dist/bin/install.js
+if [ "$1" = "install" ]; then
+    GUILD_ID="$2" node dist/bin/install.js
     exit 0
 fi
 

src/bin/install.ts

@@ -1,8 +1,9 @@
 /* eslint-disable no-process-exit */
 /* eslint-disable unicorn/no-process-exit */
 
+import { SlashCommandBuilder } from '@discordjs/builders';
 import { REST } from '@discordjs/rest';
-import { Routes } from 'discord-api-types/v9';
+import { APIApplicationCommand, APIGuild, APIPartialGuild, Routes } from 'discord-api-types/v9';
 
 import commands from '../commands';
 import config from '../config';
@@ -14,17 +15,78 @@ if (!clientID) {
     process.exit(1);
 }
 
+class API {
+    private rest: REST;
+
+    constructor(token: string, private clientID: string, private guildID?: string) {
+        this.rest = new REST({ version: '9' }).setToken(token);
+    }
+
+    async list(): Promise<APIApplicationCommand[]> {
+        const route = this.guildID
+            ? Routes.applicationGuildCommands(this.clientID, this.guildID)
+            : Routes.applicationCommands(this.clientID);
+
+        const response = await this.rest.get(route);
+        return response as APIApplicationCommand[];
+    }
+
+    async install(commands: SlashCommandBuilder[]): Promise<APIApplicationCommand[]> {
+        const route = this.guildID
+            ? Routes.applicationGuildCommands(this.clientID, this.guildID)
+            : Routes.applicationCommands(this.clientID);
+        const body = commands.map((command) => command.toJSON());
+
+        const response = await this.rest.put(route, { body });
+        return response as APIApplicationCommand[];
+    }
+
+    async uninstall(command: APIApplicationCommand): Promise<void> {
+        const route = command.guild_id
+            ? Routes.applicationGuildCommand(this.clientID, command.guild_id, command.id)
+            : Routes.applicationCommand(this.clientID, command.id);
+
+        await this.rest.delete(route);
+    }
+
+    async permission(command: string, guildID: string, user: string, permission = true): Promise<void> {
+        const route = Routes.applicationCommandPermissions(this.clientID, guildID, command);
+        const body = { permissions: [{ id: user, type: 2, permission }] };
+
+        await this.rest.put(route, { body });
+    }
+
+    async guilds(): Promise<string[]> {
+        const response = await this.rest.get(Routes.userGuilds());
+        const guilds = response as APIPartialGuild[];
+        return guilds.map((guild) => guild.id);
+    }
+
+    async guild(guildID: string): Promise<APIGuild> {
+        const response = await this.rest.get(Routes.guild(guildID));
+        return response as APIGuild;
+    }
+}
+
 (async () => {
-    const rest = new REST({ version: '9' }).setToken(config.token);
-    const route = !config.guildID
-        ? Routes.applicationCommands(clientID)
-        : Routes.applicationGuildCommands(clientID, config.guildID);
+    const api = new API(config.token, clientID, config.guildID);
 
     try {
+        if (process.argv.includes('--uninstall')) {
+            for (const command of await api.list()) {
+                logger.info(
+                    { id: command.id, command: command.name, guild: command.guild_id },
+                    'Deleting application (/) command',
+                );
+                await api.uninstall(command);
+            }
+            return;
+        }
+
         logger.info({ guild: config.guildID, commands: [...commands.keys()] }, 'Installing application (/) commands');
-        await rest.put(route, { body: commands.map((command) => command.config.toJSON()) });
+        await api.install(commands.map((command) => command.config));
     } catch (error) {
-        logger.fatal(error as Error);
+        logger.fatal(error);
         process.exit(1);
     }
 })();