feat: add db migrations with typeORM (#28)

* adding typescript packages for typeORM * add typeORM initial files * updating package scripts * updating compose.yaml to have an exposed port for the postgres * modifying setup for typeORM * update database stuff and and package.json to help generate migrations * made models and migrations in typeORM * delete unneeded database.js * made database pattern ignored by jest * remove sequelize * separate member repo from member helper * not sure why i made everything numbers in the model but it's fixed now * edited package.json script * remove unused index.ts * adjusted files to reference repository correctly and appdatasource * made appdatasource export as named * removed start-db script * added init to appdatasource in bot.js * migrations finally! * new migration matching model names I want * updating tests * removing testpathignore patterns since it seems to be unecessary? * adjusting migrations to match current schema * removed reference to secrets file * delete old migration * Revert "delete old migration" This reverts commit db1efa39a7a80d8976878856250ccaac6a753ab2. * Revert "adjusting migrations to match current schema" This reverts commit ef89a83f6a2ef0643d6ace0a3fcf9c40f4bc6dd6. * just deleted system creation since it's got nothing in it anyway * renamed memberRepository to memberRepo for consistency * added await back to parseMemberCommand call to memberArgumentHandler * changed call to memberHelper.getMembersByAuthor to memberRepo * renamed repo updateMemberValue to updateMemberField * removed throw references in repo docstrings * remove unneeded subscriber directory ref * changed createdAt and updatedAt columns to be auto-generated made member table have timezone * changed casing of isInitialized in mock for bot.js * removed % from ILike query so that it doesn't match substrings/wildcard * renamed some stray updateMemberValue in mocks -> updateMemberField --------- Co-authored-by: Aster Fialla <asterfialla@gmail.com>
2026-03-01 21:25:49 -05:00
parent d14e89e8b2
commit 8fe53563d0
14 changed files with 1831 additions and 637 deletions
--- a/src/bot.js
+++ b/src/bot.js
@@ -5,6 +5,7 @@ const {commands} = require("./commands.js");
 const {webhookHelper} = require("./helpers/webhookHelper.js");
 const env = require('dotenv');
 const {utils} = require("./helpers/utils.js");
+const { AppDataSource } = require("../database/data-source");

 env.config();

@@ -20,7 +21,7 @@ client = new Client({ intents: 0 });
 module.exports.client = client;

 client.on(Events.MessageCreate, async (message) => {
-    await handleMessageCreate(message);
+    await module.exports.handleMessageCreate(message);
 });

 /**
@@ -85,8 +86,10 @@ const debouncePrintGuilds  = utils.debounce(printGuilds, 2000);

 module.exports.login = async function() {
    try {
+        if (!AppDataSource.isInitialized) {
+            await AppDataSource.initialize();
+        }
        await client.login(token);
-        // await db.check_connection();
    } catch (err) {
        console.error('Login failed:', err);
        process.exit(1);
--- a/src/database.js
+++ b/src/database.js
@@ -1,86 +0,0 @@
-const env = require('dotenv')
-const {Sequelize, DataTypes} = require('sequelize');
-
-env.config();
-
-const password = process.env.POSTGRES_PASSWORD;
-
-if (!password) {
-    console.error("Missing POSTGRES_PASSWORD environment variable.");
-    process.exit(1);
-}
-
-const database = {};
-
-const sequelize = new Sequelize('postgres', 'postgres', password, {
-    host: 'localhost',
-    logging: false,
-    dialect: 'postgres'
-});
-
-database.sequelize = sequelize;
-database.Sequelize = Sequelize;
-
-database.members = sequelize.define('Member', {
-    userid: {
-        type: DataTypes.STRING,
-        allowNull: false,
-    },
-    name: {
-        type: DataTypes.STRING,
-        allowNull: false,
-    },
-    displayname: {
-        type: DataTypes.STRING,
-    },
-    propic: {
-        type: DataTypes.STRING,
-    },
-    proxy: {
-        type: DataTypes.STRING,
-    }
-});
-
-database.systems = sequelize.define('System', {
-    userid: {
-        type: DataTypes.STRING,
-    },
-    fronter: {
-        type: DataTypes.STRING
-    },
-    grouptag: {
-        type: DataTypes.STRING
-    },
-    autoproxy: {
-        type: DataTypes.BOOLEAN,
-    }
-})
-
-/**
- * Checks Sequelize database connection.
- */
-database.check_connection = async function () {
-    try {
-        await sequelize.authenticate();
-        console.log('Connection has been established successfully.');
-        await syncModels();
-    } catch (err) {
-        console.error('Unable to connect to the database:', err);
-        process.exit(1);
-    }
-}
-
-/**
- * Syncs Sequelize models.
- */
-async function syncModels() {
-    try {
-        await sequelize.sync()
-        console.log('Models synced successfully.');
-    } catch(err) {
-        console.error('Syncing models did not work', err);
-        process.exit(1);
-    }
-}
-
-module.exports.database = database;
--- a/src/helpers/memberHelper.js
+++ b/src/helpers/memberHelper.js
@@ -1,8 +1,7 @@
-const {database} = require('../database.js');
 const {enums} = require("../enums.js");
-const {Op} = require("sequelize");
 const {EmbedBuilder} = require("@fluxerjs/core");
 const {utils} = require("./utils.js");
+const {memberRepo} = require("../repositories/memberRepo.js");

 const memberHelper = {};

@@ -52,7 +51,7 @@ memberHelper.parseMemberCommand = async function (authorId, authorFull, args, at
        isHelp = true;
    }

-    return await memberHelper.memberArgumentHandler(authorId, authorFull, isHelp, command, memberName, args, attachmentUrl, attachmentExpiration)
+    return await memberHelper.memberArgumentHandler(authorId, authorFull, isHelp, command, memberName, args, attachmentUrl, attachmentExpiration);
 }

 /**
@@ -71,6 +70,7 @@ memberHelper.parseMemberCommand = async function (authorId, authorFull, args, at
 * @returns {Promise <EmbedBuilder>} A list of 25 members as an embed.
 * @returns {Promise <EmbedBuilder>} A list of member commands and descriptions.
 * @returns {Promise<{EmbedBuilder, [string], string}>} A member info embed + info/errors.
+ * @returns {Promise<string>} - A help message
 * @throws {Error} When there's no member or a command is not recognized.
 */
 memberHelper.memberArgumentHandler = async function(authorId, authorFull, isHelp, command = null, memberName = null, args = [], attachmentUrl = null, attachmentExpiration = null) {
@@ -113,7 +113,7 @@ memberHelper.memberArgumentHandler = async function(authorId, authorFull, isHelp
 * @throws {Error} When there's no member
 */
 memberHelper.sendCurrentValue = async function(authorId, memberName, command= null) {
-    const member = await memberHelper.getMemberByName(authorId, memberName);
+    const member = await memberRepo.getMemberByName(authorId, memberName);
    if (!member) throw new Error(enums.err.NO_MEMBER);

    if (!command) {
@@ -167,10 +167,7 @@ memberHelper.sendHelpEnum = function(command) {
 * @param {string[]} values - The values to be passed in. Only includes the values after member name and command name.
 * @param {string | null} attachmentUrl - The attachment URL, if any
 * @param {string | null} attachmentExpiration - The attachment expiry date, if any
- * @returns {Promise<string>} A success message.
- * @returns {Promise <EmbedBuilder>} A list of 25 members as an embed.
- * @returns {Promise <EmbedBuilder>} A list of member commands and descriptions.
- * @returns {Promise<{EmbedBuilder, [string], string}>} A member info embed + info/errors.
+ * @returns {Promise<string> | Promise <EmbedBuilder> | Promise<{EmbedBuilder, [string], string}>}
 */
 memberHelper.memberCommandHandler = async function(authorId, command, memberName, values, attachmentUrl = null, attachmentExpiration = null) {
    switch (command) {
@@ -297,12 +294,7 @@ memberHelper.updatePropic = async function (authorId, memberName, values, attach
 * @throws {Error} When there is no member to remove.
 */
 memberHelper.removeMember = async function (authorId, memberName) {
-    const destroyed = await database.members.destroy({
-        where: {
-            name: {[Op.iLike]: memberName},
-            userid: authorId
-        }
-    })
+    const destroyed = await memberRepo.removeMember(authorId, memberName);
    if (destroyed > 0) {
        return `Member "${memberName}" has been deleted.`;
    } else {
@@ -322,11 +314,11 @@ memberHelper.removeMember = async function (authorId, memberName) {
 * @param {string | null} [proxy] - The proxy tag of the member.
 * @param {string | null} [propic] - The profile picture URL of the member.
 * @param {string | null} [attachmentExpiration] - The expiration date of an uploaded profile picture.
- * @returns {Promise<{model, string[]}>} A successful addition object, including errors if there are any.
+ * @returns {Promise<{Members, string[]}>} A successful addition object, including errors if there are any.
 * @throws {Error}  When the member already exists, there are validation errors, or adding a member doesn't work.
 */
 memberHelper.addFullMember = async function (authorId, memberName, displayName = null, proxy = null, propic = null, attachmentExpiration = null) {
-    const existingMember = await memberHelper.getMemberByName(authorId, memberName);
+    const existingMember = await memberRepo.getMemberByName(authorId, memberName);
    if (existingMember) {
        throw new Error(`Can't add ${memberName}. ${enums.err.MEMBER_EXISTS}`);
    }
@@ -380,7 +372,7 @@ memberHelper.addFullMember = async function (authorId, memberName, displayName =
        }
    }

-    const member = await database.members.create({
+    const member = await memberRepo.createMember({
        name: memberName, userid: authorId, displayname: isValidDisplayName ? displayName : null, proxy: isValidProxy ? proxy : null, propic: isValidPropic ? propic : null
    });

@@ -400,13 +392,8 @@ memberHelper.addFullMember = async function (authorId, memberName, displayName =
 * @throws {Error} When no member row was updated.
 */
 memberHelper.updateMemberField = async function (authorId, memberName, columnName, value, expirationWarning = null) {
-    const res = await database.members.update({[columnName]: value}, {
-        where: {
-            name: {[Op.iLike]: memberName},
-            userid: authorId
-        }
-    })
-    if (res[0] === 0) {
+    const res = await memberRepo.updateMemberField(authorId, memberName, columnName, value);
+    if (res === 0) {
        throw new Error(`Can't update ${memberName}. ${enums.err.NO_MEMBER}.`);
    } else {
        return `Updated ${columnName} for ${memberName} to ${value}${expirationWarning ? `. ${expirationWarning}.` : '.'}`;
@@ -416,7 +403,7 @@ memberHelper.updateMemberField = async function (authorId, memberName, columnNam
 /**
 * Gets the details for a member.
 *
- * @param {model} member - The member object
+ * @param {{Members, string[]}} member - The member object
 * @returns {EmbedBuilder} The member's info.
 */
 memberHelper.getMemberInfo = function (member) {
@@ -441,7 +428,7 @@ memberHelper.getMemberInfo = function (member) {
 * @throws {Error} When there are no members for an author.
 */
 memberHelper.getAllMembersInfo = async function (authorId, authorName) {
-    const members = await memberHelper.getMembersByAuthor(authorId);
+    const members = await memberRepo.getMembersByAuthor(authorId);
    if (members.length === 0) throw Error(enums.err.USER_NO_MEMBERS);
    const fields = [...members.entries()].map(([index, member]) => ({
        name: member.name, value: `(Proxy: \`${member.proxy ?? "unset"}\`)`, inline: true,
@@ -451,29 +438,6 @@ memberHelper.getAllMembersInfo = async function (authorId, authorName) {
        .addFields(...fields);
 }

-/**
- * Gets a member based on the author and proxy tag.
- *
- * @async
- * @param {string} authorId - The author of the message.
- * @param {string} memberName - The member's name.
- * @returns {Promise<model>} The member object.
- */
-memberHelper.getMemberByName = async function (authorId, memberName) {
-    return await database.members.findOne({where: {userid: authorId, name: {[Op.iLike]: memberName}}});
-}
-
-/**
- * Gets all members belonging to the author.
- *
- * @async
- * @param {string} authorId - The author of the message
- * @returns {Promise<model[] | null>} The member object array.
- */
-memberHelper.getMembersByAuthor = async function (authorId) {
-    return await database.members.findAll({where: {userid: authorId}});
-}
-
 /**
 * Checks if proxy exists for a member.
 *
@@ -487,7 +451,7 @@ memberHelper.checkIfProxyExists = async function (authorId, proxy) {
    if (splitProxy.length < 2) throw new Error(enums.err.NO_TEXT_FOR_PROXY);
    if (!splitProxy[0] && !splitProxy[1]) throw new Error(enums.err.NO_PROXY_WRAPPER);

-    const memberList = await memberHelper.getMembersByAuthor(authorId);
+    const memberList = await memberRepo.getMembersByAuthor(authorId);
    const proxyExists = memberList.some(member => member.proxy === proxy);
    if (proxyExists) {
        throw new Error(enums.err.PROXY_EXISTS);
--- a/src/repositories/memberRepo.js
+++ b/src/repositories/memberRepo.js
@@ -0,0 +1,81 @@
+const Member = require("../../database/entity/Member");
+const { AppDataSource } = require("../../database/data-source");
+const {ILike} = require("typeorm");
+const members = AppDataSource.getRepository(Member.Member)
+
+const memberRepo = {};
+/**
+ * Gets a member based on the author and proxy tag.
+ *
+ * @async
+ * @param {string} authorId - The author of the message.
+ * @param {string} memberName - The member's name.
+ * @returns {Promise<Member | null>} The member object or null if not found.
+ */
+memberRepo.getMemberByName = async function (authorId, memberName) {
+    return await members.findOne({where: {userid: authorId, name: ILike(memberName)}});
+}
+
+/**
+ * Gets all members belonging to the author.
+ *
+ * @async
+ * @param {string} authorId - The author of the message
+ * @returns {Promise<Member[]>} The member object array.
+ */
+memberRepo.getMembersByAuthor = async function (authorId) {
+    return await members.findBy({userid: authorId});
+}
+
+/**
+ * Removes a member.
+ *
+ * @async
+ * @param {string} authorId - The author of the message
+ * @param {string} memberName - The name of the member to remove
+ * @returns {Promise<number>} Number of results removed.
+ */
+memberRepo.removeMember = async function (authorId, memberName) {
+    const deleted = await members.delete({
+        where: {
+            name: ILike(memberName),
+            userid: authorId
+        }
+    })
+    return deleted.affected;
+}
+
+/**
+ * Adds a member with full details.
+ *
+ * @async
+ * @param {{name: string, userid: string, displayname: (string|null), proxy: (string|null), propic: (string|null)}} createObj - Object with parameters in it
+ * @returns {Promise<Member>} A successful inserted object.
+ */
+memberRepo.createMember = async function (createObj) {
+    return members.insert({
+        name: createObj.name, userid: createObj.authorId, displayname: createObj.displayName, proxy: createObj.proxy, propic: createObj.propic
+    });
+}
+
+/**
+ * Updates one fields for a member in the database.
+ *
+ * @async
+ * @param {string} authorId - The author of the message
+ * @param {string} memberName - The member to update
+ * @param {string} columnName - The column name to update.
+ * @param {string} value - The value to update to.
+ * @returns {Promise<number>} A successful update.
+ */
+memberRepo.updateMemberField = async function (authorId, memberName, columnName, value) {
+    const updated = await members.update({[columnName]: value}, {
+        where: {
+            name: ILike(memberName),
+            userid: authorId
+        }
+    })
+    return updated.affected;
+}
+
+module.exports.memberRepo = memberRepo;