Compare commits

..

76 Commits

Author SHA1 Message Date
973678d635 3.0.6 2023-01-07 20:35:28 +01:00
28e7bad605 fix(core): update 2023-01-07 20:35:27 +01:00
fb44dd47fc 3.0.5 2023-01-07 19:05:30 +01:00
a2f6bccac2 fix(core): update 2023-01-07 19:05:29 +01:00
e4f8be5603 3.0.4 2022-11-14 14:54:26 +01:00
84f186924e fix(core): update 2022-11-14 14:54:26 +01:00
ff57dccee1 3.0.3 2022-11-09 10:36:18 +01:00
a9d84d5147 fix(core): update 2022-11-09 10:36:18 +01:00
ae6a6ce67e 3.0.2 2022-08-02 15:07:20 +02:00
05b14136f9 fix(core): update 2022-08-02 15:07:20 +02:00
bf9ca39c36 3.0.1 2022-04-15 16:41:42 +02:00
e61791ec41 fix(core): update 2022-04-15 16:41:42 +02:00
9001a96df0 3.0.0 2022-03-25 12:14:49 +01:00
835fa3663d BREAKING CHANGE(core): switch to esm 2022-03-25 12:14:49 +01:00
f50384947d 2.1.17 2021-11-11 20:48:32 +01:00
65c1dd8fdc fix(core): update 2021-11-11 20:48:31 +01:00
613d46bb38 2.1.16 2021-11-11 20:37:27 +01:00
439da1f342 fix(core): update 2021-11-11 20:37:27 +01:00
e9e4a60fe6 2.1.15 2021-11-11 19:59:56 +01:00
1630f6971f fix(core): update 2021-11-11 19:59:56 +01:00
7bfb145513 2.1.14 2021-09-26 14:45:02 +02:00
c367f0f949 fix(core): update 2021-09-26 14:45:02 +02:00
8f9b3151d8 2.1.13 2020-09-07 23:52:23 +00:00
81e97b513a fix(core): update 2020-09-07 23:52:22 +00:00
7da0035805 2.1.12 2020-09-07 17:35:51 +00:00
16a77e4c41 fix(core): update 2020-09-07 17:35:50 +00:00
495f63ec71 2.1.11 2020-09-04 16:09:44 +00:00
17f840d24c fix(core): update 2020-09-04 16:09:44 +00:00
b93407e83a 2.1.10 2020-09-04 06:47:31 +00:00
003c1f2796 fix(core): update 2020-09-04 06:47:30 +00:00
7f72a88846 2.1.9 2020-09-03 20:43:38 +00:00
823d4f7d55 fix(core): update 2020-09-03 20:43:37 +00:00
7d57fcf07e 2.1.8 2020-09-02 15:26:46 +00:00
eb9ae2fa71 fix(core): update 2020-09-02 15:26:45 +00:00
5fe60c6e50 2.1.7 2020-09-02 13:46:27 +00:00
6f811b4ab5 fix(core): update 2020-09-02 13:46:26 +00:00
2cf32ac723 2.1.6 2020-09-02 13:04:53 +00:00
09936fda56 fix(core): update 2020-09-02 13:04:52 +00:00
ddc9a77fe2 2.1.5 2020-09-02 13:04:12 +00:00
575912eab7 fix(core): update 2020-09-02 13:04:12 +00:00
eee146ae8b 2.1.4 2020-07-12 10:57:15 +00:00
ea8ef61c40 fix(core): update 2020-07-12 10:57:15 +00:00
70bb5b3f5d 2.1.3 2020-07-12 02:40:45 +00:00
5fa7312171 fix(core): update 2020-07-12 02:40:45 +00:00
cb85deeb3d 2.1.2 2020-07-12 00:48:51 +00:00
fdfb780c33 fix(core): update 2020-07-12 00:48:51 +00:00
f21b53b81d 2.1.1 2019-11-28 14:42:29 +00:00
0bf3b2ea8b fix(core): update 2019-11-28 14:42:28 +00:00
0e81b8bd94 2.1.0 2019-11-28 11:33:26 +00:00
138aefc499 feat(taskrunner): now has working taskrunner 2019-11-28 11:33:26 +00:00
af5fa857cc 2.0.16 2019-11-27 23:34:45 +00:00
f275f7e2f6 fix(core): update 2019-11-27 23:34:45 +00:00
ea1f434cdd 2.0.15 2019-09-23 18:06:43 +02:00
2cc212f210 fix(core): update 2019-09-23 18:06:43 +02:00
2d2788d1ca 2.0.14 2019-09-23 16:31:07 +02:00
de1652bac9 fix(core): update 2019-09-23 16:31:06 +02:00
5310bef1be 2.0.13 2019-09-22 15:18:28 +02:00
1a5c67efc1 2.0.12 2019-09-22 15:16:27 +02:00
df21ebd581 fix(core): update 2019-09-22 15:16:27 +02:00
3f749dfdd2 2.0.11 2019-09-18 19:15:56 +02:00
2a39543a75 fix(core): update 2019-09-18 19:15:56 +02:00
68f7d26d3b 2.0.10 2019-09-08 22:45:37 +02:00
6373a74fb3 fix(core): update 2019-09-08 22:45:36 +02:00
be3d2d41d6 2.0.9 2019-09-06 16:32:36 +02:00
2affa189a7 fix(core): update 2019-09-06 16:32:36 +02:00
8c4c2a552c 2.0.8 2019-09-05 11:35:26 +02:00
eff9c6e6c9 fix(core): update 2019-09-05 11:35:26 +02:00
4c7a373d98 2.0.7 2019-01-15 00:20:05 +01:00
6b93a2e7ac fix(core): update 2019-01-15 00:20:05 +01:00
9c6487c779 2.0.6 2019-01-15 00:17:45 +01:00
e3f37f5027 fix(core): update 2019-01-15 00:17:44 +01:00
1152bb1138 2.0.5 2018-08-12 20:55:07 +02:00
9df7787450 2.0.4 2018-08-11 00:01:19 +02:00
3e81fdacad fix(CI): now building properly 2018-08-11 00:01:19 +02:00
f74da6ff0b 2.0.3 2018-08-05 23:10:01 +02:00
e9d976ad1e fix(ci): update testing framework to the new tstest 2018-08-05 23:10:00 +02:00
35 changed files with 5303 additions and 1530 deletions

22
.gitignore vendored
View File

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

View File

@ -1,16 +1,19 @@
# gitzone standard # gitzone ci_default
image: hosttoday/ht-docker-node:npmci image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
cache: cache:
paths: paths:
- .npmci_cache/ - .npmci_cache/
key: "$CI_BUILD_STAGE" key: '$CI_BUILD_STAGE'
stages: stages:
- security - security
- test - test
- release - release
- metadata - metadata
before_script:
- npm install -g @shipzone/npmci
# ==================== # ====================
# security stage # security stage
@ -18,109 +21,115 @@ stages:
mirror: mirror:
stage: security stage: security
script: script:
- npmci git mirror - npmci git mirror
only:
- tags
tags: tags:
- docker - lossless
- notpriv - docker
- notpriv
snyk: auditProductionDependencies:
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
stage: security stage: security
script: script:
- npmci command npm install -g snyk - npmci npm prepare
- npmci command npm install --ignore-scripts - npmci command npm install --production --ignore-scripts
- npmci command snyk test - npmci command npm config set registry https://registry.npmjs.org
- npmci command npm audit --audit-level=high --only=prod --production
tags: tags:
- docker - docker
- notpriv 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 # test stage
# ==================== # ====================
testLEGACY:
stage: test
script:
- npmci node install legacy
- npmci npm install
- npmci npm test
coverage: /\d+.?\d+?\%\s*coverage/
tags:
- docker
- notpriv
allow_failure: true
testLTS: testStable:
stage: test stage: test
script: script:
- npmci node install lts - npmci npm prepare
- npmci npm install - npmci node install stable
- npmci npm test - npmci npm install
- npmci npm test
coverage: /\d+.?\d+?\%\s*coverage/ coverage: /\d+.?\d+?\%\s*coverage/
tags: tags:
- docker - docker
- notpriv
testBuild:
testSTABLE:
stage: test stage: test
script: script:
- npmci node install stable - npmci npm prepare
- npmci npm install - npmci node install stable
- npmci npm test - npmci npm install
- npmci command npm run build
coverage: /\d+.?\d+?\%\s*coverage/ coverage: /\d+.?\d+?\%\s*coverage/
tags: tags:
- docker - docker
- notpriv
release: release:
stage: release stage: release
script: script:
- npmci node install stable - npmci node install stable
- npmci npm publish - npmci npm publish
only: only:
- tags - tags
tags: tags:
- docker - lossless
- notpriv - docker
- notpriv
# ==================== # ====================
# metadata stage # metadata stage
# ==================== # ====================
codequality: codequality:
stage: metadata stage: metadata
image: docker:stable
allow_failure: true allow_failure: true
services: only:
- docker:stable-dind - tags
script: 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: tags:
- docker - lossless
- priv - docker
- priv
trigger: trigger:
stage: metadata stage: metadata
script: script:
- npmci trigger - npmci trigger
only: only:
- tags - tags
tags: tags:
- docker - lossless
- notpriv - docker
- notpriv
pages: pages:
image: hosttoday/ht-docker-node:npmci
stage: metadata stage: metadata
script: 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 npm install
- npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/ - npmci command tsdoc
tags: tags:
- lossless
- docker - docker
- notpriv - notpriv
only: only:
@ -128,15 +137,5 @@ pages:
artifacts: artifacts:
expire_in: 1 week expire_in: 1 week
paths: paths:
- public - public
allow_failure: true
windowsCompatibility:
image: stefanscherer/node-windows:10-build-tools
stage: metadata
script:
- npm install & npm test
coverage: /\d+.?\d+?\%\s*coverage/
tags:
- windows
allow_failure: true allow_failure: true

11
.vscode/launch.json vendored Normal file
View File

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

26
.vscode/settings.json vendored Normal file
View File

@ -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"]
}
}
}
}
}
}
]
}

View File

@ -1,12 +1,18 @@
{ {
"npmts":{
"mode":"default",
"testConfig": {
"parallel": false
}
},
"npmci": { "npmci": {
"npmGlobalTools": [], "npmGlobalTools": [],
"npmAccessLevel": "public" "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"
}
} }
} }

1036
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,13 +1,14 @@
{ {
"name": "@pushrocks/taskbuffer", "name": "@pushrocks/taskbuffer",
"version": "2.0.2", "version": "3.0.6",
"private": false, "private": false,
"description": "flexible task management. TypeScript ready!", "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",
"type": "module",
"scripts": { "scripts": {
"test": "tstest test/", "test": "(tstest test/ --web)",
"build": "echo \"Not needed for now\"" "build": "(tsbuild --web && tsbundle npm)"
}, },
"repository": { "repository": {
"type": "git", "type": "git",
@ -27,17 +28,35 @@
}, },
"homepage": "https://gitlab.com/pushrocks/taskbuffer#readme", "homepage": "https://gitlab.com/pushrocks/taskbuffer#readme",
"dependencies": { "dependencies": {
"@pushrocks/lik": "^3.0.1", "@pushrocks/isounique": "^1.0.5",
"@pushrocks/smartdelay": "^2.0.1", "@pushrocks/lik": "^6.0.0",
"@pushrocks/smartlog": "^2.0.1", "@pushrocks/smartdelay": "^2.0.13",
"@pushrocks/smartpromise": "^2.0.5", "@pushrocks/smartlog": "^3.0.1",
"@types/cron": "^1.3.0", "@pushrocks/smartpromise": "^3.1.7",
"cron": "^1.3.0", "@pushrocks/smartrx": "^3.0.0",
"rxjs": "^6.2.2" "@pushrocks/smarttime": "^4.0.1"
}, },
"devDependencies": { "devDependencies": {
"@gitzone/tstest": "^1.0.7", "@gitzone/tsbuild": "^2.1.63",
"@pushrocks/tapbundle": "^3.0.1", "@gitzone/tsbundle": "^2.0.6",
"@types/node": "^10.5.4" "@gitzone/tsrun": "^1.2.39",
} "@gitzone/tstest": "^1.0.72",
"@pushrocks/tapbundle": "^5.0.4",
"@types/node": "^18.11.18"
},
"files": [
"ts/**/*",
"ts_web/**/*",
"dist/**/*",
"dist_*/**/*",
"dist_ts/**/*",
"dist_ts_web/**/*",
"assets/**/*",
"cli.js",
"npmextra.json",
"readme.md"
],
"browserslist": [
"last 1 chrome versions"
]
} }

4349
pnpm-lock.yaml generated Normal file

File diff suppressed because it is too large Load Diff

View File

@ -1,64 +1,29 @@
# taskbuffer # @pushrocks/taskbuffer
flexible task management. TypeScript ready! 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 ## 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**. 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) > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks) [![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)

View File

@ -1,5 +1,6 @@
import { expect, tap } from '@pushrocks/tapbundle'; import { expect, tap } from '@pushrocks/tapbundle';
import taskbuffer = require('../ts/index');
import * as taskbuffer from '../ts/index.js';
import * as smartpromise from '@pushrocks/smartpromise'; import * as smartpromise from '@pushrocks/smartpromise';
import * as smartdelay from '@pushrocks/smartdelay'; import * as smartdelay from '@pushrocks/smartdelay';
@ -8,13 +9,10 @@ import * as smartdelay from '@pushrocks/smartdelay';
let testTask: taskbuffer.Task; let testTask: taskbuffer.Task;
let testPreTask = new taskbuffer.Task({ let testPreTask = new taskbuffer.Task({
taskFunction: function() { taskFunction: async () => {
let done = smartpromise.defer();
console.log('preTask executed'); console.log('preTask executed');
done.resolve();
return done.promise;
}, },
preTask: testTask preTask: testTask,
}); });
// some more tasks to test with // some more tasks to test with
@ -30,20 +28,20 @@ let task1 = new taskbuffer.Task({
done.resolve(); done.resolve();
}, 5000); }, 5000);
return done.promise; return done.promise;
} },
}); });
let task2 = new taskbuffer.Task({ let task2 = new taskbuffer.Task({
name: 'Task 1', name: 'Task 1',
taskFunction: () => { taskFunction: async () => {
let done = smartpromise.defer(); const done = smartpromise.defer();
console.log('Task2 started'); console.log('Task2 started');
setTimeout(() => { setTimeout(() => {
console.log('Task2 executed'); console.log('Task2 executed');
done.resolve(); done.resolve();
}, 5000); }, 5000);
return done.promise; await done.promise;
} },
}); });
let task3 = new taskbuffer.Task({ let task3 = new taskbuffer.Task({
@ -56,7 +54,7 @@ let task3 = new taskbuffer.Task({
done.resolve(); done.resolve();
}, 5000); }, 5000);
return done.promise; return done.promise;
} },
}); });
tap.test('new Task() should return a new task', async () => { tap.test('new Task() should return a new task', async () => {
@ -64,12 +62,12 @@ tap.test('new Task() should return a new task', async () => {
taskFunction: async () => { taskFunction: async () => {
console.log('executed twice'); console.log('executed twice');
}, },
preTask: testPreTask preTask: testPreTask,
}); });
}); });
tap.test('expect testTask to be an instance of Task', async () => { tap.test('expect testTask to be an instance of Task', async () => {
expect(testTask).to.be.instanceof(taskbuffer.Task); expect(testTask).toBeInstanceOf(taskbuffer.Task);
}); });
tap.test('expect testTask.idle is true', async () => { tap.test('expect testTask.idle is true', async () => {
@ -79,13 +77,13 @@ tap.test('expect testTask.idle is true', async () => {
}); });
tap.test('testTask.running should be of type boolean and initially false', async () => { tap.test('testTask.running should be of type boolean and initially false', async () => {
expect(testTask.running).to.be.a('boolean'); expect(testTask.running).toBeTypeofBoolean();
// tslint:disable-next-line:no-unused-expression // tslint:disable-next-line:no-unused-expression
expect(testTask.running).to.be.false; expect(testTask.running).toBeFalse();
}); });
tap.test('testTask.trigger() should return Promise', async () => { tap.test('testTask.trigger() should return Promise', async () => {
expect(testTask.trigger()).to.be.instanceof(Promise); expect(testTask.trigger()).toBeInstanceOf(Promise);
}); });
tap.test('testTask.trigger() returned Promise should be fullfilled', async () => { tap.test('testTask.trigger() returned Promise should be fullfilled', async () => {
@ -96,7 +94,7 @@ tap.test('expect to run a task without pre and afterTask errorless', async () =>
let localTestTask = new taskbuffer.Task({ let localTestTask = new taskbuffer.Task({
taskFunction: async () => { taskFunction: async () => {
console.log('only once'); console.log('only once');
} },
}); });
await localTestTask.trigger(); await localTestTask.trigger();
}); });
@ -107,7 +105,7 @@ tap.test('expect task to run in buffered mode', async () => {
await smartdelay.delayFor(3000); await smartdelay.delayFor(3000);
}, },
buffered: true, buffered: true,
bufferMax: 2 bufferMax: 2,
}); });
localTestTask.trigger(); localTestTask.trigger();
localTestTask.trigger(); localTestTask.trigger();

View File

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

View File

@ -1,36 +1,35 @@
import { expect, tap } from '@pushrocks/tapbundle'; import { expect, tap } from '@pushrocks/tapbundle';
import taskbuffer = require('../ts/index');
import * as smartq from 'smartq';
import * as smartdelay from '@pushrocks/smartdelay'; import * as smartdelay from '@pushrocks/smartdelay';
import * as taskbuffer from '../ts/index.js';
let task1Executed = false; let task1Executed = false;
let task1 = new taskbuffer.Task({ const task1 = new taskbuffer.Task({
taskFunction: async () => { taskFunction: async () => {
await smartdelay.delayFor(2000); await smartdelay.delayFor(2000);
task1Executed = true; task1Executed = true;
} },
}); });
let task2Executed = false; let task2Executed = false;
let task2 = new taskbuffer.Task({ const task2 = new taskbuffer.Task({
taskFunction: async () => { taskFunction: async () => {
await smartdelay.delayFor(2000); await smartdelay.delayFor(2000);
task2Executed = true; task2Executed = true;
} },
}); });
let task3Executed = false; let task3Executed = false;
let task3 = new taskbuffer.Task({ const task3 = new taskbuffer.Task({
taskFunction: async () => { taskFunction: async () => {
await smartdelay.delayFor(2000); await smartdelay.delayFor(2000);
task3Executed = true; task3Executed = true;
} },
}); });
tap.test('expect run in Parallel', async () => { tap.test('expect run in Parallel', async () => {
let testTaskparallel = new taskbuffer.Taskparallel({ const testTaskparallel = new taskbuffer.Taskparallel({
taskArray: [task1, task2, task3] taskArray: [task1, task2, task3],
}); });
await testTaskparallel.trigger(); await testTaskparallel.trigger();
}); });

View File

@ -1,16 +1,17 @@
import { expect, tap } from '@pushrocks/tapbundle'; import { expect, tap } from '@pushrocks/tapbundle';
import taskbuffer = require('../ts/index');
import * as taskbuffer from '../ts/index.js';
import * as smartpromise from '@pushrocks/smartpromise'; import * as smartpromise from '@pushrocks/smartpromise';
import * as smartdelay from '@pushrocks/smartdelay'; import * as smartdelay from '@pushrocks/smartdelay';
let myTaskManager: taskbuffer.TaskManager; let myTaskManager: taskbuffer.TaskManager;
let taskRunCounter = 0; let taskRunCounter = 0;
let taskDone = smartpromise.defer(); const taskDone = smartpromise.defer();
tap.test('should create an instance of TaskManager', async () => { tap.test('should create an instance of TaskManager', async () => {
myTaskManager = new taskbuffer.TaskManager(); myTaskManager = new taskbuffer.TaskManager();
expect(myTaskManager).to.be.instanceof(taskbuffer.TaskManager); expect(myTaskManager).toBeInstanceOf(taskbuffer.TaskManager);
}); });
tap.test('should run the task as expected', async () => { tap.test('should run the task as expected', async () => {
@ -18,25 +19,32 @@ tap.test('should run the task as expected', async () => {
myTaskManager.addTask( myTaskManager.addTask(
new taskbuffer.Task({ new taskbuffer.Task({
name: 'myTask', name: 'myTask',
bufferMax: 1,
buffered: true,
taskFunction: async () => { taskFunction: async () => {
console.log('Task executed!'); console.log('Task "myTask" executed!');
referenceBoolean = true; referenceBoolean = true;
taskRunCounter++; taskRunCounter++;
if (taskRunCounter === 10) { if (taskRunCounter === 10) {
taskDone.resolve(); taskDone.resolve();
} }
} },
}) })
); );
myTaskManager.start();
await myTaskManager.triggerTaskByName('myTask'); await myTaskManager.triggerTaskByName('myTask');
// tslint:disable-next-line:no-unused-expression // tslint:disable-next-line:no-unused-expression
expect(referenceBoolean).to.be.true; expect(referenceBoolean).toBeTrue();
}); });
tap.test('should schedule task', async () => { tap.test('should schedule task', async () => {
myTaskManager.scheduleTaskByName('myTask', '* * * * * *'); myTaskManager.scheduleTaskByName('myTask', '*/10 * * * * *');
await taskDone.promise; await taskDone.promise;
myTaskManager.descheduleTaskByName('myTask'); myTaskManager.descheduleTaskByName('myTask');
}); });
tap.test('should stop the taskmanager', async () => {
myTaskManager.stop();
});
tap.start(); tap.start();

View File

@ -1,64 +1,65 @@
import { expect, tap } from '@pushrocks/tapbundle'; import { expect, tap } from '@pushrocks/tapbundle';
import taskbuffer = require('../ts/index');
import * as taskbuffer from '../ts/index.js';
import * as smartpromise from '@pushrocks/smartpromise'; import * as smartpromise from '@pushrocks/smartpromise';
import * as smartdelay from '@pushrocks/smartdelay'; import * as smartdelay from '@pushrocks/smartdelay';
let flowTask1 = new taskbuffer.Task({ const flowTask1 = new taskbuffer.Task({
taskFunction: (x: number) => { taskFunction: (x: number) => {
let done = smartpromise.defer(); const done = smartpromise.defer();
console.log('flowTask1'); console.log('flowTask1');
console.log(x); console.log(x);
done.resolve(x); done.resolve(x);
return done.promise; return done.promise;
} },
}); });
let flowTaskBuffered = new taskbuffer.Task({ const flowTaskBuffered = new taskbuffer.Task({
taskFunction: (x: number) => { taskFunction: (x: number) => {
let done = smartpromise.defer(); const done = smartpromise.defer();
console.log('flowTask1'); console.log('flowTask1');
console.log(x); console.log(x);
done.resolve(x); done.resolve(x);
return done.promise; return done.promise;
}, },
buffered: true, buffered: true,
bufferMax: 1 bufferMax: 1,
}); });
let flowTask2 = new taskbuffer.Task({ const flowTask2 = new taskbuffer.Task({
taskFunction: (x: number) => { taskFunction: (x: number) => {
let done = smartpromise.defer(); const done = smartpromise.defer();
console.log('flowTask2'); console.log('flowTask2');
console.log(x); console.log(x);
done.resolve(x); done.resolve(x);
return done.promise; return done.promise;
}, },
preTask: flowTask1 preTask: flowTask1,
}); });
let flowTask3 = new taskbuffer.Taskchain({ const flowTask3 = new taskbuffer.Taskchain({
taskArray: [flowTask1, flowTask2] taskArray: [flowTask1, flowTask2],
}); });
tap.test('should let a value flow through a task', async () => { tap.test('should let a value flow through a task', async () => {
let result = await flowTask1.trigger(12); const result = await flowTask1.trigger(12);
expect(result).to.equal(12); expect(result).toEqual(12);
}); });
tap.test('expect values to flow between tasks', async () => { tap.test('expect values to flow between tasks', async () => {
let result = await flowTask2.trigger(12); const result = await flowTask2.trigger(12);
expect(result).to.equal(12); expect(result).toEqual(12);
}); });
tap.test('expect values to flow between tasks when buffered', async () => { tap.test('expect values to flow between tasks when buffered', async () => {
let result = await flowTaskBuffered.trigger(12); const result = await flowTaskBuffered.trigger(12);
expect(result).to.equal(12); expect(result).toEqual(12);
}); });
tap.test('expect values to flow between tasks in Taskchain', async () => { tap.test('expect values to flow between tasks in Taskchain', async () => {
let result = await flowTask3.trigger(12); const result = await flowTask3.trigger(12);
expect(result).to.equal(12); expect(result).toEqual(12);
}); });
tap.start(); tap.start();

View File

@ -1,6 +1,6 @@
import { expect, tap } from '@pushrocks/tapbundle'; import { expect, tap } from '@pushrocks/tapbundle';
import * as taskbuffer from '../ts/index'; import * as taskbuffer from '../ts/index.js';
let myNumber = 0; let myNumber = 0;
let myTaskOnce: taskbuffer.TaskOnce; let myTaskOnce: taskbuffer.TaskOnce;
@ -9,20 +9,20 @@ tap.test('should create a valid instance of TaskOnce', async () => {
myTaskOnce = new taskbuffer.TaskOnce({ myTaskOnce = new taskbuffer.TaskOnce({
taskFunction: async () => { taskFunction: async () => {
myNumber++; myNumber++;
} },
}); });
expect(myTaskOnce).to.be.instanceof(taskbuffer.TaskOnce); expect(myTaskOnce).toBeInstanceOf(taskbuffer.TaskOnce);
}); });
tap.test('myNumber should still be 0', async () => { tap.test('myNumber should still be 0', async () => {
expect(myNumber).to.equal(0); expect(myNumber).toEqual(0);
}); });
tap.test('myTaskOnce should trigger once', async () => { tap.test('myTaskOnce should trigger once', async () => {
await myTaskOnce.trigger(); await myTaskOnce.trigger();
await myTaskOnce.trigger(); await myTaskOnce.trigger();
await myTaskOnce.trigger(); await myTaskOnce.trigger();
expect(myNumber).to.equal(1); expect(myNumber).toEqual(1);
}); });
tap.start(); tap.start();

51
test/test.7.taskloop.ts Normal file
View File

@ -0,0 +1,51 @@
import { tap, expect } from '@pushrocks/tapbundle';
import * as taskbuffer from '../ts/index.js';
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();

View File

@ -0,0 +1,52 @@
import { tap, expect } from '@pushrocks/tapbundle';
import * as taskbuffer from '../ts/index.js';
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();

34
test/test.taskrunner.ts Normal file
View File

@ -0,0 +1,34 @@
import { tap, expect } from '@pushrocks/tapbundle';
import * as taskbuffer from '../ts/index.js';
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();

8
ts/00_commitinfo_data.ts Normal file
View File

@ -0,0 +1,8 @@
/**
* autocreated commitinfo by @pushrocks/commitinfo
*/
export const commitinfo = {
name: '@pushrocks/taskbuffer',
version: '3.0.6',
description: 'flexible task management. TypeScript ready!'
}

View File

@ -1,8 +1,12 @@
export { Task, ITaskFunction } from './taskbuffer.classes.task'; export { Task } from './taskbuffer.classes.task.js';
export { Taskchain } from './taskbuffer.classes.taskchain'; export type { ITaskFunction } from './taskbuffer.classes.task.js'
export { Taskparallel } from './taskbuffer.classes.taskparallel'; export { Taskchain } from './taskbuffer.classes.taskchain.js';
export { TaskManager } from './taskbuffer.classes.taskmanager'; export { Taskparallel } from './taskbuffer.classes.taskparallel.js';
export { TaskOnce } from './taskbuffer.classes.taskonce'; export { TaskManager } from './taskbuffer.classes.taskmanager.js';
export { TaskOnce } from './taskbuffer.classes.taskonce.js';
// import for naming only export { TaskRunner } from './taskbuffer.classes.taskrunner.js';
import './taskbuffer.classes.helpers'; export { TaskDebounced } from './taskbuffer.classes.taskdebounced.js';
import * as distributedCoordination from './taskbuffer.classes.distributedcoordinator.js';
export {
distributedCoordination
}

View File

@ -0,0 +1,39 @@
import { Task } from './taskbuffer.classes.task.js';
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);
}
}

View File

@ -0,0 +1,36 @@
import * as plugins from './taskbuffer.plugins.js';
import { Task } from './taskbuffer.classes.task.js';
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;
}
}

View File

@ -0,0 +1,46 @@
import { Task } from './taskbuffer.classes.task.js';
import * as plugins from './taskbuffer.plugins.js';
/**
* constains all data for the final coordinator to actually make an informed decision
*/
export interface IDistributedDecisionInfoBasis {
submitterRandomId: string;
taskName: string;
taskVersion: string;
taskExecutionTime: number;
taskExecutionTimeout: number;
taskExecutionParallel: number;
status: 'requesting' | 'gotRejected' | 'failed' | 'succeeded';
}
export interface ITaskConsultationResult {
considered: boolean;
rank: string;
reason: string;
shouldTrigger: boolean;
}
export interface IDistributedCoordinatorConstructorOptions {
/**
* each execution should be announced
*/
announceDistributedDecisionInfoBasis: (distributedCoordinatorArg: DistributedCoordinator, infoBasisArg: IDistributedDecisionInfoBasis) => Promise<ITaskConsultationResult>
updateDistributedDecisionInfoBasis: (distributedCoordinatorArg: DistributedCoordinator, infoBasisArg: IDistributedDecisionInfoBasis) => Promise<void>
}
export class DistributedCoordinator {
public options: IDistributedCoordinatorConstructorOptions;
constructor(optionsArg: IDistributedCoordinatorConstructorOptions) {
this.options = optionsArg;
}
public async announceDistributedDecisionInfoBasis(infoBasisArg: IDistributedDecisionInfoBasis): Promise<ITaskConsultationResult> {
return this.options.announceDistributedDecisionInfoBasis(this, infoBasisArg);
}
public async updateDistributedDevisionInfoBasis(infoBasisArg: IDistributedDecisionInfoBasis): Promise<void> {
return this.options.updateDistributedDecisionInfoBasis(this, infoBasisArg)
}
}

View File

@ -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);
}
}

View File

@ -1,29 +1,157 @@
import * as plugins from './taskbuffer.plugins'; import * as plugins from './taskbuffer.plugins.js';
import * as helpers from './taskbuffer.classes.helpers'; import { BufferRunner } from './taskbuffer.classes.bufferrunner.js';
import { CycleCounter } from './taskbuffer.classes.cyclecounter.js';
import { logger } from './taskbuffer.logging.js';
export interface ITaskFunction { export interface ITaskFunction {
(x?: any): PromiseLike<any>; (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?: 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;
/**
* the version of the task
* should follow semver
* might be important for DistributedCoordinator
*/
public version: string;
public taskFunction: ITaskFunction;
public buffered: boolean;
public cronJob: plugins.smarttime.CronJob;
public bufferMax: number;
public execDelay: number;
public timeout: number;
// tasks to run before and after // tasks to run before and after
preTask: Task; public preTask: Task | TPreOrAfterTaskFunction;
afterTask: Task; public afterTask: Task | TPreOrAfterTaskFunction;
// initialize by default // 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'; private _state: string = 'ready';
constructor(optionsArg: { constructor(optionsArg: {
@ -34,11 +162,11 @@ export class Task {
/** /**
* any other task to run before * any other task to run before
*/ */
preTask?: Task; preTask?: Task | TPreOrAfterTaskFunction;
/** /**
* any other task to run after * any other task to run after
*/ */
afterTask?: Task; afterTask?: Task | TPreOrAfterTaskFunction;
/** /**
* wether this task should run buffered * wether this task should run buffered
*/ */
@ -70,7 +198,7 @@ export class Task {
/** /**
* trigger the task. Will trigger buffered if this.buffered is true * trigger the task. Will trigger buffered if this.buffered is true
*/ */
trigger(x?): Promise<any> { public trigger(x?: any): Promise<any> {
if (this.buffered) { if (this.buffered) {
return this.triggerBuffered(x); return this.triggerBuffered(x);
} else { } else {
@ -80,15 +208,17 @@ export class Task {
/** /**
* trigger task unbuffered. * trigger task unbuffered.
* will actually run the task, not considering any buffered limits.
*/ */
triggerUnBuffered(x?): Promise<any> { public triggerUnBuffered(x?: any): Promise<any> {
return helpers.runTask(this, { x: x }); return Task.runTask(this, { x: x });
} }
/** /**
* trigger task buffered. * trigger task buffered.
* note: .trigger() also calls this function
*/ */
triggerBuffered(x?): Promise<any> { public triggerBuffered(x?: any): Promise<any> {
return this.bufferRunner.trigger(x); return this.bufferRunner.trigger(x);
} }
@ -100,7 +230,7 @@ export class Task {
if (stateArg === 'locked') { if (stateArg === 'locked') {
this._state = 'locked'; this._state = 'locked';
} else { } else {
plugins.smartlog.defaultLogger.error('state type ' + stateArg + ' could not be set'); logger.log('error', `state type ${stateArg} could not be set`);
} }
} }
} }

View File

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

View File

@ -0,0 +1,27 @@
import * as plugins from './taskbuffer.plugins.js';
import { Task, ITaskFunction } from './taskbuffer.classes.task.js';
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);
});
}
}

View File

@ -1,22 +1,36 @@
import * as plugins from './taskbuffer.plugins'; import * as plugins from './taskbuffer.plugins.js';
import { Task } from './taskbuffer.classes.task'; import { Task } from './taskbuffer.classes.task.js';
import { DistributedCoordinator } from './taskbuffer.classes.distributedcoordinator.js';
// interfaces export interface ICronJob {
import { Objectmap } from '@pushrocks/lik'; cronString: string;
taskNameArg: string;
job: any;
}
export interface ITaskManagerConstructorOptions {
distributedCoordinator?: DistributedCoordinator
}
export class TaskManager { export class TaskManager {
taskMap = new plugins.lik.Objectmap<Task>(); public randomId = plugins.isounique.uni();
private cronJobMap = new plugins.lik.Objectmap<ICronJob>(); public taskMap = new plugins.lik.ObjectMap<Task>();
constructor() { private cronJobManager = new plugins.smarttime.CronManager();
// nothing here
public options: ITaskManagerConstructorOptions = {
distributedCoordinator: null
};
constructor(optionosArg: ITaskManagerConstructorOptions = {}) {
this.options = Object.assign(this.options, optionosArg);
} }
/** /**
* checks if a task is already present * checks if a task is already present
* @param taskNameArg * @param taskNameArg
*/ */
getTaskByName(taskNameArg): Task { public getTaskByName(taskNameArg: string): Task {
return this.taskMap.find(itemArg => { return this.taskMap.findSync((itemArg) => {
return itemArg.name === taskNameArg; return itemArg.name === taskNameArg;
}); });
} }
@ -25,7 +39,7 @@ export class TaskManager {
* adds a Task to the TaskManager * adds a Task to the TaskManager
* @param taskArg * @param taskArg
*/ */
addTask(taskArg: Task): void { public addTask(taskArg: Task): void {
if (!taskArg.name) { if (!taskArg.name) {
throw new Error('taskArg needs a name to be added to taskManager'); throw new Error('taskArg needs a name to be added to taskManager');
} }
@ -37,59 +51,105 @@ export class TaskManager {
* @param taskArg * @param taskArg
* @param cronStringArg * @param cronStringArg
*/ */
addAndScheduleTask(taskArg: Task, cronStringArg: string) { public addAndScheduleTask(taskArg: Task, cronStringArg: string) {
this.addTask(taskArg); this.addTask(taskArg);
let taskName = taskArg.name; this.scheduleTaskByName(taskArg.name, cronStringArg);
this.scheduleTaskByName(taskName, cronStringArg);
} }
/** /**
* triggers a task in the TaskManagerByName * triggers a task in the TaskManagerByName
* @param taskNameArg * @param taskNameArg
*/ */
triggerTaskByName(taskNameArg: string): Promise<any> { public triggerTaskByName(taskNameArg: string): Promise<any> {
let taskToTrigger = this.getTaskByName(taskNameArg); const taskToTrigger = this.getTaskByName(taskNameArg);
if (!taskToTrigger) { if (!taskToTrigger) {
throw new Error(`There is no task with the name of ${taskNameArg}`); throw new Error(`There is no task with the name of ${taskNameArg}`);
} }
return taskToTrigger.trigger(); return taskToTrigger.trigger();
} }
public async triggerTask(task: Task) {
return task.trigger();
}
/** /**
* schedules the task by name * schedules the task by name
* @param taskNameArg * @param taskNameArg
*/ */
scheduleTaskByName(taskNameArg: string, cronStringArg: string) { public scheduleTaskByName(taskNameArg: string, cronStringArg: string) {
let taskToSchedule = this.getTaskByName(taskNameArg); const taskToSchedule = this.getTaskByName(taskNameArg);
let job = new plugins.cron.CronJob({ const cronJob = this.cronJobManager.addCronjob(cronStringArg, async (triggerTimeArg: number) => {
cronTime: cronStringArg, console.log(`taskbuffer schedule triggered task >>${taskToSchedule.name}<<`);
onTick: () => { console.log(
this.triggerTaskByName(taskNameArg); `task >>${taskToSchedule.name}<< is ${
}, taskToSchedule.buffered
start: true ? `buffered with max ${taskToSchedule.bufferMax} buffered calls`
}); : `unbuffered`
this.cronJobMap.add({ }`
taskNameArg: taskToSchedule.name, );
cronString: cronStringArg, if (this.options.distributedCoordinator) {
job: job console.log(`Found a distrubuted coordinator, performing distributed consultation.`);
const announcementResult = await this.options.distributedCoordinator.announceDistributedDecisionInfoBasis({
submitterRandomId: this.randomId,
status: 'requesting',
taskExecutionParallel: 1,
taskExecutionTime: triggerTimeArg,
taskExecutionTimeout: taskToSchedule.timeout,
taskName: taskToSchedule.name,
taskVersion: taskToSchedule.version,
});
if (!announcementResult.shouldTrigger) {
console.log('distributed coordinator result: NOT EXECUTING')
return;
} else {
console.log('distributed coordinator result: CHOSEN AND EXECUTING')
}
}
await taskToSchedule.trigger();
}); });
taskToSchedule.cronJob = cronJob;
} }
descheduleTaskByName(taskNameArg: string) { /**
let descheduledCron = this.cronJobMap.findOneAndRemove(itemArg => { * deschedules a task by name
return itemArg.taskNameArg === taskNameArg; * @param taskNameArg
}); */
descheduledCron.job.stop(); public descheduleTaskByName(taskNameArg: string) {
const taskToDeSchedule = this.getTaskByName(taskNameArg);
if (taskToDeSchedule.cronJob) {
this.cronJobManager.removeCronjob(taskToDeSchedule.cronJob);
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 * returns all schedules of a specific task
* @param taskNameArg * @param taskNameArg
*/ */
getSchedulesForTaskName(taskNameArg: string) {} public getSchedulesForTaskName(taskNameArg: string) {}
}
export interface ICronJob { /**
cronString: string; * starts the taskmanager
taskNameArg: string; */
job: any; public start() {
this.cronJobManager.start();
}
/**
* stops the taskmanager
*/
public stop() {
this.cronJobManager.stop();
}
} }

View File

@ -1,6 +1,6 @@
import * as plugins from './taskbuffer.plugins'; import * as plugins from './taskbuffer.plugins.js';
import { Task, ITaskFunction } from './taskbuffer.classes.task'; import { Task, ITaskFunction } from './taskbuffer.classes.task.js';
/** /**
* TaskOnce is run exactly once, no matter how often it is triggered * TaskOnce is run exactly once, no matter how often it is triggered
@ -15,7 +15,7 @@ export class TaskOnce extends Task {
this.hasTriggered = true; this.hasTriggered = true;
await optionsArg.taskFunction(); await optionsArg.taskFunction();
} }
} },
}); });
} }
} }

View File

@ -1,23 +1,22 @@
import * as plugins from './taskbuffer.plugins'; import * as plugins from './taskbuffer.plugins.js';
import * as helpers from './taskbuffer.classes.helpers'; import { Task } from './taskbuffer.classes.task.js';
import { Task } from './taskbuffer.classes.task';
export class Taskparallel extends Task { export class Taskparallel extends Task {
taskArray: Task[]; public taskArray: Task[];
constructor(optionsArg: { taskArray: Task[] }) { constructor(optionsArg: { taskArray: Task[] }) {
const options = { const options = {
...optionsArg, ...optionsArg,
...{ ...{
taskFunction: () => { 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()); promiseArray.push(taskArg.trigger());
}); });
Promise.all(promiseArray).then(done.resolve); Promise.all(promiseArray).then(done.resolve);
return done.promise; return done.promise;
} },
} },
}; };
super(options); super(options);
this.taskArray = optionsArg.taskArray; this.taskArray = optionsArg.taskArray;

View File

@ -0,0 +1,63 @@
import * as plugins from './taskbuffer.plugins.js';
import { Task } from './taskbuffer.classes.task.js';
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';
}
}

3
ts/taskbuffer.logging.ts Normal file
View File

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

View File

@ -1,8 +1,9 @@
import * as smartlog from '@pushrocks/smartlog'; import * as isounique from '@pushrocks/isounique';
let cron = require('cron');
import * as lik from '@pushrocks/lik'; import * as lik from '@pushrocks/lik';
import * as rxjs from 'rxjs'; import * as smartlog from '@pushrocks/smartlog';
import * as smartpromise from '@pushrocks/smartpromise'; import * as smartpromise from '@pushrocks/smartpromise';
import * as smartdelay from '@pushrocks/smartdelay'; 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 { isounique, lik, smartlog, smartpromise, smartdelay, smartrx, smarttime };

10
tsconfig.json Normal file
View File

@ -0,0 +1,10 @@
{
"compilerOptions": {
"experimentalDecorators": true,
"useDefineForClassFields": false,
"target": "ES2022",
"module": "ES2022",
"moduleResolution": "nodenext",
"esModuleInterop": true
}
}

View File

@ -1,3 +0,0 @@
{
"extends": "tslint-config-standard"
}