Skip to content
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.

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

fix(fluent-editor): fix link img render error #2156

Merged
merged 1 commit into from
Sep 20, 2024

Conversation

kagol
Copy link
Member

@kagol kagol commented Sep 20, 2024

PR

PR Checklist

Please check if your PR fulfills the following requirements:

  • The commit message follows our Commit Message Guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe:

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

  • New Features

    • Enhanced XSS protection by adding href attribute to <a> tags and src attribute to <img> tags.
    • Improved visual consistency of the Fluent Editor theme with updated SVG icon styling.
  • Bug Fixes

    • Addressed security concerns related to XSS by updating the configuration options.

Copy link

coderabbitai bot commented Sep 20, 2024

Walkthrough

The pull request introduces updates to enhance the XSS protection mechanism in the xss.ts file by adding the href attribute for <a> tags and the src attribute for <img> tags to the whitelist. Additionally, the index.less file for the Fluent Editor theme has been modified to improve the styling of SVG elements by setting their width to 16 pixels.

Changes

File Change Summary
packages/renderless/src/common/xss.ts Enhanced XSS protection by adding href to <a> tag and src to <img> tag in xssOptions.
packages/theme/src/fluent-editor/index.less Improved SVG styling by adding width: 16px; to svg elements for visual consistency.

Possibly related PRs

  • fix(fluent-editor): fix link and img render error #2142: This PR modifies the xssOptions in the xss.ts file to enhance XSS protection by adding the href and src attributes to the whitelist for <a> and <img> tags, which directly relates to the changes made in the main PR regarding the same attributes in the same file.

Suggested labels

bug

Poem

Hop along, dear friends, with glee,
XSS is safer, as you can see!
SVGs now shine, with width just right,
In our editor, they bring delight.
So let’s celebrate, with a joyful cheer,
For changes that make our code more clear! 🐇✨


Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 1d6b6bd and 11eefe3.

Files selected for processing (2)
  • packages/renderless/src/common/xss.ts (2 hunks)
  • packages/theme/src/fluent-editor/index.less (1 hunks)
Files skipped from review due to trivial changes (1)
  • packages/theme/src/fluent-editor/index.less
Additional comments not posted (2)
packages/renderless/src/common/xss.ts (2)

25-25: LGTM!

Adding the href attribute to the whitelist for the <a> tag is a necessary change to enable hyperlinks in the sanitized output. This change aligns with the PR objective of fixing the link rendering issue in the fluent editor while still maintaining security through attribute whitelisting.


77-77: LGTM!

Adding the src attribute to the whitelist for the <img> tag is a necessary change to enable images with specified sources in the sanitized output. This change aligns with the PR objective of fixing the image rendering issue in the fluent editor while still maintaining security through attribute whitelisting.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    -- I pushed a fix in commit <commit_id>, please review it.
    -- Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    -- @coderabbitai generate unit testing code for this file.
    -- @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    -- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    -- @coderabbitai read src/utils.ts and generate unit testing code.
    -- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    -- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

[e2e-test-warn]
The component to be tested is missing.

The title of the Pull request should look like "fix(vue-renderless): [action-menu, alert] fix xxx bug".

Please make sure you've read our contributing guide

@zzcr zzcr merged commit 30384d0 into release-3.18.0 Sep 20, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants