dorfteich/apps/backup/src/settings.test.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

93 lines
3.1 KiB
TypeScript

import { describe, expect, it } from 'vitest';
import { parseCommand } from './commands.js';
import { resolveRemoteTarget } from './remote.js';
import { parseBackupSettings } from './settings.js';
describe('parseBackupSettings', () => {
it('returns pure defaults for a database without the keys', () => {
expect(parseBackupSettings([])).toEqual({
localRetentionDays: null,
remoteRetentionDays: 30,
nextcloud: {
enabled: false,
baseUrl: '',
username: '',
folder: 'dorfteich-backups',
uploadSchedule: 'daily',
},
});
});
it('applies stored rows and falls back per key on invalid values', () => {
const settings = parseBackupSettings([
{ key: 'backup.localRetentionDays', value: 14 },
{ key: 'backup.remoteRetentionDays', value: 'not-a-number' },
{ key: 'backup.nextcloud.enabled', value: true },
{ key: 'backup.nextcloud.baseUrl', value: 'https://cloud.example.com' },
{ key: 'backup.nextcloud.username', value: 'backupuser' },
{ key: 'backup.nextcloud.uploadSchedule', value: 'weekly' },
]);
expect(settings.localRetentionDays).toBe(14);
expect(settings.remoteRetentionDays).toBe(30);
expect(settings.nextcloud).toMatchObject({
enabled: true,
baseUrl: 'https://cloud.example.com',
username: 'backupuser',
uploadSchedule: 'weekly',
});
});
});
describe('resolveRemoteTarget', () => {
const settings = parseBackupSettings([
{ key: 'backup.nextcloud.enabled', value: true },
{ key: 'backup.nextcloud.baseUrl', value: 'https://cloud.example.com' },
{ key: 'backup.nextcloud.username', value: 'backupuser' },
]);
it('combines settings with the secret-store app password', () => {
expect(resolveRemoteTarget(settings, { BACKUP_NEXTCLOUD_PASSWORD: 'app-pass' })).toEqual({
baseUrl: 'https://cloud.example.com',
username: 'backupuser',
password: 'app-pass',
folder: 'dorfteich-backups',
});
});
it('is null when disabled or incompletely configured', () => {
expect(resolveRemoteTarget(settings, {})).toBeNull();
expect(
resolveRemoteTarget(parseBackupSettings([]), { BACKUP_NEXTCLOUD_PASSWORD: 'app-pass' }),
).toBeNull();
});
});
describe('parseCommand', () => {
it('parses run and restore commands', () => {
expect(parseCommand('{"kind":"run","requestedBy":"admin"}')).toEqual({
kind: 'run',
requestedBy: 'admin',
});
expect(
parseCommand('{"kind":"restore","source":"remote","backupId":"20260712-030000"}'),
).toEqual({
kind: 'restore',
source: 'remote',
backupId: '20260712-030000',
requestedBy: null,
});
});
it('rejects malformed payloads and bad backup ids', () => {
expect(parseCommand('not json')).toBeNull();
expect(parseCommand('{"kind":"nuke"}')).toBeNull();
expect(
parseCommand('{"kind":"restore","source":"remote","backupId":"../../etc/passwd"}'),
).toBeNull();
expect(
parseCommand('{"kind":"restore","source":"elsewhere","backupId":"20260712-030000"}'),
).toBeNull();
});
});