Skip to content

WIP: perf: Don't inject the entire nextConfig in edge templates #86630

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.

Sign up for GitHub

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

Draft
wants to merge 1 commit into
base: graphite-base/86630
Choose a base branch
from
Draft

WIP: perf: Don't inject the entire nextConfig in edge templates #86630

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 4 additions & 7 deletions crates/next-core/src/next_app/app_page_entry.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,17 +145,14 @@ async fn wrap_edge_page(
) -> Result<Vc<Box<dyn Module>>> {
const INNER: &str = "INNER_PAGE_ENTRY";

let next_config_val = &*next_config.await?;

let source = load_next_js_template(
"edge-ssr-app.js",
project_root.clone(),
&[("VAR_USERLAND", INNER), ("VAR_PAGE", &page.to_string())],
&[
// TODO do we really need to pass the entire next config here?
// This is bad for invalidation as any config change will invalidate this
("nextConfig", &*serde_json::to_string(next_config_val)?),
],
&[(
"cacheMaxMemorySize",
&*serde_json::to_string(&next_config.cache_max_memory_size().await?)?,
)],
&[("incrementalCacheHandler", None)],
)
.await?;
Expand Down
7 changes: 4 additions & 3 deletions crates/next-core/src/next_app/app_route_entry.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,13 +136,14 @@ async fn wrap_edge_route(
) -> Result<Vc<Box<dyn Module>>> {
let inner = rcstr!("INNER_ROUTE_ENTRY");

let next_config = &*next_config.await?;

let source = load_next_js_template(
"edge-app-route.js",
project_root.clone(),
&[("VAR_USERLAND", &*inner), ("VAR_PAGE", &page.to_string())],
&[("nextConfig", &*serde_json::to_string(next_config)?)],
&[(
"cacheLifeProfiles",
&*serde_json::to_string(&next_config.cache_life().await?)?,
)],
&[],
)
.await?;
Expand Down
71 changes: 12 additions & 59 deletions crates/next-core/src/next_config.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,10 +81,11 @@ pub struct NextConfig {
config_file: Option<RcStr>,
config_file_name: RcStr,

cache_life: Option<JsonValue>,
/// In-memory cache size in bytes.
///
/// If `cache_max_memory_size: 0` disables in-memory caching.
cache_max_memory_size: Option<f64>,
cache_max_memory_size: Option<JsonValue>,
/// custom path to a cache handler to use
cache_handler: Option<RcStr>,
cache_handlers: Option<FxIndexMap<RcStr, RcStr>>,
Expand Down Expand Up @@ -835,7 +836,6 @@ pub struct ExperimentalConfig {
adjust_font_fallbacks_with_size_adjust: Option<bool>,
after: Option<bool>,
app_document_preloading: Option<bool>,
cache_life: Option<FxIndexMap<String, CacheLifeProfile>>,
Copy link
Member Author

@bgw bgw Nov 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

An example of why this was a bad idea: This config was moved out of experimental, but Turbopack's config was never updated, so edge-app-route.ts​ was probably reading the wrong value when using Turbopack...

case_sensitive_routes: Option<bool>,
cpus: Option<f64>,
cra_compat: Option<bool>,
Expand Down Expand Up @@ -908,63 +908,6 @@ pub struct ExperimentalConfig {
devtool_segment_explorer: Option<bool>,
}

#[derive(
Clone, Debug, PartialEq, Serialize, Deserialize, TraceRawVcs, NonLocalValue, OperationValue,
)]
#[serde(rename_all = "camelCase")]
pub struct CacheLifeProfile {
#[serde(skip_serializing_if = "Option::is_none")]
pub stale: Option<u32>,
#[serde(skip_serializing_if = "Option::is_none")]
pub revalidate: Option<u32>,
#[serde(skip_serializing_if = "Option::is_none")]
pub expire: Option<u32>,
}
Comment on lines -915 to -922
Copy link
Member Author

@bgw bgw Nov 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't actually care what the contents of CacheLifeProfile are, only that we can round-trip it. So serde_json::Value seems like a much simpler/better choice.


#[test]
fn test_cache_life_profiles() {
let json = serde_json::json!({
"cacheLife": {
"frequent": {
"stale": 19,
"revalidate": 100,
},
}
});

let config: ExperimentalConfig = serde_json::from_value(json).unwrap();
let mut expected_cache_life = FxIndexMap::default();

expected_cache_life.insert(
"frequent".to_string(),
CacheLifeProfile {
stale: Some(19),
revalidate: Some(100),
expire: None,
},
);

assert_eq!(config.cache_life, Some(expected_cache_life));
}

#[test]
fn test_cache_life_profiles_invalid() {
let json = serde_json::json!({
"cacheLife": {
"invalid": {
"stale": "invalid_value",
},
}
});

let result: Result<ExperimentalConfig, _> = serde_json::from_value(json);

assert!(
result.is_err(),
"Deserialization should fail due to invalid 'stale' value type"
);
}

#[derive(
Clone, Debug, PartialEq, Eq, Serialize, Deserialize, TraceRawVcs, NonLocalValue, OperationValue,
)]
Expand Down Expand Up @@ -1312,6 +1255,16 @@ impl NextConfig {
Vc::cell(self.base_path.clone())
}

#[turbo_tasks::function]
pub fn cache_life(&self) -> Vc<OptionJsonValue> {
Vc::cell(self.cache_life.clone())
}

#[turbo_tasks::function]
pub fn cache_max_memory_size(&self) -> Vc<OptionJsonValue> {
Vc::cell(self.cache_max_memory_size.clone())
}

#[turbo_tasks::function]
pub fn cache_handler(&self, project_path: FileSystemPath) -> Result<Vc<OptionFileSystemPath>> {
if let Some(handler) = &self.cache_handler {
Expand Down
9 changes: 4 additions & 5 deletions crates/next-core/src/next_pages/page_entry.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,8 +223,6 @@ async fn wrap_edge_page(
const INNER_ERROR: &str = "INNER_ERROR";
const INNER_ERROR_500: &str = "INNER_500";

let next_config_val = &*next_config.await?;

let source = load_next_js_template(
"edge-ssr.js",
project_root.clone(),
Expand All @@ -236,9 +234,10 @@ async fn wrap_edge_page(
("VAR_MODULE_GLOBAL_ERROR", INNER_ERROR),
],
&[
// TODO do we really need to pass the entire next config here?
// This is bad for invalidation as any config change will invalidate this
("nextConfig", &*serde_json::to_string(next_config_val)?),
(
"cacheMaxMemorySize",
&*serde_json::to_string(&next_config.cache_max_memory_size().await?)?,
),
(
"pageRouteModuleOptions",
&serde_json::to_string(&get_route_module_options(page.clone(), pathname.clone()))?,
Expand Down
8 changes: 4 additions & 4 deletions packages/next/src/build/entries.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -621,7 +621,9 @@ export function getEdgeServerEntry(opts: {
absolutePagePath: opts.absolutePagePath,
page: opts.page,
appDirLoader: Buffer.from(opts.appDirLoader || '').toString('base64'),
nextConfig: Buffer.from(JSON.stringify(opts.config)).toString('base64'),
cacheLifeProfiles: Buffer.from(
JSON.stringify(opts.config.cacheLife)
).toString('base64'),
preferredRegion: opts.preferredRegion,
middlewareConfig: Buffer.from(
JSON.stringify(opts.middlewareConfig || {})
Expand Down Expand Up @@ -682,9 +684,7 @@ export function getEdgeServerEntry(opts: {
dev: opts.isDev,
isServerComponent: opts.isServerComponent,
page: opts.page,
stringifiedConfig: Buffer.from(JSON.stringify(opts.config)).toString(
'base64'
),
cacheMaxMemorySize: JSON.stringify(opts.config.cacheMaxMemorySize),
pagesType: opts.pagesType,
appDirLoader: Buffer.from(opts.appDirLoader || '').toString('base64'),
sriEnabled: !opts.isDev && !!opts.config.experimental.sri?.algorithm,
Expand Down
6 changes: 3 additions & 3 deletions packages/next/src/build/templates/edge-app-route.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ import { EdgeRouteModuleWrapper } from '../../server/web/edge-route-module-wrapp
import * as module from 'VAR_USERLAND'

// injected by the loader afterwards.
declare const nextConfig: NextConfigComplete
// INJECT:nextConfig
declare const cacheLifeProfiles: NextConfigComplete['cacheLife']
// INJECT:cacheLifeProfiles

const maybeJSONParse = (str?: string) => (str ? JSON.parse(str) : undefined)

Expand All @@ -26,7 +26,7 @@ if (rscManifest && rscServerManifest) {
export const ComponentMod = module

const handler: EdgeHandler = EdgeRouteModuleWrapper.wrap(module.routeModule, {
nextConfig,
cacheLifeProfiles,
page: 'VAR_PAGE',
})
export default handler
8 changes: 4 additions & 4 deletions packages/next/src/build/templates/edge-ssr-app.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ import { IncrementalCache } from '../../server/lib/incremental-cache'

import * as pageMod from 'VAR_USERLAND'

import type { NextConfigComplete } from '../../server/config-shared'
import { setManifestsSingleton } from '../../server/app-render/manifests-singleton'
import { initializeCacheHandlers } from '../../server/use-cache/handlers'
import { BaseServerSpan } from '../../server/lib/trace/constants'
Expand All @@ -29,12 +28,12 @@ import { checkIsOnDemandRevalidate } from '../../server/api-utils'
import { CloseController } from '../../server/web/web-on-close'

declare const incrementalCacheHandler: any
declare const nextConfig: NextConfigComplete
declare const cacheMaxMemorySize: number
// OPTIONAL_IMPORT:incrementalCacheHandler
// INJECT:nextConfig
// INJECT:cacheMaxMemorySize

// Initialize the cache handlers interface.
initializeCacheHandlers(nextConfig.cacheMaxMemorySize)
initializeCacheHandlers(cacheMaxMemorySize)

const maybeJSONParse = (str?: string) => (str ? JSON.parse(str) : undefined)

Expand Down Expand Up @@ -76,6 +75,7 @@ async function requestHandler(
const {
query,
params,
nextConfig,
buildId,
buildManifest,
prerenderManifest,
Expand Down
11 changes: 4 additions & 7 deletions packages/next/src/build/templates/edge-ssr.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ import RouteModule, {
} from '../../server/route-modules/pages/module'
import { WebNextRequest, WebNextResponse } from '../../server/base-http/web'

import type { NextConfigComplete } from '../../server/config-shared'
import type { NextFetchEvent } from '../../server/web/spec-extension/fetch-event'
import type RenderResult from '../../server/render-result'
import type { RenderResultMetadata } from '../../server/render-result'
Expand All @@ -31,20 +30,17 @@ import { BaseServerSpan } from '../../server/lib/trace/constants'
import { HTML_CONTENT_TYPE_HEADER } from '../../lib/constants'

// injected by the loader afterwards.
declare const nextConfig: NextConfigComplete
declare const cacheMaxMemorySize: number
declare const pageRouteModuleOptions: any
declare const errorRouteModuleOptions: any
declare const user500RouteModuleOptions: any
// INJECT:nextConfig
// INJECT:cacheMaxMemorySize
// INJECT:pageRouteModuleOptions
// INJECT:errorRouteModuleOptions
// INJECT:user500RouteModuleOptions

// Initialize the cache handlers interface.
initializeCacheHandlers(nextConfig.cacheMaxMemorySize)

// expose this for the route-module
;(globalThis as any).nextConfig = nextConfig
initializeCacheHandlers(cacheMaxMemorySize)

const pageMod = {
...userlandPage,
Expand Down Expand Up @@ -109,6 +105,7 @@ async function requestHandler(
const {
query,
params,
nextConfig,
buildId,
isNextDataRequest,
buildManifest,
Expand Down
10 changes: 5 additions & 5 deletions packages/next/src/build/webpack/loaders/next-edge-app-route-loader/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ export type EdgeAppRouteLoaderQuery = {
page: string
appDirLoader: string
preferredRegion: string | string[] | undefined
nextConfig: string
cacheLifeProfiles: string
middlewareConfig: string
cacheHandlers: string
}
Expand All @@ -24,7 +24,7 @@ const EdgeAppRouteLoader: webpack.LoaderDefinitionFunction<EdgeAppRouteLoaderQue
preferredRegion,
appDirLoader: appDirLoaderBase64 = '',
middlewareConfig: middlewareConfigBase64 = '',
nextConfig: nextConfigBase64,
cacheLifeProfiles: cacheLifeProfilesBase64,
cacheHandlers: cacheHandlersStringified,
} = this.getOptions()

Expand Down Expand Up @@ -64,8 +64,8 @@ const EdgeAppRouteLoader: webpack.LoaderDefinitionFunction<EdgeAppRouteLoaderQue
stringifiedPagePath.length - 1
)}?${WEBPACK_RESOURCE_QUERIES.edgeSSREntry}`

const stringifiedConfig = Buffer.from(
nextConfigBase64 || '',
const stringifiedCacheLifeProfiles = Buffer.from(
cacheLifeProfilesBase64 || '',
'base64'
).toString()

Expand All @@ -76,7 +76,7 @@ const EdgeAppRouteLoader: webpack.LoaderDefinitionFunction<EdgeAppRouteLoaderQue
VAR_PAGE: page,
},
{
nextConfig: stringifiedConfig,
cacheLifeProfiles: stringifiedCacheLifeProfiles,
}
)
}
Expand Down
12 changes: 4 additions & 8 deletions packages/next/src/build/webpack/loaders/next-edge-ssr-loader/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ export type EdgeSSRLoaderQuery = {
dev: boolean
isServerComponent: boolean
page: string
stringifiedConfig: string
cacheMaxMemorySize: string
appDirLoader?: string
pagesType: PAGE_TYPES
sriEnabled: boolean
Expand Down Expand Up @@ -73,7 +73,7 @@ const edgeSSRLoader: webpack.LoaderDefinitionFunction<EdgeSSRLoaderQuery> =
absolute500Path,
absoluteErrorPath,
isServerComponent,
stringifiedConfig: stringifiedConfigBase64,
cacheMaxMemorySize: cacheMaxMemorySizeStringified,
appDirLoader: appDirLoaderBase64,
pagesType,
cacheHandler,
Expand All @@ -94,10 +94,6 @@ const edgeSSRLoader: webpack.LoaderDefinitionFunction<EdgeSSRLoaderQuery> =
Buffer.from(middlewareConfigBase64, 'base64').toString()
)

const stringifiedConfig = Buffer.from(
stringifiedConfigBase64 || '',
'base64'
).toString()
const appDirLoader = Buffer.from(
appDirLoaderBase64 || '',
'base64'
Expand Down Expand Up @@ -161,7 +157,7 @@ const edgeSSRLoader: webpack.LoaderDefinitionFunction<EdgeSSRLoaderQuery> =
VAR_PAGE: page,
},
{
nextConfig: stringifiedConfig,
cacheMaxMemorySize: cacheMaxMemorySizeStringified,
},
{
incrementalCacheHandler: cacheHandler ?? null,
Expand All @@ -178,7 +174,7 @@ const edgeSSRLoader: webpack.LoaderDefinitionFunction<EdgeSSRLoaderQuery> =
VAR_MODULE_GLOBAL_ERROR: errorPath,
},
{
nextConfig: stringifiedConfig,
cacheMaxMemorySize: cacheMaxMemorySizeStringified,
pageRouteModuleOptions: JSON.stringify(getRouteModuleOptions(page)),
errorRouteModuleOptions: JSON.stringify(
getRouteModuleOptions('/_error')
Expand Down
Loading
Loading