import Vue from 'vue'
import VNode from 'core/vdom/vnode'
import { patch } from 'web/runtime/patch'
import { SSR_ATTR } from 'shared/constants'
function createMockSSRDOM (innerHTML) {
const dom = document.createElement('div')
dom.setAttribute(SSR_ATTR, 'true')
dom.innerHTML = innerHTML
return dom
}
describe('vdom patch: hydration', () => {
let vnode0
beforeEach(() => {
vnode0 = new VNode('p', { attrs: { id: '1' }}, [createTextVNode('hello world')])
patch(null, vnode0)
})
it('should hydrate elements when server-rendered DOM tree is same as virtual DOM tree', () => {
const result = []
function init (vnode) { result.push(vnode) }
function createServerRenderedDOM () {
const root = document.createElement('div')
root.setAttribute(SSR_ATTR, 'true')
const span = document.createElement('span')
root.appendChild(span)
const div = document.createElement('div')
const child1 = document.createElement('span')
const child2 = document.createElement('span')
child1.textContent = 'hi'
child2.textContent = 'ho'
div.appendChild(child1)
div.appendChild(child2)
root.appendChild(div)
return root
}
const node0 = createServerRenderedDOM()
const vnode1 = new VNode('div', {}, [
new VNode('span', {}),
new VNode('div', { hook: { init }}, [
new VNode('span', {}, [new VNode(undefined, undefined, undefined, 'hi')]),
new VNode('span', {}, [new VNode(undefined, undefined, undefined, 'ho')])
])
])
patch(node0, vnode1)
expect(result.length).toBe(1)
function traverseAndAssert (vnode, element) {
expect(vnode.elm).toBe(element)
if (vnode.children) {
vnode.children.forEach((node, i) => {
traverseAndAssert(node, element.childNodes[i])
})
}
}
// ensure vnodes are correctly associated with actual DOM
traverseAndAssert(vnode1, node0)
// check update
const vnode2 = new VNode('div', { attrs: { id: 'foo' }}, [
new VNode('span', { attrs: { id: 'bar' }}),
new VNode('div', { hook: { init }}, [
new VNode('span', {}),
new VNode('span', {})
])
])
patch(vnode1, vnode2)
expect(node0.id).toBe('foo')
expect(node0.children[0].id).toBe('bar')
})
it('should warn message that virtual DOM tree is not matching when hydrate element', () => {
function createServerRenderedDOM () {
const root = document.createElement('div')
root.setAttribute(SSR_ATTR, 'true')
const span = document.createElement('span')
root.appendChild(span)
const div = document.createElement('div')
const child1 = document.createElement('span')
div.appendChild(child1)
root.appendChild(div)
return root
}
const node0 = createServerRenderedDOM()
const vnode1 = new VNode('div', {}, [
new VNode('span', {}),
new VNode('div', {}, [
new VNode('span', {}),
new VNode('span', {})
])
])
patch(node0, vnode1)
expect('The client-side rendered virtual DOM tree is not matching').toHaveBeenWarned()
})
// component hydration is better off with a more e2e approach
it('should hydrate components when server-rendered DOM tree is same as virtual DOM tree', done => {
const dom = createMockSSRDOM('foo
foo qux
')
const originalNode1 = dom.children[0]
const originalNode2 = dom.children[1]
const vm = new Vue({
template: '',
data: {
msg: 'foo',
ok: false
},
components: {
test: {
props: ['msg'],
data () {
return { a: 'qux' }
},
template: '{{msg}} {{a}}
'
}
}
})
expect(() => { vm.$mount(dom) }).not.toThrow()
expect('not matching server-rendered content').not.toHaveBeenWarned()
expect(vm.$el).toBe(dom)
expect(vm.$children[0].$el).toBe(originalNode2)
expect(vm.$el.children[0]).toBe(originalNode1)
expect(vm.$el.children[1]).toBe(originalNode2)
vm.msg = 'bar'
waitForUpdate(() => {
expect(vm.$el.innerHTML).toBe('barbar qux
')
vm.$children[0].a = 'ququx'
}).then(() => {
expect(vm.$el.innerHTML).toBe('barbar ququx
')
vm.ok = true
}).then(() => {
expect(vm.$el.innerHTML).toBe('barbar ququx
')
}).then(done)
})
it('should warn failed hydration for non-matching DOM in child component', () => {
const dom = createMockSSRDOM('
')
new Vue({
template: '
',
components: {
test: {
template: ''
}
}
}).$mount(dom)
expect('not matching server-rendered content').toHaveBeenWarned()
})
it('should overwrite textNodes in the correct position but with mismatching text without warning', () => {
const dom = createMockSSRDOM('foo
')
new Vue({
template: '
',
components: {
test: {
data () {
return { a: 'qux' }
},
template: '{{a}}
'
}
}
}).$mount(dom)
expect('not matching server-rendered content').not.toHaveBeenWarned()
expect(dom.querySelector('span').textContent).toBe('qux')
})
it('should pick up elements with no children and populate without warning', done => {
const dom = createMockSSRDOM('
')
const span = dom.querySelector('span')
const vm = new Vue({
template: '
',
components: {
test: {
data () {
return { a: 'qux' }
},
template: '{{a}}
'
}
}
}).$mount(dom)
expect('not matching server-rendered content').not.toHaveBeenWarned()
expect(span).toBe(vm.$el.querySelector('span'))
expect(vm.$el.innerHTML).toBe('qux
')
vm.$children[0].a = 'foo'
waitForUpdate(() => {
expect(vm.$el.innerHTML).toBe('foo
')
}).then(done)
})
it('should hydrate async component', done => {
const dom = createMockSSRDOM('foo')
const span = dom.querySelector('span')
const Foo = resolve => setTimeout(() => {
resolve({
data: () => ({ msg: 'foo' }),
template: `{{ msg }}`
})
}, 0)
const vm = new Vue({
template: '
',
components: { Foo }
}).$mount(dom)
expect('not matching server-rendered content').not.toHaveBeenWarned()
expect(dom.innerHTML).toBe('foo')
expect(vm.$refs.foo).toBeUndefined()
setTimeout(() => {
expect(dom.innerHTML).toBe('foo')
expect(vm.$refs.foo).not.toBeUndefined()
vm.$refs.foo.msg = 'bar'
waitForUpdate(() => {
expect(dom.innerHTML).toBe('bar')
expect(dom.querySelector('span')).toBe(span)
}).then(done)
}, 0)
})
it('should hydrate async component without showing loading', done => {
const dom = createMockSSRDOM('foo')
const span = dom.querySelector('span')
const Foo = () => ({
component: new Promise(resolve => {
setTimeout(() => {
resolve({
data: () => ({ msg: 'foo' }),
template: `{{ msg }}`
})
}, 10)
}),
delay: 1,
loading: {
render: h => h('span', 'loading')
}
})
const vm = new Vue({
template: '
',
components: { Foo }
}).$mount(dom)
expect('not matching server-rendered content').not.toHaveBeenWarned()
expect(dom.innerHTML).toBe('foo')
expect(vm.$refs.foo).toBeUndefined()
setTimeout(() => {
expect(dom.innerHTML).toBe('foo')
}, 1)
setTimeout(() => {
expect(dom.innerHTML).toBe('foo')
expect(vm.$refs.foo).not.toBeUndefined()
vm.$refs.foo.msg = 'bar'
waitForUpdate(() => {
expect(dom.innerHTML).toBe('bar')
expect(dom.querySelector('span')).toBe(span)
}).then(done)
}, 10)
})
it('should hydrate async component by replacing DOM if error occurs', done => {
const dom = createMockSSRDOM('foo')
const Foo = () => ({
component: new Promise((resolve, reject) => {
setTimeout(() => {
reject('something went wrong')
}, 10)
}),
error: {
render: h => h('span', 'error')
}
})
new Vue({
template: '
',
components: { Foo }
}).$mount(dom)
expect('not matching server-rendered content').not.toHaveBeenWarned()
expect(dom.innerHTML).toBe('foo')
setTimeout(() => {
expect('Failed to resolve async').toHaveBeenWarned()
expect(dom.innerHTML).toBe('error')
done()
}, 10)
})
})