fix(custom-element): ensure configureApp is applied to async component by edison1105 · Pull Request #12607 · vuejs/core

edison1105 · 2024-12-25T01:31:33Z

Summary by CodeRabbit

Bug Fixes
- Ensured that custom elements created from async components correctly preserve and apply the configureApp option.
Tests
- Added a new test to verify that async custom elements receive injected values via configureApp as expected.

github-actions · 2024-12-25T01:32:24Z

Size Report

Bundles

File	Size	Gzip	Brotli
runtime-dom.global.prod.js	101 kB (+40 B)	38.4 kB (+15 B)	34.6 kB (+26 B)
vue.global.prod.js	159 kB (+40 B)	58.5 kB (+15 B)	52.1 kB (-14 B)

Usages

Name	Size	Gzip	Brotli
createApp (CAPI only)	46.6 kB	18.2 kB	16.7 kB
createApp	54.6 kB	21.2 kB	19.4 kB
createSSRApp	58.8 kB	23 kB	21 kB
defineCustomElement	59.5 kB (+40 B)	22.8 kB (+12 B)	20.8 kB (+11 B)
overall	68.7 kB	26.4 kB	24 kB

pkg-pr-new · 2024-12-25T01:32:52Z

Open in StackBlitz

@vue/compiler-core

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

@vue/compiler-dom

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

@vue/compiler-sfc

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

@vue/compiler-ssr

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

@vue/reactivity

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

@vue/runtime-core

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

@vue/runtime-dom

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

@vue/server-renderer

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

@vue/shared

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

vue

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

@vue/compat

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

commit: bf2c65c

vue-bot · 2024-12-25T06:23:18Z

📝 Ran ecosystem CI: Open

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

packages/runtime-dom/src/apiCustomElement.ts

Co-authored-by: skirtle <[email protected]>

coderabbitai · 2025-06-05T02:04:12Z

Walkthrough

The changes update the handling of async components in custom elements to ensure the configureApp hook is preserved and executed when using defineCustomElement with async components. A new test verifies that configureApp works as expected for async components by injecting and rendering a provided value.

Changes

File(s)	Change Summary
packages/runtime-dom/src/apiCustomElement.ts	Copies `configureApp` from the wrapper to the resolved async component before mounting.
packages/runtime-dom/tests/customElement.spec.ts	Adds a test to verify `configureApp` is executed for async components in custom elements.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CustomElement
    participant AsyncComponentLoader
    participant LoadedComponent

    User->>CustomElement: Define custom element with async component and configureApp
    CustomElement->>AsyncComponentLoader: Load async component
    AsyncComponentLoader-->>CustomElement: Return LoadedComponent
    CustomElement->>LoadedComponent: Copy configureApp to LoadedComponent
    CustomElement->>LoadedComponent: Mount component (configureApp executed)

Assessment against linked issues

Objective	Addressed	Explanation
Ensure `configureApp` is preserved and executed for async components in `defineCustomElement` (#12448)	✅
Add test verifying `configureApp` execution with async components (#12448)	✅

Poem

In the warren of code, async hops anew,
Now configureApp sticks like morning dew.
With tests to ensure our carrots align,
Async or not, the veggies are fine!
🥕✨

— A jubilant rabbit, debugging in rhyme

📜 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 73055d8 and bf2c65c.

📒 Files selected for processing (2)

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

🔇 Additional comments (2)

packages/runtime-dom/src/apiCustomElement.ts (1)

407-410: LGTM! Properly preserves configureApp for async components.

This fix correctly addresses the issue where configureApp hooks were lost during async component resolution. The implementation follows the previous suggestion to skip the conditional check and directly assign the property, which is clean and efficient.

packages/runtime-dom/__tests__/customElement.spec.ts (1)

1569-1590: Excellent test coverage for the async component fix.

The test appropriately validates that configureApp works with async components by:

Creating an async component that uses injection

Providing the injected value via configureApp

Verifying the component renders correctly after async resolution

The async handling with setTimeout is consistent with other async tests in the file.

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

fix(customElement): handle configure app work with async component

85e2850

edison1105 added ready to merge The PR is ready to be merged. 🔨 p3-minor-bug Priority 3: this fixes a bug, but is an edge case that only affects very specific usage. scope: custom elements labels Dec 25, 2024

vuejs deleted a comment from vue-bot Dec 25, 2024

skirtles-code reviewed Dec 30, 2024

View reviewed changes

packages/runtime-dom/src/apiCustomElement.ts Outdated Show resolved Hide resolved

Apply suggestions from code review

c75dcd9

Co-authored-by: skirtle <[email protected]>

edison1105 changed the title ~~fix(customElement): handle configure app work with async component~~ fix(custom-element): handle configure app work with async component Jan 6, 2025

Merge branch 'main' into edison/fix/12448

a139cea

[autofix.ci] apply automated fixes

bf2c65c

edison1105 changed the title ~~fix(custom-element): handle configure app work with async component~~ fix(custom-element): ensure configureApp is applied to async component Jun 5, 2025

edison1105 merged commit 5ba1afb into main Jun 5, 2025
16 checks passed

edison1105 deleted the edison/fix/12448 branch June 5, 2025 02:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix(custom-element): ensure configureApp is applied to async component#12607

fix(custom-element): ensure configureApp is applied to async component#12607
edison1105 merged 4 commits intomainfrom
edison/fix/12448

edison1105 commented Dec 25, 2024 •

edited by coderabbitai bot

Loading

Uh oh!

github-actions bot commented Dec 25, 2024 •

edited

Loading

Uh oh!

pkg-pr-new bot commented Dec 25, 2024 •

edited

Loading

Uh oh!

vue-bot commented Dec 25, 2024

Uh oh!

Uh oh!

coderabbitai bot commented Jun 5, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

edison1105 commented Dec 25, 2024 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

github-actions bot commented Dec 25, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Size Report

Bundles

Usages

Uh oh!

pkg-pr-new bot commented Dec 25, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vue-bot commented Dec 25, 2024

Uh oh!

Uh oh!

coderabbitai bot commented Jun 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Assessment against linked issues

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

edison1105 commented Dec 25, 2024 •

edited by coderabbitai bot

Loading

github-actions bot commented Dec 25, 2024 •

edited

Loading

pkg-pr-new bot commented Dec 25, 2024 •

edited

Loading

coderabbitai bot commented Jun 5, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)