fix(compat): maintain compatConfig option in legacy functional comp (#4974)

This commit is contained in:
Illya Klymov 2021-12-06 06:20:27 +02:00 committed by GitHub
parent 595a93715b
commit ee97cf5a4d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 80 additions and 39 deletions

View File

@ -55,6 +55,7 @@ export function convertLegacyFunctionalComponent(comp: ComponentOptions) {
} }
Func.props = comp.props Func.props = comp.props
Func.displayName = comp.name Func.displayName = comp.name
Func.compatConfig = comp.compatConfig
// v2 functional components do not inherit attrs // v2 functional components do not inherit attrs
Func.inheritAttrs = false Func.inheritAttrs = false

View File

@ -60,7 +60,11 @@ import { markAttrsAccessed } from './componentRenderUtils'
import { currentRenderingInstance } from './componentRenderContext' import { currentRenderingInstance } from './componentRenderContext'
import { startMeasure, endMeasure } from './profiling' import { startMeasure, endMeasure } from './profiling'
import { convertLegacyRenderFn } from './compat/renderFn' import { convertLegacyRenderFn } from './compat/renderFn'
import { globalCompatConfig, validateCompatConfig } from './compat/compatConfig' import {
CompatConfig,
globalCompatConfig,
validateCompatConfig
} from './compat/compatConfig'
import { SchedulerJob } from './scheduler' import { SchedulerJob } from './scheduler'
export type Data = Record<string, unknown> export type Data = Record<string, unknown>
@ -111,6 +115,7 @@ export interface FunctionalComponent<P = {}, E extends EmitsOptions = {}>
emits?: E | (keyof E)[] emits?: E | (keyof E)[]
inheritAttrs?: boolean inheritAttrs?: boolean
displayName?: string displayName?: string
compatConfig?: CompatConfig
} }
export interface ClassComponent { export interface ClassComponent {

View File

@ -18,7 +18,8 @@ afterEach(() => {
Vue.configureCompat({ MODE: 3 }) Vue.configureCompat({ MODE: 3 })
}) })
test('COMPONENT_FUNCTIONAL', async () => { describe('COMPONENT_FUNCTIONAL', () => {
test('basic usage', async () => {
const func = { const func = {
name: 'Func', name: 'Func',
functional: true, functional: true,
@ -56,7 +57,41 @@ test('COMPONENT_FUNCTIONAL', async () => {
expect( expect(
( (
deprecationData[DeprecationTypes.COMPONENT_FUNCTIONAL].message as Function deprecationData[DeprecationTypes.COMPONENT_FUNCTIONAL]
.message as Function
)(func) )(func)
).toHaveBeenWarned() ).toHaveBeenWarned()
}) })
test('copies compatConfig option', () => {
const func = {
name: 'Func',
functional: true,
compatConfig: {
ATTR_FALSE_VALUE: 'suppress-warning' as const
},
render: (h: any) => {
// should not render required: false due to compatConfig
return h('div', { 'data-some-attr': false })
}
}
const vm = new Vue({
components: { func },
template: `<func class="foo" x="foo">hello</func>`
}).$mount()
expect(vm.$el.outerHTML).toMatchInlineSnapshot(`"<div></div>"`)
expect(
(
deprecationData[DeprecationTypes.COMPONENT_FUNCTIONAL]
.message as Function
)(func)
).toHaveBeenWarned()
expect(
(deprecationData[DeprecationTypes.ATTR_FALSE_VALUE].message as Function)(
func
)
).not.toHaveBeenWarned()
})
})