Unverified Commit e820e92d authored by OJ Kwon's avatar OJ Kwon Committed by GitHub

fext(next-core): inherit root layout segment config for the routes (#63683)

### What

Supports root segment config inherit from layout. Currently route
segment config only runs agasint own source, so individual route segment
config works but if the config is set in layout level it is being
ignored. PR introduces root segment and pass into each route if tree
level have a corresponding layout.

Closes PACK-2839
parent 00e9cf9d
......@@ -4,6 +4,7 @@ use anyhow::{Context, Result};
use indexmap::IndexSet;
use next_core::{
all_assets_from_entries,
app_segment_config::NextSegmentConfig,
app_structure::{
get_entrypoints, Entrypoint as AppEntrypoint, Entrypoints as AppEntrypoints, LoaderTree,
MetadataItem,
......@@ -30,6 +31,7 @@ use next_core::{
get_server_module_options_context, get_server_resolve_options_context,
get_server_runtime_entries, ServerContextType,
},
parse_segment_config_from_source,
util::NextRuntime,
};
use serde::{Deserialize, Serialize};
......@@ -522,11 +524,15 @@ pub fn app_entry_point_to_route(
})
.collect(),
),
AppEntrypoint::AppRoute { page, path } => Route::AppRoute {
AppEntrypoint::AppRoute {
page,
path,
root_layouts,
} => Route::AppRoute {
original_name: page.to_string(),
endpoint: Vc::upcast(
AppEndpoint {
ty: AppEndpointType::Route { path },
ty: AppEndpointType::Route { path, root_layouts },
app_project,
page,
}
......@@ -562,6 +568,7 @@ enum AppEndpointType {
},
Route {
path: Vc<FileSystemPath>,
root_layouts: Vc<Vec<Vc<FileSystemPath>>>,
},
Metadata {
metadata: MetadataItem,
......@@ -590,15 +597,34 @@ impl AppEndpoint {
}
#[turbo_tasks::function]
fn app_route_entry(&self, path: Vc<FileSystemPath>) -> Vc<AppEntry> {
get_app_route_entry(
async fn app_route_entry(
&self,
path: Vc<FileSystemPath>,
root_layouts: Vc<Vec<Vc<FileSystemPath>>>,
) -> Result<Vc<AppEntry>> {
let root_layouts = root_layouts.await?;
let config = if root_layouts.is_empty() {
None
} else {
let mut config = NextSegmentConfig::default();
for layout in root_layouts.iter().rev() {
let source = Vc::upcast(FileSource::new(*layout));
let layout_config = parse_segment_config_from_source(source);
config.apply_parent_config(&*layout_config.await?);
}
Some(config.cell())
};
Ok(get_app_route_entry(
self.app_project.route_module_context(),
self.app_project.edge_route_module_context(),
Vc::upcast(FileSource::new(path)),
self.page.clone(),
self.app_project.project().project_path(),
None,
)
config,
))
}
#[turbo_tasks::function]
......@@ -631,7 +657,9 @@ impl AppEndpoint {
// NOTE(alexkirsz) For routes, technically, a lot of the following code is not needed,
// as we know we won't have any client references. However, for now, for simplicity's
// sake, we just do the same thing as for pages.
AppEndpointType::Route { path } => (self.app_route_entry(path), false, false),
AppEndpointType::Route { path, root_layouts } => {
(self.app_route_entry(path, root_layouts), false, false)
}
AppEndpointType::Metadata { metadata } => {
(self.app_metadata_entry(metadata), false, false)
}
......
......@@ -63,8 +63,8 @@ pub enum NextRevalidate {
},
}
#[turbo_tasks::value]
#[derive(Debug, Default)]
#[turbo_tasks::value(into = "shared")]
#[derive(Debug, Default, Clone)]
pub struct NextSegmentConfig {
pub dynamic: Option<NextSegmentDynamic>,
pub dynamic_params: Option<bool>,
......@@ -349,11 +349,10 @@ fn parse_config_value(
JsValue::Constant(ConstantValue::Str(str)) if str.as_str() == "force-cache" => {
config.revalidate = Some(NextRevalidate::ForceCache);
}
_ => invalid_config(
"`revalidate` needs to be static false, static 'force-cache' or a static \
positive integer",
&value,
),
_ => {
//noop; revalidate validation occurs in runtime at
//https://github.com/vercel/next.js/blob/cd46c221d2b7f796f963d2b81eea1e405023db23/packages/next/src/server/lib/patch-fetch.ts#L20
}
}
}
"fetchCache" => {
......@@ -444,6 +443,7 @@ pub async fn parse_segment_config_from_loader_tree(
for tree in parallel_configs {
config.apply_parallel_config(&tree)?;
}
for component in [components.page, components.default, components.layout]
.into_iter()
.flatten()
......
......@@ -472,6 +472,7 @@ pub enum Entrypoint {
AppRoute {
page: AppPage,
path: Vc<FileSystemPath>,
root_layouts: Vc<Vec<Vc<FileSystemPath>>>,
},
AppMetadata {
page: AppPage,
......@@ -602,11 +603,16 @@ fn add_app_route(
result: &mut IndexMap<AppPath, Entrypoint>,
page: AppPage,
path: Vc<FileSystemPath>,
root_layouts: Vc<Vec<Vc<FileSystemPath>>>,
) {
let e = match result.entry(page.clone().into()) {
Entry::Occupied(e) => e,
Entry::Vacant(e) => {
e.insert(Entrypoint::AppRoute { page, path });
e.insert(Entrypoint::AppRoute {
page,
path,
root_layouts,
});
return;
}
};
......@@ -682,6 +688,7 @@ pub fn get_entrypoints(
app_dir,
get_directory_tree(app_dir, page_extensions),
get_global_metadata(app_dir, page_extensions),
Default::default(),
)
}
......@@ -690,6 +697,7 @@ fn directory_tree_to_entrypoints(
app_dir: Vc<FileSystemPath>,
directory_tree: Vc<DirectoryTree>,
global_metadata: Vc<GlobalMetadata>,
root_layouts: Vc<Vec<Vc<FileSystemPath>>>,
) -> Vc<Entrypoints> {
directory_tree_to_entrypoints_internal(
app_dir,
......@@ -697,6 +705,7 @@ fn directory_tree_to_entrypoints(
"".to_string(),
directory_tree,
AppPage::new(),
root_layouts,
)
}
......@@ -932,6 +941,7 @@ async fn directory_tree_to_entrypoints_internal(
directory_name: String,
directory_tree: Vc<DirectoryTree>,
app_page: AppPage,
root_layouts: Vc<Vec<Vc<FileSystemPath>>>,
) -> Result<Vc<Entrypoints>> {
let span = tracing::info_span!("build layout trees", name = display(&app_page));
directory_tree_to_entrypoints_internal_untraced(
......@@ -940,6 +950,7 @@ async fn directory_tree_to_entrypoints_internal(
directory_name,
directory_tree,
app_page,
root_layouts,
)
.instrument(span)
.await
......@@ -951,6 +962,7 @@ async fn directory_tree_to_entrypoints_internal_untraced(
directory_name: String,
directory_tree: Vc<DirectoryTree>,
app_page: AppPage,
root_layouts: Vc<Vec<Vc<FileSystemPath>>>,
) -> Result<Vc<Entrypoints>> {
let mut result = IndexMap::new();
......@@ -959,8 +971,17 @@ async fn directory_tree_to_entrypoints_internal_untraced(
let subdirectories = &directory_tree.subdirectories;
let components = directory_tree.components.await?.clone_value();
// Route can have its own segment config, also can inherit from the layout root
// segment config. https://nextjs.org/docs/app/building-your-application/rendering/edge-and-nodejs-runtimes#segment-runtime-option
// Pass down layouts from each tree to apply segment config when adding route.
let root_layouts = if let Some(layout) = components.layout {
let mut layouts = (*root_layouts.await?).clone();
layouts.push(layout);
Vc::cell(layouts)
} else {
root_layouts
};
// if let Some(_) = components.page.or(components.default) {
if components.page.is_some() {
let app_path = AppPath::from(app_page.clone());
......@@ -989,6 +1010,7 @@ async fn directory_tree_to_entrypoints_internal_untraced(
&mut result,
app_page.complete(PageType::Route)?,
route,
root_layouts,
);
}
......@@ -1097,6 +1119,7 @@ async fn directory_tree_to_entrypoints_internal_untraced(
subdir_name.to_string(),
subdirectory,
child_app_page.clone(),
root_layouts,
)
.await?;
......@@ -1156,8 +1179,12 @@ async fn directory_tree_to_entrypoints_internal_untraced(
.await?;
}
}
Entrypoint::AppRoute { ref page, path } => {
add_app_route(app_dir, &mut result, page.clone(), path);
Entrypoint::AppRoute {
ref page,
path,
root_layouts,
} => {
add_app_route(app_dir, &mut result, page.clone(), path, root_layouts);
}
Entrypoint::AppMetadata { ref page, metadata } => {
add_app_metadata_route(app_dir, &mut result, page.clone(), metadata);
......
......@@ -6,7 +6,7 @@
#![feature(arbitrary_self_types)]
#![feature(iter_intersperse)]
mod app_segment_config;
pub mod app_segment_config;
pub mod app_structure;
mod babel;
mod bootstrap;
......
......@@ -39,8 +39,15 @@ pub async fn get_app_route_entry(
project_root: Vc<FileSystemPath>,
original_segment_config: Option<Vc<NextSegmentConfig>>,
) -> Result<Vc<AppEntry>> {
let config =
original_segment_config.unwrap_or_else(|| parse_segment_config_from_source(source));
let segment_from_source = parse_segment_config_from_source(source);
let config = if let Some(original_segment_config) = original_segment_config {
let mut segment_config = (*segment_from_source.await?).clone();
segment_config.apply_parent_config(&*original_segment_config.await?);
segment_config.into()
} else {
segment_from_source
};
let is_edge = matches!(config.await?.runtime, Some(NextRuntime::Edge));
let context = if is_edge {
edge_context
......
......@@ -3367,12 +3367,11 @@
"app dir - draft mode in nodejs runtime should not perform full page navigation on router.refresh()",
"app dir - draft mode in nodejs runtime should read other cookies when draft mode enabled",
"app dir - draft mode in nodejs runtime should use initial rand when draft mode is disabled on /index",
"app dir - draft mode in nodejs runtime should use initial rand when draft mode is disabled on /with-cookies"
],
"failed": [
"app dir - draft mode in nodejs runtime should use initial rand when draft mode is disabled on /with-cookies",
"app dir - draft mode in edge runtime should genenerate rand when draft mode enabled",
"app dir - draft mode in edge runtime should read other cookies when draft mode enabled"
],
"failed": [],
"pending": [],
"flakey": [],
"runtimeError": false
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