Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Show warning during build if page is returning a large amount of data #37264

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/next/export/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -385,6 +385,7 @@ export default async function exportApp(
nextScriptWorkers: nextConfig.experimental.nextScriptWorkers,
optimizeFonts: nextConfig.optimizeFonts,
reactRoot: nextConfig.experimental.reactRoot || false,
largePageDataBytes: nextConfig.experimental.largePageDataBytes,
}

const { serverRuntimeConfig, publicRuntimeConfig } = nextConfig
Expand Down
22 changes: 11 additions & 11 deletions packages/next/pages/_document.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -946,20 +946,20 @@ export class NextScript extends Component<OriginProps> {
}

static getInlineScriptSource(context: Readonly<HtmlProps>): string {
const { __NEXT_DATA__ } = context
const { __NEXT_DATA__, largePageDataBytes } = context
try {
const data = JSON.stringify(__NEXT_DATA__)
const bytes = Buffer.from(data).byteLength
const prettyBytes = require('../lib/pretty-bytes').default

if (process.env.NODE_ENV === 'development') {
const bytes = Buffer.from(data).byteLength
const prettyBytes = require('../lib/pretty-bytes').default
if (bytes > 128 * 1000) {
console.warn(
`Warning: data for page "${__NEXT_DATA__.page}" is ${prettyBytes(
bytes
)}, this amount of data can reduce performance.\nSee more info here: https://nextjs.org/docs/messages/large-page-data`
)
}
if (largePageDataBytes && bytes > largePageDataBytes) {
console.warn(
`Warning: data for page "${__NEXT_DATA__.page}" is ${prettyBytes(
bytes
)} which exceeds the threshold of ${prettyBytes(
largePageDataBytes
)}, this amount of data can reduce performance.\nSee more info here: https://nextjs.org/docs/messages/large-page-data`
)
}

return htmlEscapeJsonString(data)
Expand Down
2 changes: 2 additions & 0 deletions packages/next/server/base-server.ts
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,7 @@ export default abstract class Server<ServerOptions extends Options = Options> {
renderServerComponentData?: boolean
serverComponentProps?: any
reactRoot: boolean
largePageDataBytes?: number
}
protected serverOptions: ServerOptions
private incrementalCache: IncrementalCache
Expand Down Expand Up @@ -327,6 +328,7 @@ export default abstract class Server<ServerOptions extends Options = Options> {
? this.nextConfig.crossOrigin
: undefined,
reactRoot: this.nextConfig.experimental.reactRoot === true,
largePageDataBytes: this.nextConfig.experimental.largePageDataBytes,
}

// Only the `publicRuntimeConfig` key is exposed to the client side
Expand Down
2 changes: 2 additions & 0 deletions packages/next/server/config-shared.ts
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,7 @@ export interface ExperimentalConfig {
swcTraceProfiling?: boolean
forceSwcTransforms?: boolean
swcPlugins?: Array<[string, Record<string, unknown>]>
largePageDataBytes?: number
}

/**
Expand Down Expand Up @@ -516,6 +517,7 @@ export const defaultConfig: NextConfig = {
remotePatterns: [],
},
forceSwcTransforms: false,
largePageDataBytes: 128 * 1000, // 128KB by default
},
}

Expand Down
2 changes: 2 additions & 0 deletions packages/next/server/render.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -243,6 +243,7 @@ export type RenderOptsPartial = {
crossOrigin?: string
images: ImageConfigComplete
reactRoot: boolean
largePageDataBytes?: number
}

export type RenderOpts = LoadComponentsReturnType & RenderOptsPartial
Expand Down Expand Up @@ -1562,6 +1563,7 @@ export async function renderToHTML(
optimizeFonts: renderOpts.optimizeFonts,
nextScriptWorkers: renderOpts.nextScriptWorkers,
runtime: globalRuntime,
largePageDataBytes: renderOpts.largePageDataBytes,
}

const document = (
Expand Down
1 change: 1 addition & 0 deletions packages/next/shared/lib/html-context.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ export type HtmlProps = {
nextScriptWorkers?: boolean
runtime?: 'edge' | 'nodejs'
hasConcurrentFeatures?: boolean
largePageDataBytes?: number
}

export const HtmlContext = createContext<HtmlProps>(null as any)
Expand Down
16 changes: 8 additions & 8 deletions test/e2e/prerender.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -942,15 +942,15 @@ describe('Prerender', () => {
})
})

if ((global as any).isNextDev) {
it('should show warning when large amount of page data is returned', async () => {
await renderViaHTTP(next.url, '/large-page-data')
await check(
() => next.cliOutput,
/Warning: data for page "\/large-page-data" is 128 kB, this amount of data can reduce performance/
)
})
it('should show warning when large amount of page data is returned', async () => {
await renderViaHTTP(next.url, '/large-page-data')
await check(
() => next.cliOutput,
/Warning: data for page "\/large-page-data" is 256 kB which exceeds the threshold of 128 kB, this amount of data can reduce performance/
)
})

if ((global as any).isNextDev) {
it('should not show warning from url prop being returned', async () => {
const urlPropPage = 'pages/url-prop.js'
await next.patchFile(
Expand Down
2 changes: 1 addition & 1 deletion test/e2e/prerender/pages/large-page-data.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import Link from 'next/link'
export async function getStaticProps({ params }) {
return {
props: {
lotsOfData: new Array(128 * 1000).fill('a').join(''),
lotsOfData: new Array(256 * 1000).fill('a').join(''),
},
revalidate: false,
}
Expand Down