@angular/build 21.0.0-next.2 → 21.0.0-next.4

package/src/builders/karma/assets-middleware.js

@@ -0,0 +1,65 @@
+"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.AngularAssetsMiddleware = void 0;
+const node_path_1 = __importDefault(require("node:path"));
+const isWindows = process.platform === 'win32';
+const LATEST_BUILD_FILES_TOKEN = 'angularLatestBuildFiles';
+class AngularAssetsMiddleware {
+    serveFile;
+    latestBuildFiles;
+    static $inject = ['serveFile', LATEST_BUILD_FILES_TOKEN];
+    static NAME = 'angular-test-assets';
+    constructor(serveFile, latestBuildFiles) {
+        this.serveFile = serveFile;
+        this.latestBuildFiles = latestBuildFiles;
+    }
+    handle(req, res, next) {
+        const url = new URL(`http://${req.headers['host'] ?? ''}${req.url ?? ''}`);
+        // Remove the leading slash from the URL path and convert to platform specific.
+        // The latest build files will use the platform path separator.
+        let pathname = url.pathname.slice(1);
+        if (isWindows) {
+            pathname = pathname.replaceAll(node_path_1.default.posix.sep, node_path_1.default.win32.sep);
+        }
+        const file = this.latestBuildFiles.files[pathname];
+        if (!file) {
+            next();
+            return;
+        }
+        // Implementation of serverFile can be found here:
+        // https://github.com/karma-runner/karma/blob/84f85e7016efc2266fa6b3465f494a3fa151c85c/lib/middleware/common.js#L10
+        switch (file.origin) {
+            case 'disk':
+                this.serveFile(file.inputPath, undefined, res, undefined, undefined, /* doNotCache */ true);
+                break;
+            case 'memory':
+                // Include pathname to help with Content-Type headers.
+                this.serveFile(`/unused/${url.pathname}`, undefined, res, undefined, file.contents, 
+                /* doNotCache */ false);
+                break;
+        }
+    }
+    static createPlugin(initialFiles) {
+        return {
+            [LATEST_BUILD_FILES_TOKEN]: ['value', { files: { ...initialFiles.files } }],
+            [`middleware:${AngularAssetsMiddleware.NAME}`]: [
+                'factory',
+                Object.assign((...args) => {
+                    const inst = new AngularAssetsMiddleware(...args);
+                    return inst.handle.bind(inst);
+                }, AngularAssetsMiddleware),
+            ],
+        };
+    }
+}
+exports.AngularAssetsMiddleware = AngularAssetsMiddleware;

package/src/builders/karma/coverage.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
+ */
+export declare function createInstrumentationFilter(includedBasePath: string, excludedPaths: Set<string>): (request: string) => boolean;
+export declare function getInstrumentationExcludedPaths(root: string, excludedPaths: string[]): Set<string>;

package/src/builders/karma/coverage.js

@@ -0,0 +1,31 @@
+"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.createInstrumentationFilter = createInstrumentationFilter;
+exports.getInstrumentationExcludedPaths = getInstrumentationExcludedPaths;
+const node_path_1 = __importDefault(require("node:path"));
+const tinyglobby_1 = require("tinyglobby");
+function createInstrumentationFilter(includedBasePath, excludedPaths) {
+    return (request) => {
+        return (!excludedPaths.has(request) &&
+            !/\.(e2e|spec)\.tsx?$|[\\/]node_modules[\\/]/.test(request) &&
+            request.startsWith(includedBasePath));
+    };
+}
+function getInstrumentationExcludedPaths(root, excludedPaths) {
+    const excluded = new Set();
+    for (const excludeGlob of excludedPaths) {
+        const excludePath = excludeGlob[0] === '/' ? excludeGlob.slice(1) : excludeGlob;
+        (0, tinyglobby_1.globSync)(excludePath, { cwd: root }).forEach((p) => excluded.add(node_path_1.default.join(root, p)));
+    }
+    return excluded;
+}

package/src/builders/karma/find-tests.d.ts

@@ -9,7 +9,8 @@ export declare function findTests(include: string[], exclude: string[], workspac
 interface TestEntrypointsOptions {
     projectSourceRoot: string;
     workspaceRoot: string;
+    removeTestExtension?: boolean;
 }
 /** Generate unique bundle names for a set of test files. */
-export declare function getTestEntrypoints(testFiles: string[], { projectSourceRoot, workspaceRoot }: TestEntrypointsOptions): Map<string, string>;
+export declare function getTestEntrypoints(testFiles: string[], { projectSourceRoot, workspaceRoot, removeTestExtension }: TestEntrypointsOptions): Map<string, string>;
 export {};

package/src/builders/karma/find-tests.js

@@ -21,7 +21,7 @@ async function findTests(include, exclude, workspaceRoot, projectSourceRoot) {
     return [...new Set(files.flat())];
 }
 /** Generate unique bundle names for a set of test files. */
-function getTestEntrypoints(testFiles, { projectSourceRoot, workspaceRoot }) {
+function getTestEntrypoints(testFiles, { projectSourceRoot, workspaceRoot, removeTestExtension }) {
     const seen = new Set();
     return new Map(Array.from(testFiles, (testFile) => {
         const relativePath = removeRoots(testFile, [projectSourceRoot, workspaceRoot])
@@ -29,7 +29,11 @@ function getTestEntrypoints(testFiles, { projectSourceRoot, workspaceRoot }) {
             .replace(/^[./\\]+/, '')
             // Replace any path separators with dashes.
             .replace(/[/\\]/g, '-');
-        const baseName = `spec-${(0, node_path_1.basename)(relativePath, (0, node_path_1.extname)(relativePath))}`;
+        let fileName = (0, node_path_1.basename)(relativePath, (0, node_path_1.extname)(relativePath));
+        if (removeTestExtension) {
+            fileName = fileName.replace(/\.(spec|test)$/, '');
+        }
+        const baseName = `spec-${fileName}`;
         let uniqueName = baseName;
         let suffix = 2;
         while (seen.has(uniqueName)) {

package/src/builders/karma/karma-config.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @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 type { BuilderContext } from '@angular-devkit/architect';
+import type { ConfigOptions } from 'karma';
+import type { NormalizedKarmaBuilderOptions } from './options';
+export declare function getBaseKarmaOptions(options: NormalizedKarmaBuilderOptions, context: BuilderContext): ConfigOptions;

package/src/builders/karma/karma-config.js

@@ -0,0 +1,79 @@
+"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.getBaseKarmaOptions = getBaseKarmaOptions;
+const node_module_1 = require("node:module");
+const node_path_1 = __importDefault(require("node:path"));
+function getBaseKarmaOptions(options, context) {
+    // Determine project name from builder context target
+    const projectName = context.target?.project;
+    if (!projectName) {
+        throw new Error(`The 'karma' builder requires a target to be specified.`);
+    }
+    const karmaOptions = options.karmaConfig
+        ? {}
+        : getBuiltInKarmaConfig(context.workspaceRoot, projectName);
+    const singleRun = !options.watch;
+    karmaOptions.singleRun = singleRun;
+    // Workaround https://github.com/angular/angular-cli/issues/28271, by clearing context by default
+    // for single run executions. Not clearing context for multi-run (watched) builds allows the
+    // Jasmine Spec Runner to be visible in the browser after test execution.
+    karmaOptions.client ??= {};
+    karmaOptions.client.clearContext ??= singleRun;
+    // Convert browsers from a string to an array
+    if (options.browsers) {
+        karmaOptions.browsers = options.browsers;
+    }
+    if (options.reporters) {
+        karmaOptions.reporters = options.reporters;
+    }
+    return karmaOptions;
+}
+function getBuiltInKarmaConfig(workspaceRoot, projectName) {
+    let coverageFolderName = projectName.charAt(0) === '@' ? projectName.slice(1) : projectName;
+    coverageFolderName = coverageFolderName.toLowerCase();
+    const workspaceRootRequire = (0, node_module_1.createRequire)(workspaceRoot + '/');
+    // Any changes to the config here need to be synced to: packages/schematics/angular/config/files/karma.conf.js.template
+    return {
+        basePath: '',
+        frameworks: ['jasmine'],
+        plugins: [
+            'karma-jasmine',
+            'karma-chrome-launcher',
+            'karma-jasmine-html-reporter',
+            'karma-coverage',
+        ].map((p) => workspaceRootRequire(p)),
+        jasmineHtmlReporter: {
+            suppressAll: true, // removes the duplicated traces
+        },
+        coverageReporter: {
+            dir: node_path_1.default.join(workspaceRoot, 'coverage', coverageFolderName),
+            subdir: '.',
+            reporters: [{ type: 'html' }, { type: 'text-summary' }],
+        },
+        reporters: ['progress', 'kjhtml'],
+        browsers: ['Chrome'],
+        customLaunchers: {
+            // Chrome configured to run in a bazel sandbox.
+            // Disable the use of the gpu and `/dev/shm` because it causes Chrome to
+            // crash on some environments.
+            // See:
+            //   https://github.com/puppeteer/puppeteer/blob/v1.0.0/docs/troubleshooting.md#tips
+            //   https://stackoverflow.com/questions/50642308/webdriverexception-unknown-error-devtoolsactiveport-file-doesnt-exist-while-t
+            ChromeHeadlessNoSandbox: {
+                base: 'ChromeHeadless',
+                flags: ['--no-sandbox', '--headless', '--disable-gpu', '--disable-dev-shm-usage'],
+            },
+        },
+        restartOnFileChange: true,
+    };
+}

package/src/builders/karma/polyfills-plugin.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @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 type { FilePattern, InlinePluginDef } from 'karma';
+export declare class AngularPolyfillsPlugin {
+    static readonly $inject: string[];
+    static readonly NAME = "angular-polyfills";
+    static createPlugin(polyfillsFile: FilePattern, jasmineCleanupFiles: FilePattern, scriptsFiles: FilePattern[]): InlinePluginDef;
+}

package/src/builders/karma/polyfills-plugin.js

@@ -0,0 +1,74 @@
+"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
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AngularPolyfillsPlugin = void 0;
+const node_module_1 = require("node:module");
+const localResolve = (0, node_module_1.createRequire)(__filename).resolve;
+class AngularPolyfillsPlugin {
+    static $inject = ['config.files'];
+    static NAME = 'angular-polyfills';
+    static createPlugin(polyfillsFile, jasmineCleanupFiles, scriptsFiles) {
+        return {
+            // This has to be a "reporter" because reporters run _after_ frameworks
+            // and karma-jasmine-html-reporter injects additional scripts that may
+            // depend on Jasmine but aren't modules - which means that they would run
+            // _before_ all module code (including jasmine).
+            [`reporter:${AngularPolyfillsPlugin.NAME}`]: [
+                'factory',
+                Object.assign((files) => {
+                    // The correct order is zone.js -> jasmine -> zone.js/testing.
+                    // Jasmine has to see the patched version of the global `setTimeout`
+                    // function so it doesn't cache the unpatched version. And /testing
+                    // needs to see the global `jasmine` object so it can patch it.
+                    const polyfillsIndex = 0;
+                    files.splice(polyfillsIndex, 0, polyfillsFile);
+                    // Insert just before test_main.js.
+                    const zoneTestingIndex = files.findIndex((f) => {
+                        if (typeof f === 'string') {
+                            return false;
+                        }
+                        return f.pattern.endsWith('/test_main.js');
+                    });
+                    if (zoneTestingIndex === -1) {
+                        throw new Error('Could not find test entrypoint file.');
+                    }
+                    files.splice(zoneTestingIndex, 0, jasmineCleanupFiles);
+                    // We need to ensure that all files are served as modules, otherwise
+                    // the order in the files list gets really confusing: Karma doesn't
+                    // set defer on scripts, so all scripts with type=js will run first,
+                    // even if type=module files appeared earlier in `files`.
+                    for (const f of files) {
+                        if (typeof f === 'string') {
+                            throw new Error(`Unexpected string-based file: "${f}"`);
+                        }
+                        if (f.included === false) {
+                            // Don't worry about files that aren't included on the initial
+                            // page load. `type` won't affect them.
+                            continue;
+                        }
+                        if (f.pattern.endsWith('.js') && 'js' === (f.type ?? 'js')) {
+                            f.type = 'module';
+                        }
+                    }
+                    // Add "scripts" option files as classic scripts
+                    files.unshift(...scriptsFiles);
+                    // Add browser sourcemap support as a classic script
+                    files.unshift({
+                        pattern: localResolve('source-map-support/browser-source-map-support.js'),
+                        included: true,
+                        watched: false,
+                    });
+                    // Karma needs a return value for a factory and Karma's multi-reporter expects an `adapters` array
+                    return { adapters: [] };
+                }, AngularPolyfillsPlugin),
+            ],
+        };
+    }
+}
+exports.AngularPolyfillsPlugin = AngularPolyfillsPlugin;

package/src/builders/karma/progress-reporter.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @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 type { BuilderOutput } from '@angular-devkit/architect';
+import type { Config, ConfigOptions } from 'karma';
+import type { ReadableStreamController } from 'node:stream/web';
+import type { ApplicationBuilderInternalOptions } from '../application/options';
+import type { Result } from '../application/results';
+interface BuildOptions extends ApplicationBuilderInternalOptions {
+    outputPath: string;
+}
+export declare function injectKarmaReporter(buildOptions: BuildOptions, buildIterator: AsyncIterator<Result>, karmaConfig: Config & ConfigOptions, controller: ReadableStreamController<BuilderOutput>): void;
+export {};

package/src/builders/karma/progress-reporter.js

@@ -0,0 +1,73 @@
+"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
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.injectKarmaReporter = injectKarmaReporter;
+const test_files_1 = require("../../utils/test-files");
+const results_1 = require("../application/results");
+const LATEST_BUILD_FILES_TOKEN = 'angularLatestBuildFiles';
+function injectKarmaReporter(buildOptions, buildIterator, karmaConfig, controller) {
+    const reporterName = 'angular-progress-notifier';
+    class ProgressNotifierReporter {
+        emitter;
+        latestBuildFiles;
+        static $inject = ['emitter', LATEST_BUILD_FILES_TOKEN];
+        constructor(emitter, latestBuildFiles) {
+            this.emitter = emitter;
+            this.latestBuildFiles = latestBuildFiles;
+            this.startWatchingBuild();
+        }
+        startWatchingBuild() {
+            void (async () => {
+                // This is effectively "for await of but skip what's already consumed".
+                let isDone = false; // to mark the loop condition as "not constant".
+                while (!isDone) {
+                    const { done, value: buildOutput } = await buildIterator.next();
+                    if (done) {
+                        isDone = true;
+                        break;
+                    }
+                    if (buildOutput.kind === results_1.ResultKind.Failure) {
+                        controller.enqueue({ success: false, message: 'Build failed' });
+                    }
+                    else if (buildOutput.kind === results_1.ResultKind.Incremental ||
+                        buildOutput.kind === results_1.ResultKind.Full) {
+                        if (buildOutput.kind === results_1.ResultKind.Full) {
+                            this.latestBuildFiles.files = buildOutput.files;
+                        }
+                        else {
+                            this.latestBuildFiles.files = {
+                                ...this.latestBuildFiles.files,
+                                ...buildOutput.files,
+                            };
+                        }
+                        await (0, test_files_1.writeTestFiles)(buildOutput.files, buildOptions.outputPath);
+                        this.emitter.refreshFiles();
+                    }
+                }
+            })();
+        }
+        onRunComplete = function (_browsers, results) {
+            if (results.exitCode === 0) {
+                controller.enqueue({ success: true });
+            }
+            else {
+                controller.enqueue({ success: false });
+            }
+        };
+    }
+    karmaConfig.reporters ??= [];
+    karmaConfig.reporters.push(reporterName);
+    karmaConfig.plugins ??= [];
+    karmaConfig.plugins.push({
+        [`reporter:${reporterName}`]: [
+            'factory',
+            Object.assign((...args) => new ProgressNotifierReporter(...args), ProgressNotifierReporter),
+        ],
+    });
+}

package/src/builders/karma/utils.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @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 type { BuilderContext } from '@angular-devkit/architect';
+import type { NormalizedKarmaBuilderOptions } from './options';
+export declare function getProjectSourceRoot(context: BuilderContext): Promise<string>;
+export declare function normalizePolyfills(polyfills?: string[]): [polyfills: string[], jasmineCleanup: string[]];
+export declare function collectEntrypoints(options: NormalizedKarmaBuilderOptions, context: BuilderContext, projectSourceRoot: string): Promise<Map<string, string>>;
+export declare function hasChunkOrWorkerFiles(files: Record<string, unknown>): boolean;
+/** Returns the first item yielded by the given generator and cancels the execution. */
+export declare function first<T>(generator: AsyncIterable<T>, { cancel }: {
+    cancel: boolean;
+}): Promise<[T, AsyncIterator<T> | null]>;

package/src/builders/karma/utils.js

@@ -0,0 +1,66 @@
+"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
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getProjectSourceRoot = getProjectSourceRoot;
+exports.normalizePolyfills = normalizePolyfills;
+exports.collectEntrypoints = collectEntrypoints;
+exports.hasChunkOrWorkerFiles = hasChunkOrWorkerFiles;
+exports.first = first;
+const node_module_1 = require("node:module");
+const project_metadata_1 = require("../../utils/project-metadata");
+const find_tests_1 = require("./find-tests");
+const localResolve = (0, node_module_1.createRequire)(__filename).resolve;
+async function getProjectSourceRoot(context) {
+    // We have already validated that the project name is set before calling this function.
+    const projectName = context.target?.project;
+    if (!projectName) {
+        return context.workspaceRoot;
+    }
+    const projectMetadata = await context.getProjectMetadata(projectName);
+    const { projectSourceRoot } = (0, project_metadata_1.getProjectRootPaths)(context.workspaceRoot, projectMetadata);
+    return projectSourceRoot;
+}
+function normalizePolyfills(polyfills = []) {
+    const jasmineGlobalEntryPoint = localResolve('./polyfills/jasmine_global.js');
+    const jasmineGlobalCleanupEntrypoint = localResolve('./polyfills/jasmine_global_cleanup.js');
+    const sourcemapEntrypoint = localResolve('./polyfills/init_sourcemaps.js');
+    const zoneTestingEntryPoint = 'zone.js/testing';
+    const polyfillsExludingZoneTesting = polyfills.filter((p) => p !== zoneTestingEntryPoint);
+    return [
+        polyfillsExludingZoneTesting.concat([jasmineGlobalEntryPoint, sourcemapEntrypoint]),
+        polyfillsExludingZoneTesting.length === polyfills.length
+            ? [jasmineGlobalCleanupEntrypoint]
+            : [jasmineGlobalCleanupEntrypoint, zoneTestingEntryPoint],
+    ];
+}
+async function collectEntrypoints(options, context, projectSourceRoot) {
+    // Glob for files to test.
+    const testFiles = await (0, find_tests_1.findTests)(options.include, options.exclude, context.workspaceRoot, projectSourceRoot);
+    return (0, find_tests_1.getTestEntrypoints)(testFiles, { projectSourceRoot, workspaceRoot: context.workspaceRoot });
+}
+function hasChunkOrWorkerFiles(files) {
+    return Object.keys(files).some((filename) => {
+        return /(?:^|\/)(?:worker|chunk)[^/]+\.js$/.test(filename);
+    });
+}
+/** Returns the first item yielded by the given generator and cancels the execution. */
+async function first(generator, { cancel }) {
+    if (!cancel) {
+        const iterator = generator[Symbol.asyncIterator]();
+        const firstValue = await iterator.next();
+        if (firstValue.done) {
+            throw new Error('Expected generator to emit at least once.');
+        }
+        return [firstValue.value, iterator];
+    }
+    for await (const value of generator) {
+        return [value, null];
+    }
+    throw new Error('Expected generator to emit at least once.');
+}