fix(custom-element): properly resolve props for sync component defs

[edison1105]

close #12854

Summary by CodeRabbit

• Tests

  • Added a new test case to verify prop types validation for custom elements, ensuring correct handling and display of prop values and their types.

• Refactor

  • Improved the internal logic for resolving custom element properties to ensure consistent behavior for both synchronous and asynchronous component definitions.

[github-actions]

Size Report

Bundles

File	Size	Gzip	Brotli
runtime-dom.global.prod.js	101 kB (-58 B)	38.3 kB (-14 B)	34.5 kB (-44 B)
vue.global.prod.js	159 kB (-58 B)	58.5 kB (-14 B)	52.1 kB (+57 B)

Usages

Name	Size	Gzip	Brotli
createApp (CAPI only)	46.6 kB	18.2 kB	16.7 kB
createApp	54.5 kB	21.2 kB	19.4 kB
createSSRApp	58.8 kB	23 kB	20.9 kB
defineCustomElement	59.5 kB (-58 B)	22.8 kB (-15 B)	20.8 kB (-14 B)
overall	68.6 kB	26.4 kB	24.1 kB

[pkg-pr-new]

Open in StackBlitz

@vue/compiler-core

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

@vue/compiler-dom

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

@vue/compiler-sfc

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

@vue/compiler-ssr

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

@vue/reactivity

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

@vue/runtime-core

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

@vue/runtime-dom

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

@vue/server-renderer

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

@vue/shared

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

vue

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

@vue/compat

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

commit: 55ac052

[coderabbitai]

"""

Walkthrough

The changes refactor the timing of prop resolution in custom Vue elements to ensure that props are processed only after the component definition is fully resolved, regardless of whether it is synchronous or asynchronous. A new test is added to verify correct prop type handling and initial rendering in custom elements.

Changes

File(s)	Change Summary
packages/runtime-dom/src/apiCustomElement.ts	Refactored prop resolution logic: moved _resolveProps call from constructor to _resolveDef for all cases.
packages/runtime-dom/tests/customElement.spec.ts	Added a test case for prop types validation in custom elements.

Assessment against linked issues

Objective	Addressed	Explanation
Ensure initial render of custom element props preserves correct value types and does not coerce to strings (#12854)	✅

Poem

In the warren of Vue, a bug hopped in,
Props turned to strings, oh what a din!
Now with careful code and a test so bright,
Types stay true from the very first byte.
🐇✨ Hooray for fixes, and shadows that render right!
"""

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 9d6c690 and f251059.

📒 Files selected for processing (2)

• packages/runtime-dom/__tests__/customElement.spec.ts (1 hunks)
• packages/runtime-dom/src/apiCustomElement.ts (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (2)

• packages/runtime-dom/src/apiCustomElement.ts
• packages/runtime-dom/tests/customElement.spec.ts

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: test / unit-test-windows

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

[edison1105]

/ecosystem-ci run

[vue-bot]

📝 Ran ecosystem CI: Open

suite	result	latest scheduled
language-tools	✅ success	✅ success
nuxt	✅ success	✅ success
radix-vue	✅ success	✅ success
quasar	✅ success	✅ success
primevue	✅ success	✅ success
pinia	✅ success	✅ success
test-utils	✅ success	✅ success
vite-plugin-vue	✅ success	✅ success
router	✅ success	✅ success
vue-macros	✅ success	✅ success
vant	✅ success	✅ success
vueuse	✅ success	✅ success
vuetify	✅ success	✅ success
vue-i18n	✅ success	✅ success
vitepress	✅ success	✅ success
vue-simple-compiler	✅ success	✅ success