.npmrc

@@ -1,3 +0,0 @@
-@astrogd:registry=https://git.astrogd.cloud/api/packages/packages/npm/
-@internal:registry=https://git.astrogd.cloud/api/packages/internal/npm/
-//git.astrogd.cloud/api/packages/internal/npm/:_authToken=${NPM_TOKEN}

Changelog.md

@@ -1,30 +1,9 @@
 # Changelog
-
 This file is used to list changes made to this software.
 
-_Current development release: 1.1.1_
-
-## V1.1.1 [2023-09-16]
-
-### Updates
-- Updated packages to latest versions
-
-### Bugfixes
-- Fixed a bug where the bot would crash on startup if the database connection establishment took too long
-
-### Other
-- Renamed db service in docker compose file from database to db
-
-## V1.1.0 [2022-11-29]
-
-### Features
-
-- If a channel gets deleted and the responsible user has been detected, a message will be sent to that user informing him of the deletion
-
 ## V1.0.0 [2022-11-29]
-
+_Current development version: **1.0.0**_
 ### Features
-
 - /info
 - /logchannel
 - /blocklist get

README.md

@@ -1,53 +1,40 @@
 # eu.astrogd.white-leopard
-
 A Discord bot that checks Discord channel names for banned words and prevents renaming of them
 
 ## Commands
-
 ### /logchanel [channel?] `Permission: MANAGE_GUILD`
-
 Sets the channel where the bot will log if a channel meets the banned word criteria. If channel is omitted, the log channel will be disabled.
 
 ### /blocklist `Permission: MANAGE_GUILD`
-
 #### /blocklist get
-
 Returns the global and server specific banned word list and returns it (Same behaviour as /showblocklist)
 
 #### /blocklist add [word]
-
 Adds the word to the server specific blocklist
 
 #### /blocklist remove [word]
-
 Removes the word from the server specific blocklist
 
 ### /info `Permission: EVERYONE`
-
 Returns general information about the bot and the servers stats
 
 ### /preservesettings `Permission: ADMINISTRATOR`
-
 Changes the behaviour when the bot leaves the server.
 Options are:
-
 - Keep settings persistent even if the bot leaves
 - Delete setting when the bot leaves the server [default]
 
 ### /showblocklist `Permission: MANAGE_CHANNELS`
-
 Returns the global and server specific banned word list and returns it
 
 ### /showsettings `Permission: MANAGE_GUILD`
-
 Returns the current settings for the server
 
 ## Environment variables
-
 | Name             | Description                                                                     | Required | Example             |
 | :--------------- | :------------------------------------------------------------------------------ | :------: | :------------------ |
 | TOKEN            | Discord bot token to log into the API with                                      |   ▶️/🚀    | NzYzMDP3MzE1Mzky... |
-| DB_HOST          | Hostname of the database                                                        |    ▶️     | 127.0.0.1           |
+| DB_HOST          | Hostname of the database                                                        |    ▶️     | 127.0.0.1:3546      |
 | DB_USERNAME      | Username of the database                                                        |    ▶️     | root                |
 | DB_PASSWORD      | Password of the database                                                        |    ▶️     | abc123              |
 | DB_DATABASE      | Database name                                                                   |    ▶️     | white-leopard       |
@@ -55,7 +42,6 @@ Returns the current settings for the server
 | DEPLOY_TOKEN     | Production Discord bot token to log into the API with                           |    🚀     | NzYzMDP3MzE1Mzky... |
 | DEPLOY_CLIENT_ID | Production Client ID of the Discord appication associated with the deploy token |    🚀     | 763035392692274     |
 
-### Icon explanation
-
+### Icon explanation:
 - ▶️ = Required in runtime
 - 🚀 = Required during CI/CD

docker-compose.yml

@@ -8,16 +8,15 @@ services:
     tty: true
     stdin_open: true
     depends_on:
-      - db
+      - database
     restart: unless-stopped
     environment:
       - TOKEN=$TOKEN
-      - DB_HOST=db
+      - DB_HOST=database
       - DB_USERNAME=$DB_USERNAME
       - DB_PASSWORD=$DB_PASSWORD
       - DB_DATABASE=$DB_DATABASE
-      - MONITOR_URL=$MONITOR_URL
-  db:
+  database:
     image: postgres:latest
     restart: unless-stopped
     ports:

package.json

@@ -1,27 +1,22 @@
 {
   "name": "eu.astrogd.white-leopard",
-  "version": "1.2.0",
+  "version": "1.0.0",
   "description": "A Discord bot that checks channel names for blacklisted words and reverts the changes if necessary",
   "main": "build/index.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "build": "tsc && shx cp package-lock.json build/package-lock.json",
     "start:rebuild": "npm run build && node --enable-source-maps .",
-    "version:dev": "npm version prerelease --preid dev --no-commit-hooks --no-git-tag-version",
-    "version:patch": "npm version prepatch --preid dev --no-commit-hooks --no-git-tag-version",
-    "version:minor": "npm version preminor --preid dev --no-commit-hooks --no-git-tag-version",
-    "version:major": "npm version premajor --preid dev --no-commit-hooks --no-git-tag-version",
-    "version:release": "npm version patch --no-commit-hooks --no-git-tag-version",
     "deploy-commands:dev": "ts-node ci/devDeploy.ts",
     "deploy-commands:prod": "ts-node ci/deploy.ts",
     "deploy:dev": "npm run build && npm run deploy-commands:dev && docker compose build && docker compose up -d",
     "deploy:prod": "rimraf build && npm run build && npm run deploy-commands:prod && docker build -t astrogd/white-leopard:latest . && docker push astrogd/white-leopard:latest",
-    "start": "npm run build && npm run deploy-commands:dev && docker-compose up -d db && node --enable-source-maps .",
-    "migration:create": "node --require ts-node/register ./node_modules/typeorm/cli.js migration:generate -d src/data/dataSource.migration.ts -p src/data/migrations/data",
-    "migration:run": "node --require ts-node/register ./node_modules/typeorm/cli.js migration:run -d src/data/dataSource.migration.ts",
-    "migration:revert": "node --require ts-node/register ./node_modules/typeorm/cli.js migration:revert -d src/data/dataSource.migration.ts",
-    "migration:show": "node --require ts-node/register ./node_modules/typeorm/cli.js migration:show -d src/data/dataSource.migration.ts",
-    "migration:check": "node --require ts-node/register ./node_modules/typeorm/cli.js migration:generate --check -d src/data/dataSource.migration.ts src/data/migrations/data"
+    "start": "npm run build && npm run deploy-commands:dev && docker-compose up --no-start && docker compose start database && node --enable-source-maps .",
+    "migration:create": "node --require ts-node/register ./node_modules/typeorm/cli.js migration:generate -d src/data/dataSource.ts -p src/data/migrations/data",
+    "migration:run": "node --require ts-node/register ./node_modules/typeorm/cli.js migration:run -d src/data/dataSource.ts",
+    "migration:revert": "node --require ts-node/register ./node_modules/typeorm/cli.js migration:revert -d src/data/dataSource.ts",
+    "migration:show": "node --require ts-node/register ./node_modules/typeorm/cli.js migration:show -d src/data/dataSource.ts",
+    "migration:check": "node --require ts-node/register ./node_modules/typeorm/cli.js migration:generate --check -d src/data/dataSource.ts src/data/migrations/data"
   },
   "repository": {
     "type": "git",
@@ -35,16 +30,15 @@
   "homepage": "https://github.com/r-Overwatch2/eu.astrogd.white-leopard#readme",
   "devDependencies": {
     "@types/express": "^4.17.14",
-    "@types/fs-extra": "^11.0.2",
-    "@types/node": "^18.17.17",
-    "rimraf": "^5.0.1",
+    "@types/fs-extra": "^9.0.13",
+    "@types/node": "^18.11.9",
+    "rimraf": "^3.0.2",
     "shx": "^0.3.4",
     "ts-node": "^10.9.1",
-    "typescript": "^5.2.2"
+    "typescript": "^4.9.3"
   },
   "dependencies": {
-    "@astrogd/eu.astrogd.uptime-kuma-push-monitor": "^1.0.0-dev.3",
-    "discord.js": "^14.13.0",
+    "discord.js": "^14.6.0",
     "dotenv": "^16.0.3",
     "express": "^4.18.2",
     "fs-extra": "^11.0.0",

src/client/init.ts

@@ -1,25 +1,13 @@
 import { runCleanup } from "../service";
 import client from "./index";
-import { initPromise } from "../data/dataSource";
-import pushMonitor from "@astrogd/eu.astrogd.uptime-kuma-push-monitor";
 
 const token = process.env["TOKEN"];
 if (!token) throw new ReferenceError("TOKEN environment variable is missing");
 
-async function run() {
-    console.log("Establishing database connection");
-    await initPromise;
-    console.log("Connection established\nAuthenticating with Discord API");
-    client.login(token);
-}
+client.login(token);
 
-client.on("ready", async () => {
+client.on("ready", () => {
     console.log(`Connected to Discord API. Bot account is ${client.user?.tag} (${client.user?.id})`);
-    if (process.env["MONITOR_URL"]) pushMonitor.register(process.env["MONITOR_URL"], 120);
-    pushMonitor.enableShutdownNotifications();
-    pushMonitor.setPerformanceHandler(() => client.ws.ping);
 
     runCleanup();
 });
-
-run();

src/data/dataSource.migration.ts

@@ -1,3 +0,0 @@
-import dataSource from "./dataSource";
-
-export default dataSource;

src/data/dataSource.ts

@@ -28,9 +28,6 @@ const dataSource = new DataSource({
     migrationsTransactionMode: "each"
 });
 
-const initPromise = dataSource.initialize();
+dataSource.initialize();
 
 export default dataSource;
-export {
-    initPromise
-}

src/events/channelCreate.ts

@@ -3,7 +3,7 @@ import { AuditLogEvent, Events, GuildAuditLogsEntry, PermissionFlagsBits, User }
 import { getGuildSetting } from "../tools/data";
 import { Badword, database } from "../data";
 import { IsNull } from "typeorm";
-import getDefaultEmbed, { getFailedEmbed, getUserReportEmbed } from "../tools/defaultEmbeds";
+import getDefaultEmbed, { getFailedEmbed } from "../tools/defaultEmbeds";
 import { getGuildChannel } from "../tools/discord";
 import { Color, Emoji } from "../tools/design";
 
@@ -89,13 +89,6 @@ client.on(Events.ChannelCreate, async (newChannel) => {
         return;
     }
 
-    if (responsibleUser) {
-        const embed = getUserReportEmbed(guild.name, newChannel.name);
-        responsibleUser.send({
-            embeds: [embed]
-        }).catch(() => {});
-    }
-
     if (!logChannel || !logChannel.isTextBased()) return;
     const embed = getDefaultEmbed();
     embed.setTitle(`${Emoji.SECURITY_CHALLENGE_FAILED} Blocked word detected`);

src/events/channelUpdate.ts

@@ -3,7 +3,7 @@ import { AuditLogEvent, Events, GuildAuditLogsEntry, PermissionFlagsBits, User }
 import { getGuildSetting } from "../tools/data";
 import { Badword, database } from "../data";
 import { IsNull } from "typeorm";
-import getDefaultEmbed, { getFailedEmbed, getUserReportEmbed } from "../tools/defaultEmbeds";
+import getDefaultEmbed, { getFailedEmbed } from "../tools/defaultEmbeds";
 import { getGuildChannel } from "../tools/discord";
 import { Color, Emoji } from "../tools/design";
 
@@ -89,13 +89,6 @@ client.on(Events.ChannelUpdate, async (oldChannel, newChannel) => {
         return;
     }
 
-    if (responsibleUser) {
-        const embed = getUserReportEmbed(guild.name, newChannel.name);
-        responsibleUser.send({
-            embeds: [embed]
-        }).catch(() => {});
-    }
-
     if (!logChannel || !logChannel.isTextBased()) return;
     const embed = getDefaultEmbed();
     embed.setTitle(`${Emoji.SECURITY_CHALLENGE_FAILED} Blocked word detected`);

src/service/index.ts

@@ -1,3 +1,4 @@
+import "./uptime";
 import runCleanup from "./cleanup";
 
 export {

src/service/uptime.ts

@@ -0,0 +1,19 @@
+import express from "express";
+import pack from "../../package.json";
+import startupTime from "../tools/startupTime";
+
+const app = express();
+
+app.get("/", (_req, res) => {
+    res.status(200).json({
+        running: true,
+        version: pack.version,
+        runningSince: startupTime.toISOString()
+    });
+});
+
+app.all("*", (_req, res) => {
+    res.status(404).end();
+});
+
+app.listen(80);

src/tools/defaultEmbeds.ts

@@ -30,14 +30,3 @@ export function getFailedEmbed(): EmbedBuilder {
     embed.setColor(Color.STOPSIGN_RED);
     return embed;
 }
-
-export function getUserReportEmbed(guildName: string, channelName: string): EmbedBuilder {
-    const embed = getDefaultEmbed();
-    embed.setColor(Color.STOPSIGN_RED);
-    embed.setTitle(`${Emoji.SECURITY_CHALLENGE_FAILED} A channel you modified has been deleted`);
-    embed.setDescription(`Hey there ${Emoji.WAVING}
-Your channel (#${channelName}) on the "${guildName}" server contained a blacklisted word and was deleted automatically.
-Please make sure to keep channel names friendly for everyone!`);
-
-    return embed;
-}