2.1.17

.gitignore

@@ -15,8 +15,6 @@ node_modules/
 
 # builds
 dist/
-dist_web/
-dist_serve/
-dist_ts_web/
+dist_*/
 
 # custom

.gitlab-ci.yml

@@ -3,14 +3,17 @@ image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
-  - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+    - .npmci_cache/
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
-- test
-- release
-- metadata
+  - security
+  - test
+  - release
+  - metadata
+
+before_script:
+  - npm install -g @shipzone/npmci
 
 # ====================
 # security stage
@@ -18,21 +21,37 @@ stages:
 mirror:
   stage: security
   script:
-  - npmci git mirror
+    - npmci git mirror
+  only:
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
-snyk:
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
     - npmci npm prepare
-    - npmci command npm install -g snyk
-    - npmci command npm install --ignore-scripts
-    - npmci command snyk test
+    - npmci command npm install --production --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high --only=prod --production
   tags:
-  - docker
-  - notpriv
+    - docker
+  allow_failure: true
+
+auditDevDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  stage: security
+  script:
+    - npmci npm prepare
+    - npmci command npm install --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high --only=dev
+  tags:
+    - docker
+  allow_failure: true
 
 # ====================
 # test stage
@@ -41,37 +60,36 @@ snyk:
 testStable:
   stage: test
   script:
-  - npmci npm prepare
-  - npmci node install stable
-  - npmci npm install
-  - npmci npm test
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
-  - priv
+    - docker
 
 testBuild:
   stage: test
   script:
-  - npmci npm prepare
-  - npmci node install lts
-  - npmci npm install
-  - npmci command npm run build
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
-  - notpriv
+    - docker
 
 release:
   stage: release
   script:
-  - npmci node install lts
-  - npmci npm publish
+    - npmci node install stable
+    - npmci npm publish
   only:
-  - tags
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 # ====================
 # metadata stage
@@ -79,35 +97,39 @@ release:
 codequality:
   stage: metadata
   allow_failure: true
+  only:
+    - tags
   script:
     - npmci command npm install -g tslint typescript
+    - npmci npm prepare
     - npmci npm install
     - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
-  - docker
-  - priv
+    - lossless
+    - docker
+    - priv
 
 trigger:
   stage: metadata
   script:
-  - npmci trigger
+    - npmci trigger
   only:
-  - tags
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 pages:
-  image: hosttoday/ht-docker-dbase:npmci
-  services:
-   - docker:stable-dind
   stage: metadata
   script:
+    - npmci node install lts
     - npmci command npm install -g @gitzone/tsdoc
     - npmci npm prepare
     - npmci npm install
     - npmci command tsdoc
   tags:
+    - lossless
     - docker
     - notpriv
   only:
@@ -115,5 +137,5 @@ pages:
   artifacts:
     expire_in: 1 week
     paths:
-    - public
+      - public
   allow_failure: true

.vscode/launch.json

@@ -0,0 +1,11 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "command": "npm test",
+      "name": "Run npm test",
+      "request": "launch",
+      "type": "node-terminal"
+    }
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,26 @@
+{
+  "json.schemas": [
+    {
+      "fileMatch": ["/npmextra.json"],
+      "schema": {
+        "type": "object",
+        "properties": {
+          "npmci": {
+            "type": "object",
+            "description": "settings for npmci"
+          },
+          "gitzone": {
+            "type": "object",
+            "description": "settings for gitzone",
+            "properties": {
+              "projectType": {
+                "type": "string",
+                "enum": ["website", "element", "service", "npm", "wcc"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

npmextra.json

@@ -5,6 +5,7 @@
     "npmRegistryUrl": "registry.npmjs.org"
   },
   "gitzone": {
+    "projectType": "npm",
     "module": {
       "githost": "gitlab.com",
       "gitscope": "pushrocks",

package.json

@@ -1,13 +1,13 @@
 {
   "name": "@pushrocks/taskbuffer",
-  "version": "2.0.14",
+  "version": "2.1.17",
   "private": false,
   "description": "flexible task management. TypeScript ready!",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
   "scripts": {
-    "test": "(tstest test/)",
-    "build": "(tsbuild)"
+    "test": "(tstest test/ --web)",
+    "build": "(tsbuild --web && tsbundle npm)"
   },
   "repository": {
     "type": "git",
@@ -27,31 +27,36 @@
   },
   "homepage": "https://gitlab.com/pushrocks/taskbuffer#readme",
   "dependencies": {
-    "@pushrocks/lik": "^3.0.11",
-    "@pushrocks/smartdelay": "^2.0.3",
-    "@pushrocks/smartlog": "^2.0.19",
-    "@pushrocks/smartpromise": "^3.0.5",
-    "@types/cron": "^1.7.1",
-    "cron": "^1.7.2",
-    "rxjs": "^6.5.3"
+    "@pushrocks/lik": "^5.0.0",
+    "@pushrocks/smartdelay": "^2.0.13",
+    "@pushrocks/smartlog": "^2.0.44",
+    "@pushrocks/smartpromise": "^3.1.6",
+    "@pushrocks/smartrx": "^2.0.19",
+    "@pushrocks/smarttime": "^3.0.43",
+    "@types/cron": "^1.7.3"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.17",
-    "@gitzone/tstest": "^1.0.24",
-    "@pushrocks/tapbundle": "^3.0.13",
-    "@types/node": "^12.7.5",
-    "tslint": "^5.20.0",
+    "@gitzone/tsbuild": "^2.1.28",
+    "@gitzone/tsbundle": "^1.0.88",
+    "@gitzone/tstest": "^1.0.60",
+    "@pushrocks/tapbundle": "^3.2.14",
+    "@types/node": "^16.11.7",
+    "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0"
   },
   "files": [
-    "ts/*",
-    "ts_web/*",
-    "dist/*",
-    "dist_web/*",
-    "dist_ts_web/*",
-    "assets/*",
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
     "cli.js",
     "npmextra.json",
     "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
   ]
 }

readme.md

@@ -8,13 +8,20 @@ flexible task management. TypeScript ready!
 * [docs (typedoc)](https://pushrocks.gitlab.io/taskbuffer/)
 
 ## Status for master
-[![build status](https://gitlab.com/pushrocks/taskbuffer/badges/master/build.svg)](https://gitlab.com/pushrocks/taskbuffer/commits/master)
-[![coverage report](https://gitlab.com/pushrocks/taskbuffer/badges/master/coverage.svg)](https://gitlab.com/pushrocks/taskbuffer/commits/master)
-[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/taskbuffer.svg)](https://www.npmjs.com/package/@pushrocks/taskbuffer)
-[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/taskbuffer/badge.svg)](https://snyk.io/test/npm/@pushrocks/taskbuffer)
-[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
+
+Status Category | Status Badge
+-- | --
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/taskbuffer/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/taskbuffer/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/taskbuffer)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/taskbuffer)](https://lossless.cloud)
+TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
+node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
+PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@pushrocks/taskbuffer)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/taskbuffer)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/taskbuffer)](https://lossless.cloud)
+Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
 
 ## Usage
 
@@ -44,6 +51,10 @@ For further information read the linked docs at the top of this README.
 
 [![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks)
 
+## Contribution
+
+We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
+
 For further information read the linked docs at the top of this readme.
 
 > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)

test/test.1.task.ts

@@ -11,7 +11,7 @@ let testPreTask = new taskbuffer.Task({
   taskFunction: async () => {
     console.log('preTask executed');
   },
-  preTask: testTask
+  preTask: testTask,
 });
 
 // some more tasks to test with
@@ -27,7 +27,7 @@ let task1 = new taskbuffer.Task({
       done.resolve();
     }, 5000);
     return done.promise;
-  }
+  },
 });
 
 let task2 = new taskbuffer.Task({
@@ -40,7 +40,7 @@ let task2 = new taskbuffer.Task({
       done.resolve();
     }, 5000);
     await done.promise;
-  }
+  },
 });
 
 let task3 = new taskbuffer.Task({
@@ -53,7 +53,7 @@ let task3 = new taskbuffer.Task({
       done.resolve();
     }, 5000);
     return done.promise;
-  }
+  },
 });
 
 tap.test('new Task() should return a new task', async () => {
@@ -61,7 +61,7 @@ tap.test('new Task() should return a new task', async () => {
     taskFunction: async () => {
       console.log('executed twice');
     },
-    preTask: testPreTask
+    preTask: testPreTask,
   });
 });
 
@@ -93,7 +93,7 @@ tap.test('expect to run a task without pre and afterTask errorless', async () =>
   let localTestTask = new taskbuffer.Task({
     taskFunction: async () => {
       console.log('only once');
-    }
+    },
   });
   await localTestTask.trigger();
 });
@@ -104,7 +104,7 @@ tap.test('expect task to run in buffered mode', async () => {
       await smartdelay.delayFor(3000);
     },
     buffered: true,
-    bufferMax: 2
+    bufferMax: 2,
   });
   localTestTask.trigger();
   localTestTask.trigger();

test/test.2.taskchain.ts

@@ -9,7 +9,7 @@ const task1 = new taskbuffer.Task({
   taskFunction: async () => {
     await smartdelay.delayFor(2000);
     task1Executed = true;
-  }
+  },
 });
 
 let task2Executed = false;
@@ -17,7 +17,7 @@ const task2 = new taskbuffer.Task({
   taskFunction: async () => {
     await smartdelay.delayFor(2000);
     task2Executed = true;
-  }
+  },
 });
 
 let task3Executed = false;
@@ -25,13 +25,13 @@ const task3 = new taskbuffer.Task({
   taskFunction: async () => {
     await smartdelay.delayFor(2000);
     task3Executed = true;
-  }
+  },
 });
 
 tap.test('expect run tasks in sequence', async () => {
   const testTaskchain = new taskbuffer.Taskchain({
     name: 'Taskchain1',
-    taskArray: [task1, task2, task3]
+    taskArray: [task1, task2, task3],
   });
   const testPromise = testTaskchain.trigger();
   await smartdelay.delayFor(2100);

test/test.3.taskparallel.ts

@@ -7,7 +7,7 @@ const task1 = new taskbuffer.Task({
   taskFunction: async () => {
     await smartdelay.delayFor(2000);
     task1Executed = true;
-  }
+  },
 });
 
 let task2Executed = false;
@@ -15,7 +15,7 @@ const task2 = new taskbuffer.Task({
   taskFunction: async () => {
     await smartdelay.delayFor(2000);
     task2Executed = true;
-  }
+  },
 });
 
 let task3Executed = false;
@@ -23,12 +23,12 @@ const task3 = new taskbuffer.Task({
   taskFunction: async () => {
     await smartdelay.delayFor(2000);
     task3Executed = true;
-  }
+  },
 });
 
 tap.test('expect run in Parallel', async () => {
   const testTaskparallel = new taskbuffer.Taskparallel({
-    taskArray: [task1, task2, task3]
+    taskArray: [task1, task2, task3],
   });
   await testTaskparallel.trigger();
 });

test/test.4.taskmanager.both.ts

@@ -18,25 +18,32 @@ tap.test('should run the task as expected', async () => {
   myTaskManager.addTask(
     new taskbuffer.Task({
       name: 'myTask',
+      bufferMax: 1,
+      buffered: true,
       taskFunction: async () => {
-        console.log('Task executed!');
+        console.log('Task "myTask" executed!');
         referenceBoolean = true;
         taskRunCounter++;
         if (taskRunCounter === 10) {
           taskDone.resolve();
         }
-      }
+      },
     })
   );
+  myTaskManager.start();
   await myTaskManager.triggerTaskByName('myTask');
   // tslint:disable-next-line:no-unused-expression
   expect(referenceBoolean).to.be.true;
 });
 
 tap.test('should schedule task', async () => {
-  myTaskManager.scheduleTaskByName('myTask', '* * * * * *');
+  myTaskManager.scheduleTaskByName('myTask', '*/10 * * * * *');
   await taskDone.promise;
   myTaskManager.descheduleTaskByName('myTask');
 });
 
+tap.test('should stop the taskmanager', async () => {
+  myTaskManager.stop();
+});
+
 tap.start();

test/test.5.task.paramflow.ts

@@ -11,7 +11,7 @@ const flowTask1 = new taskbuffer.Task({
     console.log(x);
     done.resolve(x);
     return done.promise;
-  }
+  },
 });
 
 const flowTaskBuffered = new taskbuffer.Task({
@@ -23,7 +23,7 @@ const flowTaskBuffered = new taskbuffer.Task({
     return done.promise;
   },
   buffered: true,
-  bufferMax: 1
+  bufferMax: 1,
 });
 
 const flowTask2 = new taskbuffer.Task({
@@ -34,11 +34,11 @@ const flowTask2 = new taskbuffer.Task({
     done.resolve(x);
     return done.promise;
   },
-  preTask: flowTask1
+  preTask: flowTask1,
 });
 
 const flowTask3 = new taskbuffer.Taskchain({
-  taskArray: [flowTask1, flowTask2]
+  taskArray: [flowTask1, flowTask2],
 });
 
 tap.test('should let a value flow through a task', async () => {

test/test.6.taskonce.ts

@@ -9,7 +9,7 @@ tap.test('should create a valid instance of TaskOnce', async () => {
   myTaskOnce = new taskbuffer.TaskOnce({
     taskFunction: async () => {
       myNumber++;
-    }
+    },
   });
   expect(myTaskOnce).to.be.instanceof(taskbuffer.TaskOnce);
 });

test/test.7.taskloop.ts

@@ -1,6 +1,6 @@
 import { tap, expect } from '@pushrocks/tapbundle';
 
-import * as taskbuffer from  '../ts';
+import * as taskbuffer from '../ts';
 
 let preTask: taskbuffer.Task;
 let afterTask: taskbuffer.Task;
@@ -13,7 +13,7 @@ tap.test('should create tasks', async () => {
     taskFunction: async () => {
       console.log('pretask executed :)');
       return 'hi';
-    }
+    },
   });
   afterTask = new taskbuffer.Task({
     name: 'myAfterTask',
@@ -25,7 +25,7 @@ tap.test('should create tasks', async () => {
       return x;
     },
     preTask,
-    afterTask
+    afterTask,
   });
 
   mainTask = new taskbuffer.Task({
@@ -37,13 +37,15 @@ tap.test('should create tasks', async () => {
       console.log('afterTask executed :)');
       return x;
     },
-    preTask,
-    afterTask
+    preTask: () => {
+      return preTask;
+    },
+    afterTask,
   });
 });
 
-tap.test('should execute the mainTasj', async () => {
+tap.test('should execute the mainTask', async () => {
   await mainTask.trigger();
 });
 
-tap.start();
+tap.start();

test/test.8.bufferedrun.ts

@@ -0,0 +1,52 @@
+import { tap, expect } from '@pushrocks/tapbundle';
+
+import * as taskbuffer from '../ts';
+
+let counter1 = 0;
+let counter2 = 0;
+let counter3 = 0;
+
+tap.test('should run buffered', async (tools) => {
+  const task = new taskbuffer.Task({
+    name: 'a buffered task',
+    taskFunction: async () => {
+      counter1++;
+      await tools.delayFor(2000);
+      console.log(`task 1 ran ${counter1} times`);
+    },
+    buffered: true,
+    bufferMax: 1,
+    afterTask: () => {
+      return task2;
+    },
+  });
+  const task2 = new taskbuffer.Task({
+    name: 'a buffered task',
+    taskFunction: async () => {
+      counter2++;
+      await tools.delayFor(2000);
+      console.log(`task2 ran ${counter2} times`);
+    },
+    buffered: true,
+    bufferMax: 1,
+    afterTask: () => {
+      return task3;
+    },
+  });
+  const task3 = new taskbuffer.Task({
+    name: 'a buffered task',
+    taskFunction: async () => {
+      counter3++;
+      await tools.delayFor(2000);
+      console.log(`task3 ran ${counter3} times`);
+    },
+    buffered: true,
+    bufferMax: 1,
+  });
+  while (counter1 < 10) {
+    await tools.delayFor(5000);
+    task.trigger();
+  }
+});
+
+tap.start();

test/test.taskrunner.ts

@@ -0,0 +1,33 @@
+import { tap, expect } from '@pushrocks/tapbundle';
+import * as taskbuffer from '../ts/index';
+
+let testTaskRunner: taskbuffer.TaskRunner;
+
+tap.test('should create a valid taskrunner', async () => {
+  testTaskRunner = new taskbuffer.TaskRunner();
+  await testTaskRunner.start();
+});
+
+tap.test('should execute task when its scheduled', async (tools) => {
+  const done = tools.defer();
+  testTaskRunner.addTask(
+    new taskbuffer.Task({
+      taskFunction: async () => {
+        console.log('hi');
+      },
+    })
+  );
+
+  testTaskRunner.addTask(
+    new taskbuffer.Task({
+      taskFunction: async () => {
+        console.log('there');
+        done.resolve();
+      },
+    })
+  );
+
+  await done.promise;
+});
+
+tap.start();

ts/index.ts

@@ -3,6 +3,5 @@ export { Taskchain } from './taskbuffer.classes.taskchain';
 export { Taskparallel } from './taskbuffer.classes.taskparallel';
 export { TaskManager } from './taskbuffer.classes.taskmanager';
 export { TaskOnce } from './taskbuffer.classes.taskonce';
-
-// import for naming only
-import './taskbuffer.classes.helpers';
+export { TaskRunner } from './taskbuffer.classes.taskrunner';
+export { TaskDebounced } from './taskbuffer.classes.taskdebounced';

ts/taskbuffer.classes.bufferrunner.ts

@@ -0,0 +1,39 @@
+import { Task } from './taskbuffer.classes.task';
+
+export class BufferRunner {
+  public task: Task;
+  // initialze by default
+  public bufferCounter: number = 0;
+  constructor(taskArg: Task) {
+    this.task = taskArg;
+  }
+
+  public trigger(x: any): Promise<any> {
+    if (!(this.bufferCounter >= this.task.bufferMax)) {
+      this.bufferCounter++;
+    }
+    const returnPromise: Promise<any> = this.task.cycleCounter.getPromiseForCycle(
+      this.bufferCounter + 1
+    );
+    if (!this.task.running) {
+      this._run(x);
+    }
+    return returnPromise;
+  }
+
+  private _run(x: any) {
+    const recursiveBufferRunner = (x: any) => {
+      if (this.bufferCounter >= 0) {
+        this.task.running = true;
+        Task.runTask(this.task, { x: x }).then((x) => {
+          this.bufferCounter--; // this.bufferCounter drops below 0, the recursion stops.
+          this.task.cycleCounter.informOfCycle(x);
+          recursiveBufferRunner(x);
+        });
+      } else {
+        this.task.running = false;
+      }
+    };
+    recursiveBufferRunner(x);
+  }
+}

ts/taskbuffer.classes.cyclecounter.ts

@@ -0,0 +1,36 @@
+import * as plugins from './taskbuffer.plugins';
+import { Task } from './taskbuffer.classes.task';
+
+export interface ICycleObject {
+  cycleCounter: number;
+  deferred: plugins.smartpromise.Deferred<any>;
+}
+
+export class CycleCounter {
+  public task: Task;
+  public cycleObjectArray: ICycleObject[] = [];
+  constructor(taskArg: Task) {
+    this.task = taskArg;
+  }
+  public getPromiseForCycle(cycleCountArg: number) {
+    const done = plugins.smartpromise.defer();
+    const cycleObject: ICycleObject = {
+      cycleCounter: cycleCountArg,
+      deferred: done,
+    };
+    this.cycleObjectArray.push(cycleObject);
+    return done.promise;
+  }
+  public informOfCycle(x: any) {
+    const newCycleObjectArray: ICycleObject[] = [];
+    this.cycleObjectArray.forEach((cycleObjectArg) => {
+      cycleObjectArg.cycleCounter--;
+      if (cycleObjectArg.cycleCounter <= 0) {
+        cycleObjectArg.deferred.resolve(x);
+      } else {
+        newCycleObjectArray.push(cycleObjectArg);
+      }
+    });
+    this.cycleObjectArray = newCycleObjectArray;
+  }
+}

ts/taskbuffer.classes.helpers.ts

@@ -1,166 +0,0 @@
-import plugins = require('./taskbuffer.plugins');
-import { Task, ITaskFunction } from './taskbuffer.classes.task';
-
-export const emptyTaskFunction: ITaskFunction = function(x) {
-  const done = plugins.smartpromise.defer();
-  done.resolve();
-  return done.promise;
-};
-
-export const isTask = (taskArg: Task): boolean => {
-  if (taskArg instanceof Task && typeof taskArg.taskFunction === 'function') {
-    return true;
-  } else {
-    return false;
-  }
-};
-
-export const isTaskTouched = (taskArg: Task, touchedTasksArray: Task[]): boolean => {
-  let result = false;
-  for (const keyArg in touchedTasksArray) {
-    if (taskArg === touchedTasksArray[keyArg]) {
-      result = true;
-    }
-  }
-  return result;
-};
-
-export const runTask = async (taskArg: Task, optionsArg: { x?; touchedTasksArray?: Task[] }) => {
-  const done = plugins.smartpromise.defer();
-
-  // pay respect to execDelay
-  if (taskArg.execDelay) {
-    await plugins.smartdelay.delayFor(taskArg.execDelay);
-  }
-
-  //  set running params
-  taskArg.running = true;
-
-  done.promise.then(async () => {
-    taskArg.running = false;
-  });
-
-  // handle options
-  const options = {
-    ...{ x: undefined, touchedTasksArray: [] },
-    ...optionsArg
-  };
-  const x = options.x;
-  const touchedTasksArray: Task[] = options.touchedTasksArray;
-
-  touchedTasksArray.push(taskArg);
-
-  // run the task cascade
-  const localDeferred = plugins.smartpromise.defer();
-  localDeferred.promise
-    .then(() => {
-      // lets run any preTask
-      if (taskArg.preTask && !isTaskTouched(taskArg.preTask, touchedTasksArray)) {
-        return runTask(taskArg.preTask, { x, touchedTasksArray });
-      } else {
-        const done2 = plugins.smartpromise.defer();
-        done2.resolve(x);
-        return done2.promise;
-      }
-    })
-    .then(async x => {
-      // lets run the main task
-      try {
-        return await taskArg.taskFunction(x);
-      } catch (e) {
-        console.log(e);
-      }
-    })
-    .then(x => {
-      if (taskArg.afterTask && !isTaskTouched(taskArg.afterTask, touchedTasksArray)) {
-        return runTask(taskArg.afterTask, { x: x, touchedTasksArray: touchedTasksArray });
-      } else {
-        const done2 = plugins.smartpromise.defer();
-        done2.resolve(x);
-        return done2.promise;
-      }
-    })
-    .then(x => {
-      done.resolve(x);
-    })
-    .catch(err => {
-      console.log(err);
-    });
-  localDeferred.resolve();
-  return await done.promise;
-};
-
-export interface cycleObject {
-  cycleCounter: number;
-  deferred: plugins.smartpromise.Deferred<any>;
-}
-
-export class CycleCounter {
-  task: Task;
-  cycleObjectArray: cycleObject[] = [];
-  constructor(taskArg: Task) {
-    this.task = taskArg;
-  }
-  getPromiseForCycle(cycleCountArg: number) {
-    const done = plugins.smartpromise.defer();
-    const cycleObject: cycleObject = {
-      cycleCounter: cycleCountArg,
-      deferred: done
-    };
-    this.cycleObjectArray.push(cycleObject);
-    return done.promise;
-  }
-  informOfCycle(x) {
-    const newCycleObjectArray: cycleObject[] = [];
-    this.cycleObjectArray.forEach(cycleObjectArg => {
-      cycleObjectArg.cycleCounter--;
-      if (cycleObjectArg.cycleCounter <= 0) {
-        cycleObjectArg.deferred.resolve(x);
-      } else {
-        newCycleObjectArray.push(cycleObjectArg);
-      }
-    });
-    this.cycleObjectArray = newCycleObjectArray;
-  }
-}
-
-export class BufferRunner {
-  task: Task;
-  // initialze by default
-  bufferCounter: number = 0;
-  running: boolean = false;
-  constructor(taskArg: Task) {
-    this.task = taskArg;
-  }
-
-  trigger(x): Promise<any> {
-    if (!(this.bufferCounter >= this.task.bufferMax)) {
-      this.bufferCounter++;
-    }
-    const returnPromise: Promise<any> = this.task.cycleCounter.getPromiseForCycle(
-      this.bufferCounter + 1
-    );
-    if (!this.running) {
-      this._run(x);
-    }
-    return returnPromise;
-  }
-
-  private _run(x) {
-    const recursiveBufferRunner = x => {
-      if (this.bufferCounter >= 0) {
-        this.running = true;
-        this.task.running = true;
-        runTask(this.task, { x: x }).then(x => {
-          this.bufferCounter--;
-          this.task.cycleCounter.informOfCycle(x);
-          recursiveBufferRunner(x);
-        });
-      } else {
-        this.running = false;
-        this.task.running = false;
-      }
-    };
-    recursiveBufferRunner(x);
-  }
-}

ts/taskbuffer.classes.task.ts

@@ -1,29 +1,150 @@
 import * as plugins from './taskbuffer.plugins';
-import * as helpers from './taskbuffer.classes.helpers';
+import { BufferRunner } from './taskbuffer.classes.bufferrunner';
+import { CycleCounter } from './taskbuffer.classes.cyclecounter';
+
+import { logger } from './taskbuffer.logging';
 
 export interface ITaskFunction {
   (x?: any): PromiseLike<any>;
 }
 
-export class Task {
-  // man datory properties
-  name: string;
-  taskFunction: ITaskFunction;
-  buffered: boolean;
+export type TPreOrAfterTaskFunction = () => Task;
 
-  bufferMax: number;
-  execDelay: number;
+export class Task {
+  // STATIC
+  public static extractTask(preOrAfterTaskArg: Task | TPreOrAfterTaskFunction): Task {
+    switch (true) {
+      case !preOrAfterTaskArg:
+        return null;
+      case preOrAfterTaskArg instanceof Task:
+        return preOrAfterTaskArg as Task;
+      case typeof preOrAfterTaskArg === 'function':
+        const taskFunction = preOrAfterTaskArg as TPreOrAfterTaskFunction;
+        return taskFunction();
+      default:
+        return null;
+    }
+  }
+
+  public static emptyTaskFunction: ITaskFunction = function (x) {
+    const done = plugins.smartpromise.defer();
+    done.resolve();
+    return done.promise;
+  };
+
+  public static isTask = (taskArg: Task): boolean => {
+    if (taskArg instanceof Task && typeof taskArg.taskFunction === 'function') {
+      return true;
+    } else {
+      return false;
+    }
+  };
+
+  public static isTaskTouched = (
+    taskArg: Task | TPreOrAfterTaskFunction,
+    touchedTasksArray: Task[]
+  ): boolean => {
+    const taskToCheck = Task.extractTask(taskArg);
+    let result = false;
+    for (const keyArg in touchedTasksArray) {
+      if (taskToCheck === touchedTasksArray[keyArg]) {
+        result = true;
+      }
+    }
+    return result;
+  };
+
+  public static runTask = async (
+    taskArg: Task | TPreOrAfterTaskFunction,
+    optionsArg: { x?: any; touchedTasksArray?: Task[] }
+  ) => {
+    // extracts the task in case it is specified as a return value of a function
+    const taskToRun = Task.extractTask(taskArg);
+    const done = plugins.smartpromise.defer();
+
+    // pay respect to execDelay
+    if (taskToRun.execDelay) {
+      await plugins.smartdelay.delayFor(taskToRun.execDelay);
+    }
+
+    //  set running params
+    taskToRun.running = true;
+
+    done.promise.then(async () => {
+      taskToRun.running = false;
+    });
+
+    // handle options
+    const options = {
+      ...{ x: undefined, touchedTasksArray: [] },
+      ...optionsArg,
+    };
+    const x = options.x;
+    const touchedTasksArray: Task[] = options.touchedTasksArray;
+
+    touchedTasksArray.push(taskToRun);
+
+    // run the task cascade
+    const localDeferred = plugins.smartpromise.defer();
+    localDeferred.promise
+      .then(() => {
+        // lets run any preTask
+
+        if (taskToRun.preTask && !Task.isTaskTouched(taskToRun.preTask, touchedTasksArray)) {
+          return Task.runTask(taskToRun.preTask, { x, touchedTasksArray });
+        } else {
+          const done2 = plugins.smartpromise.defer();
+          done2.resolve(x);
+          return done2.promise;
+        }
+      })
+      .then(async (x) => {
+        // lets run the main task
+        try {
+          return await taskToRun.taskFunction(x);
+        } catch (e) {
+          console.log(e);
+        }
+      })
+      .then((x) => {
+        if (taskToRun.afterTask && !Task.isTaskTouched(taskToRun.afterTask, touchedTasksArray)) {
+          return Task.runTask(taskToRun.afterTask, { x: x, touchedTasksArray: touchedTasksArray });
+        } else {
+          const done2 = plugins.smartpromise.defer();
+          done2.resolve(x);
+          return done2.promise;
+        }
+      })
+      .then((x) => {
+        done.resolve(x);
+      })
+      .catch((err) => {
+        console.log(err);
+      });
+    localDeferred.resolve();
+    return await done.promise;
+  };
+
+  // INSTANCE
+  // mandatory properties
+  public name: string;
+  public taskFunction: ITaskFunction;
+  public buffered: boolean;
+  public cronJob: plugins.smarttime.CronJob;
+
+  public bufferMax: number;
+  public execDelay: number;
 
   // tasks to run before and after
-  preTask: Task;
-  afterTask: Task;
+  public preTask: Task | TPreOrAfterTaskFunction;
+  public afterTask: Task | TPreOrAfterTaskFunction;
 
   // initialize by default
-  running: boolean = false;
-  bufferRunner = new helpers.BufferRunner(this);
-  cycleCounter = new helpers.CycleCounter(this);
+  public running: boolean = false;
+  public bufferRunner = new BufferRunner(this);
+  public cycleCounter = new CycleCounter(this);
 
-  idle: boolean = true;
+  public idle: boolean = true;
   private _state: string = 'ready';
 
   constructor(optionsArg: {
@@ -34,11 +155,11 @@ export class Task {
     /**
      * any other task to run before
      */
-    preTask?: Task;
+    preTask?: Task | TPreOrAfterTaskFunction;
     /**
      * any other task to run after
      */
-    afterTask?: Task;
+    afterTask?: Task | TPreOrAfterTaskFunction;
     /**
      * wether this task should run buffered
      */
@@ -70,7 +191,7 @@ export class Task {
   /**
    * trigger the task. Will trigger buffered if this.buffered is true
    */
-  trigger(x?): Promise<any> {
+  public trigger(x?: any): Promise<any> {
     if (this.buffered) {
       return this.triggerBuffered(x);
     } else {
@@ -80,15 +201,17 @@ export class Task {
 
   /**
    * trigger task unbuffered.
+   * will actually run the task, not considering any buffered limits.
    */
-  triggerUnBuffered(x?): Promise<any> {
-    return helpers.runTask(this, { x: x });
+  public triggerUnBuffered(x?: any): Promise<any> {
+    return Task.runTask(this, { x: x });
   }
 
   /**
    * trigger task buffered.
+   * note: .trigger() also calls this function
    */
-  triggerBuffered(x?): Promise<any> {
+  public triggerBuffered(x?: any): Promise<any> {
     return this.bufferRunner.trigger(x);
   }
 
@@ -100,7 +223,7 @@ export class Task {
     if (stateArg === 'locked') {
       this._state = 'locked';
     } else {
-      plugins.smartlog.defaultLogger.log('error', 'state type ' + stateArg + ' could not be set');
+      logger.log('error', `state type ${stateArg} could not be set`);
     }
   }
 }

ts/taskbuffer.classes.taskchain.ts

@@ -3,7 +3,7 @@
 
 import * as plugins from './taskbuffer.plugins';
 import { Task } from './taskbuffer.classes.task';
-import helpers = require('./taskbuffer.classes.helpers');
+import { logger } from './taskbuffer.logging';
 
 export class Taskchain extends Task {
   taskArray: Task[];
@@ -14,22 +14,22 @@ export class Taskchain extends Task {
     buffered?: boolean;
     bufferMax?: number;
   }) {
-    let options = {
+    const options = {
       ...{
         name: 'unnamed Taskchain',
-        log: false
+        log: false,
       },
       ...optionsArg,
       ...{
         taskFunction: (x: any) => {
           // this is the function that gets executed when TaskChain is triggered
-          let done = plugins.smartpromise.defer(); // this is the starting Deferred object
+          const done = plugins.smartpromise.defer(); // this is the starting Deferred object
           let taskCounter = 0; // counter for iterating async over the taskArray
-          let iterateTasks = x => {
+          const iterateTasks = (x: any) => {
             if (typeof this.taskArray[taskCounter] !== 'undefined') {
               console.log(this.name + ' running: Task' + this.taskArray[taskCounter].name);
-              this.taskArray[taskCounter].trigger(x).then(x => {
-                plugins.smartlog.defaultLogger.log('info', this.taskArray[taskCounter].name);
+              this.taskArray[taskCounter].trigger(x).then((x) => {
+                logger.log('info', this.taskArray[taskCounter].name);
                 taskCounter++;
                 iterateTasks(x);
               });
@@ -40,8 +40,8 @@ export class Taskchain extends Task {
           };
           iterateTasks(x);
           return done.promise;
-        }
-      }
+        },
+      },
     };
     super(options);
     this.taskArray = optionsArg.taskArray;

ts/taskbuffer.classes.taskdebounced.ts

@@ -0,0 +1,27 @@
+import * as plugins from './taskbuffer.plugins';
+
+import { Task, ITaskFunction } from './taskbuffer.classes.task';
+
+export class TaskDebounced<T = unknown> extends Task {
+  private _debouncedTaskFunction: ITaskFunction;
+  private _observableIntake = new plugins.smartrx.ObservableIntake<T>();
+
+  constructor(optionsArg: {
+    name: string;
+    taskFunction: ITaskFunction;
+    debounceTimeInMillis: number;
+  }) {
+    super({
+      name: optionsArg.name,
+      taskFunction: async (x: T) => {
+        this._observableIntake.push(x);
+      },
+    });
+    this.taskFunction = optionsArg.taskFunction;
+    this._observableIntake.observable
+      .pipe(plugins.smartrx.rxjs.ops.debounceTime(optionsArg.debounceTimeInMillis))
+      .subscribe((x) => {
+        this.taskFunction(x);
+      });
+  }
+}

ts/taskbuffer.classes.taskmanager.ts

@@ -1,5 +1,6 @@
 import * as plugins from './taskbuffer.plugins';
 import { Task } from './taskbuffer.classes.task';
+import { threadId } from 'worker_threads';
 
 export interface ICronJob {
   cronString: string;
@@ -8,9 +9,9 @@ export interface ICronJob {
 }
 
 export class TaskManager {
-  public taskMap = new plugins.lik.Objectmap<Task>();
-  private cronJobMap = new plugins.lik.Objectmap<ICronJob>();
-  
+  public taskMap = new plugins.lik.ObjectMap<Task>();
+  private cronJobManager = new plugins.smarttime.CronManager();
+
   constructor() {
     // nothing here
   }
@@ -19,8 +20,8 @@ export class TaskManager {
    * checks if a task is already present
    * @param taskNameArg
    */
-  public getTaskByName(taskNameArg): Task {
-    return this.taskMap.find(itemArg => {
+  public getTaskByName(taskNameArg: string): Task {
+    return this.taskMap.findSync((itemArg) => {
       return itemArg.name === taskNameArg;
     });
   }
@@ -43,8 +44,7 @@ export class TaskManager {
    */
   public addAndScheduleTask(taskArg: Task, cronStringArg: string) {
     this.addTask(taskArg);
-    const taskName = taskArg.name;
-    this.scheduleTaskByName(taskName, cronStringArg);
+    this.scheduleTaskByName(taskArg.name, cronStringArg);
   }
 
   /**
@@ -69,29 +69,33 @@ export class TaskManager {
    */
   public scheduleTaskByName(taskNameArg: string, cronStringArg: string) {
     const taskToSchedule = this.getTaskByName(taskNameArg);
-    const job = new plugins.cron.CronJob({
-      cronTime: cronStringArg,
-      onTick: () => {
-        this.triggerTaskByName(taskNameArg);
-      },
-      start: true
-    });
-    this.cronJobMap.add({
-      taskNameArg: taskToSchedule.name,
-      cronString: cronStringArg,
-      job
+    const cronJob = this.cronJobManager.addCronjob(cronStringArg, async () => {
+      console.log(`taskbuffer schedule triggered task >>${taskToSchedule.name}<<`);
+      console.log(
+        `task >>${taskToSchedule.name}<< is ${
+          taskToSchedule.buffered
+            ? `buffered with max ${taskToSchedule.bufferMax} buffered calls`
+            : `unbuffered`
+        }`
+      );
+      await taskToSchedule.trigger();
     });
+    taskToSchedule.cronJob = cronJob;
   }
 
   /**
    * deschedules a task by name
-   * @param taskNameArg 
+   * @param taskNameArg
    */
   public descheduleTaskByName(taskNameArg: string) {
-    const descheduledCron = this.cronJobMap.findOneAndRemove(itemArg => {
-      return itemArg.taskNameArg === taskNameArg;
-    });
-    descheduledCron.job.stop();
+    const taskToDeSchedule = this.getTaskByName(taskNameArg);
+    if (taskToDeSchedule.cronJob) {
+      this.cronJobManager.removeCronjob(taskToDeSchedule.cronJob);
+      taskToDeSchedule.cronJob = null;
+    }
+    if (this.cronJobManager.cronjobs.isEmpty) {
+      this.cronJobManager.stop();
+    }
   }
 
   /**
@@ -106,4 +110,18 @@ export class TaskManager {
    * @param taskNameArg
    */
   public getSchedulesForTaskName(taskNameArg: string) {}
+
+  /**
+   * starts the taskmanager
+   */
+  public start() {
+    this.cronJobManager.start();
+  }
+
+  /**
+   * stops the taskmanager
+   */
+  public stop() {
+    this.cronJobManager.stop();
+  }
 }

ts/taskbuffer.classes.taskonce.ts

@@ -15,7 +15,7 @@ export class TaskOnce extends Task {
           this.hasTriggered = true;
           await optionsArg.taskFunction();
         }
-      }
+      },
     });
   }
 }

ts/taskbuffer.classes.taskparallel.ts

@@ -1,23 +1,22 @@
 import * as plugins from './taskbuffer.plugins';
-import * as helpers from './taskbuffer.classes.helpers';
 import { Task } from './taskbuffer.classes.task';
 
 export class Taskparallel extends Task {
-  taskArray: Task[];
+  public taskArray: Task[];
   constructor(optionsArg: { taskArray: Task[] }) {
     const options = {
       ...optionsArg,
       ...{
         taskFunction: () => {
-          let done = plugins.smartpromise.defer();
-          let promiseArray: Promise<any>[] = []; // stores promises of all tasks, since they run in parallel
-          this.taskArray.forEach(function(taskArg) {
+          const done = plugins.smartpromise.defer();
+          const promiseArray: Promise<any>[] = []; // stores promises of all tasks, since they run in parallel
+          this.taskArray.forEach(function (taskArg) {
             promiseArray.push(taskArg.trigger());
           });
           Promise.all(promiseArray).then(done.resolve);
           return done.promise;
-        }
-      }
+        },
+      },
     };
     super(options);
     this.taskArray = optionsArg.taskArray;

ts/taskbuffer.classes.taskrunner.ts

@@ -0,0 +1,63 @@
+import * as plugins from './taskbuffer.plugins';
+
+import { Task } from './taskbuffer.classes.task';
+
+export class TaskRunner {
+  public maxParrallelJobs: number = 1;
+  public status: 'stopped' | 'running' = 'stopped';
+  public runningTasks: plugins.lik.ObjectMap<Task> = new plugins.lik.ObjectMap<Task>();
+  public qeuedTasks: Task[] = [];
+
+  constructor() {
+    this.runningTasks.eventSubject.subscribe(async (eventArg) => {
+      this.checkExecution();
+    });
+  }
+
+  /**
+   * adds a task to the qeue
+   */
+  public addTask(taskArg: Task) {
+    this.qeuedTasks.push(taskArg);
+    this.checkExecution();
+  }
+
+  /**
+   * set amount of parallel tasks
+   * be careful, you might loose dependability of tasks
+   */
+  public setMaxParallelJobs(maxParrallelJobsArg: number) {
+    this.maxParrallelJobs = maxParrallelJobsArg;
+  }
+
+  /**
+   * starts the task queue
+   */
+  public async start() {
+    this.status = 'running';
+  }
+
+  /**
+   * checks wether execution is on point
+   */
+  public async checkExecution() {
+    if (
+      this.runningTasks.getArray().length < this.maxParrallelJobs &&
+      this.status === 'running' &&
+      this.qeuedTasks.length > 0
+    ) {
+      const nextJob = this.qeuedTasks.shift();
+      this.runningTasks.add(nextJob);
+      await nextJob.trigger();
+      this.runningTasks.remove(nextJob);
+      this.checkExecution();
+    }
+  }
+
+  /**
+   * stops the task queue
+   */
+  public async stop() {
+    this.status = 'stopped';
+  }
+}

ts/taskbuffer.logging.ts

@@ -0,0 +1,3 @@
+import * as plugins from './taskbuffer.plugins';
+
+export const logger = new plugins.smartlog.ConsoleLog();

ts/taskbuffer.plugins.ts

@@ -1,8 +1,8 @@
 import * as smartlog from '@pushrocks/smartlog';
-import cron from 'cron';
 import * as lik from '@pushrocks/lik';
-import * as rxjs from 'rxjs';
 import * as smartpromise from '@pushrocks/smartpromise';
 import * as smartdelay from '@pushrocks/smartdelay';
+import * as smartrx from '@pushrocks/smartrx';
+import * as smarttime from '@pushrocks/smarttime';
 
-export { smartlog, cron, lik, rxjs, smartpromise, smartdelay };
+export { smartlog, lik, smartpromise, smartdelay, smartrx, smarttime };