threadsx 2.0.2 → 2.2.0

package/esm/worker/index.mjs

@@ -0,0 +1,224 @@
+import { createRequire as __createRequire } from "module";
+import { fileURLToPath as __fileURLToPath } from "url";
+import { dirname as __pathDirname } from "path";
+const require = __createRequire(import.meta.url);
+const __filename = __fileURLToPath(import.meta.url);
+const __dirname = __pathDirname(__filename);
+import { serialize, deserialize } from '../common.mjs';
+export { registerSerializer } from '../common.mjs';
+import { isTransferDescriptor } from '../transferable.mjs';
+export { Transfer } from '../transferable.mjs';
+import { WorkerMessageType, MasterMessageType } from '../types/messages.mjs';
+import Implementation from './implementation.mjs';
+
+var __awaiter = (undefined && undefined.__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());
+    });
+};
+/** Returns `true` if this code is currently running in a worker. */
+const isWorkerRuntime = Implementation.isWorkerRuntime;
+let exposeCalled = false;
+const activeSubscriptions = new Map();
+const isMasterJobCancelMessage = (thing) => thing && thing.type === MasterMessageType.cancel;
+const isMasterJobRunMessage = (thing) => thing && thing.type === MasterMessageType.run;
+/**
+ * Detects observables via the `Symbol.observable` / `@@observable` interop protocol.
+ * Inlined from the `is-observable` package (which is now ESM-only) to keep the
+ * CommonJS build working without an extra dependency.
+ */
+function isInteropObservable(thing) {
+    if (!thing) {
+        return false;
+    }
+    const observableSymbol = Symbol.observable;
+    if (typeof observableSymbol === "symbol" && typeof thing[observableSymbol] === "function") {
+        return thing === thing[observableSymbol]();
+    }
+    if (typeof thing["@@observable"] === "function") {
+        return thing === thing["@@observable"]();
+    }
+    return false;
+}
+/**
+ * There are issues with interop observable detection not recognizing zen-observable's instances.
+ * We are using `observable-fns`, but it's based on zen-observable, too.
+ */
+const isObservable = (thing) => isInteropObservable(thing) || isZenObservable(thing);
+function isZenObservable(thing) {
+    return thing && typeof thing === "object" && typeof thing.subscribe === "function";
+}
+function deconstructTransfer(thing) {
+    return isTransferDescriptor(thing)
+        ? { payload: thing.send, transferables: thing.transferables }
+        : { payload: thing, transferables: undefined };
+}
+function postFunctionInitMessage() {
+    const initMessage = {
+        type: WorkerMessageType.init,
+        exposed: {
+            type: "function"
+        }
+    };
+    Implementation.postMessageToMaster(initMessage);
+}
+function postModuleInitMessage(methodNames) {
+    const initMessage = {
+        type: WorkerMessageType.init,
+        exposed: {
+            type: "module",
+            methods: methodNames
+        }
+    };
+    Implementation.postMessageToMaster(initMessage);
+}
+function postJobErrorMessage(uid, rawError) {
+    const { payload: error, transferables } = deconstructTransfer(rawError);
+    const errorMessage = {
+        type: WorkerMessageType.error,
+        uid,
+        error: serialize(error)
+    };
+    Implementation.postMessageToMaster(errorMessage, transferables);
+}
+function postJobResultMessage(uid, completed, resultValue) {
+    const { payload, transferables } = deconstructTransfer(resultValue);
+    const resultMessage = {
+        type: WorkerMessageType.result,
+        uid,
+        complete: completed ? true : undefined,
+        payload
+    };
+    Implementation.postMessageToMaster(resultMessage, transferables);
+}
+function postJobStartMessage(uid, resultType) {
+    const startMessage = {
+        type: WorkerMessageType.running,
+        uid,
+        resultType
+    };
+    Implementation.postMessageToMaster(startMessage);
+}
+function postUncaughtErrorMessage(error) {
+    try {
+        const errorMessage = {
+            type: WorkerMessageType.uncaughtError,
+            error: serialize(error)
+        };
+        Implementation.postMessageToMaster(errorMessage);
+    }
+    catch (subError) {
+        console.error("Not reporting uncaught error back to master thread as it " +
+            "occured while reporting an uncaught error already." +
+            "\nLatest error:", subError, "\nOriginal error:", error);
+    }
+}
+function runFunction(jobUID, fn, args) {
+    return __awaiter(this, void 0, void 0, function* () {
+        let syncResult;
+        try {
+            syncResult = fn(...args);
+        }
+        catch (error) {
+            return postJobErrorMessage(jobUID, error);
+        }
+        const resultType = isObservable(syncResult) ? "observable" : "promise";
+        postJobStartMessage(jobUID, resultType);
+        if (isObservable(syncResult)) {
+            const subscription = syncResult.subscribe(value => postJobResultMessage(jobUID, false, serialize(value)), error => {
+                postJobErrorMessage(jobUID, serialize(error));
+                activeSubscriptions.delete(jobUID);
+            }, () => {
+                postJobResultMessage(jobUID, true);
+                activeSubscriptions.delete(jobUID);
+            });
+            activeSubscriptions.set(jobUID, subscription);
+        }
+        else {
+            try {
+                const result = yield syncResult;
+                postJobResultMessage(jobUID, true, serialize(result));
+            }
+            catch (error) {
+                postJobErrorMessage(jobUID, serialize(error));
+            }
+        }
+    });
+}
+/**
+ * Expose a function or a module (an object whose values are functions)
+ * to the main thread. Must be called exactly once in every worker thread
+ * to signal its API to the main thread.
+ *
+ * @param exposed Function or object whose values are functions
+ */
+function expose(exposed) {
+    if (!Implementation.isWorkerRuntime()) {
+        throw Error("expose() called in the master thread.");
+    }
+    if (exposeCalled) {
+        throw Error("expose() called more than once. This is not possible. Pass an object to expose() if you want to expose multiple functions.");
+    }
+    exposeCalled = true;
+    if (typeof exposed === "function") {
+        Implementation.subscribeToMasterMessages(messageData => {
+            if (isMasterJobRunMessage(messageData) && !messageData.method) {
+                runFunction(messageData.uid, exposed, messageData.args.map(deserialize));
+            }
+        });
+        postFunctionInitMessage();
+    }
+    else if (typeof exposed === "object" && exposed) {
+        Implementation.subscribeToMasterMessages(messageData => {
+            if (isMasterJobRunMessage(messageData) && messageData.method) {
+                runFunction(messageData.uid, exposed[messageData.method], messageData.args.map(deserialize));
+            }
+        });
+        const methodNames = Object.keys(exposed).filter(key => typeof exposed[key] === "function");
+        postModuleInitMessage(methodNames);
+    }
+    else {
+        throw Error(`Invalid argument passed to expose(). Expected a function or an object, got: ${exposed}`);
+    }
+    Implementation.subscribeToMasterMessages(messageData => {
+        if (isMasterJobCancelMessage(messageData)) {
+            const jobUID = messageData.uid;
+            const subscription = activeSubscriptions.get(jobUID);
+            if (subscription) {
+                subscription.unsubscribe();
+                activeSubscriptions.delete(jobUID);
+            }
+        }
+    });
+}
+if (typeof self !== "undefined" && typeof self.addEventListener === "function" && Implementation.isWorkerRuntime()) {
+    self.addEventListener("error", event => {
+        // Post with some delay, so the master had some time to subscribe to messages
+        setTimeout(() => postUncaughtErrorMessage(event.error || event), 250);
+    });
+    self.addEventListener("unhandledrejection", event => {
+        const error = event.reason;
+        if (error && typeof error.message === "string") {
+            // Post with some delay, so the master had some time to subscribe to messages
+            setTimeout(() => postUncaughtErrorMessage(error), 250);
+        }
+    });
+}
+if (typeof process !== "undefined" && typeof process.on === "function" && Implementation.isWorkerRuntime()) {
+    process.on("uncaughtException", (error) => {
+        // Post with some delay, so the master had some time to subscribe to messages
+        setTimeout(() => postUncaughtErrorMessage(error), 250);
+    });
+    process.on("unhandledRejection", (error) => {
+        if (error && typeof error.message === "string") {
+            // Post with some delay, so the master had some time to subscribe to messages
+            setTimeout(() => postUncaughtErrorMessage(error), 250);
+        }
+    });
+}
+
+export { expose, isWorkerRuntime };

package/esm/worker_threads.mjs

@@ -0,0 +1,13 @@
+import { createRequire as __createRequire } from "module";
+import { fileURLToPath as __fileURLToPath } from "url";
+import { dirname as __pathDirname } from "path";
+const require = __createRequire(import.meta.url);
+const __filename = __fileURLToPath(import.meta.url);
+const __dirname = __pathDirname(__filename);
+import * as WorkerThreadsModule from 'worker_threads';
+
+function getImplementation() {
+    return WorkerThreadsModule;
+}
+
+export { getImplementation as default };

package/package.json

@@ -1,18 +1,19 @@
 {
   "name": "threadsx",
-  "version": "2.0.2",
+  "version": "2.2.0",
   "description": "Make web workers & worker threads as simple as a function call. Maintained, modernized fork of threads.js — Node.js 20+, ESM & CommonJS, TypeScript, observables and thread pools.",
   "license": "MIT",
   "main": "dist/index.js",
   "module": "dist-esm/index.js",
   "scripts": {
-    "clean": "rimraf dist/ dist-esm/",
+    "clean": "rimraf dist/ dist-esm/ esm/",
     "dev": "npm run clean && tsc -p tsconfig.json --watch",
     "build": "npm run clean && npm run build:cjs && npm run build:es",
     "build:cjs": "tsc -p tsconfig.json",
     "build:es": "tsc -p tsconfig-esm.json",
-    "postbuild": "npm run bundle",
+    "postbuild": "npm run bundle && npm run bundle:entries",
     "bundle": "rollup -c -f umd --file=bundle/worker.js --name=threads --silent -- dist-esm/worker/bundle-entry.js",
+    "bundle:entries": "rollup -c rollup.entries.config.js --silent",
     "lint": "eslint .",
     "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
     "test": "npm run lint && npm run test:library && npm run test:tooling && npm run test:browser",
@@ -20,38 +21,41 @@
     "test:tooling": "ava ./test-tooling/**/*.test.ts",
     "test:browser": "playwright test",
     "test:coverage": "c8 ava ./test/**/*.test.ts",
+    "test:coverage:browser": "COVERAGE=1 playwright test",
+    "test:coverage:merged": "npm run test:coverage && npm run test:coverage:browser && node scripts/merge-coverage.mjs",
     "prepare": "npm run build"
   },
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
       "module": "./dist-esm/index.js",
-      "import": "./index.mjs",
+      "import": "./esm/index.mjs",
       "require": "./dist/index.js"
     },
     "./observable": {
       "types": "./dist/observable.d.ts",
       "module": "./dist-esm/observable.js",
-      "import": "./observable.mjs",
+      "import": "./esm/observable.mjs",
       "require": "./dist/observable.js"
     },
     "./register": {
+      "types": "./dist/master/register.d.ts",
       "module": "./dist-esm/master/register.js",
-      "import": "./register.mjs",
+      "import": "./esm/master/register.mjs",
       "require": "./dist/master/register.js"
     },
     "./worker": {
       "types": "./dist/worker/index.d.ts",
       "module": "./dist-esm/worker/index.js",
-      "import": "./worker.mjs",
+      "import": "./esm/worker/index.mjs",
       "require": "./dist/worker/index.js"
     }
   },
   "sideEffects": [
     "./dist*/master/register.js",
     "./dist*/worker/index.js",
-    "./register.mjs",
-    "./worker.mjs"
+    "./esm/master/register.mjs",
+    "./esm/worker/index.mjs"
   ],
   "repository": {
     "type": "git",
@@ -94,22 +98,25 @@
     "@rollup/plugin-commonjs": "^29.0.3",
     "@rollup/plugin-node-resolve": "^16.0.3",
     "@types/debug": "^4.1.12",
-    "@types/execa": "^2.0.0",
     "@types/node": "^20.19.0",
     "ava": "^7.0.0",
-    "c8": "^10.1.3",
+    "c8": "^11.0.0",
     "esbuild": "^0.25.12",
     "eslint": "^10.5.0",
-    "eslint-config-prettier": "^9.1.2",
-    "execa": "^4.0.3",
+    "eslint-config-prettier": "^10.1.8",
     "globals": "^16.5.0",
+    "istanbul-lib-coverage": "^3.2.2",
+    "istanbul-lib-instrument": "^6.0.3",
+    "istanbul-lib-report": "^3.0.1",
+    "istanbul-lib-source-maps": "^5.0.6",
+    "istanbul-reports": "^3.2.0",
     "prettier": "^3.8.4",
     "rimraf": "^6.0.1",
     "rollup": "^4.62.0",
     "ts-loader": "^9.6.1",
     "tsx": "^4.22.4",
-    "typescript": "^5.9.3",
-    "typescript-eslint": "^8.61.1",
+    "typescript": "^6.0.3",
+    "typescript-eslint": "^8.62.1",
     "webpack": "^5.107.2"
   },
   "ava": {
@@ -142,12 +149,13 @@
     "reporter": [
       "text-summary",
       "text",
-      "lcov"
+      "lcov",
+      "json"
     ],
     "check-coverage": true,
-    "lines": 91,
-    "branches": 80,
-    "functions": 90
+    "lines": 94,
+    "branches": 84,
+    "functions": 91
   },
   "browser": {
     "callsites": false,
@@ -171,9 +179,9 @@
   "files": [
     "dist/**",
     "dist-esm/**",
-    "index.mjs",
-    "observable.mjs",
-    "register.mjs",
-    "worker.mjs"
-  ]
+    "esm/**"
+  ],
+  "overrides": {
+    "js-yaml": "^4.1.0"
+  }
 }

package/index.mjs

@@ -1,4 +0,0 @@
-// ESM entry for Node. Re-exports the CommonJS build (which is runtime-safe in
-// both module systems); bundlers get the tree-shakeable dist-esm/ build via the
-// "module" condition in package.json#exports.
-export * from "./dist/index.js"

package/observable.mjs

@@ -1 +0,0 @@
-export * from "./dist/observable.js"

package/register.mjs

@@ -1,2 +0,0 @@
-// Side-effect only: registers the threads.js Worker as the global Worker.
-import "./dist/master/register.js"

package/worker.mjs

@@ -1 +0,0 @@
-export * from "./dist/worker/index.js"