Unverified Commit 582cb376 authored by Jiachi Liu's avatar Jiachi Liu Committed by GitHub

Fix: only contain middleware in dev middleware manifest (#39217)

x-ref #39199

The change in #39199 isn't correct. Middleware manifest should only contain middleware route, so that when router navigates, it only try to apply middleware instead of checking all edge routes. This PR also changes the middleware manifest global value from array to object for easier access

## Bug

- [ ] Related issues linked using `fixes #number`
- [x] Integration tests added
- [ ] Errors have helpful link attached, see `contributing.md`
parent f0df2c27
......@@ -11,7 +11,7 @@ import { createRouteLoader, getClientBuildManifest } from './route-loader'
declare global {
interface Window {
__DEV_MIDDLEWARE_MANIFEST?: [location: string, isSSR: boolean][]
__DEV_MIDDLEWARE_MANIFEST?: { location?: string }
__DEV_PAGES_MANIFEST?: { pages: string[] }
__SSG_MANIFEST_CB?: () => void
__SSG_MANIFEST?: Set<string>
......@@ -30,9 +30,7 @@ export default class PageLoader {
private assetPrefix: string
private promisedSsgManifest: Promise<Set<string>>
private promisedDevPagesManifest?: Promise<string[]>
private promisedMiddlewareManifest?: Promise<
[location: string, isSSR: boolean][]
>
private promisedMiddlewareManifest?: Promise<{ location: string }>
public routeLoader: RouteLoader
......@@ -81,12 +79,12 @@ export default class PageLoader {
}
}
getMiddlewareList() {
getMiddleware() {
if (process.env.NODE_ENV === 'production') {
const middlewareRegex = process.env.__NEXT_MIDDLEWARE_REGEX
window.__MIDDLEWARE_MANIFEST = middlewareRegex
? [[middlewareRegex, false]]
: []
? { location: middlewareRegex }
: undefined
return window.__MIDDLEWARE_MANIFEST
} else {
if (window.__DEV_MIDDLEWARE_MANIFEST) {
......@@ -99,7 +97,7 @@ export default class PageLoader {
`${this.assetPrefix}/_next/static/${this.buildId}/_devMiddlewareManifest.json`
)
.then((res) => res.json())
.then((manifest: [location: string, isSSR: boolean][]) => {
.then((manifest: { location?: string }) => {
window.__DEV_MIDDLEWARE_MANIFEST = manifest
return manifest
})
......
......@@ -13,7 +13,7 @@ declare global {
interface Window {
__BUILD_MANIFEST?: Record<string, string[]>
__BUILD_MANIFEST_CB?: Function
__MIDDLEWARE_MANIFEST?: [location: string, isSSR: boolean][]
__MIDDLEWARE_MANIFEST?: { location: string }
__MIDDLEWARE_MANIFEST_CB?: Function
}
}
......
......@@ -964,15 +964,16 @@ export default class DevServer extends Server {
type: 'route',
name: `_next/${CLIENT_STATIC_FILES_PATH}/${this.buildId}/${DEV_MIDDLEWARE_MANIFEST}`,
fn: async (_req, res) => {
const edgeRoutes = this.getEdgeFunctions().concat(
this.middleware ? [this.middleware] : []
)
res.statusCode = 200
res.setHeader('Content-Type', 'application/json; charset=utf-8')
res
.body(
JSON.stringify(
edgeRoutes.map((edgeRoute) => [edgeRoute.re!.source])
this.middleware
? {
location: this.middleware.re!.source,
}
: {}
)
)
.send()
......
......@@ -1159,7 +1159,7 @@ export default class Router implements BaseRouter {
;[pages, { __rewrites: rewrites }] = await Promise.all([
this.pageLoader.getPageList(),
getClientBuildManifest(),
this.pageLoader.getMiddlewareList(),
this.pageLoader.getMiddleware(),
])
} catch (err) {
// If we fail to resolve the page list or client-build manifest, we must
......@@ -2267,18 +2267,17 @@ interface MiddlewareEffectParams<T extends FetchDataOutput> {
function matchesMiddleware<T extends FetchDataOutput>(
options: MiddlewareEffectParams<T>
): Promise<boolean> {
return Promise.resolve(options.router.pageLoader.getMiddlewareList()).then(
(items) => {
return Promise.resolve(options.router.pageLoader.getMiddleware()).then(
(middleware) => {
const { pathname: asPathname } = parsePath(options.asPath)
const cleanedAs = hasBasePath(asPathname)
? removeBasePath(asPathname)
: asPathname
return !!items?.some(([regex, ssr]) => {
return (
!ssr && new RegExp(regex).test(addLocale(cleanedAs, options.locale))
)
})
const regex = middleware?.location
return (
!!regex && new RegExp(regex).test(addLocale(cleanedAs, options.locale))
)
}
)
}
......
......@@ -95,6 +95,15 @@ describe('Middleware Runtime', () => {
await browser.close()
}
})
it('should only contain middleware route in dev middleware manifest', async () => {
const res = await fetchViaHTTP(
next.url,
`/_next/static/${next.buildId}/_devMiddlewareManifest.json`
)
const { location } = await res.json()
expect(location).toBe('.*')
})
}
if ((global as any).isNextStart) {
......
......@@ -90,11 +90,12 @@ describe('Middleware can set the matcher in its config', () => {
: 'window.__MIDDLEWARE_MANIFEST'
)
return Array.isArray(manifest) &&
manifest?.[0]?.[0].includes('with-middleware') &&
manifest?.[0]?.[0].includes('another-middleware')
const { location } = manifest
return location &&
location.includes('with-middleware') &&
location.includes('another-middleware')
? 'success'
: manifest
: 'failed'
}, 'success')
})
......@@ -141,12 +142,12 @@ describe('using a single matcher', () => {
next = await createNext({
files: {
'pages/[...route].js': `
export default function Page({ message }) {
export default function Page({ message }) {
return <div>
<p>root page</p>
<p>{message}</p>
</div>
}
}
export const getServerSideProps = ({ params }) => {
return {
......@@ -222,11 +223,11 @@ describe('using a single matcher with i18n', () => {
next = await createNext({
files: {
'pages/index.js': `
export default function Page({ message }) {
export default function Page({ message }) {
return <div>
<p>{message}</p>
</div>
}
}
export const getServerSideProps = ({ params, locale }) => ({
props: { message: \`(\${locale}) Hello from /\` }
})
......@@ -237,7 +238,7 @@ describe('using a single matcher with i18n', () => {
<p>catchall page</p>
<p>{message}</p>
</div>
}
}
export const getServerSideProps = ({ params, locale }) => ({
props: { message: \`(\${locale}) Hello from /\` + params.route.join("/") }
})
......@@ -311,12 +312,12 @@ describe('using a single matcher with i18n and basePath', () => {
next = await createNext({
files: {
'pages/index.js': `
export default function Page({ message }) {
export default function Page({ message }) {
return <div>
<p>root page</p>
<p>{message}</p>
</div>
}
}
export const getServerSideProps = ({ params, locale }) => ({
props: { message: \`(\${locale}) Hello from /\` }
})
......@@ -327,7 +328,7 @@ describe('using a single matcher with i18n and basePath', () => {
<p>catchall page</p>
<p>{message}</p>
</div>
}
}
export const getServerSideProps = ({ params, locale }) => ({
props: { message: \`(\${locale}) Hello from /\` + params.route.join("/") }
})
......
......@@ -61,21 +61,13 @@ describe('Switchable runtime', () => {
if ((global as any).isNextDev) {
describe('Switchable runtime (dev)', () => {
it('should include edge api routes and edge ssr routes into dev middleware manifest', async () => {
it('should not include edge api routes and edge ssr routes into dev middleware manifest', async () => {
const res = await fetchViaHTTP(
next.url,
`/_next/static/${next.buildId}/_devMiddlewareManifest.json`
)
const routesMatchers = await res.json()
expect(
routesMatchers.some((matcher) =>
matcher[0].startsWith('^\\/api\\/edge')
)
).toBe(true)
expect(
routesMatchers.some((matcher) => matcher[0].startsWith('^\\/edge'))
).toBe(true)
const devMiddlewareManifest = await res.json()
expect(devMiddlewareManifest).toEqual({})
})
it.skip('should support client side navigation to ssr rsc pages', async () => {
......
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