Unverified Commit 3ee0a1f4 authored by Joe Haddad's avatar Joe Haddad Committed by GitHub

Wait for flush before firing routing event (#13287)

This waits for the render to be committed to DOM before we render the route change complete event (no longer sync in new React).

We have tests that ensure this resolves.

---

Closes #12938
parent d6ad201f
......@@ -64,6 +64,7 @@ const updateHead = initHeadManager()
const appElement = document.getElementById('__next')
let lastAppProps
let lastRenderReject
let webpackHMR
export let router
let Component
......@@ -266,9 +267,8 @@ export default async ({ webpackHMR: passedWebpackHMR } = {}) => {
wrapApp,
err: initialErr,
isFallback,
subscription: ({ Component, props, err }, App) => {
render({ App, Component, props, err })
},
subscription: ({ Component, props, err }, App) =>
render({ App, Component, props, err }),
})
// call init-client middleware
......@@ -496,10 +496,27 @@ async function doRender({ App, Component, props, err }) {
// lastAppProps has to be set before ReactDom.render to account for ReactDom throwing an error.
lastAppProps = appProps
let resolvePromise
const renderPromise = new Promise((resolve, reject) => {
if (lastRenderReject) {
lastRenderReject()
}
resolvePromise = () => {
lastRenderReject = null
resolve()
}
lastRenderReject = () => {
lastRenderReject = null
reject()
}
})
const elem = (
<AppContainer>
<App {...appProps} />
</AppContainer>
<Root callback={resolvePromise}>
<AppContainer>
<App {...appProps} />
</AppContainer>
</Root>
)
// We catch runtime errors using componentDidCatch which will trigger renderError
......@@ -511,4 +528,13 @@ async function doRender({ App, Component, props, err }) {
),
appElement
)
await renderPromise
}
function Root({ callback, children }) {
// We use `useLayoutEffect` to guarantee the callback is executed
// as soon as React flushes the update.
React.useLayoutEffect(() => callback(), [callback])
return children
}
......@@ -73,7 +73,7 @@ type RouteInfo = {
error?: any
}
type Subscription = (data: RouteInfo, App?: ComponentType) => void
type Subscription = (data: RouteInfo, App?: ComponentType) => Promise<void>
type BeforePopStateCallback = (state: any) => boolean
......@@ -486,15 +486,15 @@ export default class Router implements BaseRouter {
!(routeInfo.Component as any).getInitialProps
}
this.set(route, pathname, query, as, routeInfo)
if (error) {
Router.events.emit('routeChangeError', error, as)
throw error
}
this.set(route, pathname, query, as, routeInfo).then(() => {
if (error) {
Router.events.emit('routeChangeError', error, as)
throw error
}
Router.events.emit('routeChangeComplete', as)
return resolve(true)
Router.events.emit('routeChangeComplete', as)
return resolve(true)
})
},
reject
)
......@@ -665,14 +665,14 @@ export default class Router implements BaseRouter {
query: any,
as: string,
data: RouteInfo
): void {
): Promise<void> {
this.isFallback = false
this.route = route
this.pathname = pathname
this.query = query
this.asPath = as
this.notify(data)
return this.notify(data)
}
/**
......@@ -855,7 +855,7 @@ export default class Router implements BaseRouter {
}
}
notify(data: RouteInfo): void {
this.sub(data, this.components['/_app'].Component)
notify(data: RouteInfo): Promise<void> {
return this.sub(data, this.components['/_app'].Component)
}
}
......@@ -80,7 +80,7 @@ describe('Production response size', () => {
)
// These numbers are without gzip compression!
const delta = responseSizesBytes - 263 * 1024
const delta = responseSizesBytes - 264 * 1024
expect(delta).toBeLessThanOrEqual(1024) // don't increase size more than 1kb
expect(delta).toBeGreaterThanOrEqual(-1024) // don't decrease size more than 1kb without updating target
})
......@@ -100,7 +100,7 @@ describe('Production response size', () => {
)
// These numbers are without gzip compression!
const delta = responseSizesBytes - 168 * 1024
const delta = responseSizesBytes - 169 * 1024
expect(delta).toBeLessThanOrEqual(1024) // don't increase size more than 1kb
expect(delta).toBeGreaterThanOrEqual(-1024) // don't decrease size more than 1kb without updating target
})
......
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