Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit 5e28132

Browse files
authored
fix(perf): exclude /_next/static/* from generated functions (#3100)
1 parent 74e40d4 commit 5e28132

File tree

6 files changed

+87
-7
lines changed

6 files changed

+87
-7
lines changed

‎src/build/functions/server.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,7 @@ const getHandlerFile = async (ctx: PluginContext): Promise<string> => {
106106

107107
const templateVariables: Record<string, string> = {
108108
'{{useRegionalBlobs}}': ctx.useRegionalBlobs.toString(),
109+
'{{excludeStaticPath}}': posixJoin(ctx.buildConfig.basePath || '', '/_next/static/*'),
109110
}
110111
// In this case it is a monorepo and we need to use a own template for it
111112
// as we have to change the process working directory

‎src/build/templates/handler-monorepo.tmpl.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,4 +49,9 @@ export default async function (req, context) {
4949
export const config = {
5050
path: '/*',
5151
preferStatic: true,
52+
excludedPath: [
53+
// We use `preferStatic: true` so we already won't run this on *existing* static assets,
54+
// but by excluding this entire path we also avoid invoking the function just to 404.
55+
'{{excludeStaticPath}}',
56+
],
5257
}

‎src/build/templates/handler.tmpl.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,4 +43,9 @@ export default async function handler(req, context) {
4343
export const config = {
4444
path: '/*',
4545
preferStatic: true,
46+
excludedPath: [
47+
// We use `preferStatic: true` so we already won't run this on *existing* static assets,
48+
// but by excluding this entire path we also avoid invoking the function just to 404.
49+
'{{excludeStaticPath}}',
50+
],
4651
}

‎tests/e2e/page-router.test.ts

Lines changed: 72 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
import { expect } from '@playwright/test'
22
import { nextVersionSatisfies } from '../utils/next-version-helpers.mjs'
33
import { test } from '../utils/playwright-helpers.js'
4+
import { join } from 'node:path'
5+
import { readdir } from 'node:fs/promises'
46

57
export function waitFor(millis: number) {
68
return new Promise((resolve) => setTimeout(resolve, millis))
@@ -614,6 +616,34 @@ test.describe('Simple Page Router (no basePath, no i18n)', () => {
614616
/(s-maxage|max-age)/,
615617
)
616618
})
619+
620+
test.describe('static assets and function invocations', () => {
621+
test('should return 200 for an existing static asset without invoking a function', async ({
622+
page,
623+
pageRouter,
624+
}) => {
625+
// Since assets are hashed, we can't hardcode anything here. Find something to fetch.
626+
const [staticAsset] = await readdir(
627+
join(pageRouter.isolatedFixtureRoot, '.next', 'static', 'chunks'),
628+
)
629+
expect(staticAsset).toBeDefined()
630+
631+
const response = await page.goto(`${pageRouter.url}/_next/static/chunks/${staticAsset}`)
632+
633+
expect(response?.status()).toBe(200)
634+
expect(response?.headers()).not.toHaveProperty('x-nf-function-type')
635+
})
636+
637+
test('should return 404 for a nonexistent static asset without invoking a function', async ({
638+
page,
639+
pageRouter,
640+
}) => {
641+
const response = await page.goto(`${pageRouter.url}/_next/static/stale123abcdef.js`)
642+
643+
expect(response?.status()).toBe(404)
644+
expect(response?.headers()).not.toHaveProperty('x-nf-function-type')
645+
})
646+
})
617647
})
618648

619649
test.describe('Page Router with basePath and i18n', () => {
@@ -1352,13 +1382,15 @@ test.describe('Page Router with basePath and i18n', () => {
13521382

13531383
test('requesting a non existing page route that needs to be fetched from the blob store like 404.html', async ({
13541384
page,
1355-
pageRouter,
1385+
pageRouterBasePathI18n,
13561386
}) => {
1357-
const response = await page.goto(new URL('non-existing', pageRouter.url).href)
1387+
const response = await page.goto(
1388+
new URL('base/path/non-existing', pageRouterBasePathI18n.url).href,
1389+
)
13581390
const headers = response?.headers() || {}
13591391
expect(response?.status()).toBe(404)
13601392

1361-
expect(await page.textContent('p')).toBe('Custom 404 page')
1393+
expect(await page.textContent('p')).toBe('Custom 404 page for locale: en')
13621394

13631395
// https://github.com/vercel/next.js/pull/69802 made changes to returned cache-control header,
13641396
// after that 404 pages would have `private` directive, before that it would not
@@ -1375,13 +1407,15 @@ test.describe('Page Router with basePath and i18n', () => {
13751407

13761408
test('requesting a non existing page route that needs to be fetched from the blob store like 404.html (notFound: true)', async ({
13771409
page,
1378-
pageRouter,
1410+
pageRouterBasePathI18n,
13791411
}) => {
1380-
const response = await page.goto(new URL('static/not-found', pageRouter.url).href)
1412+
const response = await page.goto(
1413+
new URL('base/path/static/not-found', pageRouterBasePathI18n.url).href,
1414+
)
13811415
const headers = response?.headers() || {}
13821416
expect(response?.status()).toBe(404)
13831417

1384-
expect(await page.textContent('p')).toBe('Custom 404 page')
1418+
expect(await page.textContent('p')).toBe('Custom 404 page for locale: en')
13851419

13861420
expect(headers['debug-netlify-cdn-cache-control']).toBe(
13871421
nextVersionSatisfies('>=15.0.0-canary.187')
@@ -1390,4 +1424,36 @@ test.describe('Page Router with basePath and i18n', () => {
13901424
)
13911425
expect(headers['cache-control']).toBe('public,max-age=0,must-revalidate')
13921426
})
1427+
1428+
test.describe('static assets and function invocations', () => {
1429+
test('should return 200 for an existing static asset without invoking a function', async ({
1430+
page,
1431+
pageRouterBasePathI18n,
1432+
}) => {
1433+
// Since assets are hashed, we can't hardcode anything here. Find something to fetch.
1434+
const [staticAsset] = await readdir(
1435+
join(pageRouterBasePathI18n.isolatedFixtureRoot, '.next', 'static', 'chunks'),
1436+
)
1437+
expect(staticAsset).toBeDefined()
1438+
1439+
const response = await page.goto(
1440+
`${pageRouterBasePathI18n.url}/base/path/_next/static/chunks/${staticAsset}`,
1441+
)
1442+
1443+
expect(response?.status()).toBe(200)
1444+
expect(response?.headers()).not.toHaveProperty('x-nf-function-type')
1445+
})
1446+
1447+
test('should return 404 for a nonexistent static asset without invoking a function', async ({
1448+
page,
1449+
pageRouterBasePathI18n,
1450+
}) => {
1451+
const response = await page.goto(
1452+
`${pageRouterBasePathI18n.url}/base/path/_next/static/stale123abcdef.js`,
1453+
)
1454+
1455+
expect(response?.status()).toBe(404)
1456+
expect(response?.headers()).not.toHaveProperty('x-nf-function-type')
1457+
})
1458+
})
13931459
})

‎tests/utils/create-e2e-fixture.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ export interface DeployResult {
2121
deployID: string
2222
url: string
2323
logs: string
24+
isolatedFixtureRoot: string
2425
}
2526

2627
type PackageManager = 'npm' | 'pnpm' | 'yarn' | 'bun' | 'berry'
@@ -92,6 +93,7 @@ export const createE2EFixture = async (fixture: string, config: E2EConfig = {})
9293
cleanup: _cleanup,
9394
deployID: result.deployID,
9495
url: result.url,
96+
isolatedFixtureRoot: result.isolatedFixtureRoot,
9597
}
9698
} catch (error) {
9799
await _cleanup(true)
@@ -292,6 +294,7 @@ async function deploySite(
292294
url: `https://${deployID}--${siteName}.netlify.app`,
293295
deployID,
294296
logs: output,
297+
isolatedFixtureRoot,
295298
}
296299
}
297300

‎tests/utils/playwright-helpers.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ export const test = base.extend<
9898
if (response.url().includes('/_next/static/')) {
9999
expect(
100100
response.headers()['cache-control'],
101-
'_next/static assets should have immutable cache control',
101+
`_next/static asset (${response.url()}) should have immutable cache control`,
102102
).toContain('public,max-age=31536000,immutable')
103103
}
104104
})

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /