refactor: simplify static content insertion

This commit is contained in:
Evan You 2021-07-09 16:18:36 -04:00
parent 5df7dfcd71
commit c0db807844
4 changed files with 30 additions and 94 deletions

View File

@ -142,9 +142,8 @@ export interface RendererOptions<
content: string, content: string,
parent: HostElement, parent: HostElement,
anchor: HostNode | null, anchor: HostNode | null,
isSVG: boolean, isSVG: boolean
cached?: HostNode[] | null ): [HostNode, HostNode]
): HostElement[]
} }
// Renderer Node can technically be any object in the context of core renderer // Renderer Node can technically be any object in the context of core renderer
@ -633,22 +632,12 @@ function baseCreateRenderer(
) => { ) => {
// static nodes are only present when used with compiler-dom/runtime-dom // static nodes are only present when used with compiler-dom/runtime-dom
// which guarantees presence of hostInsertStaticContent. // which guarantees presence of hostInsertStaticContent.
const nodes = hostInsertStaticContent!( ;[n2.el, n2.anchor] = hostInsertStaticContent!(
n2.children as string, n2.children as string,
container, container,
anchor, anchor,
isSVG, isSVG
// pass cached nodes if the static node is being mounted multiple times
// so that runtime-dom can simply cloneNode() instead of inserting new
// HTML
n2.staticCache
) )
// first mount - this is the orignal hoisted vnode. cache nodes.
if (!n2.el) {
n2.staticCache = nodes
}
n2.el = nodes[0]
n2.anchor = nodes[nodes.length - 1]
} }
/** /**

View File

@ -168,7 +168,6 @@ export interface VNode<
target: HostElement | null // teleport target target: HostElement | null // teleport target
targetAnchor: HostNode | null // teleport target anchor targetAnchor: HostNode | null // teleport target anchor
staticCount?: number // number of elements contained in a static vnode staticCount?: number // number of elements contained in a static vnode
staticCache?: HostNode[] // cache of parsed static nodes for faster repeated insertions
// suspense // suspense
suspense: SuspenseBoundary | null suspense: SuspenseBoundary | null
@ -521,7 +520,6 @@ export function cloneVNode<T, U>(
target: vnode.target, target: vnode.target,
targetAnchor: vnode.targetAnchor, targetAnchor: vnode.targetAnchor,
staticCount: vnode.staticCount, staticCount: vnode.staticCount,
staticCache: vnode.staticCache,
shapeFlag: vnode.shapeFlag, shapeFlag: vnode.shapeFlag,
// if the vnode is cloned with extra props, we can no longer assume its // if the vnode is cloned with extra props, we can no longer assume its
// existing patch flag to be reliable and need to add the FULL_PROPS flag. // existing patch flag to be reliable and need to add the FULL_PROPS flag.

View File

@ -32,9 +32,8 @@ describe('runtime-dom: node-ops', () => {
const parent = document.createElement('div') const parent = document.createElement('div')
const nodes = nodeOps.insertStaticContent!(content, parent, null, false) const nodes = nodeOps.insertStaticContent!(content, parent, null, false)
expect(parent.innerHTML).toBe(content) expect(parent.innerHTML).toBe(content)
expect(nodes.length).toBe(3)
expect(nodes[0]).toBe(parent.firstChild) expect(nodes[0]).toBe(parent.firstChild)
expect(nodes[nodes.length - 1]).toBe(parent.lastChild) expect(nodes[1]).toBe(parent.lastChild)
}) })
test('fresh insertion with anchor', () => { test('fresh insertion with anchor', () => {
@ -45,11 +44,8 @@ describe('runtime-dom: node-ops', () => {
const anchor = parent.firstChild const anchor = parent.firstChild
const nodes = nodeOps.insertStaticContent!(content, parent, anchor, false) const nodes = nodeOps.insertStaticContent!(content, parent, anchor, false)
expect(parent.innerHTML).toBe(content + existing) expect(parent.innerHTML).toBe(content + existing)
expect(nodes.length).toBe(3)
expect(nodes[0]).toBe(parent.firstChild) expect(nodes[0]).toBe(parent.firstChild)
expect(nodes[nodes.length - 1]).toBe( expect(nodes[1]).toBe(parent.childNodes[parent.childNodes.length - 2])
parent.childNodes[parent.childNodes.length - 2]
)
}) })
test('fresh insertion as svg', () => { test('fresh insertion as svg', () => {
@ -86,32 +82,5 @@ describe('runtime-dom: node-ops', () => {
expect(first.namespaceURI).toMatch('svg') expect(first.namespaceURI).toMatch('svg')
expect(last.namespaceURI).toMatch('svg') expect(last.namespaceURI).toMatch('svg')
}) })
test('cached', () => {
const content = `<div>one</div><div>two</div>three`
const cacheParent = document.createElement('div')
const nodes = nodeOps.insertStaticContent!(
content,
cacheParent,
null,
false
)
const parent = document.createElement('div')
const clonedNodes = nodeOps.insertStaticContent!(
``,
parent,
null,
false,
nodes
)
expect(parent.innerHTML).toBe(content)
expect(clonedNodes[0]).toBe(parent.firstChild)
expect(clonedNodes[clonedNodes.length - 1]).toBe(parent.lastChild)
expect(clonedNodes[0]).not.toBe(nodes[0])
})
}) })
}) })

View File

@ -4,6 +4,8 @@ export const svgNS = 'http://www.w3.org/2000/svg'
const doc = (typeof document !== 'undefined' ? document : null) as Document const doc = (typeof document !== 'undefined' ? document : null) as Document
const staticTemplateCache = new Map<string, DocumentFragment>()
export const nodeOps: Omit<RendererOptions<Node, Element>, 'patchProp'> = { export const nodeOps: Omit<RendererOptions<Node, Element>, 'patchProp'> = {
insert: (child, parent, anchor) => { insert: (child, parent, anchor) => {
parent.insertBefore(child, anchor || null) parent.insertBefore(child, anchor || null)
@ -68,55 +70,33 @@ export const nodeOps: Omit<RendererOptions<Node, Element>, 'patchProp'> = {
}, },
// __UNSAFE__ // __UNSAFE__
// Reason: insertAdjacentHTML. // Reason: innerHTML.
// Static content here can only come from compiled templates. // Static content here can only come from compiled templates.
// As long as the user only uses trusted templates, this is safe. // As long as the user only uses trusted templates, this is safe.
insertStaticContent(content, parent, anchor, isSVG, cached) { insertStaticContent(content, parent, anchor, isSVG) {
if (cached) {
let first
let last
let i = 0
let l = cached.length
for (; i < l; i++) {
const node = cached[i].cloneNode(true)
if (i === 0) first = node
if (i === l - 1) last = node
parent.insertBefore(node, anchor)
}
return [first, last] as any
}
// <parent> before | first ... last | anchor </parent> // <parent> before | first ... last | anchor </parent>
const before = anchor ? anchor.previousSibling : parent.lastChild const before = anchor ? anchor.previousSibling : parent.lastChild
if (anchor) { let template = staticTemplateCache.get(content)
let insertionPoint if (!template) {
let usingTempInsertionPoint = false const t = doc.createElement('template')
if (anchor instanceof Element) { t.innerHTML = isSVG ? `<svg>${content}</svg>` : content
insertionPoint = anchor template = t.content
} else { if (isSVG) {
// insertAdjacentHTML only works for elements but the anchor is not an // remove outer svg wrapper
// element... const wrapper = template.firstChild!
usingTempInsertionPoint = true while (wrapper.firstChild) {
insertionPoint = isSVG template.appendChild(wrapper.firstChild)
? doc.createElementNS(svgNS, 'g') }
: doc.createElement('div') template.removeChild(wrapper)
parent.insertBefore(insertionPoint, anchor)
} }
insertionPoint.insertAdjacentHTML('beforebegin', content) staticTemplateCache.set(content, template)
if (usingTempInsertionPoint) {
parent.removeChild(insertionPoint)
}
} else {
parent.insertAdjacentHTML('beforeend', content)
} }
let first = before ? before.nextSibling : parent.firstChild parent.insertBefore(template.cloneNode(true), anchor)
const last = anchor ? anchor.previousSibling : parent.lastChild return [
const ret = [] // first
while (first) { before ? before.nextSibling! : parent.firstChild!,
ret.push(first) // last
if (first === last) break anchor ? anchor.previousSibling! : parent.lastChild!
first = first.nextSibling ]
}
return ret
} }
} }