Unverified Commit 7e81d13a authored by JJ Kasper's avatar JJ Kasper Committed by GitHub

Add experimental config for middleware (#30154)

* Add experimental config for middleware

* Apply suggestions from code review
Co-authored-by: 's avatarSteven <steven@ceriously.com>
Co-authored-by: 's avatarSteven <steven@ceriously.com>
parent 25908cf9
...@@ -121,7 +121,7 @@ export function createEntrypoints( ...@@ -121,7 +121,7 @@ export function createEntrypoints(
const isLikeServerless = isTargetLikeServerless(target) const isLikeServerless = isTargetLikeServerless(target)
if (page.match(MIDDLEWARE_ROUTE)) { if (page.match(MIDDLEWARE_ROUTE) && config.experimental.middleware) {
const loaderOpts: MiddlewareLoaderOptions = { const loaderOpts: MiddlewareLoaderOptions = {
absolutePagePath: pages[page], absolutePagePath: pages[page],
page, page,
......
...@@ -284,6 +284,14 @@ export default async function build( ...@@ -284,6 +284,14 @@ export default async function build(
) )
) )
const pageKeys = Object.keys(mappedPages) const pageKeys = Object.keys(mappedPages)
const hasMiddleware = pageKeys.some((page) => MIDDLEWARE_ROUTE.test(page))
if (hasMiddleware && !config.experimental.middleware) {
console.warn(
`Warning: detected _middleware page but the "experimental.middleware" config was not enabled. Please enable it in ${config.configFileName}`
)
}
const conflictingPublicFiles: string[] = [] const conflictingPublicFiles: string[] = []
const hasCustomErrorPage: boolean = const hasCustomErrorPage: boolean =
mappedPages['/_error'].startsWith('private-next-pages') mappedPages['/_error'].startsWith('private-next-pages')
...@@ -1710,24 +1718,26 @@ export default async function build( ...@@ -1710,24 +1718,26 @@ export default async function build(
) )
} }
const middlewareManifest: MiddlewareManifest = JSON.parse( if (config.experimental.middleware) {
await promises.readFile( const middlewareManifest: MiddlewareManifest = JSON.parse(
path.join(distDir, SERVER_DIRECTORY, MIDDLEWARE_MANIFEST), await promises.readFile(
'utf8' path.join(distDir, SERVER_DIRECTORY, MIDDLEWARE_MANIFEST),
'utf8'
)
) )
)
await promises.writeFile( await promises.writeFile(
path.join( path.join(
distDir, distDir,
CLIENT_STATIC_FILES_PATH, CLIENT_STATIC_FILES_PATH,
buildId, buildId,
'_middlewareManifest.js' '_middlewareManifest.js'
), ),
`self.__MIDDLEWARE_MANIFEST=${devalue( `self.__MIDDLEWARE_MANIFEST=${devalue(
middlewareManifest.sortedMiddleware middlewareManifest.sortedMiddleware
)};self.__MIDDLEWARE_MANIFEST_CB&&self.__MIDDLEWARE_MANIFEST_CB()` )};self.__MIDDLEWARE_MANIFEST_CB&&self.__MIDDLEWARE_MANIFEST_CB()`
) )
}
const images = { ...config.images } const images = { ...config.images }
const { deviceSizes, imageSizes } = images const { deviceSizes, imageSizes } = images
......
...@@ -946,6 +946,7 @@ export default async function getBaseWebpackConfig( ...@@ -946,6 +946,7 @@ export default async function getBaseWebpackConfig(
parallel: config.experimental.cpus, parallel: config.experimental.cpus,
swcMinify: config.experimental.swcMinify, swcMinify: config.experimental.swcMinify,
terserOptions, terserOptions,
middlewareEnabled: config.experimental.middleware,
}).apply(compiler) }).apply(compiler)
}, },
// Minify CSS // Minify CSS
...@@ -1196,6 +1197,9 @@ export default async function getBaseWebpackConfig( ...@@ -1196,6 +1197,9 @@ export default async function getBaseWebpackConfig(
}), }),
'process.env.__NEXT_ROUTER_BASEPATH': JSON.stringify(config.basePath), 'process.env.__NEXT_ROUTER_BASEPATH': JSON.stringify(config.basePath),
'process.env.__NEXT_HAS_REWRITES': JSON.stringify(hasRewrites), 'process.env.__NEXT_HAS_REWRITES': JSON.stringify(hasRewrites),
'process.env.__NEXT_HAS_MIDDLEWARE': JSON.stringify(
config.experimental.middleware
),
'process.env.__NEXT_I18N_SUPPORT': JSON.stringify(!!config.i18n), 'process.env.__NEXT_I18N_SUPPORT': JSON.stringify(!!config.i18n),
'process.env.__NEXT_I18N_DOMAINS': JSON.stringify(config.i18n?.domains), 'process.env.__NEXT_I18N_DOMAINS': JSON.stringify(config.i18n?.domains),
'process.env.__NEXT_ANALYTICS_ID': JSON.stringify(config.analyticsId), 'process.env.__NEXT_ANALYTICS_ID': JSON.stringify(config.analyticsId),
...@@ -1274,7 +1278,9 @@ export default async function getBaseWebpackConfig( ...@@ -1274,7 +1278,9 @@ export default async function getBaseWebpackConfig(
new PagesManifestPlugin({ serverless: isLikeServerless, dev }), new PagesManifestPlugin({ serverless: isLikeServerless, dev }),
// MiddlewarePlugin should be after DefinePlugin so NEXT_PUBLIC_* // MiddlewarePlugin should be after DefinePlugin so NEXT_PUBLIC_*
// replacement is done before its process.env.* handling // replacement is done before its process.env.* handling
!isServer && new MiddlewarePlugin({ dev }), !isServer &&
config.experimental.middleware &&
new MiddlewarePlugin({ dev }),
isServer && new NextJsSsrImportPlugin(), isServer && new NextJsSsrImportPlugin(),
!isServer && !isServer &&
new BuildManifestPlugin({ new BuildManifestPlugin({
......
...@@ -49,13 +49,20 @@ function buildError(error, file) { ...@@ -49,13 +49,20 @@ function buildError(error, file) {
export class TerserPlugin { export class TerserPlugin {
constructor(options = {}) { constructor(options = {}) {
const { cacheDir, terserOptions = {}, parallel, swcMinify } = options const {
cacheDir,
terserOptions = {},
parallel,
swcMinify,
middlewareEnabled,
} = options
this.options = { this.options = {
swcMinify, swcMinify,
cacheDir, cacheDir,
parallel, parallel,
terserOptions, terserOptions,
middlewareEnabled,
} }
} }
...@@ -99,15 +106,17 @@ export class TerserPlugin { ...@@ -99,15 +106,17 @@ export class TerserPlugin {
} }
// remove below if we start minifying middleware chunks // remove below if we start minifying middleware chunks
if (name.startsWith('static/chunks/webpack-')) { if (this.options.middlewareEnabled) {
webpackAsset = name if (name.startsWith('static/chunks/webpack-')) {
} webpackAsset = name
}
// don't minify _middleware as it can break in some cases // don't minify _middleware as it can break in some cases
// and doesn't provide too much of a benefit as it's server-side // and doesn't provide too much of a benefit as it's server-side
if (name.match(/(middleware-chunks|_middleware\.js$)/)) { if (name.match(/(middleware-chunks|_middleware\.js$)/)) {
hasMiddleware = true hasMiddleware = true
return false return false
}
} }
const { info } = res const { info } = res
......
...@@ -85,27 +85,31 @@ export default class PageLoader { ...@@ -85,27 +85,31 @@ export default class PageLoader {
} }
getMiddlewareList(): Promise<string[]> { getMiddlewareList(): Promise<string[]> {
if (process.env.NODE_ENV === 'production') { if (process.env.__NEXT_HAS_MIDDLEWARE) {
return getMiddlewareManifest() if (process.env.NODE_ENV === 'production') {
} else { return getMiddlewareManifest()
if ((window as any).__DEV_MIDDLEWARE_MANIFEST) {
return (window as any).__DEV_MIDDLEWARE_MANIFEST
} else { } else {
if (!this.promisedMiddlewareManifest) { if ((window as any).__DEV_MIDDLEWARE_MANIFEST) {
this.promisedMiddlewareManifest = fetch( return (window as any).__DEV_MIDDLEWARE_MANIFEST
`${this.assetPrefix}/_next/static/${this.buildId}/_devMiddlewareManifest.json` } else {
) if (!this.promisedMiddlewareManifest) {
.then((res) => res.json()) this.promisedMiddlewareManifest = fetch(
.then((manifest) => { `${this.assetPrefix}/_next/static/${this.buildId}/_devMiddlewareManifest.json`
;(window as any).__DEV_MIDDLEWARE_MANIFEST = manifest )
return manifest .then((res) => res.json())
}) .then((manifest) => {
.catch((err) => { ;(window as any).__DEV_MIDDLEWARE_MANIFEST = manifest
console.log(`Failed to fetch _devMiddlewareManifest`, err) return manifest
}) })
.catch((err) => {
console.log(`Failed to fetch _devMiddlewareManifest`, err)
})
}
return this.promisedMiddlewareManifest
} }
return this.promisedMiddlewareManifest
} }
} else {
return Promise.resolve([])
} }
} }
......
...@@ -232,27 +232,32 @@ export function getClientBuildManifest(): Promise<ClientBuildManifest> { ...@@ -232,27 +232,32 @@ export function getClientBuildManifest(): Promise<ClientBuildManifest> {
markAssetError(new Error('Failed to load client build manifest')) markAssetError(new Error('Failed to load client build manifest'))
) )
} }
let _getMiddlewareManifest = () => Promise.resolve([])
export function getMiddlewareManifest(): Promise<any> { if (process.env.__NEXT_HAS_MIDDLEWARE) {
if (self.__MIDDLEWARE_MANIFEST) { _getMiddlewareManifest = async () => {
return Promise.resolve(self.__MIDDLEWARE_MANIFEST) if (self.__MIDDLEWARE_MANIFEST) {
} return Promise.resolve(self.__MIDDLEWARE_MANIFEST)
const onMiddlewareManifest: Promise<any> = new Promise<any>((resolve) => {
const cb = self.__MIDDLEWARE_MANIFEST_CB
self.__MIDDLEWARE_MANIFEST_CB = () => {
resolve(self.__MIDDLEWARE_MANIFEST!)
cb && cb()
} }
})
return resolvePromiseWithTimeout( const onMiddlewareManifest: Promise<any> = new Promise<any>((resolve) => {
onMiddlewareManifest, const cb = self.__MIDDLEWARE_MANIFEST_CB
MS_MAX_IDLE_DELAY, self.__MIDDLEWARE_MANIFEST_CB = () => {
markAssetError(new Error('Failed to load client middleware manifest')) resolve(self.__MIDDLEWARE_MANIFEST!)
) cb && cb()
}
})
return resolvePromiseWithTimeout(
onMiddlewareManifest,
MS_MAX_IDLE_DELAY,
markAssetError(new Error('Failed to load client middleware manifest'))
)
}
} }
export const getMiddlewareManifest = _getMiddlewareManifest
interface RouteFiles { interface RouteFiles {
scripts: string[] scripts: string[]
css: string[] css: string[]
......
...@@ -119,6 +119,7 @@ export type NextConfig = { [key: string]: any } & { ...@@ -119,6 +119,7 @@ export type NextConfig = { [key: string]: any } & {
staticPageGenerationTimeout?: number staticPageGenerationTimeout?: number
crossOrigin?: false | 'anonymous' | 'use-credentials' crossOrigin?: false | 'anonymous' | 'use-credentials'
experimental?: { experimental?: {
middleware?: boolean
swcMinify?: boolean swcMinify?: boolean
swcLoader?: boolean swcLoader?: boolean
cpus?: number cpus?: number
...@@ -203,6 +204,7 @@ export const defaultConfig: NextConfig = { ...@@ -203,6 +204,7 @@ export const defaultConfig: NextConfig = {
}, },
staticPageGenerationTimeout: 60, staticPageGenerationTimeout: 60,
experimental: { experimental: {
middleware: false,
swcLoader: false, swcLoader: false,
swcMinify: false, swcMinify: false,
cpus: Math.max( cpus: Math.max(
......
...@@ -265,10 +265,12 @@ export default class DevServer extends Server { ...@@ -265,10 +265,12 @@ export default class DevServer extends Server {
routedPages.push(pageName) routedPages.push(pageName)
} }
this.middleware = getSortedRoutes(routedMiddleware).map((page) => ({ if (this.nextConfig.experimental.middleware) {
match: getRouteMatcher(getMiddlewareRegex(page)), this.middleware = getSortedRoutes(routedMiddleware).map((page) => ({
page, match: getRouteMatcher(getMiddlewareRegex(page)),
})) page,
}))
}
try { try {
// we serve a separate manifest with all pages for the client in // we serve a separate manifest with all pages for the client in
...@@ -691,25 +693,27 @@ export default class DevServer extends Server { ...@@ -691,25 +693,27 @@ export default class DevServer extends Server {
}, },
}) })
fsRoutes.unshift({ if (this.nextConfig.experimental.middleware) {
match: route( fsRoutes.unshift({
`/_next/${CLIENT_STATIC_FILES_PATH}/${this.buildId}/${DEV_MIDDLEWARE_MANIFEST}` match: route(
), `/_next/${CLIENT_STATIC_FILES_PATH}/${this.buildId}/${DEV_MIDDLEWARE_MANIFEST}`
type: 'route', ),
name: `_next/${CLIENT_STATIC_FILES_PATH}/${this.buildId}/${DEV_MIDDLEWARE_MANIFEST}`, type: 'route',
fn: async (_req, res) => { name: `_next/${CLIENT_STATIC_FILES_PATH}/${this.buildId}/${DEV_MIDDLEWARE_MANIFEST}`,
res.statusCode = 200 fn: async (_req, res) => {
res.setHeader('Content-Type', 'application/json; charset=utf-8') res.statusCode = 200
res.end( res.setHeader('Content-Type', 'application/json; charset=utf-8')
JSON.stringify( res.end(
this.middleware?.map((middleware) => middleware.page) || [] JSON.stringify(
this.middleware?.map((middleware) => middleware.page) || []
)
) )
) return {
return { finished: true,
finished: true, }
} },
}, })
}) }
fsRoutes.push({ fsRoutes.push({
match: route('/:path*'), match: route('/:path*'),
......
...@@ -281,7 +281,7 @@ export default class Server { ...@@ -281,7 +281,7 @@ export default class Server {
if (!dev) { if (!dev) {
this.pagesManifest = require(pagesManifestPath) this.pagesManifest = require(pagesManifestPath)
if (!this.minimalMode) { if (!this.minimalMode && this.nextConfig.experimental.middleware) {
this.middlewareManifest = require(middlewareManifestPath) this.middlewareManifest = require(middlewareManifestPath)
} }
} }
...@@ -569,6 +569,9 @@ export default class Server { ...@@ -569,6 +569,9 @@ export default class Server {
} }
protected getMiddleware() { protected getMiddleware() {
if (!this.nextConfig.experimental.middleware) {
return []
}
return Object.keys(this.middlewareManifest?.middleware || {}).map( return Object.keys(this.middlewareManifest?.middleware || {}).map(
(page) => ({ (page) => ({
match: getRouteMatcher(getMiddlewareRegex(page)), match: getRouteMatcher(getMiddlewareRegex(page)),
...@@ -1082,7 +1085,7 @@ export default class Server { ...@@ -1082,7 +1085,7 @@ export default class Server {
let catchAllMiddleware: Route | undefined let catchAllMiddleware: Route | undefined
if (!this.minimalMode) { if (!this.minimalMode && this.nextConfig.experimental.middleware) {
catchAllMiddleware = { catchAllMiddleware = {
match: route('/:path*'), match: route('/:path*'),
type: 'route', type: 'route',
......
This diff is collapsed.
module.exports = { module.exports = {
basePath: '/root', basePath: '/root',
experimental: {
middleware: true,
},
} }
...@@ -3,4 +3,7 @@ module.exports = { ...@@ -3,4 +3,7 @@ module.exports = {
locales: ['en', 'fr', 'nl'], locales: ['en', 'fr', 'nl'],
defaultLocale: 'en', defaultLocale: 'en',
}, },
experimental: {
middleware: true,
},
} }
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