Skip to content

refactor(@angular/build): add internal support for generating template update functions #28672

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

Merged
merged 1 commit into from
Oct 22, 2024
Merged

refactor(@angular/build): add internal support for generating template update functions #28672

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
1 change: 1 addition & 0 deletions packages/angular/build/src/tools/angular/compilation/angular-compilation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ export abstract class AngularCompilation {
compilerOptions: ng.CompilerOptions;
referencedFiles: readonly string[];
externalStylesheets?: ReadonlyMap<string, string>;
templateUpdates?: ReadonlyMap<string, string>;
}>;

abstract emitAffectedFiles(): Iterable<EmitFileResult> | Promise<Iterable<EmitFileResult>>;
Expand Down
50 changes: 50 additions & 0 deletions packages/angular/build/src/tools/angular/compilation/aot-compilation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@

import type ng from '@angular/compiler-cli';
import assert from 'node:assert';
import { relative } from 'node:path';
import ts from 'typescript';
import { profileAsync, profileSync } from '../../esbuild/profiling';
import {
Expand Down Expand Up @@ -47,6 +48,7 @@ export class AotCompilation extends AngularCompilation {
compilerOptions: ng.CompilerOptions;
referencedFiles: readonly string[];
externalStylesheets?: ReadonlyMap<string, string>;
templateUpdates?: ReadonlyMap<string, string>;
}> {
// Dynamically load the Angular compiler CLI package
const { NgtscProgram, OptimizeFor } = await AngularCompilation.loadCompilerCli();
Expand Down Expand Up @@ -91,6 +93,40 @@ export class AotCompilation extends AngularCompilation {
);

await profileAsync('NG_ANALYZE_PROGRAM', () => angularCompiler.analyzeAsync());

let templateUpdates;
if (
compilerOptions['_enableHmr'] &&
hostOptions.modifiedFiles &&
hasOnlyTemplates(hostOptions.modifiedFiles)
) {
const componentNodes = [...hostOptions.modifiedFiles].flatMap((file) => [
...angularCompiler.getComponentsWithTemplateFile(file),
]);

for (const node of componentNodes) {
if (!ts.isClassDeclaration(node)) {
continue;
}
const componentFilename = node.getSourceFile().fileName;
let relativePath = relative(host.getCurrentDirectory(), componentFilename);
if (relativePath.startsWith('..')) {
relativePath = componentFilename;
}
const updateId = encodeURIComponent(
`${host.getCanonicalFileName(relativePath)}@${node.name?.text}`,
);
const updateText = angularCompiler.emitHmrUpdateModule(node);
if (updateText === null) {
// Build is needed if a template cannot be updated
templateUpdates = undefined;
break;
}
templateUpdates ??= new Map<string, string>();
templateUpdates.set(updateId, updateText);
}
}

const affectedFiles = profileSync('NG_FIND_AFFECTED', () =>
findAffectedFiles(typeScriptProgram, angularCompiler, usingBuildInfo),
);
Expand Down Expand Up @@ -131,6 +167,7 @@ export class AotCompilation extends AngularCompilation {
compilerOptions,
referencedFiles,
externalStylesheets: hostOptions.externalStylesheets,
templateUpdates,
};
}

Expand Down Expand Up @@ -385,3 +422,16 @@ function findAffectedFiles(

return affectedFiles;
}

function hasOnlyTemplates(modifiedFiles: Set<string>): boolean {
for (const file of modifiedFiles) {
const lowerFile = file.toLowerCase();
if (lowerFile.endsWith('.html') || lowerFile.endsWith('.svg')) {
Comment on lines +428 to +429
Copy link
Collaborator

Choose a reason for hiding this comment

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

NIT:

Suggested change
const lowerFile = file.toLowerCase();
if (lowerFile.endsWith('.html') || lowerFile.endsWith('.svg')) {
const ext = extname(file).toLowerCase();
if (ext === '.html' || ext === '.svg') {

Or also

 return [...modifiedFiles].every(file => /\.(html|svg)$/i.test(file));

continue;
}

return false;
}

return true;
}
88 changes: 45 additions & 43 deletions packages/angular/build/src/tools/angular/compilation/parallel-worker.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,60 +42,62 @@ export async function initialize(request: InitRequest) {
}
});

const { compilerOptions, referencedFiles, externalStylesheets } = await compilation.initialize(
request.tsconfig,
{
fileReplacements: request.fileReplacements,
sourceFileCache,
modifiedFiles: sourceFileCache.modifiedFiles,
transformStylesheet(data, containingFile, stylesheetFile, order, className) {
const requestId = randomUUID();
const resultPromise = new Promise<string>((resolve, reject) =>
stylesheetRequests.set(requestId, [resolve, reject]),
);

request.stylesheetPort.postMessage({
requestId,
data,
containingFile,
stylesheetFile,
order,
className,
});

return resultPromise;
const { compilerOptions, referencedFiles, externalStylesheets, templateUpdates } =
await compilation.initialize(
request.tsconfig,
{
fileReplacements: request.fileReplacements,
sourceFileCache,
modifiedFiles: sourceFileCache.modifiedFiles,
transformStylesheet(data, containingFile, stylesheetFile, order, className) {
const requestId = randomUUID();
const resultPromise = new Promise<string>((resolve, reject) =>
stylesheetRequests.set(requestId, [resolve, reject]),
);

request.stylesheetPort.postMessage({
requestId,
data,
containingFile,
stylesheetFile,
order,
className,
});

return resultPromise;
},
processWebWorker(workerFile, containingFile) {
Atomics.store(request.webWorkerSignal, 0, 0);
request.webWorkerPort.postMessage({ workerFile, containingFile });

Atomics.wait(request.webWorkerSignal, 0, 0);
const result = receiveMessageOnPort(request.webWorkerPort)?.message;

if (result?.error) {
throw result.error;
}

return result?.workerCodeFile ?? workerFile;
},
},
processWebWorker(workerFile, containingFile) {
Atomics.store(request.webWorkerSignal, 0, 0);
request.webWorkerPort.postMessage({ workerFile, containingFile });
(compilerOptions) => {
Atomics.store(request.optionsSignal, 0, 0);
request.optionsPort.postMessage(compilerOptions);

Atomics.wait(request.webWorkerSignal, 0, 0);
const result = receiveMessageOnPort(request.webWorkerPort)?.message;
Atomics.wait(request.optionsSignal, 0, 0);
const result = receiveMessageOnPort(request.optionsPort)?.message;

if (result?.error) {
throw result.error;
}

return result?.workerCodeFile ?? workerFile;
return result?.transformedOptions ?? compilerOptions;
},
},
(compilerOptions) => {
Atomics.store(request.optionsSignal, 0, 0);
request.optionsPort.postMessage(compilerOptions);

Atomics.wait(request.optionsSignal, 0, 0);
const result = receiveMessageOnPort(request.optionsPort)?.message;

if (result?.error) {
throw result.error;
}

return result?.transformedOptions ?? compilerOptions;
},
);
);

return {
externalStylesheets,
templateUpdates,
referencedFiles,
// TODO: Expand? `allowJs`, `isolatedModules`, `sourceMap`, `inlineSourceMap` are the only fields needed currently.
compilerOptions: {
Expand Down