2.1.2

.gitignore

@@ -1,4 +1,20 @@
-coverage/
-node_modules
-pages/
 .nogit/
+
+# artifacts
+coverage/
+public/
+pages/
+
+# installs
+node_modules/
+
+# caches
+.yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_*/
+
+# custom

.gitlab-ci.yml

@@ -1,16 +1,16 @@
 # gitzone ci_default
-image: hosttoday/ht-docker-node:npmci
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
     - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
+  - security
-- test
+  - test
-- release
+  - release
-- metadata
+  - metadata
 
 # ====================
 # security stage
@@ -20,62 +20,28 @@ mirror:
   script:
     - npmci git mirror
   tags:
+    - lossless
     - docker
     - notpriv
 
-snyk:
+audit:
+  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 config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high
   tags:
+    - lossless
     - docker
     - notpriv
 
-sast:
-  stage: security
-  image: registry.gitlab.com/hosttoday/ht-docker-dbase:npmci
-  variables:
-    DOCKER_DRIVER: overlay2
-  allow_failure: true
-  services:
-    - docker:stable-dind
-  script:
-    - npmci npm prepare
-    - npmci npm install
-    - npmci command npm run build
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
-    - docker run
-        --env SAST_CONFIDENCE_LEVEL="${SAST_CONFIDENCE_LEVEL:-3}"
-        --volume "$PWD:/code"
-        --volume /var/run/docker.sock:/var/run/docker.sock
-        "registry.gitlab.com/gitlab-org/security-products/sast:$SP_VERSION" /app/bin/run /code
-  artifacts:
-    reports:
-      sast: gl-sast-report.json
-  tags:
-  - docker
-  - priv
-
 # ====================
 # test stage
 # ====================
 
-testLTS:
+testStable:
-  stage: test
-  script:
-  - npmci npm prepare
-  - npmci node install lts
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-    
-testSTABLE:
   stage: test
   script:
     - npmci npm prepare
@@ -84,6 +50,20 @@ testSTABLE:
     - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
+    - lossless
+    - docker
+    - priv
+
+testBuild:
+  stage: test
+  script:
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci command npm run build
+  coverage: /\d+.?\d+?\%\s*coverage/
+  tags:
+    - lossless
     - docker
     - notpriv
 
@@ -95,6 +75,7 @@ release:
   only:
     - tags
   tags:
+    - lossless
     - docker
     - notpriv
 
@@ -103,20 +84,14 @@ release:
 # ====================
 codequality:
   stage: metadata
-  image: docker:stable
   allow_failure: true
-  services:
-    - docker:stable-dind
   script:
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
+    - npmci command npm install -g tslint typescript
-    - docker run
+    - npmci npm prepare
-        --env SOURCE_CODE="$PWD"
+    - npmci npm install
-        --volume "$PWD":/code
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
-        --volume /var/run/docker.sock:/var/run/docker.sock
-        "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
-  artifacts:
-    paths: [codeclimate.json]
   tags:
+    - lossless
     - docker
     - priv
 
@@ -127,18 +102,20 @@ trigger:
   only:
     - tags
   tags:
+    - lossless
     - docker
     - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
   stage: metadata
   script:
-    - npmci command npm install -g typedoc typescript
+    - npmci node install lts
+    - npmci command npm install -g @gitzone/tsdoc
     - npmci npm prepare
     - npmci npm install
-    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
+    - npmci command tsdoc
   tags:
+    - lossless
     - docker
     - notpriv
   only:

.vscode/launch.json

@@ -0,0 +1,29 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "current file",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "${relativeFile}"
+      ],
+      "runtimeArgs": ["-r", "@gitzone/tsrun"],
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+      "internalConsoleOptions": "openOnSessionStart"
+    },
+    {
+      "name": "test.ts",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "test/test.ts"
+      ],
+      "runtimeArgs": ["-r", "@gitzone/tsrun"],
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+      "internalConsoleOptions": "openOnSessionStart"
+    }
+  ]
+}

.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"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

npmextra.json

@@ -3,5 +3,16 @@
     "npmGlobalTools": [],
     "npmAccessLevel": "public",
     "npmRegistryUrl": "registry.npmjs.org"
+  },
+  "gitzone": {
+    "projectType": "npm",
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "pushrocks",
+      "gitrepo": "taskbuffer",
+      "shortDescription": "flexible task management. TypeScript ready!",
+      "npmPackagename": "@pushrocks/taskbuffer",
+      "license": "MIT"
+    }
   }
 }

package.json

@@ -1,13 +1,13 @@
 {
   "name": "@pushrocks/taskbuffer",
-  "version": "2.0.8",
+  "version": "2.1.2",
   "private": false,
   "description": "flexible task management. TypeScript ready!",
-  "main": "dist/index.js",
+  "main": "dist_ts/index.js",
-  "typings": "dist/index.d.ts",
+  "typings": "dist_ts/index.d.ts",
   "scripts": {
-    "test": "(tstest test/)",
+    "test": "(tstest test/ --web)",
-    "build": "(tsbuild)"
+    "build": "(tsbuild --web && tsbundle npm)"
   },
   "repository": {
     "type": "git",
@@ -27,20 +27,35 @@
   },
   "homepage": "https://gitlab.com/pushrocks/taskbuffer#readme",
   "dependencies": {
-    "@pushrocks/lik": "^3.0.11",
+    "@pushrocks/lik": "^4.0.13",
-    "@pushrocks/smartdelay": "^2.0.3",
+    "@pushrocks/smartdelay": "^2.0.10",
-    "@pushrocks/smartlog": "^2.0.19",
+    "@pushrocks/smartlog": "^2.0.35",
-    "@pushrocks/smartpromise": "^3.0.2",
+    "@pushrocks/smartpromise": "^3.0.6",
-    "@types/cron": "^1.7.1",
+    "@pushrocks/smarttime": "^3.0.24",
-    "cron": "^1.7.1",
+    "@types/cron": "^1.7.2"
-    "rxjs": "^6.5.3"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.17",
+    "@gitzone/tsbuild": "^2.1.24",
-    "@gitzone/tstest": "^1.0.24",
+    "@gitzone/tsbundle": "^1.0.72",
-    "@pushrocks/tapbundle": "^3.0.13",
+    "@gitzone/tstest": "^1.0.41",
-    "@types/node": "^12.7.4",
+    "@pushrocks/tapbundle": "^3.2.9",
-    "tslint": "^5.19.0",
+    "@types/node": "^14.0.22",
+    "tslint": "^6.1.2",
     "tslint-config-prettier": "^1.18.0"
-  }
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
+  ]
 }

readme.md

@@ -1,64 +1,29 @@
-# taskbuffer
+# @pushrocks/taskbuffer
-
 flexible task management. TypeScript ready!
 
-## Availabililty
+## Availabililty and Links
-
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/taskbuffer)
-[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/taskbuffer)
+* [gitlab.com (source)](https://gitlab.com/pushrocks/taskbuffer)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/taskbuffer)
+* [github.com (source mirror)](https://github.com/pushrocks/taskbuffer)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/taskbuffer)
+* [docs (typedoc)](https://pushrocks.gitlab.io/taskbuffer/)
-[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](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)
+Status Category | Status Badge
-[![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/taskbuffer.svg)](https://www.npmjs.com/package/taskbuffer)
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/taskbuffer/badges/master/pipeline.svg)](https://lossless.cloud)
-[![Dependency Status](https://david-dm.org/pushrocks/taskbuffer.svg)](https://david-dm.org/pushrocks/taskbuffer)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/taskbuffer/badges/master/coverage.svg)](https://lossless.cloud)
-[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/taskbuffer/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/taskbuffer/master/dependencies/npm)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/taskbuffer)](https://lossless.cloud)
-[![bitHound Code](https://www.bithound.io/github/pushrocks/taskbuffer/badges/code.svg)](https://www.bithound.io/github/pushrocks/taskbuffer)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/taskbuffer)](https://lossless.cloud)
-[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
+TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
-[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
+node Support | [![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-standard-brightgreen.svg)](http://standardjs.com/)
+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)
 
-## Install
+## Usage
-
-```sh
-npm install taskbuffer --save
-```
-
-## Concepts
-
-### class `Task`
-
-- A Task in its most simple form is a function that is executed when the task runs.
-- A Task can have a **preTask** and an **afterTask**
-  (those are run before or after the main function whenever the task is called)
-- A Task can be buffered.
-  That means it can be called multiple times in a very short time.
-  However execution happens in line:
-  meaning execution of the task's main function is on halt until the previous task call has finished.
-  You can set bufferMax number, which is the max number of buffered task calls.
-  Any additional calls will then be truncated
-- Task.trigger() and Task.triggerBuffered() always return a Promise
-  which is fullfilled once the related task call has completed.
-- Task.triggered() is an Observable stream that emits events every time a task call is called and every time a call is completed.
-- Task is compatible to gulp streams.
-
-### class `TaskChain`
-
-- TaskChain extends Task.
-- Multiple Tasks can be combined in a bigger task using a TaskChain.
-- While the tasks are async in themselve, TaskChain **runs Tasks serialized** (one after the other)
-- that means that tasks can rely on each other and
-
-### class `TaskParallel`
-
-- TaskParallel extends Task.
-- like TaskChain, however **tasks run in parallel**
-- Tasks cannot rely on each other.
-
-### Usage
 
 We highly recommend TypeScript as this module supports **TypeScript intellisense**.
 
@@ -85,3 +50,14 @@ For further information read the linked docs at the top of this README.
 > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
 
 [![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)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
+
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

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

@@ -5,35 +5,35 @@ import * as smartpromise from '@pushrocks/smartpromise';
 import * as smartdelay from '@pushrocks/smartdelay';
 
 let task1Executed = false;
-let task1 = new taskbuffer.Task({
+const task1 = new taskbuffer.Task({
   taskFunction: async () => {
     await smartdelay.delayFor(2000);
     task1Executed = true;
-  }
+  },
 });
 
 let task2Executed = false;
-let task2 = new taskbuffer.Task({
+const task2 = new taskbuffer.Task({
   taskFunction: async () => {
     await smartdelay.delayFor(2000);
     task2Executed = true;
-  }
+  },
 });
 
 let task3Executed = false;
-let task3 = new taskbuffer.Task({
+const task3 = new taskbuffer.Task({
   taskFunction: async () => {
     await smartdelay.delayFor(2000);
     task3Executed = true;
-  }
+  },
 });
 
 tap.test('expect run tasks in sequence', async () => {
-  let testTaskchain = new taskbuffer.Taskchain({
+  const testTaskchain = new taskbuffer.Taskchain({
     name: 'Taskchain1',
-    taskArray: [task1, task2, task3]
+    taskArray: [task1, task2, task3],
   });
-  let testPromise = testTaskchain.trigger();
+  const testPromise = testTaskchain.trigger();
   await smartdelay.delayFor(2100);
   // tslint:disable-next-line:no-unused-expression
   expect(task1Executed).to.be.true;

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.browser.ts

@@ -0,0 +1,42 @@
+import { expect, tap } from '@pushrocks/tapbundle';
+import taskbuffer = require('../ts/index');
+
+import * as smartpromise from '@pushrocks/smartpromise';
+import * as smartdelay from '@pushrocks/smartdelay';
+
+let myTaskManager: taskbuffer.TaskManager;
+let taskRunCounter = 0;
+const taskDone = smartpromise.defer();
+
+tap.test('should create an instance of TaskManager', async () => {
+  myTaskManager = new taskbuffer.TaskManager();
+  expect(myTaskManager).to.be.instanceof(taskbuffer.TaskManager);
+});
+
+tap.test('should run the task as expected', async () => {
+  let referenceBoolean = false;
+  myTaskManager.addTask(
+    new taskbuffer.Task({
+      name: 'myTask',
+      taskFunction: async () => {
+        console.log('Task executed!');
+        referenceBoolean = true;
+        taskRunCounter++;
+        if (taskRunCounter === 10) {
+          taskDone.resolve();
+        }
+      },
+    })
+  );
+  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', '* * * * * *');
+  await taskDone.promise;
+  myTaskManager.descheduleTaskByName('myTask');
+});
+
+tap.start();

test/test.4.taskmanager.ts

@@ -25,7 +25,7 @@ tap.test('should run the task as expected', async () => {
         if (taskRunCounter === 10) {
           taskDone.resolve();
         }
-      }
+      },
     })
   );
   await myTaskManager.triggerTaskByName('myTask');

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

@@ -0,0 +1,51 @@
+import { tap, expect } from '@pushrocks/tapbundle';
+
+import * as taskbuffer from '../ts';
+
+let preTask: taskbuffer.Task;
+let afterTask: taskbuffer.Task;
+
+let mainTask: taskbuffer.Task;
+
+tap.test('should create tasks', async () => {
+  preTask = new taskbuffer.Task({
+    name: 'myPreTask',
+    taskFunction: async () => {
+      console.log('pretask executed :)');
+      return 'hi';
+    },
+  });
+  afterTask = new taskbuffer.Task({
+    name: 'myAfterTask',
+    taskFunction: async (x) => {
+      if (x === 'hi') {
+        console.log('afterTask: values get passed along alright');
+      }
+      console.log('afterTask executed :)');
+      return x;
+    },
+    preTask,
+    afterTask,
+  });
+
+  mainTask = new taskbuffer.Task({
+    name: 'mainTask',
+    taskFunction: async (x) => {
+      if (x === 'hi') {
+        console.log('mainTask: values get passed along alright');
+      }
+      console.log('afterTask executed :)');
+      return x;
+    },
+    preTask: () => {
+      return preTask;
+    },
+    afterTask,
+  });
+});
+
+tap.test('should execute the mainTask', async () => {
+  await mainTask.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,4 @@ export { Taskchain } from './taskbuffer.classes.taskchain';
 export { Taskparallel } from './taskbuffer.classes.taskparallel';
 export { TaskManager } from './taskbuffer.classes.taskmanager';
 export { TaskOnce } from './taskbuffer.classes.taskonce';
-
+export { TaskRunner } from './taskbuffer.classes.taskrunner';
-// import for naming only
-import './taskbuffer.classes.helpers';

ts/taskbuffer.classes.bufferrunner.ts

@@ -0,0 +1,42 @@
+import { Task } from './taskbuffer.classes.task';
+
+export class BufferRunner {
+  public task: Task;
+  // initialze by default
+  public bufferCounter: number = 0;
+  public running: boolean = false;
+  constructor(taskArg: Task) {
+    this.task = taskArg;
+  }
+
+  public 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;
+        Task.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.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) {
+    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,160 +0,0 @@
-import plugins = require('./taskbuffer.plugins');
-import { Task, ITaskFunction } from './taskbuffer.classes.task';
-
-export let emptyTaskFunction: ITaskFunction = function(x) {
-  let done = plugins.smartpromise.defer();
-  done.resolve();
-  return done.promise;
-};
-
-export let isTask = function(taskArg: Task): boolean {
-  if (taskArg instanceof Task && typeof taskArg.taskFunction === 'function') {
-    return true;
-  } else {
-    return false;
-  }
-};
-
-export let isTaskTouched = (taskArg: Task, touchedTasksArray: Task[]): boolean => {
-  let result = false;
-  for (let keyArg in touchedTasksArray) {
-    if (taskArg === touchedTasksArray[keyArg]) {
-      result = true;
-    }
-  }
-  return result;
-};
-
-export let runTask = async (taskArg: Task, optionsArg: { x?; touchedTasksArray?: Task[] }) => {
-  let 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
-  let options = {
-    ...{ x: undefined, touchedTasksArray: [] },
-    ...optionsArg
-  };
-  let x = options.x;
-  let touchedTasksArray: Task[] = options.touchedTasksArray;
-
-  touchedTasksArray.push(taskArg);
-
-  // run the task cascade
-  let localDeferred = plugins.smartpromise.defer();
-  localDeferred.promise
-    .then(() => {
-      if (taskArg.preTask && !isTaskTouched(taskArg.preTask, touchedTasksArray)) {
-        return runTask(taskArg.preTask, { x: x, touchedTasksArray: touchedTasksArray });
-      } else {
-        let done2 = plugins.smartpromise.defer();
-        done2.resolve(x);
-        return done2.promise;
-      }
-    })
-    .then(x => {
-      return taskArg.taskFunction(x);
-    })
-    .then(x => {
-      if (taskArg.afterTask && !isTaskTouched(taskArg.afterTask, touchedTasksArray)) {
-        return runTask(taskArg.afterTask, { x: x, touchedTasksArray: touchedTasksArray });
-      } else {
-        let 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) {
-    let done = plugins.smartpromise.defer();
-    let cycleObject: cycleObject = {
-      cycleCounter: cycleCountArg,
-      deferred: done
-    };
-    this.cycleObjectArray.push(cycleObject);
-    return done.promise;
-  }
-  informOfCycle(x) {
-    let 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++;
-    }
-    let returnPromise: Promise<any> = this.task.cycleCounter.getPromiseForCycle(
-      this.bufferCounter + 1
-    );
-    if (!this.running) {
-      this._run(x);
-    }
-    return returnPromise;
-  }
-
-  private _run(x) {
-    let 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,149 @@
 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 {
+export type TPreOrAfterTaskFunction = () => Task;
-  // man datory properties
-  name: string;
-  taskFunction: ITaskFunction;
-  buffered: boolean;
 
-  bufferMax: number;
+export class Task {
-  execDelay: number;
+  // 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?; touchedTasksArray?: Task[] }
+  ) => {
+    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
+  // man datory 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;
+  public preTask: Task | TPreOrAfterTaskFunction;
-  afterTask: Task;
+  public afterTask: Task | TPreOrAfterTaskFunction;
 
   // initialize by default
-  running: boolean = false;
+  public running: boolean = false;
-  bufferRunner = new helpers.BufferRunner(this);
+  public bufferRunner = new BufferRunner(this);
-  cycleCounter = new helpers.CycleCounter(this);
+  public cycleCounter = new CycleCounter(this);
 
-  idle: boolean = true;
+  public idle: boolean = true;
   private _state: string = 'ready';
 
   constructor(optionsArg: {
@@ -34,11 +154,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 +190,7 @@ export class Task {
   /**
    * trigger the task. Will trigger buffered if this.buffered is true
    */
-  trigger(x?): Promise<any> {
+  public trigger(x?): Promise<any> {
     if (this.buffered) {
       return this.triggerBuffered(x);
     } else {
@@ -81,14 +201,14 @@ export class Task {
   /**
    * trigger task unbuffered.
    */
-  triggerUnBuffered(x?): Promise<any> {
+  public triggerUnBuffered(x?): Promise<any> {
-    return helpers.runTask(this, { x: x });
+    return Task.runTask(this, { x: x });
   }
 
   /**
    * trigger task buffered.
    */
-  triggerBuffered(x?): Promise<any> {
+  public triggerBuffered(x?): Promise<any> {
     return this.bufferRunner.trigger(x);
   }
 
@@ -100,7 +220,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) => {
             if (typeof this.taskArray[taskCounter] !== 'undefined') {
               console.log(this.name + ' running: Task' + this.taskArray[taskCounter].name);
-              this.taskArray[taskCounter].trigger(x).then(x => {
+              this.taskArray[taskCounter].trigger(x).then((x) => {
-                plugins.smartlog.defaultLogger.log('info', this.taskArray[taskCounter].name);
+                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.taskmanager.ts

@@ -1,12 +1,17 @@
 import * as plugins from './taskbuffer.plugins';
 import { Task } from './taskbuffer.classes.task';
+import { threadId } from 'worker_threads';
 
-// interfaces
+export interface ICronJob {
-import { Objectmap } from '@pushrocks/lik';
+  cronString: string;
+  taskNameArg: string;
+  job: any;
+}
 
 export class TaskManager {
-  public taskMap = new plugins.lik.Objectmap<Task>();
+  public taskMap = new plugins.lik.ObjectMap<Task>();
-  private cronJobMap = new plugins.lik.Objectmap<ICronJob>();
+  private cronJobManager = new plugins.smarttime.CronManager();
+
   constructor() {
     // nothing here
   }
@@ -16,7 +21,7 @@ export class TaskManager {
    * @param taskNameArg
    */
   public getTaskByName(taskNameArg): Task {
-    return this.taskMap.find(itemArg => {
+    return this.taskMap.find((itemArg) => {
       return itemArg.name === taskNameArg;
     });
   }
@@ -55,31 +60,44 @@ export class TaskManager {
     return taskToTrigger.trigger();
   }
 
+  public async triggerTask(task: Task) {
+    return task.trigger();
+  }
+
   /**
    * schedules the task by name
    * @param taskNameArg
    */
   public scheduleTaskByName(taskNameArg: string, cronStringArg: string) {
     const taskToSchedule = this.getTaskByName(taskNameArg);
-    const job = new plugins.cron.CronJob({
+    const cronJob = this.cronJobManager.addCronjob(cronStringArg, async () => {
-      cronTime: cronStringArg,
+      await taskToSchedule.triggerBuffered();
-      onTick: () => {
-        this.triggerTaskByName(taskNameArg);
-      },
-      start: true
-    });
-    this.cronJobMap.add({
-      taskNameArg: taskToSchedule.name,
-      cronString: cronStringArg,
-      job: job
     });
+    taskToSchedule.cronJob = cronJob;
+    this.cronJobManager.start();
   }
 
+  /**
+   * deschedules a task by name
+   * @param taskNameArg
+   */
   public descheduleTaskByName(taskNameArg: string) {
-    const descheduledCron = this.cronJobMap.findOneAndRemove(itemArg => {
+    const taskToDeSchedule = this.getTaskByName(taskNameArg);
-      return itemArg.taskNameArg === taskNameArg;
+    if (taskToDeSchedule.cronJob) {
-    });
+      this.cronJobManager.removeCronjob(taskToDeSchedule.cronJob);
-    descheduledCron.job.stop();
+      taskToDeSchedule.cronJob = null;
+    }
+    if (this.cronJobManager.cronjobs.isEmpty) {
+      this.cronJobManager.stop();
+    }
+  }
+
+  /**
+   * deschedules a task
+   * @param task
+   */
+  public async descheduleTask(task: Task) {
+    await this.descheduleTaskByName(task.name);
   }
   /**
    * returns all schedules of a specific task
@@ -87,9 +105,3 @@ export class TaskManager {
    */
   public getSchedulesForTaskName(taskNameArg: string) {}
 }
-
-export interface ICronJob {
-  cronString: string;
-  taskNameArg: string;
-  job: any;
-}

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();
+          const done = plugins.smartpromise.defer();
-          let promiseArray: Promise<any>[] = []; // stores promises of all tasks, since they run in parallel
+          const promiseArray: Promise<any>[] = []; // stores promises of all tasks, since they run in parallel
-          this.taskArray.forEach(function(taskArg) {
+          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,7 @@
 import * as smartlog from '@pushrocks/smartlog';
-let cron = require('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 smarttime from '@pushrocks/smarttime';
 
-export { smartlog, cron, lik, rxjs, smartpromise, smartdelay };
+export { smartlog, lik, smartpromise, smartdelay, smarttime };