Skip to content

Commit

Permalink
perf: improve static content insertion perf
Browse files Browse the repository at this point in the history
Especially on multiple insertions of the same static node.

fix #3090
  • Loading branch information
yyx990803 committed Jun 21, 2021
1 parent be1e42e commit 4de5d24
Show file tree
Hide file tree
Showing 3 changed files with 151 additions and 21 deletions.
9 changes: 7 additions & 2 deletions packages/runtime-core/src/renderer.ts
Expand Up @@ -141,7 +141,8 @@ export interface RendererOptions<
content: string,
parent: HostElement,
anchor: HostNode | null,
isSVG: boolean
isSVG: boolean,
cached?: [HostNode, HostNode | null] | null
): HostElement[]
}

Expand Down Expand Up @@ -635,7 +636,11 @@ function baseCreateRenderer(
n2.children as string,
container,
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.el && [n2.el, n2.anchor]
)
}

Expand Down
99 changes: 98 additions & 1 deletion packages/runtime-dom/__tests__/nodeOps.spec.ts
@@ -1,4 +1,4 @@
import { nodeOps } from '../src/nodeOps'
import { nodeOps, svgNS } from '../src/nodeOps'

describe('runtime-dom: node-ops', () => {
test('the _value property should be cloned', () => {
Expand All @@ -25,4 +25,101 @@ describe('runtime-dom: node-ops', () => {
expect(option1.selected).toBe(true)
expect(option2.selected).toBe(true)
})

describe('insertStaticContent', () => {
test('fresh insertion', () => {
const content = `<div>one</div><div>two</div>three`
const parent = document.createElement('div')
const [first, last] = nodeOps.insertStaticContent!(
content,
parent,
null,
false
)
expect(parent.innerHTML).toBe(content)
expect(first).toBe(parent.firstChild)
expect(last).toBe(parent.lastChild)
})

test('fresh insertion with anchor', () => {
const content = `<div>one</div><div>two</div>three`
const existing = `<div>existing</div>`
const parent = document.createElement('div')
parent.innerHTML = existing
const anchor = parent.firstChild
const [first, last] = nodeOps.insertStaticContent!(
content,
parent,
anchor,
false
)
expect(parent.innerHTML).toBe(content + existing)
expect(first).toBe(parent.firstChild)
expect(last).toBe(parent.childNodes[parent.childNodes.length - 2])
})

test('fresh insertion as svg', () => {
const content = `<text>hello</text><circle cx="100" cy="100" r="80"></circle>`
const parent = document.createElementNS(svgNS, 'svg')
const [first, last] = nodeOps.insertStaticContent!(
content,
parent,
null,
true
)
expect(parent.innerHTML).toBe(content)
expect(first).toBe(parent.firstChild)
expect(last).toBe(parent.lastChild)
expect(first.namespaceURI).toMatch('svg')
expect(last.namespaceURI).toMatch('svg')
})

test('fresh insertion as svg, with anchor', () => {
const content = `<text>hello</text><circle cx="100" cy="100" r="80"></circle>`
const existing = `<path></path>`
const parent = document.createElementNS(svgNS, 'svg')
parent.innerHTML = existing
const anchor = parent.firstChild
const [first, last] = nodeOps.insertStaticContent!(
content,
parent,
anchor,
true
)
expect(parent.innerHTML).toBe(content + existing)
expect(first).toBe(parent.firstChild)
expect(last).toBe(parent.childNodes[parent.childNodes.length - 2])
expect(first.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 [cachedFirst, cachedLast] = nodeOps.insertStaticContent!(
content,
cacheParent,
null,
false
)

const parent = document.createElement('div')

const [first, last] = nodeOps.insertStaticContent!(
``,
parent,
null,
false,
[cachedFirst, cachedLast]
)

expect(parent.innerHTML).toBe(content)
expect(first).toBe(parent.firstChild)
expect(last).toBe(parent.lastChild)

expect(first).not.toBe(cachedFirst)
expect(last).not.toBe(cachedLast)
})
})
})
64 changes: 46 additions & 18 deletions packages/runtime-dom/src/nodeOps.ts
Expand Up @@ -4,9 +4,6 @@ export const svgNS = 'http://www.w3.org/2000/svg'

const doc = (typeof document !== 'undefined' ? document : null) as Document

let tempContainer: HTMLElement
let tempSVGContainer: SVGElement

export const nodeOps: Omit<RendererOptions<Node, Element>, 'patchProp'> = {
insert: (child, parent, anchor) => {
parent.insertBefore(child, anchor || null)
Expand Down Expand Up @@ -71,23 +68,54 @@ export const nodeOps: Omit<RendererOptions<Node, Element>, 'patchProp'> = {
},

// __UNSAFE__
// Reason: innerHTML.
// Reason: insertAdjacentHTML.
// Static content here can only come from compiled templates.
// As long as the user only uses trusted templates, this is safe.
insertStaticContent(content, parent, anchor, isSVG) {
const temp = isSVG
? tempSVGContainer ||
(tempSVGContainer = doc.createElementNS(svgNS, 'svg'))
: tempContainer || (tempContainer = doc.createElement('div'))
temp.innerHTML = content
const first = temp.firstChild as Element
let node: Element | null = first
let last: Element = node
while (node) {
last = node
nodeOps.insert(node, parent, anchor)
node = temp.firstChild as Element
insertStaticContent(content, parent, anchor, isSVG, cached) {
if (cached) {
let [cachedFirst, cachedLast] = cached
let first, last
while (true) {
let node = cachedFirst.cloneNode(true)
if (!first) first = node
parent.insertBefore(node, anchor)
if (cachedFirst === cachedLast) {
last = node
break
}
cachedFirst = cachedFirst.nextSibling!
}
return [first, last] as any
}

// <parent> before | first ... last | anchor </parent>
const before = anchor ? anchor.previousSibling : parent.lastChild
if (anchor) {
let insertionPoint
let usingTempInsertionPoint = false
if (anchor instanceof Element) {
insertionPoint = anchor
} else {
// insertAdjacentHTML only works for elements but the anchor is not an
// element...
usingTempInsertionPoint = true
insertionPoint = isSVG
? doc.createElementNS(svgNS, 'g')
: doc.createElement('div')
parent.insertBefore(insertionPoint, anchor)
}
insertionPoint.insertAdjacentHTML('beforebegin', content)
if (usingTempInsertionPoint) {
parent.removeChild(insertionPoint)
}
} else {
parent.insertAdjacentHTML('beforeend', content)
}
return [first, last]
return [
// first
before ? before.nextSibling : parent.firstChild,
// last
anchor ? anchor.previousSibling : parent.lastChild
]
}
}

0 comments on commit 4de5d24

Please sign in to comment.