Build and Push Containers / build-and-push (push) Successful in 1m50s
One env var (BOR_APP_NAME, default "Brain of Reese") now drives the app's
display name everywhere (TODO.md L12 — owner ask: "a way to customize the
name for 'Brain of'. Should be an env var."). The existing app_name setting
is the source of truth (phase locked decision — no new variable, no rename);
with the variable unset the app is byte-identical to before.
Endpoint (A10 public/stateless, no secrets):
GET /api/config → exactly {app_name, version} (app/api/config.py, the
health.py pattern; registered before the static mount). Integration tests:
anonymous 200, default values, a Settings override follows, key set is
exactly two keys — no other setting may leak in later.
Frontend brand layer (A11 — runtime fetch, static templates stay static):
assets/brand.js — a CLASSIC script, first on all six pages, so its top
level runs at parse time: window.BOR_BRAND = "Brain of Reese"
synchronously (the default renders immediately, no blank flash), then a
no-store fetch of /api/config applies the name — document.title (global
replace), every .brand-text (a name starting "Brain of " keeps the bold
split Brain of <strong>rest</strong>, any other name renders plain; the
operator-controlled name is HTML-escaped before innerHTML), a TreeWalker
over text nodes (script/style rejected — page source never rewritten),
and the aria-label/placeholder/meta-content attributes. Fetch failure
keeps the default + console.warn (the loadHealth house style).
app.js (status labels, typing label, elapsed-hint aria, tool labels) and
document.js (viewer titles) read window.BOR_BRAND at CALL time via
brand() — a label set after the fetch lands carries the configured name.
Containerfile: esbuild minify line for brand.js (classic, like markdown.js);
the phase-33 ?v= cache-busting picks the new asset ref up automatically.
E2E (A16 — one story, one file, isolated): test_configurable_brand.py boots
a SECOND app instance (same DB/mock-LLM/admin-auth env block, port APP_PORT+1,
BOR_APP_NAME="Brain of Testy") — the shared conftest server keeps the
default name so every other suite's title/label assertions stay untouched —
and asserts /api/config on both instances, the index title/brand/greeting/
#messages aria-label, the sources + login page titles, and one pre-token
chat turn (think out loud marker) whose #send-status reads "Brain of Testy
is thinking"; the no-op regression pins the shared server's default bytes.
Docs: .env.example App section + README configuration reference — what it
affects (titles, header brand, status labels, aria text), the default, the
bold-split rendering rule.
Gates: 695 unit+integration passed, app/ coverage 99% (>90%), story E2E
green in isolation (two consecutive runs), brand-string suites (smoke,
shared header, header consistency, chat persistence) green, ruff + pyright
clean.
239 lines
9.8 KiB
JavaScript
239 lines
9.8 KiB
JavaScript
/* Brain of Reese — document viewer (phase 10) + the shared document
|
|
* renderer (phase 26).
|
|
*
|
|
* Two jobs:
|
|
*
|
|
* 1. renderDocument(doc, { titleEl, metaEl, contentEl }) — the
|
|
* EXPORTED rendering core. The /document.html page and the document
|
|
* modal (assets/document-modal.js, phase 26) both render through it,
|
|
* so the two surfaces can never drift:
|
|
*
|
|
* • md / markdown → the shared escape-first renderer (markdown.js)
|
|
* in a ≤46rem centered column;
|
|
* • any other → the raw content as a text node inside
|
|
* <pre class="doc-raw"> (mono, horizontal
|
|
* scroll);
|
|
* • doc.summary non-empty (phase 36 — phase 30 summaries exist
|
|
* only on non-markdown docs) → a labeled
|
|
* .doc-summary section ABOVE the content;
|
|
* null / empty / whitespace renders nothing, so
|
|
* markdown docs and fail-soft rows are
|
|
* byte-for-byte unchanged.
|
|
*
|
|
* 2. The /document.html page itself: reads `source`/`path` query
|
|
* params, fetches the stateless content endpoint
|
|
* (GET /api/documents/content — database only, no filesystem), and
|
|
* renders via renderDocument into #doc-title / #doc-meta /
|
|
* #doc-content. A missing document (unknown pair, missing params,
|
|
* network error) shows the designed not-found card with a link back
|
|
* to the Sources page.
|
|
*
|
|
* XSS-safe by construction: markdown is escaped before transform, raw
|
|
* formats are set via textContent, and every document-derived string
|
|
* (title, badges, path) is written with textContent — never innerHTML
|
|
* (innerHTML goes through renderMarkdown, which escapes first).
|
|
*
|
|
* Phase 19: the viewer joins the shared header (assets/header.js) — the
|
|
* whoami fetch is the module's cached promise (one request per page,
|
|
* shared with initSharedHeader's toggling). Phase 34 task 02: the New
|
|
* chat binding is module-owned (assets/header.js, the SINGLE one) — on
|
|
* this non-chat page it clears the phase-14 conversation key and
|
|
* navigates to the chat's empty state.
|
|
*
|
|
* Phase 26 (import safety): the modal module imports renderDocument
|
|
* from THIS file on the chat/sources pages, so everything
|
|
* /document.html-specific runs only when #doc-title exists (the guard
|
|
* around the page block below). Importing renderDocument elsewhere has
|
|
* no side effects: no back-link resolution, no whoami, no content
|
|
* fetch, no New Chat binding.
|
|
*
|
|
* Phase 36: the renderer owns the optional summary panel — a non-empty
|
|
* doc.summary renders as a labeled .doc-summary section above the
|
|
* original content on BOTH surfaces (page + modal) through this one
|
|
* core; the summary text is a text node (XSS contract unchanged).
|
|
*/
|
|
|
|
import { fetchIsAdmin, initSharedHeader } from "./header.js";
|
|
|
|
/* Phase 39: the page title's display name — window.BOR_BRAND (set at
|
|
* parse time by the classic assets/brand.js, refreshed from
|
|
* /api/config). This is a module, so the global is set by the time this
|
|
* evaluates; the literal is the no-config fallback only. */
|
|
const brand = () => window.BOR_BRAND || "Brain of Reese";
|
|
|
|
function fmtDate(iso) {
|
|
try {
|
|
return new Date(iso).toLocaleString();
|
|
} catch {
|
|
return iso;
|
|
}
|
|
}
|
|
|
|
function contentUrl(s, p) {
|
|
return "/api/documents/content?source=" + encodeURIComponent(s) + "&path=" + encodeURIComponent(p);
|
|
}
|
|
|
|
function metaBadge(cls, text) {
|
|
const el = document.createElement("span");
|
|
el.className = cls;
|
|
el.textContent = text;
|
|
return el;
|
|
}
|
|
|
|
/* ---------- shared renderer (phase 26, task 02) ----------
|
|
* Populates the three elements every render surface provides: a title,
|
|
* a .doc-meta badge row (source · format · mono path · indexed ·
|
|
* chunks), and a content container — an optional .doc-summary section
|
|
* first (phase 36: only when doc.summary is non-empty — markdown docs
|
|
* and fail-soft rows carry none, so they render exactly as before),
|
|
* then .doc-md for md/markdown (the shared escape-first renderer),
|
|
* <pre class="doc-raw"> otherwise. The XSS contract: innerHTML only
|
|
* through renderMarkdown; every document-derived string (summary text
|
|
* included) is a text node. */
|
|
export function renderDocument(doc, { titleEl, metaEl, contentEl }) {
|
|
titleEl.textContent = doc.title;
|
|
// Phase 34 task 04: the titlebar title ellipsizes — the full title
|
|
// stays reachable on hover via the `title` attribute.
|
|
titleEl.setAttribute("title", doc.title);
|
|
|
|
const pathCode = document.createElement("code");
|
|
pathCode.className = "doc-path";
|
|
pathCode.textContent = doc.path;
|
|
metaEl.replaceChildren(
|
|
metaBadge("doc-source-badge", doc.source),
|
|
metaBadge("format-badge", doc.format),
|
|
pathCode,
|
|
metaBadge("doc-indexed", `Indexed ${fmtDate(doc.indexed_at)}`),
|
|
metaBadge("doc-chunks", `${doc.chunks} chunk${doc.chunks === 1 ? "" : "s"}`),
|
|
);
|
|
|
|
contentEl.replaceChildren();
|
|
// Phase 36: the summary panel — labeled section ABOVE the original
|
|
// content, on BOTH surfaces (page + modal) through this one core.
|
|
// Only a non-empty summary renders: markdown docs carry none (phase
|
|
// 30) and the fail-soft path leaves summary NULL, so both are
|
|
// byte-for-byte unchanged here.
|
|
if (doc.summary && doc.summary.trim() !== "") {
|
|
const section = document.createElement("section");
|
|
section.className = "doc-summary";
|
|
section.setAttribute("aria-label", "Summary");
|
|
const title = document.createElement("h2");
|
|
title.className = "doc-summary-title";
|
|
title.textContent = "Summary";
|
|
const body = document.createElement("p");
|
|
body.className = "doc-summary-text";
|
|
body.textContent = doc.summary; // text node — XSS contract unchanged
|
|
section.append(title, body);
|
|
contentEl.appendChild(section);
|
|
}
|
|
if (doc.format === "md" || doc.format === "markdown") {
|
|
const wrap = document.createElement("div");
|
|
wrap.className = "doc-md";
|
|
wrap.innerHTML = renderMarkdown(doc.content); // escape-first: XSS-safe
|
|
contentEl.appendChild(wrap);
|
|
} else {
|
|
const pre = document.createElement("pre");
|
|
pre.className = "doc-raw";
|
|
pre.textContent = doc.content; // text node: never parsed as HTML
|
|
contentEl.appendChild(pre);
|
|
}
|
|
}
|
|
|
|
/* ---------- /document.html page (phases 10/13/19) ----------
|
|
* Phase 26: viewer-page-specific — see the import-safety note in the
|
|
* header. The guard is #doc-title: it exists only on this page, so the
|
|
* modal module's `import { renderDocument } from "./document.js"` on
|
|
* the chat/sources pages evaluates none of the code below. */
|
|
if (document.querySelector("#doc-title")) {
|
|
const params = new URLSearchParams(window.location.search);
|
|
const source = params.get("source") || "";
|
|
const path = params.get("path") || "";
|
|
|
|
const titleEl = document.querySelector("#doc-title");
|
|
const metaEl = document.querySelector("#doc-meta");
|
|
const contentEl = document.querySelector("#doc-content");
|
|
const notFoundEl = document.querySelector("#doc-not-found");
|
|
const mainEl = document.querySelector("#main");
|
|
const backLink = document.querySelector("#doc-back");
|
|
|
|
/* Back button (phase 13): the return target comes from the `back`
|
|
* query param, not the browser history — the dedicated page is
|
|
* reachable directly (no history to go back to). The param is honored
|
|
* only for same-origin relative URLs (starts with "/" but not "//"),
|
|
* so absolute (https://…), protocol-relative (//…), and
|
|
* pseudo-protocol (javascript:…) values are rejected; anything else
|
|
* falls back to the Sources page. The static href="/sources.html" in
|
|
* document.html remains the no-JS fallback, and with the href set the
|
|
* anchor's default click behavior IS the deterministic navigation (no
|
|
* browser-history heuristics). */
|
|
const backParam = params.get("back") || "";
|
|
const backTarget =
|
|
backParam.startsWith("/") && !backParam.startsWith("//")
|
|
? backParam
|
|
: "/sources.html";
|
|
backLink.href = backTarget;
|
|
const backLabel = backLink.querySelector("span");
|
|
if (backLabel) {
|
|
backLabel.textContent =
|
|
backTarget === "/"
|
|
? "Chat"
|
|
: backTarget === "/sources.html"
|
|
? "Sources"
|
|
: "Back";
|
|
}
|
|
|
|
/* renderDocument fills the page elements; the page additionally owns
|
|
* the document.title (the modal keeps the page title untouched). */
|
|
function render(doc) {
|
|
renderDocument(doc, { titleEl, metaEl, contentEl });
|
|
document.title = `${doc.title} · ${brand()}`;
|
|
}
|
|
|
|
function showNotFound() {
|
|
titleEl.textContent = "Document not found";
|
|
titleEl.removeAttribute("title"); // no stale full-title tooltip
|
|
document.title = `Document not found · ${brand()}`;
|
|
metaEl.replaceChildren();
|
|
contentEl.replaceChildren();
|
|
notFoundEl.hidden = false;
|
|
}
|
|
|
|
/* Phase 19 (phase 34 task 03, owner confirmation 2026-08-26): the
|
|
* viewer now carries the SAME standard bar as every other page —
|
|
* nav incl. the admin-only links, Tuning toggle, Sync, New chat, the
|
|
* auth pair — all toggled here on the module's cached whoami.
|
|
* Independent of the doc fetch (its own IIFE — load() below never
|
|
* waits on it).
|
|
* (fetchIsAdmin is imported for parity with the other header
|
|
* consumers — the module's cached promise is the single whoami per
|
|
* page either way.) */
|
|
(async () => {
|
|
await initSharedHeader();
|
|
})();
|
|
|
|
/* The New chat binding is module-owned (assets/header.js, phase 34
|
|
* task 02 — the SINGLE binding): on this non-chat page it clears the
|
|
* phase-14 conversation key and navigates to the chat's empty state. */
|
|
|
|
async function load() {
|
|
try {
|
|
if (!source || !path) {
|
|
showNotFound();
|
|
return;
|
|
}
|
|
const r = await fetch(contentUrl(source, path));
|
|
if (!r.ok) {
|
|
showNotFound();
|
|
return;
|
|
}
|
|
render(await r.json());
|
|
} catch {
|
|
showNotFound();
|
|
} finally {
|
|
mainEl.focus(); // move focus to main on load (a11y)
|
|
}
|
|
}
|
|
|
|
load();
|
|
}
|