Commit 4850bd03 authored by JJ Kasper's avatar JJ Kasper Committed by Joe Haddad

Provide AppTree to getInitialProps for getDataFromTree (#7732)

* Provide AppContainer to getInitialProps for getDataFromTree

* Update to only pass AppTree component instead of AppContainer

* Clean up props and remove extra imports

* Make updates from review

* De-dupe AppTree a bit

* Re-use wrapApp in router

* Remove un-needed change

* revert changes to examples until on stable

* Add test for AppTree
parent 72098328
...@@ -69,6 +69,7 @@ export default class Router implements BaseRouter { ...@@ -69,6 +69,7 @@ export default class Router implements BaseRouter {
pageLoader: any pageLoader: any
_bps: BeforePopStateCallback | undefined _bps: BeforePopStateCallback | undefined
events: MittEmitter events: MittEmitter
_wrapApp: (App: ComponentType) => any
static events: MittEmitter = mitt() static events: MittEmitter = mitt()
...@@ -80,6 +81,7 @@ export default class Router implements BaseRouter { ...@@ -80,6 +81,7 @@ export default class Router implements BaseRouter {
initialProps, initialProps,
pageLoader, pageLoader,
App, App,
wrapApp,
Component, Component,
err, err,
subscription, subscription,
...@@ -89,6 +91,7 @@ export default class Router implements BaseRouter { ...@@ -89,6 +91,7 @@ export default class Router implements BaseRouter {
pageLoader: any pageLoader: any
Component: ComponentType Component: ComponentType
App: ComponentType App: ComponentType
wrapApp: (App: ComponentType) => any
err?: Error err?: Error
} }
) { ) {
...@@ -117,6 +120,7 @@ export default class Router implements BaseRouter { ...@@ -117,6 +120,7 @@ export default class Router implements BaseRouter {
this.asPath = as this.asPath = as
this.sub = subscription this.sub = subscription
this.clc = null this.clc = null
this._wrapApp = wrapApp
if (typeof window !== 'undefined') { if (typeof window !== 'undefined') {
// in order for `e.state` to work on the `onpopstate` event // in order for `e.state` to work on the `onpopstate` event
...@@ -581,6 +585,7 @@ export default class Router implements BaseRouter { ...@@ -581,6 +585,7 @@ export default class Router implements BaseRouter {
const { Component: App } = this.components['/_app'] const { Component: App } = this.components['/_app']
const props = await loadGetInitialProps<AppContextType<Router>>(App, { const props = await loadGetInitialProps<AppContextType<Router>>(App, {
AppTree: this._wrapApp(App),
Component, Component,
router: this, router: this,
ctx, ctx,
......
...@@ -99,8 +99,9 @@ export interface NextPageContext { ...@@ -99,8 +99,9 @@ export interface NextPageContext {
export type AppContextType<R extends NextRouter = NextRouter> = { export type AppContextType<R extends NextRouter = NextRouter> = {
Component: NextComponentType<NextPageContext> Component: NextComponentType<NextPageContext>
router: R AppTree: NextComponentType
ctx: NextPageContext ctx: NextPageContext
router: R
} }
export type AppInitialProps = { export type AppInitialProps = {
......
...@@ -20,7 +20,6 @@ import Head, { defaultHead } from '../lib/head' ...@@ -20,7 +20,6 @@ import Head, { defaultHead } from '../lib/head'
// @ts-ignore types will be added later as it's an internal module // @ts-ignore types will be added later as it's an internal module
import Loadable from '../lib/loadable' import Loadable from '../lib/loadable'
import { DataManagerContext } from '../lib/data-manager-context' import { DataManagerContext } from '../lib/data-manager-context'
import { RequestContext } from '../lib/request-context'
import { LoadableContext } from '../lib/loadable-context' import { LoadableContext } from '../lib/loadable-context'
import { RouterContext } from '../lib/router-context' import { RouterContext } from '../lib/router-context'
import { DataManager } from '../lib/data-manager' import { DataManager } from '../lib/data-manager'
...@@ -325,7 +324,6 @@ export async function renderToHTML( ...@@ -325,7 +324,6 @@ export async function renderToHTML(
const reactLoadableModules: string[] = [] const reactLoadableModules: string[] = []
const AppContainer = ({ children }: any) => ( const AppContainer = ({ children }: any) => (
<RequestContext.Provider value={req}>
<RouterContext.Provider value={router}> <RouterContext.Provider value={router}>
<DataManagerContext.Provider value={dataManager}> <DataManagerContext.Provider value={dataManager}>
<AmpStateContext.Provider value={ampState}> <AmpStateContext.Provider value={ampState}>
...@@ -337,11 +335,22 @@ export async function renderToHTML( ...@@ -337,11 +335,22 @@ export async function renderToHTML(
</AmpStateContext.Provider> </AmpStateContext.Provider>
</DataManagerContext.Provider> </DataManagerContext.Provider>
</RouterContext.Provider> </RouterContext.Provider>
</RequestContext.Provider>
) )
try { try {
props = await loadGetInitialProps(App, { Component, router, ctx }) props = await loadGetInitialProps(App, {
Component,
AppTree: (props: any) => {
const appProps = { ...props, Component, router }
return (
<AppContainer>
<App {...appProps} />
</AppContainer>
)
},
router,
ctx,
})
} catch (err) { } catch (err) {
if (!dev || !err) throw err if (!dev || !err) throw err
ctx.err = err ctx.err = err
......
...@@ -167,6 +167,7 @@ export default async ({ webpackHMR: passedWebpackHMR } = {}) => { ...@@ -167,6 +167,7 @@ export default async ({ webpackHMR: passedWebpackHMR } = {}) => {
pageLoader, pageLoader,
App, App,
Component, Component,
wrapApp,
err: initialErr, err: initialErr,
subscription: ({ Component, props, err }, App) => { subscription: ({ Component, props, err }, App) => {
render({ App, Component, props, err, emitter }) render({ App, Component, props, err, emitter })
...@@ -211,13 +212,16 @@ export async function renderError (props) { ...@@ -211,13 +212,16 @@ export async function renderError (props) {
// In production we do a normal render with the `ErrorComponent` as component. // In production we do a normal render with the `ErrorComponent` as component.
// If we've gotten here upon initial render, we can use the props from the server. // If we've gotten here upon initial render, we can use the props from the server.
// Otherwise, we need to call `getInitialProps` on `App` before mounting. // Otherwise, we need to call `getInitialProps` on `App` before mounting.
const initProps = props.props const appCtx = {
? props.props AppTree: wrapApp(App),
: await loadGetInitialProps(App, {
Component: ErrorComponent, Component: ErrorComponent,
router, router,
ctx: { err, pathname: page, query, asPath } ctx: { err, pathname: page, query, asPath }
}) }
const initProps = props.props
? props.props
: await loadGetInitialProps(App, appCtx)
await doRender({ ...props, err, Component: ErrorComponent, props: initProps }) await doRender({ ...props, err, Component: ErrorComponent, props: initProps })
} }
...@@ -256,6 +260,15 @@ function AppContainer ({ children }) { ...@@ -256,6 +260,15 @@ function AppContainer ({ children }) {
) )
} }
const wrapApp = App => props => {
const appProps = { ...props, Component, err, router }
return (
<AppContainer>
<App {...appProps} />
</AppContainer>
)
}
async function doRender ({ App, Component, props, err }) { async function doRender ({ App, Component, props, err }) {
// Usual getInitialProps fetching is handled in next/router // Usual getInitialProps fetching is handled in next/router
// this is for when ErrorComponent gets replaced by Component by HMR // this is for when ErrorComponent gets replaced by Component by HMR
...@@ -266,17 +279,19 @@ async function doRender ({ App, Component, props, err }) { ...@@ -266,17 +279,19 @@ async function doRender ({ App, Component, props, err }) {
lastAppProps.Component === ErrorComponent lastAppProps.Component === ErrorComponent
) { ) {
const { pathname, query, asPath } = router const { pathname, query, asPath } = router
props = await loadGetInitialProps(App, { const appCtx = {
Component,
router, router,
AppTree: wrapApp(App),
Component: ErrorComponent,
ctx: { err, pathname, query, asPath } ctx: { err, pathname, query, asPath }
}) }
props = await loadGetInitialProps(App, appCtx)
} }
Component = Component || lastAppProps.Component Component = Component || lastAppProps.Component
props = props || lastAppProps.props props = props || lastAppProps.props
const appProps = { Component, err, router, ...props } const appProps = { ...props, Component, err, router }
// 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
......
...@@ -2,7 +2,6 @@ ...@@ -2,7 +2,6 @@
import React from 'react' import React from 'react'
import Router, { NextRouter } from 'next-server/dist/lib/router/router' import Router, { NextRouter } from 'next-server/dist/lib/router/router'
import { RouterContext } from 'next-server/dist/lib/router-context' import { RouterContext } from 'next-server/dist/lib/router-context'
import { RequestContext } from 'next-server/dist/lib/request-context'
type ClassArguments<T> = T extends new (...args: infer U) => any ? U : any type ClassArguments<T> = T extends new (...args: infer U) => any ? U : any
...@@ -118,10 +117,6 @@ export function useRouter() { ...@@ -118,10 +117,6 @@ export function useRouter() {
return React.useContext(RouterContext) return React.useContext(RouterContext)
} }
export function useRequest() {
return React.useContext(RequestContext)
}
// INTERNAL APIS // INTERNAL APIS
// ------------- // -------------
// (do not use following exports inside the app) // (do not use following exports inside the app)
......
import React from 'react'
import Link from 'next/link'
import { render } from 'react-dom'
import App, { Container } from 'next/app'
import { renderToString } from 'react-dom/server'
class MyApp extends App {
static async getInitialProps ({ Component, AppTree, router, ctx }) {
let pageProps = {}
if (Component.getInitialProps) {
pageProps = await Component.getInitialProps(ctx)
}
let html
const toRender = (
<AppTree
{...{
router,
Component
}}
/>
)
if (typeof window !== 'undefined') {
const el = document.createElement('div')
document.querySelector('body').appendChild(el)
render(toRender, el)
html = el.innerHTML
el.remove()
} else {
html = renderToString(toRender)
}
return { pageProps, html }
}
render () {
const { Component, pageProps, html, router } = this.props
const href = router.pathname === '/' ? '/another' : '/'
return html ? (
<>
<div dangerouslySetInnerHTML={{ __html: html }} />
<Link href={href}>
<a id={href === '/' ? 'home' : 'another'}>to {href}</a>
</Link>
</>
) : (
<Container>
<Component {...pageProps} {...{ html }} />
</Container>
)
}
}
export default MyApp
import { useRouter } from 'next/router'
const Page = () => {
const { pathname } = useRouter()
return (
<>
<h3>page: {pathname}</h3>
</>
)
}
export default Page
import { useRouter } from 'next/router'
const Page = () => {
const { pathname } = useRouter()
return (
<>
<h3>page: {pathname}</h3>
</>
)
}
export default Page
/* eslint-env jest */
/* global jasmine */
import path from 'path'
import fs from 'fs-extra'
import webdriver from 'next-webdriver'
import {
nextBuild,
nextStart,
findPort,
launchApp,
killApp,
renderViaHTTP,
waitFor,
killAll
} from 'next-test-utils'
jasmine.DEFAULT_TIMEOUT_INTERVAL = 1000 * 60 * 1
const appDir = path.join(__dirname, '..')
const nextConfig = path.join(appDir, 'next.config.js')
let appPort
let app
const runTests = () => {
it('should provide router context in AppTree on SSR', async () => {
let html = await renderViaHTTP(appPort, '/')
expect(html).toMatch(/page:.*?\//)
html = await renderViaHTTP(appPort, '/another')
expect(html).toMatch(/page:.*?\/another/)
})
it('should provide router context in AppTree on CSR', async () => {
const browser = await webdriver(appPort, '/')
let html = await browser.eval(`document.documentElement.innerHTML`)
expect(html).toMatch(/page:.*?\//)
browser.elementByCss('#another').click()
await waitFor(500)
html = await browser.eval(`document.documentElement.innerHTML`)
expect(html).toMatch(/page:.*?\//)
browser.elementByCss('#home').click()
await waitFor(500)
html = await browser.eval(`document.documentElement.innerHTML`)
expect(html).toMatch(/page:.*?\/another/)
})
}
describe('Auto Export', () => {
describe('dev mode', () => {
beforeAll(async () => {
appPort = await findPort()
app = await launchApp(appDir, appPort)
})
afterAll(() => killApp(app))
runTests()
})
describe('production mode', () => {
beforeAll(async () => {
await nextBuild(appDir)
appPort = await findPort()
app = await nextStart(appDir, appPort)
})
afterAll(() => killAll(app))
runTests()
})
describe('serverless mode', () => {
beforeAll(async () => {
await fs.writeFile(
nextConfig,
`module.exports = { target: 'serverless' }`
)
await nextBuild(appDir)
appPort = await findPort()
app = await nextStart(appDir, appPort)
})
afterAll(async () => {
await killApp(app)
await fs.remove(nextConfig)
})
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