Nuxt/lib/core/renderer.js

418 lines
12 KiB
JavaScript
Raw Normal View History

2017-06-19 16:09:01 +00:00
import ansiHTML from 'ansi-html'
import serialize from 'serialize-javascript'
import generateETag from 'etag'
import fresh from 'fresh'
import Tapable from 'tappable'
import pify from 'pify'
import serveStatic from 'serve-static'
import compression from 'compression'
import _ from 'lodash'
import { join, resolve } from 'path'
import fs from 'fs-extra'
import { createBundleRenderer } from 'vue-server-renderer'
import { encodeHtml, getContext, setAnsiColors, isUrl } from 'utils'
import { defaultOptions } from './options'
2017-06-19 16:09:01 +00:00
import Debug from 'debug'
2017-06-19 23:15:57 +00:00
import connect from 'connect'
2017-06-11 14:17:36 +00:00
2017-06-18 09:35:00 +00:00
const debug = Debug('nuxt:render')
2017-06-11 14:17:36 +00:00
debug.color = 4 // Force blue color
2017-06-18 09:35:00 +00:00
2017-06-11 14:17:36 +00:00
setAnsiColors(ansiHTML)
let jsdom = null
export default class Renderer extends Tapable {
constructor (nuxt) {
super()
this.nuxt = nuxt
this.options = nuxt.options
2017-06-14 16:33:04 +00:00
// Will be set by createRenderer
this.bundleRenderer = null
// Will be available on dev
this.webpackDevMiddleware = null
this.webpackHotMiddleware = null
2017-06-19 23:15:57 +00:00
// Create new connect instance
this.app = connect()
// Renderer runtime resources
this.resources = {
clientManifest: null,
serverBundle: null,
appTemplate: null,
errorTemplate: parseTemplate('<pre>{{ stack }}</pre>') // Will be loaded on ready
}
// Bind middleware to this context
this.nuxtMiddleware = this.nuxtMiddleware.bind(this)
this.errorMiddleware = this.errorMiddleware.bind(this)
2017-06-15 22:19:53 +00:00
// Initialize
2017-06-19 15:47:31 +00:00
/* istanbul ignore if */
if (nuxt.initialized) {
// If nuxt already initialized
2017-06-15 14:59:26 +00:00
this._ready = this.ready().catch(this.nuxt.errorHandler)
} else {
// Wait for hook
2017-06-14 18:51:14 +00:00
this.nuxt.plugin('afterInit', () => {
2017-06-15 14:59:26 +00:00
this._ready = this.ready()
return this._ready
2017-06-14 16:33:04 +00:00
})
}
}
2017-06-15 14:59:26 +00:00
async ready () {
2017-06-19 15:47:31 +00:00
/* istanbul ignore if */
2017-06-15 14:59:26 +00:00
if (this._ready) {
return this._ready
}
2017-06-19 23:15:57 +00:00
// Setup all middleWare
this.setupMiddleware()
2017-06-19 23:15:57 +00:00
// Load error template
2017-06-16 12:42:45 +00:00
const errorTemplatePath = resolve(this.options.buildDir, 'views/error.html')
if (fs.existsSync(errorTemplatePath)) {
this.resources.errorTemplate = parseTemplate(fs.readFileSync(errorTemplatePath, 'utf8'))
}
2017-06-19 23:15:57 +00:00
// Load SSR resources from fs
2017-06-15 14:53:00 +00:00
if (!this.options.dev) {
2017-06-15 22:19:53 +00:00
await this.loadResources()
2017-06-15 14:53:00 +00:00
}
2017-06-15 22:19:53 +00:00
return this
}
async loadResources (_fs = fs) {
2017-06-15 22:19:53 +00:00
let distPath = resolve(this.options.buildDir, 'dist')
2017-06-15 14:53:00 +00:00
let updated = []
resourceMap.forEach(({ key, fileName, transform }) => {
let rawKey = '$$' + key
const path = join(distPath, fileName)
2017-06-15 14:53:00 +00:00
let rawData, data
if (!_fs.existsSync(path)) {
return // Resource not exists
}
2017-06-15 14:53:00 +00:00
rawData = _fs.readFileSync(path, 'utf8')
if (!rawData || rawData === this.resources[rawKey]) {
return // No changes
}
2017-06-15 14:53:00 +00:00
this.resources[rawKey] = rawData
data = transform(rawData)
2017-06-19 15:47:31 +00:00
/* istanbul ignore if */
2017-06-15 14:53:00 +00:00
if (!data) {
return // Invalid data ?
}
this.resources[key] = data
updated.push(key)
})
2017-06-15 14:53:00 +00:00
if (updated.length > 0) {
2017-06-15 22:19:53 +00:00
// debug('Updated', updated.join(', '), isServer)
2017-06-15 14:53:00 +00:00
this.createRenderer()
}
}
createRenderer () {
// If resources are not yet provided
if (!this.resources.serverBundle || !this.resources.clientManifest) {
return
}
// Create bundle renderer for SSR
this.bundleRenderer = createBundleRenderer(this.resources.serverBundle, Object.assign({
clientManifest: this.resources.clientManifest,
runInNewContext: false,
basedir: this.options.rootDir
2017-06-19 21:03:55 +00:00
}, this.options.render.ssr, this.options.build.ssr))
2017-06-20 13:12:33 +00:00
/* istanbul ignore if */
if (this.options.build.ssr) {
2017-06-19 23:23:57 +00:00
// eslint-disable-next-line no-console
2017-06-20 18:19:31 +00:00
console.warn('[nuxt] `build.ssr` is deprecated and will be removed in 1.0 release, please use `render.ssr` instead!')
2017-06-19 21:03:55 +00:00
}
// Promisify renderToString
this.bundleRenderer.renderToString = pify(this.bundleRenderer.renderToString)
2017-06-11 14:17:36 +00:00
}
2017-06-19 23:15:57 +00:00
useMiddleware (m) {
// Resolve
if (typeof m === 'string') {
m = require(this.nuxt.resolvePath(m))
2017-06-19 23:15:57 +00:00
}
// Use middleware
if (m instanceof Function) {
this.app.use(m)
} else if (m && m.path && m.handler) {
this.app.use(m.path, m.handler)
}
}
setupMiddleware () {
2017-06-20 13:32:02 +00:00
// Apply setupMiddleware from modules first
this.applyPlugins('setupMiddleware', this.app)
2017-06-19 23:15:57 +00:00
// Gzip middleware for production
if (!this.options.dev && this.options.render.gzip) {
this.useMiddleware(compression(this.options.render.gzip))
}
// Common URL checks
this.useMiddleware((req, res, next) => {
2017-06-11 14:17:36 +00:00
// If base in req.url, remove it for the middleware and vue-router
if (this.options.router.base !== '/' && req.url.indexOf(this.options.router.base) === 0) {
req.url = req.url.replace(this.options.router.base, '/')
}
// Prevent access to SSR resources
2017-06-19 23:15:57 +00:00
if (ssrResourceRegex.test(req.url)) {
res.statusCode = 404
return res.end()
2017-06-15 23:00:53 +00:00
}
2017-06-19 23:15:57 +00:00
next()
})
2017-06-15 23:00:53 +00:00
2017-06-19 23:15:57 +00:00
// Add webpack middleware only for development
if (this.options.dev) {
this.useMiddleware(async (req, res, next) => {
if (req.url.includes('.hot-update.json')) {
res.statusCode = 404
return res.end()
}
if (this.webpackDevMiddleware) {
await this.webpackDevMiddleware(req, res)
}
if (this.webpackHotMiddleware) {
await this.webpackHotMiddleware(req, res)
}
next()
})
}
2017-06-19 23:15:57 +00:00
// For serving static/ files to /
this.useMiddleware(serveStatic(resolve(this.options.srcDir, 'static'), this.options.render.static))
// Serve .nuxt/dist/ files only for production
// For dev they will be served with devMiddleware
if (!this.options.dev) {
const distDir = resolve(this.options.buildDir, 'dist')
this.useMiddleware({
path: isUrl(this.options.build.publicPath) ? defaultOptions.build.publicPath : this.options.build.publicPath,
handler: serveStatic(distDir, {
index: false, // Don't serve index.html template
maxAge: (this.options.dev ? 0 : '1y') // 1 year in production
})
})
2017-06-19 23:15:57 +00:00
}
2017-06-20 13:32:02 +00:00
// Add User provided middleware
this.options.serverMiddleware.forEach(m => {
this.useMiddleware(m)
})
2017-06-19 23:15:57 +00:00
// Finally use nuxtMiddleware
this.useMiddleware(this.nuxtMiddleware)
// Error middleware for errors that occurred in middleware that declared above
this.useMiddleware(this.errorMiddleware)
2017-06-19 23:15:57 +00:00
}
async nuxtMiddleware (req, res, next) {
2017-06-19 23:15:57 +00:00
// Get context
const context = getContext(req, res)
res.statusCode = 200
try {
const { html, error, redirected, resourceHints } = await this.renderRoute(req.url, context)
2017-06-11 14:17:36 +00:00
if (redirected) {
return html
}
if (error) {
res.statusCode = context.nuxt.error.statusCode || 500
}
2017-06-19 23:15:57 +00:00
// Add ETag header
2017-06-11 14:17:36 +00:00
if (!error && this.options.render.etag) {
const etag = generateETag(html, this.options.render.etag)
if (fresh(req.headers, { etag })) {
res.statusCode = 304
res.end()
return
}
res.setHeader('ETag', etag)
}
2017-06-11 14:17:36 +00:00
// HTTP2 push headers
if (!error && this.options.render.http2.push) {
// Parse resourceHints to extract HTTP.2 prefetch/push headers
// https://w3c.github.io/preload/#server-push-http-2
const regex = /link rel="([^"]*)" href="([^"]*)" as="([^"]*)"/g
const pushAssets = []
let m
while (m = regex.exec(resourceHints)) { // eslint-disable-line no-cond-assign
const [_, rel, href, as] = m // eslint-disable-line no-unused-vars
if (rel === 'preload') {
pushAssets.push(`<${href}>; rel=${rel}; as=${as}`)
}
}
// Pass with single Link header
// https://blog.cloudflare.com/http-2-server-push-with-multiple-assets-per-link-header
res.setHeader('Link', pushAssets.join(','))
}
// Send response
2017-06-11 14:17:36 +00:00
res.setHeader('Content-Type', 'text/html; charset=utf-8')
res.setHeader('Content-Length', Buffer.byteLength(html))
res.end(html, 'utf8')
return html
} catch (err) {
next(this.errorMiddleware(err, req, res, next, context))
}
}
async errorMiddleware (err, req, res, next, context) {
/* istanbul ignore if */
if (context && context.redirected) {
console.error(err) // eslint-disable-line no-console
2017-06-11 14:17:36 +00:00
return err
}
// Render error template
const html = this.resources.errorTemplate({
error: err,
stack: ansiHTML(encodeHtml(err.stack))
})
// Send response
res.statusCode = 500
res.setHeader('Content-Type', 'text/html; charset=utf-8')
res.setHeader('Content-Length', Buffer.byteLength(html))
res.end(html, 'utf8')
return err
2017-06-11 14:17:36 +00:00
}
2017-06-14 17:42:20 +00:00
async renderRoute (url, context = {}) {
/* istanbul ignore if */
if (!this.bundleRenderer || !this.resources.appTemplate) {
2017-06-15 14:53:00 +00:00
return new Promise(resolve => {
setTimeout(() => resolve(this.renderRoute(url, context)), 1000)
})
}
2017-06-11 14:17:36 +00:00
// Log rendered url
debug(`Rendering url ${url}`)
2017-06-11 14:17:36 +00:00
// Add url and isSever to the context
context.url = url
context.isServer = true
2017-06-11 14:17:36 +00:00
// Call renderToString from the bundleRenderer and generate the HTML (will update the context as well)
let APP = await this.bundleRenderer.renderToString(context)
2017-06-11 14:17:36 +00:00
if (!context.nuxt.serverRendered) {
APP = '<div id="__nuxt"></div>'
}
const m = context.meta.inject()
let HEAD = m.meta.text() + m.title.text() + m.link.text() + m.style.text() + m.script.text() + m.noscript.text()
if (this.options._routerBaseSpecified) {
2017-06-11 14:17:36 +00:00
HEAD += `<base href="${this.options.router.base}">`
}
2017-06-20 12:48:25 +00:00
let resourceHints = ''
if (this.options.render.resourceHints) {
resourceHints = context.renderResourceHints()
HEAD += resourceHints
}
HEAD += context.renderStyles()
2017-06-11 14:17:36 +00:00
APP += `<script type="text/javascript">window.__NUXT__=${serialize(context.nuxt, { isJSON: true })}</script>`
APP += context.renderScripts()
const html = this.resources.appTemplate({
2017-06-11 14:17:36 +00:00
HTML_ATTRS: 'data-n-head-ssr ' + m.htmlAttrs.text(),
BODY_ATTRS: m.bodyAttrs.text(),
HEAD,
APP
})
2017-06-11 14:17:36 +00:00
return {
html,
resourceHints,
error: context.nuxt.error,
redirected: context.redirected
}
}
async renderAndGetWindow (url, opts = {}) {
/* istanbul ignore if */
if (!jsdom) {
try {
jsdom = require('jsdom')
} catch (e) /* istanbul ignore next */ {
2017-06-11 14:17:36 +00:00
console.error('Fail when calling nuxt.renderAndGetWindow(url)') // eslint-disable-line no-console
console.error('jsdom module is not installed') // eslint-disable-line no-console
console.error('Please install jsdom with: npm install --save-dev jsdom') // eslint-disable-line no-console
2017-06-13 22:09:03 +00:00
throw e
2017-06-11 14:17:36 +00:00
}
}
let options = {
resources: 'usable', // load subresources (https://github.com/tmpvar/jsdom#loading-subresources)
runScripts: 'dangerously',
beforeParse (window) {
// Mock window.scrollTo
window.scrollTo = () => {
}
}
}
if (opts.virtualConsole !== false) {
options.virtualConsole = new jsdom.VirtualConsole().sendTo(console)
}
url = url || 'http://localhost:3000'
const { window } = await jsdom.JSDOM.fromURL(url, options)
// If Nuxt could not be loaded (error from the server-side)
const nuxtExists = window.document.body.innerHTML.includes('window.__NUXT__')
2017-06-19 15:47:31 +00:00
/* istanbul ignore if */
2017-06-11 14:17:36 +00:00
if (!nuxtExists) {
let error = new Error('Could not load the nuxt app')
error.body = window.document.body.innerHTML
throw error
}
// Used by nuxt.js to say when the components are loaded and the app ready
await new Promise((resolve) => {
window._onNuxtLoaded = () => resolve(window)
})
// Send back window object
return window
}
}
2017-06-20 11:44:47 +00:00
const parseTemplate = templateStr => _.template(templateStr, {
interpolate: /{{([\s\S]+?)}}/g
})
const resourceMap = [
{
key: 'clientManifest',
fileName: 'vue-ssr-client-manifest.json',
transform: JSON.parse
},
{
key: 'serverBundle',
fileName: 'server-bundle.json',
transform: JSON.parse
},
{
key: 'appTemplate',
fileName: 'index.html',
transform: parseTemplate
}
]
// Protector utility against request to SSR bundle files
const ssrResourceRegex = new RegExp(resourceMap.map(resource => resource.fileName).join('|'), 'i')