fix(custom-element): preserve appContext during update #12455

edison1105 · 2024-11-21T14:05:12Z

Summary by CodeRabbit

Bug Fixes
- Improved handling of application context in custom elements to ensure correct rendering behavior.
Tests
- Added a new test case to verify custom element behavior during Hot Module Replacement (HMR) reloads.

github-actions · 2024-11-21T14:06:12Z

Size Report

Bundles

File	Size	Gzip	Brotli
runtime-dom.global.prod.js	101 kB (+53 B)	38.3 kB (+17 B)	34.5 kB (+36 B)
vue.global.prod.js	159 kB (+53 B)	58.5 kB (+14 B)	52 kB (+2 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 (+53 B)	22.8 kB (+13 B)	20.8 kB (+3 B)
overall	68.6 kB	26.4 kB	24.1 kB

pkg-pr-new · 2024-11-21T14:06:33Z

Open in StackBlitz

@vue/compiler-core

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

@vue/compiler-dom

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

@vue/compiler-ssr

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

@vue/compiler-sfc

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

@vue/reactivity

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

@vue/runtime-core

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

@vue/runtime-dom

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

@vue/server-renderer

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

@vue/shared

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

vue

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

@vue/compat

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

commit: 43e4164

packages/runtime-dom/src/apiCustomElement.ts

Copilot

Copilot reviewed 2 out of 2 changed files in this pull request and generated no suggestions.

Comments skipped due to low confidence (1)

packages/runtime-dom/src/apiCustomElement.ts:524

The new behavior introduced in the '_update' method should be covered by tests to ensure that 'vnode.appContext' is correctly set.

if (this._app && !this._instance) vnode.appContext = this._app._context

danieldasilva-smake · 2025-02-04T10:00:15Z

@edison1105 Can you tell me when this will be merged? Some colleagues and me would be very happy if the HMR works again for us 😅
But thanks a lot for your work ^^

edison1105 · 2025-02-04T13:53:27Z

@danieldasilva-smake
I'm also not sure exactly when this PR will be merged. Maybe you can try using it in your development environment with:

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

It includes the latest code from the main branch.

packages/runtime-dom/src/apiCustomElement.ts

coderabbitai · 2025-05-14T08:16:51Z

"""

Walkthrough

A new test case was added to verify that the provide context and global properties configured via configureApp are preserved after a Hot Module Replacement (HMR) reload in custom elements. The _update method in VueElement was modified to explicitly set the vnode's appContext to the app's context when appropriate, ensuring context retention during HMR.

Changes

File(s)	Change Summary
`packages/runtime-dom/__tests__/customElement.spec.ts`	Added a test to check that provided context and global properties persist after HMR reload in custom elements.
`packages/runtime-dom/src/apiCustomElement.ts`	Modified `VueElement._update` to assign `appContext` to vnode before rendering, ensuring context is retained on HMR.

Sequence Diagram(s)

sequenceDiagram
    participant TestRunner
    participant CustomElement
    participant VueApp
    participant VNode
    participant HMRRuntime

    TestRunner->>CustomElement: Mount custom element with configureApp
    CustomElement->>VueApp: Provide context and set global properties
    CustomElement->>VNode: Create VNode and assign appContext
    CustomElement->>VueApp: Render VNode
    TestRunner->>HMRRuntime: Trigger HMR reload
    HMRRuntime->>CustomElement: Reload component definition
    CustomElement->>VNode: Create new VNode and assign appContext
    CustomElement->>VueApp: Render new VNode
    TestRunner->>CustomElement: Verify context and globals persist

Assessment against linked issues

Objective (Issue #)	Addressed	Explanation
Preserve provide context and global properties configured by `configureApp` after HMR in custom elements (#12453)	✅

Poem

In the warren of code, a context was lost,
But with careful update, it now stays embossed.
HMR may reload, but our context won’t flee—
The shadow DOM whispers, “You still have me!”
🐇✨

With a hop and a test, the bug’s put to rest!
"""

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.

Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.

📜 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 c1e6e85 and 43e4164.

📒 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 (5)

GitHub Check: continuous-release
GitHub Check: autofix
GitHub Check: test / lint-and-test-dts
GitHub Check: test / e2e-test
GitHub Check: test / unit-test

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

packages/runtime-dom/src/apiCustomElement.ts

edison1105 added 2 commits November 21, 2024 22:04

fix(customElement): keep appContext during custom element update

792e276

chore: update

2235643

edison1105 added 2 commits November 22, 2024 10:38

test: add test

42a30ad

test: update

b7b0932

edison1105 changed the title ~~fix(customElement): keep appContext during custom element update~~ fix(customElement): preserve appContext during custom element update Nov 22, 2024

edison1105 added 🔨 p3-minor-bug Priority 3: this fixes a bug, but is an edge case that only affects very specific usage. scope: custom elements labels Nov 22, 2024

edison1105 changed the title ~~fix(customElement): preserve appContext during custom element update~~ fix(customElement): preserve appContext during hmr reload Nov 22, 2024

chore: update

b07d1db

edison1105 commented Nov 22, 2024

View reviewed changes

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

edison1105 added the scope: hmr label Nov 22, 2024

edison1105 requested a review from Copilot November 22, 2024 03:58

edison1105 added the ready to merge The PR is ready to be merged. label Nov 22, 2024

Copilot AI reviewed Nov 22, 2024

View reviewed changes

edison1105 changed the title ~~fix(customElement): preserve appContext during hmr reload~~ fix(custom-element): preserve appContext during hmr reload Jan 6, 2025

Merge branch 'main' into edison/fix/12453

1f38527

danieldasilva-smake reviewed Apr 29, 2025

View reviewed changes

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

Merge branch 'main' into edison/fix/12453

cb019c1

chore: tweaks

c1e6e85

edison1105 commented May 14, 2025

View reviewed changes

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

edison1105 changed the title ~~fix(custom-element): preserve appContext during hmr reload~~ fix(custom-element): preserve appContext during update May 19, 2025

edison1105 removed the scope: hmr label May 19, 2025

Merge branch 'main' into edison/fix/12453

43e4164

edison1105 merged commit 013749e into main May 20, 2025
16 checks passed

edison1105 deleted the edison/fix/12453 branch May 20, 2025 00:34

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix(custom-element): preserve appContext during update #12455

fix(custom-element): preserve appContext during update #12455

Uh oh!

edison1105 commented Nov 21, 2024 •

edited by coderabbitai bot

Loading

Uh oh!

github-actions bot commented Nov 21, 2024 •

edited

Loading

Uh oh!

pkg-pr-new bot commented Nov 21, 2024 •

edited

Loading

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

danieldasilva-smake commented Feb 4, 2025

Uh oh!

edison1105 commented Feb 4, 2025

Uh oh!

Uh oh!

coderabbitai bot commented May 14, 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!

Uh oh!

Uh oh!

Uh oh!

fix(custom-element): preserve appContext during update #12455

fix(custom-element): preserve appContext during update #12455

Uh oh!

Conversation

edison1105 commented Nov 21, 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 Nov 21, 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 Nov 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

danieldasilva-smake commented Feb 4, 2025

Uh oh!

edison1105 commented Feb 4, 2025

Uh oh!

Uh oh!

coderabbitai bot commented May 14, 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!

Uh oh!

Uh oh!

edison1105 commented Nov 21, 2024 •

edited by coderabbitai bot

Loading

github-actions bot commented Nov 21, 2024 •

edited

Loading

pkg-pr-new bot commented Nov 21, 2024 •

edited

Loading

coderabbitai bot commented May 14, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)