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): only render valid slot content #2485

Merged
merged 3 commits into from
Nov 26, 2020
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 29 additions & 1 deletion packages/runtime-core/__tests__/helpers/renderSlot.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ import {
createVNode,
openBlock,
createBlock,
Fragment
Fragment,
createCommentVNode
} from '../../src'
import { PatchFlags } from '@vue/shared/src'

Expand Down Expand Up @@ -47,4 +48,31 @@ describe('renderSlot', () => {
const templateRendered = renderSlot({ default: slot }, 'default')
expect(templateRendered.dynamicChildren!.length).toBe(1)
})

// #2347 #2461
describe('only render valid slot content', () => {
it('should ignore slots that are all comments', () => {
let fallback
const vnode = renderSlot(
{ default: () => [createCommentVNode('foo')] },
'default',
undefined,
() => [(fallback = h('fallback'))]
)
expect(vnode.children).toEqual([fallback])
expect(vnode.patchFlag).toBe(PatchFlags.BAIL)
})

it('should ignore invalid slot content generated by nested slot', () => {
let fallback
const vnode = renderSlot(
{ default: () => [renderSlot({}, 'foo')] },
'default',
undefined,
() => [(fallback = h('fallback'))]
)
expect(vnode.children).toEqual([fallback])
expect(vnode.patchFlag).toBe(PatchFlags.BAIL)
})
})
})
27 changes: 22 additions & 5 deletions packages/runtime-core/src/helpers/renderSlot.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { Data } from '../component'
import { Slots, RawSlots } from '../componentSlots'
import { Comment, isVNode } from '../vnode'
import {
VNodeArrayChildren,
openBlock,
Expand Down Expand Up @@ -42,15 +43,31 @@ export function renderSlot(
// `renderSlot` we can be sure that it's template-based so we can force
// enable it.
isRenderingCompiledSlot++
const rendered = (openBlock(),
createBlock(
openBlock()
const validSlotContent = slot && ensureValidVNode(slot(props))
const rendered = createBlock(
Fragment,
{ key: props.key },
slot ? slot(props) : fallback ? fallback() : [],
(slots as RawSlots)._ === SlotFlags.STABLE
validSlotContent || (fallback ? fallback() : []),
validSlotContent && (slots as RawSlots)._ === SlotFlags.STABLE
? PatchFlags.STABLE_FRAGMENT
: PatchFlags.BAIL
))
)
isRenderingCompiledSlot--
return rendered
}

function ensureValidVNode(vnodes: VNodeArrayChildren) {
return vnodes.some(child => {
if (!isVNode(child)) return true
if (child.type === Comment) return false
if (
child.type === Fragment &&
!ensureValidVNode(child.children as VNodeArrayChildren)
)
return false
return true
})
? vnodes
: null
}