Skip to content

fix(compiler-sfc): transform empty srcset w/ includeAbsolute: true #13639

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

edison1105
Copy link
Member

@edison1105 edison1105 commented Jul 15, 2025

close vitejs/vite-plugin-vue#631

Summary by CodeRabbit

  • Bug Fixes

    • Improved handling of empty or missing URLs in image srcset attributes to prevent errors or unintended behavior.
  • Tests

    • Added a test case to verify correct processing of empty srcset attributes when including absolute URLs.

Copy link

coderabbitai bot commented Jul 15, 2025

Walkthrough

A guard was added in the shouldProcessUrl function to prevent processing empty or falsy srcset URLs, avoiding unintended behavior. Additionally, a new test case was introduced to verify that an empty srcset with includeAbsolute: true is handled correctly. No changes were made to public APIs or exports.

Changes

File(s) Change Summary
packages/compiler-sfc/src/template/transformSrcset.ts Added a check in shouldProcessUrl to immediately return false if the URL is falsy.
packages/compiler-sfc/tests/templateTransformSrcset.spec.ts Added a test for handling an empty srcset attribute with includeAbsolute: true option.

Sequence Diagram(s)

sequenceDiagram
    participant TestRunner
    participant Compiler
    participant transformSrcset
    TestRunner->>Compiler: Compile template with <img srcset=" ">
    Compiler->>transformSrcset: Process srcset attribute
    transformSrcset->>transformSrcset: Call shouldProcessUrl(url)
    alt url is falsy (empty string)
        transformSrcset-->>Compiler: Skip processing
    else url is valid
        transformSrcset-->>Compiler: Process URL as usual
    end
    Compiler-->>TestRunner: Return compiled code
Loading

Assessment against linked issues

Objective Addressed Explanation
Prevent invalid JS output for empty or whitespace-only srcset attributes (#631)
Ensure empty srcset does not trigger URL import or transformation logic (#631)
Add regression test for empty srcset handling (#631)

Poem

A bunny hopped through fields of code,
Guarding empty srcset on the road.
No more broken JS lines,
Just passing tests and clear confines.
With every patch, the garden grows—
Safe and sound, the Vue code flows! 🐇✨


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 347ef1d and a2c4c6b.

⛔ Files ignored due to path filters (1)
  • packages/compiler-sfc/__tests__/__snapshots__/templateTransformSrcset.spec.ts.snap is excluded by !**/*.snap
📒 Files selected for processing (2)
  • packages/compiler-sfc/__tests__/templateTransformSrcset.spec.ts (1 hunks)
  • packages/compiler-sfc/src/template/transformSrcset.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: Redirect rules
  • GitHub Check: Header rules
  • GitHub Check: Pages changed
🔇 Additional comments (2)
packages/compiler-sfc/src/template/transformSrcset.ts (1)

72-79: LGTM! Proper defensive guard added.

The addition of the url && check prevents processing of empty or falsy URLs, which correctly addresses the issue described in the PR. This follows JavaScript best practices for defensive programming and ensures the function returns false immediately for empty strings, null, or undefined values.

packages/compiler-sfc/__tests__/templateTransformSrcset.spec.ts (1)

75-81: LGTM! Test case properly validates the fix.

The new test case directly addresses the issue described in the PR by testing an empty srcset (single space character) with includeAbsolute: true. The test is well-named and uses snapshot testing to ensure the output remains consistent, providing good regression protection.

✨ Finishing Touches
  • 📝 Generate Docstrings

🪧 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.

Copy link

Size Report

Bundles

File Size Gzip Brotli
runtime-dom.global.prod.js 101 kB 38.4 kB 34.5 kB
vue.global.prod.js 159 kB 58.5 kB 52.1 kB

Usages

Name Size Gzip Brotli
createApp (CAPI only) 46.5 kB 18.2 kB 16.7 kB
createApp 54.5 kB 21.2 kB 19.4 kB
createSSRApp 58.7 kB 22.9 kB 20.9 kB
defineCustomElement 59.5 kB 22.8 kB 20.8 kB
overall 68.5 kB 26.4 kB 24 kB

Copy link

pkg-pr-new bot commented Jul 15, 2025

Open in StackBlitz

@vue/compiler-core

npm i https://pkg.pr.new/@vue/compiler-core@13639

@vue/compiler-dom

npm i https://pkg.pr.new/@vue/compiler-dom@13639

@vue/compiler-sfc

npm i https://pkg.pr.new/@vue/compiler-sfc@13639

@vue/compiler-ssr

npm i https://pkg.pr.new/@vue/compiler-ssr@13639

@vue/reactivity

npm i https://pkg.pr.new/@vue/reactivity@13639

@vue/runtime-core

npm i https://pkg.pr.new/@vue/runtime-core@13639

@vue/runtime-dom

npm i https://pkg.pr.new/@vue/runtime-dom@13639

@vue/server-renderer

npm i https://pkg.pr.new/@vue/server-renderer@13639

@vue/shared

npm i https://pkg.pr.new/@vue/shared@13639

vue

npm i https://pkg.pr.new/vue@13639

@vue/compat

npm i https://pkg.pr.new/@vue/compat@13639

commit: a2c4c6b

@edison1105 edison1105 added ready to merge The PR is ready to be merged. scope: sfc 🔨 p3-minor-bug Priority 3: this fixes a bug, but is an edge case that only affects very specific usage. labels Jul 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🔨 p3-minor-bug Priority 3: this fixes a bug, but is an edge case that only affects very specific usage. ready to merge The PR is ready to be merged. scope: sfc
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Difference in output between sfc playground and plugin-vue
1 participant