Commit 4b8a1987 authored by Niklas Mischkulnig's avatar Niklas Mischkulnig Committed by Niklas Mischkulnig

Implement CSS Module tree shaking via lightningcss unused_symbols

For `.module.css` files, pass the list of unused CSS class names
(derived from BindingUsageInfo.used_exports on the owning EcmascriptCssModule)
to lightningcss MinifyOptions::unused_symbols, which removes the corresponding
CSS rules at build time. Global CSS files are unaffected.
Co-Authored-By: 's avatarClaude <noreply@anthropic.com>
parent 844af6c9
...@@ -23,7 +23,7 @@ use crate::{ ...@@ -23,7 +23,7 @@ use crate::{
code_gen::CodeGenerateable, code_gen::CodeGenerateable,
process::{ process::{
CssWithPlaceholderResult, FinalCssResult, ParseCss, ParseCssResult, ProcessCss, CssWithPlaceholderResult, FinalCssResult, ParseCss, ParseCssResult, ProcessCss,
finalize_css, parse_css, process_css_with_placeholder, finalize_css, finalize_css_module, parse_css, process_css_with_placeholder,
}, },
references::{ references::{
compose::CssModuleComposeReference, import::ImportAssetReference, url::ReferencedAsset, compose::CssModuleComposeReference, import::ImportAssetReference, url::ReferencedAsset,
...@@ -43,6 +43,11 @@ pub struct CssModule { ...@@ -43,6 +43,11 @@ pub struct CssModule {
ty: CssModuleType, ty: CssModuleType,
environment: Option<ResolvedVc<Environment>>, environment: Option<ResolvedVc<Environment>>,
lightningcss_features: LightningCssFeatureFlags, lightningcss_features: LightningCssFeatureFlags,
/// For CSS Modules (`.module.css`), the owning [`EcmascriptCssModule`] that exports class
/// names. Used to retrieve export usage info for CSS tree shaking.
///
/// [`EcmascriptCssModule`]: crate::EcmascriptCssModule
ecmascript_module: Option<ResolvedVc<Box<dyn Module>>>,
} }
#[turbo_tasks::value_impl] #[turbo_tasks::value_impl]
...@@ -56,6 +61,7 @@ impl CssModule { ...@@ -56,6 +61,7 @@ impl CssModule {
import_context: Option<ResolvedVc<ImportContext>>, import_context: Option<ResolvedVc<ImportContext>>,
environment: Option<ResolvedVc<Environment>>, environment: Option<ResolvedVc<Environment>>,
lightningcss_features: LightningCssFeatureFlags, lightningcss_features: LightningCssFeatureFlags,
ecmascript_module: Option<ResolvedVc<Box<dyn Module>>>,
) -> Vc<Self> { ) -> Vc<Self> {
Self::cell(CssModule { Self::cell(CssModule {
source, source,
...@@ -64,9 +70,34 @@ impl CssModule { ...@@ -64,9 +70,34 @@ impl CssModule {
ty, ty,
environment, environment,
lightningcss_features, lightningcss_features,
ecmascript_module,
}) })
} }
/// Returns a copy of this module with the given [`EcmascriptCssModule`] as its owner.
///
/// Used by [`EcmascriptCssModule`] to give the inner [`CssModule`] a back-reference so that
/// the CSS chunk item can query export usage for CSS tree shaking.
///
/// [`EcmascriptCssModule`]: crate::EcmascriptCssModule
#[turbo_tasks::function]
pub async fn with_ecmascript_module(
self: Vc<Self>,
module: ResolvedVc<Box<dyn Module>>,
) -> Result<Vc<Self>> {
let this = self.await?;
Ok(CssModule {
source: this.source,
asset_context: this.asset_context,
import_context: this.import_context,
ty: this.ty,
environment: this.environment,
lightningcss_features: this.lightningcss_features,
ecmascript_module: Some(module),
}
.cell())
}
/// Returns the asset ident of the source without the "css" modifier /// Returns the asset ident of the source without the "css" modifier
#[turbo_tasks::function] #[turbo_tasks::function]
pub fn source_ident(&self) -> Vc<AssetIdent> { pub fn source_ident(&self) -> Vc<AssetIdent> {
...@@ -128,6 +159,32 @@ impl ProcessCss for CssModule { ...@@ -128,6 +159,32 @@ impl ProcessCss for CssModule {
this.lightningcss_features, this.lightningcss_features,
)) ))
} }
#[turbo_tasks::function]
async fn finalize_css_module(
self: Vc<Self>,
chunking_context: Vc<Box<dyn ChunkingContext>>,
minify_type: MinifyType,
ecmascript_module: Vc<Box<dyn Module>>,
) -> Result<Vc<FinalCssResult>> {
let process_result = self.get_css_with_placeholder();
let this = self.await?;
let origin_source_map =
match ResolvedVc::try_sidecast::<Box<dyn GenerateSourceMap>>(this.source) {
Some(gsm) => gsm.generate_source_map(),
None => FileContent::NotFound.cell(),
};
Ok(finalize_css_module(
process_result,
chunking_context,
minify_type,
origin_source_map,
this.environment.as_deref().copied(),
this.lightningcss_features,
ecmascript_module,
))
}
} }
#[turbo_tasks::value_impl] #[turbo_tasks::value_impl]
...@@ -179,6 +236,24 @@ impl StyleModule for CssModule { ...@@ -179,6 +236,24 @@ impl StyleModule for CssModule {
} }
} }
#[turbo_tasks::value_impl]
impl CssModule {
#[turbo_tasks::function]
async fn as_chunk_item_impl(
self: ResolvedVc<Self>,
module_graph: Vc<ModuleGraph>,
chunking_context: Vc<Box<dyn ChunkingContext>>,
) -> Result<Vc<CssModuleChunkItem>> {
let ecmascript_module = self.await?.ecmascript_module;
Ok(CssModuleChunkItem::cell(CssModuleChunkItem {
module: self,
module_graph: module_graph.to_resolved().await?,
chunking_context: chunking_context.to_resolved().await?,
ecmascript_module,
}))
}
}
#[turbo_tasks::value_impl] #[turbo_tasks::value_impl]
impl ChunkableModule for CssModule { impl ChunkableModule for CssModule {
#[turbo_tasks::function] #[turbo_tasks::function]
...@@ -187,11 +262,7 @@ impl ChunkableModule for CssModule { ...@@ -187,11 +262,7 @@ impl ChunkableModule for CssModule {
module_graph: ResolvedVc<ModuleGraph>, module_graph: ResolvedVc<ModuleGraph>,
chunking_context: ResolvedVc<Box<dyn ChunkingContext>>, chunking_context: ResolvedVc<Box<dyn ChunkingContext>>,
) -> Vc<Box<dyn turbopack_core::chunk::ChunkItem>> { ) -> Vc<Box<dyn turbopack_core::chunk::ChunkItem>> {
Vc::upcast(CssModuleChunkItem::cell(CssModuleChunkItem { Vc::upcast(self.as_chunk_item_impl(*module_graph, *chunking_context))
module: self,
module_graph,
chunking_context,
}))
} }
} }
...@@ -216,6 +287,11 @@ struct CssModuleChunkItem { ...@@ -216,6 +287,11 @@ struct CssModuleChunkItem {
module: ResolvedVc<CssModule>, module: ResolvedVc<CssModule>,
module_graph: ResolvedVc<ModuleGraph>, module_graph: ResolvedVc<ModuleGraph>,
chunking_context: ResolvedVc<Box<dyn ChunkingContext>>, chunking_context: ResolvedVc<Box<dyn ChunkingContext>>,
/// For CSS Modules (`.module.css`), the owning [`EcmascriptCssModule`] that exports class
/// names. Used to query export usage info for CSS tree shaking.
///
/// [`EcmascriptCssModule`]: crate::EcmascriptCssModule
ecmascript_module: Option<ResolvedVc<Box<dyn Module>>>,
} }
#[turbo_tasks::value_impl] #[turbo_tasks::value_impl]
...@@ -334,10 +410,16 @@ impl CssChunkItem for CssModuleChunkItem { ...@@ -334,10 +410,16 @@ impl CssChunkItem for CssModuleChunkItem {
} }
} }
let result = self let minify_type = *chunking_context.minify_type().await?;
.module let result = if let Some(ecmascript_module) = self.ecmascript_module {
.finalize_css(*chunking_context, *chunking_context.minify_type().await?) self.module
.await?; .finalize_css_module(*chunking_context, minify_type, *ecmascript_module)
.await?
} else {
self.module
.finalize_css(*chunking_context, minify_type)
.await?
};
if let FinalCssResult::Ok { if let FinalCssResult::Ok {
output_code, output_code,
......
...@@ -28,6 +28,7 @@ use turbopack_ecmascript::{ ...@@ -28,6 +28,7 @@ use turbopack_ecmascript::{
}; };
use crate::{ use crate::{
CssModule,
process::{CssWithPlaceholderResult, ProcessCss}, process::{CssWithPlaceholderResult, ProcessCss},
references::{compose::CssModuleComposeReference, internal::InternalCssAssetReference}, references::{compose::CssModuleComposeReference, internal::InternalCssAssetReference},
}; };
...@@ -83,6 +84,7 @@ impl Module for EcmascriptCssModule { ...@@ -83,6 +84,7 @@ impl Module for EcmascriptCssModule {
// 1. @import or composes references are loaded first // 1. @import or composes references are loaded first
// 2. The local CSS is loaded last // 2. The local CSS is loaded last
let self_resolved = self.to_resolved().await?;
let references = self let references = self
.module_references() .module_references()
.await? .await?
...@@ -94,12 +96,28 @@ impl Module for EcmascriptCssModule { ...@@ -94,12 +96,28 @@ impl Module for EcmascriptCssModule {
.try_into_module() .try_into_module()
.await? .await?
{ {
Some(inner) => Some( Some(inner) => {
InternalCssAssetReference::new(*inner) // Give the inner CssModule a back-reference to this EcmascriptCssModule
.to_resolved() // so that its CSS chunk item can query export usage for tree shaking.
.await let inner = if let Some(css_module) =
.map(ResolvedVc::upcast)?, ResolvedVc::try_downcast_type::<CssModule>(inner)
), {
ResolvedVc::upcast(
css_module
.with_ecmascript_module(*ResolvedVc::upcast(self_resolved))
.to_resolved()
.await?,
)
} else {
inner
};
Some(
InternalCssAssetReference::new(*inner)
.to_resolved()
.await
.map(ResolvedVc::upcast)?,
)
}
None => None, None => None,
}, },
) )
......
...@@ -27,6 +27,8 @@ use turbopack_core::{ ...@@ -27,6 +27,8 @@ use turbopack_core::{
AdditionalIssueSource, Issue, IssueExt, IssueSeverity, IssueSource, IssueStage, AdditionalIssueSource, Issue, IssueExt, IssueSeverity, IssueSource, IssueStage,
StyledString, StyledString,
}, },
module::Module,
module_graph::binding_usage_info::ModuleExportUsageInfo,
reference::ModuleReferences, reference::ModuleReferences,
reference_type::ImportContext, reference_type::ImportContext,
resolve::origin::ResolveOrigin, resolve::origin::ResolveOrigin,
...@@ -340,6 +342,143 @@ pub async fn finalize_css( ...@@ -340,6 +342,143 @@ pub async fn finalize_css(
} }
} }
/// Like [`finalize_css`], but also performs CSS tree shaking for CSS Modules by removing CSS rules
/// for class names that are unused according to the JS module binding analysis.
///
/// The `ecmascript_module` parameter is the [`EcmascriptCssModule`] that owns this CSS, used to
/// query [`ChunkingContext::module_export_usage`] and determine which class names are actually
/// referenced in JS.
///
/// [`EcmascriptCssModule`]: crate::EcmascriptCssModule
#[turbo_tasks::function]
pub async fn finalize_css_module(
result: Vc<CssWithPlaceholderResult>,
chunking_context: Vc<Box<dyn ChunkingContext>>,
minify_type: MinifyType,
origin_source_map: Vc<FileContent>,
environment: Option<ResolvedVc<Environment>>,
feature_flags: LightningCssFeatureFlags,
ecmascript_module: Vc<Box<dyn Module>>,
) -> Result<Vc<FinalCssResult>> {
let result = result.await?;
match &*result {
CssWithPlaceholderResult::Ok {
parse_result,
url_references,
exports,
..
} => {
let (mut stylesheet, code) = match &*parse_result.await? {
ParseCssResult::Ok {
stylesheet,
options,
code,
..
} => (stylesheet_into_static(stylesheet, options.clone()), *code),
ParseCssResult::Unparsable => return Ok(FinalCssResult::Unparsable.cell()),
ParseCssResult::NotFound => return Ok(FinalCssResult::NotFound.cell()),
};
let url_references = *url_references;
let mut url_map = FxHashMap::default();
for (src, reference) in (*url_references.await?).iter() {
let resolved = resolve_url_reference(**reference, chunking_context).await?;
if let Some(v) = resolved.as_ref().cloned() {
url_map.insert(RcStr::from(src.as_str()), v);
}
}
replace_url_references(&mut stylesheet, &url_map);
// CSS tree shaking: remove rules for unused CSS classes.
//
// We query the binding usage info for the owning EcmascriptCssModule to determine
// which JS export names (= CSS class original names) are actually referenced. Any
// class whose original name is not used gets its hashed CSS name added to the
// `unused_symbols` set passed to lightningcss, which then removes the corresponding
// CSS rules.
if let Some(exports) = exports {
let export_usage = chunking_context
.module_export_usage(ecmascript_module)
.await?;
if !export_usage.is_circuit_breaker {
let export_usage_info = export_usage.export_usage.await?;
let unused_symbols: std::collections::HashSet<String> =
match &*export_usage_info {
// All exports used, or unknown — keep every class.
ModuleExportUsageInfo::All => Default::default(),
// Some or no exports used — collect hashed names of unused classes.
ModuleExportUsageInfo::Evaluation
| ModuleExportUsageInfo::Exports(_) => exports
.iter()
.filter(|(orig_name, _)| {
!export_usage_info
.is_export_used(&RcStr::from(orig_name.as_str()))
})
.map(|(_, export)| export.name.clone())
.collect(),
};
if !unused_symbols.is_empty() {
let targets = *get_lightningcss_browser_targets(
environment.as_deref().copied(),
true,
feature_flags,
)
.await?;
let _ = stylesheet.minify(MinifyOptions {
targets,
unused_symbols,
});
}
}
}
let code = code.await?;
let code = match &*code {
FileContent::Content(v) => v.content().to_str()?,
_ => bail!("this case should be filtered out while parsing"),
};
let origin_source_map = if let Some(rope) = origin_source_map.await?.as_content() {
Some(parcel_sourcemap::SourceMap::from_json(
"",
&rope.content().to_str()?,
)?)
} else {
None
};
let (result, srcmap) = stylesheet_to_css(
&stylesheet,
&code,
minify_type,
true,
true,
origin_source_map,
environment,
feature_flags,
)
.await?;
Ok(FinalCssResult::Ok {
output_code: result.code,
source_map: if let Some(srcmap) = srcmap {
FileContent::Content(File::from(srcmap)).resolved_cell()
} else {
FileContent::NotFound.resolved_cell()
},
}
.cell())
}
CssWithPlaceholderResult::Unparsable => Ok(FinalCssResult::Unparsable.cell()),
CssWithPlaceholderResult::NotFound => Ok(FinalCssResult::NotFound.cell()),
}
}
#[turbo_tasks::value_trait] #[turbo_tasks::value_trait]
pub trait ParseCss { pub trait ParseCss {
#[turbo_tasks::function] #[turbo_tasks::function]
...@@ -357,6 +496,14 @@ pub trait ProcessCss: ParseCss { ...@@ -357,6 +496,14 @@ pub trait ProcessCss: ParseCss {
chunking_context: Vc<Box<dyn ChunkingContext>>, chunking_context: Vc<Box<dyn ChunkingContext>>,
minify_type: MinifyType, minify_type: MinifyType,
) -> Result<Vc<FinalCssResult>>; ) -> Result<Vc<FinalCssResult>>;
#[turbo_tasks::function]
async fn finalize_css_module(
self: Vc<Self>,
chunking_context: Vc<Box<dyn ChunkingContext>>,
minify_type: MinifyType,
ecmascript_module: Vc<Box<dyn Module>>,
) -> Result<Vc<FinalCssResult>>;
} }
#[turbo_tasks::function] #[turbo_tasks::function]
......
...@@ -265,6 +265,7 @@ async fn apply_module_type( ...@@ -265,6 +265,7 @@ async fn apply_module_type(
css_import_context.map(|c| *c), css_import_context.map(|c| *c),
environment.as_deref().copied(), environment.as_deref().copied(),
*lightningcss_features, *lightningcss_features,
None, // ecmascript_module: set via with_ecmascript_module() for CSS Modules
) )
.to_resolved() .to_resolved()
.await?, .await?,
......
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