app/lib/backup-checks.ts

Functions

Imports

It imports no other module of this repo. Imported by app/lib/backup.server.ts, workers/app.ts.

Source

1// What Carrel's nightly dump must leave out and carry, for d1-dump's runCheckedBackup, which runs the
2// standard checks (not empty, nothing excluded present, every required table there) and this one.
3
4import type { DumpResult } from "@dustinedwards/d1-dump";
5
6/** The cron expression that runs the nightly dump; the other cron in wrangler.jsonc.example runs the rest. */
7export const BACKUP_CRON = "17 3 * * *";
8
9/**
10 * Tables that hold a live credential or a one-time token, which a backup bucket must never carry.
11 * google_tokens: Dustin's drive.file refresh token (encrypted, but still a live credential).
12 * google_oauth_states: the one-time `state` values of an OAuth sign-in in flight.
13 * test/backup.test.ts derives the credential-shaped tables from drizzle/ and fails if one is neither
14 * excluded here nor on the reviewed list in that test.
15 */
16export const EXCLUDED_TABLES = ["google_tokens", "google_oauth_states"] as const;
17
18/** Tables that exist nowhere else: the authorship record and the AI drafts saved beside Dustin's. */
19export const REQUIRED_TABLES = ["authorship", "ai_drafts"] as const;
20
21/** Carrel cannot run without its Owner, so a dump with no people row is an emptied or wrong database. */
22function ownerProblems(dump: DumpResult): string[] {
23  const people = dump.tables.find((t) => t.name === "people")?.rows ?? 0;
24  return people > 0 ? [] : ["the dump holds no people, so not even the Owner"];
25}
26
27export const BACKUP_OPTIONS = { exclude: [...EXCLUDED_TABLES], required: [...REQUIRED_TABLES], check: ownerProblems };