[heft] Require a logging name for every operation

apps/heft/src/cli/HeftActionRunner.ts

@@ -341,8 +341,8 @@ export class HeftActionRunner {
  executeAsync: (state: IWatchLoopState): Promise<OperationStatus> => {
  return this._executeOnceAsync(executionManager, state.abortSignal, state.requestRun);
  },
- onRequestRun: (requestor?: string) => {
- terminal.writeLine(Colors.bold(`New run requested by ${requestor || 'unknown task'}`));
+ onRequestRun: (requester: string) => {
+ terminal.writeLine(Colors.bold(`New run requested by ${requester}`));
  },
  onAbort: () => {
  terminal.writeLine(Colors.bold(`Cancelling incremental build...`));
@@ -354,7 +354,7 @@ export class HeftActionRunner {
  private async _executeOnceAsync(
  executionManager: OperationExecutionManager,
  abortSignal: AbortSignal,
- requestRun?: (requestor?: string) => void
+ requestRun?: (requester: string) => void
  ): Promise<OperationStatus> {
  // Execute the action operations
  return await runWithLoggingAsync(
@@ -453,6 +453,7 @@ function _getOrCreatePhaseOperation(
  // Only create the operation. Dependencies are hooked up separately
  operation = new Operation({
  groupName: phase.phaseName,
+ operationName: `${phase.phaseName} phase`,
  runner: new PhaseOperationRunner({ phase, internalHeftSession })
  });
  operations.set(key, operation);
@@ -472,6 +473,7 @@ function _getOrCreateTaskOperation(
  if (!operation) {
  operation = new Operation({
  groupName: task.parentPhase.phaseName,
+ operationName: `${task.taskName} task`,
  runner: new TaskOperationRunner({
  internalHeftSession,
  task

apps/heft/src/operations/runners/PhaseOperationRunner.ts

@@ -23,7 +23,7 @@ export class PhaseOperationRunner implements IOperationRunner {
  private readonly _options: IPhaseOperationRunnerOptions;
  private _isClean: boolean = false;
 
- public get name(): string {
+ public get operationName(): string {
  return `Phase ${JSON.stringify(this._options.phase.phaseName)}`;
  }
 

apps/heft/src/operations/runners/TaskOperationRunner.ts

@@ -55,7 +55,7 @@ export class TaskOperationRunner implements IOperationRunner {
 
  public readonly silent: boolean = false;
 
- public get name(): string {
+ public get operationName(): string {
  const { taskName, parentPhase } = this._options.task;
  return `Task ${JSON.stringify(taskName)} of phase ${JSON.stringify(parentPhase.phaseName)}`;
  }

common/reviews/api/operation-graph.api.md

@@ -33,7 +33,7 @@ export interface IExecuteOperationContext extends Omit<IOperationRunnerContext,
  afterExecute(operation: Operation, state: IOperationState): void;
  beforeExecute(operation: Operation, state: IOperationState): void;
  queueWork(workFn: () => Promise<OperationStatus>, priority: number): Promise<OperationStatus>;
- requestRun?: (requestor?: string) => void;
+ requestRun?: (requester: string) => void;
  terminal: ITerminal;
 }
 
@@ -50,23 +50,23 @@ export interface IOperationExecutionOptions {
  // (undocumented)
  parallelism: number;
  // (undocumented)
- requestRun?: (requestor?: string) => void;
+ requestRun?: (requester: string) => void;
  // (undocumented)
  terminal: ITerminal;
 }
 
 // @beta
 export interface IOperationOptions {
  groupName?: string | undefined;
- name?: string | undefined;
+ operationName: string;
  runner?: IOperationRunner | undefined;
  weight?: number | undefined;
 }
 
 // @beta
 export interface IOperationRunner {
  executeAsync(context: IOperationRunnerContext): Promise<OperationStatus>;
- readonly name: string;
+ readonly operationName: string;
  silent: boolean;
 }
 
@@ -99,7 +99,7 @@ export interface IRequestRunEventMessage {
  // (undocumented)
  event: 'requestRun';
  // (undocumented)
- requestor?: string;
+ requester: string;
 }
 
 // @beta
@@ -127,20 +127,20 @@ export interface IWatchLoopOptions {
  executeAsync: (state: IWatchLoopState) => Promise<OperationStatus>;
  onAbort: () => void;
  onBeforeExecute: () => void;
- onRequestRun: (requestor?: string) => void;
+ onRequestRun: (requester: string) => void;
 }
 
 // @beta
 export interface IWatchLoopState {
  // (undocumented)
  get abortSignal(): AbortSignal;
  // (undocumented)
- requestRun: (requestor?: string) => void;
+ requestRun: (requester: string) => void;
 }
 
 // @beta
 export class Operation implements IOperationStates {
- constructor(options?: IOperationOptions);
+ constructor(options: IOperationOptions);
  // (undocumented)
  addDependency(dependency: Operation): void;
  readonly consumers: Set<Operation>;
@@ -152,7 +152,7 @@ export class Operation implements IOperationStates {
  _executeAsync(context: IExecuteOperationContext): Promise<OperationStatus>;
  readonly groupName: string | undefined;
  lastState: IOperationState | undefined;
- readonly name: string | undefined;
+ readonly operationName: string;
  // (undocumented)
  reset(): void;
  runner: IOperationRunner | undefined;
@@ -231,7 +231,7 @@ export class Stopwatch {
 export class WatchLoop implements IWatchLoopState {
  constructor(options: IWatchLoopOptions);
  get abortSignal(): AbortSignal;
- requestRun: (requestor?: string) => void;
+ requestRun: (requester: string) => void;
  runIPCAsync(host?: IPCHost): Promise<void>;
  runUntilAbortedAsync(abortSignal: AbortSignal, onWaiting: () => void): Promise<void>;
  runUntilStableAsync(abortSignal: AbortSignal): Promise<OperationStatus>;

libraries/operation-graph/src/IOperationRunner.ts

@@ -81,7 +81,7 @@ export interface IOperationRunner {
  /**
  * Name of the operation, for logging.
  */
- readonly name: string;
+ readonly operationName: string;
 
  /**
  * Indicates that this runner is architectural and should not be reported on.

libraries/operation-graph/src/Operation.ts

@@ -21,7 +21,7 @@ export interface IOperationOptions {
  /**
  * The name of this operation, for logging.
  */
- name?: string | undefined;
+ operationName: string;
 
  /**
  * The group that this operation belongs to. Will be used for logging and duration tracking.
@@ -67,7 +67,7 @@ export interface IExecuteOperationContext extends Omit<IOperationRunnerContext,
  * A callback to the overarching orchestrator to request that the operation be invoked again.
  * Used in watch mode to signal that inputs have changed.
  */
- requestRun?: (requestor?: string) => void;
+ requestRun?: (requester: string) => void;
 
  /**
  * Terminal to write output to.
@@ -100,7 +100,7 @@ export class Operation implements IOperationStates {
  /**
  * The name of this operation, for logging.
  */
- public readonly name: string | undefined;
+ public readonly operationName: string;
 
  /**
  * When the scheduler is ready to process this `Operation`, the `runner` implements the actual work of
@@ -173,11 +173,11 @@ export class Operation implements IOperationStates {
  */
  private _runPending: boolean = true;
 
- public constructor(options?: IOperationOptions) {
+ public constructor(options: IOperationOptions) {
  this.groupName = options?.groupName;
  this.runner = options?.runner;
  this.weight = options?.weight || 1;
- this.name = options?.name;
+ this.operationName = options.operationName;
  }
 
  public addDependency(dependency: Operation): void {
@@ -279,7 +279,9 @@ export class Operation implements IOperationStates {
  // The requestRun callback is assumed to remain constant
  // throughout the lifetime of the process, so it is safe
  // to capture here.
- return requestRun(this.name);
+ return requestRun(this.operationName);
+ case undefined:
+ throw new InternalError(`The operation state is undefined`);
  default:
  // This line is here to enforce exhaustiveness
  const currentStatus: undefined = this.state?.status;

libraries/operation-graph/src/OperationExecutionManager.ts

@@ -20,7 +20,7 @@ export interface IOperationExecutionOptions {
  parallelism: number;
  terminal: ITerminal;
 
- requestRun?: (requestor?: string) => void;
+ requestRun?: (requester: string) => void;
 }
 
 /**
@@ -76,8 +76,8 @@ export class OperationExecutionManager {
  for (const dependency of consumer.dependencies) {
  if (!operations.has(dependency)) {
  throw new Error(
- `Operation ${JSON.stringify(consumer.name)} declares a dependency on operation ` +
- `${JSON.stringify(dependency.name)} that is not in the set of operations to execute.`
+ `Operation ${JSON.stringify(consumer.operationName)} declares a dependency on operation ` +
+ `${JSON.stringify(dependency.operationName)} that is not in the set of operations to execute.`
  );
  }
  }

libraries/operation-graph/src/OperationGroupRecord.ts

@@ -54,7 +54,7 @@ export class OperationGroupRecord {
 
  public setOperationAsComplete(operation: Operation, state: IOperationState): void {
  if (!this._remainingOperations.has(operation)) {
- throw new InternalError(`Operation ${operation.name} is not in the group ${this.name}`);
+ throw new InternalError(`Operation ${operation.operationName} is not in the group ${this.name}`);
  }
 
  if (state.status === OperationStatus.Aborted) {

libraries/operation-graph/src/WatchLoop.ts

@@ -31,7 +31,7 @@ export interface IWatchLoopOptions {
  /**
  * Logging callback when a run is requested (and hasn't already been).
  */
- onRequestRun: (requestor?: string) => void;
+ onRequestRun: (requester: string) => void;
  /**
  * Logging callback when a run is aborted.
  */
@@ -45,7 +45,7 @@ export interface IWatchLoopOptions {
  */
 export interface IWatchLoopState {
  get abortSignal(): AbortSignal;
- requestRun: (requestor?: string) => void;
+ requestRun: (requester: string) => void;
 }
 
 /**
@@ -61,7 +61,7 @@ export class WatchLoop implements IWatchLoopState {
  private _isRunning: boolean;
  private _runRequested: boolean;
  private _requestRunPromise: Promise<string | undefined>;
- private _resolveRequestRun!: (requestor?: string) => void;
+ private _resolveRequestRun!: (requester: string) => void;
 
  public constructor(options: IWatchLoopOptions) {
  this._options = options;
@@ -148,7 +148,7 @@ export class WatchLoop implements IWatchLoopState {
  let runRequestedFromHost: boolean = true;
  let status: OperationStatus = OperationStatus.Ready;
 
- function requestRunFromHost(requestor?: string): void {
+ function requestRunFromHost(requester: string): void {
  if (runRequestedFromHost) {
  return;
  }
@@ -157,7 +157,7 @@ export class WatchLoop implements IWatchLoopState {
 
  const requestRunMessage: IRequestRunEventMessage = {
  event: 'requestRun',
- requestor
+ requester
  };
 
  host.send!(requestRunMessage);
@@ -193,7 +193,9 @@ export class WatchLoop implements IWatchLoopState {
 
  try {
  status = await this.runUntilStableAsync(abortController.signal);
- this._requestRunPromise.finally(requestRunFromHost);
+ this._requestRunPromise.finally(() => {
+ requestRunFromHost('runIPCAsync');
+ });
  } catch (err) {
  status = OperationStatus.Failure;
  return reject(err);
@@ -224,16 +226,16 @@ export class WatchLoop implements IWatchLoopState {
  /**
  * Requests that a new run occur.
  */
- public requestRun: (requestor?: string) => void = (requestor?: string) => {
+ public requestRun: (requester: string) => void = (requester: string) => {
  if (!this._runRequested) {
- this._options.onRequestRun(requestor);
+ this._options.onRequestRun(requester);
  this._runRequested = true;
  if (this._isRunning) {
  this._options.onAbort();
  this._abortCurrent();
  }
  }
- this._resolveRequestRun(requestor);
+ this._resolveRequestRun(requester);
  };
 
  /**

libraries/operation-graph/src/calculateCriticalPath.ts

@@ -2,7 +2,7 @@
 // See LICENSE in the project root for license information.
 
 export interface ISortableOperation<T extends ISortableOperation<T>> {
- name: string | undefined;
+ operationName: string | undefined;
  criticalPathLength?: number | undefined;
  weight: number;
  consumers: Set<T>;
@@ -54,7 +54,9 @@ export function calculateShortestPath<T extends ISortableOperation<T>>(
  }
 
  if (!finalParent) {
- throw new Error(`Could not find a path from "${startOperation.name}" to "${endOperation.name}"`);
+ throw new Error(
+ `Could not find a path from "${startOperation.operationName}" to "${endOperation.operationName}"`
+ );
  }
 
  // Walk back up the path from the end operation to the start operation
@@ -81,7 +83,7 @@ export function calculateCriticalPathLength<T extends ISortableOperation<T>>(
 
  throw new Error(
  'A cyclic dependency was encountered:\n ' +
- shortestPath.map((visitedTask) => visitedTask.name).join('\n -> ')
+ shortestPath.map((visitedTask) => visitedTask.operationName).join('\n -> ')
  );
  }
 

libraries/operation-graph/src/protocol.types.ts

@@ -10,7 +10,7 @@ import type { OperationStatus } from './OperationStatus';
  */
 export interface IRequestRunEventMessage {
  event: 'requestRun';
- requestor?: string;
+ requester: string;
 }
 
 /**