Escape the '.' in '.json' when making static data routes.

[creationix]

Problem

When generating route regular expressions for data routes, some code paths appear to not escape the . in .json. This causes routing to be slightly slower, prevents some optimizations related to static postfixes, and potentially allows for unintended request paths to be accepted as value.

Solution

After much tracing and digging, I found a code path writing regular expressions directly without escaping. In this case the solution is to escape the . using \\. when generating static data routes.

A simple next app was made to exercise this path with a route pages/server-time.tsx that contains a simple getServerSideProps.

import type { InferGetServerSidePropsType, GetServerSideProps } from 'next'
 
type TimeDate = {
  timestamp: number
}
 
export const getServerSideProps = (async () => {
  return { props: { timestamp: Date.now() } }
}) satisfies GetServerSideProps<TimeDate>
 
export default function Page({
  timestamp,
}: InferGetServerSidePropsType<typeof getServerSideProps>) {
  return (
    <main>
      <p>{new Date(timestamp).toUTCString()}</p>
    </main>
  )
}

Before the change, the generated route regexp was "^/_next/data/[build_id]/server-time.json$", but after then change it becomes "^/_next/data/[build_id]/server-time\\.json$"

The related tests were updated to expect properly escaped \\.json$ endings to the regexps.

[ijjk]

Tests Passed

[ijjk]

Stats from current PR

Default Build (Increase detected ⚠️)

General

	vercel/next.js canary	vercel/next.js creationix/fix-static-data-route-json-escape	Change
buildDuration	44.8s	41.7s	N/A
buildDurationCached	39.2s	33.8s	N/A
nodeModulesSize	410 MB	410 MB	N/A
nextStartRea..uration (ms)	1.1s	944ms	N/A

Client Bundles (main, webpack)

	vercel/next.js canary	vercel/next.js creationix/fix-static-data-route-json-escape	Change
1187-HASH.js gzip	50.8 kB	50.8 kB	N/A
8276.HASH.js gzip	169 B	168 B	N/A
8377-HASH.js gzip	5.36 kB	5.36 kB	N/A
bccd1874-HASH.js gzip	53 kB	53 kB	N/A
framework-HASH.js gzip	57.5 kB	57.5 kB	N/A
main-app-HASH.js gzip	232 B	235 B	N/A
main-HASH.js gzip	34 kB	34 kB	N/A
webpack-HASH.js gzip	1.71 kB	1.71 kB	N/A
Overall change	0 B	0 B	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	vercel/next.js creationix/fix-static-data-route-json-escape	Change
polyfills-HASH.js gzip	39.4 kB	39.4 kB	✓
Overall change	39.4 kB	39.4 kB	✓

Client Pages

	vercel/next.js canary	vercel/next.js creationix/fix-static-data-route-json-escape	Change
_app-HASH.js gzip	193 B	193 B	✓
_error-HASH.js gzip	193 B	193 B	✓
amp-HASH.js gzip	512 B	510 B	N/A
css-HASH.js gzip	343 B	342 B	N/A
dynamic-HASH.js gzip	1.84 kB	1.84 kB	✓
edge-ssr-HASH.js gzip	265 B	265 B	✓
head-HASH.js gzip	363 B	362 B	N/A
hooks-HASH.js gzip	393 B	392 B	N/A
image-HASH.js gzip	4.49 kB	4.49 kB	N/A
index-HASH.js gzip	268 B	268 B	✓
link-HASH.js gzip	2.35 kB	2.34 kB	N/A
routerDirect..HASH.js gzip	328 B	328 B	✓
script-HASH.js gzip	397 B	397 B	✓
withRouter-HASH.js gzip	323 B	326 B	N/A
1afbb74e6ecf..834.css gzip	106 B	106 B	✓
Overall change	3.59 kB	3.59 kB	✓

Client Build Manifests

	vercel/next.js canary	vercel/next.js creationix/fix-static-data-route-json-escape	Change
_buildManifest.js gzip	747 B	746 B	N/A
Overall change	0 B	0 B	✓

Rendered Page Sizes

	vercel/next.js canary	vercel/next.js creationix/fix-static-data-route-json-escape	Change
index.html gzip	524 B	522 B	N/A
link.html gzip	539 B	537 B	N/A
withRouter.html gzip	520 B	519 B	N/A
Overall change	0 B	0 B	✓

Edge SSR bundle Size

	vercel/next.js canary	vercel/next.js creationix/fix-static-data-route-json-escape	Change
edge-ssr.js gzip	128 kB	128 kB	N/A
page.js gzip	203 kB	203 kB	N/A
Overall change	0 B	0 B	✓

Middleware size

	vercel/next.js canary	vercel/next.js creationix/fix-static-data-route-json-escape	Change
middleware-b..fest.js gzip	671 B	668 B	N/A
middleware-r..fest.js gzip	155 B	156 B	N/A
middleware.js gzip	31.2 kB	31.2 kB	N/A
edge-runtime..pack.js gzip	844 B	844 B	✓
Overall change	844 B	844 B	✓

Next Runtimes

	vercel/next.js canary	vercel/next.js creationix/fix-static-data-route-json-escape	Change
523-experime...dev.js gzip	322 B	322 B	✓
523.runtime.dev.js gzip	314 B	314 B	✓
app-page-exp...dev.js gzip	323 kB	323 kB	✓
app-page-exp..prod.js gzip	127 kB	127 kB	✓
app-page-tur..prod.js gzip	140 kB	140 kB	✓
app-page-tur..prod.js gzip	135 kB	135 kB	✓
app-page.run...dev.js gzip	313 kB	313 kB	✓
app-page.run..prod.js gzip	123 kB	123 kB	✓
app-route-ex...dev.js gzip	37.3 kB	37.3 kB	✓
app-route-ex..prod.js gzip	25.4 kB	25.4 kB	✓
app-route-tu..prod.js gzip	25.4 kB	25.4 kB	✓
app-route-tu..prod.js gzip	25.2 kB	25.2 kB	✓
app-route.ru...dev.js gzip	38.9 kB	38.9 kB	✓
app-route.ru..prod.js gzip	25.2 kB	25.2 kB	✓
pages-api-tu..prod.js gzip	9.67 kB	9.67 kB	✓
pages-api.ru...dev.js gzip	11.6 kB	11.6 kB	✓
pages-api.ru..prod.js gzip	9.66 kB	9.66 kB	✓
pages-turbo...prod.js gzip	21.7 kB	21.7 kB	✓
pages.runtim...dev.js gzip	27.4 kB	27.4 kB	✓
pages.runtim..prod.js gzip	21.7 kB	21.7 kB	✓
server.runti..prod.js gzip	916 kB	916 kB	✓
Overall change	2.36 MB	2.36 MB	✓

build cache Overall increase ⚠️

	vercel/next.js canary	vercel/next.js creationix/fix-static-data-route-json-escape	Change
0.pack gzip	2.06 MB	2.05 MB	N/A
index.pack gzip	71.4 kB	72.1 kB	⚠️ +680 B
Overall change	71.4 kB	72.1 kB	⚠️ +680 B

Diff details

Diff for main-HASH.js

Diff too large to display

Commit: 029e3d6