fix(custom-element): allow injecting values from app context in nested elements (fix #13212) #13219

adrianbrs · 2025-04-17T17:47:28Z

Before this change, when a custom element was nested within another, the values provided via configureApp were ignored. Now, the provides object in the app context of a custom element inherits the provides object from its parent, allowing values to be injected properly using the app context in nested custom elements.

Note

In this implementation, values provided in the configureApp method will take precedence over values injected from parent elements. I believe this should be the expected behavior, since each custom element should have its own scope, but we can discuss it further if needed.

Close #13212

Playground:
https://deploy-preview-13219--vue-sfc-playground.netlify.app/#eNrdVk2P2jAQ/SuuL2QlIKraEw1ILeKwPXSrbm91D1EygGniWLZDkRD/vRNPPiDNIrqHql0OwZ55nnkzz3Zy5O+1nu5L4DMe2cRI7ZgFV2qWxWozF9zZg+ALoWSuC+PYkaWwlgqWpXVFvsogB+XGTKodJPivTbGXKbATW5siZyMMPHonlFBJoaxjD6UDw+ZDMYLgjs0X7CgUwx/B7TY2kCKewgcjMozuMGSHKuqgDcjPexip1AXGzz2GUAZLNooRh4BsjEWp3GPpNMHp9vXCVxCFODqz68WjJzZjR2J4ikJ9CfDr0O/J/e6+r/ig2/Pqu21WOBa2lijsaFGVp3H17Fq3lpvSAAobxFrfNQ7GcDatFWp7OWZtVwdh1E1E1W0lEGWsntRD6rKv4hZ52+ikA0b3g4nfeVWOf3wX+EJfxC7o5N2DMWiaXOjcQ1/KdcNmWG5lVkn3/x542tO+jr8p+IC8TXvlmgWvkvNW2ukGsEayTYCMjZC18r0FJMgTa8Z0UVfpMOut+eoW/1G+ZkP5Rjwn3ySplHlO1nplndsLXBOIQnoRYvtx4iDXWezAixEN9auWqe/zWTpBn+awiMIrzjr4IIQ49V0NqSg8487H+CqnW2G6s4XC973vmOBJkWuZgXnQTuLZERw3JCUVPM6y4udHb3OmBH/Q/ZotJD8G7Lvqa2GGg88GLJg9CN76XGxQRnKvHj/BAcetMy/SMkP0FecXsEVWVhwJ9qFUKdI+w3m29/5DRarNV7s6OFC2Kaoi2t2TguO3yfJK6R3dN9O3bQppLy6xyv2tkVhw3/lGB8HJ8b0+vSd++gXFBQq6

Summary by CodeRabbit

Bug Fixes
- Improved warning messages when overwriting provided values, distinguishing between own and inherited properties.
- Enhanced dependency injection logic for custom elements to correctly handle inherited values in nested scenarios.
Tests
- Added a test to verify provide/inject inheritance and overriding across nested custom elements.
Refactor
- Updated the inheritance mechanism for dependency injection in custom elements to use prototype chaining for more accurate context inheritance.

…sted elements Before this change, when a custom element was nested within another, the values provided via `configureApp` were ignored. Now, the provides object in the app context of a custom element inherits the provides object from its parent, allowing values to be injected properly using the app context in nested custom elements. Close vuejs#13212

packages/runtime-core/src/apiCreateApp.ts

…ontext Calling `_inheritParentContext` inside `_setParent` should be sufficient.

github-actions · 2025-04-18T00:30:37Z

Size Report

Bundles

File	Size	Gzip	Brotli
runtime-dom.global.prod.js	101 kB (+144 B)	38.3 kB (+47 B)	34.5 kB (+59 B)
vue.global.prod.js	159 kB (+144 B)	58.4 kB (+51 B)	52 kB (+96 B)

Usages

Name	Size	Gzip	Brotli
createApp (CAPI only)	46.6 kB	18.2 kB	16.7 kB
createApp	54.5 kB (+6 B)	21.2 kB (+6 B)	19.4 kB (-3 B)
createSSRApp	58.7 kB (+6 B)	23 kB (+6 B)	20.9 kB (+5 B)
defineCustomElement	59.5 kB (+144 B)	22.8 kB (+40 B)	20.8 kB (+31 B)
overall	68.6 kB (+6 B)	26.4 kB (+5 B)	24 kB (+9 B)

pkg-pr-new · 2025-04-18T00:42:46Z

Open in StackBlitz

@vue/compiler-core

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

@vue/compiler-dom

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

@vue/compiler-sfc

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

@vue/compiler-ssr

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

@vue/reactivity

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

@vue/runtime-core

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

@vue/runtime-dom

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

@vue/server-renderer

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

@vue/shared

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

vue

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

@vue/compat

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

commit: e73daea

packages/runtime-dom/src/apiCustomElement.ts

…rnal instance The internal instance of a custom element already inherits the app context’s provides object via the prototype chain, so there’s no need to override it or add extra logic to the `provide` function.

coderabbitai · 2025-05-13T01:08:01Z

Walkthrough

The changes update the dependency injection context handling for Vue custom elements. They refactor how provides objects are inherited using prototype chaining instead of direct assignment, improve warning messages for provide/inject key overwrites, and add a test to verify correct injection inheritance and overriding in nested custom elements.

Changes

File(s)	Change Summary
`packages/runtime-core/src/apiCreateApp.ts`	Refined the warning logic in the `provide` method to distinguish between overwriting own properties and inherited properties in the `provides` object, using the `hasOwn` utility.
`packages/runtime-core/src/apiInject.ts`	Updated injection logic to check for custom elements and use the correct `provides` source, ensuring custom elements retrieve injected values from the app context when appropriate.
`packages/runtime-dom/src/apiCustomElement.ts`	Changed the inheritance mechanism for the dependency injection context in `VueElement` to use prototype chaining via a new private `_inheritParentContext` method, replacing direct assignment of the `provides` object. Applied this method during parent setting and before app configuration.
`packages/runtime-dom/__tests__/customElement.spec.ts`	Added a test verifying that nested custom elements correctly inherit and override injection contexts, and that appropriate warnings are emitted for missing injections and overwrites.

Sequence Diagram(s)

sequenceDiagram
    participant ParentCustomElement
    participant ChildCustomElement
    participant AppContext

    ParentCustomElement->AppContext: provide('key', value)
    ChildCustomElement->AppContext: inherit provides via prototype chain
    ChildCustomElement->AppContext: provide('key', newValue)
    ChildCustomElement->AppContext: inject('key')
    Note right of ChildCustomElement: Receives newValue (own), falls back to parent if not present

Assessment against linked issues

Objective	Addressed	Explanation
Ensure nested Vue custom elements have isolated injection scopes and can override parent provides (#13212)	✅
Ensure inner custom elements can access their own provided values, with precedence over parent-provided ones (#13212)	✅
Ensure proper warnings are emitted for missing injections and overwriting provides (#13212)	✅

Suggested reviewers

LittleSound

Poem

In the garden where custom elements grow,
Rabbits hop and dependencies flow.
With prototype chains and warnings anew,
Each nested bunny gets its own view.
Inheritance works, the tests all pass,
Hooray for injection—now top of the class!
🐇✨

📜 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 87cda11 and e73daea.

📒 Files selected for processing (1)

packages/runtime-core/src/apiCreateApp.ts (2 hunks)

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

packages/runtime-core/src/apiCreateApp.ts

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

GitHub Check: test / e2e-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.

…lements

edison1105 · 2025-05-14T07:23:30Z

/ecosystem-ci run

vue-bot · 2025-05-14T07:59:29Z

📝 Ran ecosystem CI: Open

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

adrianbrs commented Apr 17, 2025

View reviewed changes

packages/runtime-core/src/apiCreateApp.ts Show resolved Hide resolved

adrianbrs added 2 commits April 17, 2025 19:25

refactor(custom-elements): remove unnecessary call to _inheritParentC…

399dfaf

…ontext Calling `_inheritParentContext` inside `_setParent` should be sufficient.

test(custom-elements): inject from app context within nested elements

6694878

adrianbrs marked this pull request as ready for review April 17, 2025 22:34

edison1105 reviewed Apr 18, 2025

View reviewed changes

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

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 Apr 18, 2025

edison1105 added the ready to merge The PR is ready to be merged. label May 13, 2025

edison1105 changed the title ~~fix(custom-elements): allow injecting values from app context in nested elements (fix #13212)~~ fix(custom-element): allow injecting values from app context in nested elements (fix #13212) May 14, 2025

Merge branch 'main' into fix/broken-provide-inject-in-nested-custom-e…

e73daea

…lements

vuejs deleted a comment from edison1105 May 14, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(custom-element): allow injecting values from app context in nested elements (fix #13212) #13219

fix(custom-element): allow injecting values from app context in nested elements (fix #13212) #13219

adrianbrs commented Apr 17, 2025 •

edited by coderabbitai bot

Loading

github-actions bot commented Apr 18, 2025 •

edited

Loading

pkg-pr-new bot commented Apr 18, 2025 •

edited

Loading

coderabbitai bot commented May 13, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

edison1105 commented May 14, 2025

vue-bot commented May 14, 2025

fix(custom-element): allow injecting values ​​from app context in nested elements (fix #13212) #13219

Are you sure you want to change the base?

fix(custom-element): allow injecting values ​​from app context in nested elements (fix #13212) #13219

Conversation

adrianbrs commented Apr 17, 2025 • edited by coderabbitai bot Loading

Summary by CodeRabbit

github-actions bot commented Apr 18, 2025 • edited Loading

Size Report

Bundles

Usages

pkg-pr-new bot commented Apr 18, 2025 • edited Loading

coderabbitai bot commented May 13, 2025 • edited Loading

Walkthrough

Changes

Sequence Diagram(s)

Assessment against linked issues

Suggested reviewers

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

edison1105 commented May 14, 2025

vue-bot commented May 14, 2025

fix(custom-element): allow injecting values from app context in nested elements (fix #13212) #13219

fix(custom-element): allow injecting values from app context in nested elements (fix #13212) #13219

adrianbrs commented Apr 17, 2025 •

edited by coderabbitai bot

Loading

github-actions bot commented Apr 18, 2025 •

edited

Loading

pkg-pr-new bot commented Apr 18, 2025 •

edited

Loading

coderabbitai bot commented May 13, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)