* feat(home+news): state-aware /home + /news + admin-edited news section
Squash of the vr/home-page feature work for clean rebase onto main.
Original 18-commit history preserved in branch backup/vr-home-page-pre-rebase.
What's in this PR:
**State-aware /home page**
- New `/home` route with hero + auto-mode + connectors (Asana / GWS /
Atlassian) + lookarounds. Onboarded vs not-onboarded state-machine
branches a single template (`home_not_onboarded.html`); the install
steps, "Setup a new Claude Code" CTA (90-day PAT mint), and per-
connector setup prompts hide once `users.onboarded=TRUE`. A
completion badge replaces them.
- "Mark me as offboarded" button reverses the flag without an SQL UPDATE.
- `users.onboarded BOOLEAN` column added; default FALSE; flipped by the
CLI's `agnes init` post-success POST and the `/admin/users` API.
- Connector setup prompts pre-check whether the tool is already
installed/connected before re-running setup.
- GWS scope set widened to include Google Chat (`chat.spaces`,
`chat.messages`).
**Single template + design tokens**
- `dashboard.html` now extends `base.html` via the new
`{% block layout %}` opt-out (full-width pages skip the 800px
`.container`). Net: every page shares one shell.
- `style-custom.css` `:root` extended with `--space-{7,9,10,12}`,
`--radius-2xl`, `--shadow-{card,elevated}`, `--text-{muted,disabled}`,
`--focus-ring`, `--transition-*`, `--width-{narrow,app,wide}` so
inline page styles can migrate incrementally.
**Auth redirects honor AGNES_HOME_ROUTE**
- `safe_next_path` resolves the configured home route when no `default=`
is passed; OAuth callbacks, magic-link clicks, password form, and
LOCAL_DEV_MODE shortcuts now land on `/home` (or whatever the operator
picked) instead of always /dashboard.
**News section + /news permalink + /admin/news editor**
- Schema-bumped `news_template` table (single versioned entity, draft +
publish gate). `published BOOLEAN` distinguishes draft from public;
monotonically-increasing `version` per save; rows >30d pruned on
save except the currently-displayed published version.
- `/home` bottom-of-page renders the latest published intro with a
"Read more →" link to `/news` (which renders the full body).
- `/admin/news` editor with sandboxed live preview, versions table,
per-row Unpublish, Format-help cheatsheet.
- `agnes admin news show / draft / edit / publish / unpublish /
versions / export` (CLI). Talks to the live server via the
`/api/admin/news/*` endpoints (PAT-authed) — no direct DB access
so it coexists with a running uvicorn.
- **Optimistic-lock guard**: `agnes admin news publish --version N` and
PUT/PATCH endpoints accept `expected_version` and 409 with structured
`{error: "version_conflict", expected, actual, actual_by}` when a
concurrent admin replaced the draft. Edit refuses to overwrite a
draft authored by someone else without `--force` or
`--expect-version`.
- nh3 (Rust-backed ammonia) HTML sanitizer; iframe pre-pass strips
any iframe whose src is not on the YouTube/Vimeo/Loom allowlist;
javascript:/data: schemes blocked everywhere.
- Author CSS vocabulary: `.news-hero` (blue gradient hero block),
`.callout`/`.callout-{info,warn,success,danger}`,
`.video-embed`, `.news-section`, `.news-grid-{2,3}`, `.news-cta` —
all consolidated in `style-custom.css` under "News content
vocabulary (shared)" so /home perex, /news body, and /admin/news
preview share one source of styling.
- Code-inside-`<pre>` contrast fix (was unreadable amber-on-silver).
- `.news-content` table styling (border, header band, row-hover).
**`scripts/dev/run-local.sh`** — local uvicorn launcher. Pulls Google
OAuth client id/secret from GCP Secret Manager
(`AGNES_OAUTH_GCP_PROJECT`-driven, no vendor defaults), points
`AGNES_CLI_DIST_DIR` at `./dist` so the wheel endpoint resolves, and
`--dev` flips `LOCAL_DEV_MODE=1` + `AGNES_HOME_ROUTE=/home` for one-
command iteration. `LOCAL_DEV_MODE=1` also enables the FastAPI debug
toolbar.
**CLAUDE.md "Run tests before every push" section** codifies
`pytest tests/ -n auto -q` as non-negotiable before each push.
**Tests**: 51 + 14 + 8 = 73 new tests across news-template repo,
sanitizer, API, web, CLI; plus updated home/auth/template tests for
the new shared-shell architecture.
Origin docs (gitignored, customer-fork content):
docs/brainstorms/home-page-requirements.md,
docs/plans/2026-05-07-001-feat-home-page-plan.md.
* feat(cli): agnes onboarded {on,off,status} — self-scoped flag toggle
User-facing equivalent of the in-page "Mark me as (off)boarded" button
on /home. POSTs /api/me/onboarded with {onboarded, source}; --source
overrides the audit-log marker so flips made from the CLI vs the web
button vs agnes init automation stay distinguishable.
`status` reads via /api/me/profile (when present); falls back to a
quick body-marker scan of /home so the read path doesn't write an
audit_log row. PAT-authed via cli.client.api_post — same convention
as agnes admin news / agnes admin add-user etc.
Tests: 5 covering on/off/status round-trip, idempotency, and
audit-log source recording. Full suite holds at 12 pre-existing
failures (same set as before).
* ui(nav+home): primary nav reorg + green What's new band + /marketplace link fix
Primary nav (post-rebase audit + per-user feedback):
- Items: Home → Marketplace → Data Packages → Memory. Admin dropdown
for admins only. The "Dashboard" label was renamed Home — point still
resolves through `home_route` so customer instances on /dashboard
still land there.
- Activity Center moved into the Admin dropdown. Per-team adoption
analytics is admin-consumed in practice; the route still allows
any authed user for direct deep-links so existing /home tile +
bookmarks keep working.
- Memory link added (→ /corporate-memory) — was previously buried in
the /home "Look around" tiles.
- Setup local agent + My Stack dropped from main nav. Setup is the
/home install flow's home now; My Stack lives as a tab inside
/marketplace.
/home tweaks:
- Plugin marketplace tile now points at /marketplace (was /store —
legacy from before the marketplace rebrand landed in #230).
- "What's new" section header gets a green band (success-flavored
D1FAE5 background, A7F3D0 border, darker green title) so the
bottom-of-page news block visibly distinguishes from the blue
install-hero at the top. Header strip only — body stays white.
Test fix: test_home_route_resolution renamed `dashboard_link_uses_home_route`
→ `home_link_uses_home_route` and asserts `href="/home">Home` instead
of `href="/home">Dashboard` after the label change.
* fix(home): decouple Step 3 + Connect-tools collapse from server onboarded flag
The server-side `users.onboarded` flip happens through two paths:
1. Explicit user click on "Mark me as onboarded" or `agnes onboarded on`.
2. Implicit `agnes init` POST → /api/me/onboarded on success.
Path 2 produced a UX surprise: an analyst running `agnes init` mid-flow
reloaded /home and saw Step 3 (auto-mode) + Connect-your-tools auto-
collapse to summary bars. They were actively working through those
sections — the install POST never signalled "I'm done with the rest
of setup", just "Agnes itself is installed".
Decouple the section-collapse decision from the server flag:
- Step 1 + Step 2 install blocks: still hidden on `onboarded=TRUE`
(their completion is a hard server signal — Agnes IS installed).
- Step 3 + Connect-your-tools: render flat by default in BOTH states.
Wrapped in `<details class="setup-collapsible" open>` so the
browser's native disclosure handles per-section toggle without JS,
but the `<summary>` is CSS-hidden until the page-level
`data-setup-minimized="1"` attribute is set on `.home-mock`.
- New "Minimize setup view" toggle inside the blue install-hero,
rendered only when onboarded. Click flips the data-attr on
`.home-mock` AND removes the `open` attribute from each
`<details>`. State persists in `localStorage["agnes_home_setup_minimized"]`
so the choice survives reloads but is per-device.
- "Show full setup view" (the same button when minimized) re-opens
both `<details>` and clears localStorage.
When minimized, each `<details>` still has its own native expand/
collapse — click the gray summary bar to peek at one section without
toggling the page-level minimize off.
Tests:
- test_step3_and_connectors_render_flat_when_onboarded_by_default —
asserts `<details class="setup-collapsible" ... open>` for both
sections post-onboarding and the absence of any server-rendered
`data-setup-minimized` attribute on the `.home-mock` root.
- test_minimize_toggle_visible_only_when_onboarded — toggle button
rendered only when onboarded.
Full pytest holds at 12 pre-existing failures (same set).
175 lines
6.3 KiB
Python
175 lines
6.3 KiB
Python
"""HTML sanitizer for the admin-edited news entity.
|
|
|
|
The /home news perex + /news full body are admin-authored HTML rendered
|
|
to every authenticated user, so the sanitizer is the security boundary.
|
|
nh3 (Rust-backed ammonia) is used in allowlist mode: anything not on
|
|
the explicit per-tag attribute list is dropped.
|
|
|
|
Iframe support is gated to a small list of video providers (YouTube,
|
|
Vimeo, Loom). The pre-pass strips any iframe whose `src` is missing or
|
|
not in the allowlist BEFORE handing to nh3 — nh3's own `attribute_filter`
|
|
can drop attributes but not whole elements, so a pre-pass is the
|
|
simplest way to enforce "iframe only when src is YouTube/Vimeo/Loom."
|
|
|
|
The sanitizer is invoked once on save (in the repository's `save_draft`)
|
|
before the row is written. Templates render with `{{ x | safe }}` and
|
|
trust the stored content — no second-pass sanitization on read.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import re
|
|
from urllib.parse import urlparse
|
|
|
|
import nh3
|
|
|
|
|
|
# Tag allowlist for nh3.
|
|
_ALLOWED_TAGS: set[str] = {
|
|
"p", "br", "hr",
|
|
"h1", "h2", "h3", "h4", "h5", "h6",
|
|
"ul", "ol", "li",
|
|
"strong", "em", "b", "i", "u", "s",
|
|
"code", "pre", "blockquote",
|
|
"a", "img",
|
|
"span", "div", "section",
|
|
"table", "thead", "tbody", "tr", "th", "td",
|
|
"details", "summary",
|
|
"figure", "figcaption",
|
|
"iframe",
|
|
}
|
|
|
|
|
|
# Per-tag attribute allowlist. Anything not listed here is stripped by nh3.
|
|
_ATTR_CLASS_TARGETS = {"span", "div", "section", "p",
|
|
"h1", "h2", "h3", "h4", "h5", "h6",
|
|
"table", "td", "th", "blockquote", "a"}
|
|
|
|
_ALLOWED_ATTRIBUTES: dict[str, set[str]] = {
|
|
# `rel` is managed by nh3's `link_rel="noopener noreferrer"` and must
|
|
# NOT appear in this list (nh3 raises ValueError otherwise).
|
|
"a": {"href", "title", "target", "class"},
|
|
"img": {"src", "alt", "width", "height"},
|
|
"iframe": {"src", "title", "width", "height", "allow",
|
|
"allowfullscreen", "frameborder"},
|
|
}
|
|
for _tag in _ATTR_CLASS_TARGETS:
|
|
_ALLOWED_ATTRIBUTES.setdefault(_tag, set()).add("class")
|
|
|
|
|
|
# URL scheme allowlist applied to <a href> / <img src>.
|
|
_ALLOWED_URL_SCHEMES: set[str] = {"http", "https", "mailto"}
|
|
|
|
|
|
# Iframe host allowlist — `src` must start with one of these prefixes
|
|
# (scheme + host + the leading path segment). Pre-pass drops the whole
|
|
# iframe element if `src` is missing or fails this check.
|
|
_IFRAME_SRC_PREFIXES: tuple[str, ...] = (
|
|
"https://www.youtube.com/embed/",
|
|
"https://youtube.com/embed/",
|
|
"https://www.youtube-nocookie.com/embed/",
|
|
"https://youtube-nocookie.com/embed/",
|
|
"https://player.vimeo.com/video/",
|
|
"https://www.loom.com/embed/",
|
|
"https://www.loom.com/share/",
|
|
)
|
|
|
|
|
|
# Pre-pass regex matching opening <iframe ...>, with `re.DOTALL` so multi-
|
|
# line attributes are handled. We strip the WHOLE element (open tag,
|
|
# inner content, close tag) when the src doesn't pass the host check.
|
|
_IFRAME_OPEN_RE = re.compile(r"<iframe\b[^>]*>", re.IGNORECASE | re.DOTALL)
|
|
_SRC_ATTR_RE = re.compile(
|
|
r'\bsrc\s*=\s*(?:"([^"]*)"|\'([^\']*)\'|([^\s>]+))',
|
|
re.IGNORECASE,
|
|
)
|
|
|
|
|
|
def _iframe_src_allowed(open_tag: str) -> bool:
|
|
"""Return True if the `src=` value on an iframe open-tag matches the
|
|
video-host allowlist; False on missing src, malformed src, or
|
|
out-of-allowlist src."""
|
|
m = _SRC_ATTR_RE.search(open_tag)
|
|
if not m:
|
|
return False
|
|
src = (m.group(1) or m.group(2) or m.group(3) or "").strip()
|
|
if not src:
|
|
return False
|
|
return any(src.startswith(prefix) for prefix in _IFRAME_SRC_PREFIXES)
|
|
|
|
|
|
def _strip_disallowed_iframes(html: str) -> str:
|
|
"""Remove `<iframe>...</iframe>` blocks whose src is not in the
|
|
video-host allowlist. nh3 then sees only the surviving iframes plus
|
|
the rest of the document untouched.
|
|
|
|
The walk is destructive (rewrites the string position by position)
|
|
rather than re.sub-based so we can match the close tag cleanly even
|
|
when iframes contain inner whitespace / nested children (rare but
|
|
legal in HTML5)."""
|
|
out_parts: list[str] = []
|
|
i = 0
|
|
while True:
|
|
m = _IFRAME_OPEN_RE.search(html, i)
|
|
if not m:
|
|
out_parts.append(html[i:])
|
|
break
|
|
# Emit text before the iframe.
|
|
out_parts.append(html[i:m.start()])
|
|
open_end = m.end()
|
|
# Find the matching </iframe> (case-insensitive). HTML5 disallows
|
|
# nesting iframes, so the next close tag is the matching one.
|
|
close_re = re.compile(r"</iframe\s*>", re.IGNORECASE)
|
|
close_m = close_re.search(html, open_end)
|
|
if close_m:
|
|
inner_close_end = close_m.end()
|
|
else:
|
|
# Unclosed iframe — drop the rest of the document defensively.
|
|
inner_close_end = len(html)
|
|
|
|
if _iframe_src_allowed(m.group(0)):
|
|
out_parts.append(html[m.start():inner_close_end])
|
|
# else: drop the whole iframe element (open tag + body + close tag).
|
|
i = inner_close_end
|
|
return "".join(out_parts)
|
|
|
|
|
|
def sanitize(html: str | None) -> str:
|
|
"""Sanitize `html` against the news allowlist. Returns "" for None / "".
|
|
|
|
The two-stage pipeline is: (1) strip non-allowlisted iframes via
|
|
regex pre-pass, (2) hand the survivors to nh3 with the tag /
|
|
attribute / url-scheme allowlists. nh3 enforces every other rule —
|
|
event handlers stripped, javascript:/data: schemes blocked, unknown
|
|
tags removed, comments stripped.
|
|
"""
|
|
if not html:
|
|
return ""
|
|
pre = _strip_disallowed_iframes(html)
|
|
return nh3.clean(
|
|
pre,
|
|
tags=_ALLOWED_TAGS,
|
|
attributes=_ALLOWED_ATTRIBUTES,
|
|
url_schemes=_ALLOWED_URL_SCHEMES,
|
|
link_rel="noopener noreferrer",
|
|
strip_comments=True,
|
|
)
|
|
|
|
|
|
def stripped_text(html: str | None, limit: int = 120) -> str:
|
|
"""Return a plain-text preview of `html` clamped to `limit` chars.
|
|
|
|
Used by the admin UI's versions table where each row shows a short
|
|
preview of the intro + body. Strips ALL tags, then collapses
|
|
whitespace and truncates with an ellipsis.
|
|
"""
|
|
if not html:
|
|
return ""
|
|
plain = nh3.clean(html, tags=set(), attributes={}, strip_comments=True)
|
|
plain = " ".join(plain.split()).strip()
|
|
if len(plain) > limit:
|
|
return plain[: limit - 1].rstrip() + "…"
|
|
return plain
|
|
|
|
|
|
__all__ = ["sanitize", "stripped_text"]
|