Skip to content

fix(ra.viewer): escape brand in public render API #103

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
erayack wants to merge 1 commit into
base: master
Choose a base branch
from
+86 −24
Open

fix(ra.viewer): escape brand in public render API #103

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 21 additions & 12 deletions src/ra/viewer/html.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@

import json
from dataclasses import dataclass
from html import escape
from pathlib import Path
import re

from ra.viewer import style
from ra.viewer.trace import RunTrace, load_rollout_dir
Expand Down Expand Up @@ -168,8 +170,12 @@ class Panel:
def trace_panel() -> Panel:
"""The built-in causal-trace panel, reusable by any ``ra`` agent."""

return Panel("trace", "Trace", _TRACE_SECTION, _TRACE_CSS, _TRACE_JS, "renderTrace();")
return Panel(
"trace", "Trace", _TRACE_SECTION, _TRACE_CSS, _TRACE_JS, "renderTrace();"
)


_SHELL_PLACEHOLDER_RE = re.compile(r"__[A-Z_]+__")

_SHELL = r"""<!DOCTYPE html>
<html lang="en">
Expand Down Expand Up @@ -254,17 +260,20 @@ def render_page(
render_calls = "\n ".join(p.render_call for p in panels)
panels_meta = json.dumps([{"id": p.id, "label": p.label} for p in panels])
default = json.dumps(default_view or (panels[0].id if panels else ""))
return (
_SHELL.replace("__TITLE__", f"{brand} — run view")
.replace("__BRAND__", brand)
.replace("__STYLE__", css)
.replace("__SECTIONS__", sections)
.replace("__PANELS_META__", panels_meta)
.replace("__PANEL_JS__", panel_js)
.replace("__RENDER_CALLS__", render_calls)
.replace("__DEFAULT_VIEW__", default)
.replace("__DATA__", blob)
)
escaped_brand = escape(brand, quote=True)
escaped_title = escape(f"{brand} — run view", quote=True)
replacements = {
"__TITLE__": escaped_title,
"__BRAND__": escaped_brand,
"__STYLE__": css,
"__SECTIONS__": sections,
"__PANELS_META__": panels_meta,
"__PANEL_JS__": panel_js,
"__RENDER_CALLS__": render_calls,
"__DEFAULT_VIEW__": default,
"__DATA__": blob,
}
return _SHELL_PLACEHOLDER_RE.sub(lambda match: replacements[match.group(0)], _SHELL)


def render_trace_html(run: RunTrace, *, brand: str = "ra") -> str:
Expand Down
77 changes: 65 additions & 12 deletions tests/test_ra_viewer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,31 @@ def _write_rollout(dir_path: Path) -> None:
rollouts = dir_path / "rollouts"
rollouts.mkdir()
rows = [
{"type": "metadata", "agent": "root", "depth": 0, "spawn_id": "r1",
"timestamp": "2026-06-03T00:00:00+00:00", "model": "some/model"},
{"type": "iteration", "agent": "root", "iteration": 1, "spawn_id": "r1",
"timestamp": "2026-06-03T00:01:00+00:00", "response": "thinking", "code_blocks": []},
{"type": "result", "agent": "root", "iteration": 1, "spawn_id": "r1",
"timestamp": "2026-06-03T00:02:00+00:00", "final_answer": "done"},
{
"type": "metadata",
"agent": "root",
"depth": 0,
"spawn_id": "r1",
"timestamp": "2026-06-03T00:00:00+00:00",
"model": "some/model",
},
{
"type": "iteration",
"agent": "root",
"iteration": 1,
"spawn_id": "r1",
"timestamp": "2026-06-03T00:01:00+00:00",
"response": "thinking",
"code_blocks": [],
},
{
"type": "result",
"agent": "root",
"iteration": 1,
"spawn_id": "r1",
"timestamp": "2026-06-03T00:02:00+00:00",
"final_answer": "done",
},
]
(rollouts / "root.jsonl").write_text(
"\n".join(json.dumps(r) for r in rows), encoding="utf-8"
Expand All @@ -41,19 +60,53 @@ def test_render_trace_html_is_self_contained(tmp_path: Path) -> None:
assert "renderTrace();" in html


def test_render_page_escapes_brand_in_shell_chrome() -> None:
# Regression: brand is a public render_page/render_trace_html input, so it
# must not be able to break out of the <title> or header markup.
panel = Panel(
id="trace",
label="Trace",
section='<section class="view" id="view-trace"></section>',
css="",
js="",
render_call="",
)
brand = '__DATA__</title><script>alert("x")</script><h1>'
data = {"title": '<img src=x onerror=alert("data")>', "run": {}}

html = render_page(data, [panel], brand=brand)

assert '</title><script>alert("x")</script>' not in html
assert '<img src=x onerror=alert("data")>' not in html
assert "__DATA__&lt;/title&gt;&lt;script&gt;alert" in html


def test_render_page_composes_arbitrary_panels() -> None:
run = RunTrace(
title="t", benchmark=None, task_id="t", success=None, failure_reason=None,
poc_source=None, models=["m"], agents=[], root_name="root",
root_result=None, root_steps=[], unlinked=[],
title="t",
benchmark=None,
task_id="t",
success=None,
failure_reason=None,
poc_source=None,
models=["m"],
agents=[],
root_name="root",
root_result=None,
root_steps=[],
unlinked=[],
)
custom = Panel(
id="notes", label="Notes",
id="notes",
label="Notes",
section='<section class="view" id="view-notes"><p id="n"></p></section>',
css=".notes{}", js="function renderNotes(){document.getElementById('n').textContent='hi';}",
css=".notes{}",
js="function renderNotes(){document.getElementById('n').textContent='hi';}",
render_call="renderNotes();",
)
html = render_page({"title": "t", "run": run.as_dict()}, [custom], default_view="notes")
html = render_page(
{"title": "t", "run": run.as_dict()}, [custom], default_view="notes"
)
assert 'id="view-notes"' in html
assert "renderNotes();" in html
assert '"id": "notes"' in html or '"id":"notes"' in html