satoru-render 1.0.11 → 1.0.13

package/dist/workers.js

@@ -9,8 +9,18 @@ export * from "./log-level.js";
  *                      Defaults to the bundled workers.js in the same directory.
  * @param params.maxParallel Maximum number of parallel workers
  */
+/**
+ * Create a Satoru worker proxy using worker-lib.
+ * @param params Initialization parameters
+ * @param params.worker Optional: Path to the worker file, a URL, or a factory function.
+ *                      Defaults to the bundled workers.js in the same directory.
+ * @param params.maxParallel Maximum number of parallel workers (default: 4)
+ * @param params.timeoutMs Optional: Default timeout in milliseconds for each render job.
+ *                         If a render job times out, the pool is reset to prevent hung workers.
+ * @param params.onWorkerLog Optional: Global callback to intercept logs emitted by the worker threads.
+ */
 export const createSatoruWorker = (params) => {
-    const { worker, maxParallel = 4 } = params ?? {};
+    const { worker, maxParallel = 4, timeoutMs, onWorkerLog } = params ?? {};
     const factory = () => {
         let w;
         if (worker) {
@@ -29,20 +39,109 @@ export const createSatoruWorker = (params) => {
         return w;
     };
     const workerInstance = createWorker(factory, maxParallel);
+    let totalPendingJobs = 0;
+    let completedJobs = 0;
+    let failedJobs = 0;
+    let totalJobTimeMs = 0;
+    /**
+     * Retrieve operational stats of the worker pool.
+     */
+    const getStats = () => ({
+        workerCount: maxParallel,
+        activeJobs: Math.min(totalPendingJobs, maxParallel),
+        queuedJobs: Math.max(0, totalPendingJobs - maxParallel),
+        completedJobs,
+        failedJobs,
+        avgJobTimeMs: completedJobs > 0 ? totalJobTimeMs / completedJobs : 0,
+    });
+    /**
+     * Reset the worker pool by terminating all running workers and recreating them.
+     * Useful to clear hung workers or reset statistics.
+     */
+    const reset = () => {
+        workerInstance.setLimit(0);
+        workerInstance.setLimit(maxParallel);
+        totalPendingJobs = 0;
+        completedJobs = 0;
+        failedJobs = 0;
+        totalJobTimeMs = 0;
+    };
     const proxy = new Proxy(workerInstance, {
         get(target, prop, receiver) {
+            if (prop === "getStats") {
+                return getStats;
+            }
+            if (prop === "reset") {
+                return reset;
+            }
             if (prop === "render") {
                 return async (options) => {
-                    return await target.execute("render", options);
+                    totalPendingJobs++;
+                    const startTime = Date.now();
+                    const jobTimeoutMs = options.limits?.timeoutMs ?? timeoutMs;
+                    // Merge the user's specific onLog callback with the global onWorkerLog callback
+                    const originalOnLog = options.onLog;
+                    const mergedOnLog = (level, message) => {
+                        if (originalOnLog) {
+                            originalOnLog(level, message);
+                        }
+                        if (onWorkerLog) {
+                            onWorkerLog(level, message);
+                        }
+                    };
+                    const mergedOptions = {
+                        ...options,
+                        onLog: mergedOnLog,
+                    };
+                    let timeoutId;
+                    let timeoutPromise;
+                    if (jobTimeoutMs !== undefined && jobTimeoutMs > 0) {
+                        timeoutPromise = new Promise((_, reject) => {
+                            timeoutId = setTimeout(() => {
+                                // If a job times out, terminate and recreate workers to recover from a potential hang
+                                reset();
+                                reject(new Error(`Render timed out after ${jobTimeoutMs}ms`));
+                            }, jobTimeoutMs);
+                        });
+                    }
+                    try {
+                        const executePromise = target.execute("render", mergedOptions);
+                        const result = await (timeoutPromise
+                            ? Promise.race([executePromise, timeoutPromise])
+                            : executePromise);
+                        completedJobs++;
+                        totalJobTimeMs += Date.now() - startTime;
+                        return result;
+                    }
+                    catch (e) {
+                        failedJobs++;
+                        throw e;
+                    }
+                    finally {
+                        if (timeoutId) {
+                            clearTimeout(timeoutId);
+                        }
+                        totalPendingJobs--;
+                    }
                 };
             }
             if (prop in target) {
                 return Reflect.get(target, prop, receiver);
             }
-            return (...args) => target.execute(prop, ...args);
+            return async (...args) => {
+                totalPendingJobs++;
+                try {
+                    return await target.execute(prop, ...args);
+                }
+                finally {
+                    totalPendingJobs--;
+                }
+            };
         },
     });
     return proxy;
 };
-const { close, render, launchWorker, setLimit, waitAll, waitReady } = createSatoruWorker({ maxParallel: 1 });
-export { close, render, launchWorker, setLimit, waitAll, waitReady };
+const defaultWorker = createSatoruWorker({ maxParallel: 1 });
+export const { close, render, launchWorker, setLimit, waitAll, waitReady } = defaultWorker;
+export const reset = () => defaultWorker.reset();
+export const getStats = () => defaultWorker.getStats();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "satoru-render",
-  "version": "1.0.11",
+  "version": "1.0.13",
   "description": "High-fidelity HTML/CSS to SVG/PNG/PDF converter running in WebAssembly",
   "type": "module",
   "main": "./dist/index.js",
@@ -8,10 +8,6 @@
   "bin": {
     "satoru-render": "./dist/cli.js"
   },
-  "scripts": {
-    "build": "tsc -b && rolldown -c rolldown.config.js",
-    "deploy": "npm publish"
-  },
   "exports": {
     ".": {
       "workerd": {
@@ -64,6 +60,10 @@
       "types": "./dist/tailwind.d.ts",
       "import": "./dist/tailwind.js"
     },
+    "./resources": {
+      "types": "./dist/resources.d.ts",
+      "import": "./dist/resources.js"
+    },
     "./jsdom": {
       "types": "./dist/jsdom.d.ts",
       "import": "./dist/jsdom.js"
@@ -86,6 +86,9 @@
       "tailwind": [
         "./dist/tailwind.d.ts"
       ],
+      "resources": [
+        "./dist/resources.d.ts"
+      ],
       "jsdom": [
         "./dist/jsdom.d.ts"
       ],
@@ -97,7 +100,8 @@
   "files": [
     "dist",
     "README.md",
-    "LICENSE"
+    "LICENSE",
+    "CHANGELOG.md"
   ],
   "repository": {
     "type": "git",
@@ -164,5 +168,9 @@
     "@unocss/preset-wind4": {
       "optional": true
     }
+  },
+  "scripts": {
+    "build": "tsc -b && rolldown -c rolldown.config.js",
+    "deploy": "npm publish"
   }
-}
+}