multi-tasks 1.1.2 → 1.1.3

package/README.md

@@ -7,14 +7,31 @@ Install:
 npm install multi-tasks
 ```
 
+How to use:
+
+```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
+let RunnerConsumer;//See examples, please provide a Consumer class to process a certain sub-task and return the processed data
+
+master.start(RunnerProducer, RunnerConsumer, {
+    multi_task_parent_folder: `C:/tmp-demo`,
+    quotaOfEachTask:2, //The number of tasks assigned to each worker
+    numberOfWorks: 6
+});
+```
+
 Have a try:
 
 ```shell
-node example/run
+node example0/run
+node example1/run
 ```
 
 Changelog:
 
+- 1.1.3 Simplified usage, see example0
+- 1.1.2 
 - 1.1.1 Rename files, updated changelog
 - 1.1.0 Simplified the usage of a customized Consumer, see example0
 - 1.0.8 Fix examples

package/example0/RunnerConsumer.js

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

package/example0/RunnerProducer.js

@@ -24,7 +24,7 @@ class TestProducer extends SuperProducer {
                 let task_props = {
                     index: i,
                     name: `task-${i}`,
-                    description: `This is a subtask's prop`
+                    description: `This prop is for a subtask`
                 };
                 alltasks.push(task_props);
             }

package/example0/run.js

@@ -1,23 +1,9 @@
-let RunnerProducer = require('./RunnerProducer');//switch to require from node_modules in your project
-let RunnerConsumer = require('./RunnerConsumer');//switch to require from node_modules in your project
-
-let taskId = Math.random()+'';
-let multi_task_parent_folder = `C:/tmp-demo`;
-
-let producer = new RunnerProducer(`workers_of_${taskId}`, multi_task_parent_folder)
-let consumer = new RunnerConsumer();
+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;
 
-console.log(producer.getTaskName())
-//return;
-
-let taskConfig = {
-    multi_task_parent_folder
-}
-//console.log(resp)
-producer.setTaskTrunkInfo(taskConfig);
-consumer.setTaskTrunkInfo(taskConfig)
-master.run(producer, consumer, {
-    quotaOfEachTask:2,
+master.start(RunnerProducer, RunnerConsumer, {
+    multi_task_parent_folder: `C:/tmp-demo`,
+    quotaOfEachTask:2, //The number of tasks assigned to each worker
     numberOfWorks: 6
 });

package/example1/RunnerConsumer.js

@@ -2,15 +2,18 @@ let SuperConsumer = require('../index').SuperConsumer;
 
 
 let _do = (mainTaskInfo, actions, callback)=>{
-    if(actions.length === 0) return callback({data:'hahaha'+Math.random()});
-    let action = actions.shift();
+    if(actions.length === 0) return callback({
+        data:'subtask finished, random data='+Math.random()
+    });
+    let actionData = actions.shift();
 
     //start to write your process code here
 
-    console.log('action', action)
+    console.log('actionData', actionData)
 
     //end of your process code.
 
+    //trigger next task
     _do(mainTaskInfo, actions, callback);
 };
 

package/example1/RunnerProducer.js

@@ -24,7 +24,7 @@ class TestProducer extends SuperProducer {
                 let task_props = {
                     index: i,
                     name: `task-${i}`,
-                    description: `This is a subtask's prop`
+                    description: `This prop is for a subtask`
                 };
                 alltasks.push(task_props);
             }

package/package.json

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

package/workers/SuperConsumer.js

@@ -12,10 +12,11 @@ class SuperConsumer {
     setTaskTrunkInfo(trunkInfo){
         this.trunkInfo = trunkInfo;
     }
-    _run (mainTaskInfo, actions, callback){
+    _run (mainTaskInfo, subTaskInfo, actions, results, callback){
         if(actions.length === 0) return callback({
                                             finishedAt: new Date()*1,
-                                            results:this.results
+                                            results,
+                                            subTaskInfo
                                         });
         let taskInfo = {
             mainid: this.mainid,
@@ -26,16 +27,17 @@ class SuperConsumer {
         if(this.process){
             let result = this.process(taskInfo, actionData);//rewrite this method in subclass
             if(result){
-                this.results.push(result);
+                results.push(result);
             }
         }
     
-        this._run(mainTaskInfo, actions, callback);
+        this._run(mainTaskInfo, subTaskInfo, actions, results, callback);
     };
     run (mainTaskInfo, subTaskInfo, taskInfo, callback){
+        let results = [];
         let actions = subTaskInfo.actions;
         mainTaskInfo.defination = this.trunkInfo.defination;
-        this._run(mainTaskInfo, actions, (result)=>{
+        this._run(mainTaskInfo, subTaskInfo, actions, results, (result)=>{
             callback(result)
         })
 

package/workers/master.js

@@ -3,7 +3,6 @@ var pathutil = require('path');
 const cluster = require('cluster');
 const numCPUs = require('os').cpus().length;
 
-
 let MSG_REQUEST_TASKID = 'request_taskid';
 /**
  * masterId, the id of scanning flow
@@ -141,7 +140,26 @@ let run = (currentProducer, currentConsumer, opt)=>{
       worker.send(MSG_REQUEST_TASKID);//request new task
 
     }
+};
+let start = (ProducerClass, ConsumerClass, taskConfig)=>{  
+  let taskId = Math.random()+'';
+  let {multi_task_parent_folder} = taskConfig;
+  
+  let producer = new ProducerClass(`workers_of_${taskId}`, multi_task_parent_folder)
+  let consumer = new ConsumerClass();
+
+  console.log(producer.getTaskName())
+  //return;
+
+  //console.log(resp)
+  producer.setTaskTrunkInfo(taskConfig);
+  consumer.setTaskTrunkInfo(taskConfig);
+  run(producer, consumer, {
+      quotaOfEachTask:2,
+      numberOfWorks: 6
+  });
 }
 module.exports = {
-  run
+  run,
+  start
 };