Require IOperationOptions.name

Author: octogonz

apps/heft/src/cli/HeftActionRunner.ts

@@ -447,6 +447,7 @@ function _getOrCreatePhaseOperation(
     // Only create the operation. Dependencies are hooked up separately
     operation = new Operation({
       groupName: phase.phaseName,
+      name: `${phase.phaseName} phase`,
       runner: new PhaseOperationRunner({ phase, internalHeftSession })
     });
     operations.set(key, operation);
@@ -466,6 +467,7 @@ function _getOrCreateTaskOperation(
   if (!operation) {
     operation = new Operation({
       groupName: task.parentPhase.phaseName,
+      name: `${task.taskName} task`,
       runner: new TaskOperationRunner({
         internalHeftSession,
         task

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

@@ -58,7 +58,7 @@ export interface IOperationExecutionOptions {
 // @beta
 export interface IOperationOptions {
     groupName?: string | undefined;
-    name?: string | undefined;
+    name: string;
     runner?: IOperationRunner | undefined;
     weight?: number | undefined;
 }
@@ -140,7 +140,7 @@ export interface IWatchLoopState {
 
 // @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 name: string;
     // (undocumented)
     reset(): void;
     runner: IOperationRunner | undefined;

libraries/operation-graph/src/Operation.ts

@@ -22,7 +22,7 @@ export interface IOperationOptions {
   /**
    * The name of this operation, for logging.
    */
-  name?: string | undefined;
+  name: string;
 
   /**
    * The group that this operation belongs to. Will be used for logging and duration tracking.
@@ -101,7 +101,7 @@ export class Operation implements IOperationStates {
   /**
    * The name of this operation, for logging.
    */
-  public readonly name: string | undefined;
+  public readonly name: string;
 
   /**
    * When the scheduler is ready to process this `Operation`, the `runner` implements the actual work of
@@ -174,11 +174,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.name = options.name;
   }
 
   public addDependency(dependency: Operation): void {