Skip to content

feat(vue/image): [image]the image component supports binary stream base64 format #2829

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Merged
merged 1 commit into from
Jan 20, 2025

Conversation

zzcr
Copy link
Member

@zzcr zzcr commented Jan 20, 2025

image组件支持二进制流base64格式

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

  • Bug Fixes
    • Enhanced base64 URL validation to support a broader range of media types, including application data streams.

Copy link

coderabbitai bot commented Jan 20, 2025

Walkthrough

The pull request modifies the base64 image URL filtering regex in the filterImageUrl function within the packages/renderless/src/image/index.ts file. The change expands the media type validation to include both image and application media types, specifically adding support for application/octet-stream. This modification broadens the function's ability to validate base64 encoded data URLs beyond traditional image formats.

Changes

File Change Summary
packages/renderless/src/image/index.ts Updated regex pattern in filterImageUrl to support broader base64 data URL media types

Possibly related PRs

Suggested labels

enhancement

Poem

🐰 A regex dance, so wild and free,
Base64 images, now more than just a spree!
From pixels to streams, our pattern expands,
Embracing data types with rabbit-like hands 🖼️
A small change that makes our code shine bright!

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

@github-actions github-actions bot added the enhancement New feature or request (功能增强) label Jan 20, 2025
Copy link

Walkthrough

This PR enhances the image component to support binary stream base64 format by modifying the regex pattern to include application/octet-stream in addition to existing image formats. This change allows the component to handle a broader range of base64 encoded data.

Changes

File Summary
packages/renderless/src/image/index.ts Updated regex in filterImageUrl function to support application/octet-stream for base64 format.

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 changed the title feat(vue/image): the image component supports binary stream base64 format feat(vue/image): [image]the image component supports binary stream base64 format Jan 20, 2025
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (3)
packages/renderless/src/image/index.ts (3)

188-188: Enhance the base64 validation regex pattern.

While the regex pattern correctly validates base64 data URLs, it can be improved for better security and maintainability:

  1. The pattern should be anchored with ^ and $ (already done correctly).
  2. The media type validation is expanded to include application/octet-stream, which is good.
  3. However, the base64 validation part [a-zA-Z0-9+/]+={0,2} could be more strict.

Consider using this enhanced pattern for stricter validation:

-  const isBase64 = /^data:(image|application)\/(png|jpg|jpeg|gif|octet-stream);base64,([a-zA-Z0-9+/]+={0,2})/
+  const isBase64 = /^data:(image|application)\/(png|jpg|jpeg|gif|octet-stream);base64,([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{4}|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)$/

This improved pattern:

  • Uses a more precise base64 validation that checks for proper padding
  • Ensures the string ends properly with the base64 data

188-188: Add unit tests for base64 validation.

The changes to the regex pattern require comprehensive testing to ensure correct validation of various base64 encoded images.

Would you like me to help generate unit tests that cover:

  • Valid base64 encoded images with different media types
  • Invalid base64 strings
  • Edge cases with different padding lengths
  • Malformed data URLs

188-188: Document the supported formats.

The function now supports additional formats through application/octet-stream, but this isn't documented.

Add a JSDoc comment to document the supported formats:

+ /**
+  * Filters and validates image URLs, supporting:
+  * - Regular URLs (filtered through XSS)
+  * - Base64 data URLs with the following media types:
+  *   - image/png, image/jpg, image/jpeg, image/gif
+  *   - application/octet-stream
+  * @param {Object} props - Component props containing the src
+  * @returns {string} Filtered URL
+  */
 export const filterImageUrl = (props) => () => {
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a0b4de4 and 465007a.

📒 Files selected for processing (1)
  • packages/renderless/src/image/index.ts (1 hunks)
🔇 Additional comments (1)
packages/renderless/src/image/index.ts (1)

188-188: Verify browser compatibility for application/octet-stream.

The addition of application/octet-stream media type needs verification across different browsers to ensure consistent behavior.

Let's check browser compatibility and existing usage:

✅ Verification successful

The application/octet-stream MIME type usage is safe and compatible.

The MIME type is used correctly within the data URL validation context and is well-supported across all modern browsers that the project targets.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for any existing tests or documentation related to browser compatibility
rg -i "octet-stream|browser.*(support|compat)" --type ts --type md

# Search for existing usage of application/octet-stream in tests
rg -i "application/octet-stream" --type test

Length of output: 935

@zzcr zzcr merged commit 6ce2186 into dev Jan 20, 2025
13 of 19 checks passed
@kagol kagol deleted the fix-image-url-base64-0120 branch April 14, 2025 12:25
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
enhancement New feature or request (功能增强)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant