Fix SVG rendering by converting base64 SVG data URIs to inline <svg>#8001
Open
donny-wong wants to merge 2 commits into
Open
Fix SVG rendering by converting base64 SVG data URIs to inline <svg>#8001donny-wong wants to merge 2 commits into
donny-wong wants to merge 2 commits into
Conversation
added 2 commits
June 12, 2026 01:14
Collaborator
Coverage Report for CI Build 27396759596Coverage increased (+0.01%) to 90.221%Details
Uncovered ChangesNo uncovered changes found. Coverage RegressionsNo coverage regressions found. Coverage Stats💛 - Coveralls |
david-yz-liu
left a comment
Collaborator
There was a problem hiding this comment.
@donny-wong I left one question, but also please update the PR description with a screenshot showing the SVG image that was rendered in the notebook.
| @@ -1 +1,2 @@ | |||
| <%= sanitize(@html_content, scrubber: Rails::HTML::TargetScrubber.new(prune: true)) %> | |||
| <%= sanitize(inline_svg_data_uris(@html_content), | |||
| scrubber: Rails::HTML::PermitScrubber.new(prune: true)) %> | |||
Collaborator
There was a problem hiding this comment.
I'm not sure why the scrubber was changed? Doesn't the TargetScrubber preserve the SVG?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Proposed Changes
(Describe your changes here. Also describe the motivation for your changes: what problem do they solve, or how do they improve the application or codebase? If this pull request fixes an open issue, use a keyword to link this pull request to the issue.)
Summary
nbconvert embeds notebook SVG output as
<img src="data:image/svg+xml;base64,…">.Those SVG data-URI images don't survive our HTML pipeline — the
srcis droppedduring sanitization — so the graphics render blank.
inline_svg_data_urisdecodeseach of those data URIs and inlines the SVG as real
<svg>markup (stripping any<?xml?>prolog/DOCTYPE/comments) before it's sanitized, so the figures render.This PR adds
ApplicationHelper#inline_svg_data_uris,which finds those
<img>tags and replaces each with the decoded<svg>…</svg>markup inlined directly into the document, so the SVG renders as real markup
instead of an (un-rendered) image reference. Any
<?xml?>prolog, DOCTYPE, orcomments preceding the root
<svg>element are stripped.Usage
Output is sanitized at the call site:
Security considerations
from a sandboxed
<img src="data:…">context (scripts inert) into live DOM(scripts can run), so every caller MUST sanitize the result.
rails-html-sanitizer >= 1.6.1and a patched Nokogiri.html_safe) String by design.Screenshots of your changes (if applicable)
Associated documentation repository pull request (if applicable)
Type of Change
(Write an
Xor a brief description next to the type or types that best describe your changes.)Checklist
(Complete each of the following items for your pull request. Indicate that you have completed an item by changing the
[ ]into a[x]in the raw text, or by clicking on the checkbox in the rendered description on GitHub.)Before opening your pull request:
After opening your pull request:
Questions and Comments
(Include any questions or comments you have regarding your changes.)