ssr-template.spec.js 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367
  1. import webpack from 'webpack'
  2. import Vue from '../../dist/vue.runtime.common.js'
  3. import { compileWithWebpack } from './compile-with-webpack'
  4. import { createRenderer } from '../../packages/vue-server-renderer'
  5. import VueSSRClientPlugin from '../../packages/vue-server-renderer/client-plugin'
  6. import { createRenderer as createBundleRenderer } from './ssr-bundle-render.spec.js'
  7. const defaultTemplate = `<html><head></head><body><!--vue-ssr-outlet--></body></html>`
  8. const interpolateTemplate = `<html><head><title>{{ title }}</title></head><body><!--vue-ssr-outlet-->{{{ snippet }}}</body></html>`
  9. function generateClientManifest (file, cb) {
  10. compileWithWebpack(file, {
  11. output: {
  12. path: '/',
  13. filename: '[name].js'
  14. },
  15. plugins: [
  16. new webpack.optimize.CommonsChunkPlugin({
  17. name: 'manifest',
  18. minChunks: Infinity
  19. }),
  20. new VueSSRClientPlugin()
  21. ]
  22. }, fs => {
  23. cb(JSON.parse(fs.readFileSync('/vue-ssr-client-manifest.json', 'utf-8')))
  24. })
  25. }
  26. function createRendererWithManifest (file, options, cb) {
  27. if (typeof options === 'function') {
  28. cb = options
  29. options = null
  30. }
  31. generateClientManifest(file, clientManifest => {
  32. createBundleRenderer(file, Object.assign({
  33. asBundle: true,
  34. template: defaultTemplate,
  35. clientManifest
  36. }, options), cb)
  37. })
  38. }
  39. describe('SSR: template option', () => {
  40. it('renderToString', done => {
  41. const renderer = createRenderer({
  42. template: defaultTemplate
  43. })
  44. const context = {
  45. head: '<meta name="viewport" content="width=device-width">',
  46. styles: '<style>h1 { color: red }</style>',
  47. state: { a: 1 }
  48. }
  49. renderer.renderToString(new Vue({
  50. template: '<div>hi</div>'
  51. }), context, (err, res) => {
  52. expect(err).toBeNull()
  53. expect(res).toContain(
  54. `<html><head>${context.head}${context.styles}</head><body>` +
  55. `<div data-server-rendered="true">hi</div>` +
  56. `<script>window.__INITIAL_STATE__={"a":1}</script>` +
  57. `</body></html>`
  58. )
  59. done()
  60. })
  61. })
  62. it('renderToString with interpolation', done => {
  63. const renderer = createRenderer({
  64. template: interpolateTemplate
  65. })
  66. const context = {
  67. title: '<script>hacks</script>',
  68. snippet: '<div>foo</div>',
  69. head: '<meta name="viewport" content="width=device-width">',
  70. styles: '<style>h1 { color: red }</style>',
  71. state: { a: 1 }
  72. }
  73. renderer.renderToString(new Vue({
  74. template: '<div>hi</div>'
  75. }), context, (err, res) => {
  76. expect(err).toBeNull()
  77. expect(res).toContain(
  78. `<html><head>` +
  79. // double mustache should be escaped
  80. `<title>&lt;script&gt;hacks&lt;/script&gt;</title>` +
  81. `${context.head}${context.styles}</head><body>` +
  82. `<div data-server-rendered="true">hi</div>` +
  83. `<script>window.__INITIAL_STATE__={"a":1}</script>` +
  84. // triple should be raw
  85. `<div>foo</div>` +
  86. `</body></html>`
  87. )
  88. done()
  89. })
  90. })
  91. it('renderToStream', done => {
  92. const renderer = createRenderer({
  93. template: defaultTemplate
  94. })
  95. const context = {
  96. head: '<meta name="viewport" content="width=device-width">',
  97. styles: '<style>h1 { color: red }</style>',
  98. state: { a: 1 }
  99. }
  100. const stream = renderer.renderToStream(new Vue({
  101. template: '<div>hi</div>'
  102. }), context)
  103. let res = ''
  104. stream.on('data', chunk => {
  105. res += chunk
  106. })
  107. stream.on('end', () => {
  108. expect(res).toContain(
  109. `<html><head>${context.head}${context.styles}</head><body>` +
  110. `<div data-server-rendered="true">hi</div>` +
  111. `<script>window.__INITIAL_STATE__={"a":1}</script>` +
  112. `</body></html>`
  113. )
  114. done()
  115. })
  116. })
  117. it('renderToStream with interpolation', done => {
  118. const renderer = createRenderer({
  119. template: interpolateTemplate
  120. })
  121. const context = {
  122. title: '<script>hacks</script>',
  123. snippet: '<div>foo</div>',
  124. head: '<meta name="viewport" content="width=device-width">',
  125. styles: '<style>h1 { color: red }</style>',
  126. state: { a: 1 }
  127. }
  128. const stream = renderer.renderToStream(new Vue({
  129. template: '<div>hi</div>'
  130. }), context)
  131. let res = ''
  132. stream.on('data', chunk => {
  133. res += chunk
  134. })
  135. stream.on('end', () => {
  136. expect(res).toContain(
  137. `<html><head>` +
  138. // double mustache should be escaped
  139. `<title>&lt;script&gt;hacks&lt;/script&gt;</title>` +
  140. `${context.head}${context.styles}</head><body>` +
  141. `<div data-server-rendered="true">hi</div>` +
  142. `<script>window.__INITIAL_STATE__={"a":1}</script>` +
  143. // triple should be raw
  144. `<div>foo</div>` +
  145. `</body></html>`
  146. )
  147. done()
  148. })
  149. })
  150. it('bundleRenderer + renderToString', done => {
  151. createBundleRenderer('app.js', {
  152. asBundle: true,
  153. template: defaultTemplate
  154. }, renderer => {
  155. const context = {
  156. head: '<meta name="viewport" content="width=device-width">',
  157. styles: '<style>h1 { color: red }</style>',
  158. state: { a: 1 },
  159. url: '/test'
  160. }
  161. renderer.renderToString(context, (err, res) => {
  162. expect(err).toBeNull()
  163. expect(res).toContain(
  164. `<html><head>${context.head}${context.styles}</head><body>` +
  165. `<div data-server-rendered="true">/test</div>` +
  166. `<script>window.__INITIAL_STATE__={"a":1}</script>` +
  167. `</body></html>`
  168. )
  169. expect(context.msg).toBe('hello')
  170. done()
  171. })
  172. })
  173. })
  174. it('bundleRenderer + renderToStream', done => {
  175. createBundleRenderer('app.js', {
  176. asBundle: true,
  177. template: defaultTemplate
  178. }, renderer => {
  179. const context = {
  180. head: '<meta name="viewport" content="width=device-width">',
  181. styles: '<style>h1 { color: red }</style>',
  182. state: { a: 1 },
  183. url: '/test'
  184. }
  185. const stream = renderer.renderToStream(context)
  186. let res = ''
  187. stream.on('data', chunk => {
  188. res += chunk.toString()
  189. })
  190. stream.on('end', () => {
  191. expect(res).toContain(
  192. `<html><head>${context.head}${context.styles}</head><body>` +
  193. `<div data-server-rendered="true">/test</div>` +
  194. `<script>window.__INITIAL_STATE__={"a":1}</script>` +
  195. `</body></html>`
  196. )
  197. expect(context.msg).toBe('hello')
  198. done()
  199. })
  200. })
  201. })
  202. const expectedHTMLWithManifest = (options = {}) =>
  203. `<html><head>` +
  204. // used chunks should have preload
  205. `<link rel="preload" href="/manifest.js" as="script">` +
  206. `<link rel="preload" href="/main.js" as="script">` +
  207. `<link rel="preload" href="/0.js" as="script">` +
  208. `<link rel="preload" href="/test.css" as="style">` +
  209. // images and fonts are only preloaded when explicitly asked for
  210. (options.preloadOtherAssets ? `<link rel="preload" href="/test.png" as="image">` : ``) +
  211. (options.preloadOtherAssets ? `<link rel="preload" href="/test.woff2" as="font" type="font/woff2" crossorigin>` : ``) +
  212. // unused chunks should have prefetch
  213. `<link rel="prefetch" href="/1.js">` +
  214. // css assets should be loaded
  215. `<link rel="stylesheet" href="/test.css">` +
  216. `</head><body>` +
  217. `<div data-server-rendered="true"><div>async test.woff2 test.png</div></div>` +
  218. // state should be inlined before scripts
  219. `<script>window.${options.stateKey || '__INITIAL_STATE__'}={"a":1}</script>` +
  220. // manifest chunk should be first
  221. `<script src="/manifest.js" defer></script>` +
  222. // async chunks should be before main chunk
  223. `<script src="/0.js" defer></script>` +
  224. `<script src="/main.js" defer></script>` +
  225. `</body></html>`
  226. createClientManifestAssertions(true)
  227. createClientManifestAssertions(false)
  228. function createClientManifestAssertions (runInNewContext) {
  229. it('bundleRenderer + renderToString + clientManifest ()', done => {
  230. createRendererWithManifest('split.js', { runInNewContext }, renderer => {
  231. renderer.renderToString({ state: { a: 1 }}, (err, res) => {
  232. expect(err).toBeNull()
  233. expect(res).toContain(expectedHTMLWithManifest())
  234. done()
  235. })
  236. })
  237. })
  238. it('bundleRenderer + renderToStream + clientManifest + shouldPreload', done => {
  239. createRendererWithManifest('split.js', {
  240. runInNewContext,
  241. shouldPreload: (file, type) => {
  242. if (type === 'image' || type === 'script' || type === 'font' || type === 'style') {
  243. return true
  244. }
  245. }
  246. }, renderer => {
  247. const stream = renderer.renderToStream({ state: { a: 1 }})
  248. let res = ''
  249. stream.on('data', chunk => {
  250. res += chunk.toString()
  251. })
  252. stream.on('end', () => {
  253. expect(res).toContain(expectedHTMLWithManifest({
  254. preloadOtherAssets: true
  255. }))
  256. done()
  257. })
  258. })
  259. })
  260. it('bundleRenderer + renderToString + clientManifest + inject: false', done => {
  261. createRendererWithManifest('split.js', {
  262. runInNewContext,
  263. template: `<html>` +
  264. `<head>{{{ renderResourceHints() }}}{{{ renderStyles() }}}</head>` +
  265. `<body><!--vue-ssr-outlet-->{{{ renderState({ windowKey: '__FOO__', contextKey: 'foo' }) }}}{{{ renderScripts() }}}</body>` +
  266. `</html>`,
  267. inject: false
  268. }, renderer => {
  269. const context = { foo: { a: 1 }}
  270. renderer.renderToString(context, (err, res) => {
  271. expect(err).toBeNull()
  272. expect(res).toContain(expectedHTMLWithManifest({
  273. stateKey: '__FOO__'
  274. }))
  275. done()
  276. })
  277. })
  278. })
  279. it('bundleRenderer + renderToString + clientManifest + no template', done => {
  280. createRendererWithManifest('split.js', {
  281. runInNewContext,
  282. template: null
  283. }, renderer => {
  284. const context = { foo: { a: 1 }}
  285. renderer.renderToString(context, (err, res) => {
  286. expect(err).toBeNull()
  287. const customOutput =
  288. `<html><head>${
  289. context.renderResourceHints() +
  290. context.renderStyles()
  291. }</head><body>${
  292. res +
  293. context.renderState({
  294. windowKey: '__FOO__',
  295. contextKey: 'foo'
  296. }) +
  297. context.renderScripts()
  298. }</body></html>`
  299. expect(customOutput).toContain(expectedHTMLWithManifest({
  300. stateKey: '__FOO__'
  301. }))
  302. done()
  303. })
  304. })
  305. })
  306. it('whitespace insensitive interpolation', done => {
  307. const interpolateTemplate = `<html><head><title>{{title}}</title></head><body><!--vue-ssr-outlet-->{{{snippet}}}</body></html>`
  308. const renderer = createRenderer({
  309. template: interpolateTemplate
  310. })
  311. const context = {
  312. title: '<script>hacks</script>',
  313. snippet: '<div>foo</div>',
  314. head: '<meta name="viewport" content="width=device-width">',
  315. styles: '<style>h1 { color: red }</style>',
  316. state: { a: 1 }
  317. }
  318. renderer.renderToString(new Vue({
  319. template: '<div>hi</div>'
  320. }), context, (err, res) => {
  321. expect(err).toBeNull()
  322. expect(res).toContain(
  323. `<html><head>` +
  324. // double mustache should be escaped
  325. `<title>&lt;script&gt;hacks&lt;/script&gt;</title>` +
  326. `${context.head}${context.styles}</head><body>` +
  327. `<div data-server-rendered="true">hi</div>` +
  328. `<script>window.__INITIAL_STATE__={"a":1}</script>` +
  329. // triple should be raw
  330. `<div>foo</div>` +
  331. `</body></html>`
  332. )
  333. done()
  334. })
  335. })
  336. }
  337. })