Files
khosra/internal/web/extras_test.go
T
Claude Opus 5andbdeshi 9100ce4876 notice content changes and rebuild without a restart
Polling lives in internal/ext/watch, per the human's call to keep core under its
ceiling rather than raise it a second time — which is what ADR-0041 said a second
raise would mean. It is a poller, deletable without trace, and core stayed at
2671/2800.

A settled change calls the same `rebuilder` that startup calls, because a reload
path that differs from the startup path is a reload path that drifts. The index is
an atomic.Pointer swapped whole, so a request reads the site that was current when
it arrived instead of one being rebuilt underneath it — the alternative, mutating in
place, is a data race with every in-flight request.

Names, sizes and modification times, not contents: reading every file to detect a
change costs more than the rebuild it triggers. Editor droppings are excluded,
because saving in vim writes a swap file, a backup and the number 4913, and each
would otherwise look like a change. A change must hold still for a moment first,
since one save is often several operations.

Verified against the running binary: a page 404s, the file appears, and five seconds
later it serves — one "site root changed" in the log. Then three droppings written
at once produced no rebuild at all.

Two warnings fired and were fixed rather than silenced: `runServe` gave up the
rebuild closure to `rebuilder`, and the fingerprint walk gave up its body to
`record`, where three exclusions read as a list instead of as nesting.

The Dockerfile ships the binary alone. The site root arrives as a volume and is
never copied in — it is somebody's content repository with its own history
(ADR-0011), so the image is the same for every site.
2026-07-31 14:00:53 +06:00

156 lines
5.8 KiB
Go

package web
import (
"net/http"
"net/http/httptest"
"strings"
"testing"
"testing/fstest"
"khosra/internal/content"
"khosra/internal/render"
)
func extrasFS() fstest.MapFS {
return fstest.MapFS{
"content/writing/story/index.md": {Data: []byte("---\ntitle: A Story\ndate: 2026-01-01\n---\nThe story itself.\n")},
"content/writing/story/extras/notes.md": {Data: []byte("## Notes\n\nWith *emphasis*.\n")},
"content/writing/story/extras/log.txt": {Data: []byte("day one: <not markup>\n")},
"content/writing/story/extras/scan.jpg": {Data: []byte("jpeg bytes")},
"content/writing/story/extras/drafts/v1.md": {Data: []byte("first attempt\n")},
"content/writing/plain.md": {Data: []byte("---\ntitle: Plain\ndate: 2026-01-02\n---\nx\n")},
}
}
func extrasHandler(t *testing.T, fsys fstest.MapFS) http.Handler {
t.Helper()
bundles, err := content.Scan(fsys)
if err != nil {
t.Fatal(err)
}
r, err := render.New(nil, content.Settings{}, nil)
if err != nil {
t.Fatal(err)
}
return Handler(Fixed(content.NewSite(bundles)), r, fsys, nil, content.Settings{})
}
func TestExtrasAreNotBundles(t *testing.T) {
// The scanner skips the directory entirely, so a .md in there has no URL, no identity and never appears in
// a listing (content-model.md).
fsys := extrasFS()
bundles, err := content.Scan(fsys)
if err != nil {
t.Fatal(err)
}
for _, b := range bundles {
if strings.Contains(b.Key, "extras") {
t.Errorf("%q was scanned as a bundle", b.Key)
}
}
if len(bundles) != 2 {
t.Errorf("scanned %d bundles, want 2", len(bundles))
}
h := extrasHandler(t, fsys)
for _, path := range []string{"/writing/story/extras/notes/", "/writing/story/extras/drafts/v1/"} {
rec := httptest.NewRecorder()
h.ServeHTTP(rec, httptest.NewRequest(http.MethodGet, path, nil))
if rec.Code == http.StatusOK && strings.Contains(rec.Body.String(), "<h1>") {
t.Errorf("GET %s rendered a page for something that is not a bundle", path)
}
}
}
func TestTheExtrasListingShowsTheTreeClassified(t *testing.T) {
h := extrasHandler(t, extrasFS())
rec := httptest.NewRecorder()
h.ServeHTTP(rec, httptest.NewRequest(http.MethodGet, "/writing/story/extras/", nil))
if rec.Code != http.StatusOK {
t.Fatalf("got %d, want 200", rec.Code)
}
body := rec.Body.String()
for _, want := range []string{"notes.md", "log.txt", "scan.jpg", "drafts", "markdown", "text", "image"} {
if !strings.Contains(body, want) {
t.Errorf("listing missing %q:\n%s", want, body)
}
}
// Sorted by path, so the order is the same on every request and a numeric prefix orders a set.
if strings.Index(body, "drafts") > strings.Index(body, "log.txt") {
t.Errorf("entries should be sorted by path:\n%s", body)
}
// A bundle with no extras has no listing at all.
rec = httptest.NewRecorder()
h.ServeHTTP(rec, httptest.NewRequest(http.MethodGet, "/writing/plain/extras/", nil))
if rec.Code != http.StatusNotFound {
t.Errorf("a bundle without extras = %d, want 404", rec.Code)
}
}
func TestSelectingAnEntryRendersWhatItCanAndOffersTheRest(t *testing.T) {
h := extrasHandler(t, extrasFS())
rec := httptest.NewRecorder()
h.ServeHTTP(rec, httptest.NewRequest(http.MethodGet, "/writing/story/extras/notes.md", nil))
body := rec.Body.String()
if !strings.Contains(body, "<h2>Notes</h2>") || !strings.Contains(body, "<em>emphasis</em>") {
t.Errorf("markdown should be rendered:\n%s", body)
}
// The tree is still there: selecting is a link, and the page is a full re-render, so no JavaScript is needed.
if !strings.Contains(body, "log.txt") {
t.Errorf("the listing should still be shown beside the selection:\n%s", body)
}
// A text file is shown as text, escaped — a log is not markup.
rec = httptest.NewRecorder()
h.ServeHTTP(rec, httptest.NewRequest(http.MethodGet, "/writing/story/extras/log.txt", nil))
body = rec.Body.String()
if !strings.Contains(body, "&lt;not markup&gt;") {
t.Errorf("a text entry must be escaped, not interpreted:\n%s", body)
}
// A picture cannot be rendered inline as text, so it arrives with a raw URL instead.
rec = httptest.NewRecorder()
h.ServeHTTP(rec, httptest.NewRequest(http.MethodGet, "/writing/story/extras/scan.jpg", nil))
if body := rec.Body.String(); !strings.Contains(body, "scan.jpg?raw") {
t.Errorf("an image entry should offer its bytes:\n%s", body)
}
}
func TestRawReturnsTheBytesAndNothingElse(t *testing.T) {
h := extrasHandler(t, extrasFS())
rec := httptest.NewRecorder()
h.ServeHTTP(rec, httptest.NewRequest(http.MethodGet, "/writing/story/extras/scan.jpg?raw", nil))
if rec.Code != http.StatusOK {
t.Fatalf("got %d, want 200", rec.Code)
}
if got := rec.Body.String(); got != "jpeg bytes" {
t.Errorf("body = %q, want the file itself", got)
}
if ct := rec.Header().Get("Content-Type"); !strings.HasPrefix(ct, "image/jpeg") {
t.Errorf("content-type = %q", ct)
}
}
func TestExtrasCannotBeUsedToWanderOrToReadAnUnpublishedBundle(t *testing.T) {
fsys := extrasFS()
fsys["content/writing/secret/index.md"] = &fstest.MapFile{Data: []byte("---\ntitle: Secret\ndraft: true\n---\nx\n")}
fsys["content/writing/secret/extras/plan.md"] = &fstest.MapFile{Data: []byte("the plan\n")}
h := extrasHandler(t, fsys)
for _, path := range []string{
"/writing/story/extras/../../../etc/passwd",
"/writing/story/extras/nothing.md",
"/writing/story/extras/drafts", // a directory is not an entry to show
"/writing/secret/extras/", // draft: the whole bundle is hidden (ADR-0024)
"/writing/secret/extras/plan.md",
"/writing/secret/extras/plan.md?raw",
} {
rec := httptest.NewRecorder()
h.ServeHTTP(rec, httptest.NewRequest(http.MethodGet, path, nil))
if rec.Code == http.StatusOK {
t.Errorf("GET %s = 200, want a miss:\n%s", path, rec.Body.String())
}
if strings.Contains(rec.Body.String(), "the plan") {
t.Fatalf("GET %s leaked an unpublished bundle's extras", path)
}
}
}