Unverified Commit cb44b43c authored by Sebastian "Sebbie" Silbermann's avatar Sebastian "Sebbie" Silbermann Committed by GitHub

Use page extensions in next-swc transforms applying to pages (#90650)

Co-authored-by: 's avatarCursor Agent <cursoragent@cursor.com>
Co-authored-by: 's avatarNiklas Mischkulnig <4586894+mischnic@users.noreply.github.com>
Co-authored-by: 's avatarvercel[bot] <35613825+vercel[bot]@users.noreply.github.com>
parent 1bc8f559
......@@ -32,6 +32,12 @@ pub async fn get_next_client_transforms_rules(
let modularize_imports_config = &next_config.modularize_imports().await?;
let enable_mdx_rs = next_config.mdx_rs().await?.is_some();
let page_extensions: Vec<String> = next_config
.page_extensions()
.await?
.iter()
.map(|s| s.to_string())
.collect();
if !foreign_code {
rules.push(get_next_lint_transform_rule(enable_mdx_rs));
......@@ -77,6 +83,7 @@ pub async fn get_next_client_transforms_rules(
ExportFilter::StripDataExports,
enable_mdx_rs,
vec![],
&page_extensions,
)?);
rules.push(get_next_disallow_export_all_in_page_rule(
enable_mdx_rs,
......
......@@ -39,6 +39,12 @@ pub async fn get_next_server_transforms_rules(
let modularize_imports_config = &next_config.modularize_imports().await?;
let mdx_rs = next_config.mdx_rs().await?.is_some();
let page_extensions: Vec<String> = next_config
.page_extensions()
.await?
.iter()
.map(|s| s.to_string())
.collect();
if !foreign_code {
rules.push(get_next_lint_transform_rule(mdx_rs));
......@@ -87,6 +93,7 @@ pub async fn get_next_server_transforms_rules(
vec![RuleCondition::ReferenceType(ReferenceType::Entry(
EntryReferenceSubType::PageData,
))],
&page_extensions,
)?);
}
false
......@@ -149,7 +156,10 @@ pub async fn get_next_server_transforms_rules(
};
if is_app_dir {
rules.push(get_next_debug_instant_stack_rule(mdx_rs));
rules.push(get_next_debug_instant_stack_rule(
mdx_rs,
page_extensions.clone(),
));
}
if is_app_dir &&
......
......@@ -8,9 +8,14 @@ use turbopack_ecmascript::{CustomTransformer, EcmascriptInputTransform, Transfor
use super::module_rule_match_js_no_url;
pub fn get_next_debug_instant_stack_rule(enable_mdx_rs: bool) -> ModuleRule {
pub fn get_next_debug_instant_stack_rule(
enable_mdx_rs: bool,
page_extensions: Vec<String>,
) -> ModuleRule {
let transform =
EcmascriptInputTransform::Plugin(ResolvedVc::cell(Box::new(NextDebugInstantStack {}) as _));
EcmascriptInputTransform::Plugin(ResolvedVc::cell(Box::new(NextDebugInstantStack {
page_extensions,
}) as _));
ModuleRule::new(
module_rule_match_js_no_url(enable_mdx_rs),
......@@ -23,13 +28,18 @@ pub fn get_next_debug_instant_stack_rule(enable_mdx_rs: bool) -> ModuleRule {
}
#[derive(Debug)]
struct NextDebugInstantStack {}
struct NextDebugInstantStack {
page_extensions: Vec<String>,
}
#[async_trait]
impl CustomTransformer for NextDebugInstantStack {
#[tracing::instrument(level = tracing::Level::TRACE, name = "debug_instant_stack", skip_all)]
async fn transform(&self, program: &mut Program, ctx: &TransformContext<'_>) -> Result<()> {
program.mutate(debug_instant_stack(ctx.file_path_str.to_string()));
program.mutate(debug_instant_stack(
ctx.file_path_str.to_string(),
self.page_extensions.clone(),
));
Ok(())
}
}
......@@ -37,6 +37,12 @@ pub async fn get_next_react_server_components_transform_rule(
let cache_components_enabled = *next_config.enable_cache_components().await?;
let use_cache_enabled = *next_config.enable_use_cache().await?;
let taint_enabled = *next_config.enable_taint().await?;
let page_extensions = next_config
.page_extensions()
.await?
.iter()
.map(|s| s.to_string())
.collect::<Vec<_>>();
Ok(get_ecma_transform_rule(
Box::new(NextJsReactServerComponents::new(
is_react_server_layer,
......@@ -44,6 +50,7 @@ pub async fn get_next_react_server_components_transform_rule(
use_cache_enabled,
taint_enabled,
app_dir,
page_extensions,
)),
enable_mdx_rs,
EcmascriptTransformStage::Preprocess,
......@@ -57,6 +64,7 @@ struct NextJsReactServerComponents {
use_cache_enabled: bool,
taint_enabled: bool,
app_dir: Option<FileSystemPath>,
page_extensions: Vec<String>,
}
impl NextJsReactServerComponents {
......@@ -66,6 +74,7 @@ impl NextJsReactServerComponents {
use_cache_enabled: bool,
taint_enabled: bool,
app_dir: Option<FileSystemPath>,
page_extensions: Vec<String>,
) -> Self {
Self {
is_react_server_layer,
......@@ -73,6 +82,7 @@ impl NextJsReactServerComponents {
use_cache_enabled,
taint_enabled,
app_dir,
page_extensions,
}
}
}
......@@ -94,6 +104,7 @@ impl CustomTransformer for NextJsReactServerComponents {
cache_components_enabled: self.cache_components_enabled,
use_cache_enabled: self.use_cache_enabled,
taint_enabled: self.taint_enabled,
page_extensions: self.page_extensions.clone(),
}),
self.app_dir.as_ref().map(|path| path.path.clone().into()),
);
......
......@@ -17,25 +17,28 @@ pub fn get_next_pages_transforms_rule(
export_filter: ExportFilter,
enable_mdx_rs: bool,
extra_conditions: Vec<RuleCondition>,
page_extensions: &[String],
) -> Result<ModuleRule> {
// Apply the Next SSG transform to all pages.
let strip_transform =
EcmascriptInputTransform::Plugin(ResolvedVc::cell(Box::new(NextJsStripPageExports {
export_filter,
}) as _));
let document_exclusions: Vec<RuleCondition> = page_extensions
.iter()
.map(|ext| {
Ok(RuleCondition::ResourcePathEquals(
pages_dir.join(&format!("_document.{ext}"))?,
))
})
.collect::<Result<Vec<_>>>()?;
let conditions = RuleCondition::all(vec![
RuleCondition::all(vec![
RuleCondition::ResourcePathInExactDirectory(pages_dir.clone()),
RuleCondition::not(RuleCondition::ResourcePathInExactDirectory(
pages_dir.join("api")?,
)),
RuleCondition::not(RuleCondition::any(vec![
// TODO(alexkirsz): Possibly ignore _app as well?
RuleCondition::ResourcePathEquals(pages_dir.join("_document.js")?),
RuleCondition::ResourcePathEquals(pages_dir.join("_document.jsx")?),
RuleCondition::ResourcePathEquals(pages_dir.join("_document.ts")?),
RuleCondition::ResourcePathEquals(pages_dir.join("_document.tsx")?),
])),
RuleCondition::not(RuleCondition::any(document_exclusions)),
]),
module_rule_match_js_no_url(enable_mdx_rs),
RuleCondition::all(extra_conditions),
......
......@@ -350,6 +350,12 @@ where
),
crate::transforms::debug_instant_stack::debug_instant_stack(
file_path_for_instant_stack,
match &opts.server_components {
Some(react_server_components::Config::WithOptions(options)) => {
options.page_extensions.clone()
}
_ => vec![],
},
),
visit_mut_pass(crate::transforms::pure::pure_magic(comments.clone())),
Optional::new(
......
use once_cell::sync::Lazy;
use regex::Regex;
use swc_core::{
common::{Span, Spanned},
......@@ -9,20 +8,30 @@ use swc_core::{
quote,
};
/// Only apply to page/layout segment files.
static PAGE_OR_LAYOUT_RE: Lazy<Regex> =
Lazy::new(|| Regex::new(r"[\\/](page|layout|default)\.(ts|js)x?$").unwrap());
fn build_page_extensions_regex(page_extensions: &[String]) -> String {
if page_extensions.is_empty() {
"(ts|js)x?".to_string()
} else {
let escaped: Vec<String> = page_extensions
.iter()
.map(|ext| regex::escape(ext))
.collect();
format!("({})", escaped.join("|"))
}
}
pub fn debug_instant_stack(filepath: String) -> impl Pass {
pub fn debug_instant_stack(filepath: String, page_extensions: Vec<String>) -> impl Pass {
visit_mut_pass(DebugInstantStack {
filepath,
instant_export_span: None,
page_extensions,
})
}
struct DebugInstantStack {
filepath: String,
instant_export_span: Option<Span>,
page_extensions: Vec<String>,
}
/// Given an export specifier, returns `Some((exported_name, local_name))` if
......@@ -73,7 +82,10 @@ fn find_var_init_span(items: &[ModuleItem], local_name: &str) -> Option<Span> {
impl VisitMut for DebugInstantStack {
fn visit_mut_module_items(&mut self, items: &mut Vec<ModuleItem>) {
if !PAGE_OR_LAYOUT_RE.is_match(&self.filepath) {
let ext_pattern = build_page_extensions_regex(&self.page_extensions);
let page_or_layout_re =
Regex::new(&format!(r"[\\/](page|layout|default)\.{ext_pattern}$")).unwrap();
if !page_or_layout_re.is_match(&self.filepath) {
return;
}
......
......@@ -10,6 +10,18 @@ use once_cell::sync::Lazy;
use regex::Regex;
use rustc_hash::FxHashMap;
use serde::Deserialize;
fn build_page_extensions_regex(page_extensions: &[String]) -> String {
if page_extensions.is_empty() {
"(ts|js)x?".to_string()
} else {
let escaped: Vec<String> = page_extensions
.iter()
.map(|ext| regex::escape(ext))
.collect();
format!("({})", escaped.join("|"))
}
}
use swc_core::{
atoms::{Atom, Wtf8Atom, atom},
common::{
......@@ -55,6 +67,8 @@ pub struct Options {
pub use_cache_enabled: bool,
#[serde(default)]
pub taint_enabled: bool,
#[serde(default)]
pub page_extensions: Vec<String>,
}
/// A visitor that transforms given module to use module proxy if it's a React
......@@ -69,6 +83,7 @@ struct ReactServerComponents<C: Comments> {
filepath: String,
app_dir: Option<PathBuf>,
comments: C,
page_extensions: Vec<String>,
}
#[derive(Clone, Debug)]
......@@ -137,6 +152,7 @@ impl<C: Comments> VisitMut for ReactServerComponents<C> {
self.taint_enabled,
self.filepath.clone(),
self.app_dir.clone(),
self.page_extensions.clone(),
);
module.visit_with(&mut validator);
......@@ -604,6 +620,7 @@ struct ReactServerComponentValidator {
pub module_directive: Option<ModuleDirective>,
pub export_names: Vec<Atom>,
imports: ImportMap,
page_extensions: Vec<String>,
}
impl ReactServerComponentValidator {
......@@ -614,6 +631,7 @@ impl ReactServerComponentValidator {
taint_enabled: bool,
filename: String,
app_dir: Option<PathBuf>,
page_extensions: Vec<String>,
) -> Self {
Self {
is_react_server_layer,
......@@ -715,6 +733,7 @@ impl ReactServerComponentValidator {
"experimental_taintUniqueValue",
],
imports: ImportMap::default(),
page_extensions,
}
}
......@@ -824,10 +843,10 @@ impl ReactServerComponentValidator {
if self.is_from_node_modules(&self.filepath) {
return;
}
static RE: Lazy<Regex> =
Lazy::new(|| Regex::new(r"[\\/]((global-)?error)\.(ts|js)x?$").unwrap());
let ext_pattern = build_page_extensions_regex(&self.page_extensions);
let re = Regex::new(&format!(r"[\\/]((global-)?error)\.{ext_pattern}$")).unwrap();
let is_error_file = RE.is_match(&self.filepath);
let is_error_file = re.is_match(&self.filepath);
if is_error_file
&& let Some(app_dir) = &self.app_dir
......@@ -888,9 +907,9 @@ impl ReactServerComponentValidator {
if self.is_from_node_modules(&self.filepath) {
return;
}
static RE: Lazy<Regex> =
Lazy::new(|| Regex::new(r"[\\/](page|layout|route)\.(ts|js)x?$").unwrap());
let is_app_entry = RE.is_match(&self.filepath);
let ext_pattern = build_page_extensions_regex(&self.page_extensions);
let re = Regex::new(&format!(r"[\\/](page|layout|route)\.{ext_pattern}$")).unwrap();
let is_app_entry = re.is_match(&self.filepath);
if is_app_entry {
let mut possibly_invalid_exports: FxIndexMap<Atom, (InvalidExportKind, Span)> =
......@@ -1177,6 +1196,10 @@ pub fn server_components_assert(
Config::WithOptions(x) => x.taint_enabled,
_ => false,
};
let page_extensions: Vec<String> = match &config {
Config::WithOptions(x) => x.page_extensions.clone(),
_ => vec![],
};
let filename = match filename {
FileName::Custom(path) => format!("<{path}>"),
_ => filename.to_string(),
......@@ -1188,6 +1211,7 @@ pub fn server_components_assert(
taint_enabled,
filename,
app_dir,
page_extensions,
)
}
......@@ -1215,6 +1239,10 @@ pub fn server_components<C: Comments>(
Config::WithOptions(x) => x.taint_enabled,
_ => false,
};
let page_extensions: Vec<String> = match &config {
Config::WithOptions(x) => x.page_extensions.clone(),
_ => vec![],
};
visit_mut_pass(ReactServerComponents {
is_react_server_layer,
cache_components_enabled,
......@@ -1226,5 +1254,6 @@ pub fn server_components<C: Comments>(
_ => filename.to_string(),
},
app_dir,
page_extensions,
})
}
......@@ -115,6 +115,7 @@ fn react_server_components_errors(input: PathBuf) {
cache_components_enabled,
use_cache_enabled,
taint_enabled,
page_extensions: vec![],
}),
tr.comments.as_ref().clone(),
app_dir.clone(),
......@@ -174,6 +175,7 @@ fn react_server_actions_errors(input: PathBuf) {
cache_components_enabled: true,
use_cache_enabled: true,
taint_enabled: true,
page_extensions: vec![],
}),
tr.comments.as_ref().clone(),
None,
......@@ -243,6 +245,7 @@ fn use_cache_not_allowed(input: PathBuf) {
cache_components_enabled: false,
use_cache_enabled: false,
taint_enabled: true,
page_extensions: vec![],
}),
tr.comments.as_ref().clone(),
None,
......
......@@ -455,6 +455,7 @@ fn react_server_components_typescript(input: PathBuf) {
cache_components_enabled: false,
use_cache_enabled: false,
taint_enabled: true,
page_extensions: vec![],
}),
tr.comments.as_ref().clone(),
None,
......@@ -489,6 +490,7 @@ fn react_server_components_fixture(input: PathBuf) {
cache_components_enabled: false,
use_cache_enabled: false,
taint_enabled: true,
page_extensions: vec![],
}),
tr.comments.as_ref().clone(),
None,
......@@ -876,7 +878,7 @@ fn test_debug_instant_stack(input: PathBuf) {
test_fixture(
syntax(),
&|_| debug_instant_stack("app/page.js".to_string()),
&|_| debug_instant_stack("app/page.js".to_string(), vec![]),
&input,
&output,
FixtureTestConfig {
......
......@@ -75,6 +75,7 @@ function getBaseSWCOptions({
useCacheEnabled,
taintEnabled,
trackDynamicImports,
pageExtensions,
}: {
filename: string
jest?: boolean
......@@ -97,6 +98,7 @@ function getBaseSWCOptions({
useCacheEnabled?: boolean
taintEnabled?: boolean
trackDynamicImports?: boolean
pageExtensions?: string[]
}) {
const isReactServerLayer = shouldUseReactServerCondition(bundleLayer)
const isAppRouterPagesLayer = isWebpackAppPagesLayer(bundleLayer)
......@@ -220,6 +222,7 @@ function getBaseSWCOptions({
cacheComponentsEnabled: isCacheComponents,
useCacheEnabled,
taintEnabled,
pageExtensions: pageExtensions || [],
}
: undefined,
serverActions:
......@@ -407,6 +410,7 @@ export function getLoaderSWCOptions({
useCacheEnabled,
taintEnabled,
trackDynamicImports,
pageExtensions,
}: {
filename: string
development: boolean
......@@ -435,6 +439,7 @@ export function getLoaderSWCOptions({
useCacheEnabled?: boolean
taintEnabled?: boolean
trackDynamicImports?: boolean
pageExtensions?: string[]
}) {
let baseOptions: any = getBaseSWCOptions({
filename,
......@@ -457,6 +462,7 @@ export function getLoaderSWCOptions({
useCacheEnabled,
taintEnabled,
trackDynamicImports,
pageExtensions,
})
baseOptions.fontLoaders = {
fontLoaders: ['next/font/local', 'next/font/google'],
......
......@@ -169,6 +169,7 @@ async function loaderTransform(
useCacheEnabled: nextConfig.experimental?.useCache,
taintEnabled: nextConfig.experimental?.taint,
trackDynamicImports,
pageExtensions: nextConfig.pageExtensions,
})
const programmaticOptions = {
......
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