hydration.spec.ts 36 KB

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