packages/angular/build/src/tools/esbuild/bundler-execution-result.ts - main - githubmirror/angular-cli

packages/angular/build/src/tools/esbuild/bundler-execution-result.ts
214 строк7 KB
Alan Agius
fix(@angular/build): prevent build process hang on unhandled error (#33715)
31 июл 2026, 21:34
31 июл 2026, 21:344fb1229
/**
 * @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 { Message, PartialMessage } from 'esbuild';
import { normalize } from 'node:path';
import type { ChangedFiles } from '../../tools/esbuild/watcher';
import type { ComponentStylesheetBundler } from './angular/component-stylesheets';
import type { SourceFileCache } from './angular/source-file-cache';
import type { BundlerContext } from './bundler-context';
import { type BuildOutputFile, BuildOutputFileType, createOutputFile } from './bundler-files';

export interface BuildOutputAsset {
  source: string;
  destination: string;
}

export interface RebuildState {
  rebuildContexts: {
    typescriptContexts: BundlerContext[];
    otherContexts: BundlerContext[];
  };
  componentStyleBundler: ComponentStylesheetBundler;
  codeBundleCache?: SourceFileCache;
  fileChanges: ChangedFiles;
  previousOutputInfo: ReadonlyMap<string, { hash: string; type: BuildOutputFileType }>;
  previousAssetsInfo: ReadonlyMap<string, string>;
  templateUpdates?: Map<string, string>;
}

export interface ExternalResultMetadata {
  implicitBrowser: string[];
  implicitServer: string[];
  explicit: string[];
}

export type PrerenderedRoutesRecord = Record<string, { headers?: Record<string, string> }>;

/**
 * Represents the result of a single builder execute call.
 */
export class ExecutionResult {
  outputFiles: BuildOutputFile[] = [];
  assetFiles: BuildOutputAsset[] = [];
  errors: (Message | PartialMessage)[] = [];
  prerenderedRoutes: PrerenderedRoutesRecord = {};
  warnings: (Message | PartialMessage)[] = [];
  logs: string[] = [];
  externalMetadata?: ExternalResultMetadata;
  extraWatchFiles: string[] = [];
  htmlIndexPath?: string;
  htmlBaseHref?: string;

  constructor(
    private rebuildContexts: {
      typescriptContexts: BundlerContext[];
      otherContexts: BundlerContext[];
    },
    private componentStyleBundler: ComponentStylesheetBundler,
    private codeBundleCache?: SourceFileCache,
    readonly templateUpdates?: Map<string, string>,
  ) {}

  addOutputFile(path: string, content: string | Uint8Array, type: BuildOutputFileType): void {
    this.outputFiles.push(createOutputFile(path, content, type));
  }

  addAssets(assets: BuildOutputAsset[]): void {
    this.assetFiles.push(...assets);
  }

  addLog(value: string): void {
    this.logs.push(value);
  }

  addError(error: PartialMessage | string): void {
    if (typeof error === 'string') {
      this.errors.push({ text: error, location: null });
    } else {
      this.errors.push(error);
    }
  }

  addErrors(errors: (PartialMessage | string)[]): void {
    for (const error of errors) {
      this.addError(error);
    }
  }

  addPrerenderedRoutes(routes: PrerenderedRoutesRecord): void {
    Object.assign(this.prerenderedRoutes, routes);

    // Sort the prerendered routes.
    const sortedObj: PrerenderedRoutesRecord = {};
    for (const key of Object.keys(this.prerenderedRoutes).sort()) {
      sortedObj[key] = this.prerenderedRoutes[key];
    }

    this.prerenderedRoutes = sortedObj;
  }

  addWarning(error: PartialMessage | string): void {
    if (typeof error === 'string') {
      this.warnings.push({ text: error, location: null });
    } else {
      this.warnings.push(error);
    }
  }

  addWarnings(errors: (PartialMessage | string)[]): void {
    for (const error of errors) {
      this.addWarning(error);
    }
  }

  /**
   * Add external JavaScript import metadata to the result. This is currently used
   * by the development server to optimize the prebundling process.
   * @param implicitBrowser External dependencies for the browser bundles due to the external packages option.
   * @param implicitServer External dependencies for the server bundles due to the external packages option.
   * @param explicit External dependencies due to explicit project configuration.
   */
  setExternalMetadata(
    implicitBrowser: string[],
    implicitServer: string[],
    explicit: string[],
  ): void {
    this.externalMetadata = { implicitBrowser, implicitServer, explicit };
  }

  get output() {
    return {
      success: this.errors.length === 0,
    };
  }

  get outputWithFiles() {
    return {
      success: this.errors.length === 0,
      outputFiles: this.outputFiles,
      assetFiles: this.assetFiles,
      errors: this.errors,
      externalMetadata: this.externalMetadata,
    };
  }

  get watchFiles(): Readonly<string[]> {
    const { typescriptContexts, otherContexts } = this.rebuildContexts;

    return [
      // Bundler contexts internally normalize file dependencies.
      ...typescriptContexts.flatMap((context) => [...context.watchFiles]),
      ...otherContexts.flatMap((context) => [...context.watchFiles]),
      // These files originate from TS/NG and can have POSIX path separators even on Windows.
      // To ensure path comparisons are valid, all these paths must be normalized.
      ...(this.codeBundleCache?.referencedFiles?.map(normalize) ?? []),
      // The assets source files.
      ...this.assetFiles.map(({ source }) => source),
      ...this.extraWatchFiles,
    ];
  }

  createRebuildState(fileChanges: ChangedFiles): RebuildState {
    return {
      rebuildContexts: this.rebuildContexts,
      codeBundleCache: this.codeBundleCache,
      componentStyleBundler: this.componentStyleBundler,
      fileChanges,
      previousOutputInfo: new Map(
        this.outputFiles.map(({ path, hash, type }) => [path, { hash, type }]),
      ),
      previousAssetsInfo: new Map(
        this.assetFiles.map(({ source, destination }) => [source, destination]),
      ),
      templateUpdates: this.templateUpdates,
    };
  }

  findChangedFiles(
    previousOutputHashes: ReadonlyMap<string, { hash: string; type: BuildOutputFileType }>,
  ): Set<string> {
    const changed = new Set<string>();
    for (const file of this.outputFiles) {
      const previousHash = previousOutputHashes.get(file.path)?.hash;
      if (previousHash === undefined || previousHash !== file.hash) {
        changed.add(file.path);
      }
    }

    return changed;
  }

  #disposal?: Promise<void>;

  dispose(): Promise<void> {
    return (this.#disposal ??= this.#dispose());
  }

  async #dispose(): Promise<void> {
    try {
      await Promise.allSettled([
        ...this.rebuildContexts.typescriptContexts.map((context) => context.dispose()),
        ...this.rebuildContexts.otherContexts.map((context) => context.dispose()),
        this.componentStyleBundler.dispose(),
      ]);
    } finally {
      this.codeBundleCache?.clear();
    }
  }
}