@rushstack/worker-pool 0.1.0

package/LICENSE

@@ -0,0 +1,24 @@
+@rushstack/worker-pool
+
+Copyright (c) Microsoft Corporation. All rights reserved.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,12 @@
+# @rushstack/worker-pool
+
+This library contains a lightweight worker pool using the NodeJS worker_threads API.
+
+## Links
+
+- [CHANGELOG.md](
+  https://github.com/microsoft/rushstack/blob/main/libraries/worker-pool/CHANGELOG.md) - Find
+  out what's new in the latest version
+- [API Reference](https://rushstack.io/pages/api/worker-pool/)
+
+`@rushstack/worker-pool` is part of the [Rush Stack](https://rushstack.io/) family of projects.

package/dist/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.24.1"
+    }
+  ]
+}

package/dist/worker-pool.d.ts

@@ -0,0 +1,107 @@
+/// <reference types="node" />
+
+import { Worker } from 'worker_threads';
+
+/**
+ * @internal
+ */
+export declare interface IWorkerPoolOptions {
+    /**
+     * Identifier for this pool, to assign to its workers for tracking
+     */
+    id: string;
+    /**
+     * Maximum number of concurrent workers this WorkerPool may spawn.
+     */
+    maxWorkers: number;
+    /**
+     * Optional callback invoked when a worker is destroyed.
+     */
+    onWorkerDestroyed?: () => void;
+    /**
+     * Optional callback invoked on a newly created worker.
+     */
+    prepareWorker?: (worker: Worker) => void;
+    /**
+     * Optional data to pass to workers when they are initialized.
+     * Will be subjected to the Structured Clone algorithm.
+     */
+    workerData?: unknown;
+    /**
+     * Absolute path to the worker script.
+     */
+    workerScriptPath: string;
+}
+
+/**
+ * Symbol to read the ID off of a worker
+ * @internal
+ */
+export declare const WORKER_ID_SYMBOL: unique symbol;
+
+/**
+ * Manages a pool of workers.
+ * Workers will be shutdown by sending them the boolean value `false` in a postMessage.
+ * @internal
+ */
+export declare class WorkerPool {
+    id: string;
+    maxWorkers: number;
+    private readonly _alive;
+    private _error;
+    private _finishing;
+    private readonly _idle;
+    private _nextId;
+    private readonly _onComplete;
+    private readonly _onWorkerDestroyed;
+    private readonly _pending;
+    private readonly _prepare;
+    private readonly _workerData;
+    private readonly _workerScript;
+    constructor(options: IWorkerPoolOptions);
+    /**
+     * Gets the count of active workers.
+     */
+    getActiveCount(): number;
+    /**
+     * Gets the count of idle workers.
+     */
+    getIdleCount(): number;
+    /**
+     * Gets the count of live workers.
+     */
+    getLiveCount(): number;
+    /**
+     * Tells the pool to shut down when all workers are done.
+     * Returns a promise that will be fulfilled if all workers finish successfully, or reject with the first error.
+     */
+    finishAsync(): Promise<void>;
+    /**
+     * Resets the pool and allows more work
+     */
+    reset(): void;
+    /**
+     * Returns a worker to the pool. If the pool is finishing, deallocates the worker.
+     * @param worker - The worker to free
+     */
+    checkinWorker(worker: Worker): void;
+    /**
+     * Checks out a currently available worker or waits for the next free worker.
+     * @param allowCreate - If creating new workers is allowed (subject to maxSize)
+     */
+    checkoutWorkerAsync(allowCreate: boolean): Promise<Worker>;
+    /**
+     * Creates a new worker if allowed by maxSize.
+     */
+    private _createWorker;
+    /**
+     * Cleans up a worker
+     */
+    private _destroyWorker;
+    /**
+     * Notifies all pending callbacks that an error has occurred and switches this pool into error state.
+     */
+    private _onError;
+}
+
+export { }

package/lib/WorkerPool.d.ts

@@ -0,0 +1,102 @@
+/// <reference types="node" />
+import { Worker } from 'worker_threads';
+/**
+ * Symbol to read the ID off of a worker
+ * @internal
+ */
+export declare const WORKER_ID_SYMBOL: unique symbol;
+/**
+ * @internal
+ */
+export interface IWorkerPoolOptions {
+    /**
+     * Identifier for this pool, to assign to its workers for tracking
+     */
+    id: string;
+    /**
+     * Maximum number of concurrent workers this WorkerPool may spawn.
+     */
+    maxWorkers: number;
+    /**
+     * Optional callback invoked when a worker is destroyed.
+     */
+    onWorkerDestroyed?: () => void;
+    /**
+     * Optional callback invoked on a newly created worker.
+     */
+    prepareWorker?: (worker: Worker) => void;
+    /**
+     * Optional data to pass to workers when they are initialized.
+     * Will be subjected to the Structured Clone algorithm.
+     */
+    workerData?: unknown;
+    /**
+     * Absolute path to the worker script.
+     */
+    workerScriptPath: string;
+}
+/**
+ * Manages a pool of workers.
+ * Workers will be shutdown by sending them the boolean value `false` in a postMessage.
+ * @internal
+ */
+export declare class WorkerPool {
+    id: string;
+    maxWorkers: number;
+    private readonly _alive;
+    private _error;
+    private _finishing;
+    private readonly _idle;
+    private _nextId;
+    private readonly _onComplete;
+    private readonly _onWorkerDestroyed;
+    private readonly _pending;
+    private readonly _prepare;
+    private readonly _workerData;
+    private readonly _workerScript;
+    constructor(options: IWorkerPoolOptions);
+    /**
+     * Gets the count of active workers.
+     */
+    getActiveCount(): number;
+    /**
+     * Gets the count of idle workers.
+     */
+    getIdleCount(): number;
+    /**
+     * Gets the count of live workers.
+     */
+    getLiveCount(): number;
+    /**
+     * Tells the pool to shut down when all workers are done.
+     * Returns a promise that will be fulfilled if all workers finish successfully, or reject with the first error.
+     */
+    finishAsync(): Promise<void>;
+    /**
+     * Resets the pool and allows more work
+     */
+    reset(): void;
+    /**
+     * Returns a worker to the pool. If the pool is finishing, deallocates the worker.
+     * @param worker - The worker to free
+     */
+    checkinWorker(worker: Worker): void;
+    /**
+     * Checks out a currently available worker or waits for the next free worker.
+     * @param allowCreate - If creating new workers is allowed (subject to maxSize)
+     */
+    checkoutWorkerAsync(allowCreate: boolean): Promise<Worker>;
+    /**
+     * Creates a new worker if allowed by maxSize.
+     */
+    private _createWorker;
+    /**
+     * Cleans up a worker
+     */
+    private _destroyWorker;
+    /**
+     * Notifies all pending callbacks that an error has occurred and switches this pool into error state.
+     */
+    private _onError;
+}
+//# sourceMappingURL=WorkerPool.d.ts.map

package/lib/WorkerPool.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WorkerPool.d.ts","sourceRoot":"","sources":["../src/WorkerPool.ts"],"names":[],"mappings":";AAGA,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;;GAGG;AACH,eAAO,MAAM,gBAAgB,EAAE,OAAO,MAA2B,CAAC;AAElE;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,IAAI,CAAC;IAC/B;;OAEG;IACH,aAAa,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;IACzC;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;CAC1B;AAED;;;;GAIG;AACH,qBAAa,UAAU;IACd,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IAE1B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAW;IAClC,OAAO,CAAC,MAAM,CAAoB;IAClC,OAAO,CAAC,UAAU,CAAU;IAC5B,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAW;IACjC,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAyC;IACrE,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAA2B;IAC9D,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAuD;IAChF,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAyC;IAClE,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAU;IACtC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAS;gBAEpB,OAAO,EAAE,kBAAkB;IAkB9C;;OAEG;IACI,cAAc,IAAI,MAAM;IAI/B;;OAEG;IACI,YAAY,IAAI,MAAM;IAI7B;;OAEG;IACI,YAAY,IAAI,MAAM;IAI7B;;;OAGG;IACU,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;IAqBzC;;OAEG;IACI,KAAK,IAAI,IAAI;IAKpB;;;OAGG;IACI,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAqB1C;;;OAGG;IACU,mBAAmB,CAAC,WAAW,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC;IAmBvE;;OAEG;IACH,OAAO,CAAC,aAAa;IAoCrB;;OAEG;IACH,OAAO,CAAC,cAAc;IAwBtB;;OAEG;IACH,OAAO,CAAC,QAAQ;CAWjB"}

package/lib/WorkerPool.js

@@ -0,0 +1,187 @@
+"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.WorkerPool = exports.WORKER_ID_SYMBOL = void 0;
+const worker_threads_1 = require("worker_threads");
+/**
+ * Symbol to read the ID off of a worker
+ * @internal
+ */
+exports.WORKER_ID_SYMBOL = Symbol('workerId');
+/**
+ * Manages a pool of workers.
+ * Workers will be shutdown by sending them the boolean value `false` in a postMessage.
+ * @internal
+ */
+class WorkerPool {
+    constructor(options) {
+        const { id, maxWorkers, onWorkerDestroyed, prepareWorker, workerData, workerScriptPath } = options;
+        this.id = id;
+        this.maxWorkers = maxWorkers;
+        this._alive = [];
+        this._error = undefined;
+        this._finishing = false;
+        this._idle = [];
+        this._nextId = 0;
+        this._onComplete = [];
+        this._onWorkerDestroyed = onWorkerDestroyed;
+        this._pending = [];
+        this._prepare = prepareWorker;
+        this._workerData = workerData;
+        this._workerScript = workerScriptPath;
+    }
+    /**
+     * Gets the count of active workers.
+     */
+    getActiveCount() {
+        return this._alive.length - this._idle.length;
+    }
+    /**
+     * Gets the count of idle workers.
+     */
+    getIdleCount() {
+        return this._idle.length;
+    }
+    /**
+     * Gets the count of live workers.
+     */
+    getLiveCount() {
+        return this._alive.length;
+    }
+    /**
+     * Tells the pool to shut down when all workers are done.
+     * Returns a promise that will be fulfilled if all workers finish successfully, or reject with the first error.
+     */
+    async finishAsync() {
+        this._finishing = true;
+        if (this._error) {
+            throw this._error;
+        }
+        if (!this._alive.length) {
+            // The pool has no live workers, this is a no-op
+            return;
+        }
+        // Clean up all idle workers
+        for (const worker of this._idle.splice(0)) {
+            worker.postMessage(false);
+        }
+        // There are still active workers, wait for them to clean up.
+        await new Promise((resolve, reject) => this._onComplete.push([resolve, reject]));
+    }
+    /**
+     * Resets the pool and allows more work
+     */
+    reset() {
+        this._finishing = false;
+        this._error = undefined;
+    }
+    /**
+     * Returns a worker to the pool. If the pool is finishing, deallocates the worker.
+     * @param worker - The worker to free
+     */
+    checkinWorker(worker) {
+        if (this._error) {
+            // Shut down the worker (failure)
+            worker.postMessage(false);
+            return;
+        }
+        const next = this._pending.shift();
+        if (next) {
+            // Perform the next unit of work;
+            next[0](worker);
+        }
+        else if (this._finishing) {
+            // Shut down the worker (success)
+            worker.postMessage(false);
+        }
+        else {
+            // No pending work, idle the workers
+            this._idle.push(worker);
+        }
+    }
+    /**
+     * Checks out a currently available worker or waits for the next free worker.
+     * @param allowCreate - If creating new workers is allowed (subject to maxSize)
+     */
+    async checkoutWorkerAsync(allowCreate) {
+        if (this._error) {
+            throw this._error;
+        }
+        let worker = this._idle.shift();
+        if (!worker && allowCreate) {
+            worker = this._createWorker();
+        }
+        if (worker) {
+            return worker;
+        }
+        return await new Promise((resolve, reject) => {
+            this._pending.push([resolve, reject]);
+        });
+    }
+    /**
+     * Creates a new worker if allowed by maxSize.
+     */
+    _createWorker() {
+        if (this._alive.length >= this.maxWorkers) {
+            return;
+        }
+        const worker = new worker_threads_1.Worker(this._workerScript, {
+            eval: false,
+            workerData: this._workerData
+        });
+        const id = `${this.id}#${++this._nextId}`;
+        worker[exports.WORKER_ID_SYMBOL] = id;
+        this._alive.push(worker);
+        worker.on('error', (err) => {
+            this._onError(err);
+            this._destroyWorker(worker);
+        });
+        worker.on('exit', (exitCode) => {
+            if (exitCode !== 0) {
+                this._onError(new Error(`Worker ${id} exited with code ${exitCode}`));
+            }
+            this._destroyWorker(worker);
+        });
+        if (this._prepare) {
+            this._prepare(worker);
+        }
+        return worker;
+    }
+    /**
+     * Cleans up a worker
+     */
+    _destroyWorker(worker) {
+        const aliveIndex = this._alive.indexOf(worker);
+        if (aliveIndex >= 0) {
+            this._alive.splice(aliveIndex, 1);
+        }
+        const freeIndex = this._idle.indexOf(worker);
+        if (freeIndex >= 0) {
+            this._idle.splice(freeIndex, 1);
+        }
+        worker.unref();
+        if (this._onWorkerDestroyed) {
+            this._onWorkerDestroyed();
+        }
+        if (!this._alive.length && !this._error) {
+            for (const [resolve] of this._onComplete.splice(0)) {
+                resolve();
+            }
+        }
+    }
+    /**
+     * Notifies all pending callbacks that an error has occurred and switches this pool into error state.
+     */
+    _onError(error) {
+        this._error = error;
+        for (const [, reject] of this._pending.splice(0)) {
+            reject(this._error);
+        }
+        for (const [, reject] of this._onComplete.splice(0)) {
+            reject(this._error);
+        }
+    }
+}
+exports.WorkerPool = WorkerPool;
+//# sourceMappingURL=WorkerPool.js.map

package/lib/WorkerPool.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WorkerPool.js","sourceRoot":"","sources":["../src/WorkerPool.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAE3D,mDAAwC;AAExC;;;GAGG;AACU,QAAA,gBAAgB,GAAkB,MAAM,CAAC,UAAU,CAAC,CAAC;AAiClE;;;;GAIG;AACH,MAAa,UAAU;IAgBrB,YAAmB,OAA2B;QAC5C,MAAM,EAAE,EAAE,EAAE,UAAU,EAAE,iBAAiB,EAAE,aAAa,EAAE,UAAU,EAAE,gBAAgB,EAAE,GAAG,OAAO,CAAC;QAEnG,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;QACjB,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;QACxB,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;QACxB,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;QAChB,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC;QACjB,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;QACtB,IAAI,CAAC,kBAAkB,GAAG,iBAAiB,CAAC;QAC5C,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;QACnB,IAAI,CAAC,QAAQ,GAAG,aAAa,CAAC;QAC9B,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAC9B,IAAI,CAAC,aAAa,GAAG,gBAAgB,CAAC;IACxC,CAAC;IAED;;OAEG;IACI,cAAc;QACnB,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;IAChD,CAAC;IAED;;OAEG;IACI,YAAY;QACjB,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;IAC3B,CAAC;IAED;;OAEG;IACI,YAAY;QACjB,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;IAC5B,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,WAAW;QACtB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QAEvB,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,MAAM,IAAI,CAAC,MAAM,CAAC;SACnB;QAED,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE;YACvB,gDAAgD;YAChD,OAAO;SACR;QAED,4BAA4B;QAC5B,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE;YACzC,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;SAC3B;QAED,6DAA6D;QAC7D,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IACzF,CAAC;IAED;;OAEG;IACI,KAAK;QACV,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;QACxB,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;IAC1B,CAAC;IAED;;;OAGG;IACI,aAAa,CAAC,MAAc;QACjC,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,iCAAiC;YACjC,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;YAC1B,OAAO;SACR;QAED,MAAM,IAAI,GAAoD,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;QAEpF,IAAI,IAAI,EAAE;YACR,iCAAiC;YACjC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;SACjB;aAAM,IAAI,IAAI,CAAC,UAAU,EAAE;YAC1B,iCAAiC;YACjC,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;SAC3B;aAAM;YACL,oCAAoC;YACpC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SACzB;IACH,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,mBAAmB,CAAC,WAAoB;QACnD,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,MAAM,IAAI,CAAC,MAAM,CAAC;SACnB;QAED,IAAI,MAAM,GAAuB,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;QACpD,IAAI,CAAC,MAAM,IAAI,WAAW,EAAE;YAC1B,MAAM,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;SAC/B;QAED,IAAI,MAAM,EAAE;YACV,OAAO,MAAM,CAAC;SACf;QAED,OAAO,MAAM,IAAI,OAAO,CAAC,CAAC,OAAiC,EAAE,MAA8B,EAAE,EAAE;YAC7F,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACK,aAAa;QACnB,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,IAAI,CAAC,UAAU,EAAE;YACzC,OAAO;SACR;QAED,MAAM,MAAM,GAER,IAAI,uBAAM,CAAC,IAAI,CAAC,aAAa,EAAE;YACjC,IAAI,EAAE,KAAK;YACX,UAAU,EAAE,IAAI,CAAC,WAAW;SAC7B,CAAC,CAAC;QAEH,MAAM,EAAE,GAAW,GAAG,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC;QAClD,MAAM,CAAC,wBAAgB,CAAC,GAAG,EAAE,CAAC;QAE9B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAEzB,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;YACzB,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;YACnB,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE;YAC7B,IAAI,QAAQ,KAAK,CAAC,EAAE;gBAClB,IAAI,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC,UAAU,EAAE,qBAAqB,QAAQ,EAAE,CAAC,CAAC,CAAC;aACvE;YACD,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;QAEH,IAAI,IAAI,CAAC,QAAQ,EAAE;YACjB,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;SACvB;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;OAEG;IACK,cAAc,CAAC,MAAc;QACnC,MAAM,UAAU,GAAW,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACvD,IAAI,UAAU,IAAI,CAAC,EAAE;YACnB,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;SACnC;QAED,MAAM,SAAS,GAAW,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACrD,IAAI,SAAS,IAAI,CAAC,EAAE;YAClB,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;SACjC;QAED,MAAM,CAAC,KAAK,EAAE,CAAC;QAEf,IAAI,IAAI,CAAC,kBAAkB,EAAE;YAC3B,IAAI,CAAC,kBAAkB,EAAE,CAAC;SAC3B;QAED,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YACvC,KAAK,MAAM,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE;gBAClD,OAAO,EAAE,CAAC;aACX;SACF;IACH,CAAC;IAED;;OAEG;IACK,QAAQ,CAAC,KAAY;QAC3B,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QAEpB,KAAK,MAAM,CAAC,EAAE,MAAM,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE;YAChD,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SACrB;QAED,KAAK,MAAM,CAAC,EAAE,MAAM,CAAC,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE;YACnD,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SACrB;IACH,CAAC;CACF;AAxND,gCAwNC","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 { Worker } from 'worker_threads';\n\n/**\n * Symbol to read the ID off of a worker\n * @internal\n */\nexport const WORKER_ID_SYMBOL: unique symbol = Symbol('workerId');\n\n/**\n * @internal\n */\nexport interface IWorkerPoolOptions {\n  /**\n   * Identifier for this pool, to assign to its workers for tracking\n   */\n  id: string;\n  /**\n   * Maximum number of concurrent workers this WorkerPool may spawn.\n   */\n  maxWorkers: number;\n  /**\n   * Optional callback invoked when a worker is destroyed.\n   */\n  onWorkerDestroyed?: () => void;\n  /**\n   * Optional callback invoked on a newly created worker.\n   */\n  prepareWorker?: (worker: Worker) => void;\n  /**\n   * Optional data to pass to workers when they are initialized.\n   * Will be subjected to the Structured Clone algorithm.\n   */\n  workerData?: unknown;\n  /**\n   * Absolute path to the worker script.\n   */\n  workerScriptPath: string;\n}\n\n/**\n * Manages a pool of workers.\n * Workers will be shutdown by sending them the boolean value `false` in a postMessage.\n * @internal\n */\nexport class WorkerPool {\n  public id: string;\n  public maxWorkers: number;\n\n  private readonly _alive: Worker[];\n  private _error: Error | undefined;\n  private _finishing: boolean;\n  private readonly _idle: Worker[];\n  private _nextId: number;\n  private readonly _onComplete: [() => void, (error: Error) => void][];\n  private readonly _onWorkerDestroyed: (() => void) | undefined;\n  private readonly _pending: [(worker: Worker) => void, (error: Error) => void][];\n  private readonly _prepare: ((worker: Worker) => void) | undefined;\n  private readonly _workerData: unknown;\n  private readonly _workerScript: string;\n\n  public constructor(options: IWorkerPoolOptions) {\n    const { id, maxWorkers, onWorkerDestroyed, prepareWorker, workerData, workerScriptPath } = options;\n\n    this.id = id;\n    this.maxWorkers = maxWorkers;\n    this._alive = [];\n    this._error = undefined;\n    this._finishing = false;\n    this._idle = [];\n    this._nextId = 0;\n    this._onComplete = [];\n    this._onWorkerDestroyed = onWorkerDestroyed;\n    this._pending = [];\n    this._prepare = prepareWorker;\n    this._workerData = workerData;\n    this._workerScript = workerScriptPath;\n  }\n\n  /**\n   * Gets the count of active workers.\n   */\n  public getActiveCount(): number {\n    return this._alive.length - this._idle.length;\n  }\n\n  /**\n   * Gets the count of idle workers.\n   */\n  public getIdleCount(): number {\n    return this._idle.length;\n  }\n\n  /**\n   * Gets the count of live workers.\n   */\n  public getLiveCount(): number {\n    return this._alive.length;\n  }\n\n  /**\n   * Tells the pool to shut down when all workers are done.\n   * Returns a promise that will be fulfilled if all workers finish successfully, or reject with the first error.\n   */\n  public async finishAsync(): Promise<void> {\n    this._finishing = true;\n\n    if (this._error) {\n      throw this._error;\n    }\n\n    if (!this._alive.length) {\n      // The pool has no live workers, this is a no-op\n      return;\n    }\n\n    // Clean up all idle workers\n    for (const worker of this._idle.splice(0)) {\n      worker.postMessage(false);\n    }\n\n    // There are still active workers, wait for them to clean up.\n    await new Promise<void>((resolve, reject) => this._onComplete.push([resolve, reject]));\n  }\n\n  /**\n   * Resets the pool and allows more work\n   */\n  public reset(): void {\n    this._finishing = false;\n    this._error = undefined;\n  }\n\n  /**\n   * Returns a worker to the pool. If the pool is finishing, deallocates the worker.\n   * @param worker - The worker to free\n   */\n  public checkinWorker(worker: Worker): void {\n    if (this._error) {\n      // Shut down the worker (failure)\n      worker.postMessage(false);\n      return;\n    }\n\n    const next: [(worker: Worker) => void, unknown] | undefined = this._pending.shift();\n\n    if (next) {\n      // Perform the next unit of work;\n      next[0](worker);\n    } else if (this._finishing) {\n      // Shut down the worker (success)\n      worker.postMessage(false);\n    } else {\n      // No pending work, idle the workers\n      this._idle.push(worker);\n    }\n  }\n\n  /**\n   * Checks out a currently available worker or waits for the next free worker.\n   * @param allowCreate - If creating new workers is allowed (subject to maxSize)\n   */\n  public async checkoutWorkerAsync(allowCreate: boolean): Promise<Worker> {\n    if (this._error) {\n      throw this._error;\n    }\n\n    let worker: Worker | undefined = this._idle.shift();\n    if (!worker && allowCreate) {\n      worker = this._createWorker();\n    }\n\n    if (worker) {\n      return worker;\n    }\n\n    return await new Promise((resolve: (worker: Worker) => void, reject: (error: Error) => void) => {\n      this._pending.push([resolve, reject]);\n    });\n  }\n\n  /**\n   * Creates a new worker if allowed by maxSize.\n   */\n  private _createWorker(): Worker | undefined {\n    if (this._alive.length >= this.maxWorkers) {\n      return;\n    }\n\n    const worker: Worker & {\n      [WORKER_ID_SYMBOL]?: string;\n    } = new Worker(this._workerScript, {\n      eval: false,\n      workerData: this._workerData\n    });\n\n    const id: string = `${this.id}#${++this._nextId}`;\n    worker[WORKER_ID_SYMBOL] = id;\n\n    this._alive.push(worker);\n\n    worker.on('error', (err) => {\n      this._onError(err);\n      this._destroyWorker(worker);\n    });\n\n    worker.on('exit', (exitCode) => {\n      if (exitCode !== 0) {\n        this._onError(new Error(`Worker ${id} exited with code ${exitCode}`));\n      }\n      this._destroyWorker(worker);\n    });\n\n    if (this._prepare) {\n      this._prepare(worker);\n    }\n\n    return worker;\n  }\n\n  /**\n   * Cleans up a worker\n   */\n  private _destroyWorker(worker: Worker): void {\n    const aliveIndex: number = this._alive.indexOf(worker);\n    if (aliveIndex >= 0) {\n      this._alive.splice(aliveIndex, 1);\n    }\n\n    const freeIndex: number = this._idle.indexOf(worker);\n    if (freeIndex >= 0) {\n      this._idle.splice(freeIndex, 1);\n    }\n\n    worker.unref();\n\n    if (this._onWorkerDestroyed) {\n      this._onWorkerDestroyed();\n    }\n\n    if (!this._alive.length && !this._error) {\n      for (const [resolve] of this._onComplete.splice(0)) {\n        resolve();\n      }\n    }\n  }\n\n  /**\n   * Notifies all pending callbacks that an error has occurred and switches this pool into error state.\n   */\n  private _onError(error: Error): void {\n    this._error = error;\n\n    for (const [, reject] of this._pending.splice(0)) {\n      reject(this._error);\n    }\n\n    for (const [, reject] of this._onComplete.splice(0)) {\n      reject(this._error);\n    }\n  }\n}\n"]}

package/lib/index.d.ts

@@ -0,0 +1,3 @@
+export type { IWorkerPoolOptions } from './WorkerPool';
+export { WORKER_ID_SYMBOL, WorkerPool } from './WorkerPool';
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,YAAY,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC"}

package/lib/index.js

@@ -0,0 +1,9 @@
+"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.WorkerPool = exports.WORKER_ID_SYMBOL = void 0;
+var WorkerPool_1 = require("./WorkerPool");
+Object.defineProperty(exports, "WORKER_ID_SYMBOL", { enumerable: true, get: function () { return WorkerPool_1.WORKER_ID_SYMBOL; } });
+Object.defineProperty(exports, "WorkerPool", { enumerable: true, get: function () { return WorkerPool_1.WorkerPool; } });
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAG3D,2CAA4D;AAAnD,8GAAA,gBAAgB,OAAA;AAAE,wGAAA,UAAU,OAAA","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nexport type { IWorkerPoolOptions } from './WorkerPool';\nexport { WORKER_ID_SYMBOL, WorkerPool } from './WorkerPool';\n"]}

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@rushstack/worker-pool",
+  "version": "0.1.0",
+  "description": "Lightweight worker pool using NodeJS worker_threads",
+  "main": "lib/index.js",
+  "typings": "dist/worker-pool.d.ts",
+  "license": "MIT",
+  "repository": {
+    "url": "https://github.com/microsoft/rushstack.git",
+    "type": "git",
+    "directory": "libraries/worker-pool"
+  },
+  "dependencies": {
+    "@types/node": "12.20.24"
+  },
+  "devDependencies": {
+    "@rushstack/eslint-config": "2.6.0",
+    "@rushstack/heft": "0.45.4",
+    "@rushstack/heft-node-rig": "1.9.5",
+    "@types/heft-jest": "1.0.1"
+  },
+  "scripts": {
+    "build": "heft build --clean",
+    "_phase:build": "heft build --clean",
+    "_phase:test": "heft test --no-build"
+  },
+  "readme": "# @rushstack/worker-pool\n\nThis library contains a lightweight worker pool using the NodeJS worker_threads API.\n\n## Links\n\n- [CHANGELOG.md](\n  https://github.com/microsoft/rushstack/blob/main/libraries/worker-pool/CHANGELOG.md) - Find\n  out what's new in the latest version\n- [API Reference](https://rushstack.io/pages/api/worker-pool/)\n\n`@rushstack/worker-pool` is part of the [Rush Stack](https://rushstack.io/) family of projects.\n"
+}