[rush] Replay logs for warnings and errors as well

build-tests/rush-redis-cobuild-plugin-integration-test/sandbox/repo/.gitignore

@@ -4,4 +4,5 @@ common/temp/
 common/autoinstallers/*/.npmrc
 projects/*/dist/
 *.log
-node_modules/
+node_modules/
+

common/changes/@microsoft/rush/sennyeya-log-replays_2024-04-29-20-05.json

@@ -0,0 +1,10 @@
+{
+ "changes": [
+ {
+ "packageName": "@microsoft/rush",
+ "comment": "Fix an issue where warnings and errors were not shown in the build summary for all cobuild agents.",
+ "type": "none"
+ }
+ ],
+ "packageName": "@microsoft/rush"
+}

common/reviews/api/rush-lib.api.md

@@ -16,7 +16,7 @@ import { CommandLineParameterKind } from '@rushstack/ts-command-line';
 import { HookMap } from 'tapable';
 import { IPackageJson } from '@rushstack/node-core-library';
 import { ITerminal } from '@rushstack/terminal';
-import type { ITerminalProvider } from '@rushstack/terminal';
+import { ITerminalProvider } from '@rushstack/terminal';
 import { JsonObject } from '@rushstack/node-core-library';
 import { PackageNameParser } from '@rushstack/node-core-library';
 import type { StdioSummarizer } from '@rushstack/terminal';
@@ -567,6 +567,8 @@ export interface _IOperationMetadata {
  // (undocumented)
  errorLogPath: string;
  // (undocumented)
+ logChunksPath: string;
+ // (undocumented)
  logPath: string;
 }
 
@@ -912,13 +914,13 @@ export class _OperationMetadataManager {
  constructor(options: _IOperationMetadataManagerOptions);
  get relativeFilepaths(): string[];
  // (undocumented)
- saveAsync({ durationInSeconds, cobuildContextId, cobuildRunnerId, logPath, errorLogPath }: _IOperationMetadata): Promise<void>;
+ saveAsync({ durationInSeconds, cobuildContextId, cobuildRunnerId, logPath, errorLogPath, logChunksPath }: _IOperationMetadata): Promise<void>;
  // (undocumented)
  readonly stateFile: _OperationStateFile;
  // (undocumented)
- tryRestoreAsync({ terminal, logPath, errorLogPath }: {
+ tryRestoreAsync({ terminal, terminalProvider, errorLogPath }: {
+ terminalProvider: ITerminalProvider;
  terminal: ITerminal;
- logPath: string;
  errorLogPath: string;
  }): Promise<void>;
 }

libraries/rush-lib/src/logic/operations/CacheableOperationPlugin.ts

@@ -322,7 +322,7 @@ export class CacheableOperationPlugin implements IPhasedCommandPlugin {
  // has changed happens inside the hashing logic.
  //
 
- const { logPath, errorLogPath } = ProjectLogWritable.getLogFilePaths({
+ const { errorLogPath } = ProjectLogWritable.getLogFilePaths({
  project,
  logFilenameIdentifier: phase.logFilenameIdentifier
  });
@@ -340,12 +340,17 @@ export class CacheableOperationPlugin implements IPhasedCommandPlugin {
  );
  if (restoreFromCacheSuccess) {
  buildCacheContext.cacheRestored = true;
- // Restore the original state of the operation without cache
- await operationMetadataManager?.tryRestoreAsync({
- terminal: buildCacheTerminal,
- logPath,
- errorLogPath
- });
+ await runnerContext.runWithTerminalAsync(
+ async (taskTerminal, terminalProvider) => {
+ // Restore the original state of the operation without cache
+ await operationMetadataManager?.tryRestoreAsync({
+ terminalProvider,
+ terminal: buildCacheTerminal,
+ errorLogPath
+ });
+ },
+ { createLogFile: false }
+ );
  }
  return !!restoreFromCacheSuccess;
  };
@@ -448,7 +453,7 @@ export class CacheableOperationPlugin implements IPhasedCommandPlugin {
  // Save the metadata to disk
  const { logFilenameIdentifier } = phase;
  const { duration: durationInSeconds } = stopwatch;
- const { logPath, errorLogPath } = ProjectLogWritable.getLogFilePaths({
+ const { logPath, errorLogPath, logChunksPath } = ProjectLogWritable.getLogFilePaths({
  project,
  logFilenameIdentifier
  });
@@ -457,7 +462,8 @@ export class CacheableOperationPlugin implements IPhasedCommandPlugin {
  cobuildContextId: cobuildLock?.cobuildConfiguration.cobuildContextId,
  cobuildRunnerId: cobuildLock?.cobuildConfiguration.cobuildRunnerId,
  logPath,
- errorLogPath
+ errorLogPath,
+ logChunksPath
  });
  }
 

libraries/rush-lib/src/logic/operations/LogChunksWritable.ts

@@ -0,0 +1,107 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+import { TerminalWritable, type ITerminalChunk } from '@rushstack/terminal';
+import { FileWriter } from '@rushstack/node-core-library';
+import type { CollatedTerminal } from '@rushstack/stream-collator';
+
+import type { RushConfigurationProject } from '../../api/RushConfigurationProject';
+import { RushConstants } from '../RushConstants';
+import { getRelativeLogFilePathBase } from './ProjectLogWritable';
+
+/**
+ * A new terminal stream that writes all log chunks to a JSON format so they can be faithfully reconstructed
+ * during build cache restores. This is used for adding warning + error messages in cobuilds where the original
+ * logs cannot be completely restored from the existing `all.log` and `error.log` files.
+ *
+ * Example output:
+ * libraries/rush-lib/.rush/temp/operations/rush-lib._phase_build.chunks.jsonl
+ * ```
+ * {"kind":"O","text":"Invoking: heft run --only build -- --clean \n"}
+ * {"kind":"O","text":" ---- build started ---- \n"}
+ * {"kind":"O","text":"[build:clean] Deleted 0 files and 5 folders\n"}
+ * {"kind":"O","text":"[build:typescript] Using TypeScript version 5.4.2\n"}
+ * {"kind":"O","text":"[build:lint] Using ESLint version 8.57.0\n"}
+ * {"kind":"E","text":"[build:lint] Warning: libraries/rush-lib/src/logic/operations/LogChunksWritable.ts:15:7 - (@typescript-eslint/typedef) Expected test to have a type annotation.\n"}
+ * {"kind":"E","text":"[build:lint] Warning: libraries/rush-lib/src/logic/operations/LogChunksWritable.ts:15:7 - (@typescript-eslint/no-unused-vars) 'test' is assigned a value but never used.\n"}
+ * {"kind":"O","text":"[build:typescript] Copied 1138 folders or files and linked 0 files\n"}
+ * {"kind":"O","text":"[build:webpack] Using Webpack version 5.82.1\n"}
+ * {"kind":"O","text":"[build:webpack] Running Webpack compilation\n"}
+ * {"kind":"O","text":"[build:api-extractor] Using API Extractor version 7.43.1\n"}
+ * {"kind":"O","text":"[build:api-extractor] Analysis will use the bundled TypeScript version 5.4.2\n"}
+ * {"kind":"O","text":"[build:copy-mock-flush-telemetry-plugin] Copied 1260 folders or files and linked 5 files\n"}
+ * {"kind":"O","text":" ---- build finished (6.856s) ---- \n"}
+ * {"kind":"O","text":"-------------------- Finished (6.858s) --------------------\n"}
+ * ```
+ *
+ */
+export class LogChunksWritable extends TerminalWritable {
+ public readonly logChunksPath: string;
+ public readonly relativeLogChunksPath: string;
+
+ private _chunkWriter: FileWriter;
+ private readonly _terminal: CollatedTerminal;
+
+ public constructor(
+ project: RushConfigurationProject,
+ terminal: CollatedTerminal,
+ /**
+ * A unique identifier for the log file. This is used to generate the prefix for the log file name.
+ */
+ logFilenameIdentifier: string
+ ) {
+ super();
+
+ const { logChunksPath, relativeLogChunksPath } = LogChunksWritable.getLogFilePaths({
+ project,
+ logFilenameIdentifier
+ });
+ this.logChunksPath = logChunksPath;
+ this.relativeLogChunksPath = relativeLogChunksPath;
+
+ this._terminal = terminal;
+
+ this._chunkWriter = FileWriter.open(this.logChunksPath);
+ }
+
+ public static getLogFilePaths({
+ project,
+ logFilenameIdentifier,
+ isLegacyLog = false
+ }: {
+ project: RushConfigurationProject;
+ logFilenameIdentifier: string;
+ isLegacyLog?: boolean;
+ }): {
+ logChunksPath: string;
+ relativeLogChunksPath: string;
+ } {
+ const { projectFolder } = project;
+
+ const logFileBaseName: string = getRelativeLogFilePathBase(
+ project,
+ logFilenameIdentifier,
+ isLegacyLog,
+ `.rush/${RushConstants.rushTempFolderName}/operations`
+ );
+ const relativeLogChunksPath: string = `${logFileBaseName}.chunks.jsonl`;
+ const logChunksPath: string = `${projectFolder}/${relativeLogChunksPath}`;
+
+ return {
+ logChunksPath,
+ relativeLogChunksPath
+ };
+ }
+
+ protected onWriteChunk(chunk: ITerminalChunk): void {
+ this._chunkWriter.write(JSON.stringify(chunk) + '\n');
+ }
+
+ protected onClose(): void {
+ try {
+ this._chunkWriter?.close();
+ } catch (error) {
+ this._terminal.writeStderrLine('Failed to close file handle for ' + this._chunkWriter?.filePath);
+ }
+ }
+}

libraries/rush-lib/src/logic/operations/OperationExecutionRecord.ts

@@ -24,6 +24,7 @@ import type { IPhase } from '../../api/CommandLineConfiguration';
 import type { RushConfigurationProject } from '../../api/RushConfigurationProject';
 import { CollatedTerminalProvider } from '../../utilities/CollatedTerminalProvider';
 import { ProjectLogWritable } from './ProjectLogWritable';
+import { LogChunksWritable } from './LogChunksWritable';
 
 export interface IOperationExecutionRecordContext {
  streamCollator: StreamCollator;
@@ -199,28 +200,44 @@ export class OperationExecutionRecord implements IOperationRunnerContext {
  `${associatedPhase.logFilenameIdentifier}${logFileSuffix}`
  )
  : undefined;
+ const logChunksWritable: LogChunksWritable | undefined =
+ associatedPhase && associatedProject
+ ? new LogChunksWritable(
+ associatedProject,
+ this.collatedWriter.terminal,
+ `${associatedPhase.logFilenameIdentifier}${logFileSuffix}`
+ )
+ : undefined;
+
+ const fileWritables: TerminalWritable[] = [projectLogWritable, logChunksWritable].filter(
+ (writable): writable is ProjectLogWritable | LogChunksWritable => writable !== undefined
+ );
 
  try {
  //#region OPERATION LOGGING
  // TERMINAL PIPELINE:
  //
  // +--> quietModeTransform? --> collatedWriter
  // |
- // normalizeNewlineTransform --1--> stderrLineTransform --2--> removeColorsTransform --> projectLogWritable
- // |
+ // normalizeNewlineTransform --1--> stderrLineTransform --2--> removeColorsTransform --> fileWritablesSplitter -> projectLogWritable (optional)
+ // | | -> logChunksWritable (optional)
  // +--> stdioSummarizer
- const destination: TerminalWritable = projectLogWritable
- ? new SplitterTransform({
- destinations: [
- new TextRewriterTransform({
- destination: projectLogWritable,
- removeColors: true,
- normalizeNewlines: NewlineKind.OsDefault
- }),
- stdioSummarizer
- ]
- })
- : stdioSummarizer;
+ const destination: TerminalWritable =
+ fileWritables.length > 0
+ ? new SplitterTransform({
+ destinations: [
+ ...fileWritables.map(
+ (writeable) =>
+ new TextRewriterTransform({
+ destination: writeable,
+ removeColors: true,
+ normalizeNewlines: NewlineKind.OsDefault
+ })
+ ),
+ stdioSummarizer
+ ]
+ })
+ : stdioSummarizer;
 
  const stderrLineTransform: StderrLineTransform = new StderrLineTransform({
  destination,