Skip to content

Make browser summary reports single-file #410

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

Merged
uriahf merged 2 commits into from
Sep 5, 2026
Merged

Make browser summary reports single-file #410

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cd1e8bd
Make browser summary reports single-file
google-labs-jules[bot] Sep 4, 2026
7933b7f
Make browser summary reports single-file
google-labs-jules[bot] Sep 4, 2026
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
7 changes: 4 additions & 3 deletions src/rtichoke/_report_browser.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,20 +33,21 @@ def write_html(self, path: str | Path) -> Path:
output.parent.mkdir(parents=True, exist_ok=True)

vendor = files("rtichoke").joinpath("_vendor", "rtichoke_viz")
for asset in ("rtichoke-viz.js", "rtichoke-viz.css"):
(output.parent / asset).write_bytes(vendor.joinpath(asset).read_bytes())

sanitized_spec = _sanitize_nan_values(self.spec)
spec_json = json.dumps(sanitized_spec, separators=(",", ":")).replace(
"</", "<\\/"
)
viz_js = vendor.joinpath("rtichoke-viz.js").read_text(encoding="utf-8")
viz_css = vendor.joinpath("rtichoke-viz.css").read_text(encoding="utf-8")
html = f"""<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="./rtichoke-viz.css">
<style>
{viz_css}
</style>
<title>rtichoke report</title>
</head>
<body>
Expand Down
11 changes: 10 additions & 1 deletion tests/test_calibration_v2.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
create_calibration_curve,
)
from rtichoke.performance_data.performance_data import prepare_performance_data
from importlib.resources import files

from rtichoke.processing.evaluation_semantics import (
_SHARED_POPULATION,
_build_evaluation_metadata,
Expand Down Expand Up @@ -280,7 +282,9 @@ def test_real_performance_table_roc_calibration_report_uses_shared_renderer(tmp_
tmp_path / "report.html"
)
html = output.read_text(encoding="utf-8")
viz_js = (tmp_path / "rtichoke-viz.js").read_text(encoding="utf-8")
vendor = files("rtichoke").joinpath("_vendor", "rtichoke_viz")
viz_js = vendor.joinpath("rtichoke-viz.js").read_text(encoding="utf-8")
viz_css = vendor.joinpath("rtichoke-viz.css").read_text(encoding="utf-8")

assert [item["id"] for item in report["sections"][0]["items"]] == [
"performance-table",
Expand All @@ -291,6 +295,11 @@ def test_real_performance_table_roc_calibration_report_uses_shared_renderer(tmp_
assert _embedded_report(html) == report
assert 'import { renderReport } from "./rtichoke-viz.js";' not in html
assert viz_js in html
assert viz_css in html
assert '<link rel="stylesheet" href="./rtichoke-viz.css">' not in html
assert [f.name for f in sorted(tmp_path.iterdir())] == ["report.html"]
assert not (tmp_path / "rtichoke-viz.js").exists()
assert not (tmp_path / "rtichoke-viz.css").exists()
assert 'sectionGroupPresentation: "tabs"' in html


Expand Down
35 changes: 32 additions & 3 deletions tests/test_report_browser.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import json
from importlib.resources import files
from typing import Any, cast

import numpy as np
Expand Down Expand Up @@ -54,10 +55,14 @@ def test_browser_report_uses_real_producers_and_only_shared_render_report(tmp_pa
tmp_path / "report.html"
)
html = output.read_text(encoding="utf-8")
viz_js = (tmp_path / "rtichoke-viz.js").read_text(encoding="utf-8")
vendor = files("rtichoke").joinpath("_vendor", "rtichoke_viz")
viz_js = vendor.joinpath("rtichoke-viz.js").read_text(encoding="utf-8")
viz_css = vendor.joinpath("rtichoke-viz.css").read_text(encoding="utf-8")

assert 'import { renderReport } from "./rtichoke-viz.js";' not in html
assert viz_js in html
assert viz_css in html
assert '<link rel="stylesheet" href="./rtichoke-viz.css">' not in html
assert 'sectionGroupPresentation: "tabs"' in html
assert 'groupPresentation: "stacked"' in html
assert _embedded_report(html) == report
Expand All @@ -66,8 +71,9 @@ def test_browser_report_uses_real_producers_and_only_shared_render_report(tmp_pa
"roc",
"gains",
]
assert (tmp_path / "rtichoke-viz.js").exists()
assert (tmp_path / "rtichoke-viz.css").exists()
assert [f.name for f in sorted(tmp_path.iterdir())] == ["report.html"]
assert not (tmp_path / "rtichoke-viz.js").exists()
assert not (tmp_path / "rtichoke-viz.css").exists()


def test_browser_report_preserves_component_local_evaluation_ids_and_time_context(
Expand Down Expand Up @@ -126,3 +132,26 @@ def test_browser_report_preserves_component_local_evaluation_ids_and_time_contex
tmp_path / "time-report.html"
)
assert _embedded_report(output.read_text(encoding="utf-8")) == report


def test_browser_report_does_not_delete_or_overwrite_preexisting_assets(tmp_path):
existing_js = tmp_path / "rtichoke-viz.js"
existing_css = tmp_path / "rtichoke-viz.css"
existing_js.write_text("// custom preexisting js", encoding="utf-8")
existing_css.write_text("/* custom preexisting css */", encoding="utf-8")

probs = {"Model A": np.array([0.05, 0.2, 0.7, 0.95])}
reals = np.array([0, 0, 1, 1])
performance_data = prepare_performance_data(probs, reals, by=0.25)
metadata = _build_evaluation_metadata(probs, reals, np.array([]))
table = _performance_table_spec_from_performance_data(performance_data, metadata)
report = _build_report_spec_v11(
[{"id": "sec-1", "components": [{"id": "performance-table", "spec": table}]}]
)

RtichokeBrowserReport(cast(dict[str, Any], report)).write_html(
tmp_path / "report.html"
)

assert existing_js.read_text(encoding="utf-8") == "// custom preexisting js"
assert existing_css.read_text(encoding="utf-8") == "/* custom preexisting css */"
16 changes: 12 additions & 4 deletions tests/test_summary_report_browser.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
from rtichoke._report_browser import RtichokeBrowserReport
from rtichoke._report_spec import _build_report_spec_v11
from rtichoke.performance_data.performance_data import prepare_performance_data
from importlib.resources import files

from rtichoke.processing.evaluation_semantics import _build_evaluation_metadata
from rtichoke.summary_report import summary_report as summary_report_module
from rtichoke.summary_report.summary_report import create_summary_report
Expand Down Expand Up @@ -170,9 +172,9 @@ def test_browser_summary_report_is_opt_in_and_uses_real_canonical_components(

assert result == output
assert output.exists()
viz_js_path = tmp_path / "rtichoke-viz.js"
assert viz_js_path.exists()
assert (tmp_path / "rtichoke-viz.css").exists()
assert [f.name for f in sorted(tmp_path.iterdir())] == ["canonical-summary.html"]
assert not (tmp_path / "rtichoke-viz.js").exists()
assert not (tmp_path / "rtichoke-viz.css").exists()

html = output.read_text(encoding="utf-8")
report = _embedded_report(html)
Expand All @@ -187,7 +189,13 @@ def test_browser_summary_report_is_opt_in_and_uses_real_canonical_components(
"performance-table",
]
assert 'import { renderReport } from "./rtichoke-viz.js";' not in html
assert viz_js_path.read_text(encoding="utf-8") in html
vendor = files("rtichoke").joinpath("_vendor", "rtichoke_viz")
viz_js = vendor.joinpath("rtichoke-viz.js").read_text(encoding="utf-8")
viz_css = vendor.joinpath("rtichoke-viz.css").read_text(encoding="utf-8")
assert viz_js in html
assert viz_css in html
assert '<link rel="stylesheet" href="./rtichoke-viz.css">' not in html
assert "<style>" in html
assert 'sectionGroupPresentation: "tabs"' in html


Expand Down
Loading