feat: Add Database Backup Management (#419)

.env.example

@@ -14,6 +14,10 @@ JWT_REFRESH_EXPIRES_IN=7d
 BCRYPT_ROUNDS=12
 PASSWORD_HISTORY_LIMIT=5
 
+# Database Backup Management
+BACKUP_STORAGE_PATH=./backups
+PG_DUMP_PATH=pg_dump
+PSQL_PATH=psql
 # Google OAuth2
 GOOGLE_CLIENT_ID=your-google-client-id
 GOOGLE_CLIENT_SECRET=your-google-client-secret

prisma/migrations/20260425093000_add_database_backup_management/migration.sql

@@ -0,0 +1,53 @@
+CREATE TYPE "BackupStatus" AS ENUM ('PENDING', 'RUNNING', 'COMPLETED', 'FAILED');
+CREATE TYPE "BackupTrigger" AS ENUM ('MANUAL', 'SCHEDULED');
+CREATE TYPE "RestoreStatus" AS ENUM ('IDLE', 'RUNNING', 'COMPLETED', 'FAILED');
+
+CREATE TABLE "database_backups" (
+  "id" TEXT NOT NULL,
+  "filename" TEXT NOT NULL,
+  "file_path" TEXT NOT NULL,
+  "status" "BackupStatus" NOT NULL DEFAULT 'PENDING',
+  "trigger" "BackupTrigger" NOT NULL,
+  "size_bytes" BIGINT,
+  "checksum" TEXT,
+  "started_at" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+  "completed_at" TIMESTAMP(3),
+  "error_message" TEXT,
+  "initiated_by_id" TEXT,
+  "restore_status" "RestoreStatus" NOT NULL DEFAULT 'IDLE',
+  "restored_at" TIMESTAMP(3),
+  "restore_error" TEXT,
+  "restored_by_id" TEXT,
+  "created_at" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+  "updated_at" TIMESTAMP(3) NOT NULL,
+
+  CONSTRAINT "database_backups_pkey" PRIMARY KEY ("id")
+);
+
+CREATE TABLE "backup_schedule_configs" (
+  "id" TEXT NOT NULL,
+  "enabled" BOOLEAN NOT NULL DEFAULT false,
+  "cron_expression" TEXT NOT NULL,
+  "retention_count" INTEGER NOT NULL DEFAULT 10,
+  "last_run_at" TIMESTAMP(3),
+  "created_at" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+  "updated_at" TIMESTAMP(3) NOT NULL,
+
+  CONSTRAINT "backup_schedule_configs_pkey" PRIMARY KEY ("id")
+);
+
+CREATE UNIQUE INDEX "database_backups_filename_key" ON "database_backups"("filename");
+CREATE INDEX "database_backups_status_started_at_idx" ON "database_backups"("status", "started_at");
+CREATE INDEX "database_backups_restore_status_restored_at_idx" ON "database_backups"("restore_status", "restored_at");
+CREATE INDEX "database_backups_trigger_created_at_idx" ON "database_backups"("trigger", "created_at");
+
+ALTER TABLE "database_backups"
+ADD CONSTRAINT "database_backups_initiated_by_id_fkey"
+FOREIGN KEY ("initiated_by_id") REFERENCES "users"("id") ON DELETE SET NULL ON UPDATE CASCADE;
+
+ALTER TABLE "database_backups"
+ADD CONSTRAINT "database_backups_restored_by_id_fkey"
+FOREIGN KEY ("restored_by_id") REFERENCES "users"("id") ON DELETE SET NULL ON UPDATE CASCADE;
+
+INSERT INTO "backup_schedule_configs" ("id", "enabled", "cron_expression", "retention_count", "created_at", "updated_at")
+VALUES ('default', false, '0 2 * * *', 10, CURRENT_TIMESTAMP, CURRENT_TIMESTAMP);

prisma/schema.prisma

@@ -91,6 +91,25 @@ enum FraudPattern {
   HIGH_VALUE_NEW_ACCOUNT_LISTING
 }
 
+enum BackupStatus {
+  PENDING
+  RUNNING
+  COMPLETED
+  FAILED
+}
+
+enum BackupTrigger {
+  MANUAL
+  SCHEDULED
+}
+
+enum RestoreStatus {
+  IDLE
+  RUNNING
+  COMPLETED
+  FAILED
+}
+
 enum NotificationStatus {
   PENDING
   DELIVERED
@@ -166,6 +185,8 @@ model User {
   savedFilters            SavedFilter[]
   searchAnalytics         SearchAnalytics[]
   searchHistory           SearchHistory[]
+  initiatedBackups        DatabaseBackup[]         @relation("BackupInitiatedBy")
+  restoredBackups         DatabaseBackup[]         @relation("BackupRestoredBy")
   emailStatus             EmailStatus              @default(ACTIVE) @map("email_status")
   notifications           Notification[]
   linkClicks              LinkClick[]
@@ -181,6 +202,46 @@ model User {
   @@map("users")
 }
 
+model DatabaseBackup {
+  id                 String        @id @default(uuid())
+  filename           String        @unique
+  filePath           String        @map("file_path")
+  status             BackupStatus  @default(PENDING)
+  trigger            BackupTrigger
+  sizeBytes          BigInt?       @map("size_bytes")
+  checksum           String?
+  startedAt          DateTime      @default(now()) @map("started_at")
+  completedAt        DateTime?     @map("completed_at")
+  errorMessage       String?       @map("error_message") @db.Text
+  initiatedById      String?       @map("initiated_by_id")
+  restoreStatus      RestoreStatus @default(IDLE) @map("restore_status")
+  restoredAt         DateTime?     @map("restored_at")
+  restoreError       String?       @map("restore_error") @db.Text
+  restoredById       String?       @map("restored_by_id")
+  createdAt          DateTime      @default(now()) @map("created_at")
+  updatedAt          DateTime      @updatedAt @map("updated_at")
+
+  initiatedBy User? @relation("BackupInitiatedBy", fields: [initiatedById], references: [id], onDelete: SetNull)
+  restoredBy  User? @relation("BackupRestoredBy", fields: [restoredById], references: [id], onDelete: SetNull)
+
+  @@index([status, startedAt])
+  @@index([restoreStatus, restoredAt])
+  @@index([trigger, createdAt])
+  @@map("database_backups")
+}
+
+model BackupScheduleConfig {
+  id             String   @id
+  enabled        Boolean  @default(false)
+  cronExpression String   @map("cron_expression")
+  retentionCount Int      @default(10) @map("retention_count")
+  lastRunAt      DateTime? @map("last_run_at")
+  createdAt      DateTime @default(now()) @map("created_at")
+  updatedAt      DateTime @updatedAt @map("updated_at")
+
+  @@map("backup_schedule_configs")
+}
+
 model ApiKey {
   id          String    @id @default(uuid())
   userId      String    @map("user_id")

src/admin/admin.controller.ts

@@ -1,4 +1,5 @@
-import { Body, Controller, Get, Param, Patch, Post, Query, UseGuards } from '@nestjs/common';
+import { Body, Controller, Get, Param, Patch, Post, Put, Query, Res, UseGuards } from '@nestjs/common';
+import { Response } from 'express';
 import { CurrentUser } from '../auth/decorators/current-user.decorator';
 import { Roles } from '../auth/decorators/roles.decorator';
 import { JwtAuthGuard } from '../auth/guards/jwt-auth.guard';
@@ -18,6 +19,7 @@ import {
   ReviewFraudAlertDto,
   TransactionMonitoringQueryDto,
 } from './dto/admin.dto';
+import { RestoreBackupDto, UpdateBackupScheduleDto } from '../backup/dto/backup.dto';
 
 @Controller('admin')
 @UseGuards(JwtAuthGuard, RolesGuard)
@@ -30,6 +32,46 @@ export class AdminController {
     return this.adminService.getDashboard();
   }
 
+  @Get('backups')
+  listBackups() {
+    return this.adminService.listBackups();
+  }
+
+  @Get('backups/status')
+  getBackupStatus() {
+    return this.adminService.getBackupStatus();
+  }
+
+  @Get('backups/schedule')
+  getBackupSchedule() {
+    return this.adminService.getBackupSchedule();
+  }
+
+  @Put('backups/schedule')
+  updateBackupSchedule(@Body() payload: UpdateBackupScheduleDto) {
+    return this.adminService.updateBackupSchedule(payload);
+  }
+
+  @Post('backups/run')
+  runBackup(@CurrentUser() user: AuthUserPayload) {
+    return this.adminService.runBackup(user.sub);
+  }
+
+  @Post('backups/:id/restore')
+  restoreBackup(
+    @Param('id') backupId: string,
+    @Body() _payload: RestoreBackupDto,
+    @CurrentUser() user: AuthUserPayload,
+  ) {
+    return this.adminService.restoreBackup(backupId, user.sub);
+  }
+
+  @Get('backups/:id/download')
+  async downloadBackup(@Param('id') backupId: string, @Res() res: Response) {
+    const file = await this.adminService.getBackupDownload(backupId);
+    return res.download(file.filePath, file.filename);
+  }
+
   @Get('users')
   listUsers(@Query() query: AdminUsersQueryDto) {
     return this.adminService.listUsers(query);

src/admin/admin.module.ts

@@ -3,9 +3,10 @@ import { AdminController } from './admin.controller';
 import { AdminService } from './admin.service';
 import { PrismaModule } from '../database/prisma.module';
 import { FraudModule } from '../fraud/fraud.module';
+import { BackupModule } from '../backup/backup.module';
 
 @Module({
-  imports: [PrismaModule, FraudModule],
+  imports: [PrismaModule, FraudModule, BackupModule],
   controllers: [AdminController],
   providers: [AdminService],
   exports: [AdminService],

src/admin/admin.service.ts

@@ -1,5 +1,7 @@
 import { Injectable } from '@nestjs/common';
 import { PrismaService } from '../database/prisma.service';
+import { BackupService } from '../backup/backup.service';
+import { UpdateBackupScheduleDto } from '../backup/dto/backup.dto';
 import {
   AddFraudInvestigationNoteDto,
   AdminUpdateUserDto,
@@ -20,8 +22,37 @@ export class AdminService {
   constructor(
     private readonly prisma: PrismaService,
     private readonly fraudService: FraudService,
+    private readonly backupService: BackupService,
   ) {}
 
+  async listBackups() {
+    return this.backupService.listBackups();
+  }
+
+  async getBackupStatus() {
+    return this.backupService.getBackupStatus();
+  }
+
+  async getBackupSchedule() {
+    return this.backupService.getSchedule();
+  }
+
+  async updateBackupSchedule(payload: UpdateBackupScheduleDto) {
+    return this.backupService.updateSchedule(payload);
+  }
+
+  async runBackup(actorId: string) {
+    return this.backupService.createManualBackup(actorId);
+  }
+
+  async restoreBackup(backupId: string, actorId: string) {
+    return this.backupService.restoreBackup(backupId, actorId);
+  }
+
+  async getBackupDownload(backupId: string) {
+    return this.backupService.getBackupFile(backupId);
+  }
+
   async getDashboard() {
     const [totalUsers, blockedUsers, totalProperties, pendingProperties, activeProperties] =
       await Promise.all([

src/app.module.ts

@@ -2,6 +2,7 @@ import { Module } from '@nestjs/common';
 import { ConfigModule } from '@nestjs/config';
 import { GraphQLModule } from '@nestjs/graphql';
 import { ApolloDriver, ApolloDriverConfig } from '@nestjs/apollo';
+import { ScheduleModule } from '@nestjs/schedule';
 import { join } from 'path';
 import { UsersModule } from './users/users.module';
 import { AuthModule } from './auth/auth.module';
@@ -21,6 +22,7 @@ import './common/common.types'; // Load registered enums
 import { AdminModule } from './admin/admin.module';
 import { FraudModule } from './fraud/fraud.module';
 import { SearchModule } from './search/search.module';
+import { BackupModule } from './backup/backup.module';
 import { TrackingModule } from './tracking/tracking.module';
 import { NotificationsModule } from './notifications/notifications.module';
 @Module({
@@ -38,6 +40,7 @@ import { NotificationsModule } from './notifications/notifications.module';
         'graphql-ws': true,
       },
     }),
+    ScheduleModule.forRoot(),
     CacheModuleConfig,
     AnalyticsModule,
     PrismaModule,
@@ -54,6 +57,7 @@ import { NotificationsModule } from './notifications/notifications.module';
     DocumentsModule,
     IntegrationsModule,
     SearchModule,
+    BackupModule,
     TrackingModule,
     NotificationsModule,
   ],

src/backup/backup.module.ts

@@ -0,0 +1,11 @@
+import { Module } from '@nestjs/common';
+import { ConfigModule } from '@nestjs/config';
+import { PrismaModule } from '../database/prisma.module';
+import { BackupService } from './backup.service';
+
+@Module({
+  imports: [ConfigModule, PrismaModule],
+  providers: [BackupService],
+  exports: [BackupService],
+})
+export class BackupModule {}