@rushstack/operation-graph 0.1.0

package/lib/IOperationRunner.js

@@ -0,0 +1,5 @@
+"use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IOperationRunner.js.map

package/lib/IOperationRunner.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IOperationRunner.js","sourceRoot":"","sources":["../src/IOperationRunner.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D","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 type { OperationStatus } from './OperationStatus';\nimport type { OperationError } from './OperationError';\n\nimport type { Stopwatch } from './Stopwatch';\n\n/**\n * Information passed to the executing `IOperationRunner`\n *\n * @beta\n */\nexport interface IOperationRunnerContext {\n  /**\n   * An abort signal for the overarching execution. Runners should do their best to gracefully abort\n   * as soon as possible if the signal is aborted.\n   */\n  abortSignal: AbortSignal;\n\n  /**\n   * If this is the first time this operation has been executed.\n   */\n  isFirstRun: boolean;\n\n  /**\n   * A callback to the overarching orchestrator to request that the operation be invoked again.\n   * Used in watch mode to signal that inputs have changed.\n   */\n  requestRun?: () => void;\n}\n\n/**\n * Interface contract for a single state of an operation.\n *\n * @beta\n */\nexport interface IOperationState {\n  /**\n   * The status code for the operation.\n   */\n  status: OperationStatus;\n  /**\n   * Whether the operation has been run at least once.\n   */\n  hasBeenRun: boolean;\n  /**\n   * The error, if the status is `OperationStatus.Failure`.\n   */\n  error: OperationError | undefined;\n  /**\n   * Timing information for the operation.\n   */\n  stopwatch: Stopwatch;\n}\n\n/**\n * Interface contract for the current and past state of an operation.\n *\n * @beta\n */\nexport interface IOperationStates {\n  /**\n   * The current state of the operation.\n   */\n  readonly state: Readonly<IOperationState> | undefined;\n  /**\n   * The previous state of the operation.\n   */\n  readonly lastState: Readonly<IOperationState> | undefined;\n}\n\n/**\n * The `Operation` class is a node in the dependency graph of work that needs to be scheduled by the\n * `OperationExecutionManager`. Each `Operation` has a `runner` member of type `IOperationRunner`, whose\n * implementation manages the actual process for running a single operation.\n *\n * @beta\n */\nexport interface IOperationRunner {\n  /**\n   * Name of the operation, for logging.\n   */\n  readonly name: string;\n\n  /**\n   * Indicates that this runner is architectural and should not be reported on.\n   */\n  silent: boolean;\n\n  /**\n   * Method to be executed for the operation.\n   */\n  executeAsync(context: IOperationRunnerContext): Promise<OperationStatus>;\n}\n"]}

package/lib/Operation.d.ts

@@ -0,0 +1,155 @@
+import { ITerminal } from '@rushstack/node-core-library';
+import type { IOperationRunner, IOperationRunnerContext, IOperationState, IOperationStates } from './IOperationRunner';
+import { OperationStatus } from './OperationStatus';
+/**
+ * Options for constructing a new Operation.
+ * @beta
+ */
+export interface IOperationOptions {
+    /**
+     * The name of this operation, for logging.
+     */
+    name?: string | undefined;
+    /**
+     * The group that this operation belongs to. Will be used for logging and duration tracking.
+     */
+    groupName?: string | undefined;
+    /**
+     * When the scheduler is ready to process this `Operation`, the `runner` implements the actual work of
+     * running the operation.
+     */
+    runner?: IOperationRunner | undefined;
+    /**
+     * The weight used by the scheduler to determine order of execution.
+     */
+    weight?: number | undefined;
+}
+/**
+ * Information provided to `executeAsync` by the `OperationExecutionManager`.
+ *
+ * @beta
+ */
+export interface IExecuteOperationContext extends Omit<IOperationRunnerContext, 'isFirstRun' | 'requestRun'> {
+    /**
+     * Function to invoke before execution of an operation, for logging.
+     */
+    beforeExecute(operation: Operation, state: IOperationState): void;
+    /**
+     * Function to invoke after execution of an operation, for logging.
+     */
+    afterExecute(operation: Operation, state: IOperationState): void;
+    /**
+     * Function used to schedule the concurrency-limited execution of an operation.
+     */
+    queueWork<T>(workFn: () => Promise<T>, priority: number): Promise<T>;
+    /**
+     * 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?: (requestor?: string) => void;
+    /**
+     * Terminal to write output to.
+     */
+    terminal: ITerminal;
+}
+/**
+ * The `Operation` class is a node in the dependency graph of work that needs to be scheduled by the
+ * `OperationExecutionManager`. Each `Operation` has a `runner` member of type `IOperationRunner`, whose
+ * implementation manages the actual process of running a single operation.
+ *
+ * The graph of `Operation` instances will be cloned into a separate execution graph after processing.
+ *
+ * @beta
+ */
+export declare class Operation implements IOperationStates {
+    /**
+     * A set of all dependencies which must be executed before this operation is complete.
+     */
+    readonly dependencies: Set<Operation>;
+    /**
+     * A set of all operations that wait for this operation.
+     */
+    readonly consumers: Set<Operation>;
+    /**
+     * If specified, the name of a grouping to which this Operation belongs, for logging start and end times.
+     */
+    readonly groupName: string | undefined;
+    /**
+     * The name of this operation, for logging.
+     */
+    readonly name: string | undefined;
+    /**
+     * When the scheduler is ready to process this `Operation`, the `runner` implements the actual work of
+     * running the operation.
+     */
+    runner: IOperationRunner | undefined;
+    /**
+     * This number represents how far away this Operation is from the furthest "root" operation (i.e.
+     * an operation with no consumers). This helps us to calculate the critical path (i.e. the
+     * longest chain of projects which must be executed in order, thereby limiting execution speed
+     * of the entire operation tree.
+     *
+     * This number is calculated via a memoized depth-first search, and when choosing the next
+     * operation to execute, the operation with the highest criticalPathLength is chosen.
+     *
+     * Example:
+     *        (0) A
+     *             \\
+     *          (1) B     C (0)         (applications)
+     *               \\   /|\\
+     *                \\ / | \\
+     *             (2) D  |  X (1)      (utilities)
+     *                    | / \\
+     *                    |/   \\
+     *                (2) Y     Z (2)   (other utilities)
+     *
+     * All roots (A & C) have a criticalPathLength of 0.
+     * B has a score of 1, since A depends on it.
+     * D has a score of 2, since we look at the longest chain (e.g D-\>B-\>A is longer than D-\>C)
+     * X has a score of 1, since the only package which depends on it is A
+     * Z has a score of 2, since only X depends on it, and X has a score of 1
+     * Y has a score of 2, since the chain Y-\>X-\>C is longer than Y-\>C
+     *
+     * The algorithm is implemented in AsyncOperationQueue.ts as calculateCriticalPathLength()
+     */
+    criticalPathLength: number | undefined;
+    /**
+     * The weight for this operation. This scalar is the contribution of this operation to the
+     * `criticalPathLength` calculation above. Modify to indicate the following:
+     * - `weight` === 1: indicates that this operation has an average duration
+     * - `weight` &gt; 1: indicates that this operation takes longer than average and so the scheduler
+     *     should try to favor starting it over other, shorter operations. An example might be an operation that
+     *     bundles an entire application and runs whole-program optimization.
+     * - `weight` &lt; 1: indicates that this operation takes less time than average and so the scheduler
+     *     should favor other, longer operations over it. An example might be an operation to unpack a cached
+     *     output, or an operation using NullOperationRunner, which might use a value of 0.
+     */
+    weight: number;
+    /**
+     * The state of this operation the previous time a manager was invoked.
+     */
+    lastState: IOperationState | undefined;
+    /**
+     * The current state of this operation
+     */
+    state: IOperationState | undefined;
+    /**
+     * A cached execution promise for the current OperationExecutionManager invocation of this operation.
+     */
+    private _promise;
+    /**
+     * If true, then a run of this operation is currently wanted.
+     * This is used to track state from the `requestRun` callback passed to the runner.
+     */
+    private _runPending;
+    constructor(options?: IOperationOptions);
+    addDependency(dependency: Operation): void;
+    deleteDependency(dependency: Operation): void;
+    reset(): void;
+    /**
+     * @internal
+     */
+    _executeAsync(context: IExecuteOperationContext): Promise<OperationStatus>;
+    private _executeInnerAsync;
+}
+//# sourceMappingURL=Operation.d.ts.map

package/lib/Operation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Operation.d.ts","sourceRoot":"","sources":["../src/Operation.ts"],"names":[],"mappings":"AAGA,OAAO,EAAiB,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAGxE,OAAO,KAAK,EACV,gBAAgB,EAChB,uBAAuB,EACvB,eAAe,EACf,gBAAgB,EACjB,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE1B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE/B;;;OAGG;IACH,MAAM,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAC;IAEtC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B;AAED;;;;GAIG;AACH,MAAM,WAAW,wBAAyB,SAAQ,IAAI,CAAC,uBAAuB,EAAE,YAAY,GAAG,YAAY,CAAC;IAC1G;;OAEG;IACH,aAAa,CAAC,SAAS,EAAE,SAAS,EAAE,KAAK,EAAE,eAAe,GAAG,IAAI,CAAC;IAElE;;OAEG;IACH,YAAY,CAAC,SAAS,EAAE,SAAS,EAAE,KAAK,EAAE,eAAe,GAAG,IAAI,CAAC;IAEjE;;OAEG;IACH,SAAS,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IAErE;;;OAGG;IACH,UAAU,CAAC,EAAE,CAAC,SAAS,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IAE1C;;OAEG;IACH,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED;;;;;;;;GAQG;AACH,qBAAa,SAAU,YAAW,gBAAgB;IAChD;;OAEG;IACH,SAAgB,YAAY,EAAE,GAAG,CAAC,SAAS,CAAC,CAAwB;IACpE;;OAEG;IACH,SAAgB,SAAS,EAAE,GAAG,CAAC,SAAS,CAAC,CAAwB;IACjE;;OAEG;IACH,SAAgB,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9C;;OAEG;IACH,SAAgB,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IAEzC;;;OAGG;IACI,MAAM,EAAE,gBAAgB,GAAG,SAAS,CAAa;IAExD;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACI,kBAAkB,EAAE,MAAM,GAAG,SAAS,CAAa;IAE1D;;;;;;;;;;OAUG;IACI,MAAM,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACI,SAAS,EAAE,eAAe,GAAG,SAAS,CAAa;IAE1D;;OAEG;IACI,KAAK,EAAE,eAAe,GAAG,SAAS,CAAa;IAEtD;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAmD;IAEnE;;;OAGG;IACH,OAAO,CAAC,WAAW,CAAiB;gBAEjB,OAAO,CAAC,EAAE,iBAAiB;IAOvC,aAAa,CAAC,UAAU,EAAE,SAAS,GAAG,IAAI;IAK1C,gBAAgB,CAAC,UAAU,EAAE,SAAS,GAAG,IAAI;IAK7C,KAAK,IAAI,IAAI;IAepB;;OAEG;IACU,aAAa,CAAC,OAAO,EAAE,wBAAwB,GAAG,OAAO,CAAC,eAAe,CAAC;YAazE,kBAAkB;CAoHjC"}

package/lib/Operation.js

@@ -0,0 +1,213 @@
+"use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Operation = void 0;
+const node_core_library_1 = require("@rushstack/node-core-library");
+const Stopwatch_1 = require("./Stopwatch");
+const OperationStatus_1 = require("./OperationStatus");
+/**
+ * The `Operation` class is a node in the dependency graph of work that needs to be scheduled by the
+ * `OperationExecutionManager`. Each `Operation` has a `runner` member of type `IOperationRunner`, whose
+ * implementation manages the actual process of running a single operation.
+ *
+ * The graph of `Operation` instances will be cloned into a separate execution graph after processing.
+ *
+ * @beta
+ */
+class Operation {
+    constructor(options) {
+        /**
+         * A set of all dependencies which must be executed before this operation is complete.
+         */
+        this.dependencies = new Set();
+        /**
+         * A set of all operations that wait for this operation.
+         */
+        this.consumers = new Set();
+        /**
+         * When the scheduler is ready to process this `Operation`, the `runner` implements the actual work of
+         * running the operation.
+         */
+        this.runner = undefined;
+        /**
+         * This number represents how far away this Operation is from the furthest "root" operation (i.e.
+         * an operation with no consumers). This helps us to calculate the critical path (i.e. the
+         * longest chain of projects which must be executed in order, thereby limiting execution speed
+         * of the entire operation tree.
+         *
+         * This number is calculated via a memoized depth-first search, and when choosing the next
+         * operation to execute, the operation with the highest criticalPathLength is chosen.
+         *
+         * Example:
+         *        (0) A
+         *             \\
+         *          (1) B     C (0)         (applications)
+         *               \\   /|\\
+         *                \\ / | \\
+         *             (2) D  |  X (1)      (utilities)
+         *                    | / \\
+         *                    |/   \\
+         *                (2) Y     Z (2)   (other utilities)
+         *
+         * All roots (A & C) have a criticalPathLength of 0.
+         * B has a score of 1, since A depends on it.
+         * D has a score of 2, since we look at the longest chain (e.g D-\>B-\>A is longer than D-\>C)
+         * X has a score of 1, since the only package which depends on it is A
+         * Z has a score of 2, since only X depends on it, and X has a score of 1
+         * Y has a score of 2, since the chain Y-\>X-\>C is longer than Y-\>C
+         *
+         * The algorithm is implemented in AsyncOperationQueue.ts as calculateCriticalPathLength()
+         */
+        this.criticalPathLength = undefined;
+        /**
+         * The state of this operation the previous time a manager was invoked.
+         */
+        this.lastState = undefined;
+        /**
+         * The current state of this operation
+         */
+        this.state = undefined;
+        /**
+         * A cached execution promise for the current OperationExecutionManager invocation of this operation.
+         */
+        this._promise = undefined;
+        /**
+         * If true, then a run of this operation is currently wanted.
+         * This is used to track state from the `requestRun` callback passed to the runner.
+         */
+        this._runPending = true;
+        this.groupName = options?.groupName;
+        this.runner = options?.runner;
+        this.weight = options?.weight || 1;
+        this.name = options?.name;
+    }
+    addDependency(dependency) {
+        this.dependencies.add(dependency);
+        dependency.consumers.add(this);
+    }
+    deleteDependency(dependency) {
+        this.dependencies.delete(dependency);
+        dependency.consumers.delete(this);
+    }
+    reset() {
+        // Reset operation state
+        this.lastState = this.state;
+        this.state = {
+            status: this.dependencies.size > 0 ? OperationStatus_1.OperationStatus.Waiting : OperationStatus_1.OperationStatus.Ready,
+            hasBeenRun: this.lastState?.hasBeenRun ?? false,
+            error: undefined,
+            stopwatch: new Stopwatch_1.Stopwatch()
+        };
+        this._promise = undefined;
+        this._runPending = true;
+    }
+    /**
+     * @internal
+     */
+    async _executeAsync(context) {
+        const { state } = this;
+        if (!state) {
+            throw new Error(`Operation state has not been initialized.`);
+        }
+        if (!this._promise) {
+            this._promise = this._executeInnerAsync(context, state);
+        }
+        return this._promise;
+    }
+    async _executeInnerAsync(context, rawState) {
+        const state = rawState;
+        const { runner } = this;
+        const dependencyResults = await Promise.allSettled(Array.from(this.dependencies, (dependency) => dependency._executeAsync(context)));
+        const { abortSignal, requestRun, queueWork } = context;
+        if (abortSignal.aborted) {
+            state.status = OperationStatus_1.OperationStatus.Aborted;
+            return state.status;
+        }
+        for (const result of dependencyResults) {
+            if (result.status === 'rejected' ||
+                result.value === OperationStatus_1.OperationStatus.Blocked ||
+                result.value === OperationStatus_1.OperationStatus.Failure) {
+                state.status = OperationStatus_1.OperationStatus.Blocked;
+                return state.status;
+            }
+        }
+        state.status = OperationStatus_1.OperationStatus.Ready;
+        const innerContext = {
+            abortSignal,
+            isFirstRun: !state.hasBeenRun,
+            requestRun: requestRun
+                ? () => {
+                    switch (this.state?.status) {
+                        case OperationStatus_1.OperationStatus.Ready:
+                        case OperationStatus_1.OperationStatus.Executing:
+                            // If current status has not yet resolved to a fixed value,
+                            // re-executing this operation does not require a full rerun
+                            // of the operation graph. Simply mark that a run is requested.
+                            // This variable is on the Operation instead of the
+                            // containing closure to deal with scenarios in which
+                            // the runner hangs on to an old copy of the callback.
+                            this._runPending = true;
+                            return;
+                        case OperationStatus_1.OperationStatus.Blocked:
+                        case OperationStatus_1.OperationStatus.Aborted:
+                        case OperationStatus_1.OperationStatus.Failure:
+                        case OperationStatus_1.OperationStatus.NoOp:
+                        case OperationStatus_1.OperationStatus.Success:
+                            // The requestRun callback is assumed to remain constant
+                            // throughout the lifetime of the process, so it is safe
+                            // to capture here.
+                            return requestRun(this.name);
+                        default:
+                            throw new node_core_library_1.InternalError(`Unexpected status: ${this.state?.status}`);
+                    }
+                }
+                : undefined
+        };
+        await queueWork(async () => {
+            // Redundant variable to satisfy require-atomic-updates
+            const innerState = state;
+            if (abortSignal.aborted) {
+                innerState.status = OperationStatus_1.OperationStatus.Aborted;
+                return innerState.status;
+            }
+            context.beforeExecute(this, innerState);
+            innerState.stopwatch.start();
+            innerState.status = OperationStatus_1.OperationStatus.Executing;
+            // Mark that the operation has been started at least once.
+            innerState.hasBeenRun = true;
+            while (this._runPending) {
+                this._runPending = false;
+                try {
+                    // We don't support aborting in the middle of a runner's execution.
+                    innerState.status = runner ? await runner.executeAsync(innerContext) : OperationStatus_1.OperationStatus.NoOp;
+                }
+                catch (error) {
+                    innerState.status = OperationStatus_1.OperationStatus.Failure;
+                    innerState.error = error;
+                }
+                // Since runner.executeAsync is async, a change could have occurred that requires re-execution
+                // This operation is still active, so can re-execute immediately, rather than forcing a whole
+                // new execution pass.
+                // As currently written, this does mean that if a job is scheduled with higher priority while
+                // this operation is still executing, it will still wait for this retry. This may not be desired
+                // and if it becomes a problem, the retry loop will need to be moved outside of the `queueWork` call.
+                // This introduces complexity regarding tracking of timing and start/end logging, however.
+                if (this._runPending) {
+                    if (abortSignal.aborted) {
+                        innerState.status = OperationStatus_1.OperationStatus.Aborted;
+                        break;
+                    }
+                    else {
+                        context.terminal.writeLine(`Immediate rerun requested. Executing.`);
+                    }
+                }
+            }
+            state.stopwatch.stop();
+            context.afterExecute(this, state);
+        }, /* priority */ this.criticalPathLength ?? 0);
+        return state.status;
+    }
+}
+exports.Operation = Operation;
+//# sourceMappingURL=Operation.js.map

package/lib/Operation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Operation.js","sourceRoot":"","sources":["../src/Operation.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAE3D,oEAAwE;AAExE,2CAAwC;AAQxC,uDAAoD;AA8DpD;;;;;;;;GAQG;AACH,MAAa,SAAS;IAyFpB,YAAmB,OAA2B;QAxF9C;;WAEG;QACa,iBAAY,GAAmB,IAAI,GAAG,EAAa,CAAC;QACpE;;WAEG;QACa,cAAS,GAAmB,IAAI,GAAG,EAAa,CAAC;QAUjE;;;WAGG;QACI,WAAM,GAAiC,SAAS,CAAC;QAExD;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA4BG;QACI,uBAAkB,GAAuB,SAAS,CAAC;QAe1D;;WAEG;QACI,cAAS,GAAgC,SAAS,CAAC;QAE1D;;WAEG;QACI,UAAK,GAAgC,SAAS,CAAC;QAEtD;;WAEG;QACK,aAAQ,GAAyC,SAAS,CAAC;QAEnE;;;WAGG;QACK,gBAAW,GAAY,IAAI,CAAC;QAGlC,IAAI,CAAC,SAAS,GAAG,OAAO,EAAE,SAAS,CAAC;QACpC,IAAI,CAAC,MAAM,GAAG,OAAO,EAAE,MAAM,CAAC;QAC9B,IAAI,CAAC,MAAM,GAAG,OAAO,EAAE,MAAM,IAAI,CAAC,CAAC;QACnC,IAAI,CAAC,IAAI,GAAG,OAAO,EAAE,IAAI,CAAC;IAC5B,CAAC;IAEM,aAAa,CAAC,UAAqB;QACxC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAClC,UAAU,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IAEM,gBAAgB,CAAC,UAAqB;QAC3C,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QACrC,UAAU,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;IAEM,KAAK;QACV,wBAAwB;QACxB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC;QAE5B,IAAI,CAAC,KAAK,GAAG;YACX,MAAM,EAAE,IAAI,CAAC,YAAY,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,iCAAe,CAAC,OAAO,CAAC,CAAC,CAAC,iCAAe,CAAC,KAAK;YACpF,UAAU,EAAE,IAAI,CAAC,SAAS,EAAE,UAAU,IAAI,KAAK;YAC/C,KAAK,EAAE,SAAS;YAChB,SAAS,EAAE,IAAI,qBAAS,EAAE;SAC3B,CAAC;QAEF,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;QAC1B,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;IAC1B,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,aAAa,CAAC,OAAiC;QAC1D,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;QACvB,IAAI,CAAC,KAAK,EAAE;YACV,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;SAC9D;QAED,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YAClB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;SACzD;QAED,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAEO,KAAK,CAAC,kBAAkB,CAC9B,OAAiC,EACjC,QAAyB;QAEzB,MAAM,KAAK,GAAoB,QAAQ,CAAC;QACxC,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;QAExB,MAAM,iBAAiB,GAA4C,MAAM,OAAO,CAAC,UAAU,CACzF,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,UAAqB,EAAE,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAC5F,CAAC;QAEF,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC;QAEvD,IAAI,WAAW,CAAC,OAAO,EAAE;YACvB,KAAK,CAAC,MAAM,GAAG,iCAAe,CAAC,OAAO,CAAC;YACvC,OAAO,KAAK,CAAC,MAAM,CAAC;SACrB;QAED,KAAK,MAAM,MAAM,IAAI,iBAAiB,EAAE;YACtC,IACE,MAAM,CAAC,MAAM,KAAK,UAAU;gBAC5B,MAAM,CAAC,KAAK,KAAK,iCAAe,CAAC,OAAO;gBACxC,MAAM,CAAC,KAAK,KAAK,iCAAe,CAAC,OAAO,EACxC;gBACA,KAAK,CAAC,MAAM,GAAG,iCAAe,CAAC,OAAO,CAAC;gBACvC,OAAO,KAAK,CAAC,MAAM,CAAC;aACrB;SACF;QAED,KAAK,CAAC,MAAM,GAAG,iCAAe,CAAC,KAAK,CAAC;QAErC,MAAM,YAAY,GAA4B;YAC5C,WAAW;YACX,UAAU,EAAE,CAAC,KAAK,CAAC,UAAU;YAC7B,UAAU,EAAE,UAAU;gBACpB,CAAC,CAAC,GAAG,EAAE;oBACH,QAAQ,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE;wBAC1B,KAAK,iCAAe,CAAC,KAAK,CAAC;wBAC3B,KAAK,iCAAe,CAAC,SAAS;4BAC5B,2DAA2D;4BAC3D,4DAA4D;4BAC5D,+DAA+D;4BAE/D,mDAAmD;4BACnD,qDAAqD;4BACrD,sDAAsD;4BACtD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;4BACxB,OAAO;wBAET,KAAK,iCAAe,CAAC,OAAO,CAAC;wBAC7B,KAAK,iCAAe,CAAC,OAAO,CAAC;wBAC7B,KAAK,iCAAe,CAAC,OAAO,CAAC;wBAC7B,KAAK,iCAAe,CAAC,IAAI,CAAC;wBAC1B,KAAK,iCAAe,CAAC,OAAO;4BAC1B,wDAAwD;4BACxD,wDAAwD;4BACxD,mBAAmB;4BACnB,OAAO,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;wBAC/B;4BACE,MAAM,IAAI,iCAAa,CAAC,sBAAsB,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;qBACvE;gBACH,CAAC;gBACH,CAAC,CAAC,SAAS;SACd,CAAC;QAEF,MAAM,SAAS,CAAC,KAAK,IAAI,EAAE;YACzB,uDAAuD;YACvD,MAAM,UAAU,GAAoB,KAAK,CAAC;YAE1C,IAAI,WAAW,CAAC,OAAO,EAAE;gBACvB,UAAU,CAAC,MAAM,GAAG,iCAAe,CAAC,OAAO,CAAC;gBAC5C,OAAO,UAAU,CAAC,MAAM,CAAC;aAC1B;YAED,OAAO,CAAC,aAAa,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;YAExC,UAAU,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;YAC7B,UAAU,CAAC,MAAM,GAAG,iCAAe,CAAC,SAAS,CAAC;YAC9C,0DAA0D;YAC1D,UAAU,CAAC,UAAU,GAAG,IAAI,CAAC;YAE7B,OAAO,IAAI,CAAC,WAAW,EAAE;gBACvB,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;gBACzB,IAAI;oBACF,mEAAmE;oBACnE,UAAU,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,MAAM,MAAM,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,iCAAe,CAAC,IAAI,CAAC;iBAC7F;gBAAC,OAAO,KAAK,EAAE;oBACd,UAAU,CAAC,MAAM,GAAG,iCAAe,CAAC,OAAO,CAAC;oBAC5C,UAAU,CAAC,KAAK,GAAG,KAAuB,CAAC;iBAC5C;gBAED,8FAA8F;gBAC9F,6FAA6F;gBAC7F,sBAAsB;gBAEtB,6FAA6F;gBAC7F,gGAAgG;gBAChG,qGAAqG;gBACrG,0FAA0F;gBAE1F,IAAI,IAAI,CAAC,WAAW,EAAE;oBACpB,IAAI,WAAW,CAAC,OAAO,EAAE;wBACvB,UAAU,CAAC,MAAM,GAAG,iCAAe,CAAC,OAAO,CAAC;wBAC5C,MAAM;qBACP;yBAAM;wBACL,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,uCAAuC,CAAC,CAAC;qBACrE;iBACF;aACF;YAED,KAAK,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;YACvB,OAAO,CAAC,YAAY,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QACpC,CAAC,EAAE,cAAc,CAAC,IAAI,CAAC,kBAAkB,IAAI,CAAC,CAAC,CAAC;QAEhD,OAAO,KAAK,CAAC,MAAM,CAAC;IACtB,CAAC;CACF;AA7PD,8BA6PC","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 { InternalError, ITerminal } from '@rushstack/node-core-library';\n\nimport { Stopwatch } from './Stopwatch';\nimport type {\n  IOperationRunner,\n  IOperationRunnerContext,\n  IOperationState,\n  IOperationStates\n} from './IOperationRunner';\nimport type { OperationError } from './OperationError';\nimport { OperationStatus } from './OperationStatus';\n\n/**\n * Options for constructing a new Operation.\n * @beta\n */\nexport interface IOperationOptions {\n  /**\n   * The name of this operation, for logging.\n   */\n  name?: string | undefined;\n\n  /**\n   * The group that this operation belongs to. Will be used for logging and duration tracking.\n   */\n  groupName?: string | undefined;\n\n  /**\n   * When the scheduler is ready to process this `Operation`, the `runner` implements the actual work of\n   * running the operation.\n   */\n  runner?: IOperationRunner | undefined;\n\n  /**\n   * The weight used by the scheduler to determine order of execution.\n   */\n  weight?: number | undefined;\n}\n\n/**\n * Information provided to `executeAsync` by the `OperationExecutionManager`.\n *\n * @beta\n */\nexport interface IExecuteOperationContext extends Omit<IOperationRunnerContext, 'isFirstRun' | 'requestRun'> {\n  /**\n   * Function to invoke before execution of an operation, for logging.\n   */\n  beforeExecute(operation: Operation, state: IOperationState): void;\n\n  /**\n   * Function to invoke after execution of an operation, for logging.\n   */\n  afterExecute(operation: Operation, state: IOperationState): void;\n\n  /**\n   * Function used to schedule the concurrency-limited execution of an operation.\n   */\n  queueWork<T>(workFn: () => Promise<T>, priority: number): Promise<T>;\n\n  /**\n   * A callback to the overarching orchestrator to request that the operation be invoked again.\n   * Used in watch mode to signal that inputs have changed.\n   */\n  requestRun?: (requestor?: string) => void;\n\n  /**\n   * Terminal to write output to.\n   */\n  terminal: ITerminal;\n}\n\n/**\n * The `Operation` class is a node in the dependency graph of work that needs to be scheduled by the\n * `OperationExecutionManager`. Each `Operation` has a `runner` member of type `IOperationRunner`, whose\n * implementation manages the actual process of running a single operation.\n *\n * The graph of `Operation` instances will be cloned into a separate execution graph after processing.\n *\n * @beta\n */\nexport class Operation implements IOperationStates {\n  /**\n   * A set of all dependencies which must be executed before this operation is complete.\n   */\n  public readonly dependencies: Set<Operation> = new Set<Operation>();\n  /**\n   * A set of all operations that wait for this operation.\n   */\n  public readonly consumers: Set<Operation> = new Set<Operation>();\n  /**\n   * If specified, the name of a grouping to which this Operation belongs, for logging start and end times.\n   */\n  public readonly groupName: string | undefined;\n  /**\n   * The name of this operation, for logging.\n   */\n  public readonly name: string | undefined;\n\n  /**\n   * When the scheduler is ready to process this `Operation`, the `runner` implements the actual work of\n   * running the operation.\n   */\n  public runner: IOperationRunner | undefined = undefined;\n\n  /**\n   * This number represents how far away this Operation is from the furthest \"root\" operation (i.e.\n   * an operation with no consumers). This helps us to calculate the critical path (i.e. the\n   * longest chain of projects which must be executed in order, thereby limiting execution speed\n   * of the entire operation tree.\n   *\n   * This number is calculated via a memoized depth-first search, and when choosing the next\n   * operation to execute, the operation with the highest criticalPathLength is chosen.\n   *\n   * Example:\n   *        (0) A\n   *             \\\\\n   *          (1) B     C (0)         (applications)\n   *               \\\\   /|\\\\\n   *                \\\\ / | \\\\\n   *             (2) D  |  X (1)      (utilities)\n   *                    | / \\\\\n   *                    |/   \\\\\n   *                (2) Y     Z (2)   (other utilities)\n   *\n   * All roots (A & C) have a criticalPathLength of 0.\n   * B has a score of 1, since A depends on it.\n   * D has a score of 2, since we look at the longest chain (e.g D-\\>B-\\>A is longer than D-\\>C)\n   * X has a score of 1, since the only package which depends on it is A\n   * Z has a score of 2, since only X depends on it, and X has a score of 1\n   * Y has a score of 2, since the chain Y-\\>X-\\>C is longer than Y-\\>C\n   *\n   * The algorithm is implemented in AsyncOperationQueue.ts as calculateCriticalPathLength()\n   */\n  public criticalPathLength: number | undefined = undefined;\n\n  /**\n   * The weight for this operation. This scalar is the contribution of this operation to the\n   * `criticalPathLength` calculation above. Modify to indicate the following:\n   * - `weight` === 1: indicates that this operation has an average duration\n   * - `weight` &gt; 1: indicates that this operation takes longer than average and so the scheduler\n   *     should try to favor starting it over other, shorter operations. An example might be an operation that\n   *     bundles an entire application and runs whole-program optimization.\n   * - `weight` &lt; 1: indicates that this operation takes less time than average and so the scheduler\n   *     should favor other, longer operations over it. An example might be an operation to unpack a cached\n   *     output, or an operation using NullOperationRunner, which might use a value of 0.\n   */\n  public weight: number;\n\n  /**\n   * The state of this operation the previous time a manager was invoked.\n   */\n  public lastState: IOperationState | undefined = undefined;\n\n  /**\n   * The current state of this operation\n   */\n  public state: IOperationState | undefined = undefined;\n\n  /**\n   * A cached execution promise for the current OperationExecutionManager invocation of this operation.\n   */\n  private _promise: Promise<OperationStatus> | undefined = undefined;\n\n  /**\n   * If true, then a run of this operation is currently wanted.\n   * This is used to track state from the `requestRun` callback passed to the runner.\n   */\n  private _runPending: boolean = true;\n\n  public constructor(options?: IOperationOptions) {\n    this.groupName = options?.groupName;\n    this.runner = options?.runner;\n    this.weight = options?.weight || 1;\n    this.name = options?.name;\n  }\n\n  public addDependency(dependency: Operation): void {\n    this.dependencies.add(dependency);\n    dependency.consumers.add(this);\n  }\n\n  public deleteDependency(dependency: Operation): void {\n    this.dependencies.delete(dependency);\n    dependency.consumers.delete(this);\n  }\n\n  public reset(): void {\n    // Reset operation state\n    this.lastState = this.state;\n\n    this.state = {\n      status: this.dependencies.size > 0 ? OperationStatus.Waiting : OperationStatus.Ready,\n      hasBeenRun: this.lastState?.hasBeenRun ?? false,\n      error: undefined,\n      stopwatch: new Stopwatch()\n    };\n\n    this._promise = undefined;\n    this._runPending = true;\n  }\n\n  /**\n   * @internal\n   */\n  public async _executeAsync(context: IExecuteOperationContext): Promise<OperationStatus> {\n    const { state } = this;\n    if (!state) {\n      throw new Error(`Operation state has not been initialized.`);\n    }\n\n    if (!this._promise) {\n      this._promise = this._executeInnerAsync(context, state);\n    }\n\n    return this._promise;\n  }\n\n  private async _executeInnerAsync(\n    context: IExecuteOperationContext,\n    rawState: IOperationState\n  ): Promise<OperationStatus> {\n    const state: IOperationState = rawState;\n    const { runner } = this;\n\n    const dependencyResults: PromiseSettledResult<OperationStatus>[] = await Promise.allSettled(\n      Array.from(this.dependencies, (dependency: Operation) => dependency._executeAsync(context))\n    );\n\n    const { abortSignal, requestRun, queueWork } = context;\n\n    if (abortSignal.aborted) {\n      state.status = OperationStatus.Aborted;\n      return state.status;\n    }\n\n    for (const result of dependencyResults) {\n      if (\n        result.status === 'rejected' ||\n        result.value === OperationStatus.Blocked ||\n        result.value === OperationStatus.Failure\n      ) {\n        state.status = OperationStatus.Blocked;\n        return state.status;\n      }\n    }\n\n    state.status = OperationStatus.Ready;\n\n    const innerContext: IOperationRunnerContext = {\n      abortSignal,\n      isFirstRun: !state.hasBeenRun,\n      requestRun: requestRun\n        ? () => {\n            switch (this.state?.status) {\n              case OperationStatus.Ready:\n              case OperationStatus.Executing:\n                // If current status has not yet resolved to a fixed value,\n                // re-executing this operation does not require a full rerun\n                // of the operation graph. Simply mark that a run is requested.\n\n                // This variable is on the Operation instead of the\n                // containing closure to deal with scenarios in which\n                // the runner hangs on to an old copy of the callback.\n                this._runPending = true;\n                return;\n\n              case OperationStatus.Blocked:\n              case OperationStatus.Aborted:\n              case OperationStatus.Failure:\n              case OperationStatus.NoOp:\n              case OperationStatus.Success:\n                // The requestRun callback is assumed to remain constant\n                // throughout the lifetime of the process, so it is safe\n                // to capture here.\n                return requestRun(this.name);\n              default:\n                throw new InternalError(`Unexpected status: ${this.state?.status}`);\n            }\n          }\n        : undefined\n    };\n\n    await queueWork(async () => {\n      // Redundant variable to satisfy require-atomic-updates\n      const innerState: IOperationState = state;\n\n      if (abortSignal.aborted) {\n        innerState.status = OperationStatus.Aborted;\n        return innerState.status;\n      }\n\n      context.beforeExecute(this, innerState);\n\n      innerState.stopwatch.start();\n      innerState.status = OperationStatus.Executing;\n      // Mark that the operation has been started at least once.\n      innerState.hasBeenRun = true;\n\n      while (this._runPending) {\n        this._runPending = false;\n        try {\n          // We don't support aborting in the middle of a runner's execution.\n          innerState.status = runner ? await runner.executeAsync(innerContext) : OperationStatus.NoOp;\n        } catch (error) {\n          innerState.status = OperationStatus.Failure;\n          innerState.error = error as OperationError;\n        }\n\n        // Since runner.executeAsync is async, a change could have occurred that requires re-execution\n        // This operation is still active, so can re-execute immediately, rather than forcing a whole\n        // new execution pass.\n\n        // As currently written, this does mean that if a job is scheduled with higher priority while\n        // this operation is still executing, it will still wait for this retry. This may not be desired\n        // and if it becomes a problem, the retry loop will need to be moved outside of the `queueWork` call.\n        // This introduces complexity regarding tracking of timing and start/end logging, however.\n\n        if (this._runPending) {\n          if (abortSignal.aborted) {\n            innerState.status = OperationStatus.Aborted;\n            break;\n          } else {\n            context.terminal.writeLine(`Immediate rerun requested. Executing.`);\n          }\n        }\n      }\n\n      state.stopwatch.stop();\n      context.afterExecute(this, state);\n    }, /* priority */ this.criticalPathLength ?? 0);\n\n    return state.status;\n  }\n}\n"]}

package/lib/OperationError.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Encapsulates information about an error
+ *
+ * @beta
+ */
+export declare class OperationError extends Error {
+    protected _type: string;
+    constructor(type: string, message: string);
+    get message(): string;
+    toString(): string;
+}
+//# sourceMappingURL=OperationError.d.ts.map

package/lib/OperationError.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"OperationError.d.ts","sourceRoot":"","sources":["../src/OperationError.ts"],"names":[],"mappings":"AAGA;;;;GAIG;AACH,qBAAa,cAAe,SAAQ,KAAK;IACvC,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC;gBAEL,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;IAYhD,IAAW,OAAO,IAAI,MAAM,CAE3B;IAEM,QAAQ,IAAI,MAAM;CAG1B"}

package/lib/OperationError.js

@@ -0,0 +1,29 @@
+"use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OperationError = void 0;
+/**
+ * Encapsulates information about an error
+ *
+ * @beta
+ */
+class OperationError extends Error {
+    constructor(type, message) {
+        super(message);
+        // Manually set the prototype, as we can no longer extend built-in classes like Error, Array, Map, etc.
+        // https://github.com/microsoft/TypeScript-wiki/blob/master/Breaking-Changes.md#extending-built-ins-like-error-array-and-map-may-no-longer-work
+        //
+        // Note: the prototype must also be set on any classes which extend this one
+        Object.setPrototypeOf(this, OperationError.prototype);
+        this._type = type;
+    }
+    get message() {
+        return `[${this._type}] '${super.message}'`;
+    }
+    toString() {
+        return this.message;
+    }
+}
+exports.OperationError = OperationError;
+//# sourceMappingURL=OperationError.js.map

package/lib/OperationError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OperationError.js","sourceRoot":"","sources":["../src/OperationError.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAE3D;;;;GAIG;AACH,MAAa,cAAe,SAAQ,KAAK;IAGvC,YAAmB,IAAY,EAAE,OAAe;QAC9C,KAAK,CAAC,OAAO,CAAC,CAAC;QAEf,uGAAuG;QACvG,+IAA+I;QAC/I,EAAE;QACF,4EAA4E;QAC5E,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,cAAc,CAAC,SAAS,CAAC,CAAC;QAEtD,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAED,IAAW,OAAO;QAChB,OAAO,IAAI,IAAI,CAAC,KAAK,MAAM,KAAK,CAAC,OAAO,GAAG,CAAC;IAC9C,CAAC;IAEM,QAAQ;QACb,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;CACF;AAtBD,wCAsBC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\n/**\n * Encapsulates information about an error\n *\n * @beta\n */\nexport class OperationError extends Error {\n  protected _type: string;\n\n  public constructor(type: string, message: string) {\n    super(message);\n\n    // Manually set the prototype, as we can no longer extend built-in classes like Error, Array, Map, etc.\n    // https://github.com/microsoft/TypeScript-wiki/blob/master/Breaking-Changes.md#extending-built-ins-like-error-array-and-map-may-no-longer-work\n    //\n    // Note: the prototype must also be set on any classes which extend this one\n    Object.setPrototypeOf(this, OperationError.prototype);\n\n    this._type = type;\n  }\n\n  public get message(): string {\n    return `[${this._type}] '${super.message}'`;\n  }\n\n  public toString(): string {\n    return this.message;\n  }\n}\n"]}

package/lib/OperationExecutionManager.d.ts

@@ -0,0 +1,46 @@
+/// <reference types="node" />
+import type { ITerminal } from '@rushstack/node-core-library';
+import type { Operation } from './Operation';
+import { OperationStatus } from './OperationStatus';
+/**
+ * Options for the current run.
+ *
+ * @beta
+ */
+export interface IOperationExecutionOptions {
+    abortSignal: AbortSignal;
+    parallelism: number;
+    terminal: ITerminal;
+    requestRun?: (requestor?: string) => void;
+}
+/**
+ * A class which manages the execution of a set of tasks with interdependencies.
+ * Initially, and at the end of each task execution, all unblocked tasks
+ * are added to a ready queue which is then executed. This is done continually until all
+ * tasks are complete, or prematurely fails if any of the tasks fail.
+ *
+ * @beta
+ */
+export declare class OperationExecutionManager {
+    /**
+     * The set of operations that will be executed
+     */
+    private readonly _operations;
+    /**
+     * Group records are metadata-only entities used for tracking the start and end of a set of related tasks.
+     * This is the only extent to which the operation graph is aware of Heft phases.
+     */
+    private readonly _groupRecordByName;
+    /**
+     * The total number of non-silent operations in the graph.
+     * Silent operations are generally used to simplify the construction of the graph.
+     */
+    private readonly _trackedOperationCount;
+    constructor(operations: ReadonlySet<Operation>);
+    /**
+     * Executes all operations which have been registered, returning a promise which is resolved when all the
+     * operations are completed successfully, or rejects when any operation fails.
+     */
+    executeAsync(executionOptions: IOperationExecutionOptions): Promise<OperationStatus>;
+}
+//# sourceMappingURL=OperationExecutionManager.d.ts.map

package/lib/OperationExecutionManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"OperationExecutionManager.d.ts","sourceRoot":"","sources":["../src/OperationExecutionManager.ts"],"names":[],"mappings":";AAGA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAG9D,OAAO,KAAK,EAA4B,SAAS,EAAE,MAAM,aAAa,CAAC;AAEvE,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAGpD;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACzC,WAAW,EAAE,WAAW,CAAC;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,SAAS,CAAC;IAEpB,UAAU,CAAC,EAAE,CAAC,SAAS,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;CAC3C;AAED;;;;;;;GAOG;AACH,qBAAa,yBAAyB;IACpC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAc;IAC1C;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAoC;IACvE;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,sBAAsB,CAAS;gBAE7B,UAAU,EAAE,WAAW,CAAC,SAAS,CAAC;IAqCrD;;;OAGG;IACU,YAAY,CAAC,gBAAgB,EAAE,0BAA0B,GAAG,OAAO,CAAC,eAAe,CAAC;CA6FlG"}

package/lib/OperationExecutionManager.js

@@ -0,0 +1,127 @@
+"use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OperationExecutionManager = void 0;
+const OperationGroupRecord_1 = require("./OperationGroupRecord");
+const OperationStatus_1 = require("./OperationStatus");
+const calculateCriticalPath_1 = require("./calculateCriticalPath");
+/**
+ * A class which manages the execution of a set of tasks with interdependencies.
+ * Initially, and at the end of each task execution, all unblocked tasks
+ * are added to a ready queue which is then executed. This is done continually until all
+ * tasks are complete, or prematurely fails if any of the tasks fail.
+ *
+ * @beta
+ */
+class OperationExecutionManager {
+    constructor(operations) {
+        const groupRecordByName = new Map();
+        this._groupRecordByName = groupRecordByName;
+        let trackedOperationCount = 0;
+        for (const operation of operations) {
+            const { groupName } = operation;
+            let group = undefined;
+            if (groupName && !(group = groupRecordByName.get(groupName))) {
+                group = new OperationGroupRecord_1.OperationGroupRecord(groupName);
+                groupRecordByName.set(groupName, group);
+            }
+            group?.addOperation(operation);
+            if (!operation.runner?.silent) {
+                // Only count non-silent operations
+                trackedOperationCount++;
+            }
+        }
+        this._trackedOperationCount = trackedOperationCount;
+        this._operations = (0, calculateCriticalPath_1.calculateCriticalPathLengths)(operations);
+        for (const consumer of operations) {
+            for (const dependency of consumer.dependencies) {
+                if (!operations.has(dependency)) {
+                    throw new Error(`Operation ${JSON.stringify(consumer.name)} declares a dependency on operation ` +
+                        `${JSON.stringify(dependency.name)} that is not in the set of operations to execute.`);
+                }
+            }
+        }
+    }
+    /**
+     * Executes all operations which have been registered, returning a promise which is resolved when all the
+     * operations are completed successfully, or rejects when any operation fails.
+     */
+    async executeAsync(executionOptions) {
+        let hasReportedFailures = false;
+        const { abortSignal, parallelism, terminal, requestRun } = executionOptions;
+        const startedGroups = new Set();
+        const finishedGroups = new Set();
+        const maxParallelism = Math.min(this._operations.length, parallelism);
+        const groupRecords = this._groupRecordByName;
+        for (const groupRecord of groupRecords.values()) {
+            groupRecord.reset();
+        }
+        for (const operation of this._operations) {
+            operation.reset();
+        }
+        terminal.writeVerboseLine(`Executing a maximum of ${maxParallelism} simultaneous tasks...`);
+        const executionContext = {
+            terminal,
+            abortSignal,
+            requestRun,
+            queueWork: (workFn, priority) => {
+                // TODO: Update to throttle parallelism
+                // Can just be a standard priority queue from async
+                return workFn();
+            },
+            beforeExecute: (operation) => {
+                // Initialize group if uninitialized and log the group name
+                const { groupName } = operation;
+                const groupRecord = groupName
+                    ? groupRecords.get(groupName)
+                    : undefined;
+                if (groupRecord && !startedGroups.has(groupRecord)) {
+                    startedGroups.add(groupRecord);
+                    groupRecord.startTimer();
+                    terminal.writeLine(` ---- ${groupRecord.name} started ---- `);
+                }
+            },
+            afterExecute: (operation, state) => {
+                const { groupName } = operation;
+                const groupRecord = groupName
+                    ? groupRecords.get(groupName)
+                    : undefined;
+                if (groupRecord) {
+                    groupRecord.setOperationAsComplete(operation, state);
+                }
+                if (state.status === OperationStatus_1.OperationStatus.Failure) {
+                    // This operation failed. Mark it as such and all reachable dependents as blocked.
+                    // Failed operations get reported, even if silent.
+                    // Generally speaking, silent operations shouldn't be able to fail, so this is a safety measure.
+                    const message = state.error?.message;
+                    if (message) {
+                        terminal.writeErrorLine(message);
+                    }
+                    hasReportedFailures = true;
+                }
+                // Log out the group name and duration if it is the last operation in the group
+                if (groupRecord?.finished && !finishedGroups.has(groupRecord)) {
+                    finishedGroups.add(groupRecord);
+                    const finishedLoggingWord = groupRecord.hasFailures
+                        ? 'encountered an error'
+                        : groupRecord.hasCancellations
+                            ? 'cancelled'
+                            : 'finished';
+                    terminal.writeLine(` ---- ${groupRecord.name} ${finishedLoggingWord} (${groupRecord.duration.toFixed(3)}s) ---- `);
+                }
+            }
+        };
+        await Promise.all(this._operations.map((record) => record._executeAsync(executionContext)));
+        const finalStatus = this._trackedOperationCount === 0
+            ? OperationStatus_1.OperationStatus.NoOp
+            : abortSignal.aborted
+                ? OperationStatus_1.OperationStatus.Aborted
+                : hasReportedFailures
+                    ? OperationStatus_1.OperationStatus.Failure
+                    : OperationStatus_1.OperationStatus.Success;
+        return finalStatus;
+    }
+}
+exports.OperationExecutionManager = OperationExecutionManager;
+//# sourceMappingURL=OperationExecutionManager.js.map