hydration.spec.ts 32 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087
  1. /**
  2. * @vitest-environment jsdom
  3. */
  4. import {
  5. createSSRApp,
  6. h,
  7. ref,
  8. nextTick,
  9. VNode,
  10. Teleport,
  11. createStaticVNode,
  12. Suspense,
  13. onMounted,
  14. defineAsyncComponent,
  15. defineComponent,
  16. createTextVNode,
  17. createVNode,
  18. withDirectives,
  19. vModelCheckbox,
  20. renderSlot
  21. } from '@vue/runtime-dom'
  22. import { renderToString, SSRContext } from '@vue/server-renderer'
  23. import { PatchFlags } from '../../shared/src'
  24. function mountWithHydration(html: string, render: () => any) {
  25. const container = document.createElement('div')
  26. container.innerHTML = html
  27. const app = createSSRApp({
  28. render
  29. })
  30. return {
  31. vnode: app.mount(container).$.subTree as VNode<Node, Element> & {
  32. el: Element
  33. },
  34. container
  35. }
  36. }
  37. const triggerEvent = (type: string, el: Element) => {
  38. const event = new Event(type)
  39. el.dispatchEvent(event)
  40. }
  41. describe('SSR hydration', () => {
  42. beforeEach(() => {
  43. document.body.innerHTML = ''
  44. })
  45. test('text', async () => {
  46. const msg = ref('foo')
  47. const { vnode, container } = mountWithHydration('foo', () => msg.value)
  48. expect(vnode.el).toBe(container.firstChild)
  49. expect(container.textContent).toBe('foo')
  50. msg.value = 'bar'
  51. await nextTick()
  52. expect(container.textContent).toBe('bar')
  53. })
  54. test('empty text', async () => {
  55. const { container } = mountWithHydration('<div></div>', () =>
  56. h('div', createTextVNode(''))
  57. )
  58. expect(container.textContent).toBe('')
  59. expect(`Hydration children mismatch in <div>`).not.toHaveBeenWarned()
  60. })
  61. test('comment', () => {
  62. const { vnode, container } = mountWithHydration('<!---->', () => null)
  63. expect(vnode.el).toBe(container.firstChild)
  64. expect(vnode.el.nodeType).toBe(8) // comment
  65. })
  66. test('static', () => {
  67. const html = '<div><span>hello</span></div>'
  68. const { vnode, container } = mountWithHydration(html, () =>
  69. createStaticVNode('', 1)
  70. )
  71. expect(vnode.el).toBe(container.firstChild)
  72. expect(vnode.el.outerHTML).toBe(html)
  73. expect(vnode.anchor).toBe(container.firstChild)
  74. expect(vnode.children).toBe(html)
  75. })
  76. test('static (multiple elements)', () => {
  77. const staticContent = '<div></div><span>hello</span>'
  78. const html = `<div><div>hi</div>` + staticContent + `<div>ho</div></div>`
  79. const n1 = h('div', 'hi')
  80. const s = createStaticVNode('', 2)
  81. const n2 = h('div', 'ho')
  82. const { container } = mountWithHydration(html, () => h('div', [n1, s, n2]))
  83. const div = container.firstChild!
  84. expect(n1.el).toBe(div.firstChild)
  85. expect(n2.el).toBe(div.lastChild)
  86. expect(s.el).toBe(div.childNodes[1])
  87. expect(s.anchor).toBe(div.childNodes[2])
  88. expect(s.children).toBe(staticContent)
  89. })
  90. // #6008
  91. test('static (with text node as starting node)', () => {
  92. const html = ` A <span>foo</span> B`
  93. const { vnode, container } = mountWithHydration(html, () =>
  94. createStaticVNode(` A <span>foo</span> B`, 3)
  95. )
  96. expect(vnode.el).toBe(container.firstChild)
  97. expect(vnode.anchor).toBe(container.lastChild)
  98. expect(`Hydration node mismatch`).not.toHaveBeenWarned()
  99. })
  100. test('static with content adoption', () => {
  101. const html = ` A <span>foo</span> B`
  102. const { vnode, container } = mountWithHydration(html, () =>
  103. createStaticVNode(``, 3)
  104. )
  105. expect(vnode.el).toBe(container.firstChild)
  106. expect(vnode.anchor).toBe(container.lastChild)
  107. expect(vnode.children).toBe(html)
  108. expect(`Hydration node mismatch`).not.toHaveBeenWarned()
  109. })
  110. test('element with text children', async () => {
  111. const msg = ref('foo')
  112. const { vnode, container } = mountWithHydration(
  113. '<div class="foo">foo</div>',
  114. () => h('div', { class: msg.value }, msg.value)
  115. )
  116. expect(vnode.el).toBe(container.firstChild)
  117. expect(container.firstChild!.textContent).toBe('foo')
  118. msg.value = 'bar'
  119. await nextTick()
  120. expect(container.innerHTML).toBe(`<div class="bar">bar</div>`)
  121. })
  122. test('element with elements children', async () => {
  123. const msg = ref('foo')
  124. const fn = vi.fn()
  125. const { vnode, container } = mountWithHydration(
  126. '<div><span>foo</span><span class="foo"></span></div>',
  127. () =>
  128. h('div', [
  129. h('span', msg.value),
  130. h('span', { class: msg.value, onClick: fn })
  131. ])
  132. )
  133. expect(vnode.el).toBe(container.firstChild)
  134. expect((vnode.children as VNode[])[0].el).toBe(
  135. container.firstChild!.childNodes[0]
  136. )
  137. expect((vnode.children as VNode[])[1].el).toBe(
  138. container.firstChild!.childNodes[1]
  139. )
  140. // event handler
  141. triggerEvent('click', vnode.el.querySelector('.foo')!)
  142. expect(fn).toHaveBeenCalled()
  143. msg.value = 'bar'
  144. await nextTick()
  145. expect(vnode.el.innerHTML).toBe(`<span>bar</span><span class="bar"></span>`)
  146. })
  147. test('element with ref', () => {
  148. const el = ref()
  149. const { vnode, container } = mountWithHydration('<div></div>', () =>
  150. h('div', { ref: el })
  151. )
  152. expect(vnode.el).toBe(container.firstChild)
  153. expect(el.value).toBe(vnode.el)
  154. })
  155. test('Fragment', async () => {
  156. const msg = ref('foo')
  157. const fn = vi.fn()
  158. const { vnode, container } = mountWithHydration(
  159. '<div><!--[--><span>foo</span><!--[--><span class="foo"></span><!--]--><!--]--></div>',
  160. () =>
  161. h('div', [
  162. [h('span', msg.value), [h('span', { class: msg.value, onClick: fn })]]
  163. ])
  164. )
  165. expect(vnode.el).toBe(container.firstChild)
  166. expect(vnode.el.innerHTML).toBe(
  167. `<!--[--><span>foo</span><!--[--><span class="foo"></span><!--]--><!--]-->`
  168. )
  169. // start fragment 1
  170. const fragment1 = (vnode.children as VNode[])[0]
  171. expect(fragment1.el).toBe(vnode.el.childNodes[0])
  172. const fragment1Children = fragment1.children as VNode[]
  173. // first <span>
  174. expect(fragment1Children[0].el!.tagName).toBe('SPAN')
  175. expect(fragment1Children[0].el).toBe(vnode.el.childNodes[1])
  176. // start fragment 2
  177. const fragment2 = fragment1Children[1]
  178. expect(fragment2.el).toBe(vnode.el.childNodes[2])
  179. const fragment2Children = fragment2.children as VNode[]
  180. // second <span>
  181. expect(fragment2Children[0].el!.tagName).toBe('SPAN')
  182. expect(fragment2Children[0].el).toBe(vnode.el.childNodes[3])
  183. // end fragment 2
  184. expect(fragment2.anchor).toBe(vnode.el.childNodes[4])
  185. // end fragment 1
  186. expect(fragment1.anchor).toBe(vnode.el.childNodes[5])
  187. // event handler
  188. triggerEvent('click', vnode.el.querySelector('.foo')!)
  189. expect(fn).toHaveBeenCalled()
  190. msg.value = 'bar'
  191. await nextTick()
  192. expect(vnode.el.innerHTML).toBe(
  193. `<!--[--><span>bar</span><!--[--><span class="bar"></span><!--]--><!--]-->`
  194. )
  195. })
  196. test('Teleport', async () => {
  197. const msg = ref('foo')
  198. const fn = vi.fn()
  199. const teleportContainer = document.createElement('div')
  200. teleportContainer.id = 'teleport'
  201. teleportContainer.innerHTML = `<span>foo</span><span class="foo"></span><!--teleport anchor-->`
  202. document.body.appendChild(teleportContainer)
  203. const { vnode, container } = mountWithHydration(
  204. '<!--teleport start--><!--teleport end-->',
  205. () =>
  206. h(Teleport, { to: '#teleport' }, [
  207. h('span', msg.value),
  208. h('span', { class: msg.value, onClick: fn })
  209. ])
  210. )
  211. expect(vnode.el).toBe(container.firstChild)
  212. expect(vnode.anchor).toBe(container.lastChild)
  213. expect(vnode.target).toBe(teleportContainer)
  214. expect((vnode.children as VNode[])[0].el).toBe(
  215. teleportContainer.childNodes[0]
  216. )
  217. expect((vnode.children as VNode[])[1].el).toBe(
  218. teleportContainer.childNodes[1]
  219. )
  220. expect(vnode.targetAnchor).toBe(teleportContainer.childNodes[2])
  221. // event handler
  222. triggerEvent('click', teleportContainer.querySelector('.foo')!)
  223. expect(fn).toHaveBeenCalled()
  224. msg.value = 'bar'
  225. await nextTick()
  226. expect(teleportContainer.innerHTML).toBe(
  227. `<span>bar</span><span class="bar"></span><!--teleport anchor-->`
  228. )
  229. })
  230. test('Teleport (multiple + integration)', async () => {
  231. const msg = ref('foo')
  232. const fn1 = vi.fn()
  233. const fn2 = vi.fn()
  234. const Comp = () => [
  235. h(Teleport, { to: '#teleport2' }, [
  236. h('span', msg.value),
  237. h('span', { class: msg.value, onClick: fn1 })
  238. ]),
  239. h(Teleport, { to: '#teleport2' }, [
  240. h('span', msg.value + '2'),
  241. h('span', { class: msg.value + '2', onClick: fn2 })
  242. ])
  243. ]
  244. const teleportContainer = document.createElement('div')
  245. teleportContainer.id = 'teleport2'
  246. const ctx: SSRContext = {}
  247. const mainHtml = await renderToString(h(Comp), ctx)
  248. expect(mainHtml).toMatchInlineSnapshot(
  249. `"<!--[--><!--teleport start--><!--teleport end--><!--teleport start--><!--teleport end--><!--]-->"`
  250. )
  251. const teleportHtml = ctx.teleports!['#teleport2']
  252. expect(teleportHtml).toMatchInlineSnapshot(
  253. '"<span>foo</span><span class=\\"foo\\"></span><!--teleport anchor--><span>foo2</span><span class=\\"foo2\\"></span><!--teleport anchor-->"'
  254. )
  255. teleportContainer.innerHTML = teleportHtml
  256. document.body.appendChild(teleportContainer)
  257. const { vnode, container } = mountWithHydration(mainHtml, Comp)
  258. expect(vnode.el).toBe(container.firstChild)
  259. const teleportVnode1 = (vnode.children as VNode[])[0]
  260. const teleportVnode2 = (vnode.children as VNode[])[1]
  261. expect(teleportVnode1.el).toBe(container.childNodes[1])
  262. expect(teleportVnode1.anchor).toBe(container.childNodes[2])
  263. expect(teleportVnode2.el).toBe(container.childNodes[3])
  264. expect(teleportVnode2.anchor).toBe(container.childNodes[4])
  265. expect(teleportVnode1.target).toBe(teleportContainer)
  266. expect((teleportVnode1 as any).children[0].el).toBe(
  267. teleportContainer.childNodes[0]
  268. )
  269. expect(teleportVnode1.targetAnchor).toBe(teleportContainer.childNodes[2])
  270. expect(teleportVnode2.target).toBe(teleportContainer)
  271. expect((teleportVnode2 as any).children[0].el).toBe(
  272. teleportContainer.childNodes[3]
  273. )
  274. expect(teleportVnode2.targetAnchor).toBe(teleportContainer.childNodes[5])
  275. // // event handler
  276. triggerEvent('click', teleportContainer.querySelector('.foo')!)
  277. expect(fn1).toHaveBeenCalled()
  278. triggerEvent('click', teleportContainer.querySelector('.foo2')!)
  279. expect(fn2).toHaveBeenCalled()
  280. msg.value = 'bar'
  281. await nextTick()
  282. expect(teleportContainer.innerHTML).toMatchInlineSnapshot(
  283. '"<span>bar</span><span class=\\"bar\\"></span><!--teleport anchor--><span>bar2</span><span class=\\"bar2\\"></span><!--teleport anchor-->"'
  284. )
  285. })
  286. test('Teleport (disabled)', async () => {
  287. const msg = ref('foo')
  288. const fn1 = vi.fn()
  289. const fn2 = vi.fn()
  290. const Comp = () => [
  291. h('div', 'foo'),
  292. h(Teleport, { to: '#teleport3', disabled: true }, [
  293. h('span', msg.value),
  294. h('span', { class: msg.value, onClick: fn1 })
  295. ]),
  296. h('div', { class: msg.value + '2', onClick: fn2 }, 'bar')
  297. ]
  298. const teleportContainer = document.createElement('div')
  299. teleportContainer.id = 'teleport3'
  300. const ctx: SSRContext = {}
  301. const mainHtml = await renderToString(h(Comp), ctx)
  302. expect(mainHtml).toMatchInlineSnapshot(
  303. '"<!--[--><div>foo</div><!--teleport start--><span>foo</span><span class=\\"foo\\"></span><!--teleport end--><div class=\\"foo2\\">bar</div><!--]-->"'
  304. )
  305. const teleportHtml = ctx.teleports!['#teleport3']
  306. expect(teleportHtml).toMatchInlineSnapshot(`"<!--teleport anchor-->"`)
  307. teleportContainer.innerHTML = teleportHtml
  308. document.body.appendChild(teleportContainer)
  309. const { vnode, container } = mountWithHydration(mainHtml, Comp)
  310. expect(vnode.el).toBe(container.firstChild)
  311. const children = vnode.children as VNode[]
  312. expect(children[0].el).toBe(container.childNodes[1])
  313. const teleportVnode = children[1]
  314. expect(teleportVnode.el).toBe(container.childNodes[2])
  315. expect((teleportVnode.children as VNode[])[0].el).toBe(
  316. container.childNodes[3]
  317. )
  318. expect((teleportVnode.children as VNode[])[1].el).toBe(
  319. container.childNodes[4]
  320. )
  321. expect(teleportVnode.anchor).toBe(container.childNodes[5])
  322. expect(children[2].el).toBe(container.childNodes[6])
  323. expect(teleportVnode.target).toBe(teleportContainer)
  324. expect(teleportVnode.targetAnchor).toBe(teleportContainer.childNodes[0])
  325. // // event handler
  326. triggerEvent('click', container.querySelector('.foo')!)
  327. expect(fn1).toHaveBeenCalled()
  328. triggerEvent('click', container.querySelector('.foo2')!)
  329. expect(fn2).toHaveBeenCalled()
  330. msg.value = 'bar'
  331. await nextTick()
  332. expect(container.innerHTML).toMatchInlineSnapshot(
  333. '"<!--[--><div>foo</div><!--teleport start--><span>bar</span><span class=\\"bar\\"></span><!--teleport end--><div class=\\"bar2\\">bar</div><!--]-->"'
  334. )
  335. })
  336. test('Teleport (as component root)', () => {
  337. const teleportContainer = document.createElement('div')
  338. teleportContainer.id = 'teleport4'
  339. teleportContainer.innerHTML = `hello<!--teleport anchor-->`
  340. document.body.appendChild(teleportContainer)
  341. const wrapper = {
  342. render() {
  343. return h(Teleport, { to: '#teleport4' }, ['hello'])
  344. }
  345. }
  346. const { vnode, container } = mountWithHydration(
  347. '<div><!--teleport start--><!--teleport end--><div></div></div>',
  348. () => h('div', [h(wrapper), h('div')])
  349. )
  350. expect(vnode.el).toBe(container.firstChild)
  351. // component el
  352. const wrapperVNode = (vnode as any).children[0]
  353. const tpStart = container.firstChild?.firstChild
  354. const tpEnd = tpStart?.nextSibling
  355. expect(wrapperVNode.el).toBe(tpStart)
  356. expect(wrapperVNode.component.subTree.el).toBe(tpStart)
  357. expect(wrapperVNode.component.subTree.anchor).toBe(tpEnd)
  358. // next node hydrate properly
  359. const nextVNode = (vnode as any).children[1]
  360. expect(nextVNode.el).toBe(container.firstChild?.lastChild)
  361. })
  362. test('Teleport (nested)', () => {
  363. const teleportContainer = document.createElement('div')
  364. teleportContainer.id = 'teleport5'
  365. teleportContainer.innerHTML = `<div><!--teleport start--><!--teleport end--></div><!--teleport anchor--><div>child</div><!--teleport anchor-->`
  366. document.body.appendChild(teleportContainer)
  367. const { vnode, container } = mountWithHydration(
  368. '<!--teleport start--><!--teleport end-->',
  369. () =>
  370. h(Teleport, { to: '#teleport5' }, [
  371. h('div', [h(Teleport, { to: '#teleport5' }, [h('div', 'child')])])
  372. ])
  373. )
  374. expect(vnode.el).toBe(container.firstChild)
  375. expect(vnode.anchor).toBe(container.lastChild)
  376. const childDivVNode = (vnode as any).children[0]
  377. const div = teleportContainer.firstChild
  378. expect(childDivVNode.el).toBe(div)
  379. expect(vnode.targetAnchor).toBe(div?.nextSibling)
  380. const childTeleportVNode = childDivVNode.children[0]
  381. expect(childTeleportVNode.el).toBe(div?.firstChild)
  382. expect(childTeleportVNode.anchor).toBe(div?.lastChild)
  383. expect(childTeleportVNode.targetAnchor).toBe(teleportContainer.lastChild)
  384. expect(childTeleportVNode.children[0].el).toBe(
  385. teleportContainer.lastChild?.previousSibling
  386. )
  387. })
  388. // compile SSR + client render fn from the same template & hydrate
  389. test('full compiler integration', async () => {
  390. const mounted: string[] = []
  391. const log = vi.fn()
  392. const toggle = ref(true)
  393. const Child = {
  394. data() {
  395. return {
  396. count: 0,
  397. text: 'hello',
  398. style: {
  399. color: 'red'
  400. }
  401. }
  402. },
  403. mounted() {
  404. mounted.push('child')
  405. },
  406. template: `
  407. <div>
  408. <span class="count" :style="style">{{ count }}</span>
  409. <button class="inc" @click="count++">inc</button>
  410. <button class="change" @click="style.color = 'green'" >change color</button>
  411. <button class="emit" @click="$emit('foo')">emit</button>
  412. <span class="text">{{ text }}</span>
  413. <input v-model="text">
  414. </div>
  415. `
  416. }
  417. const App = {
  418. setup() {
  419. return { toggle }
  420. },
  421. mounted() {
  422. mounted.push('parent')
  423. },
  424. template: `
  425. <div>
  426. <span>hello</span>
  427. <template v-if="toggle">
  428. <Child @foo="log('child')"/>
  429. <template v-if="true">
  430. <button class="parent-click" @click="log('click')">click me</button>
  431. </template>
  432. </template>
  433. <span>hello</span>
  434. </div>`,
  435. components: {
  436. Child
  437. },
  438. methods: {
  439. log
  440. }
  441. }
  442. const container = document.createElement('div')
  443. // server render
  444. container.innerHTML = await renderToString(h(App))
  445. // hydrate
  446. createSSRApp(App).mount(container)
  447. // assert interactions
  448. // 1. parent button click
  449. triggerEvent('click', container.querySelector('.parent-click')!)
  450. expect(log).toHaveBeenCalledWith('click')
  451. // 2. child inc click + text interpolation
  452. const count = container.querySelector('.count') as HTMLElement
  453. expect(count.textContent).toBe(`0`)
  454. triggerEvent('click', container.querySelector('.inc')!)
  455. await nextTick()
  456. expect(count.textContent).toBe(`1`)
  457. // 3. child color click + style binding
  458. expect(count.style.color).toBe('red')
  459. triggerEvent('click', container.querySelector('.change')!)
  460. await nextTick()
  461. expect(count.style.color).toBe('green')
  462. // 4. child event emit
  463. triggerEvent('click', container.querySelector('.emit')!)
  464. expect(log).toHaveBeenCalledWith('child')
  465. // 5. child v-model
  466. const text = container.querySelector('.text')!
  467. const input = container.querySelector('input')!
  468. expect(text.textContent).toBe('hello')
  469. input.value = 'bye'
  470. triggerEvent('input', input)
  471. await nextTick()
  472. expect(text.textContent).toBe('bye')
  473. })
  474. test('handle click error in ssr mode', async () => {
  475. const App = {
  476. setup() {
  477. const throwError = () => {
  478. throw new Error('Sentry Error')
  479. }
  480. return { throwError }
  481. },
  482. template: `
  483. <div>
  484. <button class="parent-click" @click="throwError">click me</button>
  485. </div>`
  486. }
  487. const container = document.createElement('div')
  488. // server render
  489. container.innerHTML = await renderToString(h(App))
  490. // hydrate
  491. const app = createSSRApp(App)
  492. const handler = (app.config.errorHandler = vi.fn())
  493. app.mount(container)
  494. // assert interactions
  495. // parent button click
  496. triggerEvent('click', container.querySelector('.parent-click')!)
  497. expect(handler).toHaveBeenCalled()
  498. })
  499. test('handle blur error in ssr mode', async () => {
  500. const App = {
  501. setup() {
  502. const throwError = () => {
  503. throw new Error('Sentry Error')
  504. }
  505. return { throwError }
  506. },
  507. template: `
  508. <div>
  509. <input class="parent-click" @blur="throwError"/>
  510. </div>`
  511. }
  512. const container = document.createElement('div')
  513. // server render
  514. container.innerHTML = await renderToString(h(App))
  515. // hydrate
  516. const app = createSSRApp(App)
  517. const handler = (app.config.errorHandler = vi.fn())
  518. app.mount(container)
  519. // assert interactions
  520. // parent blur event
  521. triggerEvent('blur', container.querySelector('.parent-click')!)
  522. expect(handler).toHaveBeenCalled()
  523. })
  524. test('Suspense', async () => {
  525. const AsyncChild = {
  526. async setup() {
  527. const count = ref(0)
  528. return () =>
  529. h(
  530. 'span',
  531. {
  532. onClick: () => {
  533. count.value++
  534. }
  535. },
  536. count.value
  537. )
  538. }
  539. }
  540. const { vnode, container } = mountWithHydration('<span>0</span>', () =>
  541. h(Suspense, () => h(AsyncChild))
  542. )
  543. expect(vnode.el).toBe(container.firstChild)
  544. // wait for hydration to finish
  545. await new Promise(r => setTimeout(r))
  546. triggerEvent('click', container.querySelector('span')!)
  547. await nextTick()
  548. expect(container.innerHTML).toBe(`<span>1</span>`)
  549. })
  550. test('Suspense (full integration)', async () => {
  551. const mountedCalls: number[] = []
  552. const asyncDeps: Promise<any>[] = []
  553. const AsyncChild = defineComponent({
  554. props: ['n'],
  555. async setup(props) {
  556. const count = ref(props.n)
  557. onMounted(() => {
  558. mountedCalls.push(props.n)
  559. })
  560. const p = new Promise(r => setTimeout(r, props.n * 10))
  561. asyncDeps.push(p)
  562. await p
  563. return () =>
  564. h(
  565. 'span',
  566. {
  567. onClick: () => {
  568. count.value++
  569. }
  570. },
  571. count.value
  572. )
  573. }
  574. })
  575. const done = vi.fn()
  576. const App = {
  577. template: `
  578. <Suspense @resolve="done">
  579. <div>
  580. <AsyncChild :n="1" />
  581. <AsyncChild :n="2" />
  582. </div>
  583. </Suspense>`,
  584. components: {
  585. AsyncChild
  586. },
  587. methods: {
  588. done
  589. }
  590. }
  591. const container = document.createElement('div')
  592. // server render
  593. container.innerHTML = await renderToString(h(App))
  594. expect(container.innerHTML).toMatchInlineSnapshot(
  595. `"<div><span>1</span><span>2</span></div>"`
  596. )
  597. // reset asyncDeps from ssr
  598. asyncDeps.length = 0
  599. // hydrate
  600. createSSRApp(App).mount(container)
  601. expect(mountedCalls.length).toBe(0)
  602. expect(asyncDeps.length).toBe(2)
  603. // wait for hydration to complete
  604. await Promise.all(asyncDeps)
  605. await new Promise(r => setTimeout(r))
  606. // should flush buffered effects
  607. expect(mountedCalls).toMatchObject([1, 2])
  608. expect(container.innerHTML).toMatch(
  609. `<div><span>1</span><span>2</span></div>`
  610. )
  611. const span1 = container.querySelector('span')!
  612. triggerEvent('click', span1)
  613. await nextTick()
  614. expect(container.innerHTML).toMatch(
  615. `<div><span>2</span><span>2</span></div>`
  616. )
  617. const span2 = span1.nextSibling as Element
  618. triggerEvent('click', span2)
  619. await nextTick()
  620. expect(container.innerHTML).toMatch(
  621. `<div><span>2</span><span>3</span></div>`
  622. )
  623. })
  624. test('async component', async () => {
  625. const spy = vi.fn()
  626. const Comp = () =>
  627. h(
  628. 'button',
  629. {
  630. onClick: spy
  631. },
  632. 'hello!'
  633. )
  634. let serverResolve: any
  635. let AsyncComp = defineAsyncComponent(
  636. () =>
  637. new Promise(r => {
  638. serverResolve = r
  639. })
  640. )
  641. const App = {
  642. render() {
  643. return ['hello', h(AsyncComp), 'world']
  644. }
  645. }
  646. // server render
  647. const htmlPromise = renderToString(h(App))
  648. serverResolve(Comp)
  649. const html = await htmlPromise
  650. expect(html).toMatchInlineSnapshot(
  651. `"<!--[-->hello<button>hello!</button>world<!--]-->"`
  652. )
  653. // hydration
  654. let clientResolve: any
  655. AsyncComp = defineAsyncComponent(
  656. () =>
  657. new Promise(r => {
  658. clientResolve = r
  659. })
  660. )
  661. const container = document.createElement('div')
  662. container.innerHTML = html
  663. createSSRApp(App).mount(container)
  664. // hydration not complete yet
  665. triggerEvent('click', container.querySelector('button')!)
  666. expect(spy).not.toHaveBeenCalled()
  667. // resolve
  668. clientResolve(Comp)
  669. await new Promise(r => setTimeout(r))
  670. // should be hydrated now
  671. triggerEvent('click', container.querySelector('button')!)
  672. expect(spy).toHaveBeenCalled()
  673. })
  674. test('update async wrapper before resolve', async () => {
  675. const Comp = {
  676. render() {
  677. return h('h1', 'Async component')
  678. }
  679. }
  680. let serverResolve: any
  681. let AsyncComp = defineAsyncComponent(
  682. () =>
  683. new Promise(r => {
  684. serverResolve = r
  685. })
  686. )
  687. const bol = ref(true)
  688. const App = {
  689. setup() {
  690. onMounted(() => {
  691. // change state, this makes updateComponent(AsyncComp) execute before
  692. // the async component is resolved
  693. bol.value = false
  694. })
  695. return () => {
  696. return [bol.value ? 'hello' : 'world', h(AsyncComp)]
  697. }
  698. }
  699. }
  700. // server render
  701. const htmlPromise = renderToString(h(App))
  702. serverResolve(Comp)
  703. const html = await htmlPromise
  704. expect(html).toMatchInlineSnapshot(
  705. `"<!--[-->hello<h1>Async component</h1><!--]-->"`
  706. )
  707. // hydration
  708. let clientResolve: any
  709. AsyncComp = defineAsyncComponent(
  710. () =>
  711. new Promise(r => {
  712. clientResolve = r
  713. })
  714. )
  715. const container = document.createElement('div')
  716. container.innerHTML = html
  717. createSSRApp(App).mount(container)
  718. // resolve
  719. clientResolve(Comp)
  720. await new Promise(r => setTimeout(r))
  721. // should be hydrated now
  722. expect(`Hydration node mismatch`).not.toHaveBeenWarned()
  723. expect(container.innerHTML).toMatchInlineSnapshot(
  724. `"<!--[-->world<h1>Async component</h1><!--]-->"`
  725. )
  726. })
  727. // #3787
  728. test('unmount async wrapper before load', async () => {
  729. let resolve: any
  730. const AsyncComp = defineAsyncComponent(
  731. () =>
  732. new Promise(r => {
  733. resolve = r
  734. })
  735. )
  736. const show = ref(true)
  737. const root = document.createElement('div')
  738. root.innerHTML = '<div><div>async</div></div>'
  739. createSSRApp({
  740. render() {
  741. return h('div', [show.value ? h(AsyncComp) : h('div', 'hi')])
  742. }
  743. }).mount(root)
  744. show.value = false
  745. await nextTick()
  746. expect(root.innerHTML).toBe('<div><div>hi</div></div>')
  747. resolve({})
  748. })
  749. test('unmount async wrapper before load (fragment)', async () => {
  750. let resolve: any
  751. const AsyncComp = defineAsyncComponent(
  752. () =>
  753. new Promise(r => {
  754. resolve = r
  755. })
  756. )
  757. const show = ref(true)
  758. const root = document.createElement('div')
  759. root.innerHTML = '<div><!--[-->async<!--]--></div>'
  760. createSSRApp({
  761. render() {
  762. return h('div', [show.value ? h(AsyncComp) : h('div', 'hi')])
  763. }
  764. }).mount(root)
  765. show.value = false
  766. await nextTick()
  767. expect(root.innerHTML).toBe('<div><div>hi</div></div>')
  768. resolve({})
  769. })
  770. test('elements with camel-case in svg ', () => {
  771. const { vnode, container } = mountWithHydration(
  772. '<animateTransform></animateTransform>',
  773. () => h('animateTransform')
  774. )
  775. expect(vnode.el).toBe(container.firstChild)
  776. expect(`Hydration node mismatch`).not.toHaveBeenWarned()
  777. })
  778. test('SVG as a mount container', () => {
  779. const svgContainer = document.createElement('svg')
  780. svgContainer.innerHTML = '<g></g>'
  781. const app = createSSRApp({
  782. render: () => h('g')
  783. })
  784. expect(
  785. (
  786. app.mount(svgContainer).$.subTree as VNode<Node, Element> & {
  787. el: Element
  788. }
  789. ).el instanceof SVGElement
  790. )
  791. })
  792. test('force hydrate input v-model with non-string value bindings', () => {
  793. const { container } = mountWithHydration(
  794. '<input type="checkbox" value="true">',
  795. () =>
  796. withDirectives(
  797. createVNode(
  798. 'input',
  799. { type: 'checkbox', 'true-value': true },
  800. null,
  801. PatchFlags.PROPS,
  802. ['true-value']
  803. ),
  804. [[vModelCheckbox, true]]
  805. )
  806. )
  807. expect((container.firstChild as any)._trueValue).toBe(true)
  808. })
  809. test('force hydrate select option with non-string value bindings', () => {
  810. const { container } = mountWithHydration(
  811. '<select><option :value="true">ok</option></select>',
  812. () =>
  813. h('select', [
  814. // hoisted because bound value is a constant...
  815. createVNode('option', { value: true }, null, -1 /* HOISTED */)
  816. ])
  817. )
  818. expect((container.firstChild!.firstChild as any)._value).toBe(true)
  819. })
  820. // #5728
  821. test('empty text node in slot', () => {
  822. const Comp = {
  823. render(this: any) {
  824. return renderSlot(this.$slots, 'default', {}, () => [
  825. createTextVNode('')
  826. ])
  827. }
  828. }
  829. const { container, vnode } = mountWithHydration('<!--[--><!--]-->', () =>
  830. h(Comp)
  831. )
  832. expect(container.childNodes.length).toBe(3)
  833. const text = container.childNodes[1]
  834. expect(text.nodeType).toBe(3)
  835. expect(vnode.el).toBe(container.childNodes[0])
  836. // component => slot fragment => text node
  837. expect((vnode as any).component?.subTree.children[0].el).toBe(text)
  838. })
  839. test('app.unmount()', async () => {
  840. const container = document.createElement('DIV')
  841. container.innerHTML = '<button></button>'
  842. const App = defineComponent({
  843. setup(_, { expose }) {
  844. const count = ref(0)
  845. expose({ count })
  846. return () =>
  847. h('button', {
  848. onClick: () => count.value++
  849. })
  850. }
  851. })
  852. const app = createSSRApp(App)
  853. const vm = app.mount(container)
  854. await nextTick()
  855. expect((container as any)._vnode).toBeDefined()
  856. // @ts-expect-error - expose()'d properties are not available on vm type
  857. expect(vm.count).toBe(0)
  858. app.unmount()
  859. expect((container as any)._vnode).toBe(null)
  860. })
  861. // #6637
  862. test('stringified root fragment', () => {
  863. mountWithHydration(`<!--[--><div></div><!--]-->`, () =>
  864. createStaticVNode(`<div></div>`, 1)
  865. )
  866. expect(`mismatch`).not.toHaveBeenWarned()
  867. })
  868. describe('mismatch handling', () => {
  869. test('text node', () => {
  870. const { container } = mountWithHydration(`foo`, () => 'bar')
  871. expect(container.textContent).toBe('bar')
  872. expect(`Hydration text mismatch`).toHaveBeenWarned()
  873. })
  874. test('element text content', () => {
  875. const { container } = mountWithHydration(`<div>foo</div>`, () =>
  876. h('div', 'bar')
  877. )
  878. expect(container.innerHTML).toBe('<div>bar</div>')
  879. expect(`Hydration text content mismatch in <div>`).toHaveBeenWarned()
  880. })
  881. test('not enough children', () => {
  882. const { container } = mountWithHydration(`<div></div>`, () =>
  883. h('div', [h('span', 'foo'), h('span', 'bar')])
  884. )
  885. expect(container.innerHTML).toBe(
  886. '<div><span>foo</span><span>bar</span></div>'
  887. )
  888. expect(`Hydration children mismatch in <div>`).toHaveBeenWarned()
  889. })
  890. test('too many children', () => {
  891. const { container } = mountWithHydration(
  892. `<div><span>foo</span><span>bar</span></div>`,
  893. () => h('div', [h('span', 'foo')])
  894. )
  895. expect(container.innerHTML).toBe('<div><span>foo</span></div>')
  896. expect(`Hydration children mismatch in <div>`).toHaveBeenWarned()
  897. })
  898. test('complete mismatch', () => {
  899. const { container } = mountWithHydration(
  900. `<div><span>foo</span><span>bar</span></div>`,
  901. () => h('div', [h('div', 'foo'), h('p', 'bar')])
  902. )
  903. expect(container.innerHTML).toBe('<div><div>foo</div><p>bar</p></div>')
  904. expect(`Hydration node mismatch`).toHaveBeenWarnedTimes(2)
  905. })
  906. test('fragment mismatch removal', () => {
  907. const { container } = mountWithHydration(
  908. `<div><!--[--><div>foo</div><div>bar</div><!--]--></div>`,
  909. () => h('div', [h('span', 'replaced')])
  910. )
  911. expect(container.innerHTML).toBe('<div><span>replaced</span></div>')
  912. expect(`Hydration node mismatch`).toHaveBeenWarned()
  913. })
  914. test('fragment not enough children', () => {
  915. const { container } = mountWithHydration(
  916. `<div><!--[--><div>foo</div><!--]--><div>baz</div></div>`,
  917. () => h('div', [[h('div', 'foo'), h('div', 'bar')], h('div', 'baz')])
  918. )
  919. expect(container.innerHTML).toBe(
  920. '<div><!--[--><div>foo</div><div>bar</div><!--]--><div>baz</div></div>'
  921. )
  922. expect(`Hydration node mismatch`).toHaveBeenWarned()
  923. })
  924. test('fragment too many children', () => {
  925. const { container } = mountWithHydration(
  926. `<div><!--[--><div>foo</div><div>bar</div><!--]--><div>baz</div></div>`,
  927. () => h('div', [[h('div', 'foo')], h('div', 'baz')])
  928. )
  929. expect(container.innerHTML).toBe(
  930. '<div><!--[--><div>foo</div><!--]--><div>baz</div></div>'
  931. )
  932. // fragment ends early and attempts to hydrate the extra <div>bar</div>
  933. // as 2nd fragment child.
  934. expect(`Hydration text content mismatch`).toHaveBeenWarned()
  935. // excessive children removal
  936. expect(`Hydration children mismatch`).toHaveBeenWarned()
  937. })
  938. test('Teleport target has empty children', () => {
  939. const teleportContainer = document.createElement('div')
  940. teleportContainer.id = 'teleport'
  941. document.body.appendChild(teleportContainer)
  942. mountWithHydration('<!--teleport start--><!--teleport end-->', () =>
  943. h(Teleport, { to: '#teleport' }, [h('span', 'value')])
  944. )
  945. expect(teleportContainer.innerHTML).toBe(`<span>value</span>`)
  946. expect(`Hydration children mismatch`).toHaveBeenWarned()
  947. })
  948. })
  949. })