8000 Added uppercase HTML elements to sanitize to as lowercase HTML elment… by mscherotter · Pull Request #1044 · SVG-Edit/svgedit · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Added uppercase HTML elements to sanitize to as lowercase HTML elment… #1044

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

Jump to bottom
Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Added uppercase HTML elements to sanitize to as lowercase HTML elment… #1044

wants to merge 1 commit into from

Conversation

mscherotter
Copy link
Contributor
@mscherotter mscherotter commented Apr 6, 2025 •
edited by sourcery-ai bot
Loading

This fixes an issue where the SVGCanvas was converting lowercase foreignObject HTML tags to capitalized ones.

PR description

Checklist

Note that we require UI tests to ensure that the added feature will not be
nixed by some future fix and that there is at least some test-as-documentation
to indicate how the fix or enhancement is expected to behave.

  • - Added Cypress UI tests
  • - Ran npm test, ensuring linting passes and that Cypress UI tests keep
    coverage to at least the same percent (reflected in the coverage badge
    that should be updated after the tests run)
  • - Added any user documentation. Though not required, this can be a big
    help both for future users and for the PR reviewer.

Summary by Sourcery

Bug Fixes:

  • Fix issue where SVGCanvas was only allowing lowercase HTML tags in foreignObject, now supporting both lowercase and uppercase variants

@sourcery-ai Sourcery AI
Copy link
sourcery-ai bot commented Apr 6, 2025 •
edited
Loading

Reviewer's Guide by Sourcery

This pull request addresses an issue in the SVGCanvas where lowercase HTML tags within foreignObject elements were being converted to uppercase. To resolve this, the sanitizer's whitelist has been updated to include uppercase versions of the HTML elements.

Updated class diagram for the HTML sanitizer whitelist

classDiagram
  class svgWhiteList_ {
    div: []
    DIV: []
    p: []
    P: []
    li: []
    LI: []
    pre: []
    PRE: []
    ol: []
    OL: []
    ul: []
    UL: []
    span: []
    SPAN: []
    hr: []
    HR: []
    br: []
    BR: []
    h1: []
    H1: []
    h2: []
    H2: []
    h3: []
    H3: []
    h4: []
    H4: []
    h5: []
    H5: []
    h6: []
    H6: []
  }
  note for svgWhiteList_ "Added uppercase HTML elements to the whitelist"
Loading

File-Level Changes

Change Details Files
Added uppercase HTML elements to the sanitizer whitelist.
  • Added uppercase versions of div, p, li, pre, ol, ul, span, hr, br, h1, h2, h3, h4, h5, and h6 to the svgWhiteList_ object.
 packages/svgcanvas/core/sanitize.js
Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

sourcery-ai[bot]
sourcery-ai bot reviewed Apr 6, 2025
View reviewed changes
Copy link
@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @mscherotter - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Instead of adding uppercase versions of the tags, consider converting the tag names to lowercase before checking against the whitelist.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good
Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@jfhenon
Copy link
Collaborator
jfhenon commented Apr 7, 2025

Ins't it better to consider the comment of Sourcery? Instead of adding uppercase versions of the tags, consider converting the tag names to lowercase before checking against the whitelist

@mscherotter
Copy link
Contributor Author

@jfhenon there is a bug that I discovered in the code called in showSourceEditor() which calls this.editor.svgCanvas.getSvgString() that generates the SVG xml. In the process of generating that XML, all of the HTML elements in the foreignObject are converted to uppercase. I haven't figured out why, but this fix will mitigate that issue. Since many of the non-HTML elements in the whitelist are camelCase, the suggested method will not work.

@mscherotter
Copy link
Contributor Author

Please accept this pull request until we can figure out how to fix the issue with getSvgString() that converts HTML elements to upper-case.

jfhenon
jfhenon requested changes Apr 28, 2025
View reviewed changes
Copy link
Collaborator
@jfhenon jfhenon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd prefer a change that fix the issue including with getSgvString

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

@jfhenon jfhenon jfhenon requested changes

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@mscherotter @jfhenon
0