code review

Author: avivkeller

src/generators.mjs

@@ -1,7 +1,7 @@
 'use strict';
 
 import { allGenerators } from './generators/index.mjs';
-import { WorkerPool } from './threading.mjs';
+import WorkerPool from './threading/index.mjs';
 
 /**
  * @typedef {{ ast: GeneratorMetadata<ApiDocMetadataEntry, ApiDocMetadataEntry>}} AstGenerator The AST "generator" is a facade for the AST tree and it isn't really a generator
@@ -46,11 +46,7 @@ const createGenerator = markdownInput => {
     // but it ensures all dependencies are resolved, and that multiple bottom-level generators
     // can reuse the already parsed content from the top-level/dependency generators
     for (const generatorName of generators) {
-      const {
-        dependsOn,
-        generate,
-        parallizable = true,
-      } = allGenerators[generatorName];
+      const { dependsOn, generate } = allGenerators[generatorName];
 
       // If the generator dependency has not yet been resolved, we resolve
       // the dependency first before running the current generator
@@ -68,7 +64,7 @@ const createGenerator = markdownInput => {
 
       // Adds the current generator execution Promise to the cache
       cachedGenerators[generatorName] =
-        threads < 2 || !parallizable
+        threads < 2
           ? generate(dependencyOutput, extra) // Run in main thread
           : threadPool.run(generatorName, dependencyOutput, threads, extra); // Offload to worker thread
     }

src/threading.mjs src/threading/index.mjssrc/threading.mjs renamed to src/threading/index.mjs

@@ -1,27 +1,9 @@
-import {
-  Worker,
-  isMainThread,
-  parentPort,
-  workerData,
-} from 'node:worker_threads';
-import { allGenerators } from './generators/index.mjs';
-
-// If inside a worker thread, perform the generator logic here
-if (!isMainThread) {
-  const { name, dependencyOutput, extra } = workerData;
-  const generator = allGenerators[name];
-
-  // Execute the generator and send the result or error back to the parent thread
-  generator
-    .generate(dependencyOutput, extra)
-    .then(result => parentPort.postMessage(result))
-    .catch(error => parentPort.postMessage({ error }));
-}
+import { Worker } from 'node:worker_threads';
 
 /**
  * WorkerPool class to manage a pool of worker threads
  */
-export class WorkerPool {
+export default class WorkerPool {
   /** @private {number} - Number of active threads */
   activeThreads = 0;
   /** @private {Array<Function>} - Queue of pending tasks */
@@ -44,20 +26,19 @@ export class WorkerPool {
         this.activeThreads++;
 
         // Create and start the worker thread
-        const worker = new Worker(new URL(import.meta.url), {
-          workerData: { name, dependencyOutput, extra },
-        });
+        const worker = new Worker(
+          new URL(import.meta.resolve('./worker.mjs')),
+          {
+            workerData: { name, dependencyOutput, extra },
+          }
+        );
 
         // Handle worker thread messages (result or error)
         worker.on('message', result => {
           this.activeThreads--;
           this.processQueue(threads);
 
-          if (result?.error) {
-            reject(result.error);
-          } else {
-            resolve(result);
-          }
+          (result?.error ? reject : resolve)(result);
         });
 
         // Handle worker thread errors

src/threading/worker.mjs

@@ -0,0 +1,11 @@
+import { parentPort, workerData } from 'node:worker_threads';
+import { allGenerators } from '../generators/index.mjs';
+
+const { name, dependencyOutput, extra } = workerData;
+const generator = allGenerators[name];
+
+// Execute the generator and send the result or error back to the parent thread
+generator
+  .generate(dependencyOutput, extra)
+  .then(result => parentPort.postMessage(result))
+  .catch(error => parentPort.postMessage({ error }));