Unverified Commit efa58efd authored by JJ Kasper's avatar JJ Kasper Committed by GitHub

Ensure stalled CSS triggers fallback navigation (#24488)

This ensures when CSS requests stall that they are included in the route load timeout so that stalled CSS requests don't block us from falling back to a hard navigation. This handles a rare case noticed by @pacocoursey where a transition did not complete while attempting to load CSS assets. 

## Bug

- [ ] Related issues linked using `fixes #number`
- [x] Integration tests added
parent fff183c4
...@@ -68,7 +68,7 @@ function withFuture<T>( ...@@ -68,7 +68,7 @@ function withFuture<T>(
export interface RouteLoader { export interface RouteLoader {
whenEntrypoint(route: string): Promise<RouteEntrypoint> whenEntrypoint(route: string): Promise<RouteEntrypoint>
onEntrypoint(route: string, execute: () => unknown): void onEntrypoint(route: string, execute: () => unknown): void
loadRoute(route: string): Promise<RouteLoaderEntry> loadRoute(route: string, prefetch?: boolean): Promise<RouteLoaderEntry>
prefetch(route: string): Promise<void> prefetch(route: string): Promise<void>
} }
...@@ -305,33 +305,41 @@ function createRouteLoader(assetPrefix: string): RouteLoader { ...@@ -305,33 +305,41 @@ function createRouteLoader(assetPrefix: string): RouteLoader {
if (old && 'resolve' in old) old.resolve(input) if (old && 'resolve' in old) old.resolve(input)
}) })
}, },
loadRoute(route: string) { loadRoute(route: string, prefetch?: boolean) {
return withFuture<RouteLoaderEntry>(route, routes, async () => { return withFuture<RouteLoaderEntry>(route, routes, () => {
try { return resolvePromiseWithTimeout(
const { scripts, css } = await getFilesForRoute(assetPrefix, route) getFilesForRoute(assetPrefix, route)
const [, styles] = await Promise.all([ .then(({ scripts, css }) => {
entrypoints.has(route) return Promise.all([
? [] entrypoints.has(route)
: Promise.all(scripts.map(maybeExecuteScript)), ? []
Promise.all(css.map(fetchStyleSheet)), : Promise.all(scripts.map(maybeExecuteScript)),
] as const) Promise.all(css.map(fetchStyleSheet)),
] as const)
const entrypoint: RouteEntrypoint = await resolvePromiseWithTimeout( })
this.whenEntrypoint(route), .then((res) => {
MS_MAX_IDLE_DELAY, return this.whenEntrypoint(route).then((entrypoint) => ({
markAssetError( entrypoint,
new Error(`Route did not complete loading: ${route}`) styles: res[1],
) }))
) }),
MS_MAX_IDLE_DELAY,
const res: RouteLoaderEntry = Object.assign< markAssetError(new Error(`Route did not complete loading: ${route}`))
{ styles: RouteStyleSheet[] }, )
RouteEntrypoint .then(({ entrypoint, styles }) => {
>({ styles }, entrypoint) const res: RouteLoaderEntry = Object.assign<
return 'error' in entrypoint ? entrypoint : res { styles: RouteStyleSheet[] },
} catch (err) { RouteEntrypoint
return { error: err } >({ styles: styles! }, entrypoint)
} return 'error' in entrypoint ? entrypoint : res
})
.catch((err) => {
if (prefetch) {
// we don't want to cache errors during prefetch
throw err
}
return { error: err }
})
}) })
}, },
prefetch(route: string): Promise<void> { prefetch(route: string): Promise<void> {
...@@ -351,7 +359,7 @@ function createRouteLoader(assetPrefix: string): RouteLoader { ...@@ -351,7 +359,7 @@ function createRouteLoader(assetPrefix: string): RouteLoader {
) )
) )
.then(() => { .then(() => {
requestIdleCallback(() => this.loadRoute(route)) requestIdleCallback(() => this.loadRoute(route, true).catch(() => {}))
}) })
.catch( .catch(
// swallow prefetch errors // swallow prefetch errors
......
...@@ -99,7 +99,7 @@ describe('Build Output', () => { ...@@ -99,7 +99,7 @@ describe('Build Output', () => {
expect(indexSize.endsWith('B')).toBe(true) expect(indexSize.endsWith('B')).toBe(true)
// should be no bigger than 64.8 kb // should be no bigger than 64.8 kb
expect(parseFloat(indexFirstLoad)).toBeCloseTo(65.4, 1) expect(parseFloat(indexFirstLoad)).toBeCloseTo(65.3, 1)
expect(indexFirstLoad.endsWith('kB')).toBe(true) expect(indexFirstLoad.endsWith('kB')).toBe(true)
expect(parseFloat(err404Size)).toBeCloseTo(3.69, 1) expect(parseFloat(err404Size)).toBeCloseTo(3.69, 1)
...@@ -108,7 +108,7 @@ describe('Build Output', () => { ...@@ -108,7 +108,7 @@ describe('Build Output', () => {
expect(parseFloat(err404FirstLoad)).toBeCloseTo(68.8, 0) expect(parseFloat(err404FirstLoad)).toBeCloseTo(68.8, 0)
expect(err404FirstLoad.endsWith('kB')).toBe(true) expect(err404FirstLoad.endsWith('kB')).toBe(true)
expect(parseFloat(sharedByAll)).toBeCloseTo(65.1, 1) expect(parseFloat(sharedByAll)).toBeCloseTo(65, 1)
expect(sharedByAll.endsWith('kB')).toBe(true) expect(sharedByAll.endsWith('kB')).toBe(true)
if (_appSize.endsWith('kB')) { if (_appSize.endsWith('kB')) {
......
/* eslint-env jest */ /* eslint-env jest */
import http from 'http'
import httpProxy from 'http-proxy'
import cheerio from 'cheerio' import cheerio from 'cheerio'
import { remove } from 'fs-extra' import { remove } from 'fs-extra'
import { import {
...@@ -18,6 +20,8 @@ jest.setTimeout(1000 * 60 * 1) ...@@ -18,6 +20,8 @@ jest.setTimeout(1000 * 60 * 1)
const fixturesDir = join(__dirname, '../../css-fixtures') const fixturesDir = join(__dirname, '../../css-fixtures')
const appDir = join(fixturesDir, 'multi-module') const appDir = join(fixturesDir, 'multi-module')
let proxyServer
let stallCss
let appPort let appPort
let app let app
...@@ -152,12 +156,69 @@ describe('CSS Module client-side navigation', () => { ...@@ -152,12 +156,69 @@ describe('CSS Module client-side navigation', () => {
beforeAll(async () => { beforeAll(async () => {
await remove(join(appDir, '.next')) await remove(join(appDir, '.next'))
await nextBuild(appDir) await nextBuild(appDir)
const port = await findPort()
app = await nextStart(appDir, port)
appPort = await findPort() appPort = await findPort()
app = await nextStart(appDir, appPort)
const proxy = httpProxy.createProxyServer({
target: `http://localhost:${port}`,
})
proxyServer = http.createServer(async (req, res) => {
if (stallCss && req.url.endsWith('.css')) {
console.log('stalling request for', req.url)
await new Promise((resolve) => setTimeout(resolve, 5 * 1000))
}
proxy.web(req, res)
})
proxy.on('error', (err) => {
console.warn('Failed to proxy', err)
})
await new Promise((resolve) => {
proxyServer.listen(appPort, () => resolve())
})
}) })
afterAll(async () => { afterAll(async () => {
proxyServer.close()
await killApp(app) await killApp(app)
}) })
it('should time out and hard navigate for stalled CSS request', async () => {
let browser
stallCss = true
try {
browser = await webdriver(appPort, '/red')
browser.eval('window.beforeNav = "hello"')
const redColor = await browser.eval(
`window.getComputedStyle(document.querySelector('#verify-red')).color`
)
expect(redColor).toMatchInlineSnapshot(`"rgb(255, 0, 0)"`)
expect(await browser.eval('window.beforeNav')).toBe('hello')
await browser.elementByCss('#link-blue').click()
await browser.waitForElementByCss('#verify-blue')
const blueColor = await browser.eval(
`window.getComputedStyle(document.querySelector('#verify-blue')).color`
)
expect(blueColor).toMatchInlineSnapshot(`"rgb(0, 0, 255)"`)
// the timeout should have been reached and we did a hard
// navigation
expect(await browser.eval('window.beforeNav')).toBe(null)
} finally {
stallCss = false
if (browser) {
await browser.close()
}
}
})
runTests() 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