Merge pull request #4328 from dmichon-msft/rush-serve-socket

[rush-serve-plugin] Add build status monitoring via WebSocket

common/changes/@microsoft/rush/rush-serve-socket_2023-09-14-20-17.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@microsoft/rush",
+      "comment": "Add \"Waiting\" operation status for operations that have one or more dependencies still pending. Ensure that the `onOperationStatusChanged` hook fires for every status change.",
+      "type": "none"
+    }
+  ],
+  "packageName": "@microsoft/rush"
+}

common/changes/@microsoft/rush/rush-serve-socket_2023-09-14-20-58.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@microsoft/rush",
+      "comment": "Add support for optional build status notifications over a web socket connection to `@rushstack/rush-serve-plugin`.",
+      "type": "none"
+    }
+  ],
+  "packageName": "@microsoft/rush"
+}

common/config/rush/nonbrowser-approved-packages.json

@@ -406,14 +406,14 @@
       "name": "compression",
       "allowedCategories": [ "libraries" ]
     },
-    {
-      "name": "cors",
-      "allowedCategories": [ "libraries" ]
-    },
     {
       "name": "constructs",
       "allowedCategories": [ "tests" ]
     },
+    {
+      "name": "cors",
+      "allowedCategories": [ "libraries" ]
+    },
     {
       "name": "css-loader",
       "allowedCategories": [ "libraries", "tests" ]
@@ -826,6 +826,10 @@
       "name": "wordwrap",
       "allowedCategories": [ "libraries" ]
     },
+    {
+      "name": "ws",
+      "allowedCategories": [ "libraries" ]
+    },
     {
       "name": "xmldoc",
       "allowedCategories": [ "libraries" ]

common/config/rush/repo-state.json

@@ -1,5 +1,5 @@
 // DO NOT MODIFY THIS FILE MANUALLY BUT DO COMMIT IT. It is generated and used by Rush.
 {
-  "pnpmShrinkwrapHash": "5ee5e5b7fa262ef5096e77b7d86ef24ade887c5b",
+  "pnpmShrinkwrapHash": "af97ead68ee0632cb19c93ef203e84fc0c1e1375",
   "preferredVersionsHash": "1926a5b12ac8f4ab41e76503a0d1d0dccc9c0e06"
 }

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

@@ -877,7 +877,8 @@ export enum OperationStatus {
     RemoteExecuting = "REMOTE EXECUTING",
     Skipped = "SKIPPED",
     Success = "SUCCESS",
-    SuccessWithWarning = "SUCCESS WITH WARNINGS"
+    SuccessWithWarning = "SUCCESS WITH WARNINGS",
+    Waiting = "WAITING"
 }
 
 // @public (undocumented)

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

@@ -74,6 +74,19 @@ export class AsyncOperationQueue
    */
   public complete(record: OperationExecutionRecord): void {
     this._completedOperations.add(record);
+
+    // Apply status changes to direct dependents
+    for (const item of record.consumers) {
+      // Remove this operation from the dependencies, to unblock the scheduler
+      if (
+        item.dependencies.delete(record) &&
+        item.dependencies.size === 0 &&
+        item.status === OperationStatus.Waiting
+      ) {
+        item.status = OperationStatus.Ready;
+      }
+    }
+
     if (this._completedOperations.size === this._totalOperations) {
       this._isDone = true;
     }
@@ -88,39 +101,39 @@ export class AsyncOperationQueue
 
     // By iterating in reverse order we do less array shuffling when removing operations
     for (let i: number = queue.length - 1; waitingIterators.length > 0 && i >= 0; i--) {
-      const operation: OperationExecutionRecord = queue[i];
+      const record: OperationExecutionRecord = queue[i];
 
       if (
-        operation.status === OperationStatus.Blocked ||
-        operation.status === OperationStatus.Skipped ||
-        operation.status === OperationStatus.Success ||
-        operation.status === OperationStatus.SuccessWithWarning ||
-        operation.status === OperationStatus.FromCache ||
-        operation.status === OperationStatus.NoOp ||
-        operation.status === OperationStatus.Failure
+        record.status === OperationStatus.Blocked ||
+        record.status === OperationStatus.Skipped ||
+        record.status === OperationStatus.Success ||
+        record.status === OperationStatus.SuccessWithWarning ||
+        record.status === OperationStatus.FromCache ||
+        record.status === OperationStatus.NoOp ||
+        record.status === OperationStatus.Failure
       ) {
         // It shouldn't be on the queue, remove it
         queue.splice(i, 1);
-      } else if (
-        operation.status === OperationStatus.Queued ||
-        operation.status === OperationStatus.Executing
-      ) {
+      } else if (record.status === OperationStatus.Queued || record.status === OperationStatus.Executing) {
         // This operation is currently executing
         // next one plz :)
+      } else if (record.status === OperationStatus.Waiting) {
+        // This operation is not yet ready to be executed
+        // next one plz :)
         continue;
-      } else if (operation.status === OperationStatus.RemoteExecuting) {
+      } else if (record.status === OperationStatus.RemoteExecuting) {
         // This operation is not ready to execute yet, but it may become ready later
         // next one plz :)
         continue;
-      } else if (operation.status !== OperationStatus.Ready) {
+      } else if (record.status !== OperationStatus.Ready) {
         // Sanity check
-        throw new Error(`Unexpected status "${operation.status}" for queued operation: ${operation.name}`);
-      } else if (operation.dependencies.size === 0) {
+        throw new Error(`Unexpected status "${record.status}" for queued operation: ${record.name}`);
+      } else {
         // This task is ready to process, hand it to the iterator.
         // Needs to have queue semantics, otherwise tools that iterate it get confused
-        operation.status = OperationStatus.Queued;
+        record.status = OperationStatus.Queued;
         waitingIterators.shift()!({
-          value: operation,
+          value: record,
           done: false
         });
       }

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

@@ -75,6 +75,7 @@ const TIMELINE_WIDTH: number = 109;
  * Timeline - symbols representing each operation status
  */
 const TIMELINE_CHART_SYMBOLS: Record<OperationStatus, string> = {
+  [OperationStatus.Waiting]: '?',
   [OperationStatus.Ready]: '?',
   [OperationStatus.Queued]: '?',
   [OperationStatus.Executing]: '?',
@@ -92,6 +93,7 @@ const TIMELINE_CHART_SYMBOLS: Record<OperationStatus, string> = {
  * Timeline - colorizer for each operation status
  */
 const TIMELINE_CHART_COLORIZER: Record<OperationStatus, (string: string) => string> = {
+  [OperationStatus.Waiting]: colors.yellow,
   [OperationStatus.Ready]: colors.yellow,
   [OperationStatus.Queued]: colors.yellow,
   [OperationStatus.Executing]: colors.yellow,

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

@@ -394,12 +394,6 @@ export class OperationExecutionManager {
     if (record.status !== OperationStatus.RemoteExecuting) {
       // If the operation was not remote, then we can notify queue that it is complete
       this._executionQueue.complete(record);
-
-      // Apply status changes to direct dependents
-      for (const item of record.consumers) {
-        // Remove this operation from the dependencies, to unblock the scheduler
-        item.dependencies.delete(record);
-      }
     }
   }
 }

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

@@ -33,14 +33,6 @@ export class OperationExecutionRecord implements IOperationRunnerContext {
    */
   public readonly operation: Operation;
 
-  /**
-   * The current execution status of an operation. Operations start in the 'ready' state,
-   * but can be 'blocked' if an upstream operation failed. It is 'executing' when
-   * the operation is executing. Once execution is complete, it is either 'success' or
-   * 'failure'.
-   */
-  public status: OperationStatus = OperationStatus.Ready;
-
   /**
    * The error which occurred while executing this operation, this is stored in case we need
    * it later (for example to re-print errors at end of execution).
@@ -101,6 +93,7 @@ export class OperationExecutionRecord implements IOperationRunnerContext {
   private readonly _context: IOperationExecutionRecordContext;
 
   private _collatedWriter: CollatedWriter | undefined = undefined;
+  private _status: OperationStatus;
 
   public constructor(operation: Operation, context: IOperationExecutionRecordContext) {
     const { runner, associatedPhase, associatedProject } = operation;
@@ -123,6 +116,7 @@ export class OperationExecutionRecord implements IOperationRunnerContext {
       });
     }
     this._context = context;
+    this._status = operation.dependencies.size > 0 ? OperationStatus.Waiting : OperationStatus.Ready;
   }
 
   public get name(): string {
@@ -159,6 +153,23 @@ export class OperationExecutionRecord implements IOperationRunnerContext {
     return this._operationMetadataManager?.stateFile.state?.cobuildRunnerId;
   }
 
+  /**
+   * The current execution status of an operation. Operations start in the 'ready' state,
+   * but can be 'blocked' if an upstream operation failed. It is 'executing' when
+   * the operation is executing. Once execution is complete, it is either 'success' or
+   * 'failure'.
+   */
+  public get status(): OperationStatus {
+    return this._status;
+  }
+  public set status(newStatus: OperationStatus) {
+    if (newStatus === this._status) {
+      return;
+    }
+    this._status = newStatus;
+    this._context.onOperationStatusChanged?.(this);
+  }
+
   public async executeAsync({
     onStart,
     onResult
@@ -169,9 +180,8 @@ export class OperationExecutionRecord implements IOperationRunnerContext {
     if (this.status === OperationStatus.RemoteExecuting) {
       this.stopwatch.reset();
     }
-    this.status = OperationStatus.Executing;
     this.stopwatch.start();
-    this._context.onOperationStatusChanged?.(this);
+    this.status = OperationStatus.Executing;
 
     try {
       const earlyReturnStatus: OperationStatus | undefined = await onStart(this);
@@ -194,7 +204,6 @@ export class OperationExecutionRecord implements IOperationRunnerContext {
         this.stdioSummarizer.close();
         this.stopwatch.stop();
       }
-      this._context.onOperationStatusChanged?.(this);
     }
   }
 }

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

@@ -7,9 +7,13 @@
  */
 export enum OperationStatus {
   /**
-   * The Operation is on the queue, ready to execute (but may be waiting for dependencies)
+   * The Operation is ready to execute. All its dependencies have succeeded.
    */
   Ready = 'READY',
+  /**
+   * The Operation is waiting for one or more dependencies to complete.
+   */
+  Waiting = 'WAITING',
   /**
    * The Operation is Queued
    */