Files
picpeak/backend/src/services/backupManifest.js
T
paul 20dd43c093
Mirror to GitHub / mirror (push) Successful in 28s
Test and Lint / backend-test (push) Successful in 1m26s
continuous-integration/drone/push Build is failing
Test and Lint / frontend-test (push) Failing after 2m18s
Version and Release / version-bump (push) Successful in 42s
Version and Release / trigger-drone (push) Successful in 3s
feat: implement comprehensive backup and restore system with S3 support
- Add S3/MinIO storage adapter with multipart upload support
- Implement database backup service for SQLite and PostgreSQL
- Create backup manifest generator for tracking backup contents
- Enhance backup service with S3 integration and incremental backups
- Add restore service with safety measures and rollback capability
- Create comprehensive test suite for all backup functionality
- Add admin API endpoints for backup/restore management
- Implement frontend UI with dashboard, configuration, and restore wizard
- Add roadmap section to README with implemented backup feature

This implementation provides:
- Multiple backup destinations (local, rsync, S3/MinIO)
- Intelligent change detection to minimize backup frequency
- Full database backups with compression
- Manifest-based restore with integrity validation
- Pre-restore safety backups with rollback
- Comprehensive error handling and monitoring
- User-friendly admin interface

🤖 Generated with Claude Code

Co-Authored-By: Claude <noreply@anthropic.com>
2025-07-22 09:05:52 +02:00

501 lines
16 KiB
JavaScript

const fs = require('fs').promises;
const path = require('path');
const crypto = require('crypto');
const yaml = require('js-yaml');
const os = require('os');
const { db } = require('../database/db');
const logger = require('../utils/logger');
/**
* Backup Manifest Generator
*
* Generates comprehensive manifests for backups including:
* - Version information (app, node, OS)
* - File listings with metadata and checksums
* - Database information
* - System state at backup time
* - Support for both JSON and YAML formats
* - Incremental backup support with parent references
*/
class BackupManifestGenerator {
constructor() {
this.appVersion = require('../../package.json').version;
this.nodeVersion = process.version;
this.platform = process.platform;
this.osRelease = os.release();
this.hostname = os.hostname();
}
/**
* Generate a comprehensive backup manifest
* @param {Object} options - Manifest generation options
* @param {string} options.backupType - 'full' or 'incremental'
* @param {string} options.backupPath - Path to the backup directory
* @param {Array} options.files - Array of backed up files with metadata
* @param {Object} options.databaseInfo - Database backup information
* @param {string} options.parentBackupId - For incremental backups, reference to parent
* @param {string} options.format - 'json' or 'yaml' (default: 'json')
* @param {Object} options.customMetadata - Additional metadata to include
* @returns {Object} Generated manifest object
*/
async generateManifest(options) {
const {
backupType = 'full',
backupPath,
files = [],
databaseInfo = {},
parentBackupId = null,
format = 'json',
customMetadata = {}
} = options;
const manifest = {
// Manifest metadata
manifest: {
version: '2.0',
created: new Date().toISOString(),
generator: 'PicPeak Backup Manifest Generator',
format: format
},
// Backup information
backup: {
id: this.generateBackupId(),
type: backupType,
timestamp: new Date().toISOString(),
path: backupPath,
parent_backup_id: parentBackupId,
retention_days: customMetadata.retentionDays || 30
},
// System information
system: {
hostname: this.hostname,
platform: this.platform,
os_release: this.osRelease,
architecture: os.arch(),
cpu_count: os.cpus().length,
total_memory: os.totalmem(),
free_memory: os.freemem(),
uptime: os.uptime()
},
// Application information
application: {
name: 'PicPeak',
version: this.appVersion,
node_version: this.nodeVersion,
environment: process.env.NODE_ENV || 'production',
storage_path: process.env.STORAGE_PATH || path.join(__dirname, '../../../storage')
},
// Files information
files: {
count: files.length,
total_size: files.reduce((sum, file) => sum + (file.size || 0), 0),
checksums: await this.generateFileChecksums(files),
manifest: files.map(file => ({
path: file.relativePath || file.path,
size: file.size,
modified: file.modified,
checksum: file.checksum,
type: this.getFileType(file.path),
permissions: file.permissions
}))
},
// Database information
database: {
type: databaseInfo.type || this.getDatabaseType(),
backup_file: databaseInfo.backupFile,
size: databaseInfo.size,
checksum: databaseInfo.checksum,
tables: databaseInfo.tables || {},
row_counts: databaseInfo.rowCounts || {},
schema_version: await this.getSchemaVersion()
},
// Verification information
verification: {
total_checksum: null, // Will be calculated after manifest is complete
file_count_check: files.length,
size_check: files.reduce((sum, file) => sum + (file.size || 0), 0),
integrity_timestamp: new Date().toISOString()
},
// Custom metadata
metadata: {
...customMetadata,
backup_settings: await this.getBackupSettings(),
active_events_count: await this.getActiveEventsCount(),
archived_events_count: await this.getArchivedEventsCount(),
total_photos_count: await this.getTotalPhotosCount()
}
};
// Calculate total checksum of the manifest
manifest.verification.total_checksum = this.calculateManifestChecksum(manifest);
return manifest;
}
/**
* Save manifest to file
* @param {Object} manifest - Manifest object to save
* @param {string} filePath - Path to save the manifest
* @param {string} format - 'json' or 'yaml'
*/
async saveManifest(manifest, filePath, format = 'json') {
try {
let content;
if (format === 'yaml') {
content = yaml.dump(manifest, {
indent: 2,
lineWidth: -1,
noRefs: true,
sortKeys: true
});
} else {
content = JSON.stringify(manifest, null, 2);
}
await fs.writeFile(filePath, content, 'utf8');
logger.info(`Manifest saved to ${filePath} (format: ${format})`);
return filePath;
} catch (error) {
logger.error('Failed to save manifest:', error);
throw error;
}
}
/**
* Load and validate an existing manifest
* @param {string} filePath - Path to the manifest file
* @returns {Object} Loaded and validated manifest
*/
async loadManifest(filePath) {
try {
const content = await fs.readFile(filePath, 'utf8');
let manifest;
// Detect format and parse
if (filePath.endsWith('.yaml') || filePath.endsWith('.yml')) {
manifest = yaml.load(content);
} else {
manifest = JSON.parse(content);
}
// Validate manifest structure
this.validateManifest(manifest);
return manifest;
} catch (error) {
logger.error('Failed to load manifest:', error);
throw error;
}
}
/**
* Validate manifest structure and integrity
* @param {Object} manifest - Manifest to validate
* @throws {Error} If validation fails
*/
validateManifest(manifest) {
// Check required sections
const requiredSections = ['manifest', 'backup', 'system', 'application', 'files', 'database', 'verification'];
for (const section of requiredSections) {
if (!manifest[section]) {
throw new Error(`Missing required section: ${section}`);
}
}
// Validate manifest version
if (!manifest.manifest.version) {
throw new Error('Missing manifest version');
}
// Validate file checksums
if (manifest.files.count !== manifest.files.manifest.length) {
throw new Error('File count mismatch');
}
// Validate total checksum
const calculatedChecksum = this.calculateManifestChecksum(manifest);
if (manifest.verification.total_checksum !== calculatedChecksum) {
throw new Error('Manifest checksum verification failed');
}
logger.info('Manifest validation passed');
return true;
}
/**
* Compare two manifests for incremental backup
* @param {Object} currentManifest - Current backup manifest
* @param {Object} parentManifest - Parent backup manifest
* @returns {Object} Comparison results
*/
compareManifests(currentManifest, parentManifest) {
const comparison = {
added_files: [],
modified_files: [],
deleted_files: [],
unchanged_files: [],
size_difference: 0,
database_changes: {}
};
// Create file maps for easy comparison
const currentFiles = new Map(
currentManifest.files.manifest.map(f => [f.path, f])
);
const parentFiles = new Map(
parentManifest.files.manifest.map(f => [f.path, f])
);
// Find added and modified files
for (const [path, file] of currentFiles) {
const parentFile = parentFiles.get(path);
if (!parentFile) {
comparison.added_files.push(file);
comparison.size_difference += file.size;
} else if (file.checksum !== parentFile.checksum) {
comparison.modified_files.push(file);
comparison.size_difference += file.size - parentFile.size;
} else {
comparison.unchanged_files.push(file);
}
}
// Find deleted files
for (const [path, file] of parentFiles) {
if (!currentFiles.has(path)) {
comparison.deleted_files.push(file);
comparison.size_difference -= file.size;
}
}
// Compare database info
comparison.database_changes = {
size_difference: currentManifest.database.size - parentManifest.database.size,
checksum_changed: currentManifest.database.checksum !== parentManifest.database.checksum,
schema_version_changed: currentManifest.database.schema_version !== parentManifest.database.schema_version
};
return comparison;
}
/**
* Generate incremental manifest based on parent
* @param {Object} options - Manifest generation options
* @param {Object} parentManifest - Parent backup manifest
* @returns {Object} Incremental manifest
*/
async generateIncrementalManifest(options, parentManifest) {
const fullManifest = await this.generateManifest({
...options,
backupType: 'incremental'
});
const comparison = this.compareManifests(fullManifest, parentManifest);
// Add incremental-specific information
fullManifest.incremental = {
parent_backup_id: parentManifest.backup.id,
parent_timestamp: parentManifest.backup.timestamp,
changes: {
added_files_count: comparison.added_files.length,
modified_files_count: comparison.modified_files.length,
deleted_files_count: comparison.deleted_files.length,
unchanged_files_count: comparison.unchanged_files.length,
size_difference: comparison.size_difference
},
added_files: comparison.added_files.map(f => f.path),
modified_files: comparison.modified_files.map(f => f.path),
deleted_files: comparison.deleted_files.map(f => f.path)
};
return fullManifest;
}
// Helper methods
generateBackupId() {
const timestamp = new Date().toISOString().replace(/[:-]/g, '').replace('T', '-').split('.')[0];
const random = crypto.randomBytes(4).toString('hex');
return `backup-${timestamp}-${random}`;
}
async generateFileChecksums(files) {
const checksums = {};
for (const file of files) {
if (file.checksum) {
checksums[file.relativePath || file.path] = file.checksum;
}
}
return checksums;
}
getFileType(filePath) {
const ext = path.extname(filePath).toLowerCase();
const typeMap = {
'.jpg': 'image',
'.jpeg': 'image',
'.png': 'image',
'.gif': 'image',
'.webp': 'image',
'.zip': 'archive',
'.sql': 'database',
'.db': 'database',
'.json': 'config',
'.yaml': 'config',
'.yml': 'config'
};
return typeMap[ext] || 'other';
}
getDatabaseType() {
return process.env.DB_TYPE === 'postgresql' ? 'postgresql' : 'sqlite';
}
async getSchemaVersion() {
try {
const result = await db('migrations')
.orderBy('run_at', 'desc')
.first();
return result ? result.migration_name : 'unknown';
} catch (error) {
return 'unknown';
}
}
async getBackupSettings() {
try {
const settings = await db('app_settings')
.where('setting_type', 'backup')
.select('setting_key', 'setting_value');
const config = {};
settings.forEach(setting => {
try {
config[setting.setting_key] = JSON.parse(setting.setting_value);
} catch (e) {
config[setting.setting_key] = setting.setting_value;
}
});
return config;
} catch (error) {
return {};
}
}
async getActiveEventsCount() {
try {
const result = await db('events')
.where('status', 'active')
.count('* as count')
.first();
return result ? parseInt(result.count) : 0;
} catch (error) {
return 0;
}
}
async getArchivedEventsCount() {
try {
const result = await db('events')
.where('status', 'archived')
.count('* as count')
.first();
return result ? parseInt(result.count) : 0;
} catch (error) {
return 0;
}
}
async getTotalPhotosCount() {
try {
const result = await db('photos')
.count('* as count')
.first();
return result ? parseInt(result.count) : 0;
} catch (error) {
return 0;
}
}
calculateManifestChecksum(manifest) {
// Create a copy without the checksum field
const manifestCopy = JSON.parse(JSON.stringify(manifest));
if (manifestCopy.verification) {
delete manifestCopy.verification.total_checksum;
}
// Calculate SHA256 of the sorted JSON
const content = JSON.stringify(manifestCopy, Object.keys(manifestCopy).sort());
return crypto.createHash('sha256').update(content).digest('hex');
}
/**
* Generate a summary report from a manifest
* @param {Object} manifest - Manifest to summarize
* @returns {string} Human-readable summary
*/
generateSummaryReport(manifest) {
const report = [];
report.push('=== BACKUP MANIFEST SUMMARY ===');
report.push(`Backup ID: ${manifest.backup.id}`);
report.push(`Type: ${manifest.backup.type}`);
report.push(`Created: ${manifest.backup.timestamp}`);
if (manifest.backup.parent_backup_id) {
report.push(`Parent Backup: ${manifest.backup.parent_backup_id}`);
}
report.push('\n--- System Information ---');
report.push(`Host: ${manifest.system.hostname}`);
report.push(`Platform: ${manifest.system.platform} ${manifest.system.os_release}`);
report.push(`Architecture: ${manifest.system.architecture}`);
report.push('\n--- Application Information ---');
report.push(`App Version: ${manifest.application.version}`);
report.push(`Node Version: ${manifest.application.node_version}`);
report.push(`Environment: ${manifest.application.environment}`);
report.push('\n--- Files Summary ---');
report.push(`Total Files: ${manifest.files.count}`);
report.push(`Total Size: ${(manifest.files.total_size / 1024 / 1024).toFixed(2)} MB`);
if (manifest.incremental) {
report.push('\n--- Incremental Changes ---');
report.push(`Added Files: ${manifest.incremental.changes.added_files_count}`);
report.push(`Modified Files: ${manifest.incremental.changes.modified_files_count}`);
report.push(`Deleted Files: ${manifest.incremental.changes.deleted_files_count}`);
report.push(`Size Difference: ${(manifest.incremental.changes.size_difference / 1024 / 1024).toFixed(2)} MB`);
}
report.push('\n--- Database Information ---');
report.push(`Type: ${manifest.database.type}`);
report.push(`Size: ${manifest.database.size ? (manifest.database.size / 1024 / 1024).toFixed(2) + ' MB' : 'N/A'}`);
report.push(`Schema Version: ${manifest.database.schema_version}`);
report.push('\n--- Content Statistics ---');
report.push(`Active Events: ${manifest.metadata.active_events_count}`);
report.push(`Archived Events: ${manifest.metadata.archived_events_count}`);
report.push(`Total Photos: ${manifest.metadata.total_photos_count}`);
report.push('\n--- Verification ---');
report.push(`Manifest Checksum: ${manifest.verification.total_checksum}`);
report.push(`Integrity Timestamp: ${manifest.verification.integrity_timestamp}`);
return report.join('\n');
}
}
// Export singleton instance
module.exports = new BackupManifestGenerator();