Refactor database stuff

Author: michael-kenzel

src/components/moderation/ban.ts

@@ -126,7 +126,7 @@ export default class Ban extends ModerationComponent {
             return true;
         } catch (e) {
             // fallback to the database
-            const res = await this.wheatley.database.moderations.findOne({
+            const res = await this.database.moderations.findOne({
                 user: moderation.user,
                 type: this.type,
                 active: true,

src/components/massban.ts renamed to src/components/moderation/massban.ts

@@ -1,9 +1,9 @@
 import * as Discord from "discord.js";
 import { strict as assert } from "assert";
-import { M } from "../utils/debugging-and-logging.js";
-import { colors } from "../common.js";
-import { BotComponent } from "../bot-component.js";
-import { Wheatley } from "../wheatley.js";
+import { M } from "../../utils/debugging-and-logging.js";
+import { colors } from "../../common.js";
+import { BotComponent } from "../../bot-component.js";
+import { Wheatley } from "../../wheatley.js";
 
 const snowflake_re = /\b\d{10,}\b/g;
 

src/components/moderation/moderation-common.ts

@@ -20,6 +20,7 @@ import { colors, DAY, HOUR, MINUTE, MONTH, SECOND, WEEK, YEAR } from "../../comm
 import Modlogs from "./modlogs.js";
 import { TextBasedCommand } from "../../command-abstractions/text-based-command.js";
 import {
+    moderation_state,
     moderation_type,
     moderation_entry,
     basic_moderation_with_user,
@@ -161,6 +162,11 @@ export abstract class ModerationComponent extends BotComponent {
         return false;
     }
 
+    database = this.wheatley.database.create_proxy<{
+        component_state: { id: "moderation" } & moderation_state;
+        moderations: moderation_entry;
+    }>();
+
     // Sorted by moderation end time
     sleep_list: SleepList<mongo.WithId<moderation_entry>, mongo.BSON.ObjectId>;
     timer: NodeJS.Timer | null = null;
@@ -196,11 +202,11 @@ export abstract class ModerationComponent extends BotComponent {
         (async () => {
             ModerationComponent.moderations_count
                 .labels({ type: this.type })
-                .set(await this.wheatley.database.moderations.countDocuments({ type: this.type }));
+                .set(await this.database.moderations.countDocuments({ type: this.type }));
             if (!this.is_once_off) {
                 ModerationComponent.active_moderations_count
                     .labels({ type: this.type })
-                    .set(await this.wheatley.database.moderations.countDocuments({ type: this.type, active: true }));
+                    .set(await this.database.moderations.countDocuments({ type: this.type, active: true }));
             }
         })().catch(this.wheatley.critical_error.bind(this.wheatley));
     }
@@ -209,7 +215,7 @@ export abstract class ModerationComponent extends BotComponent {
         this.update_counters();
         // Handle re-applications and sleep lists
         // If once-off active is false so the rest is all fine
-        const moderations = await this.wheatley.database.moderations.find({ type: this.type, active: true }).toArray();
+        const moderations = await this.database.moderations.find({ type: this.type, active: true }).toArray();
         const moderations_to_sleep = moderations.filter(
             entry => entry.duration !== null || entry.removed || entry.expunged,
         );
@@ -260,10 +266,10 @@ export abstract class ModerationComponent extends BotComponent {
         assert(!this.is_once_off);
         // It's possible the moderation could have been removed or been updated by the time this runs, so fetch the
         // current state
-        const entry = unwrap(await this.wheatley.database.moderations.findOne({ _id: entry_from_sleep._id }));
+        const entry = unwrap(await this.database.moderations.findOne({ _id: entry_from_sleep._id }));
         // Check for active but removed (can happen from data import)
         if (entry.active && (entry.removed || entry.expunged)) {
-            await this.wheatley.database.moderations.updateOne(
+            await this.database.moderations.updateOne(
                 { _id: entry._id },
                 {
                     $set: {
@@ -302,7 +308,7 @@ export abstract class ModerationComponent extends BotComponent {
         }
         // Check if moderation is still marked active, if so resolve it
         if (entry.active) {
-            await this.wheatley.database.moderations.updateOne(
+            await this.database.moderations.updateOne(
                 { _id: entry._id },
                 {
                     $set: {
@@ -389,7 +395,7 @@ export abstract class ModerationComponent extends BotComponent {
         if (this.is_once_off) {
             return;
         }
-        const moderations = await this.wheatley.database.moderations
+        const moderations = await this.database.moderations
             .find({ user: member.user.id, type: this.type, active: true })
             .toArray();
         for (const moderation of moderations) {
@@ -403,20 +409,17 @@ export abstract class ModerationComponent extends BotComponent {
     // Moderation entry handling
     //
 
-    async get_case_id() {
-        return (await this.wheatley.database.get_bot_singleton()).moderation_case_number;
-    }
-
     async increment_case_id() {
-        const res = await this.wheatley.database.wheatley.updateOne(
-            { id: "main" },
+        const res = await this.database.component_state.findOneAndUpdate(
+            { id: "moderation" },
             {
                 $inc: {
-                    moderation_case_number: 1,
+                    case_number: 1,
                 },
             },
+            { upsert: true, returnDocument: "after" },
         );
-        assert(res.acknowledged);
+        return unwrap(res).case_number;
     }
 
     static case_id_mutex = new Mutex();
@@ -426,9 +429,8 @@ export abstract class ModerationComponent extends BotComponent {
         try {
             await ModerationComponent.case_id_mutex.lock();
             await this.apply_moderation(moderation);
-            moderation.case_number = await this.get_case_id();
-            const res = await this.wheatley.database.moderations.insertOne(moderation);
-            await this.increment_case_id();
+            moderation.case_number = await this.increment_case_id();
+            const res = await this.database.moderations.insertOne(moderation);
             if (moderation.duration) {
                 this.sleep_list.insert([
                     moderation.issued_at + moderation.duration,
@@ -689,7 +691,7 @@ export abstract class ModerationComponent extends BotComponent {
     ) {
         assert(!this.is_once_off);
         try {
-            const res = await this.wheatley.database.moderations.findOneAndUpdate(
+            const res = await this.database.moderations.findOneAndUpdate(
                 { user: user.id, type: this.type, active: true, ...additional_moderation_properties },
                 {
                     $set: {

src/components/moderation/moderation-control.ts

@@ -7,13 +7,18 @@ import { M } from "../../utils/debugging-and-logging.js";
 import { BotComponent } from "../../bot-component.js";
 import { Wheatley } from "../../wheatley.js";
 import { ModerationComponent, parse_duration } from "./moderation-common.js";
+import { moderation_entry } from "../../infra/schemata/moderation.js";
 import { CommandSetBuilder } from "../../command-abstractions/command-set-builder.js";
 import { colors } from "../../common.js";
 import Modlogs from "./modlogs.js";
 import { EarlyReplyMode, TextBasedCommandBuilder } from "../../command-abstractions/text-based-command-builder.js";
 import { TextBasedCommand } from "../../command-abstractions/text-based-command.js";
 
 export default class ModerationControl extends BotComponent {
+    database = this.wheatley.database.create_proxy<{
+        moderations: moderation_entry;
+    }>();
+
     override async setup(commands: CommandSetBuilder) {
         commands.add(
             new TextBasedCommandBuilder("reason", EarlyReplyMode.visible)
@@ -113,7 +118,7 @@ export default class ModerationControl extends BotComponent {
     }
 
     async reason(command: TextBasedCommand, case_number: number, reason: string) {
-        const res = await this.wheatley.database.moderations.findOneAndUpdate(
+        const res = await this.database.moderations.findOneAndUpdate(
             { case_number },
             {
                 $set: {
@@ -149,7 +154,7 @@ export default class ModerationControl extends BotComponent {
     }
 
     async context_add(command: TextBasedCommand, case_number: number, context: string) {
-        const res = await this.wheatley.database.moderations.findOneAndUpdate(
+        const res = await this.database.moderations.findOneAndUpdate(
             { case_number },
             {
                 $push: {
@@ -175,7 +180,7 @@ export default class ModerationControl extends BotComponent {
     }
 
     async duration(command: TextBasedCommand, case_number: number, duration: string) {
-        const item = await this.wheatley.database.moderations.findOne({ case_number });
+        const item = await this.database.moderations.findOne({ case_number });
         if (!item) {
             await this.reply_with_error(command, `Case ${case_number} not found`);
             return;
@@ -184,7 +189,7 @@ export default class ModerationControl extends BotComponent {
             await this.reply_with_error(command, `Case ${case_number} can't take a duration`);
             return;
         }
-        const res = await this.wheatley.database.moderations.findOneAndUpdate(
+        const res = await this.database.moderations.findOneAndUpdate(
             { case_number },
             {
                 $set: {
@@ -222,7 +227,7 @@ export default class ModerationControl extends BotComponent {
     }
 
     async expunge(command: TextBasedCommand, case_number: number, reason: string | null) {
-        const res = await this.wheatley.database.moderations.findOneAndUpdate(
+        const res = await this.database.moderations.findOneAndUpdate(
             { case_number },
             {
                 $set: {

src/components/moderation/modlogs.ts

@@ -19,6 +19,10 @@ import { discord_timestamp } from "../../utils/discord.js";
 const moderations_per_page = 5;
 
 export default class Modlogs extends BotComponent {
+    database = this.wheatley.database.create_proxy<{
+        moderations: moderation_entry;
+    }>();
+
     override async setup(commands: CommandSetBuilder) {
         commands.add(
             new TextBasedCommandBuilder("modlogs", EarlyReplyMode.visible)
@@ -141,7 +145,7 @@ export default class Modlogs extends BotComponent {
         if (!show_private_logs) {
             query.type = { $ne: "note" };
         }
-        const moderations = await this.wheatley.database.moderations.find(query).sort({ issued_at: -1 }).toArray();
+        const moderations = await this.database.moderations.find(query).sort({ issued_at: -1 }).toArray();
         const pages = Math.ceil(moderations.length / moderations_per_page);
         const buttons: Discord.ButtonBuilder[] = [];
         if (pages <= 1) {
@@ -228,7 +232,7 @@ export default class Modlogs extends BotComponent {
     }
 
     async case_info(command: TextBasedCommand, case_number: number) {
-        const moderation = await this.wheatley.database.moderations.findOne({ case_number });
+        const moderation = await this.database.moderations.findOne({ case_number });
         if (moderation) {
             await command.reply({
                 embeds: [

src/components/modmail.ts renamed to src/components/moderation/modmail.ts

@@ -1,14 +1,15 @@
 import { strict as assert } from "assert";
 import * as Discord from "discord.js";
 
-import { get_url_for } from "../utils/discord.js";
-import { M } from "../utils/debugging-and-logging.js";
-import { colors, HOUR, MINUTE } from "../common.js";
-import { BotComponent } from "../bot-component.js";
-import { Wheatley } from "../wheatley.js";
-import { SelfClearingMap } from "../utils/containers.js";
-import { unwrap } from "../utils/misc.js";
-import { set_timeout } from "../utils/node.js";
+import { get_url_for } from "../../utils/discord.js";
+import { M } from "../../utils/debugging-and-logging.js";
+import { colors, HOUR, MINUTE } from "../../common.js";
+import { BotComponent } from "../../bot-component.js";
+import { Wheatley } from "../../wheatley.js";
+import { moderation_state } from "../../infra/schemata/moderation.js";
+import { SelfClearingMap } from "../../utils/containers.js";
+import { unwrap } from "../../utils/misc.js";
+import { set_timeout } from "../../utils/node.js";
 
 /*
  * Flow:
@@ -32,13 +33,24 @@ function create_embed(title: string, msg: string) {
 export default class Modmail extends BotComponent {
     // Spam prevention, user is added to the timeout set when clicking the modmail_continue button,
     readonly timeout_set = new Set<string>();
-    modmail_id_counter = -1;
 
     readonly monke_set = new SelfClearingMap<Discord.Snowflake, number>(HOUR, HOUR);
 
-    override async on_ready() {
-        const singleton = await this.wheatley.database.get_bot_singleton();
-        this.modmail_id_counter = singleton.modmail_id_counter;
+    database = this.wheatley.database.create_proxy<{
+        component_state: { id: "moderation" } & moderation_state;
+    }>();
+
+    async increment_modmail_id() {
+        const res = await this.database.component_state.findOneAndUpdate(
+            { id: "moderation" },
+            {
+                $inc: {
+                    modmail_id: 1,
+                },
+            },
+            { upsert: true, returnDocument: "after" },
+        );
+        return unwrap(res).modmail_id;
     }
 
     async create_modmail_thread(interaction: Discord.ModalSubmitInteraction | Discord.ButtonInteraction) {
@@ -48,8 +60,7 @@ export default class Modmail extends BotComponent {
                 assert(interaction.member);
                 const member = await this.wheatley.TCCPP.members.fetch(interaction.member.user.id);
                 // make the thread
-                const id = this.modmail_id_counter++;
-                await this.wheatley.database.update_bot_singleton({ modmail_id_counter: this.modmail_id_counter });
+                const id = await this.increment_modmail_id();
                 const thread = await this.wheatley.channels.rules.threads.create({
                     type: Discord.ChannelType.PrivateThread,
                     invitable: false,

src/components/modstats.ts renamed to src/components/moderation/modstats.ts

@@ -1,17 +1,22 @@
 import * as Discord from "discord.js";
 import { strict as assert } from "assert";
 
-import { BotComponent } from "../bot-component.js";
-import { CommandSetBuilder } from "../command-abstractions/command-set-builder.js";
-import { EarlyReplyMode, TextBasedCommandBuilder } from "../command-abstractions/text-based-command-builder.js";
-import { TextBasedCommand } from "../command-abstractions/text-based-command.js";
+import { BotComponent } from "../../bot-component.js";
+import { CommandSetBuilder } from "../../command-abstractions/command-set-builder.js";
+import { EarlyReplyMode, TextBasedCommandBuilder } from "../../command-abstractions/text-based-command-builder.js";
+import { TextBasedCommand } from "../../command-abstractions/text-based-command.js";
 
-import { Wheatley } from "../wheatley.js";
-import { colors, DAY } from "../common.js";
-import { unwrap } from "../utils/misc.js";
-import { capitalize } from "../utils/strings.js";
+import { Wheatley } from "../../wheatley.js";
+import { moderation_entry } from "../../infra/schemata/moderation.js";
+import { colors, DAY } from "../../common.js";
+import { unwrap } from "../../utils/misc.js";
+import { capitalize } from "../../utils/strings.js";
 
 export default class ModStats extends BotComponent {
+    database = this.wheatley.database.create_proxy<{
+        moderations: moderation_entry;
+    }>();
+
     override async setup(commands: CommandSetBuilder) {
         commands.add(
             new TextBasedCommandBuilder("modstats", EarlyReplyMode.none)
@@ -27,7 +32,7 @@ export default class ModStats extends BotComponent {
     }
 
     async get_stats(moderator: Discord.User | null, cutoff = 0) {
-        const res = await this.wheatley.database.moderations
+        const res = await this.database.moderations
             .aggregate([
                 {
                     $match: moderator

src/components/moderation/mute.ts

@@ -98,7 +98,7 @@ export default class Mute extends ModerationComponent {
             return member.roles.cache.filter(role => role.id == this.wheatley.roles.muted.id).size > 0;
         } else {
             // if the member isn't in the guild then lookup
-            const res = await this.wheatley.database.moderations.findOne({
+            const res = await this.database.moderations.findOne({
                 user: moderation.user,
                 type: this.type,
                 active: true,

src/components/notify-about-brand-new-users.ts renamed to src/components/moderation/notify-about-brand-new-users.ts

@@ -1,10 +1,10 @@
 import * as Discord from "discord.js";
 import { strict as assert } from "assert";
-import { time_to_human } from "../utils/strings.js";
-import { colors, MINUTE } from "../common.js";
-import { BotComponent } from "../bot-component.js";
-import { Wheatley } from "../wheatley.js";
-import { discord_timestamp } from "../utils/discord.js";
+import { time_to_human } from "../../utils/strings.js";
+import { colors, MINUTE } from "../../common.js";
+import { BotComponent } from "../../bot-component.js";
+import { Wheatley } from "../../wheatley.js";
+import { discord_timestamp } from "../../utils/discord.js";
 
 const NEW_USER_THRESHOLD = MINUTE * 30;
 

src/components/notify-about-formerly-banned-users.ts renamed to src/components/moderation/notify-about-formerly-banned-users.ts

@@ -1,13 +1,17 @@
 import * as Discord from "discord.js";
 import { strict as assert } from "assert";
-import { build_description, time_to_human } from "../utils/strings.js";
-import { colors, MINUTE } from "../common.js";
-import { BotComponent } from "../bot-component.js";
-import { Wheatley } from "../wheatley.js";
-import { discord_timestamp } from "../utils/discord.js";
-import { moderation_entry } from "../infra/schemata/moderation.js";
+import { build_description, time_to_human } from "../../utils/strings.js";
+import { colors, MINUTE } from "../../common.js";
+import { BotComponent } from "../../bot-component.js";
+import { Wheatley } from "../../wheatley.js";
+import { discord_timestamp } from "../../utils/discord.js";
+import { moderation_entry } from "../../infra/schemata/moderation.js";
 
 export default class NotifyAboutFormerlyBannedUsers extends BotComponent {
+    database = this.wheatley.database.create_proxy<{
+        moderations: moderation_entry;
+    }>();
+
     async alert(member: Discord.GuildMember, most_recent: moderation_entry) {
         const action = most_recent.type == "kick" ? "kicked" : "banned";
         const embed = new Discord.EmbedBuilder()
@@ -30,7 +34,7 @@ export default class NotifyAboutFormerlyBannedUsers extends BotComponent {
     }
 
     async find_most_recent_kick_or_ban(member: Discord.GuildMember) {
-        return await this.wheatley.database.moderations.findOne(
+        return await this.database.moderations.findOne(
             {
                 user: member.id,
                 $or: [{ type: "ban" }, { type: "softban" }, { type: "kick" }],