Spaces:
Runtime error
Runtime error
File size: 20,019 Bytes
cd8bd0a | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 | /**
* db/backup.js β Database backup/restore operations.
*/
import path from "path";
import fs from "fs";
import {
getDbInstance,
resetDbInstance,
isBuildPhase,
isCloud,
SQLITE_FILE,
DB_BACKUPS_DIR,
DATA_DIR,
} from "./core";
import { resetAllDbModuleState } from "./stateReset";
type CountRow = { cnt?: number };
// ββββββββββββββββ Backup Config ββββββββββββββββ
let _lastBackupAt = 0;
const BACKUP_THROTTLE_MS = 60 * 60 * 1000; // 60 minutes
const MAX_DB_BACKUPS = 20;
const DEFAULT_DB_BACKUP_RETENTION_DAYS = 0;
const TRUE_ENV_VALUES = new Set(["1", "true", "yes", "on"]);
function parsePositiveInt(value: string | undefined, fallback: number) {
if (!value) return fallback;
const parsed = Number.parseInt(value, 10);
return Number.isInteger(parsed) && parsed > 0 ? parsed : fallback;
}
function parseNonNegativeInt(value: string | undefined, fallback: number) {
if (value === undefined) return fallback;
const parsed = Number.parseInt(value, 10);
return Number.isInteger(parsed) && parsed >= 0 ? parsed : fallback;
}
// #3834: the "Keep latest backups" UI value is persisted here so it survives a page
// refresh / the loadStorageHealth() refetch. A dedicated namespace avoids any
// cross-talk with the databaseSettings key_value store (which rewrites all of its own
// keys on every update). It is intentionally separate from the orphan
// `databaseSettings.backup.keepLastNBackups` (default 5) so existing installs keep the
// historical default of 20 until an operator explicitly changes it here.
const DB_BACKUP_SETTINGS_NAMESPACE = "dbBackup";
const DB_BACKUP_MAX_FILES_KEY = "maxFiles";
const DB_BACKUP_RETENTION_DAYS_KEY = "retentionDays";
function getStoredDbBackupInteger(key: string, options: { min: number }): number | undefined {
try {
const db = getDbInstance();
const row = db
.prepare("SELECT value FROM key_value WHERE namespace = ? AND key = ?")
.get(DB_BACKUP_SETTINGS_NAMESPACE, key) as { value?: string } | undefined;
if (!row?.value) return undefined;
const parsed = JSON.parse(row.value);
return Number.isInteger(parsed) && parsed >= options.min ? parsed : undefined;
} catch {
return undefined;
}
}
function setStoredDbBackupInteger(key: string, value: number, options: { min: number }): void {
if (!Number.isInteger(value) || value < options.min) return;
const db = getDbInstance();
db.prepare("INSERT OR REPLACE INTO key_value (namespace, key, value) VALUES (?, ?, ?)").run(
DB_BACKUP_SETTINGS_NAMESPACE,
key,
JSON.stringify(value)
);
}
/** Persist the operator-chosen "keep latest backups" retention count (#3834). */
export function setDbBackupMaxFiles(value: number): void {
setStoredDbBackupInteger(DB_BACKUP_MAX_FILES_KEY, value, { min: 1 });
}
export function getDbBackupMaxFiles() {
// Precedence: DB_BACKUP_MAX_FILES env override (ops) β persisted UI value β default.
if (process.env.DB_BACKUP_MAX_FILES) {
return parsePositiveInt(process.env.DB_BACKUP_MAX_FILES, MAX_DB_BACKUPS);
}
return getStoredDbBackupInteger(DB_BACKUP_MAX_FILES_KEY, { min: 1 }) ?? MAX_DB_BACKUPS;
}
/** Persist the operator-chosen age-based backup retention window. */
export function setDbBackupRetentionDays(value: number): void {
setStoredDbBackupInteger(DB_BACKUP_RETENTION_DAYS_KEY, value, { min: 0 });
}
export function getDbBackupRetentionDays() {
// Precedence: DB_BACKUP_RETENTION_DAYS env override (ops) β persisted UI value β default.
if (process.env.DB_BACKUP_RETENTION_DAYS) {
return parseNonNegativeInt(
process.env.DB_BACKUP_RETENTION_DAYS,
DEFAULT_DB_BACKUP_RETENTION_DAYS
);
}
return (
getStoredDbBackupInteger(DB_BACKUP_RETENTION_DAYS_KEY, { min: 0 }) ??
DEFAULT_DB_BACKUP_RETENTION_DAYS
);
}
function getBackupDir() {
return DB_BACKUPS_DIR || path.join(DATA_DIR, "db_backups");
}
function getBackupFamilyBase(filename: string) {
if (filename.endsWith("-wal") || filename.endsWith("-shm")) return filename.slice(0, -4);
if (filename.endsWith("-journal")) return filename.slice(0, -8);
return filename;
}
function collectBackupFamilies(backupDir: string) {
if (!fs.existsSync(backupDir)) return [];
const families = new Map<
string,
{
base: string;
hasPrimary: boolean;
primaryMtimeMs: number;
latestMtimeMs: number;
files: string[];
}
>();
for (const name of fs.readdirSync(backupDir)) {
if (!name.startsWith("db_")) continue;
const base = getBackupFamilyBase(name);
const filePath = path.join(backupDir, name);
let stat;
try {
stat = fs.statSync(filePath);
} catch {
continue;
}
const family = families.get(base) || {
base,
hasPrimary: false,
primaryMtimeMs: 0,
latestMtimeMs: 0,
files: [],
};
family.files.push(name);
family.latestMtimeMs = Math.max(family.latestMtimeMs, stat.mtimeMs);
if (name === base && name.endsWith(".sqlite")) {
family.hasPrimary = true;
family.primaryMtimeMs = stat.mtimeMs;
}
families.set(base, family);
}
return [...families.values()];
}
export function cleanupDbBackups(options?: { maxFiles?: number; retentionDays?: number }) {
const backupDir = getBackupDir();
if (!fs.existsSync(backupDir)) {
return {
deletedBackupFamilies: 0,
deletedFiles: 0,
keptBackupFamilies: 0,
maxFiles: options?.maxFiles ?? getDbBackupMaxFiles(),
retentionDays: options?.retentionDays ?? getDbBackupRetentionDays(),
};
}
const maxFiles = Math.max(1, options?.maxFiles ?? getDbBackupMaxFiles());
const retentionDays = Math.max(0, options?.retentionDays ?? getDbBackupRetentionDays());
const cutoffMs = retentionDays > 0 ? Date.now() - retentionDays * 24 * 60 * 60 * 1000 : 0;
const families = collectBackupFamilies(backupDir);
const primaryFamilies = families
.filter((family) => family.hasPrimary)
.sort((a, b) => b.primaryMtimeMs - a.primaryMtimeMs);
const keepPrimaryBases = new Set(primaryFamilies.slice(0, maxFiles).map((family) => family.base));
let deletedBackupFamilies = 0;
let deletedFiles = 0;
for (const family of families) {
const isOverflowPrimary = family.hasPrimary && !keepPrimaryBases.has(family.base);
const isExpired = retentionDays > 0 && family.latestMtimeMs < cutoffMs;
const isOrphan = !family.hasPrimary;
if (!isOverflowPrimary && !isExpired && !isOrphan) continue;
deletedBackupFamilies += 1;
for (const name of family.files) {
try {
fs.unlinkSync(path.join(backupDir, name));
deletedFiles += 1;
} catch {
/* ignore */
}
}
}
return {
deletedBackupFamilies,
deletedFiles,
keptBackupFamilies: collectBackupFamilies(backupDir).filter((family) => family.hasPrimary)
.length,
maxFiles,
retentionDays,
};
}
function isSqliteAutoBackupDisabled() {
const isTest =
typeof process !== "undefined" &&
(process.env.NODE_ENV === "test" ||
process.env.VITEST !== undefined ||
process.argv.some((a) => a.includes("test")));
if (isTest) return true;
const value = process.env.DISABLE_SQLITE_AUTO_BACKUP;
if (!value) return false;
return TRUE_ENV_VALUES.has(value.trim().toLowerCase());
}
function sleep(ms: number) {
return new Promise((resolve) => setTimeout(resolve, ms));
}
export async function unlinkFileWithRetry(
filePath: string,
options?: { maxAttempts?: number; retryableCodes?: string[]; baseDelayMs?: number }
) {
const maxAttempts = Math.max(1, options?.maxAttempts ?? 10);
const retryableCodes = new Set(options?.retryableCodes ?? ["EBUSY", "EPERM"]);
const baseDelayMs = Math.max(0, options?.baseDelayMs ?? 100);
for (let attempt = 0; attempt < maxAttempts; attempt++) {
try {
if (fs.existsSync(filePath)) fs.unlinkSync(filePath);
return;
} catch (err: unknown) {
const code =
err && typeof err === "object" && "code" in err ? (err as NodeJS.ErrnoException).code : "";
if (code === "ENOENT") return;
if (retryableCodes.has(String(code)) && attempt < maxAttempts - 1) {
await sleep(baseDelayMs * (attempt + 1));
} else {
throw err;
}
}
}
}
// ββββββββββββββββ Backup ββββββββββββββββ
export function backupDbFile(reason = "auto") {
try {
if (isBuildPhase || isCloud) return null;
if (!SQLITE_FILE || !fs.existsSync(SQLITE_FILE)) return null;
if (reason !== "manual" && isSqliteAutoBackupDisabled()) return null;
const stat = fs.statSync(SQLITE_FILE);
if (stat.size < 4096) {
console.warn(`[DB] Backup SKIPPED β DB too small (${stat.size}B)`);
return null;
}
// Throttle
const now = Date.now();
if (reason !== "manual" && reason !== "pre-restore" && now - _lastBackupAt < BACKUP_THROTTLE_MS)
return null;
_lastBackupAt = now;
const backupDir = getBackupDir();
if (!fs.existsSync(backupDir)) fs.mkdirSync(backupDir, { recursive: true });
if (reason !== "manual" && reason !== "pre-restore") {
// Shrink detection is useful for automatic safety backups, but it should
// never block an explicit operator action like manual backup or pre-restore.
const existingBackups = fs
.readdirSync(backupDir)
.filter((f) => f.startsWith("db_") && f.endsWith(".sqlite"))
.sort();
if (existingBackups.length > 0) {
const latestBackup = existingBackups[existingBackups.length - 1];
const latestStat = fs.statSync(path.join(backupDir, latestBackup));
if (latestStat.size > 4096 && stat.size < latestStat.size * 0.5) {
console.warn(`[DB] Backup SKIPPED β DB shrank from ${latestStat.size}B to ${stat.size}B`);
return null;
}
}
}
const timestamp = new Date().toISOString().replace(/[:.]/g, "-");
const backupFile = path.join(backupDir, `db_${timestamp}_${reason}.sqlite`);
// Use native SQLite backup API for consistency
const db = getDbInstance();
db.backup(backupFile)
.then(() => {
console.log(`[DB] Backup created: ${backupFile} (${stat.size} bytes)`);
cleanupDbBackups();
})
.catch((err: unknown) => {
const message = err instanceof Error ? err.message : String(err);
console.error("[DB] Backup failed:", message);
});
return { filename: path.basename(backupFile), size: stat.size };
} catch (err: unknown) {
const message = err instanceof Error ? err.message : String(err);
console.error("[DB] Backup failed:", message);
return null;
}
}
// ββββββββββββββββ List Backups ββββββββββββββββ
export async function listDbBackups() {
const backupDir = getBackupDir();
try {
if (!fs.existsSync(backupDir)) return [];
const entries = fs
.readdirSync(backupDir)
.filter((f) => f.startsWith("db_") && f.endsWith(".sqlite"))
.sort()
.reverse();
const { tryOpenSync } = await import("@/lib/db/adapters/driverFactory");
return entries.map((filename) => {
const filePath = path.join(backupDir, filename);
const stat = fs.statSync(filePath);
const match = filename.match(/^db_(.+?)_([^.]+)\.sqlite$/);
const reason = match ? match[2] : "unknown";
let connectionCount = 0;
try {
const backupDb = tryOpenSync(filePath, { readonly: true });
if (backupDb) {
try {
const row = backupDb
.prepare("SELECT COUNT(*) as cnt FROM provider_connections")
.get() as CountRow | undefined;
connectionCount = Number(row?.cnt ?? 0);
} finally {
backupDb.close();
}
}
} catch {
/* ignore */
}
return {
id: filename,
filename,
createdAt: stat.mtime.toISOString(),
size: stat.size,
reason,
connectionCount,
};
});
} catch {
return [];
}
}
// ββββββββββββββββ Restore Backup ββββββββββββββββ
export async function restoreDbBackup(backupId: string) {
const backupDir = getBackupDir();
// Validate format: must be db_<timestamp>_<reason>.sqlite, no path separators
if (
!backupId.startsWith("db_") ||
!backupId.endsWith(".sqlite") ||
backupId.includes(path.sep) ||
backupId.includes("/")
) {
throw new Error("Invalid backup ID");
}
const backupPath = path.resolve(backupDir, backupId);
// Prevent path traversal: resolved path must stay within backupDir
if (
!backupPath.startsWith(path.resolve(backupDir) + path.sep) &&
backupPath !== path.resolve(backupDir)
) {
throw new Error("Invalid backup ID: path traversal detected");
}
if (!fs.existsSync(backupPath)) {
throw new Error(`Backup not found: ${backupId}`);
}
// Validate backup integrity
try {
const { tryOpenSync } = await import("@/lib/db/adapters/driverFactory");
const testDb = tryOpenSync(backupPath, { readonly: true });
if (!testDb) {
throw new Error("Backup file is corrupt: could not open");
}
let result: Array<{ integrity_check?: string }>;
try {
result = testDb.pragma("integrity_check") as Array<{ integrity_check?: string }>;
} finally {
testDb.close();
}
if (result[0]?.integrity_check !== "ok") {
throw new Error("Backup integrity check failed");
}
} catch (e: unknown) {
if (e instanceof Error && e.message === "Backup integrity check failed") throw e;
const message = e instanceof Error ? e.message : String(e);
throw new Error(`Backup file is corrupt: ${message}`);
}
// Force pre-restore backup (bypass throttle) and await so the DB is not closed while backup runs
if (!isSqliteAutoBackupDisabled()) {
_lastBackupAt = 0;
const backupDirForPre = getBackupDir();
if (SQLITE_FILE && fs.existsSync(SQLITE_FILE)) {
const stat = fs.statSync(SQLITE_FILE);
if (stat.size >= 4096) {
if (!fs.existsSync(backupDirForPre)) fs.mkdirSync(backupDirForPre, { recursive: true });
const preBackupPath = path.join(
backupDirForPre,
`db_${new Date().toISOString().replace(/[:.]/g, "-")}_pre-restore.sqlite`
);
const dbForBackup = getDbInstance();
await dbForBackup.backup(preBackupPath);
_lastBackupAt = Date.now();
}
}
}
// Close and reset current connection
resetDbInstance();
// Clear all cached prepared statements and other state bound to the old connection
resetAllDbModuleState();
const sqliteFile = SQLITE_FILE;
if (!sqliteFile) {
throw new Error("SQLITE_FILE is unavailable in local backup restore");
}
// On Windows, the file handle may be released asynchronously after close; give it a moment.
await sleep(500);
// Remove main file and WAL sidecars to avoid stale frame replay after restore.
// Retry unlink on EBUSY/EPERM (Windows may hold the handle briefly).
const sqliteFilesToReplace = [
sqliteFile,
`${sqliteFile}-wal`,
`${sqliteFile}-shm`,
`${sqliteFile}-journal`,
];
for (const filePath of sqliteFilesToReplace) {
if (!filePath) continue;
await unlinkFileWithRetry(filePath);
}
// Copy backup over current DB
fs.copyFileSync(backupPath, sqliteFile);
// Reopen
const db = getDbInstance();
const connCount =
(db.prepare("SELECT COUNT(*) as cnt FROM provider_connections").get() as CountRow | undefined)
?.cnt || 0;
const nodeCount =
(db.prepare("SELECT COUNT(*) as cnt FROM provider_nodes").get() as CountRow | undefined)?.cnt ||
0;
const comboCount =
(db.prepare("SELECT COUNT(*) as cnt FROM combos").get() as CountRow | undefined)?.cnt || 0;
const keyCount =
(db.prepare("SELECT COUNT(*) as cnt FROM api_keys").get() as CountRow | undefined)?.cnt || 0;
console.log(`[DB] Restored backup: ${backupId} (${connCount} connections)`);
return {
restored: true,
backupId,
connectionCount: connCount,
nodeCount,
comboCount,
apiKeyCount: keyCount,
};
}
// ββββββββββββββββ Export-All helpers (for /api/db-backups/exportAll) ββββββββββββββββ
export interface ExportAllRows {
settings: Record<string, string>;
combos: unknown[];
providers: unknown[];
apiKeys: unknown[];
}
/**
* Reads summary rows used by the exportAll backup route.
*
* - settings: full key_value table (key β value map)
* - combos: full combos table
* - providers: provider_connections rows, **excluding sensitive credentials**
* (id, provider, name, auth_type, is_active, email, created_at only)
* - apiKeys: api_keys rows with masked prefix
* (id, name, first 8 chars of key, machine_id, created_at)
*
* Each category is wrapped in a try/catch so a missing table never aborts the
* entire export β consistent with the original inline behaviour.
*/
export function exportAllSummaryRows(): ExportAllRows {
const db = getDbInstance();
const settings: Record<string, string> = {};
try {
const rows = db.prepare("SELECT key, value FROM key_value").all() as {
key: string;
value: string;
}[];
for (const row of rows) {
settings[row.key] = row.value;
}
} catch {
// key_value table might not exist
}
const combos: unknown[] = [];
try {
combos.push(...db.prepare("SELECT * FROM combos").all());
} catch {
// combos table might not exist
}
const providers: unknown[] = [];
try {
providers.push(
...db
.prepare(
"SELECT id, provider, name, auth_type, is_active, email, created_at FROM provider_connections"
)
.all()
);
} catch {
// provider_connections table might not exist
}
const apiKeys: unknown[] = [];
try {
apiKeys.push(
...db
.prepare(
"SELECT id, name, substr(key, 1, 8) as prefix, machine_id, created_at FROM api_keys"
)
.all()
);
} catch {
// api_keys table might not exist
}
return { settings, combos, providers, apiKeys };
}
// ββββββββββββββββ Import validation helpers (for /api/db-backups/import) ββββββββββββββββ
/**
* Queries an **already-opened** SQLite adapter for the list of table names.
*
* Used by the import route to validate that a candidate database contains the
* required OmniRoute tables before replacing the live database.
*
* Accepting an adapter as a parameter (rather than calling getDbInstance()) is
* intentional: the import route opens a *temporary* database for validation,
* not the live one.
*/
export function getTableNamesFromAdapter(adapter: {
prepare: (sql: string) => { all: () => unknown[] };
}): string[] {
const rows = adapter.prepare("SELECT name FROM sqlite_master WHERE type='table'").all() as Array<{
name: string;
}>;
return rows.map((r) => r.name);
}
/**
* Counts rows in a set of tables from the **live** database (post-import).
* Returns an object keyed by table name with the row count as value.
*/
export function countImportedRows(): {
connCount: number;
nodeCount: number;
comboCount: number;
keyCount: number;
} {
const db = getDbInstance();
const connCount =
(db.prepare("SELECT COUNT(*) as cnt FROM provider_connections").get() as any)?.cnt || 0;
const nodeCount =
(db.prepare("SELECT COUNT(*) as cnt FROM provider_nodes").get() as any)?.cnt || 0;
const comboCount = (db.prepare("SELECT COUNT(*) as cnt FROM combos").get() as any)?.cnt || 0;
const keyCount = (db.prepare("SELECT COUNT(*) as cnt FROM api_keys").get() as any)?.cnt || 0;
return { connCount, nodeCount, comboCount, keyCount };
}
|