Skip to content

Commit

Permalink
fix(@angular/build): avoid overwriting inline style bundling addition…
Browse files Browse the repository at this point in the history
…al results

A component may contain multiple inline styles that will originate from the
same containing file. The content of the processed style is sent directly
to the Angular compiler. However, any additional result files are collected
and emitted in the application output. In most cases, this worked as expected
as inline styles rarely had resource references that would overwrite each other.
However, the potential is present for later inline styles for a component to
overwrite these output files. To avoid this potential problem, the internal
identifier now accounts for both the class name and order of the inline styles.
This ensures that each inline style retains a unique additional results entry.
  • Loading branch information
clydin authored and alan-agius4 committed Nov 8, 2024
1 parent b0965a9 commit cdad256
Showing 1 changed file with 9 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,6 @@ export function createCompilerPlugin(
let modifiedFiles;
if (
pluginOptions.sourceFileCache?.modifiedFiles.size &&
referencedFileTracker &&
!pluginOptions.noopTypeScriptCompilation
) {
// TODO: Differentiate between changed input files and stale output files
Expand All @@ -164,6 +163,8 @@ export function createCompilerPlugin(
if (!pluginOptions.externalRuntimeStyles) {
stylesheetBundler.invalidate(modifiedFiles);
}
// Remove any stale additional results based on modified files
modifiedFiles.forEach((file) => additionalResults.delete(file));
}

if (
Expand All @@ -181,6 +182,7 @@ export function createCompilerPlugin(
sourceFileCache: pluginOptions.sourceFileCache,
async transformStylesheet(data, containingFile, stylesheetFile, order, className) {
let stylesheetResult;
let resultSource = stylesheetFile ?? containingFile;

// Stylesheet file only exists for external stylesheets
if (stylesheetFile) {
Expand All @@ -203,6 +205,11 @@ export function createCompilerPlugin(
.digest('hex')
: undefined,
);
// Adjust result source for inline styles.
// There may be multiple inline styles with the same containing file and to ensure that the results
// do not overwrite each other the result source identifier needs to be unique for each. The class
// name and order fields can be used for this. The structure is arbitrary as long as it is unique.
resultSource += `?class=${className}&order=${order}`;
}

(result.warnings ??= []).push(...stylesheetResult.warnings);
Expand All @@ -213,7 +220,7 @@ export function createCompilerPlugin(
}

const { contents, outputFiles, metafile, referencedFiles } = stylesheetResult;
additionalResults.set(stylesheetFile ?? containingFile, {
additionalResults.set(resultSource, {
outputFiles,
metafile,
});
Expand Down

0 comments on commit cdad256

Please sign in to comment.