Unverified Commit 9acd001e authored by Joe Haddad's avatar Joe Haddad Committed by GitHub

Fix render cancel behavior (#16462)

This pull request correctly tracks render cancelation behavior. Prior to this PR, we'd have an unhandled rejection that left the app in a bad state and no routeChangeError event was fired.

---

Closes #16424
Fixes #16445
parent 8a1c9937
...@@ -348,6 +348,11 @@ export async function render(renderingProps: RenderRouteInfo) { ...@@ -348,6 +348,11 @@ export async function render(renderingProps: RenderRouteInfo) {
try { try {
await doRender(renderingProps) await doRender(renderingProps)
} catch (renderErr) { } catch (renderErr) {
// bubble up cancelation errors
if (renderErr.cancelled) {
throw renderErr
}
if (process.env.NODE_ENV === 'development') { if (process.env.NODE_ENV === 'development') {
// Ensure this error is displayed in the overlay in development // Ensure this error is displayed in the overlay in development
setTimeout(() => { setTimeout(() => {
...@@ -550,13 +555,13 @@ const wrapApp = (App: AppComponent) => ( ...@@ -550,13 +555,13 @@ const wrapApp = (App: AppComponent) => (
) )
} }
async function doRender({ function doRender({
App, App,
Component, Component,
props, props,
err, err,
styleSheets, styleSheets,
}: RenderRouteInfo) { }: RenderRouteInfo): Promise<any> {
Component = Component || lastAppProps.Component Component = Component || lastAppProps.Component
props = props || lastAppProps.props props = props || lastAppProps.props
...@@ -570,6 +575,7 @@ async function doRender({ ...@@ -570,6 +575,7 @@ async function doRender({
lastAppProps = appProps lastAppProps = appProps
let resolvePromise: () => void let resolvePromise: () => void
let renderPromiseReject: () => void
const renderPromise = new Promise((resolve, reject) => { const renderPromise = new Promise((resolve, reject) => {
if (lastRenderReject) { if (lastRenderReject) {
lastRenderReject() lastRenderReject()
...@@ -578,9 +584,12 @@ async function doRender({ ...@@ -578,9 +584,12 @@ async function doRender({
lastRenderReject = null lastRenderReject = null
resolve() resolve()
} }
lastRenderReject = () => { renderPromiseReject = lastRenderReject = () => {
lastRenderReject = null lastRenderReject = null
reject()
const error: any = new Error('Cancel rendering route')
error.cancelled = true
reject(error)
} }
}) })
...@@ -601,6 +610,13 @@ async function doRender({ ...@@ -601,6 +610,13 @@ async function doRender({
return Promise.resolve([]) return Promise.resolve([])
} }
// Clean up previous render if canceling:
;([].slice.call(
document.querySelectorAll('link[data-n-staging]')
) as HTMLLinkElement[]).forEach((el) => {
el.parentNode!.removeChild(el)
})
let referenceNode: HTMLLinkElement | undefined = ([].slice.call( let referenceNode: HTMLLinkElement | undefined = ([].slice.call(
document.querySelectorAll('link[data-n-g], link[data-n-p]') document.querySelectorAll('link[data-n-g], link[data-n-p]')
) as HTMLLinkElement[]).pop() ) as HTMLLinkElement[]).pop()
...@@ -644,18 +660,6 @@ async function doRender({ ...@@ -644,18 +660,6 @@ async function doRender({
}) })
} }
function onAbort() {
;([].slice.call(
document.querySelectorAll('link[data-n-staging]')
) as HTMLLinkElement[]).forEach((el) => {
el.parentNode!.removeChild(el)
})
}
renderPromise.catch((abortError) => {
onAbort()
throw abortError
})
function onCommit() { function onCommit() {
if ( if (
// We can skip this during hydration. Running it wont cause any harm, but // We can skip this during hydration. Running it wont cause any harm, but
...@@ -696,17 +700,32 @@ async function doRender({ ...@@ -696,17 +700,32 @@ async function doRender({
) )
// We catch runtime errors using componentDidCatch which will trigger renderError // We catch runtime errors using componentDidCatch which will trigger renderError
await onStart() return Promise.race([
renderReactElement( // Download required CSS assets first:
process.env.__NEXT_STRICT_MODE ? ( onStart()
<React.StrictMode>{elem}</React.StrictMode> .then(() => {
) : ( // Ensure a new render has not been started:
elem if (renderPromiseReject === lastRenderReject) {
), // Queue rendering:
appElement! renderReactElement(
) process.env.__NEXT_STRICT_MODE ? (
<React.StrictMode>{elem}</React.StrictMode>
await renderPromise ) : (
elem
),
appElement!
)
}
})
.then(
() =>
// Wait for rendering to complete:
renderPromise
),
// Bail early on route cancelation (rejection):
renderPromise,
])
} }
function Root({ function Root({
......
...@@ -585,7 +585,7 @@ export default class Router implements BaseRouter { ...@@ -585,7 +585,7 @@ export default class Router implements BaseRouter {
as, as,
shallow shallow
) )
const { error } = routeInfo let { error } = routeInfo
Router.events.emit('beforeHistoryChange', as) Router.events.emit('beforeHistoryChange', as)
this.changeState(method, url, as, options) this.changeState(method, url, as, options)
...@@ -597,7 +597,12 @@ export default class Router implements BaseRouter { ...@@ -597,7 +597,12 @@ export default class Router implements BaseRouter {
!(routeInfo.Component as any).getInitialProps !(routeInfo.Component as any).getInitialProps
} }
await this.set(route, pathname!, query, cleanedAs, routeInfo) await this.set(route, pathname!, query, cleanedAs, routeInfo).catch(
(e) => {
if (e.cancelled) error = error || e
else throw e
}
)
if (error) { if (error) {
Router.events.emit('routeChangeError', error, cleanedAs) Router.events.emit('routeChangeError', error, cleanedAs)
......
module.exports = { target: 'experimental-serverless-trace' }
import Link from 'next/link'
import { useRouter } from 'next/router'
import React, { useEffect } from 'react'
export default () => {
const router = useRouter()
useEffect(() => {
router.events.on('routeChangeError', (err) => {
if (err.cancelled) {
window.routeCancelled = 'yes'
}
})
// Intentionally is not cleaned up
}, [router.events])
return (
<>
<Link href="/page1">
<a id="link-1">Page 1</a>
</Link>{' '}
<Link href="/page2">
<a id="link-2">Page 2</a>
</Link>
</>
)
}
import styles from './page1.module.css'
function Page1() {
return (
<p id="page-text" className={styles.abc}>
1
</p>
)
}
export default Page1
function Page2() {
return <p id="page-text">2</p>
}
export default Page2
const http = require('http')
const url = require('url')
const fs = require('fs')
const path = require('path')
const server = http.createServer(async (req, res) => {
let { pathname } = url.parse(req.url)
pathname = pathname.replace(/\/$/, '')
let isDataReq = false
if (pathname.startsWith('/_next/data')) {
isDataReq = true
pathname = pathname
.replace(`/_next/data/${process.env.BUILD_ID}/`, '/')
.replace(/\.json$/, '')
}
console.log('serving', pathname)
if (pathname === '/favicon.ico') {
res.statusCode = 404
return res.end()
}
if (pathname.startsWith('/_next/static/')) {
let prom = Promise.resolve()
if (pathname.endsWith('.css')) {
prom = new Promise((resolve) => setTimeout(resolve, 20000))
}
prom.then(() => {
res.write(
fs.readFileSync(
path.join(
__dirname,
'./.next/static/',
decodeURI(pathname.slice('/_next/static/'.length))
),
'utf8'
)
)
return res.end()
})
} else {
if (pathname === '') {
pathname = '/index'
}
const ext = isDataReq ? 'json' : 'html'
if (
fs.existsSync(
path.join(__dirname, `./.next/serverless/pages${pathname}.${ext}`)
)
) {
res.write(
fs.readFileSync(
path.join(__dirname, `./.next/serverless/pages${pathname}.${ext}`),
'utf8'
)
)
return res.end()
}
let re
try {
re = require(`./.next/serverless/pages${pathname}`)
} catch {
const d = decodeURI(pathname)
if (
fs.existsSync(
path.join(__dirname, `./.next/serverless/pages${d}.${ext}`)
)
) {
res.write(
fs.readFileSync(
path.join(__dirname, `./.next/serverless/pages${d}.${ext}`),
'utf8'
)
)
return res.end()
}
const routesManifest = require('./.next/routes-manifest.json')
const { dynamicRoutes } = routesManifest
dynamicRoutes.some(({ page, regex }) => {
if (new RegExp(regex).test(pathname)) {
if (
fs.existsSync(
path.join(__dirname, `./.next/serverless/pages${page}.${ext}`)
)
) {
res.write(
fs.readFileSync(
path.join(__dirname, `./.next/serverless/pages${page}.${ext}`),
'utf8'
)
)
res.end()
return true
}
re = require(`./.next/serverless/pages${page}`)
return true
}
return false
})
}
if (!res.finished) {
try {
return await (typeof re.render === 'function'
? re.render(req, res)
: re.default(req, res))
} catch (e) {
console.log('FAIL_FUNCTION', e)
res.statusCode = 500
res.write('FAIL_FUNCTION')
res.end()
}
}
}
})
server.listen(process.env.PORT, () => {
console.log('ready on', process.env.PORT)
})
/* eslint-env jest */
import fs from 'fs-extra'
import {
findPort,
initNextServerScript,
killApp,
nextBuild,
waitFor,
} from 'next-test-utils'
import webdriver from 'next-webdriver'
import { join } from 'path'
jest.setTimeout(1000 * 60 * 5)
let app
let appPort
const appDir = join(__dirname, '../')
function runTests() {
it('should cancel slow page loads on re-navigation', async () => {
const browser = await webdriver(appPort, '/')
await waitFor(5000)
await browser.elementByCss('#link-1').click()
await waitFor(3000)
expect(await browser.hasElementByCssSelector('#page-text')).toBeFalsy()
await browser.elementByCss('#link-2').click()
await waitFor(3000)
const text2 = await browser.elementByCss('#page-text').text()
expect(text2).toMatch(/2/)
expect(await browser.eval('window.routeCancelled')).toBe('yes')
})
}
describe('route cancel via CSS', () => {
beforeAll(async () => {
const startServerlessEmulator = async (dir, port, buildId) => {
const scriptPath = join(dir, 'server.js')
const env = Object.assign(
{},
{ ...process.env },
{ PORT: port, BUILD_ID: buildId }
)
return initNextServerScript(scriptPath, /ready on/i, env, false, {})
}
await fs.remove(join(appDir, '.next'))
await nextBuild(appDir)
const buildId = await fs.readFile(join(appDir, '.next/BUILD_ID'), 'utf8')
appPort = await findPort()
app = await startServerlessEmulator(appDir, appPort, buildId)
})
afterAll(async () => {
await killApp(app)
})
runTests()
})
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment