Update rush-serve-plugin

Author: dmichon-msft

rush-plugins/rush-serve-plugin/README.md

@@ -35,9 +35,9 @@ const socket = new WebSocket(`wss://${self.location.host}${buildStatusWebSocketP
 
 // Static graph metadata (does not include dynamic status fields)
 const operationsByName: Map<string, IOperationInfo> = new Map();
-// Current execution state for this pass
+// Current execution state for this iteration
 const executionStates: Map<string, IOperationExecutionState> = new Map();
-// Queued states for the next pass (if a pass has been queued but not yet started)
+// Queued states for the next iteration (if an iteration has been scheduled but not yet started)
 const queuedStates: Map<string, IOperationExecutionState> = new Map();
 
 let buildStatus: ReadableOperationStatus = 'Ready';
@@ -85,12 +85,12 @@ socket.addEventListener('message', (ev) => {
       // Manager state only – no operation arrays here
       break;
     }
-    case 'pass-queued': {
+    case 'iteration-scheduled': {
       applyQueuedStates(msg.queuedStates);
       break;
     }
     case 'before-execute': {
-      // Start of a pass: queuedStates become irrelevant until a new pass is queued
+      // Start of an iteration: queuedStates become irrelevant until a new iteration is scheduled
       applyQueuedStates(undefined);
       upsertExecutionStates(msg.executionStates);
       buildStatus = 'Executing';

rush-plugins/rush-serve-plugin/src/api.types.ts

@@ -80,11 +80,11 @@ export interface IOperationExecutionState {
   name: string;
 
   /**
-   * Indicates whether this operation is scheduled to actually run in the current execution pass.
+   * Indicates whether this operation is scheduled to actually run in the current execution iteration.
    * This is derived from the scheduler's decision (the execution record's `enabled` boolean), which
    * takes into account the configured enabled state plus change detection and dependency invalidation.
    */
-  runInThisPass: boolean;
+  runInThisIteration: boolean;
 
   /**
    * If true, this operation currently owns some kind of active resource (e.g. a service or a watch process).
@@ -128,18 +128,18 @@ export interface IRushSessionInfo {
 }
 
 /**
- * Message sent to a WebSocket client at the start of an execution pass.
+ * Message sent to a WebSocket client at the start of an execution iteration.
  */
 // Event (server->client) message interfaces (alphabetically by interface name)
 /**
- * Message sent to a WebSocket client at the end of an execution pass.
+ * Message sent to a WebSocket client at the end of an execution iteration.
  */
 export interface IWebSocketAfterExecuteEventMessage {
   event: 'after-execute';
   executionStates: IOperationExecutionState[];
   status: ReadableOperationStatus;
   /**
-   * The results of the previous execution pass for all operations, if available.
+   * The results of the previous execution iteration for all operations, if available.
    * This mirrors the values() of OperationExecutionManager.lastExecutionResults at the time of emission.
    */
   lastExecutionResults?: IOperationExecutionState[];
@@ -189,9 +189,9 @@ export interface IWebSocketSyncEventMessage {
     parallelism: number;
     debugMode: boolean;
     verbose: boolean;
-    runNextPassBehavior: 'automatic' | 'manual';
+    pauseNextIteration: boolean;
     status: ReadableOperationStatus;
-    hasQueuedPass: boolean;
+    hasScheduledIteration: boolean;
   };
   /**
    * The results of the previous execution pass for all operations, if available.
@@ -209,10 +209,10 @@ export interface IWebSocketSyncOperationsEventMessage {
 }
 
 /**
- * Message sent when a pass is queued with its initial set of queued operations.
+ * Message sent when an iteration is queued with its initial set of queued operations.
  */
 export interface IWebSocketPassQueuedEventMessage {
-  event: 'pass-queued';
+  event: 'iteration-scheduled';
   queuedStates: IOperationExecutionState[];
 }
 
@@ -321,12 +321,12 @@ export interface IWebSocketSetParallelismCommandMessage {
 }
 
 /**
- * Message received from a WebSocket client to set how new execution passes are triggered after invalidations.
- * 'automatic' runs new passes automatically; 'manual' requires an explicit execute command.
+ * Message received from a WebSocket client to set whether new execution iterations are paused when scheduled.
+ * A value of true means iterations are paused (manual mode); false means iterations run automatically.
  */
-export interface IWebSocketSetRunNextPassBehaviorCommandMessage {
-  command: 'set-run-next-pass-behavior';
-  value: 'automatic' | 'manual';
+export interface IWebSocketSetPauseNextIterationCommandMessage {
+  command: 'set-pause-next-iteration';
+  value: boolean;
 }
 
 /**
@@ -361,6 +361,6 @@ export type IWebSocketCommandMessage =
   | IWebSocketSetDebugCommandMessage
   | IWebSocketSetEnabledStatesCommandMessage
   | IWebSocketSetParallelismCommandMessage
-  | IWebSocketSetRunNextPassBehaviorCommandMessage
+  | IWebSocketSetPauseNextIterationCommandMessage
   | IWebSocketSetVerboseCommandMessage
   | IWebSocketSyncCommandMessage;

rush-plugins/rush-serve-plugin/src/tryEnableBuildStatusWebSocketServer.ts

@@ -14,7 +14,8 @@ import {
   OperationStatus,
   type ILogFilePaths,
   type RushConfiguration,
-  type IOperationExecutionManager
+  type IOperationExecutionManager,
+  type IOperationExecutionIterationOptions
 } from '@rushstack/rush-sdk';
 import { type ITerminalChunk, TerminalChunkKind, TerminalWritable } from '@rushstack/terminal';
 
@@ -183,7 +184,7 @@ export function tryEnableBuildStatusWebSocketServer(
     const { packageName } = associatedProject;
     return {
       name,
-      runInThisPass: record.enabled,
+      runInThisIteration: record.enabled,
       isActive: !!runner.isActive,
       status: readableStatusFromStatus[record.status],
       startTime: record.stopwatch.startTime,
@@ -242,9 +243,9 @@ export function tryEnableBuildStatusWebSocketServer(
       parallelism: executionManager.parallelism,
       debugMode: executionManager.debugMode,
       verbose: !executionManager.quietMode,
-      runNextPassBehavior: executionManager.runNextPassBehavior,
+      pauseNextIteration: executionManager.pauseNextIteration,
       status: buildStatus,
-      hasQueuedPass: executionManager.hasQueuedPass
+      hasScheduledIteration: executionManager.hasScheduledIteration
     };
   }
 
@@ -261,9 +262,9 @@ export function tryEnableBuildStatusWebSocketServer(
         parallelism: 1,
         debugMode: false,
         verbose: true,
-        runNextPassBehavior: 'automatic',
+        pauseNextIteration: false,
         status: buildStatus,
-        hasQueuedPass: false
+        hasScheduledIteration: false
       },
       lastExecutionResults: executionManager
         ? convertToExecutionStateArray(executionManager.lastExecutionResults.values())
@@ -278,10 +279,13 @@ export function tryEnableBuildStatusWebSocketServer(
 
     manager.addTerminalDestination(new WebSocketTerminalWritable(webSockets));
 
-    hooks.beforeExecuteOperationsAsync.tap(
+    hooks.beforeExecuteIterationAsync.tap(
       PLUGIN_NAME,
-      (operationsToExecute: ReadonlyMap<Operation, IOperationExecutionResult>): void => {
-        // Clear queuedStates when the pass begins executing
+      (
+        operationsToExecute: ReadonlyMap<Operation, IOperationExecutionResult>,
+        iterationOptions: IOperationExecutionIterationOptions
+      ): void => {
+        // Clear queuedStates when the iteration begins executing
         queuedStates = undefined;
         for (const [operation, result] of operationsToExecute) {
           operationStates.set(operation.name, result);
@@ -296,7 +300,7 @@ export function tryEnableBuildStatusWebSocketServer(
       }
     );
 
-    hooks.afterExecuteOperationsAsync.tap(
+    hooks.afterExecuteIterationAsync.tap(
       PLUGIN_NAME,
       (
         status: OperationStatus,
@@ -332,13 +336,13 @@ export function tryEnableBuildStatusWebSocketServer(
       }
     );
 
-    // Capture queued operations for next pass
-    hooks.onPassQueued.tap(
+    // Capture queued operations for next iteration
+    hooks.onIterationScheduled.tap(
       PLUGIN_NAME,
       (queuedMap: ReadonlyMap<Operation, IOperationExecutionResult>): void => {
         queuedStates = Array.from(queuedMap.values());
         const message: IWebSocketPassQueuedEventMessage = {
-          event: 'pass-queued',
+          event: 'iteration-scheduled',
           queuedStates: convertToExecutionStateArray(queuedStates)
         };
         sendWebSocketMessage(message);
@@ -441,7 +445,7 @@ export function tryEnableBuildStatusWebSocketServer(
           }
 
           case 'abort-execution': {
-            void executionManager?.abortCurrentPassAsync();
+            void executionManager?.abortCurrentIterationAsync();
             break;
           }
 
@@ -457,8 +461,8 @@ export function tryEnableBuildStatusWebSocketServer(
           case 'execute': {
             if (executionManager) {
               const definedExecutionManager: IOperationExecutionManager = executionManager;
-              void definedExecutionManager.queuePassAsync({}).then(() => {
-                return definedExecutionManager.executeQueuedPassAsync();
+              void definedExecutionManager.scheduleIterationAsync({}).then(() => {
+                return definedExecutionManager.executeScheduledIterationAsync();
               });
             }
             break;
@@ -474,12 +478,9 @@ export function tryEnableBuildStatusWebSocketServer(
             break;
           }
 
-          case 'set-run-next-pass-behavior': {
-            if (
-              executionManager &&
-              (parsedMessage.value === 'automatic' || parsedMessage.value === 'manual')
-            ) {
-              executionManager.runNextPassBehavior = parsedMessage.value;
+          case 'set-pause-next-iteration': {
+            if (executionManager && typeof parsedMessage.value === 'boolean') {
+              executionManager.pauseNextIteration = parsedMessage.value;
             }
             break;
           }