Skip to content

fix: harden report template for missing fields #58

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
AlwinXue wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: harden report template for missing fields #58

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
20 changes: 16 additions & 4 deletions apps/backend/app/utils/report_template.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,18 @@
def render_report_html(data):
params_html = "".join(f"<tr><td>{k}</td><td>{v}</td></tr>" for k, v in data["asl_parameters"])
missing_html = "".join(f"<li>{param}</li>" for param in data["missing_parameters"])
asl_parameters = data.get("asl_parameters", {})
if isinstance(asl_parameters, dict):
parameter_items = asl_parameters.items()
else:
parameter_items = asl_parameters

missing_parameters = data.get("missing_required_parameters", data.get("missing_parameters", []))
if isinstance(missing_parameters, dict):
missing_items = missing_parameters.keys()
else:
missing_items = missing_parameters

params_html = "".join(f"<tr><td>{k}</td><td>{v}</td></tr>" for k, v in parameter_items)
missing_html = "".join(f"<li>{param}</li>" for param in missing_items)
return f"""
<html>
<head>
Expand All @@ -18,9 +30,9 @@ def render_report_html(data):
{params_html}
</table>
<h2>Basic Report</h2>
<p>{data["basic_report"]}</p>
<p>{data.get("basic_report", "No basic report available.")}</p>
<h2>Extended Report</h2>
<p>{data["extended_report"]}</p>
<p>{data.get("extended_report", "No extended report available.")}</p>
<h2>Missing Parameters</h2>
<ul>
{missing_html}
Expand Down
12 changes: 12 additions & 0 deletions apps/backend/tests/test_report.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,16 @@ def test_report_pdf_endpoint():
}
response = client.post("/api/report/report-pdf", json=report_data)
assert response.status_code == 200
assert response.headers["content-type"] == "application/pdf"


def test_report_pdf_endpoint_uses_missing_required_parameters():
report_data = {
"report_data": {
"asl_parameters": {"param1": "value1"},
"missing_required_parameters": {"PostLabelingDelay": "ms"},
}
}
response = client.post("/api/report/report-pdf", json=report_data)
assert response.status_code == 200
assert response.headers["content-type"] == "application/pdf"