Unverified Commit 849a79fb authored by Martin Šťovíček's avatar Martin Šťovíček Committed by GitHub

Prevent timeout when loading routes in development (#25749)

* Prevent timeout when loading routes in development

The new route loader (https://github.com/vercel/next.js/pull/19006) will timeout
loading routes after 3.8s (MS_MAX_IDLE_DELAY), but this can easily happen when
running dev on a large app.

Fixes https://github.com/vercel/next.js/issues/25675

* Delay route loading timeout in development

* refactor: Integrate onBuildCallback into resolvePromiseWithTimeout

* refactor: Tweak for better dead-code elimination
Co-authored-by: 's avatarJJ Kasper <jj@jjsweb.site>
parent 36d00a74
...@@ -149,6 +149,39 @@ function appendScript( ...@@ -149,6 +149,39 @@ function appendScript(
}) })
} }
// We wait for pages to be built in dev before we start the route transition
// timeout to prevent an un-necessary hard navigation in development.
let devBuildPromise: Promise<void> | undefined
let devBuildResolve: (() => void) | undefined
if (process.env.NODE_ENV === 'development') {
const { addMessageListener } = require('./dev/error-overlay/eventsource')
addMessageListener((event: any) => {
// This is the heartbeat event
if (event.data === '\uD83D\uDC93') {
return
}
const obj =
typeof event === 'string' ? { action: event } : JSON.parse(event.data)
switch (obj.action) {
case 'built':
case 'sync':
if (devBuildResolve) {
devBuildResolve()
devBuildResolve = undefined
}
break
default:
break
}
})
}
// Resolve a promise that times out after given amount of milliseconds. // Resolve a promise that times out after given amount of milliseconds.
function resolvePromiseWithTimeout<T>( function resolvePromiseWithTimeout<T>(
p: Promise<T>, p: Promise<T>,
...@@ -164,13 +197,29 @@ function resolvePromiseWithTimeout<T>( ...@@ -164,13 +197,29 @@ function resolvePromiseWithTimeout<T>(
resolve(r) resolve(r)
}).catch(reject) }).catch(reject)
requestIdleCallback(() => // We wrap these checks separately for better dead-code elimination in
setTimeout(() => { // production bundles.
if (!cancelled) { if (process.env.NODE_ENV === 'development') {
reject(err) ;(devBuildPromise || Promise.resolve()).then(() => {
} requestIdleCallback(() =>
}, ms) setTimeout(() => {
) if (!cancelled) {
reject(err)
}
}, ms)
)
})
}
if (process.env.NODE_ENV !== 'development') {
requestIdleCallback(() =>
setTimeout(() => {
if (!cancelled) {
reject(err)
}
}, ms)
)
}
}) })
} }
...@@ -307,6 +356,12 @@ function createRouteLoader(assetPrefix: string): RouteLoader { ...@@ -307,6 +356,12 @@ function createRouteLoader(assetPrefix: string): RouteLoader {
}, },
loadRoute(route: string, prefetch?: boolean) { loadRoute(route: string, prefetch?: boolean) {
return withFuture<RouteLoaderEntry>(route, routes, () => { return withFuture<RouteLoaderEntry>(route, routes, () => {
if (process.env.NODE_ENV === 'development') {
devBuildPromise = new Promise<void>((resolve) => {
devBuildResolve = resolve
})
}
return resolvePromiseWithTimeout( return resolvePromiseWithTimeout(
getFilesForRoute(assetPrefix, route) getFilesForRoute(assetPrefix, route)
.then(({ scripts, css }) => { .then(({ scripts, css }) => {
......
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