chore: PR feedback on requester and changelog

Author: bartvandenende-wm

apps/heft/src/cli/HeftActionRunner.ts

@@ -333,8 +333,8 @@ export class HeftActionRunner {
       executeAsync: (state: IWatchLoopState): Promise<OperationStatus> => {
         return this._executeOnceAsync(executionManager, state.abortSignal, state.requestRun);
       },
-      onRequestRun: (requester: string) => {
-        terminal.writeLine(Colorize.bold(`New run requested by ${requester}`));
+      onRequestRun: (requestor: string) => {
+        terminal.writeLine(Colorize.bold(`New run requested by ${requestor}`));
       },
       onAbort: () => {
         terminal.writeLine(Colorize.bold(`Cancelling incremental build...`));
@@ -346,7 +346,7 @@ export class HeftActionRunner {
   private async _executeOnceAsync(
     executionManager: OperationExecutionManager,
     abortSignal: AbortSignal,
-    requestRun?: (requester: string) => void
+    requestRun?: (requestor: string) => void
   ): Promise<OperationStatus> {
     // Record this as the start of task execution.
     this._metricsCollector.setStartTime();

common/changes/@microsoft/rush/octogonz-heft-issue-4467_2024-10-01-08-08.json

@@ -2,8 +2,8 @@
   "changes": [
     {
       "packageName": "@rushstack/operation-graph",
-      "comment": "Require a logging name for every operation.",
-      "type": "patch"
+      "comment": "(BREAKING API CHANGE) Require an operationName for every operation to improve logging.",
+      "type": "minor"
     }
   ],
   "packageName": "@rushstack/operation-graph"

common/changes/@rushstack/operation-graph/octogonz-heft-issue-4467_2024-10-01-08-08.json

@@ -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?: (requester: string) => void;
+    requestRun?: (requestor: string) => void;
     terminal: ITerminal;
 }
 
@@ -50,7 +50,7 @@ export interface IOperationExecutionOptions {
     // (undocumented)
     parallelism: number;
     // (undocumented)
-    requestRun?: (requester: string) => void;
+    requestRun?: (requestor: string) => void;
     // (undocumented)
     terminal: ITerminal;
 }
@@ -99,7 +99,7 @@ export interface IRequestRunEventMessage {
     // (undocumented)
     event: 'requestRun';
     // (undocumented)
-    requester: string;
+    requestor: string;
 }
 
 // @beta
@@ -127,15 +127,15 @@ export interface IWatchLoopOptions {
     executeAsync: (state: IWatchLoopState) => Promise<OperationStatus>;
     onAbort: () => void;
     onBeforeExecute: () => void;
-    onRequestRun: (requester: string) => void;
+    onRequestRun: (requestor: string) => void;
 }
 
 // @beta
 export interface IWatchLoopState {
     // (undocumented)
     get abortSignal(): AbortSignal;
     // (undocumented)
-    requestRun: (requester: string) => void;
+    requestRun: (requestor: string) => void;
 }
 
 // @beta
@@ -231,7 +231,7 @@ export class Stopwatch {
 export class WatchLoop implements IWatchLoopState {
     constructor(options: IWatchLoopOptions);
     get abortSignal(): AbortSignal;
-    requestRun: (requester: string) => void;
+    requestRun: (requestor: string) => void;
     runIPCAsync(host?: IPCHost): Promise<void>;
     runUntilAbortedAsync(abortSignal: AbortSignal, onWaiting: () => void): Promise<void>;
     runUntilStableAsync(abortSignal: AbortSignal): Promise<OperationStatus>;

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

@@ -68,7 +68,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?: (requester: string) => void;
+  requestRun?: (requestor: string) => void;
 
   /**
    * Terminal to write output to.

libraries/operation-graph/src/Operation.ts

@@ -21,7 +21,7 @@ export interface IOperationExecutionOptions {
   parallelism: number;
   terminal: ITerminal;
 
-  requestRun?: (requester: string) => void;
+  requestRun?: (requestor: string) => void;
 }
 
 /**

libraries/operation-graph/src/OperationExecutionManager.ts

@@ -31,7 +31,7 @@ export interface IWatchLoopOptions {
   /**
    * Logging callback when a run is requested (and hasn't already been).
    */
-  onRequestRun: (requester: string) => void;
+  onRequestRun: (requestor: string) => void;
   /**
    * Logging callback when a run is aborted.
    */
@@ -45,7 +45,7 @@ export interface IWatchLoopOptions {
  */
 export interface IWatchLoopState {
   get abortSignal(): AbortSignal;
-  requestRun: (requester: string) => void;
+  requestRun: (requestor: string) => void;
 }
 
 /**
@@ -60,7 +60,7 @@ export class WatchLoop implements IWatchLoopState {
   private _isRunning: boolean;
   private _runRequested: boolean;
   private _requestRunPromise: Promise<string | undefined>;
-  private _resolveRequestRun!: (requester: string) => void;
+  private _resolveRequestRun!: (requestor: string) => void;
 
   public constructor(options: IWatchLoopOptions) {
     this._options = options;
@@ -147,7 +147,7 @@ export class WatchLoop implements IWatchLoopState {
         }
       }
 
-      function requestRunFromHost(requester: string): void {
+      function requestRunFromHost(requestor: string): void {
         if (runRequestedFromHost) {
           return;
         }
@@ -156,7 +156,7 @@ export class WatchLoop implements IWatchLoopState {
 
         const requestRunMessage: IRequestRunEventMessage = {
           event: 'requestRun',
-          requester
+          requestor
         };
 
         tryMessageHost(requestRunMessage);
@@ -228,16 +228,16 @@ export class WatchLoop implements IWatchLoopState {
   /**
    * Requests that a new run occur.
    */
-  public requestRun: (requester: string) => void = (requester: string) => {
+  public requestRun: (requestor: string) => void = (requestor: string) => {
     if (!this._runRequested) {
-      this._options.onRequestRun(requester);
+      this._options.onRequestRun(requestor);
       this._runRequested = true;
       if (this._isRunning) {
         this._options.onAbort();
         this._abortCurrent();
       }
     }
-    this._resolveRequestRun(requester);
+    this._resolveRequestRun(requestor);
   };
 
   /**

libraries/operation-graph/src/WatchLoop.ts

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

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

@@ -103,7 +103,7 @@ export class IPCOperationRunner implements IOperationRunner {
 
           this._ipcProcess.on('message', (message: unknown) => {
             if (isRequestRunEventMessage(message)) {
-              this._requestRun(message.requester);
+              this._requestRun(message.requestor);
             } else if (isSyncEventMessage(message)) {
               resolveReadyPromise();
             }