feat(ui): one consistent navbar on every page (TODO.md L3)
This commit is contained in:
@@ -59,6 +59,8 @@ def _make_git_repo(base: Path) -> tuple[Path, str]:
|
||||
"user.name=test",
|
||||
"-c",
|
||||
"user.email=test@example.com",
|
||||
"-c",
|
||||
"commit.gpgsign=false", # the fixture commit never signs (env gpg)
|
||||
"commit",
|
||||
"-q",
|
||||
"-m",
|
||||
|
||||
@@ -3,9 +3,10 @@
|
||||
The browser behavior is E2E-covered (tests/e2e/test_shared_header.py);
|
||||
here we pin the source-level wiring — the header.js exports, the cached
|
||||
whoami promise, the per-page HTML ids (anonymous-safe hidden-by-default
|
||||
controls), the sign-out binding move out of app.js, the non-chat New
|
||||
Chat bindings, and the viewer-bar CSS — so a silent regression is caught
|
||||
without a browser.
|
||||
controls), the sign-out binding move out of app.js, the SINGLE
|
||||
module-owned New chat binding (phase 34 task 02) + the sign-in
|
||||
?next= rewrite, and the viewer-bar CSS — so a silent regression is
|
||||
catched without a browser.
|
||||
"""
|
||||
from __future__ import annotations
|
||||
|
||||
@@ -109,17 +110,75 @@ def test_sign_out_binding_lives_in_the_shared_module() -> None:
|
||||
|
||||
|
||||
def test_nav_sources_ships_hidden_on_every_nav_page() -> None:
|
||||
"""Phase 19 UX revision (owner permission 2026-08-23): the Sources
|
||||
nav link is hidden for anonymous — so it SHIPS with the hidden
|
||||
attribute (anonymous-safe default) on every page that has a nav
|
||||
(chat, sources, login)."""
|
||||
for html in (INDEX_HTML, SOURCES_HTML, LOGIN_HTML, TUNING_HTML):
|
||||
"""Phase 19 UX revision (owner permission 2026-08-23), completed on
|
||||
all five pages by phase 34 task 03 (owner confirmation 2026-08-26):
|
||||
the Sources nav link is hidden for anonymous — so it SHIPS with the
|
||||
hidden attribute (anonymous-safe default) on every page (they all
|
||||
carry the nav now, viewer included)."""
|
||||
for html in (INDEX_HTML, SOURCES_HTML, DOCUMENT_HTML, LOGIN_HTML, TUNING_HTML):
|
||||
text = _text(html)
|
||||
assert re.search(r'id="nav-sources"[^>]*\bhidden\b', text), (
|
||||
f"{html.name}: #nav-sources must ship hidden"
|
||||
)
|
||||
|
||||
|
||||
def test_all_five_pages_share_the_header_control_order() -> None:
|
||||
"""Phase 34 task 03 (owner confirmation 2026-08-26): every page
|
||||
ships the IDENTICAL header control inventory in the IDENTICAL
|
||||
order — brand, nav [Chat, Sources, Tuning], #steering-toggle,
|
||||
#sync-btn, #new-chat-btn, Sign in, Sign out — inside the shared
|
||||
.header-inner row (the document viewer's row 1). Only the
|
||||
current-page is-active nav marker and the static ?next= fallback
|
||||
may differ per page (task 05's story E2E pins the rendered
|
||||
result)."""
|
||||
markers = (
|
||||
'class="brand"',
|
||||
'<nav class="app-nav"',
|
||||
'href="/"',
|
||||
'id="nav-sources"',
|
||||
'id="nav-tuning"',
|
||||
'id="steering-toggle"',
|
||||
'id="sync-btn"',
|
||||
'id="new-chat-btn"',
|
||||
'id="sign-in-link"',
|
||||
'id="sign-out-btn"',
|
||||
)
|
||||
for html in (INDEX_HTML, SOURCES_HTML, DOCUMENT_HTML, TUNING_HTML, LOGIN_HTML):
|
||||
text = _text(html)
|
||||
start = text.find('<div class="container header-inner">')
|
||||
assert start != -1, f"{html.name}: missing the shared .header-inner row"
|
||||
region = text[start : text.find("</header>", start)]
|
||||
missing = [m for m in markers if m not in region]
|
||||
assert not missing, f"{html.name}: header controls missing {missing}"
|
||||
for m in markers:
|
||||
assert region.count(m) == 1, f"{html.name}: {m} must appear exactly once"
|
||||
# Same order on every page: each control follows the previous one.
|
||||
pos = -1
|
||||
for m in markers:
|
||||
idx = region.find(m, pos + 1)
|
||||
assert idx > pos, f"{html.name}: {m} out of order in the shared bar"
|
||||
pos = idx
|
||||
|
||||
|
||||
def test_all_five_pages_carry_the_steering_panel() -> None:
|
||||
"""Phase 34 task 03: the #steering-panel section (+ the
|
||||
#steering-announcer live region) ships on every page — after
|
||||
#kb-banner in the chat shell, first child of <main> on the other
|
||||
four pages — ship hidden, driven by assets/header.js."""
|
||||
for html in (INDEX_HTML, SOURCES_HTML, DOCUMENT_HTML, TUNING_HTML, LOGIN_HTML):
|
||||
text = _text(html)
|
||||
tag = re.search(r'<section[^>]*id="steering-panel"[^>]*>', text)
|
||||
assert tag, f"{html.name}: missing the #steering-panel section"
|
||||
assert re.search(r'\bhidden\b', tag.group(0)), "the panel ships hidden"
|
||||
assert 'id="steering-list"' in text
|
||||
assert 'id="steering-empty"' in text
|
||||
assert re.search(r'<p[^>]*id="steering-announcer"[^>]*role="status"[^>]*>', text), (
|
||||
f"{html.name}: missing the #steering-announcer live region"
|
||||
)
|
||||
# The announcer follows the panel (the copied index.html block).
|
||||
assert text.find('id="steering-panel"') < text.find('id="steering-announcer"')
|
||||
|
||||
|
||||
def test_nav_tuning_ships_hidden_on_the_tuning_page() -> None:
|
||||
"""Phase 27: the Global Tuning page reuses the shared header — the
|
||||
"Tuning" nav link is admin-only, so it SHIPS hidden (revealed by
|
||||
@@ -139,10 +198,38 @@ def test_nav_tuning_ships_hidden_on_the_tuning_page() -> None:
|
||||
assert [s for s in srcs if "tuning.js" in s]
|
||||
|
||||
|
||||
def test_nav_sources_is_absent_from_the_viewer() -> None:
|
||||
"""The document viewer has no nav — no #nav-sources element there (the
|
||||
module's missing-element no-op keeps it out)."""
|
||||
assert 'id="nav-sources"' not in _text(DOCUMENT_HTML)
|
||||
def test_viewer_carries_the_standard_nav() -> None:
|
||||
"""Phase 34 task 03 (owner confirmation 2026-08-26): the document
|
||||
viewer carries the SAME standard bar as every other page — row 1 is
|
||||
the shared .header-inner block, so the nav (Chat + the admin-only
|
||||
#nav-sources / #nav-tuning links, ship hidden) is there too. No nav
|
||||
link is "current" on the viewer: a document is a detail view
|
||||
reachable from chat or Sources, and the phase-13 back link (row 2)
|
||||
carries the return affordance. The phase-19 single-row bar
|
||||
(.doc-header-actions) is superseded by the two-row layout —
|
||||
.doc-titlebar keeps #doc-back / #doc-title / #doc-meta, so
|
||||
document.js needs no render change."""
|
||||
text = _text(DOCUMENT_HTML)
|
||||
chat = re.search(r'<a[^>]*href="/"[^>]*>Chat</a>', text)
|
||||
assert chat, "the viewer bar carries the standard nav"
|
||||
assert "is-active" not in chat.group(0), "no nav link is current on the viewer"
|
||||
for link in ("nav-sources", "nav-tuning"):
|
||||
tag = re.search(rf'<a[^>]*id="{link}"[^>]*>', text)
|
||||
assert tag, f"the viewer bar must carry #{link}"
|
||||
assert "hidden" in tag.group(0), f"#{link} must ship hidden (admin-only)"
|
||||
assert "is-active" not in tag.group(0)
|
||||
# Row 1 is the standard bar inside the two-row viewer header.
|
||||
assert re.search(r'<header[^>]*class="doc-header"', text), "the header keeps .doc-header"
|
||||
assert 'class="app-header"' in text, "row 1 reuses the .app-header bar"
|
||||
assert 'doc-header-inner' not in text, "the old single-row wrapper is gone"
|
||||
assert 'doc-header-actions' not in text, "the old actions wrapper is gone"
|
||||
# Row 2: the .doc-titlebar keeps the back link + title + meta.
|
||||
assert 'class="doc-titlebar"' in text, "row 2 must be the .doc-titlebar"
|
||||
assert 'id="doc-back"' in text
|
||||
assert 'id="doc-title"' in text
|
||||
assert 'id="doc-meta"' in text
|
||||
back = re.search(r'<a[^>]*id="doc-back"[^>]*href="/sources.html"', text)
|
||||
assert back, "the back link keeps its /sources.html no-JS fallback"
|
||||
|
||||
|
||||
def test_sources_and_viewer_carry_the_shared_controls() -> None:
|
||||
@@ -197,14 +284,31 @@ def test_header_module_loads_before_the_page_script() -> None:
|
||||
)
|
||||
|
||||
|
||||
def test_login_page_carries_no_chat_controls() -> None:
|
||||
"""Noted boundary (owner-confirmed): the login page is the auth page,
|
||||
not an app page — no New Chat / Sign in / Sign out controls there;
|
||||
header.js only toggles the Sources link."""
|
||||
def test_login_page_carries_the_full_header() -> None:
|
||||
"""Phase 34 task 03 (owner confirmation 2026-08-26): the noted
|
||||
boundary is reversed by owner decision — the login page finally
|
||||
carries the FULL shared header: the nav gains the #nav-tuning link
|
||||
(same ship-hidden markup as the other pages), plus the Tuning
|
||||
toggle, the admin-only Sync button, New chat, and the Sign in /
|
||||
Sign out pair (ship hidden — initSharedHeader reveals exactly one
|
||||
after whoami; the static ?next= fallback is the login page itself).
|
||||
No nav link is "current" on the auth page."""
|
||||
text = _text(LOGIN_HTML)
|
||||
assert "new-chat-btn" not in text
|
||||
assert "sign-in-link" not in text
|
||||
assert "sign-out-btn" not in text
|
||||
for marker in (
|
||||
'id="nav-sources"',
|
||||
'id="nav-tuning"',
|
||||
'id="steering-toggle"',
|
||||
'id="sync-btn"',
|
||||
'id="new-chat-btn"',
|
||||
'id="sign-in-link"',
|
||||
'id="sign-out-btn"',
|
||||
):
|
||||
assert marker in text, f"login.html must carry {marker} (phase 34 full header)"
|
||||
assert 'href="/login.html?next=/login.html"' in text, (
|
||||
"the login page's Sign in returns to the login page (no-JS fallback)"
|
||||
)
|
||||
for tag in re.findall(r'<a[^>]*class="nav-link[^"]*"[^>]*>', text):
|
||||
assert "is-active" not in tag, "no nav link is current on the login page"
|
||||
|
||||
|
||||
# ---------- page-script adaptations ----------
|
||||
@@ -249,40 +353,206 @@ def test_login_js_uses_the_shared_fetch_is_admin() -> None:
|
||||
assert "window.location.replace(safeNext())" in js
|
||||
|
||||
|
||||
def test_non_chat_pages_bind_new_chat_to_the_chat_page() -> None:
|
||||
"""On sources, the viewer, and the tuning page, New Chat means "go to
|
||||
the chat, fresh": the binding clears the phase-14 key
|
||||
(clearChatStorage) and navigates to "/" — and each page runs
|
||||
initSharedHeader() at boot on the shared cached whoami. Phase 23:
|
||||
def test_new_chat_binding_is_single_and_module_owned() -> None:
|
||||
"""Phase 34 task 02: header.js owns the SINGLE #new-chat-btn binding
|
||||
(module import, like the sign-out binding): on the chat page
|
||||
(#messages exists) it dispatches window "bor:new-chat" — app.js acts
|
||||
through its own in-flight-turn guard + list reset; on every other
|
||||
page it means "go to the chat, fresh" (clearChatStorage + navigate
|
||||
to "/"). NO page script binds #new-chat-btn anymore, and each page
|
||||
still runs initSharedHeader() on the shared cached whoami. Phase 23:
|
||||
the import is relative (`./header.js`)."""
|
||||
js = _text(HEADER_JS)
|
||||
assert 'querySelector("#new-chat-btn")' in js
|
||||
assert "newChatBtn.addEventListener" in js
|
||||
assert 'querySelector("#messages")' in js, "the chat-page branch key"
|
||||
assert 'new CustomEvent("bor:new-chat")' in js
|
||||
assert "clearChatStorage();" in js
|
||||
assert 'window.location.href = "/"' in js
|
||||
for js_file in (SOURCES_JS, DOCUMENT_JS, TUNING_JS):
|
||||
js = _text(js_file)
|
||||
assert 'from "./header.js"' in js
|
||||
assert "initSharedHeader()" in js
|
||||
btn_idx = js.find("new-chat-btn")
|
||||
clear_idx = js.find("clearChatStorage();")
|
||||
nav_idx = js.find('window.location.href = "/"')
|
||||
assert -1 < btn_idx < clear_idx < nav_idx, (
|
||||
f"{js_file.name}: #new-chat-btn must clear storage then navigate to '/'"
|
||||
page_js = _text(js_file)
|
||||
assert 'from "./header.js"' in page_js
|
||||
assert "initSharedHeader()" in page_js
|
||||
assert "new-chat-btn" not in page_js, (
|
||||
f"{js_file.name}: no #new-chat-btn binding (the module owns it)"
|
||||
)
|
||||
assert 'fetch("/api/whoami")' not in js, (
|
||||
assert 'fetch("/api/whoami")' not in page_js, (
|
||||
f"{js_file.name}: whoami goes through the shared cached promise"
|
||||
)
|
||||
|
||||
|
||||
# ---------- viewer-bar CSS ----------
|
||||
|
||||
|
||||
def test_viewer_bar_css_pushes_actions_right_and_title_clips() -> None:
|
||||
"""styles.css defines .doc-header-actions (margin-left:auto flex
|
||||
cluster) and the title block keeps min-width: 0 so
|
||||
#doc-title/#doc-meta clip instead of overflowing the --header-h bar."""
|
||||
css = _text(STYLES_CSS)
|
||||
block = re.search(r"\.doc-header-actions\s*\{([^}]*)\}", css)
|
||||
assert block, "styles.css must define .doc-header-actions"
|
||||
body = block.group(1)
|
||||
assert "margin-left: auto" in body
|
||||
assert "display: flex" in body
|
||||
assert re.search(r"\.doc-title-block\s*\{[^}]*min-width:\s*0", css), (
|
||||
"the title block must keep clipping while the pills fit"
|
||||
app_js = _text(APP_JS)
|
||||
assert 'window.addEventListener("bor:new-chat", startNewChat)' in app_js
|
||||
assert "newChatBtn.addEventListener" not in app_js, (
|
||||
"app.js acts off the module's event, not its own binding"
|
||||
)
|
||||
|
||||
|
||||
def test_init_shared_header_rewrites_sign_in_next_to_current_page() -> None:
|
||||
"""Phase 34 task 02: initSharedHeader points #sign-in-link at
|
||||
/login.html?next=<current pathname> (default "/") — the admin lands
|
||||
back on the page they signed in from. The page markup keeps its own
|
||||
static ?next= as the no-JS fallback."""
|
||||
js = _text(HEADER_JS)
|
||||
fn = js.find("function initSharedHeader")
|
||||
assert fn != -1
|
||||
body = js[fn : js.find("\n}", fn)]
|
||||
# raw pathname (always a query-safe "/…" string — never "//", and ?
|
||||
# # / spaces stay percent-encoded inside it; login.js safeNext
|
||||
# re-validates), same shape as the static markup fallbacks
|
||||
assert '"/login.html?next=" + (window.location.pathname || "/")' in body
|
||||
|
||||
|
||||
# ---------- phase 34 task 01: the steering controls move to the module ----------
|
||||
# (task 02 — the sync machine + New chat + sign-in next — is pinned in
|
||||
# test_sync_button.py / above)
|
||||
|
||||
|
||||
def test_header_module_owns_the_steering_panel() -> None:
|
||||
"""header.js owns the steering panel behavior (moved from app.js in
|
||||
phase 34 task 01): the module-level null-safe element refs, the
|
||||
newest-first textContent render (XSS contract), the labeled
|
||||
per-note delete, the count badge, the announcer, and the toggle
|
||||
binding that runs at module import (like the sign-out binding)."""
|
||||
js = _text(HEADER_JS)
|
||||
for selector in (
|
||||
"#steering-toggle",
|
||||
"#steering-count",
|
||||
"#steering-panel",
|
||||
"#steering-list",
|
||||
"#steering-empty",
|
||||
"#steering-announcer",
|
||||
):
|
||||
assert f'querySelector("{selector}")' in js, f"missing {selector} ref"
|
||||
assert "function renderSteeringPanel" in js
|
||||
assert "text.className = \"steering-note-text\"" in js
|
||||
assert "text.textContent = n.note" in js, (
|
||||
"XSS contract: the note renders via textContent, never innerHTML"
|
||||
)
|
||||
assert 'del.setAttribute("aria-label", `Delete tuning note: ${n.note}`)' in js
|
||||
assert "async function deleteSteeringNote" in js
|
||||
assert 'fetch(`/api/steering/${encodeURIComponent(id)}`, { method: "DELETE" })' in js
|
||||
assert "steeringToggle.addEventListener" in js, "the toggle binding is module-owned"
|
||||
assert 'setAttribute("aria-expanded"' in js
|
||||
assert "refreshSteering()" in js # re-open refreshes the list
|
||||
|
||||
|
||||
def test_header_module_exports_refresh_and_announce_steering() -> None:
|
||||
"""refreshSteering() (fetch + render; non-2xx / unreachable API →
|
||||
the empty list state) and announceSteering() (the polite live
|
||||
region) are exported for the chat page's per-bubble Tune form.
|
||||
"""
|
||||
js = _text(HEADER_JS)
|
||||
assert "export async function refreshSteering" in js
|
||||
fn = js.find("function refreshSteering")
|
||||
assert fn != -1
|
||||
body = js[fn : js.find("\n}", fn)]
|
||||
assert 'fetch("/api/steering")' in body
|
||||
assert "renderSteeringPanel(notes)" in body
|
||||
assert "export function announceSteering" in js
|
||||
ann = js.find("function announceSteering")
|
||||
assert ann != -1
|
||||
ann_body = js[ann : js.find("\n}", ann)]
|
||||
assert "steeringAnnouncer.textContent = message" in ann_body
|
||||
|
||||
|
||||
def test_init_shared_header_gates_the_steering_surface() -> None:
|
||||
"""Inside initSharedHeader: admin → the list refreshes (count badge
|
||||
right before the panel is ever opened; only when the page ships the
|
||||
panel markup); anonymous → the toggle + panel are REMOVED from the
|
||||
DOM (phase-16 'absent, not hidden') and /api/steering is never
|
||||
fetched."""
|
||||
js = _text(HEADER_JS)
|
||||
fn = js.find("function initSharedHeader")
|
||||
assert fn != -1
|
||||
body = js[fn : js.find("\n}", fn)]
|
||||
assert "if (steeringPanel) refreshSteering();" in body
|
||||
assert "steeringToggle?.remove();" in body
|
||||
assert "steeringPanel?.remove();" in body
|
||||
|
||||
|
||||
def test_app_js_no_longer_owns_the_steering_panel() -> None:
|
||||
"""app.js keeps only the chat-specific per-bubble Tune button +
|
||||
inline form: the panel refs + logic are gone (header.js owns them
|
||||
now), and the form's success path awaits the module's
|
||||
refreshSteering() (announcing through the module's
|
||||
announceSteering()). The form's POST /api/steering + error handling
|
||||
stay in app.js, untouched."""
|
||||
js = _text(APP_JS)
|
||||
for gone in (
|
||||
"steeringToggle",
|
||||
"steeringCount",
|
||||
"steeringPanel",
|
||||
"steeringList",
|
||||
"steeringEmpty",
|
||||
"steeringAnnouncer",
|
||||
"loadSteering",
|
||||
"renderSteeringPanel",
|
||||
"deleteSteeringNote",
|
||||
"setSteeringPanel",
|
||||
'querySelector("#steering-toggle")',
|
||||
):
|
||||
assert gone not in js, f"{gone!r} must be gone from app.js (header.js owns it)"
|
||||
# the chat-specific part survives and is wired to the shared module
|
||||
assert "function appendTuneButton" in js
|
||||
assert "function openTuneForm" in js
|
||||
assert "TUNE_ICON" in js
|
||||
assert 'from "./header.js"' in js
|
||||
assert "refreshSteering" in js and "announceSteering" in js
|
||||
assert "await refreshSteering()" in js
|
||||
assert 'fetch("/api/steering", {' in js # the form's POST still lives here
|
||||
|
||||
|
||||
# ---------- viewer two-row-header CSS (phase 34 task 04) ----------
|
||||
|
||||
|
||||
def test_viewer_two_row_header_css() -> None:
|
||||
"""Phase 34 task 04: the viewer header is two rows — row 1 reuses
|
||||
the .app-header / .header-inner rules verbatim (the pinned
|
||||
--header-h height still applies to row 1), row 2 is the
|
||||
.doc-titlebar: a quiet --line border-top separator, a flex
|
||||
.container row, its own content-sized height. The old single-row
|
||||
.doc-header-actions / .doc-header-inner rules are gone, .doc-header
|
||||
no longer pins a fixed height, and .doc-title-block keeps
|
||||
min-width: 0 so #doc-title / #doc-meta ellipsize in the row."""
|
||||
css = _text(STYLES_CSS)
|
||||
block = re.search(r"\.doc-titlebar\s*\{([^}]*)\}", css)
|
||||
assert block, "styles.css must define .doc-titlebar"
|
||||
body = block.group(1)
|
||||
assert "border-top: 1px solid var(--line)" in body, (
|
||||
"the titlebar separates from row 1 with the quiet hairline"
|
||||
)
|
||||
assert "height: var(--header-h)" not in body, (
|
||||
"the titlebar row is content-sized (title line + meta line)"
|
||||
)
|
||||
assert re.search(r"\.doc-titlebar\s*\.container\s*\{[^}]*display:\s*flex", css), (
|
||||
"the titlebar row must be a flex row (back link + title block)"
|
||||
)
|
||||
assert re.search(r"\.doc-header-actions\s*\{", css) is None, (
|
||||
"the old single-row actions cluster rule is gone"
|
||||
)
|
||||
assert re.search(r"\.doc-header-inner\s*\{", css) is None, (
|
||||
"the old single-row wrapper rule is gone"
|
||||
)
|
||||
header_block = re.search(r"\.doc-header\s*\{([^}]*)\}", css)
|
||||
assert header_block, "styles.css must still style the .doc-header header element"
|
||||
assert "height: var(--header-h)" not in header_block.group(1), (
|
||||
"the two-row header is content-sized — row 1 keeps the pinned height"
|
||||
)
|
||||
assert re.search(r"\.doc-title-block\s*\{[^}]*min-width:\s*0", css), (
|
||||
"the title block must keep clipping while the row stays tidy"
|
||||
)
|
||||
|
||||
|
||||
def test_failed_sync_button_carries_the_error_look() -> None:
|
||||
"""Phase 34 task 04: the #sync-btn now lives on every page, and the
|
||||
non-Sources pages have no error banner — the failed state must be
|
||||
visible on the button itself. header.js adds .is-error (with the
|
||||
sanitized error in title / aria-label); styles.css must render it
|
||||
with the phase-08 error pair (--err-ink on --err-bg ≈9.1:1,
|
||||
--err-line border — never the amber deflection accent)."""
|
||||
css = _text(STYLES_CSS)
|
||||
block = re.search(r"\.sync-btn\.is-error\s*\{([^}]*)\}", css)
|
||||
assert block, "styles.css must define the failed .sync-btn look"
|
||||
body = block.group(1)
|
||||
assert "var(--err-bg)" in body
|
||||
assert "var(--err-ink)" in body
|
||||
assert "var(--accent-" not in body, "the amber deflection accent is never on errors"
|
||||
|
||||
+170
-78
@@ -3,10 +3,13 @@
|
||||
The browser behavior is E2E-covered (tests/e2e/test_sync_button.py,
|
||||
task 03); here we pin the source-level wiring — the anonymous-safe
|
||||
ship-hidden button markup, the header.js admin reveal on the SAME
|
||||
cached whoami (no extra fetch), the sources.js sync state machine
|
||||
(2 s poll, 202 start / 409 adoption / 403 hide, terminal labels,
|
||||
the aria-live result, the single-poll-loop guard, no client-side hard
|
||||
timeout), the §7.4 never-stale CSS (spin + reduced-motion opt-out,
|
||||
cached whoami (no extra fetch), the header.js sync state machine
|
||||
(moved here from sources.js in phase 34 task 02: 2 s poll, 202 start
|
||||
/ 409 adoption / 403 hide, terminal labels, the "bor:sync-status"
|
||||
event with the status object as detail, the single-poll-loop guard, no
|
||||
client-side hard timeout), the Sources page's event-driven
|
||||
#sync-result line + #sync-error-banner, and the §7.4 never-stale CSS
|
||||
(spin + reduced-motion opt-out,
|
||||
disabled state, 44px floor, contrast pair) — so a silent regression is
|
||||
caught without a browser.
|
||||
"""
|
||||
@@ -117,103 +120,114 @@ def test_sources_page_stays_cdn_free() -> None:
|
||||
|
||||
def test_header_reveals_sync_btn_on_the_admin_branch() -> None:
|
||||
"""initSharedHeader reveals #sync-btn in the SAME admin branch as
|
||||
#nav-sources (querySelector + hidden = !admin) — one cached whoami,
|
||||
no extra whoami call; anonymous users never leave the hidden
|
||||
default."""
|
||||
#nav-sources (hidden = !admin) — one cached whoami, no extra
|
||||
whoami call; anonymous users never leave the hidden default. The
|
||||
ref is the module-level one — the state machine shares it."""
|
||||
js = _text(HEADER_JS)
|
||||
assert 'querySelector("#sync-btn")' in js, "module-level #sync-btn ref"
|
||||
fn = js.find("function initSharedHeader")
|
||||
assert fn != -1
|
||||
body = js[fn : js.find("\n}", fn)]
|
||||
assert 'querySelector("#sync-btn")' in body, "#sync-btn must join the admin reveal"
|
||||
assert "syncBtn.hidden = !admin" in body
|
||||
assert "syncBtn.hidden = !admin" in body, "#sync-btn must join the admin reveal"
|
||||
# The reveal must not introduce a second whoami call site.
|
||||
assert js.count('fetch("/api/whoami")') == 1
|
||||
|
||||
|
||||
# ---------- sources.js: the sync state machine ----------
|
||||
# ---------- header.js: the sync state machine (moved here from
|
||||
# ---------- sources.js in phase 34 task 02) ----------
|
||||
|
||||
|
||||
def test_sources_js_calls_the_sync_api() -> None:
|
||||
def test_header_js_owns_the_sync_button_elements() -> None:
|
||||
"""The button refs are module-level and null-safe: #sync-btn,
|
||||
#sync-label, the .sync-icon inside the button — a page without the
|
||||
markup is a complete no-op, exactly like the rest of the module."""
|
||||
js = _text(HEADER_JS)
|
||||
assert 'querySelector("#sync-btn")' in js
|
||||
assert 'querySelector("#sync-label")' in js
|
||||
assert 'syncBtn.querySelector(".sync-icon")' in js
|
||||
|
||||
|
||||
def test_header_js_calls_the_sync_api() -> None:
|
||||
"""The click posts to POST /api/sync and the poll loop GETs
|
||||
/api/sync/status — both through the same-origin API (A10)."""
|
||||
js = _text(SOURCES_JS)
|
||||
js = _text(HEADER_JS)
|
||||
assert 'fetch("/api/sync", { method: "POST" })' in js
|
||||
assert 'fetch("/api/sync/status")' in js
|
||||
|
||||
|
||||
def test_sources_js_polls_every_2000ms() -> None:
|
||||
def test_header_js_polls_every_2000ms() -> None:
|
||||
"""The feedback loop is a 2000 ms poll of the status endpoint,
|
||||
re-scheduled one tick at a time (setTimeout, not setInterval — an
|
||||
in-flight fetch can never overlap the next tick)."""
|
||||
js = _text(SOURCES_JS)
|
||||
js = _text(HEADER_JS)
|
||||
assert "SYNC_POLL_MS = 2000" in js
|
||||
assert "setTimeout(tick, SYNC_POLL_MS)" in js
|
||||
assert "setInterval" not in js
|
||||
|
||||
|
||||
def test_sources_js_adopts_409_and_starts_on_202() -> None:
|
||||
def test_header_js_adopts_409_and_starts_on_202() -> None:
|
||||
"""202 (started) and 409 (a run started elsewhere — e.g. a second
|
||||
tab) both enter the running state and start polling: the UI never
|
||||
starts a second run, it adopts the in-flight one."""
|
||||
js = _text(SOURCES_JS)
|
||||
js = _text(HEADER_JS)
|
||||
assert "r.status === 202 || r.status === 409" in js
|
||||
idx = js.find("r.status === 202 || r.status === 409")
|
||||
branch = js[idx : idx + 200]
|
||||
assert "enterRunningState()" in branch
|
||||
branch = js[idx : idx + 400]
|
||||
assert "enterSyncRunningState()" in branch
|
||||
assert "startSyncPolling()" in branch
|
||||
|
||||
|
||||
def test_sources_js_hides_the_button_on_403() -> None:
|
||||
"""A 403 anywhere (POST or poll) is treated as not-admin: the
|
||||
button hides — defense in depth behind header.js's whoami reveal."""
|
||||
js = _text(SOURCES_JS)
|
||||
for occurrence in re.finditer(r"r\.status === 403", js):
|
||||
window = js[occurrence.start() : occurrence.start() + 400]
|
||||
assert "syncBtn.hidden = true" in window, "every 403 branch must hide the button"
|
||||
def test_header_js_hides_the_button_on_403() -> None:
|
||||
"""A 403 anywhere (POST, the status poll, the load re-attach) is
|
||||
treated as not-admin: the button hides — defense in depth behind
|
||||
the whoami reveal (the primary gate)."""
|
||||
js = _text(HEADER_JS)
|
||||
assert len(re.findall(r"r\.status === 403", js)) >= 3, (
|
||||
"POST, the status poll, and the load re-attach must all handle 403"
|
||||
)
|
||||
assert js.count("syncBtn.hidden = true") >= 3, (
|
||||
"every 403 branch must hide the button"
|
||||
)
|
||||
|
||||
|
||||
def test_sources_js_running_state_is_never_stale() -> None:
|
||||
def test_header_js_running_state_is_never_stale() -> None:
|
||||
"""Entering the running state disables the button, sets aria-busy,
|
||||
spins the icon, and swaps the label to 'Syncing…' (the §7.4
|
||||
feedback while the poll waits)."""
|
||||
js = _text(SOURCES_JS)
|
||||
fn = js.find("function enterRunningState")
|
||||
assert fn != -1
|
||||
body = js[fn : js.find("\n}", fn)]
|
||||
feedback while the poll waits) — and a fresh run starts clean: the
|
||||
previous failure's title / aria-label / .is-error come off NOW,
|
||||
not when the run settles."""
|
||||
js = _text(HEADER_JS)
|
||||
body = _body(js, "enterSyncRunningState")
|
||||
assert "syncBtn.disabled = true" in body
|
||||
assert 'syncBtn.setAttribute("aria-busy", "true")' in body
|
||||
assert 'syncBtn.removeAttribute("title")' in body
|
||||
assert 'syncBtn.setAttribute("aria-label", "Sync sources")' in body
|
||||
assert "syncBtn.classList.remove(\"is-error\")" in body
|
||||
assert "syncIcon.classList.add(\"is-spinning\")" in body
|
||||
assert '"Syncing…"' in body
|
||||
|
||||
|
||||
def test_sources_js_terminal_states() -> None:
|
||||
def test_header_js_terminal_states() -> None:
|
||||
"""Terminal rendering: success → enabled + 'Synced HH:MM' (local
|
||||
time of finished_at) + the last-result counts ('added' always
|
||||
announced, zero terms omitted — a no-op re-sync reads '0 added ·
|
||||
1 unchanged', never an empty live region) + a live catalog refresh
|
||||
(the KB just changed — never a stale table); failed → enabled +
|
||||
retry-ready 'Sync sources' label + the role='alert' banner with
|
||||
the error; the result is cleared on a failure."""
|
||||
js = _text(SOURCES_JS)
|
||||
time of finished_at); failed → enabled + retry-ready 'Sync sources'
|
||||
label + the sanitized error in the button's title + aria-label +
|
||||
the .is-error class (non-Sources pages: that is where the failure
|
||||
is visible). The counts formatting (fmtSyncResult) lives here and
|
||||
is EXPORTED for the Sources page ('added' always announced, zero
|
||||
terms omitted — a no-op re-sync reads '0 added · 1 unchanged')."""
|
||||
js = _text(HEADER_JS)
|
||||
|
||||
success = _body(js, "applySyncSuccess")
|
||||
assert '"Synced"' in success and "fmtSyncTime(status.finished_at)" in success
|
||||
assert "fmtSyncResult(status.detail)" in success
|
||||
# A successful sync just changed the KB: the catalog re-fetches live
|
||||
# (table / stats / empty state never sit stale under "Synced").
|
||||
assert "loadDocs()" in success
|
||||
|
||||
failure = _body(js, "applySyncFailure")
|
||||
assert 'settleSyncButton("Sync sources")' in failure # retry-ready
|
||||
assert "showSyncError(status.error)" in failure
|
||||
assert "syncBtn.title = error" in failure
|
||||
assert 'syncBtn.setAttribute("aria-label", error)' in failure
|
||||
assert "syncBtn.classList.add(\"is-error\")" in failure
|
||||
assert "sanitizeSyncError(status.error)" in failure
|
||||
|
||||
result = _body(js, "fmtSyncResult")
|
||||
# "added" is the always-announced headline term; "unchanged" covers
|
||||
# the no-op case ("0 added · 1 unchanged"); updated/pruned are
|
||||
# zero-omitted.
|
||||
assert "added" in result and "unchanged" in result
|
||||
assert " · " in result
|
||||
assert "> 0" in result, "zero terms must be omitted"
|
||||
@@ -222,26 +236,38 @@ def test_sources_js_terminal_states() -> None:
|
||||
assert "getHours()" in time and "getMinutes()" in time, "local HH:MM of finished_at"
|
||||
|
||||
|
||||
def test_sources_js_settles_the_button_on_terminal() -> None:
|
||||
"""settleSyncButton re-enables the control, drops aria-busy, and
|
||||
un-spins the icon — the button can never sit disabled after a run
|
||||
reaches a terminal state (failed included: retry-ready)."""
|
||||
js = _text(SOURCES_JS)
|
||||
fn = js.find("function settleSyncButton")
|
||||
assert fn != -1
|
||||
body = js[fn : js.find("\n}", fn)]
|
||||
def test_header_js_failed_error_is_sanitized() -> None:
|
||||
"""The button's title/aria-label error is sanitized for the
|
||||
attributes: the server already masks credentials (sync.py
|
||||
_sanitize_error); the module collapses whitespace to a single line
|
||||
and caps the length, and a missing error still names a failure."""
|
||||
js = _text(HEADER_JS)
|
||||
body = _body(js, "sanitizeSyncError")
|
||||
assert "replace(/\\s+/g, \" \")" in body, "single line for the attributes"
|
||||
assert "200" in body, "long errors (chatty git stderr) are capped"
|
||||
assert '"The sync failed."' in body
|
||||
|
||||
|
||||
def test_header_js_settles_the_button_on_terminal() -> None:
|
||||
"""settleSyncButton re-enables the control, drops aria-busy, the
|
||||
title, and the failed affordances, and un-spins the icon — the
|
||||
button can never sit disabled after a run reaches a terminal state
|
||||
(failed included: retry-ready)."""
|
||||
js = _text(HEADER_JS)
|
||||
body = _body(js, "settleSyncButton")
|
||||
assert "syncBtn.disabled = false" in body
|
||||
assert 'syncBtn.removeAttribute("aria-busy")' in body
|
||||
assert 'syncBtn.removeAttribute("title")' in body
|
||||
assert 'syncBtn.setAttribute("aria-label", "Sync sources")' in body
|
||||
assert "syncIcon.classList.remove(\"is-spinning\")" in body
|
||||
|
||||
|
||||
def test_sources_js_never_starts_a_second_poll_loop() -> None:
|
||||
def test_header_js_never_starts_a_second_poll_loop() -> None:
|
||||
"""startSyncPolling is guarded by the module-level timer: a 409
|
||||
adoption, a reload re-attach, or a stray call can never run two
|
||||
poll loops at once (phase completion criterion)."""
|
||||
js = _text(SOURCES_JS)
|
||||
js = _text(HEADER_JS)
|
||||
fn = js.find("function startSyncPolling")
|
||||
assert fn != -1
|
||||
head = js[fn : js.find("const tick", fn)]
|
||||
assert re.search(r"if\s*\(\s*syncPollTimer\s*!==\s*null\s*\)\s*return", head), (
|
||||
"the single-loop guard must be the first statement"
|
||||
@@ -249,37 +275,103 @@ def test_sources_js_never_starts_a_second_poll_loop() -> None:
|
||||
assert "clearTimeout(syncPollTimer)" in _body(js, "stopSyncPolling")
|
||||
|
||||
|
||||
def test_sources_js_has_no_client_side_hard_timeout() -> None:
|
||||
"""Phase locked decision: a sync can legitimately run for minutes,
|
||||
so there is NO client-side hard timeout — the 2 s poll is the
|
||||
feedback loop and the server state is authoritative (the 120 s
|
||||
LLM-turn guard must not leak into the sync path)."""
|
||||
js = _text(SOURCES_JS)
|
||||
def test_header_js_has_no_client_side_hard_timeout() -> None:
|
||||
"""Phase locked decision: a sync can legitimately run for minutes
|
||||
(and outlive the page), so there is NO client-side hard timeout —
|
||||
the 2 s poll is the feedback loop and the server state is
|
||||
authoritative (the 120 s LLM-turn guard must not leak into the
|
||||
sync path)."""
|
||||
js = _text(HEADER_JS)
|
||||
assert "TURN_TIMEOUT" not in js
|
||||
assert "120" not in js[js.find("Phase 32") :], (
|
||||
"no turn-timeout constant in the sync section"
|
||||
)
|
||||
sync_start = js.find("sync sources (phase 32")
|
||||
assert sync_start != -1, "the sync section marker comment"
|
||||
assert "120" not in js[sync_start:]
|
||||
|
||||
|
||||
def test_sources_js_reattaches_on_load() -> None:
|
||||
"""initSyncButton (run from the IIFE on the admin path, after
|
||||
initSharedHeader) fetches the status once and re-enters the running
|
||||
state on 'running' (reload mid-sync) or renders the last result on
|
||||
a terminal state; the click binding wires startSync to the button."""
|
||||
js = _text(SOURCES_JS)
|
||||
def test_header_js_reattaches_on_load_admin_only() -> None:
|
||||
"""initSyncButton (run at module import, button pages only) awaits
|
||||
the SAME cached whoami — ADMIN ONLY (non-admins never poll, the
|
||||
status endpoint is admin-only): a running run re-enters the
|
||||
running state (reload mid-sync), a terminal run renders its last
|
||||
result, idle settles retry-ready; the click binding wires
|
||||
startSync to the button."""
|
||||
js = _text(HEADER_JS)
|
||||
fn = js.find("function initSyncButton")
|
||||
assert fn != -1
|
||||
body = js[fn : js.find("\n}\n", fn)]
|
||||
assert "await fetchIsAdmin()" in body, "admin-only boot (no extra fetch)"
|
||||
assert 'fetch("/api/sync/status")' in body
|
||||
assert 'status.state === "running"' in body
|
||||
assert 'status.state === "success"' in body
|
||||
assert 'status.state === "failed"' in body
|
||||
assert "syncBtn.addEventListener(\"click\", startSync)" in js
|
||||
# The IIFE runs it on the admin path only (after the whoami gate).
|
||||
iife = js[js.find("(async () => {") :]
|
||||
admin_idx = iife.find("await isAdmin()")
|
||||
init_idx = iife.find("initSyncButton();")
|
||||
assert -1 < admin_idx < init_idx, "re-attach must run only for the admin"
|
||||
tail = js[js.rfind("if (syncBtn)") :]
|
||||
assert "initSyncButton()" in tail, "boot re-attach runs at module import"
|
||||
|
||||
|
||||
def test_header_js_emits_bor_sync_status_on_state_changes() -> None:
|
||||
"""Every state change dispatches window 'bor:sync-status' with the
|
||||
status object as detail — the channel the Sources page's
|
||||
banner/result line subscribe to. The click path emits the
|
||||
synthetic running frame IMMEDIATELY (no 2 s poll lag — the exact
|
||||
old enterRunningState clear behavior, now event-driven)."""
|
||||
js = _text(HEADER_JS)
|
||||
assert (
|
||||
'window.dispatchEvent(new CustomEvent("bor:sync-status", { detail: status }))'
|
||||
in js
|
||||
)
|
||||
for fn in ("applySyncSuccess", "applySyncFailure", "applySyncIdle"):
|
||||
assert "emitSyncStatus" in _body(js, fn), f"{fn} must emit its frame"
|
||||
# the running frame: synthetic on click, the real object on boot
|
||||
assert 'emitSyncStatus({ state: "running" })' in js
|
||||
assert "emitSyncStatus(status)" in _body(js, "initSyncButton")
|
||||
|
||||
|
||||
# ---------- sources.js: the event-driven result line + banner ----------
|
||||
|
||||
|
||||
def test_sources_js_renders_off_the_sync_status_event() -> None:
|
||||
"""The Sources page keeps ONLY its page-specific rendering:
|
||||
#sync-result (aria-live) + #sync-error-banner (role=alert), driven
|
||||
by the module's 'bor:sync-status' event (detail = the status
|
||||
object): running → clear + hide; success → the counts (the
|
||||
imported fmtSyncResult) + a live catalog refresh; failed → the
|
||||
banner with the error; idle → hide + clear."""
|
||||
js = _text(SOURCES_JS)
|
||||
assert 'window.addEventListener("bor:sync-status"' in js
|
||||
assert 'status.state === "running"' in js
|
||||
assert 'status.state === "success"' in js
|
||||
assert 'status.state === "failed"' in js
|
||||
assert "fmtSyncResult(status.detail)" in js
|
||||
assert "loadDocs()" in js, "the catalog re-fetches live on a successful sync"
|
||||
assert "showSyncError(status.error)" in js
|
||||
assert "syncResult.textContent" in js
|
||||
|
||||
|
||||
def test_sources_js_no_longer_owns_the_sync_machine() -> None:
|
||||
"""The state machine is GONE from sources.js (header.js owns it):
|
||||
no button refs, no POST, no status poll, no button-state helpers,
|
||||
no click binding, no load re-attach."""
|
||||
js = _text(SOURCES_JS)
|
||||
for gone in (
|
||||
"SYNC_POLL_MS",
|
||||
"syncPollTimer",
|
||||
"startSyncPolling",
|
||||
"stopSyncPolling",
|
||||
"enterRunningState",
|
||||
"settleSyncButton",
|
||||
"applySyncSuccess",
|
||||
"applySyncFailure",
|
||||
"applySyncIdle",
|
||||
"initSyncButton",
|
||||
"startSync",
|
||||
'fetch("/api/sync", { method: "POST" })',
|
||||
'fetch("/api/sync/status")',
|
||||
'querySelector("#sync-btn")',
|
||||
'querySelector("#sync-label")',
|
||||
'querySelector(".sync-icon")',
|
||||
):
|
||||
assert gone not in js, f"{gone!r} must be gone from sources.js (header.js owns it)"
|
||||
|
||||
|
||||
# ---------- styles.css: the §7.4 states ----------
|
||||
|
||||
Reference in New Issue
Block a user