Files
member-dashboard/tests/check-page-js.sh
T
inference-admin c5d4677ec3 chart module: re-pin to the canonical revision that adds the definition layer
Same byte-identical module as the panel; the dashboard's own port to the shared
definitions is the next commit. check-page-js.sh's DOM stub now supports
setAttribute/insertAdjacentHTML, which the shared metric-button builder needs.
2026-11-13 20:55:52 +00:00

100 lines
4.1 KiB
Bash
Executable File

#!/usr/bin/env bash
# Pre-deploy check for the panel/dashboard PAGE_HTML frontends.
#
# scripts/check-page-js.sh <path/to/app/main.py> [harness.js]
#
# 1. Slices PAGE_HTML out of the SOURCE TEXT. Do NOT import the module instead:
# app/oidc.py needs authlib, which is not installed on the steward host.
# 2. Extracts the single <script> block and runs `node --check` on it.
# 3. Given a harness file, runs stub + page JS + harness in ONE node eval scope,
# so the harness can call the page's real functions against real data.
#
# Never skip step 2. It is load-bearing, not ritual: it has caught a broken
# string escape and a duplicate `const` that py_compile passed, either of which
# blanks every data table on the live page.
#
# Harness rules (learned the hard way — see references/panel-and-dashboard-patterns.md):
# * Assert invariants, not the shape you happened to observe. Parse the
# rendered markup into value/position pairs and check the RELATIONSHIP.
# * A regex ending in `<` swallows the closing bracket and garbles every
# captured label. Match `[^<]*` and stop.
# * parseFloat("10-28") is 10. Date labels impersonate numeric ticks; filter
# them out by their dash before trusting a numeric parse.
# * When a check fails, suspect the ASSERTION first and fix it — never loosen
# it to get a green run.
set -euo pipefail
MAIN="${1:?usage: check-page-js.sh <path/to/app/main.py> [harness.js]}"
HARNESS="${2:-}"
TMP="$(mktemp -d)"
trap 'rm -rf "$TMP"' EXIT
python3 - "$MAIN" "$TMP/page.js" <<'PY'
import re, sys
src = open(sys.argv[1]).read()
marker = 'PAGE_HTML = """'
start = src.index(marker) + len(marker)
html = src[start:src.index('"""', start)]
blocks = re.findall(r"<script>(.*?)</script>", html, re.S)
if len(blocks) != 1:
sys.exit(f"expected exactly 1 <script> block in PAGE_HTML, found {len(blocks)}")
js = blocks[0]
# Splice the shared chart module exactly as the app does at import time, so
# the checked/eval'd JS is what actually serves. The placeholder is a comment,
# and a missing module file leaves the placeholder in place (the harness then
# fails loudly on the missing CoOpChart instead of silently checking stale JS).
from pathlib import Path
placeholder = "/*@@CHART_MODULE@@*/"
if placeholder in js:
module = Path(sys.argv[1]).resolve().parent / "coop_chart.js"
if module.exists():
js = js.replace(placeholder, module.read_text())
print(f"spliced shared chart module ({module.name}) into the extracted page JS")
open(sys.argv[2], "w").write(js)
print(f"extracted {len(js)} chars of page JS from PAGE_HTML")
PY
node --check "$TMP/page.js"
echo "node --check: OK"
if [ -n "$HARNESS" ]; then
cat > "$TMP/stub.js" <<'JS'
// Minimal browser stubs, loaded BEFORE the page JS: these pages call
// load()/loadModels() at the end of the script, which need document + fetch.
const els = {};
const mkEl = (id) => {
const el = {
id, style: {}, textContent: "", innerHTML: "", className: "",
offsetWidth: 120, offsetHeight: 48,
getAttribute: () => null,
setAttribute: () => {},
appendChild: () => {},
};
// The pages build some markup by inserting HTML into a container
// (buildMetricButtons inserts the SHARED metric list), so the stub has to
// support it or the harness cannot exercise that path at all.
el.insertAdjacentHTML = (pos, html) => { el.innerHTML += html; };
return el;
};
globalThis.document = {
getElementById: (id) => (els[id] = els[id] || mkEl(id)),
querySelectorAll: () => [],
body: { innerHTML: "", appendChild: (el) => { globalThis.__lastAppended = el; } },
createElement: (tag) => mkEl(undefined),
addEventListener: (type, fn) => { (globalThis.__listeners = globalThis.__listeners || {})[type] = fn; },
};
globalThis.fetch = async () => ({
status: 200,
json: async () => ({ series: [], totals: {}, members: [], admins: [], models: [] }),
});
globalThis.window = {
innerWidth: 1440,
innerHeight: 900,
addEventListener: (type, fn) => {},
};
JS
node -e 'const fs=require("fs"), r=p=>fs.readFileSync(p,"utf8");
eval(r(process.argv[1]) + r(process.argv[2]) + r(process.argv[3]));' \
"$TMP/stub.js" "$TMP/page.js" "$HARNESS"
fi