multi-tasks 1.1.4 → 1.2.0

package/README.md

@@ -9,6 +9,23 @@ npm install multi-tasks
 
 How to use:
 
+```javascript
+//see examples/example0
+let multiTasks = require('multi-tasks').multiTasks;
+multiTasks({
+    tasks: [...], //You need to provide an array containing all the subtasks you want to execute, multi-tasks will automatically split them and execute them in a multi-threaded manner
+    taskResolver:(task)=>{//You need to provide a taskResolver function to process a certain sub-task and return the result data
+        return Promise.resolve(data);
+    }, 
+    multi_task_parent_folder: `C:/tmp-demo`, //a directory to store progress and results files
+    quotaOfEachTask:2, //The number of tasks assigned to each worker
+    numberOfWorks: 6
+});
+
+```
+
+Or, to provide the Producer & Consumer
+
 ```javascript
 let master = require('multi-tasks').master;
 let RunnerProducer;//See examples, please provide a Producer class to specify all tasks you have, multi-tasks will automatically split them and execute them in a multi-threaded manner
@@ -24,12 +41,13 @@ master.start(RunnerProducer, RunnerConsumer, {
 Have a try:
 
 ```shell
-node example0/run
-node example1/run
+node examples/example0/run
+node examples/example1/run
 ```
 
 Changelog:
 
+- 1.2.0 Simplified usage by providing the function way and support return Promise
 - 1.1.4 Remove make-dir
 - 1.1.3 Simplified usage, see example0
 - 1.1.2 
@@ -37,4 +55,4 @@ Changelog:
 - 1.1.0 Simplified the usage of a customized Consumer, see example0
 - 1.0.8 Fix examples
 - 1.0.7 Remove moment
-- 1.0.6 Performance optimization
+- 1.0.6 Performance optimization

package/examples/example0/run.js

@@ -0,0 +1,26 @@
+let multiTasks = require('../../index').multiTasks;
+
+let alltasks = []
+for(let i=0;i<200;i++){
+    let task_props = {
+        index: i,
+        name: `task-${i}`,
+        description: `This prop is for a subtask`
+    };
+    alltasks.push(task_props);
+}
+
+let taskResolver = (actionData)=>{
+    console.log('this is the actionData of one task', actionData);
+    return Promise.resolve({
+        message: 'this is a result from a demo, random data=' + Math.random()
+    });
+}
+
+multiTasks({
+    tasks: alltasks, //You need to provide the data of all subtasks, multi-tasks will automatically split them and execute them in a multi-threaded manner
+    taskResolver, //You need to provide a taskResolver function to process a certain sub-task and return the result data
+    multi_task_parent_folder: `C:/tmp-demo`, //a directory to store progress and results files
+    quotaOfEachTask:2, //The number of tasks assigned to each worker
+    numberOfWorks: 6
+});

package/examples/example1/RunnerConsumer.js

@@ -0,0 +1,23 @@
+let SuperConsumer = require('../../index').SuperConsumer;
+
+class TestConsumer extends SuperConsumer {
+  
+    process(actionData){
+        console.log(`processing data:`, actionData);
+        //you can also return a data instead of a promise object
+        return new Promise((resolve) => {
+          setTimeout(() => {
+              let result = {
+                task:{            
+                  ...actionData,
+                },
+                result: {
+                  message: 'this is a result from a demo, random data=' + Math.random()
+                }
+              };
+              resolve(result);              
+          }, 100);
+      });
+    }
+  }
+module.exports = TestConsumer;

package/{example1 → examples/example1}/RunnerProducer.js

@@ -1,4 +1,4 @@
-let SuperProducer = require('../index').SuperProducer;
+let SuperProducer = require('../../index').SuperProducer;
 class TestProducer extends SuperProducer {
   
     // constructor

package/{example0 → examples/example1}/run.js

@@ -1,6 +1,6 @@
 let RunnerProducer = require('./RunnerProducer');//You need to provide a Producer to return all subtasks, multi-tasks will automatically split them and execute them in a multi-threaded manner
 let RunnerConsumer = require('./RunnerConsumer');//You need to provide a Consumer to process a certain sub-task and return the processed data
-let master = require('../index').master;
+let master = require('../../index').master;
 
 master.start(RunnerProducer, RunnerConsumer, {
     multi_task_parent_folder: `C:/tmp-demo`,

package/{example1 → examples/example2}/RunnerConsumer.js

@@ -1,4 +1,4 @@
-let SuperConsumer = require('../index').SuperConsumer;
+let SuperConsumer = require('../../index').SuperConsumer;
 
 
 let _do = (mainTaskInfo, actions, callback)=>{

package/{example0 → examples/example2}/RunnerProducer.js

@@ -1,4 +1,4 @@
-let SuperProducer = require('../index').SuperProducer;
+let SuperProducer = require('../../index').SuperProducer;
 class TestProducer extends SuperProducer {
   
     // constructor

package/{example1 → examples/example2}/run.js

@@ -6,7 +6,7 @@ let multi_task_parent_folder = `C:/tmp-demo`;
 
 let producer = new RunnerProducer(`workers_of_${taskId}`, multi_task_parent_folder)
 let consumer = new RunnerConsumer();
-let master = require('../index').master;
+let master = require('../../index').master;
 
 console.log(producer.getTaskName())
 //return;

package/index.js

@@ -1,8 +1,37 @@
 const SuperProducer = require('./workers/SuperProducer');
 const SuperConsumer = require('./workers/SuperConsumer');
-const master = require('./workers/master')
+const master = require('./workers/master');
+const multiTasks = (config)=>{
+    if(!config.tasks){
+        throw 'Please provide tasks data';
+    };
+    if(!config.taskResolver){
+        throw 'Please provide taskResolver function';
+    };
+    class TestProducer extends SuperProducer {      
+        // constructor
+        setTaskTrunkInfo(trunkInfo){
+            this.trunkInfo = trunkInfo;
+        }
+        getAllActions() {
+            return Promise.resolve(config.tasks);//return all your tasks as an array
+        }
+    }
+    class TestConsumer extends SuperConsumer {  
+        process(taskInfo, actionData){
+            console.log(`processing data:`, taskInfo, actionData);
+            let result = config.taskResolver(actionData);
+            return Promise.resolve(result);
+        }
+    }
+
+    master.start(TestProducer, TestConsumer, {
+        ...config
+    });
+};
 module.exports = {
     SuperProducer,
     SuperConsumer,
-    master
+    master,
+    multiTasks
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "multi-tasks",
-  "version": "1.1.4",
+  "version": "1.2.0",
   "description": "",
   "main": "index.js",
   "directories": {

package/workers/SuperConsumer.js

@@ -25,13 +25,19 @@ class SuperConsumer {
         let actionData = actions.shift();
     
         if(this.process){
-            let result = this.process(taskInfo, actionData);//rewrite this method in subclass
-            if(result){
-                results.push(result);
+            let result = this.process(actionData);//rewrite this method in subclass
+            if(typeof result === 'undefined') result = {};
+            let ispromise = result instanceof Promise;
+            if(! ispromise){
+                result = Promise.resolve(result);
             }
-        }
-    
-        this._run(mainTaskInfo, subTaskInfo, actions, results, callback);
+            result.then((data)=>{
+                results.push(data);
+                this._run(mainTaskInfo, subTaskInfo, actions, results, callback);
+            });            
+        }else{
+            this._run(mainTaskInfo, subTaskInfo, actions, results, callback);
+        }    
     };
     run (mainTaskInfo, subTaskInfo, taskInfo, callback){
         let results = [];

package/example0/RunnerConsumer.js

@@ -1,18 +0,0 @@
-let SuperConsumer = require('../index').SuperConsumer;
-
-class TestConsumer extends SuperConsumer {
-  
-    process(taskInfo, actionData){
-        console.log(`processing data:`, taskInfo, actionData);
-        return {
-          task:{            
-            ...taskInfo, 
-            ...actionData,
-          },
-          result: {
-            message: 'this is a result from a demo, random data=' + Math.random()
-          }
-        }
-    }
-  }
-module.exports = TestConsumer;