@rushstack/operation-graph 0.2.25 → 0.2.27

package/dist/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.46.1"
+      "packageVersion": "7.46.2"
     }
   ]
 }

package/lib/WatchLoop.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"WatchLoop.d.ts","sourceRoot":"","sources":["../src/WatchLoop.ts"],"names":[],"mappings":";AAOA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,KAAK,EAEV,OAAO,EAIR,MAAM,kBAAkB,CAAC;AAE1B;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,YAAY,EAAE,CAAC,KAAK,EAAE,eAAe,KAAK,OAAO,CAAC,eAAe,CAAC,CAAC;IACnE;;OAEG;IACH,eAAe,EAAE,MAAM,IAAI,CAAC;IAC5B;;OAEG;IACH,YAAY,EAAE,CAAC,SAAS,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IAC3C;;OAEG;IACH,OAAO,EAAE,MAAM,IAAI,CAAC;CACrB;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,WAAW,IAAI,WAAW,CAAC;IAC/B,UAAU,EAAE,CAAC,SAAS,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;CAC1C;AAED;;;;GAIG;AACH,qBAAa,SAAU,YAAW,eAAe;IAC/C,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA8B;IAEvD,OAAO,CAAC,gBAAgB,CAAkB;IAC1C,OAAO,CAAC,UAAU,CAAU;IAC5B,OAAO,CAAC,aAAa,CAAU;IAC/B,OAAO,CAAC,kBAAkB,CAA8B;IACxD,OAAO,CAAC,kBAAkB,CAAgC;gBAEvC,OAAO,EAAE,iBAAiB;IAY7C;;OAEG;IACU,mBAAmB,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAAC,eAAe,CAAC;IA0BpF;;OAEG;IACU,oBAAoB,CAAC,WAAW,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAgBjG;;;OAGG;IACU,WAAW,CAAC,IAAI,GAAE,OAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAkFhE;;OAEG;IACI,UAAU,EAAE,CAAC,SAAS,CAAC,EAAE,MAAM,KAAK,IAAI,CAU7C;IAEF;;OAEG;IACH,IAAW,WAAW,IAAI,WAAW,CAEpC;IAED;;OAEG;IACH,OAAO,CAAC,aAAa,CAEnB;IAEF;;OAEG;IACH,OAAO,CAAC,MAAM;IAad;;;OAGG;YACW,kBAAkB;CAiBjC"}
+{"version":3,"file":"WatchLoop.d.ts","sourceRoot":"","sources":["../src/WatchLoop.ts"],"names":[],"mappings":";AAOA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,KAAK,EAEV,OAAO,EAIR,MAAM,kBAAkB,CAAC;AAE1B;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,YAAY,EAAE,CAAC,KAAK,EAAE,eAAe,KAAK,OAAO,CAAC,eAAe,CAAC,CAAC;IACnE;;OAEG;IACH,eAAe,EAAE,MAAM,IAAI,CAAC;IAC5B;;OAEG;IACH,YAAY,EAAE,CAAC,SAAS,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IAC3C;;OAEG;IACH,OAAO,EAAE,MAAM,IAAI,CAAC;CACrB;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,WAAW,IAAI,WAAW,CAAC;IAC/B,UAAU,EAAE,CAAC,SAAS,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;CAC1C;AAED;;;;GAIG;AACH,qBAAa,SAAU,YAAW,eAAe;IAC/C,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA8B;IAEvD,OAAO,CAAC,gBAAgB,CAAkB;IAC1C,OAAO,CAAC,UAAU,CAAU;IAC5B,OAAO,CAAC,aAAa,CAAU;IAC/B,OAAO,CAAC,kBAAkB,CAA8B;IACxD,OAAO,CAAC,kBAAkB,CAAgC;gBAEvC,OAAO,EAAE,iBAAiB;IAY7C;;OAEG;IACU,mBAAmB,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAAC,eAAe,CAAC;IA0BpF;;OAEG;IACU,oBAAoB,CAAC,WAAW,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAgBjG;;;OAGG;IACU,WAAW,CAAC,IAAI,GAAE,OAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAgGhE;;OAEG;IACI,UAAU,EAAE,CAAC,SAAS,CAAC,EAAE,MAAM,KAAK,IAAI,CAU7C;IAEF;;OAEG;IACH,IAAW,WAAW,IAAI,WAAW,CAEpC;IAED;;OAEG;IACH,OAAO,CAAC,aAAa,CAEnB;IAEF;;OAEG;IACH,OAAO,CAAC,MAAM;IAad;;;OAGG;YACW,kBAAkB;CAiBjC"}

package/lib/WatchLoop.js

@@ -90,6 +90,17 @@ class WatchLoop {
             let abortController = new AbortController();
             let runRequestedFromHost = true;
             let status = OperationStatus_1.OperationStatus.Ready;
+            function tryMessageHost(message) {
+                if (!host.send) {
+                    return reject(new Error('Host does not support IPC'));
+                }
+                try {
+                    host.send(message);
+                }
+                catch (err) {
+                    reject(new Error(`Unable to communicate with host: ${err}`));
+                }
+            }
             function requestRunFromHost(requestor) {
                 if (runRequestedFromHost) {
                     return;
@@ -99,14 +110,14 @@ class WatchLoop {
                     event: 'requestRun',
                     requestor
                 };
-                host.send(requestRunMessage);
+                tryMessageHost(requestRunMessage);
             }
             function sendSync() {
                 const syncMessage = {
                     event: 'sync',
                     status
                 };
-                host.send(syncMessage);
+                tryMessageHost(syncMessage);
             }
             host.on('message', async (message) => {
                 switch (message.command) {
@@ -139,7 +150,7 @@ class WatchLoop {
                                 event: 'after-execute',
                                 status
                             };
-                            host.send(afterExecuteMessage);
+                            tryMessageHost(afterExecuteMessage);
                         }
                         return;
                     }

package/lib/WatchLoop.js.map

@@ -1 +1 @@
-{"version":3,"file":"WatchLoop.js","sourceRoot":"","sources":["../src/WatchLoop.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAE3D,6CAAmC;AAEnC,oEAAoE;AAEpE,uDAAoD;AA2CpD;;;;GAIG;AACH,MAAa,SAAS;IASpB,YAAmB,OAA0B;QAkJ7C;;WAEG;QACI,eAAU,GAAiC,CAAC,SAAkB,EAAE,EAAE;YACvE,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;gBACxB,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;gBACtC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;gBAC1B,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;oBACpB,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;oBACxB,IAAI,CAAC,aAAa,EAAE,CAAC;gBACvB,CAAC;YACH,CAAC;YACD,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;QACrC,CAAC,CAAC;QASF;;WAEG;QACK,kBAAa,GAAG,GAAS,EAAE;YACjC,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,CAAC;QAChC,CAAC,CAAC;QA5KA,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QAExB,IAAI,CAAC,gBAAgB,GAAG,IAAI,eAAe,EAAE,CAAC;QAC9C,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;QACxB,8EAA8E;QAC9E,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;QAC1B,IAAI,CAAC,kBAAkB,GAAG,IAAI,OAAO,CAAqB,CAAC,OAAO,EAAE,EAAE;YACpE,IAAI,CAAC,kBAAkB,GAAG,OAAO,CAAC;QACpC,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,mBAAmB,CAAC,WAAwB;QACvD,IAAI,WAAW,CAAC,OAAO,EAAE,CAAC;YACxB,OAAO,iCAAe,CAAC,OAAO,CAAC;QACjC,CAAC;QAED,WAAW,CAAC,gBAAgB,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QAE1E,IAAI,CAAC;YACH,IAAI,MAAM,GAAoB,iCAAe,CAAC,KAAK,CAAC;YAEpD,GAAG,CAAC;gBACF,oHAAoH;gBACpH,IAAI,WAAW,CAAC,OAAO,EAAE,CAAC;oBACxB,OAAO,iCAAe,CAAC,OAAO,CAAC;gBACjC,CAAC;gBAED,MAAM,GAAG,MAAM,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC3C,CAAC,QAAQ,IAAI,CAAC,aAAa,EAAE;YAE7B,0GAA0G;YAC1G,OAAO,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,iCAAe,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC;QAChE,CAAC;gBAAS,CAAC;YACT,WAAW,CAAC,mBAAmB,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;QAC/D,CAAC;IACH,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,oBAAoB,CAAC,WAAwB,EAAE,SAAqB;QAC/E,IAAI,WAAW,CAAC,OAAO,EAAE,CAAC;YACxB,OAAO;QACT,CAAC;QAED,MAAM,YAAY,GAAqB,IAAA,kBAAI,EAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QAElE,iDAAiD;QACjD,OAAO,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC;YAC5B,MAAM,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC;YAE5C,SAAS,EAAE,CAAC;YACZ,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,kBAAkB,EAAE,YAAY,CAAC,CAAC,CAAC;QAC9D,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,WAAW,CAAC,OAAgB,OAAO;QAC9C,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC1C,IAAI,eAAe,GAAoB,IAAI,eAAe,EAAE,CAAC;YAE7D,IAAI,oBAAoB,GAAY,IAAI,CAAC;YACzC,IAAI,MAAM,GAAoB,iCAAe,CAAC,KAAK,CAAC;YAEpD,SAAS,kBAAkB,CAAC,SAAkB;gBAC5C,IAAI,oBAAoB,EAAE,CAAC;oBACzB,OAAO;gBACT,CAAC;gBAED,oBAAoB,GAAG,IAAI,CAAC;gBAE5B,MAAM,iBAAiB,GAA4B;oBACjD,KAAK,EAAE,YAAY;oBACnB,SAAS;iBACV,CAAC;gBAEF,IAAI,CAAC,IAAK,CAAC,iBAAiB,CAAC,CAAC;YAChC,CAAC;YAED,SAAS,QAAQ;gBACf,MAAM,WAAW,GAAsB;oBACrC,KAAK,EAAE,MAAM;oBACb,MAAM;iBACP,CAAC;gBACF,IAAI,CAAC,IAAK,CAAC,WAAW,CAAC,CAAC;YAC1B,CAAC;YAED,IAAI,CAAC,EAAE,CAAC,SAAS,EAAE,KAAK,EAAE,OAA+B,EAAE,EAAE;gBAC3D,QAAQ,OAAO,CAAC,OAAO,EAAE,CAAC;oBACxB,KAAK,MAAM,CAAC,CAAC,CAAC;wBACZ,OAAO,OAAO,EAAE,CAAC;oBACnB,CAAC;oBAED,KAAK,QAAQ,CAAC,CAAC,CAAC;wBACd,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;4BACpB,eAAe,CAAC,KAAK,EAAE,CAAC;4BACxB,eAAe,GAAG,IAAI,eAAe,EAAE,CAAC;4BACxC,0EAA0E;wBAC5E,CAAC;wBACD,OAAO;oBACT,CAAC;oBAED,KAAK,KAAK,CAAC,CAAC,CAAC;wBACX,oBAAoB,GAAG,KAAK,CAAC;wBAE7B,MAAM,GAAG,iCAAe,CAAC,SAAS,CAAC;wBAEnC,IAAI,CAAC;4BACH,MAAM,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;4BAChE,8FAA8F;4BAC9F,mEAAmE;4BACnE,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;wBACtD,CAAC;wBAAC,OAAO,GAAG,EAAE,CAAC;4BACb,MAAM,GAAG,iCAAe,CAAC,OAAO,CAAC;4BACjC,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;wBACrB,CAAC;gCAAS,CAAC;4BACT,MAAM,mBAAmB,GAA8B;gCACrD,KAAK,EAAE,eAAe;gCACtB,MAAM;6BACP,CAAC;4BACF,IAAI,CAAC,IAAK,CAAC,mBAAmB,CAAC,CAAC;wBAClC,CAAC;wBACD,OAAO;oBACT,CAAC;oBAED,KAAK,MAAM,CAAC,CAAC,CAAC;wBACZ,OAAO,QAAQ,EAAE,CAAC;oBACpB,CAAC;oBAED,OAAO,CAAC,CAAC,CAAC;wBACR,OAAO,MAAM,CAAC,IAAI,KAAK,CAAC,iCAAiC,OAAO,EAAE,CAAC,CAAC,CAAC;oBACvE,CAAC;gBACH,CAAC;YACH,CAAC,CAAC,CAAC;YAEH,QAAQ,EAAE,CAAC;QACb,CAAC,CAAC,CAAC;IACL,CAAC;IAiBD;;OAEG;IACH,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC;IACtC,CAAC;IASD;;OAEG;IACK,MAAM;QACZ,IAAI,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;YACzC,IAAI,CAAC,gBAAgB,GAAG,IAAI,eAAe,EAAE,CAAC;QAChD,CAAC;QAED,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACvB,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC;YAC3B,IAAI,CAAC,kBAAkB,GAAG,IAAI,OAAO,CAAqB,CAAC,OAAO,EAAE,EAAE;gBACpE,IAAI,CAAC,kBAAkB,GAAG,OAAO,CAAC;YACpC,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,kBAAkB;QAC9B,IAAI,CAAC,MAAM,EAAE,CAAC;QAEd,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE,CAAC;QAChC,IAAI,CAAC;YACH,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;YACvB,OAAO,MAAM,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAChD,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,CAAC,GAAG,YAAY,wCAAoB,CAAC,EAAE,CAAC;gBAC3C,MAAM,GAAG,CAAC;YACZ,CAAC;iBAAM,CAAC;gBACN,OAAO,iCAAe,CAAC,OAAO,CAAC;YACjC,CAAC;QACH,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;QAC1B,CAAC;IACH,CAAC;CACF;AA7ND,8BA6NC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport { once } from 'node:events';\n\nimport { AlreadyReportedError } from '@rushstack/node-core-library';\n\nimport { OperationStatus } from './OperationStatus';\nimport type {\n  IAfterExecuteEventMessage,\n  IPCHost,\n  CommandMessageFromHost,\n  ISyncEventMessage,\n  IRequestRunEventMessage\n} from './protocol.types';\n\n/**\n * Callbacks for the watch loop.\n *\n * @beta\n */\nexport interface IWatchLoopOptions {\n  /**\n   * Callback that performs the core work of a single iteration.\n   */\n  executeAsync: (state: IWatchLoopState) => Promise<OperationStatus>;\n  /**\n   * Logging callback immediately before execution occurs.\n   */\n  onBeforeExecute: () => void;\n  /**\n   * Logging callback when a run is requested (and hasn't already been).\n   */\n  onRequestRun: (requestor?: string) => void;\n  /**\n   * Logging callback when a run is aborted.\n   */\n  onAbort: () => void;\n}\n\n/**\n * The public API surface of the watch loop, for use in the `executeAsync` callback.\n *\n * @beta\n */\nexport interface IWatchLoopState {\n  get abortSignal(): AbortSignal;\n  requestRun: (requestor?: string) => void;\n}\n\n/**\n * This class implements a watch loop.\n *\n * @beta\n */\nexport class WatchLoop implements IWatchLoopState {\n  private readonly _options: Readonly<IWatchLoopOptions>;\n\n  private _abortController: AbortController;\n  private _isRunning: boolean;\n  private _runRequested: boolean;\n  private _requestRunPromise: Promise<string | undefined>;\n  private _resolveRequestRun!: (requestor?: string) => void;\n\n  public constructor(options: IWatchLoopOptions) {\n    this._options = options;\n\n    this._abortController = new AbortController();\n    this._isRunning = false;\n    // Always start as true, so that any requests prior to first run are silenced.\n    this._runRequested = true;\n    this._requestRunPromise = new Promise<string | undefined>((resolve) => {\n      this._resolveRequestRun = resolve;\n    });\n  }\n\n  /**\n   * Runs the inner loop until the abort signal is cancelled or a run completes without a new run being requested.\n   */\n  public async runUntilStableAsync(abortSignal: AbortSignal): Promise<OperationStatus> {\n    if (abortSignal.aborted) {\n      return OperationStatus.Aborted;\n    }\n\n    abortSignal.addEventListener('abort', this._abortCurrent, { once: true });\n\n    try {\n      let result: OperationStatus = OperationStatus.Ready;\n\n      do {\n        // Always check the abort signal first, in case it was aborted in the async tick since the last executeAsync() call.\n        if (abortSignal.aborted) {\n          return OperationStatus.Aborted;\n        }\n\n        result = await this._runIterationAsync();\n      } while (this._runRequested);\n\n      // Even if the run has finished, if the abort signal was aborted, we should return `Aborted` just in case.\n      return abortSignal.aborted ? OperationStatus.Aborted : result;\n    } finally {\n      abortSignal.removeEventListener('abort', this._abortCurrent);\n    }\n  }\n\n  /**\n   * Runs the inner loop until the abort signal is aborted. Will otherwise wait indefinitely for a new run to be requested.\n   */\n  public async runUntilAbortedAsync(abortSignal: AbortSignal, onWaiting: () => void): Promise<void> {\n    if (abortSignal.aborted) {\n      return;\n    }\n\n    const abortPromise: Promise<unknown> = once(abortSignal, 'abort');\n\n    // eslint-disable-next-line no-constant-condition\n    while (!abortSignal.aborted) {\n      await this.runUntilStableAsync(abortSignal);\n\n      onWaiting();\n      await Promise.race([this._requestRunPromise, abortPromise]);\n    }\n  }\n\n  /**\n   * Sets up an IPC handler that will run the inner loop when it receives a \"run\" message from the host.\n   * Runs until receiving an \"exit\" message from the host, or aborts early if an unhandled error is thrown.\n   */\n  public async runIPCAsync(host: IPCHost = process): Promise<void> {\n    await new Promise<void>((resolve, reject) => {\n      let abortController: AbortController = new AbortController();\n\n      let runRequestedFromHost: boolean = true;\n      let status: OperationStatus = OperationStatus.Ready;\n\n      function requestRunFromHost(requestor?: string): void {\n        if (runRequestedFromHost) {\n          return;\n        }\n\n        runRequestedFromHost = true;\n\n        const requestRunMessage: IRequestRunEventMessage = {\n          event: 'requestRun',\n          requestor\n        };\n\n        host.send!(requestRunMessage);\n      }\n\n      function sendSync(): void {\n        const syncMessage: ISyncEventMessage = {\n          event: 'sync',\n          status\n        };\n        host.send!(syncMessage);\n      }\n\n      host.on('message', async (message: CommandMessageFromHost) => {\n        switch (message.command) {\n          case 'exit': {\n            return resolve();\n          }\n\n          case 'cancel': {\n            if (this._isRunning) {\n              abortController.abort();\n              abortController = new AbortController();\n              // This will terminate the currently executing `runUntilStableAsync` call.\n            }\n            return;\n          }\n\n          case 'run': {\n            runRequestedFromHost = false;\n\n            status = OperationStatus.Executing;\n\n            try {\n              status = await this.runUntilStableAsync(abortController.signal);\n              // ESLINT: \"Promises must be awaited, end with a call to .catch, end with a call to .then ...\"\n              // eslint-disable-next-line @typescript-eslint/no-floating-promises\n              this._requestRunPromise.finally(requestRunFromHost);\n            } catch (err) {\n              status = OperationStatus.Failure;\n              return reject(err);\n            } finally {\n              const afterExecuteMessage: IAfterExecuteEventMessage = {\n                event: 'after-execute',\n                status\n              };\n              host.send!(afterExecuteMessage);\n            }\n            return;\n          }\n\n          case 'sync': {\n            return sendSync();\n          }\n\n          default: {\n            return reject(new Error(`Unexpected command from host: ${message}`));\n          }\n        }\n      });\n\n      sendSync();\n    });\n  }\n\n  /**\n   * Requests that a new run occur.\n   */\n  public requestRun: (requestor?: string) => void = (requestor?: string) => {\n    if (!this._runRequested) {\n      this._options.onRequestRun(requestor);\n      this._runRequested = true;\n      if (this._isRunning) {\n        this._options.onAbort();\n        this._abortCurrent();\n      }\n    }\n    this._resolveRequestRun(requestor);\n  };\n\n  /**\n   * The abort signal for the current iteration.\n   */\n  public get abortSignal(): AbortSignal {\n    return this._abortController.signal;\n  }\n\n  /**\n   * Cancels the current iteration (if possible).\n   */\n  private _abortCurrent = (): void => {\n    this._abortController.abort();\n  };\n\n  /**\n   * Resets the abort signal and run request state.\n   */\n  private _reset(): void {\n    if (this._abortController.signal.aborted) {\n      this._abortController = new AbortController();\n    }\n\n    if (this._runRequested) {\n      this._runRequested = false;\n      this._requestRunPromise = new Promise<string | undefined>((resolve) => {\n        this._resolveRequestRun = resolve;\n      });\n    }\n  }\n\n  /**\n   * Runs a single iteration of the loop.\n   * @returns The status of the iteration.\n   */\n  private async _runIterationAsync(): Promise<OperationStatus> {\n    this._reset();\n\n    this._options.onBeforeExecute();\n    try {\n      this._isRunning = true;\n      return await this._options.executeAsync(this);\n    } catch (err) {\n      if (!(err instanceof AlreadyReportedError)) {\n        throw err;\n      } else {\n        return OperationStatus.Failure;\n      }\n    } finally {\n      this._isRunning = false;\n    }\n  }\n}\n"]}
+{"version":3,"file":"WatchLoop.js","sourceRoot":"","sources":["../src/WatchLoop.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAE3D,6CAAmC;AAEnC,oEAAoE;AAEpE,uDAAoD;AA2CpD;;;;GAIG;AACH,MAAa,SAAS;IASpB,YAAmB,OAA0B;QAgK7C;;WAEG;QACI,eAAU,GAAiC,CAAC,SAAkB,EAAE,EAAE;YACvE,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;gBACxB,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;gBACtC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;gBAC1B,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;oBACpB,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;oBACxB,IAAI,CAAC,aAAa,EAAE,CAAC;gBACvB,CAAC;YACH,CAAC;YACD,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;QACrC,CAAC,CAAC;QASF;;WAEG;QACK,kBAAa,GAAG,GAAS,EAAE;YACjC,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,CAAC;QAChC,CAAC,CAAC;QA1LA,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QAExB,IAAI,CAAC,gBAAgB,GAAG,IAAI,eAAe,EAAE,CAAC;QAC9C,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;QACxB,8EAA8E;QAC9E,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;QAC1B,IAAI,CAAC,kBAAkB,GAAG,IAAI,OAAO,CAAqB,CAAC,OAAO,EAAE,EAAE;YACpE,IAAI,CAAC,kBAAkB,GAAG,OAAO,CAAC;QACpC,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,mBAAmB,CAAC,WAAwB;QACvD,IAAI,WAAW,CAAC,OAAO,EAAE,CAAC;YACxB,OAAO,iCAAe,CAAC,OAAO,CAAC;QACjC,CAAC;QAED,WAAW,CAAC,gBAAgB,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QAE1E,IAAI,CAAC;YACH,IAAI,MAAM,GAAoB,iCAAe,CAAC,KAAK,CAAC;YAEpD,GAAG,CAAC;gBACF,oHAAoH;gBACpH,IAAI,WAAW,CAAC,OAAO,EAAE,CAAC;oBACxB,OAAO,iCAAe,CAAC,OAAO,CAAC;gBACjC,CAAC;gBAED,MAAM,GAAG,MAAM,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC3C,CAAC,QAAQ,IAAI,CAAC,aAAa,EAAE;YAE7B,0GAA0G;YAC1G,OAAO,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,iCAAe,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC;QAChE,CAAC;gBAAS,CAAC;YACT,WAAW,CAAC,mBAAmB,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;QAC/D,CAAC;IACH,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,oBAAoB,CAAC,WAAwB,EAAE,SAAqB;QAC/E,IAAI,WAAW,CAAC,OAAO,EAAE,CAAC;YACxB,OAAO;QACT,CAAC;QAED,MAAM,YAAY,GAAqB,IAAA,kBAAI,EAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QAElE,iDAAiD;QACjD,OAAO,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC;YAC5B,MAAM,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC;YAE5C,SAAS,EAAE,CAAC;YACZ,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,kBAAkB,EAAE,YAAY,CAAC,CAAC,CAAC;QAC9D,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,WAAW,CAAC,OAAgB,OAAO;QAC9C,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC1C,IAAI,eAAe,GAAoB,IAAI,eAAe,EAAE,CAAC;YAE7D,IAAI,oBAAoB,GAAY,IAAI,CAAC;YACzC,IAAI,MAAM,GAAoB,iCAAe,CAAC,KAAK,CAAC;YAEpD,SAAS,cAAc,CACrB,OAAgF;gBAEhF,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;oBACf,OAAO,MAAM,CAAC,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC,CAAC;gBACxD,CAAC;gBAED,IAAI,CAAC;oBACH,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBACrB,CAAC;gBAAC,OAAO,GAAG,EAAE,CAAC;oBACb,MAAM,CAAC,IAAI,KAAK,CAAC,oCAAoC,GAAG,EAAE,CAAC,CAAC,CAAC;gBAC/D,CAAC;YACH,CAAC;YAED,SAAS,kBAAkB,CAAC,SAAkB;gBAC5C,IAAI,oBAAoB,EAAE,CAAC;oBACzB,OAAO;gBACT,CAAC;gBAED,oBAAoB,GAAG,IAAI,CAAC;gBAE5B,MAAM,iBAAiB,GAA4B;oBACjD,KAAK,EAAE,YAAY;oBACnB,SAAS;iBACV,CAAC;gBAEF,cAAc,CAAC,iBAAiB,CAAC,CAAC;YACpC,CAAC;YAED,SAAS,QAAQ;gBACf,MAAM,WAAW,GAAsB;oBACrC,KAAK,EAAE,MAAM;oBACb,MAAM;iBACP,CAAC;gBACF,cAAc,CAAC,WAAW,CAAC,CAAC;YAC9B,CAAC;YAED,IAAI,CAAC,EAAE,CAAC,SAAS,EAAE,KAAK,EAAE,OAA+B,EAAE,EAAE;gBAC3D,QAAQ,OAAO,CAAC,OAAO,EAAE,CAAC;oBACxB,KAAK,MAAM,CAAC,CAAC,CAAC;wBACZ,OAAO,OAAO,EAAE,CAAC;oBACnB,CAAC;oBAED,KAAK,QAAQ,CAAC,CAAC,CAAC;wBACd,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;4BACpB,eAAe,CAAC,KAAK,EAAE,CAAC;4BACxB,eAAe,GAAG,IAAI,eAAe,EAAE,CAAC;4BACxC,0EAA0E;wBAC5E,CAAC;wBACD,OAAO;oBACT,CAAC;oBAED,KAAK,KAAK,CAAC,CAAC,CAAC;wBACX,oBAAoB,GAAG,KAAK,CAAC;wBAE7B,MAAM,GAAG,iCAAe,CAAC,SAAS,CAAC;wBAEnC,IAAI,CAAC;4BACH,MAAM,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;4BAChE,8FAA8F;4BAC9F,mEAAmE;4BACnE,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;wBACtD,CAAC;wBAAC,OAAO,GAAG,EAAE,CAAC;4BACb,MAAM,GAAG,iCAAe,CAAC,OAAO,CAAC;4BACjC,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;wBACrB,CAAC;gCAAS,CAAC;4BACT,MAAM,mBAAmB,GAA8B;gCACrD,KAAK,EAAE,eAAe;gCACtB,MAAM;6BACP,CAAC;4BACF,cAAc,CAAC,mBAAmB,CAAC,CAAC;wBACtC,CAAC;wBACD,OAAO;oBACT,CAAC;oBAED,KAAK,MAAM,CAAC,CAAC,CAAC;wBACZ,OAAO,QAAQ,EAAE,CAAC;oBACpB,CAAC;oBAED,OAAO,CAAC,CAAC,CAAC;wBACR,OAAO,MAAM,CAAC,IAAI,KAAK,CAAC,iCAAiC,OAAO,EAAE,CAAC,CAAC,CAAC;oBACvE,CAAC;gBACH,CAAC;YACH,CAAC,CAAC,CAAC;YAEH,QAAQ,EAAE,CAAC;QACb,CAAC,CAAC,CAAC;IACL,CAAC;IAiBD;;OAEG;IACH,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC;IACtC,CAAC;IASD;;OAEG;IACK,MAAM;QACZ,IAAI,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;YACzC,IAAI,CAAC,gBAAgB,GAAG,IAAI,eAAe,EAAE,CAAC;QAChD,CAAC;QAED,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACvB,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC;YAC3B,IAAI,CAAC,kBAAkB,GAAG,IAAI,OAAO,CAAqB,CAAC,OAAO,EAAE,EAAE;gBACpE,IAAI,CAAC,kBAAkB,GAAG,OAAO,CAAC;YACpC,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,kBAAkB;QAC9B,IAAI,CAAC,MAAM,EAAE,CAAC;QAEd,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE,CAAC;QAChC,IAAI,CAAC;YACH,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;YACvB,OAAO,MAAM,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAChD,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,CAAC,GAAG,YAAY,wCAAoB,CAAC,EAAE,CAAC;gBAC3C,MAAM,GAAG,CAAC;YACZ,CAAC;iBAAM,CAAC;gBACN,OAAO,iCAAe,CAAC,OAAO,CAAC;YACjC,CAAC;QACH,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;QAC1B,CAAC;IACH,CAAC;CACF;AA3OD,8BA2OC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport { once } from 'node:events';\n\nimport { AlreadyReportedError } from '@rushstack/node-core-library';\n\nimport { OperationStatus } from './OperationStatus';\nimport type {\n  IAfterExecuteEventMessage,\n  IPCHost,\n  CommandMessageFromHost,\n  ISyncEventMessage,\n  IRequestRunEventMessage\n} from './protocol.types';\n\n/**\n * Callbacks for the watch loop.\n *\n * @beta\n */\nexport interface IWatchLoopOptions {\n  /**\n   * Callback that performs the core work of a single iteration.\n   */\n  executeAsync: (state: IWatchLoopState) => Promise<OperationStatus>;\n  /**\n   * Logging callback immediately before execution occurs.\n   */\n  onBeforeExecute: () => void;\n  /**\n   * Logging callback when a run is requested (and hasn't already been).\n   */\n  onRequestRun: (requestor?: string) => void;\n  /**\n   * Logging callback when a run is aborted.\n   */\n  onAbort: () => void;\n}\n\n/**\n * The public API surface of the watch loop, for use in the `executeAsync` callback.\n *\n * @beta\n */\nexport interface IWatchLoopState {\n  get abortSignal(): AbortSignal;\n  requestRun: (requestor?: string) => void;\n}\n\n/**\n * This class implements a watch loop.\n *\n * @beta\n */\nexport class WatchLoop implements IWatchLoopState {\n  private readonly _options: Readonly<IWatchLoopOptions>;\n\n  private _abortController: AbortController;\n  private _isRunning: boolean;\n  private _runRequested: boolean;\n  private _requestRunPromise: Promise<string | undefined>;\n  private _resolveRequestRun!: (requestor?: string) => void;\n\n  public constructor(options: IWatchLoopOptions) {\n    this._options = options;\n\n    this._abortController = new AbortController();\n    this._isRunning = false;\n    // Always start as true, so that any requests prior to first run are silenced.\n    this._runRequested = true;\n    this._requestRunPromise = new Promise<string | undefined>((resolve) => {\n      this._resolveRequestRun = resolve;\n    });\n  }\n\n  /**\n   * Runs the inner loop until the abort signal is cancelled or a run completes without a new run being requested.\n   */\n  public async runUntilStableAsync(abortSignal: AbortSignal): Promise<OperationStatus> {\n    if (abortSignal.aborted) {\n      return OperationStatus.Aborted;\n    }\n\n    abortSignal.addEventListener('abort', this._abortCurrent, { once: true });\n\n    try {\n      let result: OperationStatus = OperationStatus.Ready;\n\n      do {\n        // Always check the abort signal first, in case it was aborted in the async tick since the last executeAsync() call.\n        if (abortSignal.aborted) {\n          return OperationStatus.Aborted;\n        }\n\n        result = await this._runIterationAsync();\n      } while (this._runRequested);\n\n      // Even if the run has finished, if the abort signal was aborted, we should return `Aborted` just in case.\n      return abortSignal.aborted ? OperationStatus.Aborted : result;\n    } finally {\n      abortSignal.removeEventListener('abort', this._abortCurrent);\n    }\n  }\n\n  /**\n   * Runs the inner loop until the abort signal is aborted. Will otherwise wait indefinitely for a new run to be requested.\n   */\n  public async runUntilAbortedAsync(abortSignal: AbortSignal, onWaiting: () => void): Promise<void> {\n    if (abortSignal.aborted) {\n      return;\n    }\n\n    const abortPromise: Promise<unknown> = once(abortSignal, 'abort');\n\n    // eslint-disable-next-line no-constant-condition\n    while (!abortSignal.aborted) {\n      await this.runUntilStableAsync(abortSignal);\n\n      onWaiting();\n      await Promise.race([this._requestRunPromise, abortPromise]);\n    }\n  }\n\n  /**\n   * Sets up an IPC handler that will run the inner loop when it receives a \"run\" message from the host.\n   * Runs until receiving an \"exit\" message from the host, or aborts early if an unhandled error is thrown.\n   */\n  public async runIPCAsync(host: IPCHost = process): Promise<void> {\n    await new Promise<void>((resolve, reject) => {\n      let abortController: AbortController = new AbortController();\n\n      let runRequestedFromHost: boolean = true;\n      let status: OperationStatus = OperationStatus.Ready;\n\n      function tryMessageHost(\n        message: ISyncEventMessage | IRequestRunEventMessage | IAfterExecuteEventMessage\n      ): void {\n        if (!host.send) {\n          return reject(new Error('Host does not support IPC'));\n        }\n\n        try {\n          host.send(message);\n        } catch (err) {\n          reject(new Error(`Unable to communicate with host: ${err}`));\n        }\n      }\n\n      function requestRunFromHost(requestor?: string): void {\n        if (runRequestedFromHost) {\n          return;\n        }\n\n        runRequestedFromHost = true;\n\n        const requestRunMessage: IRequestRunEventMessage = {\n          event: 'requestRun',\n          requestor\n        };\n\n        tryMessageHost(requestRunMessage);\n      }\n\n      function sendSync(): void {\n        const syncMessage: ISyncEventMessage = {\n          event: 'sync',\n          status\n        };\n        tryMessageHost(syncMessage);\n      }\n\n      host.on('message', async (message: CommandMessageFromHost) => {\n        switch (message.command) {\n          case 'exit': {\n            return resolve();\n          }\n\n          case 'cancel': {\n            if (this._isRunning) {\n              abortController.abort();\n              abortController = new AbortController();\n              // This will terminate the currently executing `runUntilStableAsync` call.\n            }\n            return;\n          }\n\n          case 'run': {\n            runRequestedFromHost = false;\n\n            status = OperationStatus.Executing;\n\n            try {\n              status = await this.runUntilStableAsync(abortController.signal);\n              // ESLINT: \"Promises must be awaited, end with a call to .catch, end with a call to .then ...\"\n              // eslint-disable-next-line @typescript-eslint/no-floating-promises\n              this._requestRunPromise.finally(requestRunFromHost);\n            } catch (err) {\n              status = OperationStatus.Failure;\n              return reject(err);\n            } finally {\n              const afterExecuteMessage: IAfterExecuteEventMessage = {\n                event: 'after-execute',\n                status\n              };\n              tryMessageHost(afterExecuteMessage);\n            }\n            return;\n          }\n\n          case 'sync': {\n            return sendSync();\n          }\n\n          default: {\n            return reject(new Error(`Unexpected command from host: ${message}`));\n          }\n        }\n      });\n\n      sendSync();\n    });\n  }\n\n  /**\n   * Requests that a new run occur.\n   */\n  public requestRun: (requestor?: string) => void = (requestor?: string) => {\n    if (!this._runRequested) {\n      this._options.onRequestRun(requestor);\n      this._runRequested = true;\n      if (this._isRunning) {\n        this._options.onAbort();\n        this._abortCurrent();\n      }\n    }\n    this._resolveRequestRun(requestor);\n  };\n\n  /**\n   * The abort signal for the current iteration.\n   */\n  public get abortSignal(): AbortSignal {\n    return this._abortController.signal;\n  }\n\n  /**\n   * Cancels the current iteration (if possible).\n   */\n  private _abortCurrent = (): void => {\n    this._abortController.abort();\n  };\n\n  /**\n   * Resets the abort signal and run request state.\n   */\n  private _reset(): void {\n    if (this._abortController.signal.aborted) {\n      this._abortController = new AbortController();\n    }\n\n    if (this._runRequested) {\n      this._runRequested = false;\n      this._requestRunPromise = new Promise<string | undefined>((resolve) => {\n        this._resolveRequestRun = resolve;\n      });\n    }\n  }\n\n  /**\n   * Runs a single iteration of the loop.\n   * @returns The status of the iteration.\n   */\n  private async _runIterationAsync(): Promise<OperationStatus> {\n    this._reset();\n\n    this._options.onBeforeExecute();\n    try {\n      this._isRunning = true;\n      return await this._options.executeAsync(this);\n    } catch (err) {\n      if (!(err instanceof AlreadyReportedError)) {\n        throw err;\n      } else {\n        return OperationStatus.Failure;\n      }\n    } finally {\n      this._isRunning = false;\n    }\n  }\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rushstack/operation-graph",
-  "version": "0.2.25",
+  "version": "0.2.27",
   "description": "Library for managing and executing operations in a directed acyclic graph.",
   "main": "lib/index.js",
   "typings": "dist/operation-graph.d.ts",
@@ -11,12 +11,12 @@
     "directory": "libraries/operation-graph"
   },
   "dependencies": {
-    "@rushstack/terminal": "0.13.0",
-    "@rushstack/node-core-library": "5.4.1"
+    "@rushstack/node-core-library": "5.5.0",
+    "@rushstack/terminal": "0.13.1"
   },
   "devDependencies": {
-    "@rushstack/heft": "0.66.16",
-    "@rushstack/heft-node-rig": "2.6.14",
+    "@rushstack/heft": "0.66.17",
+    "@rushstack/heft-node-rig": "2.6.15",
     "@types/heft-jest": "1.0.1",
     "@types/node": "18.17.15",
     "local-eslint-config": "1.0.0"