{"record":{"id":"7d07a7351653bc63","repo":"666ghj/MiroFish","slug":"generated-svg-root-is-invalid","errorCode":null,"errorMessage":"generated SVG root is invalid","messagePattern":"generated SVG root is invalid","errorType":"exception","errorClass":"StarHistoryError","httpStatus":null,"severity":"error","filePath":"scripts/star_history.py","lineNumber":1090,"sourceCode":" decoded_payload = payload.decode(\"utf-8\", errors=\"strict\")\n except UnicodeDecodeError as exc:\n raise StarHistoryError(\"generated SVG must be strict UTF-8\") from exc\n if decoded_payload.startswith(\"\\ufeff\") or \"\\x00\" in decoded_payload:\n raise StarHistoryError(\"generated SVG must be canonical UTF-8\")\n upper_payload = decoded_payload.upper()\n if (\n \"`, ``, or an `` missing its namespace declaration). The validator then walks only known-namespaced children, so a wrong root aborts immediately.","triggerScenarios":"Payload parses as XML but the root tag lacks `xmlns=\"http://www.w3.org/2000/svg\"` (then the tag is plain `svg`, not the namespaced one), or the document is wrapped (e.g. someone put the whole chart inside `` or prepended another element before ``).","commonSituations":"Forks that wrap the SVG in an outer container for embedding; templates that omit the xmlns attribute; tools that 'clean' the SVG and drop the namespace; embedding logic that concatenates a banner element before the svg root.","solutions":["Ensure the document's first and only root element is `` with the exact namespace URI.","Remove wrapper elements — if you need surrounding markup, keep it outside the validated artifact and embed the SVG via ``/`` or inline after validation.","If a sanitizer stripped xmlns, re-add it: `root.set(\"xmlns\", \"http://www.w3.org/2000/svg\")` before serialization (or serialize with ET which handles namespaces).","Check for accidental content before the root (comments are fine; elements are not)."],"exampleFix":"# before: wrapper element becomes the root\npayload = b\"
\" + svg_body + b\"
\"\n\n# after: svg stays the root; wrapper lives outside\nsvg = render_svg(state, theme) # root is \nhtml = b\"
\" + svg + b\"
\" # embed after validation","handlingStrategy":"try-catch","validationCode":"import xml.etree.ElementTree as ET\nSVG_NS = \"{http://www.w3.org/2000/svg}\"\n\ndef has_svg_root(payload: bytes) -> bool:\n try:\n return ET.fromstring(payload).tag == f\"{SVG_NS}svg\"\n except ET.ParseError:\n return False","typeGuard":null,"tryCatchPattern":"try:\n _validate_svg(payload)\nexcept StarHistoryError as exc:\n if \"root is invalid\" in str(exc):\n raise ValueError(\"document must be a single root element\") from exc\n raise","preventionTips":["Never wrap the SVG in container elements before validation — embed afterwards instead.","Keep xmlns=\"http://www.w3.org/2000/svg\" on the root; sanitizers that strip it will fail here.","Ensure no stray elements precede the root in concatenated output."],"tags":["svg","xml","namespace","self-check"],"backgroundTag":null,"analyzedSha":"b5b53acc57189a4a42e44a23e149dc655c98fe82","analyzedAt":"2026-08-14T22:29:33.146Z","schemaVersion":2},"datasetVersion":"2026-08-15T22:17:37.221Z"}