1import { Database } from "bun:sqlite";2import { beforeAll, describe, expect, test } from "bun:test";3import { cp, mkdir, mkdtemp, readFile, writeFile } from "node:fs/promises";4import { tmpdir } from "node:os";5import { join } from "node:path";6import { deflateSync } from "node:zlib";7import { type Bucket, openBucket } from "../src/bucket/reader.ts";8import { syncAll, syncRepo } from "../src/bucket/sync.ts";9import {10 fileAt,11 filesAt,12 flagReason,13 headId,14 history,15 objectBytes,16 repoStats,17 saveByPrefix,18 timeline,19} from "../src/mirror/queries.ts";20import { mirrorState, openMirror } from "../src/mirror/store.ts";21import { openKeprDb } from "../src/server/db.ts";22import { Browser, instance } from "./browser.ts";23import { type Fixture, makeKohBucket } from "./fixture.ts";2425const text = (bytes: Uint8Array | null) => new TextDecoder().decode(bytes ?? new Uint8Array());2627async function syncTarget(fx: Fixture) {28 const dataDir = await mkdtemp(join(tmpdir(), "kepr-data-"));29 const target = {30 bucket: openBucket({ kind: "folder", path: fx.bucketDir }),31 kepr: openKeprDb(dataDir),32 mirrorDir: join(dataDir, "mirror"),33 };34 return { ...target, mirror: () => openMirror(target.mirrorDir, fx.repo) };35}3637describe("a first sync of a koh3 bucket", () => {38 let fx: Fixture;39 let t: Awaited<ReturnType<typeof syncTarget>>;40 beforeAll(async () => {41 fx = await makeKohBucket();42 t = await syncTarget(fx);43 await syncAll(t);44 });45 const [head, checkpoint, second, first] = [0, 1, 2, 3].map((i) => () => fx.saveIds[i] as string);4647 test("registers the repo private, with a clean last sync", () => {48 const row = t.kepr.query("SELECT public, last_sync_at, last_sync_error FROM repos").get() as {49 public: number;50 last_sync_at: number;51 last_sync_error: string | null;52 };53 expect(row.public).toBe(0);54 expect(row.last_sync_error).toBeNull();55 expect(row.last_sync_at).toBeGreaterThan(0);56 });5758 test("history is newest first and leaves out the checkpoint", () => {59 expect(headId(t.mirror())).toBe(head());60 expect(history(t.mirror(), 10, 0).map((s) => s.id)).toEqual([head(), second(), first()]);61 expect(history(t.mirror(), 1, 1).map((s) => s.message)).toEqual(["add readme and entry point"]);62 expect(timeline(t.mirror()).map((s) => s.id)).toEqual([first(), second(), head()]);63 expect(saveByPrefix(t.mirror(), checkpoint())?.is_checkpoint).toBe(true);64 });6566 test("finds a save by a unique prefix of six or more characters", () => {67 const save = saveByPrefix(t.mirror(), second().slice(0, 6));68 expect([save?.id, save?.agent, save?.session]).toEqual([second(), "test-agent", "fixture"]);69 expect(saveByPrefix(t.mirror(), second().slice(0, 5))).toBeNull();70 expect(saveByPrefix(t.mirror(), "zzzzzz")).toBeNull();71 });7273 test("reads files and their bytes at any save", () => {74 const paths = filesAt(t.mirror(), head()).map((f) => f.path);75 expect(paths).toContain("src/lib/deep/util.ts");76 const now = fileAt(t.mirror(), head(), "src/main.ts");77 const then = fileAt(t.mirror(), second(), "src/main.ts");78 expect(text(objectBytes(t.mirror(), now?.hash as string))).toContain("hello");79 expect(text(objectBytes(t.mirror(), then?.hash as string))).toContain("'hi'");80 expect(fileAt(t.mirror(), first(), "src/main.ts")).toBeNull();81 expect(fileAt(t.mirror(), head(), "docs/logo.png")?.size).toBe(70);82 });8384 test("counts saves without checkpoints, and lines and language at head", () => {85 const stats = repoStats(t.mirror());86 expect(stats.saves).toBe(3);87 expect(stats.language).toBe("TypeScript");88 89 90 expect(stats.lines).toBe(4);91 expect(stats.updated).toBe(saveByPrefix(t.mirror(), head())?.created_at ?? -1);92 });9394 test("stores the flag event", () => {95 const flag = t.mirror().query("SELECT kind, save_id, reason FROM events").get();96 expect(flag).toEqual({ kind: "flag", save_id: first(), reason: "holds a secret" });97 });9899 test("a save's flag state is its newest flag or clear event, by time and then ID", async () => {100 expect(flagReason(t.mirror(), first())).toBe("holds a secret");101 expect(flagReason(t.mirror(), head())).toBeNull();102 const mirror = openMirror(await mkdtemp(join(tmpdir(), "kepr-flags-")), "flags");103 const event = mirror.query(104 "INSERT INTO events (id, kind, save_id, reason, created_at, machine) VALUES (?, ?, 'aaaaaaaaaaaa', ?, ?, 'm')",105 );106 event.run("000000000001", "flag", "first", 10);107 expect(flagReason(mirror, "aaaaaaaaaaaa")).toBe("first");108 event.run("000000000002", "clear", null, 20);109 expect(flagReason(mirror, "aaaaaaaaaaaa")).toBeNull();110 111 event.run("000000000003", "flag", "again", 20);112 expect(flagReason(mirror, "aaaaaaaaaaaa")).toBe("again");113 event.run("000000000000", "clear", null, 20);114 expect(flagReason(mirror, "aaaaaaaaaaaa")).toBe("again");115 });116117 test("a strip reaches the mirror and drops the object", async () => {118 const secret = fileAt(t.mirror(), head(), "secret.txt")?.hash as string;119 expect(objectBytes(t.mirror(), secret)).not.toBeNull();120 await fx.strip("secret.txt");121 await syncAll(t);122 for (const id of fx.saveIds) expect(fileAt(t.mirror(), id, "secret.txt")).toBeNull();123 expect(objectBytes(t.mirror(), secret)).toBeNull();124 expect(fileAt(t.mirror(), head(), "src/main.ts")).not.toBeNull();125 });126});127128test("a sync lands history in batches, so one cut short resumes where it stopped", async () => {129 const fx = await makeKohBucket("batched");130 const bucket = openBucket({ kind: "folder", path: fx.bucketDir });131 const mirror = openMirror(await mkdtemp(join(tmpdir(), "kepr-mirror-")), fx.repo);132 133 const failing: Bucket = {134 ...bucket,135 get: (key) =>136 key.includes("/objects/") && mirrorState(mirror, "head") !== null137 ? Promise.reject(new Error("connection reset"))138 : bucket.get(key),139 };140 await expect(syncRepo(failing, mirror, fx.repo, [], 1)).rejects.toThrow("connection reset");141 const first = fx.saveIds[3] as string;142 expect(mirrorState(mirror, "head")).toBe(first);143 expect(history(mirror, 10, 0).map((s) => s.id)).toEqual([first]);144145 await syncRepo(bucket, mirror, fx.repo, [], 1);146 expect(headId(mirror)).toBe(fx.saveIds[0] as string);147 expect(history(mirror, 10, 0)).toHaveLength(3);148 expect(flagReason(mirror, first)).toBe("holds a secret");149});150151test("a save larger than a batch is stored ahead of itself, and a sync cut short within it resumes", async () => {152 const fx = await makeKohBucket("ahead");153 const bucket = openBucket({ kind: "folder", path: fx.bucketDir });154 const mirror = openMirror(await mkdtemp(join(tmpdir(), "kepr-mirror-")), fx.repo);155 let objectGets = 0;156 const failing: Bucket = {157 ...bucket,158 get: (key) =>159 key.includes("/objects/") && ++objectGets > 2160 ? Promise.reject(new Error("connection reset"))161 : bucket.get(key),162 };163 await expect(syncRepo(failing, mirror, fx.repo, [], 1)).rejects.toThrow("connection reset");164 const stored = () =>165 mirror.query<{ n: number }, []>("SELECT COUNT(*) AS n FROM objects").get()?.n;166 expect(mirrorState(mirror, "head")).toBeNull();167 expect(stored()).toBe(2);168169 await syncRepo(bucket, mirror, fx.repo, [], 1);170 expect(headId(mirror)).toBe(fx.saveIds[0] as string);171 expect(history(mirror, 10, 0)).toHaveLength(3);172 const guide = fileAt(mirror, fx.saveIds[0] as string, "docs/guide.md");173 expect(text(objectBytes(mirror, guide?.hash as string))).toBe(174 "# Guide\n\nRead me. It is short.\n",175 );176});177178test("a new save syncs incrementally and a bad format is recorded as the last sync error", async () => {179 const fx = await makeKohBucket("growing");180 const t = await syncTarget(fx);181 await syncAll(t);182 await writeFile(join(fx.repoDir, "new.txt"), "new\n");183 Bun.spawnSync(["koh3", "save", "add new"], {184 cwd: fx.repoDir,185 env: { PATH: process.env.PATH, HOME: join(fx.repoDir, "../../home"), NO_COLOR: "1" },186 });187 await syncAll(t);188 expect(history(t.mirror(), 1, 0)[0]?.message).toBe("add new");189190 await writeFile(join(fx.bucketDir, fx.repo, "format"), "koh-remote 2");191 await syncAll(t);192 const row = t.kepr.query("SELECT last_sync_error FROM repos").get() as {193 last_sync_error: string;194 };195 expect(row.last_sync_error).toContain('remote format "koh-remote 2"');196});197198test("a whole-history strip reaches every save, those arriving after it too, whatever their time (§10.2)", async () => {199 const fx = await makeKohBucket("late");200 const view = await mkdtemp(join(tmpdir(), "kepr-view-"));201 const viewRepo = join(view, fx.repo);202 await cp(join(fx.bucketDir, fx.repo), viewRepo, { recursive: true });203 204 205 await mkdir(join(viewRepo, "events"), { recursive: true });206 await writeFile(207 join(viewRepo, "events", "0000000000bb"),208 JSON.stringify({209 id: "0000000000bb",210 kind: "strip",211 save_id: "",212 path: "secret.txt",213 reason: "a secret got saved",214 created_at: 1,215 machine: "elsewhere",216 }),217 );218 const oldest = fx.saveIds.at(-1) as string;219 const newest = fx.saveIds[0] as string;220 221 await writeFile(join(viewRepo, "head"), oldest);222 const t = await syncTarget({ ...fx, bucketDir: view });223 await syncAll(t);224 expect(fileAt(t.mirror(), oldest, "secret.txt")).toBeNull();225 226 await writeFile(join(viewRepo, "head"), newest);227 await syncAll(t);228 expect(headId(t.mirror())).toBe(newest);229 for (const id of fx.saveIds) expect(fileAt(t.mirror(), id, "secret.txt")).toBeNull();230 expect(fileAt(t.mirror(), newest, "src/main.ts")).not.toBeNull();231});232233describe("the mirror's schema version", () => {234 test("a version 2 mirror reopens and any other version is refused as disposable", async () => {235 const dir = await mkdtemp(join(tmpdir(), "kepr-mirror-"));236 const created = openMirror(dir, "one");237 created.run("PRAGMA wal_checkpoint(TRUNCATE)");238 await Bun.write(join(dir, "copy.db"), Bun.file(join(dir, "one.db")));239 expect(openMirror(dir, "copy").query("PRAGMA user_version").get()).toEqual({240 user_version: 2,241 });242243 for (const version of [1, 3]) {244 const other = new Database(join(dir, `v${version}.db`));245 other.run(`PRAGMA user_version = ${version}`);246 other.close();247 expect(() => openMirror(dir, `v${version}`)).toThrow("disposable");248 }249 });250});251252test("a strip that arrives older than the saves already mirrored still strips them (§10.2, R6)", async () => {253 const fx = await makeKohBucket("older-strip");254 const t = await syncTarget(fx);255 await syncAll(t);256 257 for (const id of fx.saveIds) expect(fileAt(t.mirror(), id, "secret.txt")).not.toBeNull();258259 260 261 262 const events = join(fx.bucketDir, fx.repo, "events");263 await mkdir(events, { recursive: true });264 await writeFile(265 join(events, "0000000000aa"),266 JSON.stringify({267 id: "0000000000aa",268 kind: "strip",269 save_id: "",270 path: "secret.txt",271 reason: "a secret got saved",272 created_at: 1,273 machine: "elsewhere",274 }),275 );276 await syncAll(t);277278 for (const id of fx.saveIds) expect(fileAt(t.mirror(), id, "secret.txt")).toBeNull();279 expect(fileAt(t.mirror(), fx.saveIds[0] as string, "src/main.ts")).not.toBeNull();280});281282test("a save with an unsafe path lands without it, keeps syncing, and the admin status names it (A3)", async () => {283 const fx = await makeKohBucket("quarantine");284 const head = fx.saveIds[0] as string;285 const key = join(fx.bucketDir, fx.repo, "saves", head);286 const record = JSON.parse(await readFile(key, "utf8"));287 record.files.push({ ...record.files[0], path: "Icon\r" });288 await writeFile(key, JSON.stringify(record));289 const inst = await instance(fx.bucketDir);290 const mirror = openMirror(join(inst.dataDir, "mirror"), fx.repo);291 expect(inst.kepr.query("SELECT last_sync_error FROM repos").get()).toEqual({292 last_sync_error: null,293 });294 expect(filesAt(mirror, head).map((file) => file.path)).toContain("README.md");295 expect(filesAt(mirror, head).map((file) => file.path)).not.toContain("Icon\r");296297 await writeFile(join(fx.repoDir, "later.txt"), "later\n");298 const env = { PATH: process.env.PATH, HOME: join(fx.repoDir, "../../home"), NO_COLOR: "1" };299 Bun.spawnSync(["koh3", "save", "a later save"], { cwd: fx.repoDir, env });300 Bun.spawnSync(["koh3", "offer"], { cwd: fx.repoDir, env });301 await syncAll({302 bucket: openBucket({ kind: "folder", path: fx.bucketDir }),303 kepr: inst.kepr,304 mirrorDir: join(inst.dataDir, "mirror"),305 });306 expect(history(mirror, 1, 0)[0]?.message).toBe("a later save");307308 const browser = new Browser(inst.app);309 await browser.signIn();310 const page = await (await browser.get("/admin/repos")).text();311 expect(page).toContain("1 path quarantined: Icon\\x0d");312});313314test("a strip event with an illegal path is ignored, as Koh ignores it (§5.5)", async () => {315 const fx = await makeKohBucket("illegal-strip");316 for (const [id, path] of [317 ["aaaaaaaaaaaa", "src//"],318 ["bbbbbbbbbbbb", ""],319 ["cccccccccccc", "src\ud800"],320 ]) {321 const event = { id, kind: "strip", save_id: "", path, reason: "", created_at: 1, machine: "x" };322 await writeFile(join(fx.bucketDir, fx.repo, "events", id as string), JSON.stringify(event));323 }324 const t = await syncTarget(fx);325 await syncAll(t);326 expect(t.kepr.query("SELECT last_sync_error FROM repos").get()).toEqual({327 last_sync_error: null,328 });329 expect(filesAt(t.mirror(), fx.saveIds[0] as string).map((file) => file.path)).toContain(330 "src/main.ts",331 );332});333334test("an object that inflates past 512 MiB is quarantined without stopping the sync (A3)", async () => {335 const fx = await makeKohBucket("oversized");336 const head = fx.saveIds[0] as string;337 const key = join(fx.bucketDir, fx.repo, "saves", head);338 const record = JSON.parse(await readFile(key, "utf8"));339 const hash = "ab".repeat(32);340 record.files.push({ path: "huge.bin", hash, executable: false });341 await writeFile(key, JSON.stringify(record));342 await writeFile(343 join(fx.bucketDir, fx.repo, "objects", hash),344 deflateSync(new Uint8Array(512 * 1024 * 1024 + 1)),345 );346 const t = await syncTarget(fx);347 await syncAll(t);348 expect(t.kepr.query("SELECT last_sync_error FROM repos").get()).toEqual({349 last_sync_error: null,350 });351 expect(filesAt(t.mirror(), head).map((file) => file.path)).not.toContain("huge.bin");352 expect(JSON.parse(mirrorState(t.mirror(), "quarantined") ?? "[]")).toEqual(["huge.bin"]);353});354355test("the line count skips a file over 8 MiB (A3)", async () => {356 const fx = await makeKohBucket("large-text");357 const t = await syncTarget(fx);358 await syncAll(t);359 const before = repoStats(t.mirror()).lines;360 await writeFile(join(fx.repoDir, "big.txt"), "x\n".repeat(4.5 * 1024 * 1024));361 const env = { PATH: process.env.PATH, HOME: join(fx.repoDir, "../../home"), NO_COLOR: "1" };362 Bun.spawnSync(["koh3", "save", "add a big text file"], { cwd: fx.repoDir, env });363 Bun.spawnSync(["koh3", "offer"], { cwd: fx.repoDir, env });364 await syncAll(t);365 expect(history(t.mirror(), 1, 0)[0]?.message).toBe("add a big text file");366 expect(repoStats(t.mirror()).lines).toBe(before);367});