threadsx 2.0.0

package/dist-esm/master/spawn.js

@@ -0,0 +1,153 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import DebugLogger from "debug";
+import { Observable } from "observable-fns";
+import { deserialize } from "../common";
+import { createPromiseWithResolver } from "../promise";
+import { $errors, $events, $terminate, $worker } from "../symbols";
+import { WorkerEventType } from "../types/master";
+import { createProxyFunction, createProxyModule } from "./invocation-proxy";
+const debugMessages = DebugLogger("threads:master:messages");
+const debugSpawn = DebugLogger("threads:master:spawn");
+const debugThreadUtils = DebugLogger("threads:master:thread-utils");
+const isInitMessage = (data) => data && data.type === "init";
+const isUncaughtErrorMessage = (data) => data && data.type === "uncaughtError";
+const initMessageTimeout = typeof process !== "undefined" && typeof process.env !== "undefined" && process.env.THREADS_WORKER_INIT_TIMEOUT
+    ? Number.parseInt(process.env.THREADS_WORKER_INIT_TIMEOUT, 10)
+    : 10000;
+function withTimeout(promise, timeoutInMs, errorMessage) {
+    return __awaiter(this, void 0, void 0, function* () {
+        let timeoutHandle;
+        const timeout = new Promise((resolve, reject) => {
+            timeoutHandle = setTimeout(() => reject(Error(errorMessage)), timeoutInMs);
+        });
+        try {
+            return yield Promise.race([
+                promise,
+                timeout
+            ]);
+        }
+        finally {
+            // Always clear the timer, even when `promise` rejects. Otherwise a pending
+            // timeout keeps the event loop alive until it fires (which on a failed
+            // spawn showed up as ava "failed to exit" on slower runners).
+            clearTimeout(timeoutHandle);
+        }
+    });
+}
+function receiveInitMessage(worker) {
+    return new Promise((resolve, reject) => {
+        const messageHandler = ((event) => {
+            debugMessages("Message from worker before finishing initialization:", event.data);
+            if (isInitMessage(event.data)) {
+                worker.removeEventListener("message", messageHandler);
+                resolve(event.data);
+            }
+            else if (isUncaughtErrorMessage(event.data)) {
+                worker.removeEventListener("message", messageHandler);
+                reject(deserialize(event.data.error));
+            }
+        });
+        worker.addEventListener("message", messageHandler);
+    });
+}
+function createEventObservable(worker, workerTermination) {
+    return new Observable(observer => {
+        const messageHandler = ((messageEvent) => {
+            const workerEvent = {
+                type: WorkerEventType.message,
+                data: messageEvent.data
+            };
+            observer.next(workerEvent);
+        });
+        const rejectionHandler = ((errorEvent) => {
+            debugThreadUtils("Unhandled promise rejection event in thread:", errorEvent);
+            const workerEvent = {
+                type: WorkerEventType.internalError,
+                error: Error(errorEvent.reason)
+            };
+            observer.next(workerEvent);
+        });
+        worker.addEventListener("message", messageHandler);
+        worker.addEventListener("unhandledrejection", rejectionHandler);
+        workerTermination.then(() => {
+            const terminationEvent = {
+                type: WorkerEventType.termination
+            };
+            worker.removeEventListener("message", messageHandler);
+            worker.removeEventListener("unhandledrejection", rejectionHandler);
+            observer.next(terminationEvent);
+            observer.complete();
+        });
+    });
+}
+function createTerminator(worker) {
+    const [termination, resolver] = createPromiseWithResolver();
+    const terminate = () => __awaiter(this, void 0, void 0, function* () {
+        debugThreadUtils("Terminating worker");
+        // Newer versions of worker_threads workers return a promise
+        yield worker.terminate();
+        resolver();
+    });
+    return { terminate, termination };
+}
+function setPrivateThreadProps(raw, worker, workerEvents, terminate) {
+    const workerErrors = workerEvents
+        .filter(event => event.type === WorkerEventType.internalError)
+        .map(errorEvent => errorEvent.error);
+    return Object.assign(raw, {
+        [$errors]: workerErrors,
+        [$events]: workerEvents,
+        [$terminate]: terminate,
+        [$worker]: worker
+    });
+}
+/**
+ * Spawn a new thread. Takes a fresh worker instance, wraps it in a thin
+ * abstraction layer to provide the transparent API and verifies that
+ * the worker has initialized successfully.
+ *
+ * @param worker Instance of `Worker`. Either a web worker or a `worker_threads` worker.
+ * @param [options]
+ * @param [options.timeout] Init message timeout. Default: 10000 or set by environment variable.
+ */
+export function spawn(worker, options) {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a, _b;
+        debugSpawn("Initializing new thread");
+        const timeout = options && options.timeout ? options.timeout : initMessageTimeout;
+        let initMessage;
+        try {
+            initMessage = yield withTimeout(receiveInitMessage(worker), timeout, `Timeout: Did not receive an init message from worker after ${timeout}ms. Make sure the worker calls expose().`);
+        }
+        catch (error) {
+            // The worker failed to initialise (e.g. it threw before calling expose(),
+            // or never sent an init message). Tear it down so it does not leak a live
+            // worker handle and keep the process from exiting.
+            yield Promise.resolve((_b = (_a = worker).terminate) === null || _b === void 0 ? void 0 : _b.call(_a)).catch(() => undefined);
+            throw error;
+        }
+        const exposed = initMessage.exposed;
+        const { termination, terminate } = createTerminator(worker);
+        const events = createEventObservable(worker, termination);
+        if (exposed.type === "function") {
+            const proxy = createProxyFunction(worker);
+            return setPrivateThreadProps(proxy, worker, events, terminate);
+        }
+        else if (exposed.type === "module") {
+            const proxy = createProxyModule(worker, exposed.methods);
+            return setPrivateThreadProps(proxy, worker, events, terminate);
+        }
+        else {
+            const type = exposed.type;
+            throw Error(`Worker init message states unexpected type of expose(): ${type}`);
+        }
+    });
+}

package/dist-esm/master/thread.js

@@ -0,0 +1,19 @@
+import { $errors, $events, $terminate } from "../symbols";
+function fail(message) {
+    throw Error(message);
+}
+/** Thread utility functions. Use them to manage or inspect a `spawn()`-ed thread. */
+export const Thread = {
+    /** Return an observable that can be used to subscribe to all errors happening in the thread. */
+    errors(thread) {
+        return thread[$errors] || fail("Error observable not found. Make sure to pass a thread instance as returned by the spawn() promise.");
+    },
+    /** Return an observable that can be used to subscribe to internal events happening in the thread. Useful for debugging. */
+    events(thread) {
+        return thread[$events] || fail("Events observable not found. Make sure to pass a thread instance as returned by the spawn() promise.");
+    },
+    /** Terminate a thread. Remember to terminate every thread when you are done using it. */
+    terminate(thread) {
+        return thread[$terminate]();
+    }
+};

package/dist-esm/observable-promise.js

@@ -0,0 +1,146 @@
+var _a;
+import { Observable } from "observable-fns";
+const doNothing = () => undefined;
+const returnInput = (input) => input;
+const runDeferred = (fn) => Promise.resolve().then(fn);
+function fail(error) {
+    throw error;
+}
+function isThenable(thing) {
+    return thing && typeof thing.then === "function";
+}
+/**
+ * Creates a hybrid, combining the APIs of an Observable and a Promise.
+ *
+ * It is used to proxy async process states when we are initially not sure
+ * if that async process will yield values once (-> Promise) or multiple
+ * times (-> Observable).
+ *
+ * Note that the observable promise inherits some of the observable's characteristics:
+ * The `init` function will be called *once for every time anyone subscribes to it*.
+ *
+ * If this is undesired, derive a hot observable from it using `makeHot()` and
+ * subscribe to that.
+ */
+export class ObservablePromise extends Observable {
+    constructor(init) {
+        super((originalObserver) => {
+            // eslint-disable-next-line @typescript-eslint/no-this-alias
+            const self = this;
+            const observer = Object.assign(Object.assign({}, originalObserver), { complete() {
+                    originalObserver.complete();
+                    self.onCompletion();
+                },
+                error(error) {
+                    originalObserver.error(error);
+                    self.onError(error);
+                },
+                next(value) {
+                    originalObserver.next(value);
+                    self.onNext(value);
+                } });
+            try {
+                this.initHasRun = true;
+                return init(observer);
+            }
+            catch (error) {
+                observer.error(error);
+            }
+        });
+        this.initHasRun = false;
+        this.fulfillmentCallbacks = [];
+        this.rejectionCallbacks = [];
+        this.firstValueSet = false;
+        this.state = "pending";
+        this[_a] = "[object ObservablePromise]";
+    }
+    onNext(value) {
+        if (!this.firstValueSet) {
+            this.firstValue = value;
+            this.firstValueSet = true;
+        }
+    }
+    onError(error) {
+        this.state = "rejected";
+        this.rejection = error;
+        for (const onRejected of this.rejectionCallbacks) {
+            // Promisifying the call to turn errors into unhandled promise rejections
+            // instead of them failing sync and cancelling the iteration
+            runDeferred(() => onRejected(error));
+        }
+    }
+    onCompletion() {
+        this.state = "fulfilled";
+        for (const onFulfilled of this.fulfillmentCallbacks) {
+            // Promisifying the call to turn errors into unhandled promise rejections
+            // instead of them failing sync and cancelling the iteration
+            runDeferred(() => onFulfilled(this.firstValue));
+        }
+    }
+    then(onFulfilledRaw, onRejectedRaw) {
+        const onFulfilled = onFulfilledRaw || returnInput;
+        const onRejected = onRejectedRaw || fail;
+        let onRejectedCalled = false;
+        return new Promise((resolve, reject) => {
+            const rejectionCallback = (error) => {
+                if (onRejectedCalled)
+                    return;
+                onRejectedCalled = true;
+                try {
+                    resolve(onRejected(error));
+                }
+                catch (anotherError) {
+                    reject(anotherError);
+                }
+            };
+            const fulfillmentCallback = (value) => {
+                try {
+                    resolve(onFulfilled(value));
+                }
+                catch (error) {
+                    rejectionCallback(error);
+                }
+            };
+            if (!this.initHasRun) {
+                this.subscribe({ error: rejectionCallback });
+            }
+            if (this.state === "fulfilled") {
+                return resolve(onFulfilled(this.firstValue));
+            }
+            if (this.state === "rejected") {
+                onRejectedCalled = true;
+                return resolve(onRejected(this.rejection));
+            }
+            this.fulfillmentCallbacks.push(fulfillmentCallback);
+            this.rejectionCallbacks.push(rejectionCallback);
+        });
+    }
+    catch(onRejected) {
+        return this.then(undefined, onRejected);
+    }
+    finally(onCompleted) {
+        const handler = onCompleted || doNothing;
+        return this.then((value) => {
+            handler();
+            return value;
+        }, () => handler());
+    }
+    static from(thing) {
+        if (isThenable(thing)) {
+            return new ObservablePromise(observer => {
+                const onFulfilled = (value) => {
+                    observer.next(value);
+                    observer.complete();
+                };
+                const onRejected = (error) => {
+                    observer.error(error);
+                };
+                thing.then(onFulfilled, onRejected);
+            });
+        }
+        else {
+            return super.from(thing);
+        }
+    }
+}
+_a = Symbol.toStringTag;

package/dist-esm/observable.js

@@ -0,0 +1,36 @@
+import { Observable } from "observable-fns";
+export { Observable };
+const $observers = Symbol("observers");
+/**
+ * Observable subject. Implements the Observable interface, but also exposes
+ * the `next()`, `error()`, `complete()` methods to initiate observable
+ * updates "from the outside".
+ *
+ * Use `Observable.from(subject)` to derive an observable that proxies all
+ * values, errors and the completion raised on this subject, but does not
+ * expose the `next()`, `error()`, `complete()` methods.
+ */
+export class Subject extends Observable {
+    constructor() {
+        super(observer => {
+            this[$observers] = [
+                ...(this[$observers] || []),
+                observer
+            ];
+            const unsubscribe = () => {
+                this[$observers] = this[$observers].filter(someObserver => someObserver !== observer);
+            };
+            return unsubscribe;
+        });
+        this[$observers] = [];
+    }
+    complete() {
+        this[$observers].forEach(observer => observer.complete());
+    }
+    error(error) {
+        this[$observers].forEach(observer => observer.error(error));
+    }
+    next(value) {
+        this[$observers].forEach(observer => observer.next(value));
+    }
+}

package/dist-esm/ponyfills.js

@@ -0,0 +1,18 @@
+// Based on <https://github.com/es-shims/Promise.allSettled/blob/master/implementation.js>
+export function allSettled(values) {
+    return Promise.all(values.map(item => {
+        const onFulfill = (value) => {
+            return { status: 'fulfilled', value };
+        };
+        const onReject = (reason) => {
+            return { status: 'rejected', reason };
+        };
+        const itemPromise = Promise.resolve(item);
+        try {
+            return itemPromise.then(onFulfill, onReject);
+        }
+        catch (error) {
+            return Promise.reject(error);
+        }
+    }));
+}

package/dist-esm/promise.js

@@ -0,0 +1,24 @@
+const doNothing = () => undefined;
+/**
+ * Creates a new promise and exposes its resolver function.
+ * Use with care!
+ */
+export function createPromiseWithResolver() {
+    let alreadyResolved = false;
+    let resolvedTo;
+    let resolver = doNothing;
+    const promise = new Promise(resolve => {
+        if (alreadyResolved) {
+            resolve(resolvedTo);
+        }
+        else {
+            resolver = resolve;
+        }
+    });
+    const exposedResolver = (value) => {
+        alreadyResolved = true;
+        resolvedTo = value;
+        resolver(resolvedTo);
+    };
+    return [promise, exposedResolver];
+}

package/dist-esm/serializers.js

@@ -0,0 +1,47 @@
+export function extendSerializer(extend, implementation) {
+    const fallbackDeserializer = extend.deserialize.bind(extend);
+    const fallbackSerializer = extend.serialize.bind(extend);
+    return {
+        deserialize(message) {
+            return implementation.deserialize(message, fallbackDeserializer);
+        },
+        serialize(input) {
+            return implementation.serialize(input, fallbackSerializer);
+        }
+    };
+}
+const DefaultErrorSerializer = {
+    deserialize(message) {
+        return Object.assign(Error(message.message), {
+            name: message.name,
+            stack: message.stack
+        });
+    },
+    serialize(error) {
+        return {
+            __error_marker: "$$error",
+            message: error.message,
+            name: error.name,
+            stack: error.stack
+        };
+    }
+};
+const isSerializedError = (thing) => thing && typeof thing === "object" && "__error_marker" in thing && thing.__error_marker === "$$error";
+export const DefaultSerializer = {
+    deserialize(message) {
+        if (isSerializedError(message)) {
+            return DefaultErrorSerializer.deserialize(message);
+        }
+        else {
+            return message;
+        }
+    },
+    serialize(input) {
+        if (input instanceof Error) {
+            return DefaultErrorSerializer.serialize(input);
+        }
+        else {
+            return input;
+        }
+    }
+};

package/dist-esm/symbols.js

@@ -0,0 +1,5 @@
+export const $errors = Symbol("thread.errors");
+export const $events = Symbol("thread.events");
+export const $terminate = Symbol("thread.terminate");
+export const $transferable = Symbol("thread.transferable");
+export const $worker = Symbol("thread.worker");

package/dist-esm/transferable.js

@@ -0,0 +1,22 @@
+import { $transferable } from "./symbols";
+function isTransferable(thing) {
+    if (!thing || typeof thing !== "object")
+        return false;
+    // Don't check too thoroughly, since the list of transferable things in JS might grow over time
+    return true;
+}
+export function isTransferDescriptor(thing) {
+    return thing && typeof thing === "object" && thing[$transferable];
+}
+export function Transfer(payload, transferables) {
+    if (!transferables) {
+        if (!isTransferable(payload))
+            throw Error();
+        transferables = [payload];
+    }
+    return {
+        [$transferable]: true,
+        send: payload,
+        transferables
+    };
+}

package/dist-esm/types/master.js

@@ -0,0 +1,9 @@
+/// <reference lib="dom" />
+import { $errors, $events, $terminate, $worker } from "../symbols";
+/** Event as emitted by worker thread. Subscribe to using `Thread.events(thread)`. */
+export var WorkerEventType;
+(function (WorkerEventType) {
+    WorkerEventType["internalError"] = "internalError";
+    WorkerEventType["message"] = "message";
+    WorkerEventType["termination"] = "termination";
+})(WorkerEventType || (WorkerEventType = {}));

package/dist-esm/types/messages.js

@@ -0,0 +1,17 @@
+/////////////////////////////
+// Messages sent by master:
+export var MasterMessageType;
+(function (MasterMessageType) {
+    MasterMessageType["cancel"] = "cancel";
+    MasterMessageType["run"] = "run";
+})(MasterMessageType || (MasterMessageType = {}));
+////////////////////////////
+// Messages sent by worker:
+export var WorkerMessageType;
+(function (WorkerMessageType) {
+    WorkerMessageType["error"] = "error";
+    WorkerMessageType["init"] = "init";
+    WorkerMessageType["result"] = "result";
+    WorkerMessageType["running"] = "running";
+    WorkerMessageType["uncaughtError"] = "uncaughtError";
+})(WorkerMessageType || (WorkerMessageType = {}));

package/dist-esm/types/worker.js

@@ -0,0 +1 @@
+export {};

package/dist-esm/worker/bundle-entry.js

@@ -0,0 +1,8 @@
+import { expose } from "./index";
+export * from "./index";
+if (typeof global !== "undefined") {
+    global.expose = expose;
+}
+if (typeof self !== "undefined") {
+    self.expose = expose;
+}

package/dist-esm/worker/implementation.browser.js

@@ -0,0 +1,23 @@
+/// <reference lib="dom" />
+const isWorkerRuntime = function isWorkerRuntime() {
+    const isWindowContext = typeof self !== "undefined" && typeof Window !== "undefined" && self instanceof Window;
+    return typeof self !== "undefined" && typeof self.postMessage === "function" && !isWindowContext;
+};
+const postMessageToMaster = function postMessageToMaster(data, transferList) {
+    self.postMessage(data, transferList);
+};
+const subscribeToMasterMessages = function subscribeToMasterMessages(onMessage) {
+    const messageHandler = (messageEvent) => {
+        onMessage(messageEvent.data);
+    };
+    const unsubscribe = () => {
+        self.removeEventListener("message", messageHandler);
+    };
+    self.addEventListener("message", messageHandler);
+    return unsubscribe;
+};
+export default {
+    isWorkerRuntime,
+    postMessageToMaster,
+    subscribeToMasterMessages
+};

package/dist-esm/worker/implementation.js

@@ -0,0 +1,13 @@
+/*
+ * This file is only a stub to make './implementation' resolve to the right module.
+ */
+import WebWorkerImplementation from "./implementation.browser";
+import WorkerThreadsImplementation from "./implementation.worker_threads";
+const runningInNode = typeof process !== 'undefined' && process.arch !== 'browser' && 'pid' in process;
+function selectNodeImplementation() {
+    WorkerThreadsImplementation.testImplementation();
+    return WorkerThreadsImplementation;
+}
+export default runningInNode
+    ? selectNodeImplementation()
+    : WebWorkerImplementation;

package/dist-esm/worker/implementation.worker_threads.js

@@ -0,0 +1,37 @@
+import WorkerThreads from "../worker_threads";
+function assertMessagePort(port) {
+    if (!port) {
+        throw Error("Invariant violation: MessagePort to parent is not available.");
+    }
+    return port;
+}
+const isWorkerRuntime = function isWorkerRuntime() {
+    return !WorkerThreads().isMainThread;
+};
+const postMessageToMaster = function postMessageToMaster(data, transferList) {
+    assertMessagePort(WorkerThreads().parentPort).postMessage(data, transferList);
+};
+const subscribeToMasterMessages = function subscribeToMasterMessages(onMessage) {
+    const parentPort = WorkerThreads().parentPort;
+    if (!parentPort) {
+        throw Error("Invariant violation: MessagePort to parent is not available.");
+    }
+    const messageHandler = (message) => {
+        onMessage(message);
+    };
+    const unsubscribe = () => {
+        assertMessagePort(parentPort).off("message", messageHandler);
+    };
+    assertMessagePort(parentPort).on("message", messageHandler);
+    return unsubscribe;
+};
+function testImplementation() {
+    // Will throw if `worker_threads` are not available
+    WorkerThreads();
+}
+export default {
+    isWorkerRuntime,
+    postMessageToMaster,
+    subscribeToMasterMessages,
+    testImplementation
+};