Switch to TypeORM's DataSource API (#299)

- Switch to TypeORM's DataSource API, rather than using the now deprecated ormconfig.json
- This will fix stage deployment not knowing how to deploy the database migrations

#297

> **NOTE:** This change requires the deployment scripts to be updated, please update them on the server before merging

Co-authored-by: Ethan Lane <ethan@vylpes.com>
Reviewed-on: https://gitea.vylpes.xyz/RabbitLabs/vylbot-app/pulls/299

.dev.env

@@ -15,3 +15,11 @@ BOT_CLIENTID=682942374040961060
 
 ABOUT_FUNDING=https://ko-fi.com/vylpes
 ABOUT_REPO=https://gitea.vylpes.xyz/RabbitLabs/vylbot-app
+
+DB_HOST=127.0.0.1
+DB_PORT=3101
+DB_NAME=vylbot
+DB_AUTH_USER=dev
+DB_AUTH_PASS=dev
+DB_SYNC=true
+DB_LOGGING=true

.prod.env

@@ -14,3 +14,11 @@ BOT_CLIENTID=680083120896081954
 
 ABOUT_FUNDING=https://ko-fi.com/vylpes
 ABOUT_REPO=https://gitea.vylpes.xyz/RabbitLabs/vylbot-app
+
+DB_HOST=127.0.0.1
+DB_PORT=3121
+DB_NAME=vylbot
+DB_AUTH_USER=prod
+DB_AUTH_PASS=prod
+DB_SYNC=false
+DB_LOGGING=false

.stage.env

@@ -14,3 +14,11 @@ BOT_CLIENTID=1016767908740857949
 
 ABOUT_FUNDING=https://ko-fi.com/vylpes
 ABOUT_REPO=https://gitea.vylpes.xyz/RabbitLabs/vylbot-app
+
+DB_HOST=127.0.0.1
+DB_PORT=3111
+DB_NAME=vylbot
+DB_AUTH_USER=stage
+DB_AUTH_PASS=stage
+DB_SYNC=false
+DB_LOGGING=false

ormconfig.dev.json

@@ -1,24 +0,0 @@
-{
-   "type": "mysql",
-   "host": "localhost",
-   "port": 3101,
-   "username": "dev",
-   "password": "dev",
-   "database": "vylbot",
-   "synchronize": false,
-   "logging": false,
-   "entities": [
-      "dist/entity/**/*.js"
-   ],
-   "migrations": [
-      "dist/migration/**/*.js"
-   ],
-   "subscribers": [
-      "dist/subscriber/**/*.js"
-   ],
-   "cli": {
-      "entitiesDir": "dist/entity",
-      "migrationsDir": "dist/migration",
-      "subscribersDir": "dist/subscriber"
-   }
-}

ormconfig.prod.json

@@ -1,24 +0,0 @@
-{
-   "type": "mysql",
-   "host": "localhost",
-   "port": 3121,
-   "username": "prod",
-   "password": "prod",
-   "database": "vylbot",
-   "synchronize": false,
-   "logging": false,
-   "entities": [
-      "dist/entity/**/*.js"
-   ],
-   "migrations": [
-      "dist/migration/**/*.js"
-   ],
-   "subscribers": [
-      "dist/subscriber/**/*.js"
-   ],
-   "cli": {
-      "entitiesDir": "dist/entity",
-      "migrationsDir": "dist/migration",
-      "subscribersDir": "dist/subscriber"
-   }
-}

ormconfig.stage.json

@@ -1,24 +0,0 @@
-{
-   "type": "mysql",
-   "host": "localhost",
-   "port": 3111,
-   "username": "stage",
-   "password": "stage",
-   "database": "vylbot",
-   "synchronize": false,
-   "logging": false,
-   "entities": [
-      "dist/entity/**/*.js"
-   ],
-   "migrations": [
-      "dist/migration/**/*.js"
-   ],
-   "subscribers": [
-      "dist/subscriber/**/*.js"
-   ],
-   "cli": {
-      "entitiesDir": "dist/entity",
-      "migrationsDir": "dist/migration",
-      "subscribersDir": "dist/subscriber"
-   }
-}

package.json

@@ -9,8 +9,8 @@
     "build": "tsc",
     "start": "node ./dist/vylbot",
     "test": "jest",
-    "db:up": "typeorm migration:run",
+    "db:up": "typeorm migration:run -d dist/database/dataSources/appDataSource.js",
-    "db:down": "typeorm migration:revert"
+    "db:down": "typeorm migration:revert -d dist/database/dataSources/appDataSource.js"
   },
   "repository": {
     "type": "git",

scripts/deploy_prod.sh

@@ -13,7 +13,6 @@ cd ~/apps/vylbot/vylbot_prod \
 && (pm2 stop vylbot_prod || true) \
 && (pm2 delete vylbot_prod || true) \
 && cp .prod.env .env \
-&& cp ormconfig.prod.json ormconfig.json \
 && yarn clean \
 && yarn install --frozen-lockfile \
 && yarn build \

scripts/deploy_stage.sh

@@ -13,7 +13,6 @@ cd ~/apps/vylbot/vylbot_stage \
 && (pm2 stop vylbot_stage || true) \
 && (pm2 delete vylbot_stage || true) \
 && cp .stage.env .env \
-&& cp ormconfig.stage.json ormconfig.json \
 && yarn clean \
 && yarn install --frozen-lockfile \
 && yarn build \

src/client/client.ts

@@ -8,6 +8,7 @@ import { Command } from "../type/command";
 
 import { Events } from "./events";
 import { Util } from "./util";
+import AppDataSource from "../database/dataSources/appDataSource";
 
 export class CoreClient extends Client {
     private static _commandItems: ICommandItem[];
@@ -41,10 +42,9 @@ export class CoreClient extends Client {
             return;
         }
 
-        await createConnection().catch(e => {
+        await AppDataSource.initialize()
-            console.error(e);
+            .then(() => console.log("Data Source Initialized"))
-            return;
+            .catch((err) => console.error("Error Initialising Data Source", err));
-        });
 
         super.on("interactionCreate", this._events.onInteractionCreate);
         super.on("ready", this._events.onReady);

src/commands/501231711271780357/Lobby/add.ts

@@ -1,6 +1,6 @@
 import { CommandInteraction, PermissionsBitField, SlashCommandBuilder } from "discord.js";
 import { Command } from "../../../type/command";
-import { default as eLobby } from "../../../entity/501231711271780357/Lobby";
+import { default as eLobby } from "../../../database/entities/501231711271780357/Lobby";
 
 export default class AddRole extends Command {
     constructor() {

src/commands/501231711271780357/Lobby/list.ts

@@ -1,6 +1,6 @@
 import { CacheType, CommandInteraction, EmbedBuilder, GuildBasedChannel, PermissionsBitField, SlashCommandBuilder } from "discord.js";
 import { Command } from "../../../type/command";
-import { default as eLobby } from "../../../entity/501231711271780357/Lobby";
+import { default as eLobby } from "../../../database/entities/501231711271780357/Lobby";
 import EmbedColours from "../../../constants/EmbedColours";
 
 export default class ListLobby extends Command {

src/commands/501231711271780357/Lobby/lobby.ts

@@ -1,6 +1,6 @@
 import { CommandInteraction, SlashCommandBuilder } from "discord.js";
 import { Command } from "../../../type/command";
-import { default as eLobby } from "../../../entity/501231711271780357/Lobby";
+import { default as eLobby } from "../../../database/entities/501231711271780357/Lobby";
 
 export default class Lobby extends Command {
     constructor() {

src/commands/501231711271780357/Lobby/remove.ts

@@ -1,6 +1,6 @@
 import { CommandInteraction, PermissionsBitField, SlashCommandBuilder } from "discord.js";
 import { Command } from "../../../type/command";
-import { default as eLobby } from "../../../entity/501231711271780357/Lobby";
+import { default as eLobby } from "../../../database/entities/501231711271780357/Lobby";
 import BaseEntity from "../../../contracts/BaseEntity";
 
 export default class RemoveLobby extends Command {

src/commands/Role/config.ts

@@ -1,7 +1,7 @@
 import { CommandInteraction, PermissionsBitField, SlashCommandBuilder } from "discord.js";
 import { Command } from "../../type/command";
-import { default as eRole } from "../../entity/Role";
+import { default as eRole } from "../../database/entities/Role";
-import Server from "../../entity/Server";
+import Server from "../../database/entities/Server";
 
 export default class ConfigRole extends Command {
     constructor() {

src/commands/Role/role.ts

@@ -1,6 +1,6 @@
 import { CommandInteraction, EmbedBuilder, GuildMemberRoleManager, SlashCommandBuilder } from "discord.js";
 import { Command } from "../../type/command";
-import { default as eRole } from "../../entity/Role";
+import { default as eRole } from "../../database/entities/Role";
 import EmbedColours from "../../constants/EmbedColours";
 
 export default class Role extends Command {

src/commands/audits.ts

@@ -1,4 +1,4 @@
-import Audit from "../entity/Audit";
+import Audit from "../database/entities/Audit";
 import AuditTools from "../helpers/AuditTools";
 import { Command } from "../type/command";
 import { CommandInteraction, EmbedBuilder, PermissionsBitField, SlashCommandBuilder } from "discord.js";

src/commands/ban.ts

@@ -1,5 +1,5 @@
 import { Command } from "../type/command";
-import Audit from "../entity/Audit";
+import Audit from "../database/entities/Audit";
 import { AuditType } from "../constants/AuditType";
 import { CommandInteraction, EmbedBuilder, GuildMember, PermissionsBitField, SlashCommandBuilder, TextChannel } from "discord.js";
 import EmbedColours from "../constants/EmbedColours";

src/commands/config.ts

@@ -2,8 +2,8 @@ import { CommandInteraction, EmbedBuilder, PermissionsBitField, SlashCommandBuil
 import { readFileSync } from "fs";
 import DefaultValues from "../constants/DefaultValues";
 import EmbedColours from "../constants/EmbedColours";
-import Server from "../entity/Server";
+import Server from "../database/entities/Server";
-import Setting from "../entity/Setting";
+import Setting from "../database/entities/Setting";
 import { Command } from "../type/command";
 
 export default class Config extends Command {

src/commands/ignore.ts

@@ -1,5 +1,5 @@
 import { CommandInteraction, PermissionsBitField, SlashCommandBuilder } from "discord.js";
-import IgnoredChannel from "../entity/IgnoredChannel";
+import IgnoredChannel from "../database/entities/IgnoredChannel";
 import { Command } from "../type/command";
 
 export default class Ignore extends Command {

src/commands/kick.ts

@@ -1,5 +1,5 @@
 import { Command } from "../type/command";
-import Audit from "../entity/Audit";
+import Audit from "../database/entities/Audit";
 import { AuditType } from "../constants/AuditType";
 import { CommandInteraction, EmbedBuilder, GuildMember, PermissionsBitField, SlashCommandBuilder, TextChannel } from "discord.js";
 import EmbedColours from "../constants/EmbedColours";

src/commands/mute.ts

@@ -1,7 +1,7 @@
 import { CommandInteraction, EmbedBuilder, GuildMember, PermissionsBitField, SlashCommandBuilder, TextChannel } from "discord.js";
 import { AuditType } from "../constants/AuditType";
 import EmbedColours from "../constants/EmbedColours";
-import Audit from "../entity/Audit";
+import Audit from "../database/entities/Audit";
 import SettingsHelper from "../helpers/SettingsHelper";
 import { Command } from "../type/command";
 

src/commands/setup.ts

@@ -1,5 +1,5 @@
 import { CommandInteraction, PermissionsBitField, SlashCommandBuilder } from "discord.js";
-import Server from "../entity/Server";
+import Server from "../database/entities/Server";
 import { Command } from "../type/command";
 
 export default class Setup extends Command {

src/commands/warn.ts

@@ -1,7 +1,7 @@
 import { CommandInteraction, EmbedBuilder, GuildMember, PermissionsBitField, SlashCommandBuilder, TextChannel } from "discord.js";
 import { AuditType } from "../constants/AuditType";
 import EmbedColours from "../constants/EmbedColours";
-import Audit from "../entity/Audit";
+import Audit from "../database/entities/Audit";
 import SettingsHelper from "../helpers/SettingsHelper";
 import { Command } from "../type/command";
 

src/contracts/BaseEntity.ts

@@ -1,5 +1,6 @@
-import { Column, DeepPartial, EntityTarget, getConnection, PrimaryColumn, ObjectLiteral, FindOptionsWhere } from "typeorm";
+import { Column, DeepPartial, EntityTarget, PrimaryColumn, ObjectLiteral, FindOptionsWhere } from "typeorm";
 import { v4 } from "uuid";
+import AppDataSource from "../database/dataSources/appDataSource";
 
 export default class BaseEntity {
     constructor() {
@@ -21,25 +22,19 @@ export default class BaseEntity {
     public async Save<T extends BaseEntity>(target: EntityTarget<T>, entity: DeepPartial<T>): Promise<void> {
         this.WhenUpdated = new Date();
 
-        const connection = getConnection();
+        const repository = AppDataSource.getRepository<T>(target);
-
-        const repository = connection.getRepository<T>(target);
 
         await repository.save(entity);
     }
 
     public static async Remove<T extends BaseEntity>(target: EntityTarget<T>, entity: T): Promise<void> {
-        const connection = getConnection();
+        const repository = AppDataSource.getRepository<T>(target);
-
-        const repository = connection.getRepository<T>(target);
 
         await repository.remove(entity);
     }
 
     public static async FetchAll<T extends BaseEntity>(target: EntityTarget<T>, relations?: string[]): Promise<T[]> {
-        const connection = getConnection();
+        const repository = AppDataSource.getRepository<T>(target);
-
-        const repository = connection.getRepository<T>(target);
 
         const all = await repository.find({ relations: relations || [] });
 
@@ -47,9 +42,7 @@ export default class BaseEntity {
     }
 
     public static async FetchOneById<T extends BaseEntity>(target: EntityTarget<T>, id: string, relations?: string[]): Promise<T | null> {
-        const connection = getConnection();
+        const repository = AppDataSource.getRepository<T>(target);
-
-        const repository = connection.getRepository<T>(target);
 
         const single = await repository.findOne({ where: ({ Id: id } as FindOptionsWhere<T>), relations: relations || {} });
 
@@ -57,9 +50,7 @@ export default class BaseEntity {
     }
 
     public static async Any<T extends ObjectLiteral>(target: EntityTarget<T>): Promise<boolean> {
-        const connection = getConnection();
+        const repository = AppDataSource.getRepository<T>(target);
-
-        const repository = connection.getRepository<T>(target);
 
         const any = await repository.find();
 

src/database/dataSources/appDataSource.ts

@@ -0,0 +1,26 @@
+import { DataSource } from "typeorm";
+import * as dotenv from "dotenv";
+
+dotenv.config();
+
+const AppDataSource = new DataSource({
+    type: "mysql",
+    host: process.env.DB_HOST,
+    port: Number(process.env.DB_PORT),
+    username: process.env.DB_AUTH_USER,
+    password: process.env.DB_AUTH_PASS,
+    database: process.env.DB_NAME,
+    synchronize: process.env.DB_SYNC == "true",
+    logging: process.env.DB_LOGGING == "true",
+    entities: [
+        "dist/database/entities/**/*.js",
+    ],
+    migrations: [
+        "dist/database/migrations/**/*.js",
+    ],
+    subscribers: [
+        "dist/database/subscribers/**/*.js",
+    ],
+});
+
+export default AppDataSource;

src/database/entities/501231711271780357/Lobby.ts

@@ -1,5 +1,6 @@
-import { Column, Entity, getConnection } from "typeorm";
+import { Column, Entity } from "typeorm";
-import BaseEntity from "../../contracts/BaseEntity";
+import BaseEntity from "../../../contracts/BaseEntity";
+import AppDataSource from "../../dataSources/appDataSource";
 
 @Entity()
 export default class Lobby extends BaseEntity {
@@ -34,9 +35,7 @@ export default class Lobby extends BaseEntity {
     }
 
     public static async FetchOneByChannelId(channelId: string, relations?: string[]): Promise<Lobby | null> {
-        const connection = getConnection();
+        const repository = AppDataSource.getRepository(Lobby);
-
-        const repository = connection.getRepository(Lobby);
 
         const single = await repository.findOne({ where: { ChannelId: channelId }, relations: relations || [] });
 

src/database/entities/Audit.ts

@@ -1,7 +1,8 @@
-import { Column, Entity, getConnection } from "typeorm";
+import { Column, Entity } from "typeorm";
-import { AuditType } from "../constants/AuditType";
+import { AuditType } from "../../constants/AuditType";
-import BaseEntity from "../contracts/BaseEntity";
+import BaseEntity from "../../contracts/BaseEntity";
-import StringTools from "../helpers/StringTools";
+import StringTools from "../../helpers/StringTools";
+import AppDataSource from "../dataSources/appDataSource";
 
 @Entity()
 export default class Audit extends BaseEntity {
@@ -35,9 +36,7 @@ export default class Audit extends BaseEntity {
     ServerId: string;
 
     public static async FetchAuditsByUserId(userId: string, serverId: string): Promise<Audit[] | null> {
-        const connection = getConnection();
+        const repository = AppDataSource.getRepository(Audit);
-
-        const repository = connection.getRepository(Audit);
 
         const all = await repository.find({ where: { UserId: userId, ServerId: serverId } });
 
@@ -45,9 +44,7 @@ export default class Audit extends BaseEntity {
     }
 
     public static async FetchAuditByAuditId(auditId: string, serverId: string): Promise<Audit | null> {
-        const connection = getConnection();
+        const repository = AppDataSource.getRepository(Audit);
-
-        const repository = connection.getRepository(Audit);
 
         const single = await repository.findOne({ where: { AuditId: auditId, ServerId: serverId } });
 

src/database/entities/IgnoredChannel.ts

@@ -1,5 +1,6 @@
-import { Entity, getConnection } from "typeorm";
+import { Entity } from "typeorm";
-import BaseEntity from "../contracts/BaseEntity";
+import BaseEntity from "../../contracts/BaseEntity";
+import AppDataSource from "../dataSources/appDataSource";
 
 @Entity()
 export default class IgnoredChannel extends BaseEntity {
@@ -10,9 +11,7 @@ export default class IgnoredChannel extends BaseEntity {
     }
 
     public static async IsChannelIgnored(channelId: string): Promise<boolean> {
-        const connection = getConnection();
+        const repository = AppDataSource.getRepository(IgnoredChannel);
-
-        const repository = connection.getRepository(IgnoredChannel);
 
         const single = await repository.findOne({ where: { Id: channelId } });
 

src/database/entities/Role.ts

@@ -1,6 +1,7 @@
-import { Column, Entity, getConnection, ManyToOne } from "typeorm";
+import { Column, Entity, ManyToOne } from "typeorm";
-import BaseEntity from "../contracts/BaseEntity"
+import BaseEntity from "../../contracts/BaseEntity"
 import Server from "./Server";
+import AppDataSource from "../dataSources/appDataSource";
 
 @Entity()
 export default class Role extends BaseEntity {
@@ -21,9 +22,7 @@ export default class Role extends BaseEntity {
     }
 
     public static async FetchOneByRoleId(roleId: string, relations?: string[]): Promise<Role | null> {
-        const connection = getConnection();
+        const repository = AppDataSource.getRepository(Role);
-
-        const repository = connection.getRepository(Role);
 
         const single = await repository.findOne({ where: { RoleId: roleId }, relations: relations || []});
 
@@ -31,9 +30,7 @@ export default class Role extends BaseEntity {
     }
 
     public static async FetchAllByServerId(serverId: string): Promise<Role[]> {
-        const connection = getConnection();
+        const repository = AppDataSource.getRepository(Server);
-
-        const repository = connection.getRepository(Server);
 
         const all = await repository.findOne({ where: { Id: serverId }, relations: [
             "Roles",

src/database/entities/Server.ts

@@ -1,5 +1,5 @@
 import { Entity, OneToMany } from "typeorm";
-import BaseEntity from "../contracts/BaseEntity";
+import BaseEntity from "../../contracts/BaseEntity";
 import Role from "./Role";
 import Setting from "./Setting";
 

src/database/entities/Setting.ts

@@ -1,6 +1,7 @@
-import { Column, Entity, getConnection, ManyToOne } from "typeorm";
+import { Column, Entity, ManyToOne } from "typeorm";
-import BaseEntity from "../contracts/BaseEntity";
+import BaseEntity from "../../contracts/BaseEntity";
 import Server from "./Server";
+import AppDataSource from "../dataSources/appDataSource";
 
 @Entity()
 export default class Setting extends BaseEntity {
@@ -26,9 +27,7 @@ export default class Setting extends BaseEntity {
     }
 
     public static async FetchOneByKey(key: string, relations?: string[]): Promise<Setting | null> {
-        const connection = getConnection();
+        const repository = AppDataSource.getRepository(Setting);
-
-        const repository = connection.getRepository(Setting);
 
         const single = await repository.findOne({ where: { Key: key }, relations: relations || {} });
 

src/database/migrations/3.1/1662399171315-CreateBase.ts

@@ -1,5 +1,5 @@
 import { MigrationInterface, QueryRunner } from "typeorm"
-import MigrationHelper from "../../helpers/MigrationHelper"
+import MigrationHelper from "../../../helpers/MigrationHelper"
 
 export class vylbot1662399171315 implements MigrationInterface {
 

src/events/MessageEvents/MessageDelete.ts

@@ -1,6 +1,6 @@
 import { EmbedBuilder, Message, TextChannel } from "discord.js";
 import EmbedColours from "../../constants/EmbedColours";
-import IgnoredChannel from "../../entity/IgnoredChannel";
+import IgnoredChannel from "../../database/entities/IgnoredChannel";
 import SettingsHelper from "../../helpers/SettingsHelper";
 
 export default async function MessageDelete(message: Message) {

src/events/MessageEvents/MessageUpdate.ts

@@ -1,6 +1,6 @@
 import { EmbedBuilder, Message, TextChannel } from "discord.js";
 import EmbedColours from "../../constants/EmbedColours";
-import IgnoredChannel from "../../entity/IgnoredChannel";
+import IgnoredChannel from "../../database/entities/IgnoredChannel";
 import SettingsHelper from "../../helpers/SettingsHelper";
 
 export default async function MessageUpdate(oldMessage: Message, newMessage: Message) {

src/helpers/SettingsHelper.ts

@@ -1,6 +1,6 @@
 import DefaultValues from "../constants/DefaultValues";
-import Server from "../entity/Server";
+import Server from "../database/entities/Server";
-import Setting from "../entity/Setting";
+import Setting from "../database/entities/Setting";
 
 export default class SettingsHelper {
     public static async GetSetting(key: string, serverId: string): Promise<string | undefined> {

src/vylbot.ts

@@ -11,6 +11,12 @@ const requiredConfigs: string[] = [
     "BOT_AUTHOR",
     "BOT_OWNERID",
     "BOT_CLIENTID",
+    "DB_HOST",
+    "DB_PORT",
+    "DB_AUTH_USER",
+    "DB_AUTH_PASS",
+    "DB_SYNC",
+    "DB_LOGGING",
 ];
 
 requiredConfigs.forEach(config => {