421b6e7 refactor(@angular/build): provide structured application builder result types

Author: Angular Builds

package.json

@@ -1,16 +1,16 @@
 {
   "name": "@angular-devkit/build-angular",
-  "version": "18.2.0-next.1+sha-37a2138",
+  "version": "18.2.0-next.1+sha-421b6e7",
   "description": "Angular Webpack Build Facade",
   "main": "src/index.js",
   "typings": "src/index.d.ts",
   "builders": "builders.json",
   "dependencies": {
     "@ampproject/remapping": "2.3.0",
-    "@angular-devkit/architect": "github:angular/angular-devkit-architect-builds#37a2138",
-    "@angular-devkit/build-webpack": "github:angular/angular-devkit-build-webpack-builds#37a2138",
-    "@angular-devkit/core": "github:angular/angular-devkit-core-builds#37a2138",
-    "@angular/build": "github:angular/angular-build-builds#37a2138",
+    "@angular-devkit/architect": "github:angular/angular-devkit-architect-builds#421b6e7",
+    "@angular-devkit/build-webpack": "github:angular/angular-devkit-build-webpack-builds#421b6e7",
+    "@angular-devkit/core": "github:angular/angular-devkit-core-builds#421b6e7",
+    "@angular/build": "github:angular/angular-build-builds#421b6e7",
     "@babel/core": "7.24.9",
     "@babel/generator": "7.24.10",
     "@babel/helper-annotate-as-pure": "7.24.7",
@@ -21,7 +21,7 @@
     "@babel/preset-env": "7.24.8",
     "@babel/runtime": "7.24.8",
     "@discoveryjs/json-ext": "0.6.0",
-    "@ngtools/webpack": "github:angular/ngtools-webpack-builds#37a2138",
+    "@ngtools/webpack": "github:angular/ngtools-webpack-builds#421b6e7",
     "@vitejs/plugin-basic-ssl": "1.1.0",
     "ansi-colors": "4.1.3",
     "autoprefixer": "10.4.19",

src/builders/browser-esbuild/index.d.ts

@@ -5,8 +5,8 @@
  * Use of this source code is governed by an MIT-style license that can be
  * found in the LICENSE file at https://angular.dev/license
  */
-import type { BuildOutputFile } from '@angular/build';
-import { BuilderContext, BuilderOutput } from '@angular-devkit/architect';
+import { Result } from '@angular/build/private';
+import { BuilderContext } from '@angular-devkit/architect';
 import type { Plugin } from 'esbuild';
 import type { Schema as BrowserBuilderOptions } from './schema';
 /**
@@ -18,12 +18,9 @@ import type { Schema as BrowserBuilderOptions } from './schema';
  */
 export declare function buildEsbuildBrowser(userOptions: BrowserBuilderOptions, context: BuilderContext, infrastructureSettings?: {
     write?: boolean;
-}, plugins?: Plugin[]): AsyncIterable<BuilderOutput & {
-    outputFiles?: BuildOutputFile[];
-    assetFiles?: {
-        source: string;
-        destination: string;
-    }[];
-}>;
+}, plugins?: Plugin[]): AsyncIterable<Result>;
+export declare function buildEsbuildBrowserArchitect(options: BrowserBuilderOptions, context: BuilderContext): AsyncGenerator<{
+    success: boolean;
+}, void, unknown>;
 declare const _default: import("../../../../architect/src/internal").Builder<BrowserBuilderOptions & import("../../../../core/src").JsonObject>;
 export default _default;

src/builders/browser-esbuild/index.js

@@ -11,6 +11,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.buildEsbuildBrowser = buildEsbuildBrowser;
+exports.buildEsbuildBrowserArchitect = buildEsbuildBrowserArchitect;
 const private_1 = require("@angular/build/private");
 const architect_1 = require("@angular-devkit/architect");
 const promises_1 = __importDefault(require("node:fs/promises"));
@@ -35,19 +36,30 @@ async function* buildEsbuildBrowser(userOptions, context, infrastructureSettings
     for await (const result of (0, private_1.buildApplicationInternal)(normalizedOptions, context, {
         write: false,
     }, plugins && { codePlugins: plugins })) {
-        if (infrastructureSettings?.write !== false && result.outputFiles) {
-            // Write output files
-            await writeResultFiles(result.outputFiles, result.assetFiles, fullOutputPath);
+        // Write the file directly from this builder to maintain webpack output compatibility
+        // and not output browser files into '/browser'.
+        if (infrastructureSettings?.write !== false &&
+            (result.kind === private_1.ResultKind.Full || result.kind === private_1.ResultKind.Incremental)) {
+            const directoryExists = new Set();
+            // Writes the output file to disk and ensures the containing directories are present
+            await (0, private_1.emitFilesToDisk)(Object.entries(result.files), async ([filePath, file]) => {
+                // Ensure output subdirectories exist
+                const basePath = node_path_1.default.dirname(filePath);
+                if (basePath && !directoryExists.has(basePath)) {
+                    await promises_1.default.mkdir(node_path_1.default.join(fullOutputPath, basePath), { recursive: true });
+                    directoryExists.add(basePath);
+                }
+                if (file.origin === 'memory') {
+                    // Write file contents
+                    await promises_1.default.writeFile(node_path_1.default.join(fullOutputPath, filePath), file.contents);
+                }
+                else {
+                    // Copy file contents
+                    await promises_1.default.copyFile(file.inputPath, node_path_1.default.join(fullOutputPath, filePath), promises_1.default.constants.COPYFILE_FICLONE);
+                }
+            });
         }
-        // The builder system (architect) currently attempts to treat all results as JSON and
-        // attempts to validate the object with a JSON schema validator. This can lead to slow
-        // build completion (even after the actual build is fully complete) or crashes if the
-        // size and/or quantity of output files is large. Architect only requires a `success`
-        // property so that is all that will be passed here if the infrastructure settings have
-        // not been explicitly set to avoid writes. Writing is only disabled when used directly
-        // by the dev server which bypasses the architect behavior.
-        const builderResult = infrastructureSettings?.write === false ? result : { success: result.success };
-        yield builderResult;
+        yield result;
     }
 }
 function normalizeOptions(options) {
@@ -63,32 +75,9 @@ function normalizeOptions(options) {
         ...otherOptions,
     };
 }
-// We write the file directly from this builder to maintain webpack output compatibility
-// and not output browser files into '/browser'.
-async function writeResultFiles(outputFiles, assetFiles, outputPath) {
-    const directoryExists = new Set();
-    const ensureDirectoryExists = async (basePath) => {
-        if (basePath && !directoryExists.has(basePath)) {
-            await promises_1.default.mkdir(node_path_1.default.join(outputPath, basePath), { recursive: true });
-            directoryExists.add(basePath);
-        }
-    };
-    // Writes the output file to disk and ensures the containing directories are present
-    await (0, private_1.emitFilesToDisk)(outputFiles, async (file) => {
-        // Ensure output subdirectories exist
-        const basePath = node_path_1.default.dirname(file.path);
-        await ensureDirectoryExists(basePath);
-        // Write file contents
-        await promises_1.default.writeFile(node_path_1.default.join(outputPath, file.path), file.contents);
-    });
-    if (assetFiles?.length) {
-        await (0, private_1.emitFilesToDisk)(assetFiles, async ({ source, destination }) => {
-            const basePath = node_path_1.default.dirname(destination);
-            // Ensure output subdirectories exist
-            await ensureDirectoryExists(basePath);
-            // Copy file contents
-            await promises_1.default.copyFile(source, node_path_1.default.join(outputPath, destination), promises_1.default.constants.COPYFILE_FICLONE);
-        });
+async function* buildEsbuildBrowserArchitect(options, context) {
+    for await (const result of buildEsbuildBrowser(options, context)) {
+        yield { success: result.kind !== private_1.ResultKind.Failure };
     }
 }
-exports.default = (0, architect_1.createBuilder)(buildEsbuildBrowser);
+exports.default = (0, architect_1.createBuilder)(buildEsbuildBrowserArchitect);

src/builders/extract-i18n/application-extraction.d.ts

@@ -7,10 +7,10 @@
  */
 import type { ɵParsedMessage as LocalizeMessage } from '@angular/localize';
 import type { MessageExtractor } from '@angular/localize/tools';
-import type { BuilderContext, BuilderOutput } from '@angular-devkit/architect';
+import type { BuilderContext } from '@angular-devkit/architect';
 import type { NormalizedExtractI18nOptions } from './options';
 export declare function extractMessages(options: NormalizedExtractI18nOptions, builderName: string, context: BuilderContext, extractorConstructor: typeof MessageExtractor): Promise<{
-    builderResult: BuilderOutput;
+    success: boolean;
     basePath: string;
     messages: LocalizeMessage[];
     useLegacyIds: boolean;

src/builders/extract-i18n/application-extraction.js

@@ -12,7 +12,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.extractMessages = extractMessages;
 const private_1 = require("@angular/build/private");
-const node_assert_1 = __importDefault(require("node:assert"));
 const node_path_1 = __importDefault(require("node:path"));
 const browser_esbuild_1 = require("../browser-esbuild");
 async function extractMessages(options, builderName, context, extractorConstructor) {
@@ -35,63 +34,51 @@ async function extractMessages(options, builderName, context, extractorConstruct
     else {
         build = browser_esbuild_1.buildEsbuildBrowser;
     }
-    // Build the application with the build options
-    let builderResult;
-    try {
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        for await (const result of build(buildOptions, context, { write: false })) {
-            builderResult = result;
-            break;
-        }
-        (0, node_assert_1.default)(builderResult !== undefined, 'Application builder did not provide a result.');
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const builderResult = await first(build(buildOptions, context, { write: false }));
+    let success = false;
+    if (!builderResult || builderResult.kind === private_1.ResultKind.Failure) {
+        context.logger.error('Application build failed.');
     }
-    catch (err) {
-        builderResult = {
-            success: false,
-            error: err.message,
-        };
+    else if (builderResult.kind !== private_1.ResultKind.Full) {
+        context.logger.error('Application build did not provide a full output.');
     }
-    // Extract messages from each output JavaScript file.
-    // Output files are only present on a successful build.
-    if (builderResult.outputFiles) {
-        // Store the JS and JS map files for lookup during extraction
-        const files = new Map();
-        for (const outputFile of builderResult.outputFiles) {
-            if (outputFile.path.endsWith('.js')) {
-                files.set(outputFile.path, outputFile.text);
-            }
-            else if (outputFile.path.endsWith('.js.map')) {
-                files.set(outputFile.path, outputFile.text);
-            }
-        }
+    else {
         // Setup the localize message extractor based on the in-memory files
-        const extractor = setupLocalizeExtractor(extractorConstructor, files, context);
-        // Attempt extraction of all output JS files
-        for (const filePath of files.keys()) {
+        const extractor = setupLocalizeExtractor(extractorConstructor, builderResult.files, context);
+        // Extract messages from each output JavaScript file.
+        // Output files are only present on a successful build.
+        for (const filePath of Object.keys(builderResult.files)) {
             if (!filePath.endsWith('.js')) {
                 continue;
             }
             const fileMessages = extractor.extractMessages(filePath);
             messages.push(...fileMessages);
         }
+        success = true;
     }
     return {
-        builderResult,
+        success,
         basePath: context.workspaceRoot,
         messages,
         // Legacy i18n identifiers are not supported with the new application builder
         useLegacyIds: false,
     };
 }
 function setupLocalizeExtractor(extractorConstructor, files, context) {
+    const textDecoder = new TextDecoder();
     // Setup a virtual file system instance for the extractor
     // * MessageExtractor itself uses readFile, relative and resolve
     // * Internal SourceFileLoader (sourcemap support) uses dirname, exists, readFile, and resolve
     const filesystem = {
         readFile(path) {
             // Output files are stored as relative to the workspace root
             const requestedPath = node_path_1.default.relative(context.workspaceRoot, path);
-            const content = files.get(requestedPath);
+            const file = files[requestedPath];
+            let content;
+            if (file?.origin === 'memory') {
+                content = textDecoder.decode(file.contents);
+            }
             if (content === undefined) {
                 throw new Error('Unknown file requested: ' + requestedPath);
             }
@@ -106,7 +93,7 @@ function setupLocalizeExtractor(extractorConstructor, files, context) {
         exists(path) {
             // Output files are stored as relative to the workspace root
             const requestedPath = node_path_1.default.relative(context.workspaceRoot, path);
-            return files.has(requestedPath);
+            return files[requestedPath] !== undefined;
         },
         dirname(path) {
             return node_path_1.default.dirname(path);
@@ -137,3 +124,8 @@ function setupLocalizeExtractor(extractorConstructor, files, context) {
     });
     return extractor;
 }
+async function first(iterable) {
+    for await (const value of iterable) {
+        return value;
+    }
+}

src/builders/extract-i18n/builder.js

@@ -75,17 +75,20 @@ async function execute(options, context, transforms) {
         builderName === '@angular-devkit/build-angular:browser-esbuild') {
         const { extractMessages } = await Promise.resolve().then(() => __importStar(require('./application-extraction')));
         extractionResult = await extractMessages(normalizedOptions, builderName, context, localizeToolsModule.MessageExtractor);
+        if (!extractionResult.success) {
+            return { success: false };
+        }
     }
     else {
         // Purge old build disk cache.
         // Other build systems handle stale cache purging directly.
         await (0, private_1.purgeStaleBuildCache)(context);
         const { extractMessages } = await Promise.resolve().then(() => __importStar(require('./webpack-extraction')));
         extractionResult = await extractMessages(normalizedOptions, builderName, context, transforms);
-    }
-    // Return the builder result if it failed
-    if (!extractionResult.builderResult.success) {
-        return extractionResult.builderResult;
+        // Return the builder result if it failed
+        if (!extractionResult.builderResult.success) {
+            return extractionResult.builderResult;
+        }
     }
     // Perform duplicate message checks
     const { checkDuplicateMessages } = localizeToolsModule;

src/builders/web-test-runner/index.js

@@ -47,8 +47,8 @@ exports.default = (0, architect_1.createBuilder)(async (schema, ctx) => {
     ]);
     // Build the tests and abort on any build failure.
     const buildOutput = await buildTests(testFiles, testDir, options, ctx);
-    if (!buildOutput.success) {
-        return buildOutput;
+    if (buildOutput.kind === private_1.ResultKind.Failure) {
+        return { success: false };
     }
     // Run the built tests.
     return await runTests(wtr, `${testDir}/browser`, options);

src/utils/normalize-cache.js

@@ -10,7 +10,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.normalizeCacheOptions = normalizeCacheOptions;
 const node_path_1 = require("node:path");
 /** Version placeholder is replaced during the build process with actual package version */
-const VERSION = '18.2.0-next.1+sha-37a2138';
+const VERSION = '18.2.0-next.1+sha-421b6e7';
 function hasCacheMetadata(value) {
     return (!!value &&
         typeof value === 'object' &&

uniqueId

@@ -1 +1 @@
-Fri Jul 19 2024 13:33:16 GMT+0000 (Coordinated Universal Time)
+Fri Jul 19 2024 14:12:37 GMT+0000 (Coordinated Universal Time)