feat(database): Added migration service, updated Client class to apply migrations and set up initial tables, modified database schema to add created_at and updated_at columns to User and Group tables, removed ApprovedUser and Blacklist tables, and updated seed data to match new schema

Author: m-mdy-m

src/database/Client.ts

@@ -1,18 +1,27 @@
 import { ConnectionPool } from './ConnectionPool';
-import { TablesService } from './service/tables/Tables';
+import { MigrationService } from './service/Migration';
+import { TablesService } from './service/Tables';
 export class Client {
   private _connectionPool: ConnectionPool;
   constructor() {
     this._connectionPool = new ConnectionPool();
   }
   async initialize() {
     await this._connectionPool.connect();
+    const migrationService = new MigrationService(this._connectionPool);
+
+    console.log('Applying migrations...');
+    await migrationService.applyMigrations(); // Apply pending migrations
+    console.log('Migrations applied successfully.');
+
     const tablesService = new TablesService(this._connectionPool);
-    console.log('connect database');
+    console.log('Setting up initial tables...');
     await tablesService.initialTables();
-    console.log('Initial Tables');
+    console.log('Initial Tables Setup Completed.');
+
+    console.log('Seeding tables...');
     await tablesService.seedTables();
-    console.log('Initial Seed Tables');
+    console.log('Tables seeded successfully.');
   }
   getConnectionPool(): ConnectionPool {
     return this._connectionPool;

src/database/ConnectionPool.ts

@@ -1,6 +1,6 @@
 import { Pool, PoolClient } from 'pg';
 import Config from '../config';
-import { Catch } from '../decorators/ErrorHandlingDecorator';
+import { Catch } from '../decorators/Catch';
 export class ConnectionPool {
   private _pool: Pool;
   constructor() {

src/database/service/Migration.ts

@@ -0,0 +1,52 @@
+import * as path from 'path';
+import * as fs from 'fs/promises';
+import { ConnectionPool } from '../ConnectionPool';
+export class MigrationService {
+  private migrationDir: string;
+
+  constructor(private _connectionPool: ConnectionPool) {
+    this.migrationDir = path.join(__dirname, '..', 'migrations');
+  }
+
+  // Check if the migration has been applied by its name
+  async isMigrationApplied(migrationName: string): Promise<boolean> {
+    const client = await this._connectionPool.getClient();
+    const query = 'SELECT COUNT(*) FROM "Migration" WHERE name = $1';
+    const result = await client.query(query, [migrationName]);
+    return parseInt(result.rows[0].count, 10) > 0;
+  }
+
+  // Mark the migration as applied
+  async markMigrationAsApplied(migrationName: string): Promise<void> {
+    const client = await this._connectionPool.getClient();
+    const query = 'INSERT INTO "Migration" (name) VALUES ($1)';
+    await client.query(query, [migrationName]);
+  }
+
+  // Apply the migration files in sequence
+  async applyMigrations() {
+    const migrationFiles = await fs.readdir(this.migrationDir);
+    // Sort files by filename to apply them in order (e.g., 001, 002, etc.)
+    const sortedMigrationFiles = migrationFiles.sort();
+
+    for (const migrationFile of sortedMigrationFiles) {
+      const migrationName = migrationFile.split('.')[0];
+
+      // Check if the migration has already been applied
+      const isApplied = await this.isMigrationApplied(migrationName);
+      if (!isApplied) {
+        const filePath = path.join(this.migrationDir, migrationFile);
+        const migrationSQL = await fs.readFile(filePath, 'utf-8');
+
+        const client = await this._connectionPool.getClient();
+        await client.query(migrationSQL);
+
+        // Mark the migration as applied
+        await this.markMigrationAsApplied(migrationName);
+        console.log(`Migration ${migrationName} applied successfully.`);
+      } else {
+        console.log(`Migration ${migrationName} has already been applied.`);
+      }
+    }
+  }
+}

src/database/sql/Tables.sql

@@ -6,22 +6,24 @@ CREATE TABLE IF NOT EXISTS "User" (
     first_name TEXT,
     role TEXT CHECK (role IN ('admin','owner', 'user', 'approved_user')),  -- User roles for managing permissions
     warnings INT DEFAULT 0,                   -- Number of warnings the user has received
-    approved_groups BIGINT[]                  -- Array of approved group IDs for the user
+    approved_groups BIGINT[],                  -- Array of approved group IDs for the user
+    created_at TIMESTAMP DEFAULT NOW(),
+    updated_at TIMESTAMP DEFAULT NOW()
 );
 
 -- Group table: Stores information about groups managed by the bot
 CREATE TABLE IF NOT EXISTS "Group" (
     id SERIAL PRIMARY KEY,
     group_id BIGINT UNIQUE NOT NULL,          -- Telegram group ID
     group_name TEXT,
-    rules TEXT[],                             -- Array of rules for the group
     black_list TEXT[],                        -- Array of blacklisted words or users
     chat_permissions JSONB,                   -- JSON to store permissions
     updated_at TIMESTAMP DEFAULT NOW(),
     joined_at TIMESTAMP DEFAULT NOW(),
     approved_users BIGINT[],                  -- Array of approved user IDs
     warnings BIGINT[],                   -- Number of warnings in the group
     is_spam_time BOOLEAN DEFAULT FALSE,       -- Flag for spam detection
+    welcome_message TEXT,
     members BIGINT[]
 );
 
@@ -34,15 +36,6 @@ CREATE TABLE IF NOT EXISTS "Warning" (
     reason TEXT
 );
 
--- ApprovedUser table: Tracks users approved in specific groups
-CREATE TABLE IF NOT EXISTS "ApprovedUser" (
-    id SERIAL PRIMARY KEY,
-    user_id BIGINT REFERENCES "User"(id),       -- User who was approved
-    group_id BIGINT REFERENCES "Group"(id),     -- Group where the user was approved
-    username TEXT,
-    approved_at TIMESTAMP DEFAULT NOW()
-);
-
 -- Channel table: Stores channel details managed by the bot
 CREATE TABLE IF NOT EXISTS  "Channel" (
     id SERIAL PRIMARY KEY,
@@ -51,28 +44,17 @@ CREATE TABLE IF NOT EXISTS  "Channel" (
     admins BIGINT[]                           -- Array of admin user IDs for the channel
 );
 
--- Blacklist table: Stores blacklisted words and users for each group
-CREATE TABLE IF NOT EXISTS "Blacklist" (
-    id SERIAL PRIMARY KEY,
-    group_id BIGINT REFERENCES "Group"(id),
-    blacklisted_word TEXT,                      -- Word to be blacklisted
-    blacklisted_user_id BIGINT REFERENCES "User"(id)   -- User to be blacklisted
-);
-
 -- GroupRule table: Stores individual rules for each group
 CREATE TABLE IF NOT EXISTS "GroupRule" (
     id SERIAL PRIMARY KEY,
     group_id BIGINT REFERENCES "Group"(id),
-    rule_text TEXT,                             -- Text of the rule
+    rule_text TEXT[],                             -- Text of the rule
     added_at TIMESTAMP DEFAULT NOW(),
     added_by BIGINT REFERENCES "User"(id)
 );
-
--- GroupMessageSettings table: Stores group message settings (e.g., slow mode)
-CREATE TABLE IF NOT EXISTS "GroupMessageSettings" (
-    id SERIAL PRIMARY KEY,
-    group_id BIGINT REFERENCES "Group"(id),
-    is_locked BOOLEAN DEFAULT FALSE,
-    welcome_message TEXT,
-    last_updated TIMESTAMP DEFAULT NOW()
-);
+-- migration table schema
+CREATE TABLE IF NOT EXISTS "Migration" (
+  id SERIAL PRIMARY KEY,
+  name TEXT UNIQUE NOT NULL,
+  applied_at TIMESTAMP DEFAULT NOW()
+);

src/database/sql/seed/SeedDataTables.sql

@@ -1,43 +1,27 @@
 -- Seeding the User table
-INSERT INTO "User" (telegram_id, username, first_name,role, warnings, approved_groups)
+INSERT INTO "User" (telegram_id, username, first_name,role, warnings, approved_groups,created_at,updated_at)
 VALUES
-  (111222333, 'user1','fuser1' ,'admin', 0, ARRAY[123456789, 987654321]),
-  (444555666, 'user2', 'fuser2','owner', 2, ARRAY[987654321]),
-  (777888999, 'user3','fuser3' ,'user', 0, ARRAY[123456789]),
-  (333444555, 'user4', 'fuser4','user', 1, ARRAY[123456789, 987654321]);
+  (111222333, 'user1','fuser1' ,'admin', 0, ARRAY[123456789, 987654321],NOW(),NOW()),
+  (444555666, 'user2', 'fuser2','owner', 2, ARRAY[987654321],NOW(),NOW()),
+  (777888999, 'user3','fuser3' ,'user', 0, ARRAY[123456789],NOW(),NOW()),
+  (333444555, 'user4', 'fuser4','user', 1, ARRAY[123456789, 987654321],NOW(),NOW());
 -- Seeding the Group table
-INSERT INTO "Group" (group_id, group_name, rules, black_list, chat_permissions, updated_at, joined_at, approved_users, warnings, is_spam_time,members)
+INSERT INTO "Group" (group_id, group_name, black_list, chat_permissions, updated_at, joined_at, approved_users, warnings, is_spam_time,welcome_message,members)
 VALUES
-  (123456789, 'Test Group 1', ARRAY['Rule 1', 'Rule 2'], ARRAY['BadWord1', 'BadWord2'], '{"can_post": true, "can_message": true}', NOW(), NOW(), ARRAY[1, 2], ARRAY[0], FALSE,ARRAY[0,2]),
-  (987654321, 'Test Group 2', ARRAY['Rule A', 'Rule B'], ARRAY['OffensiveUser1'], '{"can_post": false, "can_message": false}', NOW(), NOW(), ARRAY[3, 4], ARRAY[1], TRUE,ARRAY[3,4]);
+  (123456789, 'Test Group 1', ARRAY['BadWord1', 'BadWord2'], '{"can_post": true, "can_message": true}', NOW(), NOW(), ARRAY[1, 2], ARRAY[0], FALSE,'welcome message',ARRAY[0,2]),
+  (987654321, 'Test Group 2', ARRAY['OffensiveUser1'], '{"can_post": false, "can_message": false}', NOW(), NOW(), ARRAY[3, 4], ARRAY[1], TRUE,'welcome message2',ARRAY[3,4]);
 -- Seeding the Warning table after Group data has been inserted
 INSERT INTO "Warning" (user_id, group_id, warned_at, reason)
 VALUES
   (1, 1, NOW(), 'Spamming'),
   (2, 2, NOW(), 'Offensive behavior');
--- Seeding the ApprovedUser table
-INSERT INTO "ApprovedUser" (user_id, group_id, username)
-VALUES
-  (1, 1, 'user1'),
-  (2, 2, 'user2');
-
 -- Seeding the Channel table
 INSERT INTO "Channel" (name, channel_id, admins)
 VALUES
   ('Test Channel 1', 100010001, ARRAY[1, 2]),
   ('Test Channel 2', 200020002, ARRAY[3, 4]);
--- Seeding the Blacklist table
-INSERT INTO "Blacklist" (group_id, blacklisted_word, blacklisted_user_id)
-VALUES
-  (1, 'BadWord1', NULL),
-  (2, 'OffensiveUser1', 4);
 -- Seeding the GroupRule table
 INSERT INTO "GroupRule" (group_id, rule_text, added_by)
 VALUES
-  (1, 'No spamming allowed', 1),
-  (2, 'Be respectful to others', 2);
--- Seeding the GroupMessageSettings table
-INSERT INTO "GroupMessageSettings" (group_id, is_locked, welcome_message)
-VALUES
-  (1, FALSE,  'Welcome to the group!'),
-  (2, TRUE, 'Group is locked, no messages allowed');
+  (1, ARRAY['No spamming allowed'], 1),
+  (2, ARRAY['Be respectful to others'], 2);