1import { Database } from "bun:sqlite";2import { beforeAll, describe, expect, test } from "bun:test";3import { mkdir, mkdtemp, writeFile } from "node:fs/promises";4import { tmpdir } from "node:os";5import { join } from "node:path";6import type { Hono } from "hono";7import { openBucket } from "../src/bucket/reader.ts";8import { syncAll } from "../src/bucket/sync.ts";9import { fileAt, objectBytes, type Save } from "../src/mirror/queries.ts";10import { openMirror } from "../src/mirror/store.ts";11import { repoCards } from "../src/pages/library.ts";12import { timelineSvg } from "../src/pages/timeline.ts";13import { createApp } from "../src/server/app.ts";14import { openKeprDb } from "../src/server/db.ts";15import { type Fixture, makeKohBucket } from "./fixture.ts";1617let fx: Fixture;18let app: Hono;19let mirrorDir: string;20let tailSaves: string[];21const get = (path: string) => app.request(path);22const body = async (path: string) => (await get(path)).text();2324beforeAll(async () => {25 fx = await makeKohBucket();26 const secretRepo = await makeKohBucket("hidden");27 const large = await makeKohBucket("large");28 29 await writeFile(30 join(large.repoDir, "big.txt"),31 `${"a".repeat(1024 * 1024 - 1)}é${"b".repeat(1000)}\n`,32 );33 await writeFile(join(large.repoDir, "big.bin"), new Uint8Array(1024 * 1024 + 500).fill(0xff));34 Bun.spawnSync(["koh3", "save", "add large files"], {35 cwd: large.repoDir,36 env: { PATH: process.env.PATH, HOME: join(large.repoDir, "../../home"), NO_COLOR: "1" },37 });38 39 const tail = await makeKohBucket("tail");40 const tailEnv = { PATH: process.env.PATH, HOME: join(tail.repoDir, "../../home"), NO_COLOR: "1" };41 for (const [text, message] of [42 ["a\nb", "add tail"],43 ["a\nb\n", "end tail with a newline"],44 ["a\nb", "drop the newline"],45 ] as const) {46 await writeFile(join(tail.repoDir, "tail.txt"), text);47 Bun.spawnSync(["koh3", "save", message], { cwd: tail.repoDir, env: tailEnv });48 }49 tailSaves = JSON.parse(50 Bun.spawnSync(["koh3", "log", "--json"], { cwd: tail.repoDir, env: tailEnv }).stdout.toString(),51 ).saves.map((save: { id: string }) => save.id);52 const dataDir = await mkdtemp(join(tmpdir(), "kepr-pages-"));53 await mkdir(join(dataDir, "assets"));54 await writeFile(join(dataDir, "assets", "plain.txt"), "asset\n");55 const kepr = openKeprDb(dataDir);56 mirrorDir = join(dataDir, "mirror");57 for (const bucketDir of [fx.bucketDir, secretRepo.bucketDir, large.bucketDir, tail.bucketDir]) {58 const bucket = openBucket({ kind: "folder", path: bucketDir });59 await syncAll({ bucket, kepr, mirrorDir, tarballDir: join(dataDir, "tarballs") });60 }61 kepr.run(62 "UPDATE repos SET public = 1, install1 = 'nix profile add x', homepage = 'https://demo.example' WHERE name = 'demo'",63 );64 kepr.run("UPDATE repos SET public = 1 WHERE name IN ('large', 'tail')");65 app = createApp(66 {67 domain: "kepr.example",68 dataDir,69 adminPasswordHash: "$argon2id$x",70 bucket: { kind: "folder", path: fx.bucketDir },71 },72 kepr,73 );74});7576const [head, , second, first] = [0, 1, 2, 3].map((i) => () => fx.saveIds[i] as string);7778describe("the visibility gate", () => {79 test("a private repo and an unknown one are the same 404, everywhere", async () => {80 for (const suffix of ["", "/files/src/main.ts", "/raw/src/main.ts"]) {81 const hidden = await get(`/hidden${suffix}`);82 const missing = await get(`/nowhere${suffix}`);83 expect(hidden.status).toBe(404);84 expect(missing.status).toBe(404);85 expect((await hidden.text()).replaceAll("/hidden", "/nowhere")).toBe(await missing.text());86 }87 });88});8990describe("the repo page", () => {91 test("renders header, timeline, history and README at HEAD with a short cache", async () => {92 const response = await get("/demo");93 expect(response.status).toBe(200);94 expect(response.headers.get("cache-control")).toBe("public, max-age=60");95 const page = await response.text();96 expect(page).toContain('<h1 class="repo-name">demo</h1>');97 98 expect(/<div class="repo-desc"><p>(.*?)<\/p>/.exec(page)?.[1]).toBe(99 "A small repo for <strong>Kepr's</strong> tests.",100 );101 expect(page).toContain(102 '<meta property="og:description" content="A small repo for Kepr's tests.">',103 );104 expect(page).toContain('href="https://demo.example"');105 expect(page).toContain('<span class="lang-badge">TypeScript</span>');106 expect(page).toContain("3 saves");107 expect(page).toContain('data-copy="nix profile add x"');108 expect(page.match(/class="dot d\d"/g)?.length).toBe(3);109 expect(page).toContain("density = activity · position = time");110 const history = [...page.matchAll(/class="history-id">([0-9a-f]+)</g)].map((m) => m[1]);111 expect(history).toEqual([head(), second(), first()]);112 });113114 test("a page past the last, or too large to bind, is page 1", async () => {115 const history = (page: string) => [...page.matchAll(/class="history-id">([0-9a-f]+)</g)];116 for (const query of ["?page=2", `?page=${"9".repeat(400)}`, "?page=1e999", "?page=x"]) {117 const response = await get(`/demo${query}`);118 expect([query, response.status]).toEqual([query, 200]);119 expect(history(await response.text()).length).toBe(3);120 }121 });122123 test("checkpoints never appear", async () => {124 expect(await body("/demo")).not.toContain(fx.saveIds[1] as string);125 });126127 test("the README points relative links and images at raw files and drops unsafe links", async () => {128 const page = await body("/demo");129 expect(page).toContain('<a href="/demo/raw/docs/guide.md">the guide</a>');130 expect(page).toContain('<img src="/demo/raw/docs/logo.png" alt="logo">');131 expect(page).toContain('<a href="https://example.com">the site</a>');132 expect(page).not.toContain('href="javascript:');133 expect(page).toContain("<script>alert");134 expect(page).not.toContain("<script>alert");135 });136});137138describe("the timeline and card ticks", () => {139 140 const saves = [300, 100, 500, 200].map(141 (created_at, i): Save => ({142 id: `00000000000${i}`,143 parent: "",144 message: "m",145 created_at: created_at * 86400,146 machine: "m",147 agent: "",148 session: "",149 is_checkpoint: false,150 }),151 );152153 test("span from the earliest to the latest save, whatever the line's order", () => {154 const dots = [...timelineSvg("demo", saves).value.matchAll(/cx="([\d.]+)%"/g)].map((m) => m[1]);155 expect(dots).toEqual(["50.000", "1.000", "99.000", "25.500"]);156 const card = repoCards([157 {158 settings: { name: "demo", category: "", homepage: "", installLines: [] },159 mirror: new Database(":memory:"),160 stats: { saves: 4, lines: 0, language: "", updated: null },161 description: "",162 saves,163 },164 ]).value;165 const ticks = [...card.matchAll(/<line x1="([\d.]+)"/g)].map((m) => m[1]);166 expect(ticks).toEqual(["50.00", "1.00", "99.00", "25.50"]);167 });168});169170describe("the file viewer", () => {171 test("shows a file at HEAD and at an old save, with line anchors", async () => {172 const now = await get("/demo/files/src/main.ts");173 expect(now.headers.get("cache-control")).toBe("public, max-age=60");174 const nowPage = await now.text();175 expect(nowPage).toContain("hello");176 expect(nowPage).toContain(177 '<span class="line" id="L2"><a class="ln" href="#L2">2</a><span class="lc">',178 );179 expect(nowPage).toContain('class="tk-');180181 const then = await get(`/demo/files/src/main.ts?at=${second().slice(0, 6)}`);182 expect(then.headers.get("cache-control")).toBe("private, max-age=31536000");183 const thenPage = await then.text();184 expect(thenPage).toContain("'hi'");185 expect(thenPage).not.toContain("hello");186 expect(thenPage).toContain(`/demo/raw/src/main.ts?at=${second()}`);187 });188189 test("a file absent at that save, a bad save or an unsafe path is a 404", async () => {190 expect((await get(`/demo/files/src/main.ts?at=${first()}`)).status).toBe(404);191 expect((await get("/demo/files/src/main.ts?at=zzzzzz")).status).toBe(404);192 expect((await get("/demo/files/src/main.ts?at=abc")).status).toBe(404);193 expect((await get("/demo/files/src%2F..%2FREADME.md")).status).toBe(404);194 expect((await get("/demo/files/nothing.txt")).status).toBe(404);195 });196197 test("Markdown renders, with a source toggle", async () => {198 const rendered = await body("/demo/files/docs/guide.md");199 expect(rendered).toContain("<h1>Guide</h1>");200 const source = await body("/demo/files/docs/guide.md?view=source");201 expect(source).toContain('id="L1"');202 expect(source).not.toContain("<h1>Guide</h1>");203 });204205 test("an image displays inline from its raw file", async () => {206 expect(await body("/demo/files/docs/logo.png")).toContain('<img src="/demo/raw/docs/logo.png"');207 });208});209210describe("files over 1 MB", () => {211 test("text shows its first 1 MB with a raw link, even with a character cut at the mark", async () => {212 const page = await body("/large/files/big.txt");213 expect(page).toContain("showing the first 1 MB");214 expect(page).toContain('href="/large/raw/big.txt"');215 expect(page).not.toContain("bbb");216 const raw = await get("/large/raw/big.txt");217 expect(raw.headers.get("content-type")).toBe("text/plain; charset=utf-8");218 });219220 test("invalid UTF-8 without a NUL is binary, not text", async () => {221 const page = await body("/large/files/big.bin");222 expect(page).toContain("binary file");223 expect(page).not.toContain('class="code"');224 const raw = await get("/large/raw/big.bin");225 expect(raw.headers.get("content-type")).toBe("application/octet-stream");226 });227});228229describe("the Atlas", () => {230 231 const panelOf = (page: string, name: string) =>232 new RegExp(`data-name="${name}">.*?</a>\\n<template>(.*?)</template>`, "s").exec(page)?.[1] ??233 "";234 const rowOf = (page: string, name: string) =>235 new RegExp(`data-name="${name}">(.*?)</a>`, "s").exec(page)?.[1] ?? "";236237 test("sits between the timeline and History", async () => {238 const page = await body("/demo");239 const atlas = page.indexOf('id="atlas"');240 expect(page.indexOf('class="timeline"')).toBeLessThan(atlas);241 expect(atlas).toBeLessThan(page.indexOf('id="history"'));242 });243244 test("is a folder tree, folders first, then files, alphabetical", async () => {245 const names = [...(await body("/demo")).matchAll(/class="atlas-name">([^<]*)</g)].map(246 (m) => m[1],247 );248 expect(names).toEqual([249 "docs/",250 "guide.md",251 "logo.png",252 "src/",253 "lib/",254 "deep/",255 "util.ts",256 "main.ts",257 "vendor/",258 "big.c",259 ".kohignore",260 "README.md",261 "secret.txt",262 ]);263 });264265 test("rows carry the first sentence of the file's own comment, rendered, and link to the file", async () => {266 const page = await body("/demo");267 expect(rowOf(page, "util.ts")).toContain(268 '<span class="atlas-desc">The <em>one</em> helper.</span>',269 );270 expect(rowOf(page, "main.ts")).toContain("Entry point.");271 expect(rowOf(page, "guide.md")).toContain('<span class="atlas-desc">Read me.</span>');272 expect(rowOf(page, "secret.txt")).toContain('<span class="atlas-desc"></span>');273 expect(page).toContain(274 '<a class="atlas-row atlas-file" href="/demo/files/src/main.ts" data-name="main.ts">',275 );276 expect(panelOf(page, "util.ts")).toContain("<p>The <em>one</em> helper. Deep down.</p>");277 });278279 test("the panel counts only real saves, crediting a checkpoint's change to the next save", async () => {280 const page = await body("/demo");281 const main = panelOf(page, "main.ts");282 expect(main).toContain("<dt>lines</dt><dd>2</dd>");283 expect(main).toContain("<dt>saves</dt><dd>2</dd>");284 expect(main).toContain(`<dt>first save</dt><dd><a href="/demo/saves/${second()}">`);285 expect(main).toContain(`<dt>last save</dt><dd><a href="/demo/saves/${head()}">`);286 expect(main.indexOf(head())).toBeLessThan(main.lastIndexOf(second()));287 const guide = panelOf(page, "guide.md");288 expect(guide).toContain("<dt>saves</dt><dd>2</dd>");289 expect(guide).toContain(`<dt>last save</dt><dd><a href="/demo/saves/${head()}">`);290 expect(panelOf(page, "logo.png")).toContain("<dt>lines</dt><dd>binary</dd>");291 expect(page).not.toContain(fx.saveIds[1] as string);292 });293294 test("a folder's panel sums its files and counts the saves that touched anything under it", async () => {295 const page = await body("/demo");296 const folderPanel = (path: string) =>297 new RegExp(298 `data-path="${path}">\\n<summary.*?</summary>\\n<template>(.*?)</template>`,299 "s",300 ).exec(page)?.[1] ?? "";301 const docs = folderPanel("docs");302 expect(docs).toContain('<p class="atlas-info-path mono">docs</p>');303 expect(docs).toContain("<dt>lines</dt><dd>3</dd>");304 expect(docs).toContain("<dt>files</dt><dd>2</dd>");305 expect(docs).toContain("<dt>saves</dt><dd>2</dd>");306 expect(docs).toContain(`<dt>first save</dt><dd><a href="/demo/saves/${first()}">`);307 expect(docs).toContain(`<dt>last save</dt><dd><a href="/demo/saves/${head()}">`);308 const src = folderPanel("src");309 expect(src).toContain("<dt>saves</dt><dd>3</dd>");310 const recentIds = [311 ...(/<ul class="atlas-recent">(.*?)<\/ul>/s.exec(src)?.[1] ?? "").matchAll(312 /saves\/([0-9a-f]+)/g,313 ),314 ].map((m) => m[1]);315 expect(recentIds).toEqual([head(), second(), first()]);316 });317318 test("can be viewed at an older save, and an unknown save is a 404", async () => {319 const page = await body(`/demo?at=${second().slice(0, 8)}`);320 expect(page).toContain(`at <a href="/demo/saves/${second()}">${second()}</a>`);321 expect(page).toContain(`href="/demo/files/src/main.ts?at=${second()}"`);322 expect(panelOf(page, "main.ts")).toContain("<dt>saves</dt><dd>1</dd>");323 expect(panelOf(page, "main.ts")).not.toContain(head());324 const oldest = await body(`/demo?at=${first()}`);325 expect(oldest).not.toContain('data-name="main.ts"');326 expect((await get("/demo?at=abcdef")).status).toBe(404);327 expect((await get("/demo?at=../x")).status).toBe(404);328 });329});330331describe("the save page", () => {332 test("shows the save's facts and diffs against the previous real save, skipping the checkpoint", async () => {333 const response = await get(`/demo/saves/${head()}`);334 expect(response.status).toBe(200);335 expect(response.headers.get("cache-control")).toBe("public, max-age=60");336 const page = await response.text();337 expect(page).toContain('<h1 class="save-message-head">say hello</h1>');338 expect(page).toContain(339 `<dt>parent</dt><dd><a href="/demo/saves/${second()}">${second()}</a></dd>`,340 );341 expect(page).not.toContain(fx.saveIds[1] as string);342 expect(page).not.toContain("save-flag");343 344 const rows = [345 ...page.matchAll(346 /class="change-row change-(\w+)" href="#diff-\d"><span class="change-path">([^<]+)</g,347 ),348 ];349 expect(rows.map((m) => [m[1], m[2]])).toEqual([350 ["modified", "docs/guide.md"],351 ["modified", "src/main.ts"],352 ]);353 expect(page).toContain('<span class="diff-add">+1</span> <span class="diff-del">−1</span>');354 expect(page).toContain('<span class="dh">@@ -1,2 +1,2 @@</span>');355 expect(page).toContain(356 '<span class="dl dl-del"><span class="ln">2</span><span class="ln"></span><span class="ds">-</span>',357 );358 expect(page).toContain('class="tk-');359 expect(page).toContain(`href="/demo/archive/${head()}.tar.gz"`);360 expect(page).toContain(`href="/demo?at=${head()}#atlas"`);361 });362363 test("the first save diffs against nothing, notes binaries, and shows its flag and agent", async () => {364 const page = await body(`/demo/saves/${first()}`);365 expect(page).toContain('<span class="save-flag-label mono">flagged</span> holds a secret');366 expect(page).toContain("<dt>parent</dt><dd>none, the first save</dd>");367 expect(page).toContain(368 'change-added" href="#diff-2"><span class="change-path">docs/logo.png</span><span class="change-stat mono"><span class="diff-note">binary</span>',369 );370 expect(page).toContain("binary file, not shown");371 expect(page).toContain('<span class="dh">@@ -0,0 +1 @@</span>');372 const second_ = await body(`/demo/saves/${second()}`);373 expect(second_).toContain("<dt>agent</dt><dd>test-agent</dd><dt>session</dt><dd>fixture</dd>");374 expect(second_).not.toContain("save-flag");375 });376377 test("a change to the final newline alone is a changed last line, marked as in GNU diff", async () => {378 const marker = '<span class="dh">\\ No newline at end of file</span>';379 const row = (kind: string, a: string, b: string, sign: string) =>380 `<span class="dl dl-${kind}"><span class="ln">${a}</span><span class="ln">${b}</span><span class="ds">${sign}</span><span class="lc">b</span></span>`;381 const gained = await body(`/tail/saves/${tailSaves[1]}`);382 expect(gained).toContain('<span class="diff-add">+1</span> <span class="diff-del">−1</span>');383 expect(gained).toContain(`${row("del", "2", "", "-")}${marker}${row("add", "", "2", "+")}<`);384 const lost = await body(`/tail/saves/${tailSaves[0]}`);385 expect(lost).toContain(`${row("del", "2", "", "-")}${row("add", "", "2", "+")}${marker}`);386 });387388 test("a prefix redirects, and a checkpoint, an unknown or a private save is a 404", async () => {389 const short = await get(`/demo/saves/${head().slice(0, 6)}`);390 expect(short.status).toBe(302);391 expect(short.headers.get("location")).toBe(`/demo/saves/${head()}`);392 expect((await get(`/demo/saves/${fx.saveIds[1]}`)).status).toBe(404);393 expect((await get("/demo/saves/abcdef")).status).toBe(404);394 expect((await get("/demo/saves/abc")).status).toBe(404);395 expect((await get(`/hidden/saves/${head()}`)).status).toBe(404);396 });397});398399describe("raw files", () => {400 test("are the exact object bytes, text as text/plain", async () => {401 const mirror = openMirror(mirrorDir, "demo");402 for (const [path, type] of [403 ["src/main.ts", "text/plain; charset=utf-8"],404 ["docs/logo.png", "image/png"],405 ["README.md", "text/plain; charset=utf-8"],406 ] as const) {407 const response = await get(`/demo/raw/${path}`);408 const file = fileAt(mirror, head(), path);409 expect(response.headers.get("content-type")).toBe(type);410 expect(new Uint8Array(await response.arrayBuffer())).toEqual(411 objectBytes(mirror, file?.hash as string) as Uint8Array<ArrayBuffer>,412 );413 }414 expect(await (await get(`/demo/raw/src/main.ts?at=${second()}`)).text()).toContain("'hi'");415 });416});417418test("static assets and raw files carry route-based sandboxing", async () => {419 const css = await get("/static/css/kepr.css");420 expect(css.status).toBe(200);421 expect(css.headers.get("content-type")).toContain("text/css");422 const raw = await get("/demo/raw/README.md");423 expect(raw.headers.get("content-security-policy")).toContain("sandbox");424 const asset = await get("/static/assets/plain.txt");425 expect(asset.headers.get("content-security-policy")).toContain("sandbox");426 const favicon = await get("/favicon.svg");427 expect(favicon.headers.get("content-type")).toBe("image/svg+xml");428 expect(favicon.headers.get("content-security-policy")).not.toContain("sandbox");429 expect((await get("/static/../package.json")).status).toBe(404);430 const csp = (await get("/demo")).headers.get("content-security-policy") ?? "";431 expect(csp).toContain("style-src 'self' https://fonts.bunny.net");432 expect(csp).toContain("font-src https://fonts.bunny.net");433 expect(csp).not.toContain("unsafe-inline");434});435436describe("housekeeping routes", () => {437 test("robots.txt points at the sitemap, which lists public repos only", async () => {438 expect(await body("/robots.txt")).toBe(439 "User-agent: *\nAllow: /\n\nSitemap: https://kepr.example/sitemap.xml\n",440 );441 const sitemap = await get("/sitemap.xml");442 expect(sitemap.headers.get("Content-Type")).toBe("application/xml; charset=UTF-8");443 const xml = await sitemap.text();444 expect(xml).toStartWith('<?xml version="1.0" encoding="UTF-8"?>\n<urlset');445 for (const repo of ["demo", "large", "tail"]) {446 expect(xml).toContain(`<loc>https://kepr.example/${repo}</loc>`);447 }448 expect(xml).not.toContain("hidden");449 });450451 test("favicon.svg is Kepr 2's mark, and every page links it", async () => {452 const res = await get("/favicon.svg");453 expect(res.headers.get("Content-Type")).toBe("image/svg+xml");454 expect(await res.text()).toContain('<polygon points="16,3 27,23 5,23"');455 expect(await body("/demo")).toContain(456 '<link rel="icon" href="/favicon.svg" type="image/svg+xml">',457 );458 });459});