Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(runtime-core: ensure customElements have set domprop listeners synchronously if possible. #5328

Merged
merged 2 commits into from Nov 11, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
24 changes: 24 additions & 0 deletions packages/runtime-dom/__tests__/customElement.spec.ts
Expand Up @@ -215,6 +215,30 @@ describe('defineCustomElement', () => {
expect(el.hasAttribute('not-prop')).toBe(false)
})

test('handle properties set before connecting', () => {
const obj = { a: 1 }
const E = defineCustomElement({
props: {
foo: String,
post: Object
},
setup(props) {
expect(props.foo).toBe('hello')
expect(props.post).toBe(obj)
},
render() {
return JSON.stringify(this.post)
}
})
customElements.define('my-el-preconnect', E)
const el = document.createElement('my-el-preconnect') as any
el.foo = 'hello'
el.post = obj

container.appendChild(el)
expect(el.shadowRoot.innerHTML).toBe(JSON.stringify(obj))
})

// https://github.com/vuejs/core/issues/6163
test('handle components with no props', async () => {
const E = defineCustomElement({
Expand Down
54 changes: 34 additions & 20 deletions packages/runtime-dom/src/apiCustomElement.ts
Expand Up @@ -186,6 +186,10 @@ export class VueElement extends BaseClass {
)
}
this.attachShadow({ mode: 'open' })
if (!(this._def as ComponentOptions).__asyncLoader) {
// for sync component defs we can immediately resolve props
this._resolveProps(this._def)
}
}
}

Expand Down Expand Up @@ -227,9 +231,8 @@ export class VueElement extends BaseClass {
}
}).observe(this, { attributes: true })

const resolve = (def: InnerComponentDef) => {
const resolve = (def: InnerComponentDef, isAsync = false) => {
const { props, styles } = def
const declaredPropKeys = isArray(props) ? props : Object.keys(props || {})

// cast Number-type props set before resolve
let numberProps
Expand All @@ -248,23 +251,10 @@ export class VueElement extends BaseClass {
}
this._numberProps = numberProps

// check if there are props set pre-upgrade or connect
for (const key of Object.keys(this)) {
if (key[0] !== '_' && declaredPropKeys.includes(key)) {
this._setProp(key, this[key as keyof this], true, false)
}
}

// defining getter/setters on prototype
for (const key of declaredPropKeys.map(camelize)) {
Object.defineProperty(this, key, {
get() {
return this._getProp(key)
},
set(val) {
this._setProp(key, val)
}
})
if (isAsync) {
// defining getter/setters on prototype
// for sync defs, this already happened in the constructor
this._resolveProps(def)
}

// apply CSS
Expand All @@ -276,12 +266,36 @@ export class VueElement extends BaseClass {

const asyncDef = (this._def as ComponentOptions).__asyncLoader
if (asyncDef) {
asyncDef().then(resolve)
asyncDef().then(def => resolve(def, true))
} else {
resolve(this._def)
}
}

private _resolveProps(def: InnerComponentDef) {
const { props } = def
const declaredPropKeys = isArray(props) ? props : Object.keys(props || {})

// check if there are props set pre-upgrade or connect
for (const key of Object.keys(this)) {
if (key[0] !== '_' && declaredPropKeys.includes(key)) {
this._setProp(key, this[key as keyof this], true, false)
}
}

// defining getter/setters on prototype
for (const key of declaredPropKeys.map(camelize)) {
Object.defineProperty(this, key, {
get() {
return this._getProp(key)
},
set(val) {
this._setProp(key, val)
}
})
}
}

protected _setAttr(key: string) {
let value = this.getAttribute(key)
const camelKey = camelize(key)
Expand Down