hydration.spec.ts 27 KB

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