dorfteich/apps/backup/src/perform-restore.ts
Claude Opus 5 b96997501a
All checks were successful
CI / Build container images (pull_request) Successful in 3m53s
CI / Auth e2e pack (pull_request) Successful in 8m42s
CI / Auth e2e pack (push) Successful in 8m41s
CI / Lint, typecheck, test (pull_request) Successful in 6m30s
CI / Import/export fidelity gate (pull_request) Successful in 58s
CD / Build and push images (push) Successful in 18s
CD / Smoke tests against Test (push) Successful in 1m19s
CD / Deploy to Test (push) Successful in 16s
CD / Promote to Int (push) Successful in 12s
CI / Lint, typecheck, test (push) Successful in 6m41s
CI / Build container images (push) Has been skipped
CI / Import/export fidelity gate (push) Successful in 52s
#303: operator-uploaded fonts — storage, API, PDF embedding, backup
An operator holding a font licence could only use it by baking the file
into a custom image, which tied every change to a rebuild and left the
file out of the backup.

ADR 0016 said there is no runtime font management. It also listed this
exact case under "Alternatives considered" — *may become a Site-Admin-
level feature later*. The amendment takes that option and answers the two
objections it raised: licensing risk (Site Admins only, licence recorded
with the family) and file-format attack surface (magic-byte check and a
size cap, never a parse).

- `CUSTOM_FONTS_DIR` (default `./data/fonts`) — a sibling of uploads and
  plugins, NOT inside the image-baked `FONTS_DIR`, where a deploy would
  overwrite it and no backup would ever see it.
- One list of data directories (`apps/backup/src/data-dirs.ts`) now feeds
  both the nightly archive and the restore, so they cannot drift. #306 and
  #307 add one line each instead of a second mechanism.
- Both Dockerfiles bake the path. The backup image sets its volume paths
  itself ("self-sufficient without compose env" — #71's lesson) and reads
  no *_DIR from compose; without the ENV entry the archive would have
  skipped the directory silently.
- The PDF path already read WOFF2 from disk at request time, so it only
  had to pick the other base directory for a custom family.
- `fontStack`/`fontEntry` take the instance's uploaded families as an
  argument — they are runtime data. The catalog is searched first, and a
  colliding family name is rejected at upload, so a custom font can never
  shadow a catalog one.
- Deletion is never blocked by usage: an unknown family already falls back
  to the system stack, so affected ponds degrade instead of breaking. The
  count of affected ponds travels into the audit entry.
- Audit catalogue v1.6 (`font.uploaded`, `font.deleted`).

Verified: api full suite against a fresh database, 102 files / 571 tests.
The upload suite writes into a real temp directory and reads the bytes
back off disk, so the storage layer is exercised rather than mocked.
2026-08-01 14:49:13 +02:00

39 lines
1.4 KiB
TypeScript

import { existsSync } from 'node:fs';
import { join } from 'node:path';
import type { BackupEnv } from '@dorfteich/shared';
import { extractArchive } from './archive.js';
import { archiveFileName, dumpFileName } from './backup-set.js';
import { dataDirs } from './data-dirs.js';
import { pgRestore } from './pg.js';
import type { RemoteLogger } from './remote.js';
/**
* Restores one local set into the live database and data volumes:
* `pg_restore --clean --if-exists` of the dump, then the volume archive
* back over the data mounts (see data-dirs.ts). Shared by the operator CLI
* (restore.js via restore.sh) and the in-app restore orchestrator (#103) —
* one restore path, exercised by drills and the app alike.
*/
export async function performRestore(
env: Pick<
BackupEnv,
'BACKUPS_DIR' | 'DATABASE_URL' | 'UPLOADS_DIR' | 'PLUGINS_DIR' | 'CUSTOM_FONTS_DIR'
>,
backupId: string,
log: RemoteLogger,
): Promise<void> {
const dumpFile = join(env.BACKUPS_DIR, dumpFileName(backupId));
const archiveFile = join(env.BACKUPS_DIR, archiveFileName(backupId));
for (const file of [dumpFile, archiveFile]) {
if (!existsSync(file)) {
throw new Error(`restore set is incomplete — ${file} not found`);
}
}
log.info({ backupId }, 'restoring database dump');
await pgRestore(env.DATABASE_URL, dumpFile);
log.info({ backupId }, 'restoring the data-directory archive');
await extractArchive(archiveFile, dataDirs(env));
}