bb802d1 refactor(@angular-devkit/build-angular): only write test related files in Jest builder

Author: Angular Builds

package.json

@@ -1,16 +1,16 @@
 {
   "name": "@angular-devkit/build-angular",
-  "version": "18.2.0-next.3+sha-d257388",
+  "version": "18.2.0-next.3+sha-bb802d1",
   "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#d257388",
-    "@angular-devkit/build-webpack": "github:angular/angular-devkit-build-webpack-builds#d257388",
-    "@angular-devkit/core": "github:angular/angular-devkit-core-builds#d257388",
-    "@angular/build": "github:angular/angular-build-builds#d257388",
+    "@angular-devkit/architect": "github:angular/angular-devkit-architect-builds#bb802d1",
+    "@angular-devkit/build-webpack": "github:angular/angular-devkit-build-webpack-builds#bb802d1",
+    "@angular-devkit/core": "github:angular/angular-devkit-core-builds#bb802d1",
+    "@angular/build": "github:angular/angular-build-builds#bb802d1",
     "@babel/core": "7.25.2",
     "@babel/generator": "7.25.0",
     "@babel/helper-annotate-as-pure": "7.24.7",
@@ -21,7 +21,7 @@
     "@babel/preset-env": "7.25.2",
     "@babel/runtime": "7.25.0",
     "@discoveryjs/json-ext": "0.6.0",
-    "@ngtools/webpack": "github:angular/ngtools-webpack-builds#d257388",
+    "@ngtools/webpack": "github:angular/ngtools-webpack-builds#bb802d1",
     "@vitejs/plugin-basic-ssl": "1.1.0",
     "ansi-colors": "4.1.3",
     "autoprefixer": "10.4.19",

src/builders/jest/index.js

@@ -33,19 +33,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const private_1 = require("@angular/build/private");
 const architect_1 = require("@angular-devkit/architect");
 const node_child_process_1 = require("node:child_process");
+const node_crypto_1 = require("node:crypto");
 const fs = __importStar(require("node:fs/promises"));
 const path = __importStar(require("node:path"));
 const node_util_1 = require("node:util");
 const color_1 = require("../../utils/color");
 const test_files_1 = require("../../utils/test-files");
 const schema_1 = require("../browser-esbuild/schema");
+const write_test_files_1 = require("../web-test-runner/write-test-files");
 const options_1 = require("./options");
 const execFile = (0, node_util_1.promisify)(node_child_process_1.execFile);
 /** Main execution function for the Jest builder. */
 exports.default = (0, architect_1.createBuilder)(async (schema, context) => {
     context.logger.warn('NOTE: The Jest builder is currently EXPERIMENTAL and not ready for production use.');
     const options = (0, options_1.normalizeOptions)(schema);
-    const testOut = 'dist/test-out'; // TODO(dgp1130): Hide in temp directory.
+    const testOut = path.join(context.workspaceRoot, 'dist/test-out', (0, node_crypto_1.randomUUID)()); // TODO(dgp1130): Hide in temp directory.
     // Verify Jest installation and get the path to it's binary.
     // We need to `node_modules/.bin/jest`, but there is no means to resolve that directly. Fortunately Jest's `package.json` exports the
     // same file at `bin/jest`, so we can just resolve that instead.
@@ -83,7 +85,7 @@ exports.default = (0, architect_1.createBuilder)(async (schema, context) => {
     // Build all the test files.
     const jestGlobal = path.join(__dirname, 'jest-global.mjs');
     const initTestBed = path.join(__dirname, 'init-test-bed.mjs');
-    const buildResult = await build(context, {
+    const buildResult = await first((0, private_1.buildApplicationInternal)({
         // Build all the test files and also the `jest-global` and `init-test-bed` scripts.
         entryPoints: new Set([...testFiles, jestGlobal, initTestBed]),
         tsConfig: options.tsConfig,
@@ -99,15 +101,23 @@ exports.default = (0, architect_1.createBuilder)(async (schema, context) => {
             styles: false,
             vendor: false,
         },
-    });
-    if (!buildResult.success) {
-        return buildResult;
+    }, context, { write: false }));
+    if (buildResult.kind === private_1.ResultKind.Failure) {
+        return { success: false };
+    }
+    else if (buildResult.kind !== private_1.ResultKind.Full) {
+        return {
+            success: false,
+            error: 'A full build result is required from the application builder.',
+        };
     }
+    // Write test files
+    await (0, write_test_files_1.writeTestFiles)(buildResult.files, testOut);
     // Execute Jest on the built output directory.
     const jestProc = execFile(process.execPath, [
         '--experimental-vm-modules',
         jest,
-        `--rootDir="${path.join(testOut, 'browser')}"`,
+        `--rootDir="${testOut}"`,
         `--config=${path.join(__dirname, 'jest.config.mjs')}`,
         '--testEnvironment=jsdom',
         // TODO(dgp1130): Enable cache once we have a mechanism for properly clearing / disabling it.
@@ -150,19 +160,12 @@ exports.default = (0, architect_1.createBuilder)(async (schema, context) => {
     }
     return { success: true };
 });
-async function build(context, options) {
-    try {
-        for await (const _ of (0, private_1.buildApplicationInternal)(options, context)) {
-            // Nothing to do for each event, just wait for the whole build.
-        }
-        return { success: true };
-    }
-    catch (err) {
-        return {
-            success: false,
-            error: err.message,
-        };
+/** Returns the first item yielded by the given generator and cancels the execution. */
+async function first(generator) {
+    for await (const value of generator) {
+        return value;
     }
+    throw new Error('Expected generator to emit at least once.');
 }
 /** Safely resolves the given Node module string. */
 function resolveModule(module) {

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

@@ -12,13 +12,15 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const private_1 = require("@angular/build/private");
 const architect_1 = require("@angular-devkit/architect");
-const node_fs_1 = require("node:fs");
+const node_crypto_1 = require("node:crypto");
+const promises_1 = __importDefault(require("node:fs/promises"));
 const node_module_1 = require("node:module");
 const node_path_1 = __importDefault(require("node:path"));
 const test_files_1 = require("../../utils/test-files");
 const schema_1 = require("../browser-esbuild/schema");
 const builder_status_warnings_1 = require("./builder-status-warnings");
 const options_1 = require("./options");
+const write_test_files_1 = require("./write-test-files");
 exports.default = (0, architect_1.createBuilder)(async (schema, ctx) => {
     ctx.logger.warn('NOTE: The Web Test Runner builder is currently EXPERIMENTAL and not ready for production use.');
     (0, builder_status_warnings_1.logBuilderStatusWarnings)(schema, ctx);
@@ -37,21 +39,29 @@ exports.default = (0, architect_1.createBuilder)(async (schema, ctx) => {
         };
     }
     const options = (0, options_1.normalizeOptions)(schema);
-    const testDir = 'dist/test-out';
+    const testDir = node_path_1.default.join(ctx.workspaceRoot, 'dist/test-out', (0, node_crypto_1.randomUUID)());
     // Parallelize startup work.
     const [testFiles] = await Promise.all([
         // Glob for files to test.
         (0, test_files_1.findTestFiles)(options.include, options.exclude, ctx.workspaceRoot),
         // Clean build output path.
-        node_fs_1.promises.rm(testDir, { recursive: true, force: true }),
+        promises_1.default.rm(testDir, { recursive: true, force: true }),
     ]);
     // Build the tests and abort on any build failure.
     const buildOutput = await buildTests(testFiles, testDir, options, ctx);
     if (buildOutput.kind === private_1.ResultKind.Failure) {
         return { success: false };
     }
+    else if (buildOutput.kind !== private_1.ResultKind.Full) {
+        return {
+            success: false,
+            error: 'A full build result is required from the application builder.',
+        };
+    }
+    // Write test files
+    await (0, write_test_files_1.writeTestFiles)(buildOutput.files, testDir);
     // Run the built tests.
-    return await runTests(wtr, `${testDir}/browser`, options);
+    return await runTests(wtr, testDir, options);
 });
 /** Build all the given test files and write the result to the given output path. */
 async function buildTests(testFiles, outputPath, options, ctx) {
@@ -85,7 +95,7 @@ async function buildTests(testFiles, outputPath, options, ctx) {
             vendor: true,
         },
         polyfills,
-    }, ctx));
+    }, ctx, { write: false }));
     return buildOutput;
 }
 function extractZoneTesting(polyfills) {
@@ -96,7 +106,7 @@ function extractZoneTesting(polyfills) {
 /** Run Web Test Runner on the given directory of bundled JavaScript tests. */
 async function runTests(wtr, testDir, options) {
     const testPagePath = node_path_1.default.resolve(__dirname, 'test_page.html');
-    const testPage = await node_fs_1.promises.readFile(testPagePath, 'utf8');
+    const testPage = await promises_1.default.readFile(testPagePath, 'utf8');
     const runner = await wtr.startTestRunner({
         config: {
             rootDir: testDir,

src/builders/web-test-runner/write-test-files.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @license
+ * Copyright Google LLC All Rights Reserved.
+ *
+ * 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 { ResultFile } from '@angular/build/private';
+export declare function writeTestFiles(files: Record<string, ResultFile>, testDir: string): Promise<void>;

src/builders/web-test-runner/write-test-files.js

@@ -0,0 +1,41 @@
+"use strict";
+/**
+ * @license
+ * Copyright Google LLC All Rights Reserved.
+ *
+ * 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
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.writeTestFiles = writeTestFiles;
+const build_1 = require("@angular/build");
+const private_1 = require("@angular/build/private");
+const promises_1 = __importDefault(require("node:fs/promises"));
+const node_path_1 = __importDefault(require("node:path"));
+async function writeTestFiles(files, testDir) {
+    const directoryExists = new Set();
+    // Writes the test related output files to disk and ensures the containing directories are present
+    await (0, private_1.emitFilesToDisk)(Object.entries(files), async ([filePath, file]) => {
+        if (file.type !== build_1.BuildOutputFileType.Browser && file.type !== build_1.BuildOutputFileType.Media) {
+            return;
+        }
+        const fullFilePath = node_path_1.default.join(testDir, filePath);
+        // Ensure output subdirectories exist
+        const fileBasePath = node_path_1.default.dirname(fullFilePath);
+        if (fileBasePath && !directoryExists.has(fileBasePath)) {
+            await promises_1.default.mkdir(fileBasePath, { recursive: true });
+            directoryExists.add(fileBasePath);
+        }
+        if (file.origin === 'memory') {
+            // Write file contents
+            await promises_1.default.writeFile(fullFilePath, file.contents);
+        }
+        else {
+            // Copy file contents
+            await promises_1.default.copyFile(file.inputPath, fullFilePath, promises_1.default.constants.COPYFILE_FICLONE);
+        }
+    });
+}

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.3+sha-d257388';
+const VERSION = '18.2.0-next.3+sha-bb802d1';
 function hasCacheMetadata(value) {
     return (!!value &&
         typeof value === 'object' &&

uniqueId

@@ -1 +1 @@
-Wed Jul 31 2024 11:53:13 GMT+0000 (Coordinated Universal Time)
+Mon Aug 05 2024 17:50:53 GMT+0000 (Coordinated Universal Time)