Feat/mdstream safe

[DingGao-Devin]

Summary by CodeRabbit

• New Features

  • File messages now include both file identifiers and URLs, improving access to uploaded files.

• Bug Fixes

  • Enhanced HTML sanitization to better protect against XSS vulnerabilities when rendering rich text.
  • Improved URL validation in links to more effectively block unsafe "javascript:" links, even if obfuscated.

• Tests

  • Expanded test content for markdown rendering with additional XSS scenarios to ensure improved security.

[coderabbitai[bot]]

Walkthrough

This update enhances XSS protection in the @coze/chat-sdk package by adding the xss dependency, sanitizing rendered HTML, strengthening URL validation, and expanding markdown test cases with various XSS payloads. The version is incremented and several change log files are added to document these modifications.

Changes

Files/Paths	Change Summary
common/changes/@coze/chat-sdk/feat-mdstream-safe_2025-06-16-02-57.json common/changes/@coze/chat-sdk/feat-mdstream-safe_2025-06-16-04-00.json common/changes/@coze/chat-sdk/feat-mdstream-safe_2025-07-01-12-49.json	Added change log JSON files documenting minor updates for XSS fixes and metadata.
packages/chat-sdk/package.json	Bumped version to 0.1.11-beta.18; added xss as a dependency.
packages/chat-sdk/src/libs/services/helper/message/send-message/multi-send-message.ts	Included file_url alongside file_id in file message payloads and upload results.
packages/chat-sdk/src/libs/ui-kit/atomic/md-stream/render/phrase/html/index.tsx	Sanitized HTML content using xss before rendering with RichText.
packages/chat-sdk/src/libs/ui-kit/atomic/md-stream/render/phrase/link/index.tsx	Improved URL validation to better detect and block "javascript:" links, handling whitespace and casing.
packages/chat-sdk/src/pages/markdown/const.ts	Expanded markdown constant with numerous XSS payloads and updated a test link to use a malicious javascript: URL.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant MarkdownRenderer
    participant XSSSanitizer
    participant UI

    User->>MarkdownRenderer: Submit markdown with HTML
    MarkdownRenderer->>XSSSanitizer: Sanitize HTML content
    XSSSanitizer-->>MarkdownRenderer: Return sanitized HTML
    MarkdownRenderer->>UI: Render sanitized content

    User->>MarkdownRenderer: Submit markdown with link
    MarkdownRenderer->>MarkdownRenderer: Validate URL (strip whitespace, check for "javascript")
    alt URL is safe
        MarkdownRenderer->>UI: Render link
    else URL is unsafe
        MarkdownRenderer->>UI: Render as plain text or block
    end

Possibly related PRs

• coze-dev/coze-js#263: Directly related as it modifies the same XSS protection logic, dependency management, and markdown test cases in @coze/chat-sdk.

Suggested reviewers

• jackshen310

Poem

In the meadow of code where the wild bugs play,
A rabbit hopped in and swept XSS away.
With sanitizer shield and vigilant eyes,
Unsafe links and scripts met their demise.
Now markdown is safe, from field to stream—
Let’s celebrate this patch, a coder’s dream! 🐇✨

✨ Finishing Touches

• [ ] 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

[CLAassistant]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.

---

gaoding.devingao seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}