misc: build output rework (#57440)

This PR updates the build output in order to reflect the changes brought
by PPR and also to make it more consistent.

before
```
○  (Static)                  automatically pre-rendered as static HTML
◐  (Partially Pre-Rendered)  static parts of the page were pre-rendered and the dynamic parts will be streamed
ℇ  (Streaming)               server-side renders with streaming (uses React 18 SSR streaming or Server Components)
λ  (Server)                  server-side renders at runtime (uses getInitialProps or getServerSideProps)
```

after

```
○  (Static)             prerendered as static HTML
◐  (Partial Prerender)  prerendered as static HTML with dynamic server-streamed content
λ  (Dynamic)            server-rendered on demand using Node.js
ℇ  (Edge Runtime)       server-rendered on demand using the Edge Runtime
```




<!-- Thanks for opening a PR! Your contribution is much appreciated.
To make sure your PR is handled as smoothly as possible we request that
you follow the checklist sections below.
Choose the right checklist for the change(s) that you're making:

## For Contributors

### Improving Documentation

- Run `pnpm prettier-fix` to fix formatting issues before opening the
PR.
- Read the Docs Contribution Guide to ensure your contribution follows
the docs guidelines:
https://nextjs.org/docs/community/contribution-guide

### Adding or Updating Examples

- The "examples guidelines" are followed from our contributing doc
https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md
- Make sure the linting passes by running `pnpm build && pnpm lint`. See
https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md

### Fixing a bug

- Related issues linked using `fixes #number`
- Tests added. See:
https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md

### Adding a feature

- Implements an existing feature request or RFC. Make sure the feature
request has been accepted for implementation before opening a PR. (A
discussion must be opened, see
https://github.com/vercel/next.js/discussions/new?category=ideas)
- Related issues/discussions are linked using `fixes #number`
- e2e tests added
(https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs)
- Documentation added
- Telemetry added. In case of a feature if it's used or not.
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md


## For Maintainers

- Minimal description (aim for explaining to someone not on the team to
understand the PR)
- When linking to a Slack thread, you might want to share details of the
conclusion
- Link both the Linear (Fixes NEXT-xxx) and the GitHub issues
- Add review comments if necessary to explain to the reviewer the logic
behind a change

### What?

### Why?

### How?

Closes NEXT-
Fixes #

-->
This commit is contained in:
Jimmy Lai 2023-10-25 13:19:42 -07:00 committed by GitHub
parent 2b400f8fc3
commit da6562e4a1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 86 additions and 38 deletions

View file

@ -66,6 +66,7 @@
"napi",
"nextjs",
"opentelemetry",
"prerendered",
"Threadsafe",
"Turbopack",
"zipkin"

View file

@ -1807,6 +1807,7 @@ export default async function build(
runtime: pageRuntime,
pageDuration: undefined,
ssgPageDurations: undefined,
hasEmptyPrelude: undefined,
})
})
})
@ -2237,8 +2238,16 @@ export default async function build(
const {
revalidate = appConfig.revalidate ?? false,
metadata = {},
hasEmptyPrelude,
hasPostponed,
} = exportResult.byPath.get(route) ?? {}
pageInfos.set(route, {
...(pageInfos.get(route) as PageInfo),
hasPostponed,
hasEmptyPrelude,
})
if (revalidate !== 0) {
const normalizedRoute = normalizePagePath(route)
const dataRoute = isRouteHandler
@ -2299,6 +2308,11 @@ export default async function build(
const normalizedRoute = normalizePagePath(page)
const dataRoute = path.posix.join(`${normalizedRoute}.rsc`)
pageInfos.set(page, {
...(pageInfos.get(page) as PageInfo),
isDynamicAppRoute: true,
})
// TODO: create a separate manifest to allow enforcing
// dynamicParams for non-static paths?
finalDynamicRoutes[page] = {

View file

@ -337,6 +337,9 @@ export interface PageInfo {
pageDuration: number | undefined
ssgPageDurations: number[] | undefined
runtime: ServerRuntime
hasEmptyPrelude?: boolean
hasPostponed?: boolean
isDynamicAppRoute?: boolean
}
export async function printTreeView(
@ -450,18 +453,28 @@ export async function printTreeView(
(pageInfo?.pageDuration || 0) +
(pageInfo?.ssgPageDurations?.reduce((a, b) => a + (b || 0), 0) || 0)
const symbol =
item === '/_app' || item === '/_app.server'
? ' '
: isEdgeRuntime(pageInfo?.runtime)
? 'ℇ'
: pageInfo?.isPPR
? '◐'
: pageInfo?.isStatic
? '○'
: pageInfo?.isSSG
? '●'
: 'λ'
let symbol: string
if (item === '/_app' || item === '/_app.server') {
symbol = ' '
} else if (isEdgeRuntime(pageInfo?.runtime)) {
symbol = 'ℇ'
} else if (pageInfo?.isPPR) {
// If the page has an empty prelude, then it's equivalent to a static page.
if (pageInfo?.hasEmptyPrelude) {
symbol = 'λ'
} else if (!pageInfo?.hasPostponed && !pageInfo.isDynamicAppRoute) {
symbol = '○'
} else {
symbol = '◐'
}
} else if (pageInfo?.isStatic) {
symbol = '○'
} else if (pageInfo?.isSSG) {
symbol = '●'
} else {
symbol = 'λ'
}
usedSymbols.add(symbol)
@ -667,34 +680,11 @@ export async function printTreeView(
print(
textTable(
[
usedSymbols.has('◐') && [
'◐',
'(Partially Pre-Rendered)',
'static parts of the page were pre-rendered and the dynamic parts will be streamed',
],
usedSymbols.has('ℇ') && [
'ℇ',
'(Streaming)',
`server-side renders with streaming (uses React 18 SSR streaming or Server Components)`,
],
usedSymbols.has('λ') && [
'λ',
'(Server)',
`server-side renders at runtime (uses ${cyan(
'getInitialProps'
)} or ${cyan('getServerSideProps')})`,
],
usedSymbols.has('○') && [
'○',
'(Static)',
'automatically rendered as static HTML (uses no initial props)',
],
usedSymbols.has('○') && ['○', '(Static)', 'prerendered as static HTML'],
usedSymbols.has('●') && [
'●',
'(SSG)',
`automatically generated as static HTML + JSON (uses ${cyan(
'getStaticProps'
)})`,
`prerendered as static HTML (uses ${cyan('getStaticProps')})`,
],
usedSymbols.has('ISR') && [
'',
@ -703,6 +693,21 @@ export async function printTreeView(
'getStaticProps'
)})`,
],
usedSymbols.has('◐') && [
'◐',
'(Partial Prerender)',
'prerendered as static HTML with dynamic server-streamed content',
],
usedSymbols.has('λ') && [
'λ',
'(Dynamic)',
`server-rendered on demand using Node.js`,
],
usedSymbols.has('ℇ') && [
'ℇ',
'(Edge Runtime)',
`server-rendered on demand using the Edge Runtime`,
],
].filter((x) => x) as [string, string, string][],
{
align: ['l', 'l', 'l'],

View file

@ -746,6 +746,15 @@ export async function exportAppImpl(
if (typeof result.metadata !== 'undefined') {
info.metadata = result.metadata
}
if (typeof result.hasEmptyPrelude !== 'undefined') {
info.hasEmptyPrelude = result.hasEmptyPrelude
}
if (typeof result.hasPostponed !== 'undefined') {
info.hasPostponed = result.hasPostponed
}
collector.byPath.set(path, info)
// Update not found.

View file

@ -160,7 +160,12 @@ export async function exportAppPage(
)
// Writing the request metadata to a file.
const meta: RouteMetadata = { status: undefined, headers, postponed }
const meta: RouteMetadata = {
status: undefined,
headers,
postponed,
}
await fileWriter(
ExportedAppPageFiles.META,
htmlFilepath.replace(/\.html$/, '.meta'),
@ -177,6 +182,8 @@ export async function exportAppPage(
return {
// Only include the metadata if the environment has next support.
metadata: hasNextSupport ? meta : undefined,
hasEmptyPrelude: Boolean(postponed) && html === '',
hasPostponed: Boolean(postponed),
revalidate,
}
} catch (err: any) {

View file

@ -73,6 +73,8 @@ export type ExportRouteResult =
headers?: OutgoingHttpHeaders
}
ssgNotFound?: boolean
hasEmptyPrelude?: boolean
hasPostponed?: boolean
}
| {
error: boolean
@ -135,6 +137,14 @@ export type ExportAppResult = {
* The metadata for the page.
*/
metadata?: { status?: number; headers?: OutgoingHttpHeaders }
/**
* If the page has an empty prelude when using PPR.
*/
hasEmptyPrelude?: boolean
/**
* If the page has postponed when using PPR.
*/
hasPostponed?: boolean
}
>

View file

@ -360,5 +360,7 @@ export default async function exportPage(
revalidate: result.revalidate,
metadata: result.metadata,
ssgNotFound: result.ssgNotFound,
hasEmptyPrelude: result.hasEmptyPrelude,
hasPostponed: result.hasPostponed,
}
}