store.ts

1import { Database } from "bun:sqlite";2import { mkdirSync } from "node:fs";3import { join } from "node:path";4import { inflateSync } from "node:zlib";5import type { EventRecord, ReleaseRecord, SaveRecord } from "../bucket/repo.ts";6import { isTestPath } from "../describe/links.ts";78// Koh 3's schema (§5.1, `src/storage/storage.v`) minus `file_cache`, which only a working tree needs,9// plus `releases`: each version's release.json (§11.2) as read from the bucket, since that is bucket10// data too and pages and feeds need it on every request.11const SCHEMA_VERSION = 2;12const SCHEMA = `13CREATE TABLE objects (14	hash TEXT PRIMARY KEY,15	size INTEGER NOT NULL,16	data BLOB NOT NULL17);18CREATE TABLE saves (19	id            TEXT PRIMARY KEY,20	parent        TEXT REFERENCES saves(id),21	message       TEXT NOT NULL,22	created_at    INTEGER NOT NULL,23	machine       TEXT NOT NULL,24	is_checkpoint INTEGER NOT NULL DEFAULT 0,25	size_bytes    INTEGER NOT NULL DEFAULT 0,26	agent         TEXT,27	session       TEXT,28	restores      TEXT,29	replayed_from TEXT30);31CREATE TABLE save_files (32	save_id    TEXT NOT NULL REFERENCES saves(id),33	path       TEXT NOT NULL,34	hash       TEXT NOT NULL REFERENCES objects(hash),35	executable INTEGER NOT NULL DEFAULT 0,36	PRIMARY KEY (save_id, path)37);38CREATE TABLE events (39	id         TEXT PRIMARY KEY,40	kind       TEXT NOT NULL,41	save_id    TEXT,42	path       TEXT,43	reason     TEXT,44	created_at INTEGER NOT NULL,45	machine    TEXT NOT NULL46);47CREATE TABLE state (48	key   TEXT PRIMARY KEY,49	value TEXT NOT NULL50);51CREATE TABLE releases (52	version TEXT PRIMARY KEY,53	record  TEXT NOT NULL54);55CREATE INDEX saves_parent ON saves(parent);56CREATE INDEX save_files_hash ON save_files(hash);57`;5859/** An object as the bucket stores it: zlib bytes, already checked against its hash. */60export type StoredObject = { compressed: Uint8Array; size: number };6162/** What one sync brings in, landed in one transaction. Saves are oldest first. */63export type Landing = {64	head: string;65	releasesLatest: string;66	saves: SaveRecord[];67	objects: Map<string, StoredObject>;68	events: EventRecord[];69	releases: ReleaseRecord[];70	/** Escaped names of the paths these saves arrived without (§5.5, A3). */71	quarantined: string[];72	/** The operator's hidden paths (June, 2026-09-30), removed from every save like a strip. */73	hidden: string[];74};7576// A recount inflates every file at the newest save; a file this large is data, not lines of code.77const MAX_COUNTED = 8 * 1024 * 1024;7879// Display names for the header's language, by extension; data and docs formats never count.80const LANGUAGES: Record<string, string> = {81	ts: "TypeScript",82	tsx: "TypeScript",83	js: "JavaScript",84	mjs: "JavaScript",85	zig: "Zig",86	v: "V",87	rs: "Rust",88	go: "Go",89	py: "Python",90	c: "C",91	h: "C",92	cpp: "C++",93	cc: "C++",94	hpp: "C++",95	swift: "Swift",96	kt: "Kotlin",97	java: "Java",98	rb: "Ruby",99	lua: "Lua",100	sh: "Shell",101	nix: "Nix",102	css: "CSS",103	html: "HTML",104};105106// Vendored code is someone else's: counting Koh 3's bundled SQLite made it read as 290k lines of C.107const VENDORED = /(^|\/)(vendor|third_party|node_modules)\//;108// Bumped when what counts as a line changes, so every mirror recounts once when it opens.109const STATS_RULE = "source-only";110111const open = new Map<string, Database>();112113/** The mirror of one repo at `<dir>/<repo>.db`, created on first use and kept open. */114export function openMirror(dir: string, repo: string): Database {115	const path = join(dir, `${repo}.db`);116	const cached = open.get(path);117	if (cached) return cached;118	mkdirSync(dir, { recursive: true });119	const db = new Database(path, { strict: true });120	db.run("PRAGMA journal_mode = WAL");121	db.run("PRAGMA foreign_keys = ON");122	db.run("PRAGMA busy_timeout = 5000");123	const { user_version } = db.query<{ user_version: number }, []>("PRAGMA user_version").get() ?? {124		user_version: 0,125	};126	if (user_version !== 0 && user_version !== SCHEMA_VERSION) {127		db.close();128		throw new Error(129			`${path} has mirror schema version ${user_version}; this Kepr reads version ${SCHEMA_VERSION}. ` +130				"The mirror is disposable: delete it and the next sync rebuilds it from the bucket.",131		);132	}133	if (user_version === 0) {134		db.transaction(() => {135			db.run(SCHEMA);136			db.run(`PRAGMA user_version = ${SCHEMA_VERSION}`);137		})();138	}139	// Mirrors counted under an older rule are recounted now, not at the next save.140	if (mirrorState(db, "head") && mirrorState(db, "stats_rule") !== STATS_RULE) refreshStats(db);141	open.set(path, db);142	return db;143}144145export function mirrorState(db: Database, key: string): string | null {146	const row = db147		.query<{ value: string }, [string]>("SELECT value FROM state WHERE key = ?")148		.get(key);149	return row?.value ?? null;150}151152export function knownSave(db: Database, id: string): boolean {153	return db.query("SELECT 1 FROM saves WHERE id = ?").get(id) !== null;154}155156export function knownObject(db: Database, hash: string): boolean {157	return db.query("SELECT 1 FROM objects WHERE hash = ?").get(hash) !== null;158}159160export function knownEventIds(db: Database): Set<string> {161	const rows = db.query<{ id: string }, []>("SELECT id FROM events").all();162	return new Set(rows.map((row) => row.id));163}164165/** Drops a version deleted from the bucket; a sync only ever adds releases. */166export function forgetRelease(db: Database, version: string): void {167	db.query("DELETE FROM releases WHERE version = ?").run(version);168}169170/** Replaces a version's record after Kepr rewrote it in the bucket. */171export function replaceRelease(db: Database, record: ReleaseRecord): void {172	db.query("UPDATE releases SET record = ? WHERE version = ?").run(173		JSON.stringify(record),174		record.version,175	);176}177178export function knownReleases(db: Database): Set<string> {179	const rows = db.query<{ version: string }, []>("SELECT version FROM releases").all();180	return new Set(rows.map((row) => row.version));181}182183/** Lands a sync like Koh's steal: objects, events, saves, then every strip over every save. */184export function land(db: Database, landing: Landing): void {185	const putObject = db.query("INSERT OR IGNORE INTO objects (hash, size, data) VALUES (?, ?, ?)");186	const putEvent = db.query(187		"INSERT OR IGNORE INTO events (id, kind, save_id, path, reason, created_at, machine) VALUES " +188			"(?, ?, ?, ?, ?, ?, ?)",189	);190	const putSave = db.query(191		`INSERT OR IGNORE INTO saves (id, parent, message, created_at, machine, is_checkpoint, size_bytes,192			agent, session, restores, replayed_from) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)`,193	);194	const putFile = db.query(195		"INSERT OR IGNORE INTO save_files (save_id, path, hash, executable) VALUES (?, ?, ?, ?)",196	);197	const putRelease = db.query("INSERT OR IGNORE INTO releases (version, record) VALUES (?, ?)");198	const setState = db.query("INSERT OR REPLACE INTO state (key, value) VALUES (?, ?)");199	db.transaction(() => {200		for (const [hash, object] of landing.objects)201			putObject.run(hash, object.size, object.compressed);202		for (const e of landing.events) {203			putEvent.run(e.id, e.kind, e.save_id, e.path, e.reason, e.created_at, e.machine);204		}205		for (const s of landing.saves) {206			putSave.run(207				s.id,208				s.parent === "" ? null : s.parent,209				s.message,210				s.created_at,211				s.machine,212				s.is_checkpoint ? 1 : 0,213				s.size_bytes,214				s.agent,215				s.session,216				s.restores,217				s.replayed_from,218			);219			for (const f of s.files) putFile.run(s.id, f.path, f.hash, f.executable ? 1 : 0);220		}221		for (const r of landing.releases) putRelease.run(r.version, JSON.stringify(r));222		applyStrips(db);223		let hidden = 0;224		for (const path of landing.hidden) hidden += removePath(db, path, "");225		if (hidden > 0) db.run("DELETE FROM objects WHERE hash NOT IN (SELECT hash FROM save_files)");226		// In the same transaction as the removal, so the tarball key never names a list the rows227		// don't reflect yet.228		setState.run("hidden", landing.hidden.join("\n"));229		setState.run("head", landing.head);230		setState.run("releases_latest", landing.releasesLatest);231		const quarantined = new Set([...quarantinedPaths(db), ...landing.quarantined]);232		setState.run("quarantined", JSON.stringify([...quarantined].sort()));233	})();234	// Outside the transaction: the recount can inflate megabytes and needs no lock to be correct.235	refreshStats(db);236}237238/** Escaped names of every path this mirror's saves arrived without. */239export function quarantinedPaths(db: Database): string[] {240	return JSON.parse(mirrorState(db, "quarantined") ?? "[]");241}242243// §10.2: a strip of one save reaches that save; a strip of every save bans its path from all of244// history, whenever a save was made or arrives. Re-applying every strip is harmless, which is how a245// save that arrives after its strip event is covered too.246function applyStrips(db: Database): void {247	const strips = db248		.query<{ save_id: string; path: string }, []>(249			"SELECT save_id, path FROM events WHERE kind = 'strip'",250		)251		.all();252	if (strips.length === 0) return;253	for (const strip of strips) removePath(db, strip.path, strip.save_id);254	db.run("DELETE FROM objects WHERE hash NOT IN (SELECT hash FROM save_files)");255}256257/** Removes a path, file or folder, from one save or ('') every save; returns the rows removed. */258function removePath(db: Database, path: string, save: string): number {259	// Koh compares the prefix exactly, never with LIKE, so `_` and `%` in a path match only themselves.260	const dir = `${path.replace(/\/+$/, "")}/`;261	return db262		.query(263			`DELETE FROM save_files264			WHERE (path = $path OR substr(path, 1, length($dir)) = $dir)265			AND ($save = '' OR save_id = $save)`,266		)267		.run({ path, dir, save }).changes;268}269270/**271 * Empties a mirror in place so the next sync rebuilds it from the bucket, as a change to the272 * hidden paths needs. The file and its open handles stay, so a request holding one reads an empty273 * repo for a moment rather than failing. A new epoch keeps tarballs kept before it from matching.274 */275export function clearMirror(db: Database): void {276	db.transaction(() => {277		// Children before parents, for the foreign keys; every name is a table of SCHEMA's.278		for (const table of ["save_files", "events", "saves", "objects", "releases", "state"]) {279			db.run(`DELETE FROM ${table}`);280		}281		db.query("INSERT INTO state (key, value) VALUES ('epoch', ?)").run(crypto.randomUUID());282	})();283}284285// Lines and languages never change between syncs, so they are counted once here, not per view. They286// come from the newest real save, not `head`: a checkpoint's files are not public history (§21.4).287// Lines are source lines: files in a known language, tests left out; docs and data never count.288function refreshStats(db: Database): void {289	const save =290		db291			.query<{ id: string }, []>(292				"SELECT id FROM saves WHERE is_checkpoint = 0 ORDER BY rowid DESC LIMIT 1",293			)294			.get()?.id ?? "";295	const files = db296		.query<{ path: string; size: number; data: Uint8Array }, [string]>(297			"SELECT f.path, o.size, o.data FROM save_files f JOIN objects o ON o.hash = f.hash WHERE f.save_id = ?",298		)299		.all(save);300	let lines = 0;301	const byLanguage = new Map<string, number>();302	for (const file of files) {303		const language = LANGUAGES[file.path.split(".").pop() ?? ""];304		// Tests are not the program: counted, Koh 3's read as 18k lines of V where it has 11k.305		if (!language || VENDORED.test(file.path) || isTestPath(file.path)) continue;306		if (file.size > MAX_COUNTED) continue;307		const bytes = inflateSync(file.data);308		if (bytes.includes(0)) continue;309		let count = 0;310		for (const byte of bytes) if (byte === 10) count++;311		if (bytes.length > 0 && bytes[bytes.length - 1] !== 10) count++;312		lines += count;313		byLanguage.set(language, (byLanguage.get(language) ?? 0) + count);314	}315	const languages = [...byLanguage].sort((a, b) => b[1] - a[1]);316	const setState = db.query("INSERT OR REPLACE INTO state (key, value) VALUES (?, ?)");317	setState.run("lines", String(lines));318	setState.run("language", languages[0]?.[0] ?? "");319	setState.run("languages", JSON.stringify(languages));320	setState.run("stats_save", save);321	setState.run("stats_rule", STATS_RULE);322}