59739cc7fd
The second audit pass. Four things, and the first two were reported. The Prompts page put a screen of variables and a screen of preview above the editor, so the tabs began two screens down and switching one had to drag the whole page to be any use -- and on a short tab it could not drag far enough, leaving the panel stranded above a screenful of nothing. Editor first, reference after, bar sticky. Custom themes were three fixed slots: fifty-seven empty colour boxes on a fresh instance and no way to make a fourth theme. One block per theme plus a blank one, colours behind a disclosure. Both measured rather than argued about -- rendered through TestClient and driven under headless Chromium, where the tab bar moved 385->642px before and does not move now, and the themes page went from 5495px to 2820px. Asking where generated images go found the other two. Deleting a chat cascades to the attachment rows and leaves every file on disk; the helper written for exactly that was called from one place, and it was not the delete button, a schedule's chat, a helper's chat or deleting an account. Underneath it, `claim` bound message_id and never chat_id, so anything picked before a chat existed kept an empty chat_id forever -- which six readers filter on, so those files were also unnamed in the prompt, unopenable in the canvas, and invisible to the one caller the cleanup had. And folders nest now. The route has handled parent_id since folders existed, with a cycle guard and a depth cap the move path never applied; the sidebar has always drawn a tree. Nothing could ask for one. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
451 lines
17 KiB
Python
451 lines
17 KiB
Python
"""Making an instance somebody else's.
|
|
|
|
Three things are worth pinning here and the rest follows from them: that a
|
|
default is never stored, that the snapshot is dropped when it changes, and that
|
|
a colour reaching a stylesheet is a colour and not whatever was typed.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import pytest
|
|
from fastapi.testclient import TestClient
|
|
|
|
from lembas.services import branding, settings_store
|
|
|
|
|
|
@pytest.fixture(autouse=True)
|
|
def clean(db):
|
|
branding.forget()
|
|
yield
|
|
branding.forget()
|
|
|
|
|
|
def _identity(client: TestClient, *, files=None, **fields):
|
|
return client.post(
|
|
"/admin/customization/identity",
|
|
data={"instance_name": "", "tagline": "", **fields},
|
|
files=files,
|
|
follow_redirects=False,
|
|
)
|
|
|
|
|
|
# --- Defaults in code, overrides in the database --------------------------------
|
|
def test_the_shipped_wording_is_never_stored_as_an_override(db, client, registered):
|
|
"""The prompt-fragment rule, and the reason the page can render every
|
|
flavour string as a box: leaving one alone must not freeze it, or a later
|
|
release improving the wording would reach nobody who had ever pressed Save.
|
|
|
|
Blanked rather than dropped, because `settings_store.update` merges — an
|
|
omitted key leaves whatever was stored last time, so dropping would make
|
|
"I typed the default back" and "I changed nothing" store different things.
|
|
"""
|
|
client.post(
|
|
"/admin/customization/flavour",
|
|
data={key: value for key, (_, _, value) in branding.FLAVOUR.items()}
|
|
| {f"text_{key}": value for key, (_, _, value) in branding.FLAVOUR.items()},
|
|
follow_redirects=False,
|
|
)
|
|
|
|
stored = settings_store.get_group(db, branding.BRANDING)
|
|
written = {key for key, value in stored.items() if key.startswith("text_") and value}
|
|
assert written == set()
|
|
|
|
|
|
def test_an_override_is_written_and_read_back(db, client, registered):
|
|
client.post(
|
|
"/admin/customization/flavour",
|
|
data={"text_error_404": "There is nothing here."},
|
|
follow_redirects=False,
|
|
)
|
|
|
|
assert branding.snapshot().text["error_404"] == "There is nothing here."
|
|
# And the others still say what they always did.
|
|
assert branding.snapshot().text["error_403"] == branding.FLAVOUR["error_403"][2]
|
|
|
|
|
|
def test_clearing_a_box_gives_the_shipped_wording_back(db, client, registered):
|
|
client.post(
|
|
"/admin/customization/flavour", data={"text_error_404": "Gone."}, follow_redirects=False
|
|
)
|
|
client.post(
|
|
"/admin/customization/flavour", data={"text_error_404": ""}, follow_redirects=False
|
|
)
|
|
|
|
assert branding.snapshot().text["error_404"] == branding.FLAVOUR["error_404"][2]
|
|
|
|
|
|
def test_a_string_not_submitted_is_left_alone(db, client, registered):
|
|
"""The page posts one card at a time, so a save of the identity must not
|
|
wipe the wording. `save_flavour` only touches keys the form carried."""
|
|
client.post(
|
|
"/admin/customization/flavour", data={"text_error_404": "Gone."}, follow_redirects=False
|
|
)
|
|
_identity(client, instance_name="Rivendell")
|
|
|
|
assert branding.snapshot().text["error_404"] == "Gone."
|
|
assert branding.snapshot().name == "Rivendell"
|
|
|
|
|
|
# --- The cache ------------------------------------------------------------------
|
|
def test_a_save_drops_the_snapshot(db, client, registered):
|
|
"""A process-level cache read by a Jinja global. A save that did not drop it
|
|
would take effect at the next restart, which is a control that looks like it
|
|
worked and did nothing -- the failure this codebase keeps cataloguing."""
|
|
assert branding.snapshot().name == "LLeMbas"
|
|
|
|
_identity(client, instance_name="Rivendell")
|
|
|
|
assert branding.snapshot().name == "Rivendell"
|
|
assert "Rivendell" in client.get("/chat").text
|
|
|
|
|
|
def test_the_name_reaches_the_title_and_the_model(db, client, registered):
|
|
from lembas.services import harness
|
|
|
|
_identity(client, instance_name="Rivendell")
|
|
|
|
assert "<title>New chat - Rivendell</title>" in client.get("/chat").text
|
|
assert harness.context_variables(db, None, [])["instance_name"] == "Rivendell"
|
|
|
|
|
|
def test_a_name_stored_by_an_older_version_is_kept(db, registered):
|
|
"""`instance_name` lived in the general group before there was a branding
|
|
one. An upgrade must not quietly rename somebody's instance back."""
|
|
settings_store.update(db, {"instance_name": "Rivendell"})
|
|
branding.forget()
|
|
|
|
assert branding.snapshot().name == "Rivendell"
|
|
|
|
|
|
def test_the_legacy_name_is_a_seed_and_not_a_fallback(db, client, registered):
|
|
"""Consulted only while the branding group has nothing of its own. A
|
|
fallback read every time would resurrect the old name underneath a cleared
|
|
one, which is exactly what a cleared reasoning effort documents."""
|
|
settings_store.update(db, {"instance_name": "Rivendell"})
|
|
branding.forget()
|
|
_identity(client, instance_name="Bree")
|
|
assert branding.snapshot().name == "Bree"
|
|
|
|
_identity(client, instance_name="")
|
|
assert branding.snapshot().name == "LLeMbas"
|
|
|
|
|
|
# --- Themes ---------------------------------------------------------------------
|
|
def _save_theme(client, **fields):
|
|
return client.post(
|
|
"/admin/customization/themes",
|
|
data={"theme_0_id": "dusk", "theme_0_label": "Dusk", "theme_0_base": "moria", **fields},
|
|
follow_redirects=False,
|
|
)
|
|
|
|
|
|
def test_a_custom_theme_becomes_a_rule(db, client, registered):
|
|
_save_theme(client, theme_0_bg="#123456", theme_0_accent="#abcdef")
|
|
|
|
css = client.get("/branding.css").text
|
|
assert ':root[data-theme="dusk"]' in css
|
|
assert "--bg: #123456;" in css
|
|
assert "--accent: #abcdef;" in css
|
|
|
|
|
|
def test_the_soft_variants_are_derived(db, client, registered):
|
|
"""The same colour at 14%. An administrator who set an accent without them
|
|
would get focus rings in the old hue, which reads as the setting
|
|
half-working rather than as a field they missed."""
|
|
_save_theme(client, theme_0_accent="#8FB3CC")
|
|
|
|
assert "--accent-soft: rgba(143, 179, 204, 0.14);" in client.get("/branding.css").text
|
|
|
|
|
|
def test_a_value_that_is_not_a_colour_is_dropped(db, client, registered):
|
|
"""It reaches a stylesheet, so a `}` in one would end the rule and silently
|
|
break every rule after it, and `url(...)` in a colour slot is a request to a
|
|
third party from every page."""
|
|
_save_theme(
|
|
client,
|
|
theme_0_bg="#123456} body { display: none } .x {",
|
|
theme_0_accent="url(http://evil.test/x)",
|
|
theme_0_ink="#fff",
|
|
)
|
|
|
|
css = client.get("/branding.css").text
|
|
assert "display: none" not in css
|
|
assert "evil.test" not in css
|
|
assert "--ink: #fff;" in css
|
|
|
|
|
|
def test_a_token_nobody_offered_is_dropped(db):
|
|
"""Validated on **read**, so a theme written straight into the settings
|
|
table -- or stored by an earlier version -- still has to produce a
|
|
stylesheet that parses."""
|
|
brand = branding.build(
|
|
{"themes": [{"id": "dusk", "tokens": {"bg": "#111", "position": "absolute"}}]}
|
|
)
|
|
|
|
assert brand.theme("dusk").tokens == {"bg": "#111"}
|
|
|
|
|
|
def test_a_theme_cannot_take_a_built_in_name(db):
|
|
brand = branding.build({"themes": [{"id": "moria", "tokens": {"bg": "#111"}}]})
|
|
assert len(brand.themes) == 2
|
|
|
|
|
|
def test_a_custom_theme_is_offered_and_can_be_chosen(db, client, registered):
|
|
_save_theme(client, theme_0_bg="#123456")
|
|
|
|
page = client.get("/chat").text
|
|
assert 'data-themes="moria:moria shire:shire dusk:moria"' in page
|
|
assert client.post("/api/preferences/theme", json={"theme": "dusk"}).json()["ok"] is True
|
|
# And the settings screen lists it by name.
|
|
assert "Dusk" in client.get("/settings").text
|
|
|
|
|
|
def test_an_unknown_theme_is_still_refused(db, client, registered):
|
|
assert client.post("/api/preferences/theme", json={"theme": "dusk"}).json()["ok"] is False
|
|
|
|
|
|
def test_a_light_theme_carries_its_base(db, client, registered):
|
|
"""`data-base` is what makes it inherit. Without it a custom light theme is
|
|
four light colours on Moria's near-black surfaces."""
|
|
_save_theme(client, theme_0_base="shire", theme_0_bg="#fff")
|
|
|
|
assert branding.snapshot().theme("dusk").base == "shire"
|
|
assert 'dusk:shire' in client.get("/chat").text
|
|
|
|
|
|
def test_tokens_css_matches_the_base_attribute(db):
|
|
"""The other half of that, and it lives in the stylesheet: `shire`'s block
|
|
has to match `[data-base="shire"]` or the inheritance is a comment."""
|
|
from pathlib import Path
|
|
|
|
import lembas
|
|
|
|
css = (Path(lembas.__file__).parent / "web/static/css/tokens.css").read_text()
|
|
assert ':root[data-base="shire"]' in css
|
|
|
|
|
|
def test_clearing_an_id_removes_the_theme(db, client, registered):
|
|
_save_theme(client, theme_0_bg="#123456")
|
|
assert "dusk" in branding.snapshot().theme_ids
|
|
|
|
_save_theme(client, theme_0_id="")
|
|
assert "dusk" not in branding.snapshot().theme_ids
|
|
|
|
|
|
def test_the_page_offers_one_blank_theme_and_no_more(db, client, registered):
|
|
"""It rendered three blocks whether or not anybody had made a theme, so a
|
|
fresh instance opened on fifty-seven empty colour boxes under three
|
|
identical headings -- and the fourth theme was unreachable without editing
|
|
the template. One block per theme plus a single blank one is the
|
|
no-JavaScript way to say "add another"."""
|
|
page = client.get("/admin/customization").text
|
|
assert page.count('name="theme_0_id"') == 1
|
|
assert 'name="theme_1_id"' not in page
|
|
|
|
_save_theme(client, theme_0_bg="#123456")
|
|
page = client.get("/admin/customization").text
|
|
# The saved one, and a fresh blank below it.
|
|
assert 'name="theme_1_id"' in page
|
|
assert 'name="theme_2_id"' not in page
|
|
|
|
|
|
def test_a_fourth_theme_is_reachable(db, client, registered):
|
|
"""Three was a template constant, and the page is what made it a limit."""
|
|
data = {}
|
|
for index, name in enumerate(("one", "two", "three", "four")):
|
|
data[f"theme_{index}_id"] = name
|
|
data[f"theme_{index}_base"] = "moria"
|
|
client.post("/admin/customization/themes", data=data, follow_redirects=False)
|
|
|
|
ids = branding.snapshot().theme_ids
|
|
assert {"one", "two", "three", "four"} <= set(ids)
|
|
|
|
|
|
def test_the_page_stops_offering_at_the_cap(db, client, registered):
|
|
from lembas.api.admin_branding import MAX_THEMES
|
|
|
|
data = {}
|
|
for index in range(MAX_THEMES):
|
|
data[f"theme_{index}_id"] = f"t{index}"
|
|
data[f"theme_{index}_base"] = "moria"
|
|
client.post("/admin/customization/themes", data=data, follow_redirects=False)
|
|
|
|
page = client.get("/admin/customization").text
|
|
assert f'name="theme_{MAX_THEMES}_id"' not in page
|
|
assert "which is the limit" in page
|
|
|
|
|
|
def test_the_cap_is_enforced_on_save_as_well_as_offered(db, client, registered):
|
|
"""The template's job is to stop offering; the route's is to stop accepting.
|
|
A crafted POST is not the page."""
|
|
from lembas.api.admin_branding import MAX_THEMES
|
|
|
|
data = {}
|
|
for index in range(MAX_THEMES + 5):
|
|
data[f"theme_{index}_id"] = f"t{index}"
|
|
data[f"theme_{index}_base"] = "moria"
|
|
client.post("/admin/customization/themes", data=data, follow_redirects=False)
|
|
|
|
custom = [t for t in branding.snapshot().themes if not t.built_in]
|
|
assert len(custom) == MAX_THEMES
|
|
|
|
|
|
def test_a_gap_in_the_middle_does_not_disturb_the_rest(db, client, registered):
|
|
"""Clearing an id leaves a hole in the numbering, and nothing renumbers."""
|
|
data = {}
|
|
for index, name in enumerate(("one", "two", "three")):
|
|
data[f"theme_{index}_id"] = name
|
|
data[f"theme_{index}_base"] = "moria"
|
|
client.post("/admin/customization/themes", data=data, follow_redirects=False)
|
|
|
|
data["theme_1_id"] = ""
|
|
client.post("/admin/customization/themes", data=data, follow_redirects=False)
|
|
|
|
ids = set(branding.snapshot().theme_ids)
|
|
assert "one" in ids and "three" in ids
|
|
assert "two" not in ids
|
|
|
|
|
|
# --- The stylesheet -------------------------------------------------------------
|
|
def test_custom_css_is_served_as_a_stylesheet(db, client, registered):
|
|
"""A route rather than an inline `<style>`, which is a security property
|
|
before it is a caching one: an external stylesheet has no HTML context to
|
|
escape from."""
|
|
client.post(
|
|
"/admin/customization/css",
|
|
data={"custom_css": ".sidebar { border: 0 }"},
|
|
follow_redirects=False,
|
|
)
|
|
|
|
response = client.get("/branding.css")
|
|
assert response.headers["content-type"].startswith("text/css")
|
|
assert ".sidebar { border: 0 }" in response.text
|
|
|
|
|
|
def test_the_link_changes_when_the_stylesheet_does(db, client, registered):
|
|
"""A fixed URL would leave the browser's cache deciding when a rebrand takes
|
|
effect, which is a save that looks like it worked and did nothing."""
|
|
before = client.get("/chat").text
|
|
client.post(
|
|
"/admin/customization/css", data={"custom_css": ".x { color: red }"},
|
|
follow_redirects=False,
|
|
)
|
|
after = client.get("/chat").text
|
|
|
|
def revision(page: str) -> str:
|
|
return page.split("/branding.css?v=", 1)[1].split('"', 1)[0]
|
|
|
|
assert revision(before) != revision(after)
|
|
|
|
|
|
def test_the_stylesheet_is_not_precached_by_the_worker(db):
|
|
"""The worker's cache is versioned by the release; branding changes between
|
|
releases. A precached copy would outlive every rebrand until the next
|
|
version bump."""
|
|
from pathlib import Path
|
|
|
|
import lembas
|
|
|
|
worker = (Path(lembas.__file__).parent / "web/static/js/sw.js").read_text()
|
|
assert "/branding.css" not in worker
|
|
|
|
|
|
# --- Assets ---------------------------------------------------------------------
|
|
PNG = (
|
|
b"\x89PNG\r\n\x1a\n\x00\x00\x00\rIHDR\x00\x00\x00\x01\x00\x00\x00\x01\x08\x06"
|
|
b"\x00\x00\x00\x1f\x15\xc4\x89\x00\x00\x00\nIDATx\x9cc\x00\x01\x00\x00\x05\x00"
|
|
b"\x01\r\n-\xb4\x00\x00\x00\x00IEND\xaeB`\x82"
|
|
)
|
|
|
|
|
|
def test_a_logo_replaces_the_mark_everywhere(db, client, registered):
|
|
_identity(client, files={"logo": ("logo.png", PNG, "image/png")})
|
|
|
|
stored = branding.snapshot().logo_path
|
|
assert stored
|
|
assert f'src="/branding/{stored}"' in client.get("/chat").text
|
|
# Including the sign-in page, which is why the route is unauthenticated.
|
|
client.post("/auth/logout", follow_redirects=False)
|
|
assert f'src="/branding/{stored}"' in client.get("/auth/login").text
|
|
|
|
|
|
def test_an_asset_is_served_to_somebody_who_is_not_signed_in(db, client, registered):
|
|
_identity(client, files={"logo": ("logo.png", PNG, "image/png")})
|
|
stored = branding.snapshot().logo_path
|
|
client.post("/auth/logout", follow_redirects=False)
|
|
|
|
response = client.get(f"/branding/{stored}")
|
|
assert response.status_code == 200
|
|
assert response.headers["x-content-type-options"] == "nosniff"
|
|
|
|
|
|
def test_an_svg_is_refused(db, client, registered):
|
|
"""The one place somebody will most want it, and the one place it is least
|
|
safe: these files are served to people who are not signed in, and an SVG can
|
|
carry a script."""
|
|
response = _identity(
|
|
client, files={"logo": ("logo.svg", b"<svg xmlns='x'></svg>", "image/svg+xml")}
|
|
)
|
|
|
|
assert response.status_code == 200 # the page again, with the reason on it
|
|
assert "SVG" in response.text
|
|
assert branding.snapshot().logo_path == ""
|
|
|
|
|
|
def test_a_path_outside_the_directory_is_refused(db, client, registered):
|
|
assert client.get("/branding/..%2F..%2Flembas.db").status_code == 404
|
|
|
|
|
|
def test_the_launcher_icons_come_from_the_logo(db, client, registered):
|
|
_identity(client, files={"logo": ("logo.png", PNG, "image/png")})
|
|
|
|
icons = branding.snapshot().icon_paths
|
|
assert set(icons) >= {"icon-192", "icon-512", "maskable", "apple-touch", "favicon"}
|
|
manifest = client.get("/manifest.webmanifest").json()["icons"]
|
|
assert all(entry["src"].startswith("/branding/") for entry in manifest)
|
|
assert any(entry["purpose"] == "maskable" for entry in manifest)
|
|
for entry in manifest:
|
|
assert client.get(entry["src"]).status_code == 200
|
|
|
|
|
|
def test_removing_the_logo_takes_its_icons_with_it(db, client, registered):
|
|
_identity(client, files={"logo": ("logo.png", PNG, "image/png")})
|
|
_identity(client, remove_logo="true")
|
|
|
|
assert branding.snapshot().logo_path == ""
|
|
assert branding.snapshot().icon_paths == {}
|
|
# And the manifest is back to the shipped set rather than half of each.
|
|
icons = client.get("/manifest.webmanifest").json()["icons"]
|
|
assert all(entry["src"].startswith("/static/img/") for entry in icons)
|
|
|
|
|
|
# --- The page -------------------------------------------------------------------
|
|
def test_the_page_renders_and_is_in_the_nav(db, client, registered):
|
|
page = client.get("/admin/customization")
|
|
assert page.status_code == 200
|
|
assert 'href="/admin/customization"' in page.text
|
|
# Every flavour string has a box, from the table rather than from a list in
|
|
# the template -- so one added in code appears here with no template change.
|
|
for key in branding.FLAVOUR:
|
|
assert f'name="text_{key}"' in page.text
|
|
|
|
|
|
def test_the_name_is_no_longer_on_general(db, client, registered):
|
|
"""Two controls writing one value is how each becomes the answer to "why did
|
|
my change not stick?". General links to it instead."""
|
|
page = client.get("/admin/general").text
|
|
assert 'name="instance_name"' not in page
|
|
assert 'href="/admin/customization"' in page
|
|
|
|
|
|
def test_only_an_administrator_may_customise(db, client, registered):
|
|
client.post("/auth/logout", follow_redirects=False)
|
|
client.post(
|
|
"/auth/register",
|
|
data={"name": "Sam", "email": "sam@shire.test", "password": "potatoes-po-ta-toes"},
|
|
follow_redirects=False,
|
|
)
|
|
|
|
for path in ("identity", "flavour", "css", "themes"):
|
|
assert client.post(f"/admin/customization/{path}", data={}).status_code == 403
|