dorfteich/apps/backup/src/settings.ts
Claude Fable 5 5cef359b8f
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
Nextcloud backup target: admin-configured, manual + scheduled uploads, in-app restore (#103)
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
2026-07-12 10:39:18 +02:00

79 lines
3.0 KiB
TypeScript

import { Client } from 'pg';
import { z } from 'zod';
/**
* The sidecar's read-only view of the backup-related instance settings
* (issue #103). The api owns the `instance_settings` registry; the sidecar
* reads the raw rows with the same defaults, so admin changes apply on the
* next run without a restart or a config channel. A row that is missing or
* fails validation falls back to its default — never to a crash.
*/
export const NEXTCLOUD_PASSWORD_SECRET_KEY = 'BACKUP_NEXTCLOUD_PASSWORD';
const SETTING_SCHEMAS = {
// Local retention: `null` means "no admin override" — the env value
// (BACKUP_RETENTION_DAYS, stage-specific) stays authoritative until a
// Site Admin saves the setting once.
'backup.localRetentionDays': z.number().int().min(1).nullable().default(null),
'backup.remoteRetentionDays': z.number().int().min(1).default(30),
'backup.nextcloud.enabled': z.boolean().default(false),
'backup.nextcloud.baseUrl': z.string().default(''),
'backup.nextcloud.username': z.string().default(''),
'backup.nextcloud.folder': z.string().default('dorfteich-backups'),
'backup.nextcloud.uploadSchedule': z.enum(['off', 'daily', 'weekly']).default('daily'),
} as const;
export interface BackupDbSettings {
localRetentionDays: number | null;
remoteRetentionDays: number;
nextcloud: {
enabled: boolean;
baseUrl: string;
username: string;
folder: string;
uploadSchedule: 'off' | 'daily' | 'weekly';
};
}
export function parseBackupSettings(rows: { key: string; value: unknown }[]): BackupDbSettings {
const byKey = new Map(rows.map((row) => [row.key, row.value]));
const get = <K extends keyof typeof SETTING_SCHEMAS>(
key: K,
): z.infer<(typeof SETTING_SCHEMAS)[K]> => {
const parsed = SETTING_SCHEMAS[key].safeParse(byKey.get(key));
return parsed.success ? parsed.data : SETTING_SCHEMAS[key].parse(undefined);
};
return {
localRetentionDays: get('backup.localRetentionDays'),
remoteRetentionDays: get('backup.remoteRetentionDays'),
nextcloud: {
enabled: get('backup.nextcloud.enabled'),
baseUrl: get('backup.nextcloud.baseUrl'),
username: get('backup.nextcloud.username'),
folder: get('backup.nextcloud.folder'),
uploadSchedule: get('backup.nextcloud.uploadSchedule'),
},
};
}
/**
* Reads the settings rows with a short-lived connection. A database that is
* unreachable or predates the settings keys yields plain defaults — the
* local backup must still run when the instance is at its most broken.
*/
export async function readBackupDbSettings(databaseUrl: string): Promise<BackupDbSettings> {
const client = new Client({ connectionString: databaseUrl });
try {
await client.connect();
const result = await client.query<{ key: string; value: unknown }>(
`SELECT key, value FROM instance_settings WHERE key LIKE 'backup.%'`,
);
return parseBackupSettings(result.rows);
} catch {
return parseBackupSettings([]);
} finally {
await client.end().catch(() => undefined);
}
}