Skip to content

fix(@angular-devkit/build-angular): convert AOT compiler exceptions into diagnostics #26250

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
Nov 6, 2023
Merged

fix(@angular-devkit/build-angular): convert AOT compiler exceptions into diagnostics #26250

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
182 changes: 117 additions & 65 deletions packages/angular_devkit/build_angular/src/tools/esbuild/angular/compiler-plugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,8 @@ export function createCompilerPlugin(
const compilation: AngularCompilation = pluginOptions.noopTypeScriptCompilation
? new NoopCompilation()
: await createAngularCompilation(!!pluginOptions.jit);
// Compilation is initially assumed to have errors until emitted
let hasCompilationErrors = true;

// Determines if TypeScript should process JavaScript files based on tsconfig `allowJs` option
let shouldTsIgnoreJs = true;
Expand Down Expand Up @@ -233,66 +235,32 @@ export function createCompilerPlugin(

// Initialize the Angular compilation for the current build.
// In watch mode, previous build state will be reused.
const {
compilerOptions: { allowJs },
referencedFiles,
} = await compilation.initialize(tsconfigPath, hostOptions, (compilerOptions) => {
// target of 9 is ES2022 (using the number avoids an expensive import of typescript just for an enum)
if (compilerOptions.target === undefined || compilerOptions.target < 9) {
// If 'useDefineForClassFields' is already defined in the users project leave the value as is.
// Otherwise fallback to false due to https://github.com/microsoft/TypeScript/issues/45995
// which breaks the deprecated `@Effects` NGRX decorator and potentially other existing code as well.
compilerOptions.target = 9;
compilerOptions.useDefineForClassFields ??= false;

// Only add the warning on the initial build
setupWarnings?.push({
text:
'TypeScript compiler options "target" and "useDefineForClassFields" are set to "ES2022" and ' +
'"false" respectively by the Angular CLI.',
location: { file: pluginOptions.tsconfig },
notes: [
{
text:
'To control ECMA version and features use the Browerslist configuration. ' +
'For more information, see https://angular.io/guide/build#configuring-browser-compatibility',
},
],
});
}

if (compilerOptions.compilationMode === 'partial') {
setupWarnings?.push({
text: 'Angular partial compilation mode is not supported when building applications.',
location: null,
notes: [{ text: 'Full compilation mode will be used instead.' }],
});
compilerOptions.compilationMode = 'full';
}
let referencedFiles;
try {
const initializationResult = await compilation.initialize(
tsconfigPath,
hostOptions,
createCompilerOptionsTransformer(setupWarnings, pluginOptions, preserveSymlinks),
);
shouldTsIgnoreJs = !initializationResult.compilerOptions.allowJs;
referencedFiles = initializationResult.referencedFiles;
} catch (error) {
(result.errors ??= []).push({
text: 'Angular compilation initialization failed.',
location: null,
notes: [
{
text: error instanceof Error ? error.stack ?? error.message : `${error}`,
location: null,
},
],
});

// Enable incremental compilation by default if caching is enabled
if (pluginOptions.sourceFileCache?.persistentCachePath) {
compilerOptions.incremental ??= true;
// Set the build info file location to the configured cache directory
compilerOptions.tsBuildInfoFile = path.join(
pluginOptions.sourceFileCache?.persistentCachePath,
'.tsbuildinfo',
);
} else {
compilerOptions.incremental = false;
}
// Initialization failure prevents further compilation steps
hasCompilationErrors = true;

return {
...compilerOptions,
noEmitOnError: false,
inlineSources: pluginOptions.sourcemap,
inlineSourceMap: pluginOptions.sourcemap,
mapRoot: undefined,
sourceRoot: undefined,
preserveSymlinks,
};
});
shouldTsIgnoreJs = !allowJs;
return result;
}

if (compilation instanceof NoopCompilation) {
await sharedTSCompilationState.waitUntilReady;
Expand All @@ -301,19 +269,32 @@ export function createCompilerPlugin(
}

const diagnostics = await compilation.diagnoseFiles();
if (diagnostics.errors) {
if (diagnostics.errors?.length) {
(result.errors ??= []).push(...diagnostics.errors);
}
if (diagnostics.warnings) {
if (diagnostics.warnings?.length) {
(result.warnings ??= []).push(...diagnostics.warnings);
}

// Update TypeScript file output cache for all affected files
await profileAsync('NG_EMIT_TS', async () => {
for (const { filename, contents } of await compilation.emitAffectedFiles()) {
typeScriptFileCache.set(pathToFileURL(filename).href, contents);
}
});
try {
await profileAsync('NG_EMIT_TS', async () => {
for (const { filename, contents } of await compilation.emitAffectedFiles()) {
typeScriptFileCache.set(pathToFileURL(filename).href, contents);
}
});
} catch (error) {
(result.errors ??= []).push({
text: 'Angular compilation emit failed.',
location: null,
notes: [
{
text: error instanceof Error ? error.stack ?? error.message : `${error}`,
location: null,
},
],
});
}

// Add errors from failed additional results.
// This must be done after emit to capture latest web worker results.
Expand All @@ -331,6 +312,8 @@ export function createCompilerPlugin(
];
}

hasCompilationErrors = !!result.errors?.length;

// Reset the setup warnings so that they are only shown during the first build.
setupWarnings = undefined;

Expand All @@ -354,6 +337,12 @@ export function createCompilerPlugin(
let contents = typeScriptFileCache.get(pathToFileURL(request).href);

if (contents === undefined) {
// If the Angular compilation had errors the file may not have been emitted.
// To avoid additional errors about missing files, return empty contents.
if (hasCompilationErrors) {
return { contents: '', loader: 'js' };
}

// No TS result indicates the file is not part of the TypeScript program.
// If allowJs is enabled and the file is JS then defer to the next load hook.
if (!shouldTsIgnoreJs && /\.[cm]?js$/.test(request)) {
Expand Down Expand Up @@ -446,6 +435,69 @@ export function createCompilerPlugin(
};
}

function createCompilerOptionsTransformer(
setupWarnings: PartialMessage[] | undefined,
pluginOptions: CompilerPluginOptions,
preserveSymlinks: boolean | undefined,
): Parameters<AngularCompilation['initialize']>[2] {
return (compilerOptions) => {
// target of 9 is ES2022 (using the number avoids an expensive import of typescript just for an enum)
if (compilerOptions.target === undefined || compilerOptions.target < 9) {
// If 'useDefineForClassFields' is already defined in the users project leave the value as is.
// Otherwise fallback to false due to https://github.com/microsoft/TypeScript/issues/45995
// which breaks the deprecated `@Effects` NGRX decorator and potentially other existing code as well.
compilerOptions.target = 9;
compilerOptions.useDefineForClassFields ??= false;

// Only add the warning on the initial build
setupWarnings?.push({
text:
'TypeScript compiler options "target" and "useDefineForClassFields" are set to "ES2022" and ' +
'"false" respectively by the Angular CLI.',
location: { file: pluginOptions.tsconfig },
notes: [
{
text:
'To control ECMA version and features use the Browerslist configuration. ' +
'For more information, see https://angular.io/guide/build#configuring-browser-compatibility',
},
],
});
}

if (compilerOptions.compilationMode === 'partial') {
setupWarnings?.push({
text: 'Angular partial compilation mode is not supported when building applications.',
location: null,
notes: [{ text: 'Full compilation mode will be used instead.' }],
});
compilerOptions.compilationMode = 'full';
}

// Enable incremental compilation by default if caching is enabled
if (pluginOptions.sourceFileCache?.persistentCachePath) {
compilerOptions.incremental ??= true;
// Set the build info file location to the configured cache directory
compilerOptions.tsBuildInfoFile = path.join(
pluginOptions.sourceFileCache?.persistentCachePath,
'.tsbuildinfo',
);
} else {
compilerOptions.incremental = false;
}

return {
...compilerOptions,
noEmitOnError: false,
inlineSources: pluginOptions.sourcemap,
inlineSourceMap: pluginOptions.sourcemap,
mapRoot: undefined,
sourceRoot: undefined,
preserveSymlinks,
};
};
}

function bundleWebWorker(
build: PluginBuild,
pluginOptions: CompilerPluginOptions,
Expand Down