multi-tasks 3.0.3 → 3.0.4

package/README.md

@@ -23,9 +23,9 @@ npm install multi-tasks
   - `taskRootFolder` — root directory where progress and result files are stored.
   - `taskId` — task folder name under `taskRootFolder`.
   - `taskFolder` — full task folder path, required by `restart`.
-  - `numberOfWorkers` — how many worker processes run in parallel.
+  - `numberOfWorkers` — how many worker processes run in parallel; also accepts a percentage string of CPU cores, e.g. `"50%"`.
   - `taskTimeout` — optional, milliseconds; an overdue task fails with a timeout error.
-  - `maxTaskRetries` — optional, max times a failed task is auto-retried (sent back to the queue immediately); covers worker crashes, exceptions/rejections from `processTask`, and `taskTimeout` timeouts; the retry count is kept in the task file as `__retryCount` — it survives `resume` and is reset by `restart`.
+  - `maxTaskRetries` — optional, max times a failed task is auto-retried.
   - `autoCloseAfterCompletion` — set `false` if you create new tasks dynamically.
   - `shouldTerminate(info)` — return `true` to terminate the whole process.
   - `onFinish(report)` — called once after all workers are done.
@@ -161,6 +161,7 @@ The usage patterns documented above are covered by automated tests (unit tests i
 
 ### Changelog:
 
+- 3.0.4 numberOfWorkers accepts a percentage string of CPU cores, e.g. "50%"
 - 3.0.3 Support 'maxTaskRetries'
 - 3.0.2 Support 'taskTimeout'
 - 3.0.1 Versions 3.0.0 and above are maintained by AI
@@ -199,3 +200,7 @@ The usage patterns documented above are covered by automated tests (unit tests i
 ### Gitee:
 
 [https://gitee.com/zhanglei923/multi-tasks](https://gitee.com/zhanglei923/multi-tasks)
+
+### License:
+
+[MIT](https://opensource.org/licenses/MIT) (see [LICENSE](LICENSE))

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "multi-tasks",
-  "version": "3.0.3",
+  "version": "3.0.4",
   "description": "Multi-process task scheduling based on Node.js cluster, with crash resume and failed-task restart support",
   "main": "index.js",
   "files": [

package/utils/resolveWorkers.js

@@ -0,0 +1,31 @@
+'use strict';
+
+const numCPUs = require('os').cpus().length;
+
+const PERCENT_PATTERN = /^(\d+(?:\.\d+)?)%$/;
+
+// 解析 numberOfWorkers 配置:
+// - undefined -> CPU 核数减 1(默认);
+// - number -> 原样返回(现状行为不变);
+// - string -> 必须是 "数字%" 形式且百分比在 1-100 之间, 按核数四舍五入折算, 最小为 1;
+// - 其余 -> 抛 Error。
+const resolveNumberOfWorkers = (value) => {
+  if (typeof value === 'undefined') {
+    return numCPUs - 1;
+  };
+  if (typeof value === 'number') {
+    return value;
+  };
+  if (typeof value === 'string') {
+    const match = value.trim().match(PERCENT_PATTERN);
+    if (match) {
+      const percent = parseFloat(match[1]);
+      if (percent >= 1 && percent <= 100) {
+        return Math.max(1, Math.round(numCPUs * percent / 100));
+      };
+    };
+  };
+  throw new Error(`Invalid numberOfWorkers: ${JSON.stringify(value)}. Expected a number or a percentage string like "50%" (1-100).`);
+};
+
+module.exports = { resolveNumberOfWorkers };

package/workers/Multithread.js

@@ -8,6 +8,7 @@ const asMaster = require('./asMaster');
 const TaskMgr = require('./TaskMgr');
 const WorkerMgr = require('./WorkerMgr');
 const helper = require('./helper');
+const { resolveNumberOfWorkers } = require('../utils/resolveWorkers');
 
 let fmtdigit = (n)=>{
     return n > 9 ? "" + n: "0" + n;
@@ -50,6 +51,7 @@ const start = (config)=>{
     if (isMaster) {//init
         console.log('[Master]: Start!!');
         let PID = process.pid;
+        config.numberOfWorkers = resolveNumberOfWorkers(config.numberOfWorkers);//支持百分比字符串; 须在 fork 循环读值前折算, 非法值在此抛错
         let numOfWorkers = config.numberOfWorkers;
         console.log(`  numCPUs=${numCPUs}`);
         console.log(`  numOfWorkers=${numOfWorkers}`);

package/workers/asMaster.js

@@ -1,9 +1,9 @@
 var fs = require('fs');
 var pathUtil = require('path');
-const numCPUs = require('os').cpus().length;
 
 const TaskMgr = require('./TaskMgr');
 const randomsUtil = require('../utils/randoms');
+const { resolveNumberOfWorkers } = require('../utils/resolveWorkers');
 
 const resume = (config)=>{
     config.__resume = true;
@@ -60,7 +60,7 @@ const init = (config)=>{
     if(!config.initialTasks){ throw new Error('Please provide initialTasks data!');  };
     if(!config.processTask){ throw new Error('Please provide processTask function!'); };
 
-    if(typeof config.numberOfWorkers === 'undefined') config.numberOfWorkers = numCPUs - 1;
+    config.numberOfWorkers = resolveNumberOfWorkers(config.numberOfWorkers);//支持百分比字符串, 非法值在此抛错(fail fast, 不建任务目录)
 
     let {taskRootFolder, taskName} = config;