All checks were successful
CI / Lint, typecheck, test (push) Successful in 3m45s
CD / Build and push images (push) Successful in 3m49s
CI / Build container images (push) Has been skipped
CD / Deploy to Test (push) Successful in 9s
CD / Smoke tests against Test (push) Successful in 1m18s
CD / Promote to Int (push) Successful in 11s
CI / Auth e2e pack (push) Successful in 5m35s
CI / Import/export fidelity gate (push) Successful in 47s
Off-host backups for every self-hoster, configured entirely in the admin UI — supersedes the host-specific mirror plan behind #84. shared: - webdav.ts (new package entry like token-crypto): minimal WebDAV client with basic auth — PROPFIND (tolerant multistatus parser), MKCOL, PUT (streamed), GET, DELETE; Nextcloud DAV path derived from the plain server URL, explicit DAV bases pass through - backup-status.ts: additive remote-upload status in status.json, the restore-status.json contract (running/succeeded/failed + staleness bound), the backup_command/backup_maintenance NOTIFY channels, and the one-bundle-per-set naming (dorfteich-backup-<id>.tar.gz) - backup-set.ts moved here from apps/backup (api lists local sets) backup sidecar: - reads the backup.* instance settings directly from the database (admin changes apply next run; local retention row overrides the env) and the app password from the secret store - after each successful set: bundle dump + files archive + manifest into ONE self-contained tar.gz, upload via WebDAV per schedule (off/daily/weekly; manual runs always upload), prune remote bundles — never the newest — and record the outcome in status.json; upload failures alert via a new backupUploadFailed mail (de+en) - command listener on backup_command (run / restore) with a serial queue against the nightly timer - restore orchestrator: restore-status.json → maintenance NOTIFY → grace → (remote: download + manifest-verify bundle) → terminate other DB connections → shared perform-restore path (same code as restore.sh) → final status + maintenance exit api: - MaintenanceGuard (global, registered before the setup gate): 503 maintenance_mode while restore-status says running; health endpoints and the new public GET /backup/restore-status stay exempt; a stale running state (crashed sidecar) unblocks after 30 min - MaintenanceStateService watches the file and restarts the api after a successful restore (fresh caches, migrate-on-start for older dumps); main.ts refuses to touch the database while a restore runs — a container restarting mid-restore must not race pg_restore with migrate deploy - worker sweeps (conversion, mail outbox, scheduler) catch transient database failures instead of dying on an unhandled rejection — the restore's connection termination crashed the api in verification - backup admin endpoints under /admin/system/backup: settings (live connection test before save, password write-only into the secret store), nextcloud/test, sets (local via the ro backups mount + remote via WebDAV), run + restore (type-to-confirm backstop, source validation) — commands travel as NOTIFY payloads; audit actions backup.settings_changed/run_triggered/restore_requested - readyz: new warning-level backup_remote check while a target is configured (26 h daily / 170 h weekly bound) collab: - maintenance listener: on enter, persist + close every live session and refuse new connections until exit (failsafe timeout 30 min) — no in-memory document may write pre-restore content back afterwards web: - Admin → System backup section: status card with remote facts and a "Back up now" button, the Nextcloud settings form with test button, and the restore picker (local + remote sets, type-to-confirm) - global maintenance screen: any 503 maintenance_mode flips the SPA to a status page polling the exempt endpoint, reloading when the instance returns Verified end-to-end against a live stack (fresh DB, native api + sidecar, fake WebDAV server): configure → test → manual backup → bundle upload → readyz/sets/status surfaces → remote restore with maintenance gate, marker rollback and api restart; suites: shared 21, backup 9, collab 11, api 58 files green, lint + i18n:check + typecheck clean. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01EwZ4jR4KFAPvpjWevfUGX1
126 lines
3.7 KiB
TypeScript
126 lines
3.7 KiB
TypeScript
import { BACKUP_COMMAND_CHANNEL, type BackupCommand } from '@dorfteich/shared';
|
|
import { Client } from 'pg';
|
|
|
|
import type { RemoteLogger } from './remote.js';
|
|
|
|
/**
|
|
* Listens for api-issued backup commands ("back up now", "restore set X",
|
|
* issue #103) on the {@link BACKUP_COMMAND_CHANNEL} — the same dedicated-
|
|
* connection LISTEN/NOTIFY pattern as the collab server's listeners. The
|
|
* handler is invoked fire-and-forget; serialization against the nightly
|
|
* schedule happens in the caller's queue (index.ts).
|
|
*/
|
|
|
|
export interface CommandListenerDeps {
|
|
createClient(): Client;
|
|
onCommand(command: BackupCommand): void;
|
|
log: RemoteLogger;
|
|
reconnectDelayMs?: number;
|
|
}
|
|
|
|
export interface CommandListener {
|
|
start(): Promise<void>;
|
|
stop(): Promise<void>;
|
|
}
|
|
|
|
const DEFAULT_RECONNECT_DELAY_MS = 1000;
|
|
|
|
export function parseCommand(payload: string): BackupCommand | null {
|
|
let parsed: unknown;
|
|
try {
|
|
parsed = JSON.parse(payload);
|
|
} catch {
|
|
return null;
|
|
}
|
|
const command = parsed as Partial<BackupCommand>;
|
|
if (command.kind === 'run') {
|
|
return { kind: 'run', requestedBy: command.requestedBy ?? null };
|
|
}
|
|
if (
|
|
command.kind === 'restore' &&
|
|
(command.source === 'local' || command.source === 'remote') &&
|
|
typeof command.backupId === 'string' &&
|
|
/^\d{8}-\d{6}$/.test(command.backupId)
|
|
) {
|
|
return {
|
|
kind: 'restore',
|
|
source: command.source,
|
|
backupId: command.backupId,
|
|
requestedBy: command.requestedBy ?? null,
|
|
};
|
|
}
|
|
return null;
|
|
}
|
|
|
|
export function createCommandListener(deps: CommandListenerDeps): CommandListener {
|
|
const reconnectDelayMs = deps.reconnectDelayMs ?? DEFAULT_RECONNECT_DELAY_MS;
|
|
let client: Client | null = null;
|
|
let stopped = false;
|
|
let reconnectTimer: NodeJS.Timeout | null = null;
|
|
|
|
function scheduleReconnect(): void {
|
|
if (stopped || reconnectTimer) return;
|
|
reconnectTimer = setTimeout(() => {
|
|
reconnectTimer = null;
|
|
void connect();
|
|
}, reconnectDelayMs);
|
|
reconnectTimer.unref?.();
|
|
}
|
|
|
|
async function connect(): Promise<void> {
|
|
if (stopped) return;
|
|
const next = deps.createClient();
|
|
next.on('error', (error) => {
|
|
deps.log.warn({ error: error.message }, 'command listener connection error; will reconnect');
|
|
if (client === next) client = null;
|
|
scheduleReconnect();
|
|
});
|
|
next.on('end', () => {
|
|
// The restore path terminates every other connection, including this
|
|
// one — reconnect quietly so the next command still arrives.
|
|
if (client === next) client = null;
|
|
scheduleReconnect();
|
|
});
|
|
next.on('notification', (message) => {
|
|
if (message.channel !== BACKUP_COMMAND_CHANNEL || !message.payload) return;
|
|
const command = parseCommand(message.payload);
|
|
if (!command) {
|
|
deps.log.warn({ payload: message.payload }, 'ignoring malformed backup command');
|
|
return;
|
|
}
|
|
deps.onCommand(command);
|
|
});
|
|
|
|
try {
|
|
await next.connect();
|
|
await next.query(`LISTEN ${BACKUP_COMMAND_CHANNEL}`);
|
|
client = next;
|
|
deps.log.info({ channel: BACKUP_COMMAND_CHANNEL }, 'listening for backup commands');
|
|
} catch (error) {
|
|
deps.log.warn(
|
|
{ error: (error as Error).message },
|
|
'could not start command listener; will retry',
|
|
);
|
|
await next.end().catch(() => undefined);
|
|
scheduleReconnect();
|
|
}
|
|
}
|
|
|
|
return {
|
|
async start(): Promise<void> {
|
|
stopped = false;
|
|
await connect();
|
|
},
|
|
async stop(): Promise<void> {
|
|
stopped = true;
|
|
if (reconnectTimer) {
|
|
clearTimeout(reconnectTimer);
|
|
reconnectTimer = null;
|
|
}
|
|
const current = client;
|
|
client = null;
|
|
if (current) await current.end().catch(() => undefined);
|
|
},
|
|
};
|
|
}
|