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