WIP - this commit does not work, threadsjs is likely needs to be incorporated into our libraries and rewritten

Author: CMCDragonkai

package.json

@@ -40,7 +40,8 @@
     "@matrixai/async-init": "^2.0.0",
     "@matrixai/errors": "^2.0.1",
     "@matrixai/logger": "^4.0.1",
-    "threads": "^1.7.0"
+    "threads": "^1.7.0",
+    "ts-node": "^10.9.1"
   },
   "devDependencies": {
     "@swc/core": "^1.3.76",

src/WorkerManager.ts

@@ -1,12 +1,15 @@
-import type { ModuleThread } from 'threads';
-import type { ModuleMethods } from 'threads/dist/types/master';
 import type WorkerManagerInterface from './WorkerManagerInterface.js';
-import type { QueuedTask } from 'threads/dist/master/pool-types';
-import { Pool } from 'threads';
+import type {
+  ModuleMethods,
+  ModuleThread,
+  QueuedTask,
+} from './types.js';
 import Logger from '@matrixai/logger';
 import { CreateDestroy, ready } from '@matrixai/async-init/CreateDestroy.js';
+import { Pool } from 'threads';
 import * as errors from './errors.js';
 
+
 @CreateDestroy()
 class WorkerManager<W extends ModuleMethods>
   implements WorkerManagerInterface<W>

src/WorkerManagerInterface.ts

@@ -1,6 +1,8 @@
-import type { ModuleThread } from 'threads';
-import type { ModuleMethods } from 'threads/dist/types/master';
-import type { QueuedTask } from 'threads/dist/master/pool-types';
+import type {
+  ModuleMethods,
+  ModuleThread,
+  QueuedTask,
+} from './types.js';
 
 interface WorkerManagerInterface<W extends ModuleMethods> {
   destroy(options?: { force?: boolean }): Promise<void>;

src/index.ts

@@ -3,4 +3,5 @@ export { default as workerModule } from './workerModule.js';
 export * as errors from './errors.js';
 
 export type { default as WorkerManagerInterface } from './WorkerManagerInterface.js';
-export type { WorkerModule } from './workerModule.js';
+// export type { WorkerModule } from './workerModule.js';
+export type { ModuleMethods, ModuleThread, QueuedTask } from './types.js';

src/worker.ts renamed to src/oldworker.ts

@@ -6,4 +6,4 @@ import worker from '../src/workerModule.js';
 
 expose(worker);
 
-export type { WorkerModule } from '../src/workerModule.js';
+export type { WorkerModule } from '../src/oldworkerModule.js';

src/workerModule.ts renamed to src/oldworkerModule.ts

@@ -0,0 +1,11 @@
+type ModuleMethods = {
+  [methodName: string]: (...args: any) => any;
+};
+type ModuleThread<Methods = any> = any;
+type QueuedTask<ThreadType, Return> = any;
+
+export type {
+  ModuleMethods,
+  ModuleThread,
+  QueuedTask
+};

src/types.ts

@@ -0,0 +1,6 @@
+// This is an example worker script
+
+import { expose } from 'threads/worker';
+import worker from '../src/workerModule.js';
+
+expose(worker);

src/worker.js

@@ -0,0 +1,47 @@
+// import { Transfer } from 'threads';
+// import { isWorkerRuntime } from 'threads';
+
+import * as threads from 'threads';
+
+const { Transfer, isWorkerRuntime } = threads;
+
+
+/**
+ * Worker object that contains all functions that will be executed in parallel
+ * Functions should be using CPU-parallelism not IO-parallelism
+ * Most functions should be synchronous, not asynchronous
+ * Making them asynchronous does not make a difference to the caller
+ * The caller must always await because the functions will run on the pool
+ */
+const worker = {
+  /**
+   * Check if we are running in the worker.
+   * Only used for testing
+   */
+  isRunningInWorker() {
+    return isWorkerRuntime();
+  },
+  /**
+   * Sleep synchronously
+   * This blocks the entire event loop
+   * Only used for testing
+   */
+  sleep(ms) {
+    Atomics.wait(new Int32Array(new SharedArrayBuffer(4)), 0, 0, ms);
+    return;
+  },
+  /**
+   * Zero copy demonstration manipulating buffers
+   */
+  transferBuffer(data) {
+    // Zero-copy wrap to use Node Buffer API
+    const buffer = Buffer.from(data);
+    // Set the last character to 2
+    buffer[buffer.byteLength - 1] = '2'.charCodeAt(0);
+    // Node Buffer cannot be detached
+    // so we transfer the ArrayBuffer instead
+    return Transfer(data);
+  },
+};
+
+export default worker;

src/workerModule.js

@@ -1,11 +1,13 @@
-import type { WorkerModule } from '#worker.js';
-import { spawn, Worker, Transfer } from 'threads';
+// import type { WorkerModule } from '#worker.js';
 import Logger, { LogLevel, StreamHandler } from '@matrixai/logger';
 import { destroyed } from '@matrixai/async-init';
 import * as testUtils from './utils.js';
+import { spawn, Worker, Transfer } from 'threads';
 import WorkerManager from '#WorkerManager.js';
 import * as errors from '#errors.js';
 
+type WorkerModule = any;
+
 describe('WorkerManager', () => {
   const logger = new Logger('WorkerManager Test', LogLevel.WARN, [
     new StreamHandler(),
@@ -70,7 +72,7 @@ describe('WorkerManager', () => {
     expect(
       await workerManager.call(async (w) => {
         mainPid2 = process.pid;
-        const process2 = require('process');
+        const process2 = await import('node:process');
         mainPid3 = process2.pid;
         return await w.isRunningInWorker();
       }),