fix(custom-element): prevent defineCustomElement from mutating the options object #13791
+14
−2
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… argument of defineCustomElement
WalkthroughReworks defineCustomElement to avoid mutating the original component options by reassigning a shallow-extended copy to the local Comp variable; adds a unit test asserting the original component options object is unchanged after calling defineCustomElement. Changes
Sequence Diagram(s)sequenceDiagram
participant User as User Code
participant API as defineCustomElement
participant Define as defineComponent
participant Util as extend(...)
User->>API: defineCustomElement(Comp, extraOptions)
API->>Define: defineComponent(Comp, extraOptions)
alt defineComponent returns plain object
API->>Util: newComp = extend({}, Comp, extraOptions)
API-->>API: Comp = newComp (reassigned)
else defineComponent returns class/other
API-->>API: Comp unchanged (no in-place extend)
end
API-->>User: VueCustomElement class (uses local Comp)
note right of API: original Comp object passed by user is not mutated
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 💡 Knowledge Base configuration:
You can enable these sources in your CodeRabbit configuration. 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
✨ Finishing Touches
🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
packages/runtime-dom/src/apiCustomElement.ts (1)
175-175: Shallow-clone to prevent unintended mutation of caller’s options (good, targeted fix).Cloning only when
optionsis a plain object neatly avoids mutating the original input whenextraOptionsare merged later viaextend(Comp, extraOptions). Scope and runtime behavior of existing overloads remain intact.To make the rationale future-proof and prevent accidental removal, consider a short inline comment:
- if (isPlainObject(options)) options = extend({}, options) + // Avoid mutating user-supplied options when extraOptions are merged (#13791). + if (isPlainObject(options)) options = extend({}, options)packages/runtime-dom/__tests__/customElement.spec.ts (1)
1777-1788: Optionally harden the test by asserting separation of identities and effective merge.Capturing the return value lets us verify that:
- the runtime
defused by the CE is not the same object as the caller’s options, andextraOptionstook effect on the returned definition.Apply this diff within the test:
- defineCustomElement(Foo, { shadowRoot: false }) + const E = defineCustomElement(Foo, { shadowRoot: false }) + + // Returned def should not alias the caller's options + expect((E as any).def).not.toBe(Foo) + // And extraOptions should be present on the runtime def + expect((E as any).def.shadowRoot).toBe(false)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
packages/runtime-dom/__tests__/customElement.spec.ts(1 hunks)packages/runtime-dom/src/apiCustomElement.ts(1 hunks)
🧰 Additional context used
🧬 Code graph analysis (2)
packages/runtime-dom/__tests__/customElement.spec.ts (2)
packages/runtime-dom/src/apiCustomElement.ts (1)
defineCustomElement(167-186)packages/runtime-dom/src/index.ts (1)
defineCustomElement(255-255)
packages/runtime-dom/src/apiCustomElement.ts (1)
packages/shared/src/general.ts (2)
isPlainObject(74-75)extend(24-24)
⏰ 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 (1)
packages/runtime-dom/__tests__/customElement.spec.ts (1)
1777-1788: Regression test covers the mutation bug succinctly.This asserts the original options object stays untouched when passing
extraOptions. Clear and low-noise.
LeeSamFong
changed the title
edison1105
changed the title
edison1105
added
ready to merge
Size ReportBundles
Usages
|
@vue/compiler-core
@vue/compiler-dom
@vue/compiler-sfc
@vue/compiler-ssr
@vue/reactivity
@vue/runtime-core
@vue/runtime-dom
@vue/server-renderer
@vue/shared
vue
@vue/compat
commit: |
|
/ecosystem-ci run |
|
📝 Ran ecosystem CI: Open
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is to fix the problem that the 2nd argument will accidentally mutate the 1st argument of
defineCustomElement(), which will cause exceptions in the following scenarios:https://codesandbox.io/p/devbox/test-jwvgql?embed=1&file=%2Fsrc%2Fmain.ts
Summary by CodeRabbit