Compare commits
13 Commits
Author | SHA1 | Date | |
---|---|---|---|
3f749dfdd2 | |||
2a39543a75 | |||
68f7d26d3b | |||
6373a74fb3 | |||
be3d2d41d6 | |||
2affa189a7 | |||
8c4c2a552c | |||
eff9c6e6c9 | |||
4c7a373d98 | |||
6b93a2e7ac | |||
9c6487c779 | |||
e3f37f5027 | |||
1152bb1138 |
24
.gitignore
vendored
24
.gitignore
vendored
@ -1,4 +1,22 @@
|
|||||||
coverage/
|
|
||||||
node_modules
|
|
||||||
pages/
|
|
||||||
.nogit/
|
.nogit/
|
||||||
|
|
||||||
|
# artifacts
|
||||||
|
coverage/
|
||||||
|
public/
|
||||||
|
pages/
|
||||||
|
|
||||||
|
# installs
|
||||||
|
node_modules/
|
||||||
|
|
||||||
|
# caches
|
||||||
|
.yarn/
|
||||||
|
.cache/
|
||||||
|
.rpt2_cache
|
||||||
|
|
||||||
|
# builds
|
||||||
|
dist/
|
||||||
|
dist_web/
|
||||||
|
dist_serve/
|
||||||
|
dist_ts_web/
|
||||||
|
|
||||||
|
# custom
|
@ -1,5 +1,5 @@
|
|||||||
# gitzone standard
|
# gitzone ci_default
|
||||||
image: hosttoday/ht-docker-node:npmci
|
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
|
|
||||||
cache:
|
cache:
|
||||||
paths:
|
paths:
|
||||||
@ -26,6 +26,7 @@ mirror:
|
|||||||
snyk:
|
snyk:
|
||||||
stage: security
|
stage: security
|
||||||
script:
|
script:
|
||||||
|
- npmci npm prepare
|
||||||
- npmci command npm install -g snyk
|
- npmci command npm install -g snyk
|
||||||
- npmci command npm install --ignore-scripts
|
- npmci command npm install --ignore-scripts
|
||||||
- npmci command snyk test
|
- npmci command snyk test
|
||||||
@ -36,44 +37,35 @@ snyk:
|
|||||||
# ====================
|
# ====================
|
||||||
# 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
|
|
||||||
script:
|
|
||||||
- npmci node install lts
|
|
||||||
- npmci npm install
|
|
||||||
- npmci npm test
|
|
||||||
coverage: /\d+.?\d+?\%\s*coverage/
|
|
||||||
tags:
|
|
||||||
- docker
|
|
||||||
- notpriv
|
|
||||||
|
|
||||||
testSTABLE:
|
|
||||||
stage: test
|
stage: test
|
||||||
script:
|
script:
|
||||||
|
- npmci npm prepare
|
||||||
- npmci node install stable
|
- npmci node install stable
|
||||||
- npmci npm install
|
- npmci npm install
|
||||||
- npmci npm test
|
- npmci npm test
|
||||||
coverage: /\d+.?\d+?\%\s*coverage/
|
coverage: /\d+.?\d+?\%\s*coverage/
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- docker
|
||||||
|
- priv
|
||||||
|
|
||||||
|
testBuild:
|
||||||
|
stage: test
|
||||||
|
script:
|
||||||
|
- npmci npm prepare
|
||||||
|
- npmci node install lts
|
||||||
|
- npmci npm install
|
||||||
|
- npmci command npm run build
|
||||||
|
coverage: /\d+.?\d+?\%\s*coverage/
|
||||||
|
tags:
|
||||||
|
- docker
|
||||||
- notpriv
|
- notpriv
|
||||||
|
|
||||||
release:
|
release:
|
||||||
stage: release
|
stage: release
|
||||||
script:
|
script:
|
||||||
- npmci node install stable
|
- npmci node install lts
|
||||||
- npmci npm publish
|
- npmci npm publish
|
||||||
only:
|
only:
|
||||||
- tags
|
- tags
|
||||||
@ -86,19 +78,11 @@ release:
|
|||||||
# ====================
|
# ====================
|
||||||
codequality:
|
codequality:
|
||||||
stage: metadata
|
stage: metadata
|
||||||
image: docker:stable
|
|
||||||
allow_failure: true
|
allow_failure: true
|
||||||
services:
|
|
||||||
- docker:stable-dind
|
|
||||||
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 install
|
||||||
--env SOURCE_CODE="$PWD"
|
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
|
||||||
--volume "$PWD":/code
|
|
||||||
--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
|
- docker
|
||||||
- priv
|
- priv
|
||||||
@ -114,12 +98,15 @@ trigger:
|
|||||||
- notpriv
|
- notpriv
|
||||||
|
|
||||||
pages:
|
pages:
|
||||||
image: hosttoday/ht-docker-node:npmci
|
image: hosttoday/ht-docker-dbase:npmci
|
||||||
|
services:
|
||||||
|
- docker:stable-dind
|
||||||
stage: metadata
|
stage: metadata
|
||||||
script:
|
script:
|
||||||
- npmci command npm install -g typedoc typescript
|
- 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:
|
||||||
- docker
|
- docker
|
||||||
- notpriv
|
- notpriv
|
||||||
@ -130,13 +117,3 @@ pages:
|
|||||||
paths:
|
paths:
|
||||||
- public
|
- public
|
||||||
allow_failure: true
|
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
|
|
||||||
|
@ -1,12 +1,17 @@
|
|||||||
{
|
{
|
||||||
"npmts":{
|
|
||||||
"mode":"default",
|
|
||||||
"testConfig": {
|
|
||||||
"parallel": false
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"npmci": {
|
"npmci": {
|
||||||
"npmGlobalTools": [],
|
"npmGlobalTools": [],
|
||||||
"npmAccessLevel": "public"
|
"npmAccessLevel": "public",
|
||||||
|
"npmRegistryUrl": "registry.npmjs.org"
|
||||||
|
},
|
||||||
|
"gitzone": {
|
||||||
|
"module": {
|
||||||
|
"githost": "gitlab.com",
|
||||||
|
"gitscope": "pushrocks",
|
||||||
|
"gitrepo": "taskbuffer",
|
||||||
|
"shortDescription": "flexible task management. TypeScript ready!",
|
||||||
|
"npmPackagename": "@pushrocks/taskbuffer",
|
||||||
|
"license": "MIT"
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
1542
package-lock.json
generated
1542
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
39
package.json
39
package.json
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@pushrocks/taskbuffer",
|
"name": "@pushrocks/taskbuffer",
|
||||||
"version": "2.0.4",
|
"version": "2.0.11",
|
||||||
"private": false,
|
"private": false,
|
||||||
"description": "flexible task management. TypeScript ready!",
|
"description": "flexible task management. TypeScript ready!",
|
||||||
"main": "dist/index.js",
|
"main": "dist/index.js",
|
||||||
@ -27,18 +27,31 @@
|
|||||||
},
|
},
|
||||||
"homepage": "https://gitlab.com/pushrocks/taskbuffer#readme",
|
"homepage": "https://gitlab.com/pushrocks/taskbuffer#readme",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@pushrocks/lik": "^3.0.1",
|
"@pushrocks/lik": "^3.0.11",
|
||||||
"@pushrocks/smartdelay": "^2.0.1",
|
"@pushrocks/smartdelay": "^2.0.3",
|
||||||
"@pushrocks/smartlog": "^2.0.1",
|
"@pushrocks/smartlog": "^2.0.19",
|
||||||
"@pushrocks/smartpromise": "^2.0.5",
|
"@pushrocks/smartpromise": "^3.0.5",
|
||||||
"@types/cron": "^1.3.0",
|
"@types/cron": "^1.7.1",
|
||||||
"cron": "^1.3.0",
|
"cron": "^1.7.2",
|
||||||
"rxjs": "^6.2.2"
|
"rxjs": "^6.5.3"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@gitzone/tsbuild": "^2.0.22",
|
"@gitzone/tsbuild": "^2.1.17",
|
||||||
"@gitzone/tstest": "^1.0.11",
|
"@gitzone/tstest": "^1.0.24",
|
||||||
"@pushrocks/tapbundle": "^3.0.1",
|
"@pushrocks/tapbundle": "^3.0.13",
|
||||||
"@types/node": "^10.5.6"
|
"@types/node": "^12.7.5",
|
||||||
}
|
"tslint": "^5.20.0",
|
||||||
|
"tslint-config-prettier": "^1.18.0"
|
||||||
|
},
|
||||||
|
"files": [
|
||||||
|
"ts/*",
|
||||||
|
"ts_web/*",
|
||||||
|
"dist/*",
|
||||||
|
"dist_web/*",
|
||||||
|
"dist_ts_web/*",
|
||||||
|
"assets/*",
|
||||||
|
"cli.js",
|
||||||
|
"npmextra.json",
|
||||||
|
"readme.md"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
|
77
readme.md
77
readme.md
@ -1,64 +1,22 @@
|
|||||||
# 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)
|
||||||
[](https://www.npmjs.com/package/taskbuffer)
|
* [gitlab.com (source)](https://gitlab.com/pushrocks/taskbuffer)
|
||||||
[](https://GitLab.com/pushrocks/taskbuffer)
|
* [github.com (source mirror)](https://github.com/pushrocks/taskbuffer)
|
||||||
[](https://github.com/pushrocks/taskbuffer)
|
* [docs (typedoc)](https://pushrocks.gitlab.io/taskbuffer/)
|
||||||
[](https://pushrocks.gitlab.io/taskbuffer/)
|
|
||||||
|
|
||||||
## Status for master
|
## Status for master
|
||||||
|
[](https://gitlab.com/pushrocks/taskbuffer/commits/master)
|
||||||
|
[](https://gitlab.com/pushrocks/taskbuffer/commits/master)
|
||||||
|
[](https://www.npmjs.com/package/@pushrocks/taskbuffer)
|
||||||
|
[](https://snyk.io/test/npm/@pushrocks/taskbuffer)
|
||||||
|
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||||
|
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||||
|
[](https://prettier.io/)
|
||||||
|
|
||||||
[](https://GitLab.com/pushrocks/taskbuffer/commits/master)
|
## Usage
|
||||||
[](https://GitLab.com/pushrocks/taskbuffer/commits/master)
|
|
||||||
[](https://www.npmjs.com/package/taskbuffer)
|
|
||||||
[](https://david-dm.org/pushrocks/taskbuffer)
|
|
||||||
[](https://www.bithound.io/github/pushrocks/taskbuffer/master/dependencies/npm)
|
|
||||||
[](https://www.bithound.io/github/pushrocks/taskbuffer)
|
|
||||||
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
|
||||||
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
|
||||||
[](http://standardjs.com/)
|
|
||||||
|
|
||||||
## Install
|
|
||||||
|
|
||||||
```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 +43,10 @@ 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)
|
||||||
|
|
||||||
[](https://push.rocks)
|
[](https://push.rocks)
|
||||||
|
|
||||||
|
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)
|
||||||
|
|
||||||
|
[](https://maintainedby.lossless.com)
|
||||||
|
@ -8,11 +8,8 @@ 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
|
||||||
});
|
});
|
||||||
@ -35,14 +32,14 @@ let task1 = new taskbuffer.Task({
|
|||||||
|
|
||||||
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;
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
import { expect, tap } from '@pushrocks/tapbundle';
|
import { expect, tap } from '@pushrocks/tapbundle';
|
||||||
import taskbuffer = require('../ts/index');
|
import taskbuffer = require('../ts/index');
|
||||||
|
|
||||||
import * as smartq from 'smartq';
|
import * as smartpromise from '@pushrocks/smartpromise';
|
||||||
import * as smartdelay from '@pushrocks/smartdelay';
|
import * as smartdelay from '@pushrocks/smartdelay';
|
||||||
|
|
||||||
let task1Executed = false;
|
let task1Executed = false;
|
||||||
|
@ -1,11 +1,9 @@
|
|||||||
import { expect, tap } from '@pushrocks/tapbundle';
|
import { expect, tap } from '@pushrocks/tapbundle';
|
||||||
import taskbuffer = require('../ts/index');
|
import taskbuffer = require('../ts/index');
|
||||||
|
|
||||||
import * as smartq from 'smartq';
|
|
||||||
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;
|
||||||
@ -13,7 +11,7 @@ let task1 = new taskbuffer.Task({
|
|||||||
});
|
});
|
||||||
|
|
||||||
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;
|
||||||
@ -21,7 +19,7 @@ let task2 = new taskbuffer.Task({
|
|||||||
});
|
});
|
||||||
|
|
||||||
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;
|
||||||
@ -29,7 +27,7 @@ let task3 = new taskbuffer.Task({
|
|||||||
});
|
});
|
||||||
|
|
||||||
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();
|
||||||
|
@ -6,7 +6,7 @@ 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();
|
||||||
|
@ -4,9 +4,9 @@ import taskbuffer = require('../ts/index');
|
|||||||
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);
|
||||||
@ -14,9 +14,9 @@ let flowTask1 = new taskbuffer.Task({
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
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);
|
||||||
@ -26,9 +26,9 @@ let flowTaskBuffered = new taskbuffer.Task({
|
|||||||
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);
|
||||||
@ -37,27 +37,27 @@ let flowTask2 = new taskbuffer.Task({
|
|||||||
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).to.equal(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).to.equal(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).to.equal(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).to.equal(12);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
@ -1,13 +1,13 @@
|
|||||||
import plugins = require('./taskbuffer.plugins');
|
import plugins = require('./taskbuffer.plugins');
|
||||||
import { Task, ITaskFunction } from './taskbuffer.classes.task';
|
import { Task, ITaskFunction } from './taskbuffer.classes.task';
|
||||||
|
|
||||||
export let emptyTaskFunction: ITaskFunction = function(x) {
|
export const emptyTaskFunction: ITaskFunction = function(x) {
|
||||||
let done = plugins.smartpromise.defer();
|
const done = plugins.smartpromise.defer();
|
||||||
done.resolve();
|
done.resolve();
|
||||||
return done.promise;
|
return done.promise;
|
||||||
};
|
};
|
||||||
|
|
||||||
export let isTask = function(taskArg: Task): boolean {
|
export const isTask = (taskArg: Task): boolean => {
|
||||||
if (taskArg instanceof Task && typeof taskArg.taskFunction === 'function') {
|
if (taskArg instanceof Task && typeof taskArg.taskFunction === 'function') {
|
||||||
return true;
|
return true;
|
||||||
} else {
|
} else {
|
||||||
@ -15,9 +15,9 @@ export let isTask = function(taskArg: Task): boolean {
|
|||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
export let isTaskTouched = (taskArg: Task, touchedTasksArray: Task[]): boolean => {
|
export const isTaskTouched = (taskArg: Task, touchedTasksArray: Task[]): boolean => {
|
||||||
let result = false;
|
let result = false;
|
||||||
for (let keyArg in touchedTasksArray) {
|
for (const keyArg in touchedTasksArray) {
|
||||||
if (taskArg === touchedTasksArray[keyArg]) {
|
if (taskArg === touchedTasksArray[keyArg]) {
|
||||||
result = true;
|
result = true;
|
||||||
}
|
}
|
||||||
@ -25,8 +25,8 @@ export let isTaskTouched = (taskArg: Task, touchedTasksArray: Task[]): boolean =
|
|||||||
return result;
|
return result;
|
||||||
};
|
};
|
||||||
|
|
||||||
export let runTask = async (taskArg: Task, optionsArg: { x?; touchedTasksArray?: Task[] }) => {
|
export const runTask = async (taskArg: Task, optionsArg: { x?; touchedTasksArray?: Task[] }) => {
|
||||||
let done = plugins.smartpromise.defer();
|
const done = plugins.smartpromise.defer();
|
||||||
|
|
||||||
// pay respect to execDelay
|
// pay respect to execDelay
|
||||||
if (taskArg.execDelay) {
|
if (taskArg.execDelay) {
|
||||||
@ -41,35 +41,41 @@ export let runTask = async (taskArg: Task, optionsArg: { x?; touchedTasksArray?:
|
|||||||
});
|
});
|
||||||
|
|
||||||
// handle options
|
// handle options
|
||||||
let options = {
|
const options = {
|
||||||
...{ x: undefined, touchedTasksArray: [] },
|
...{ x: undefined, touchedTasksArray: [] },
|
||||||
...optionsArg
|
...optionsArg
|
||||||
};
|
};
|
||||||
let x = options.x;
|
const x = options.x;
|
||||||
let touchedTasksArray: Task[] = options.touchedTasksArray;
|
const touchedTasksArray: Task[] = options.touchedTasksArray;
|
||||||
|
|
||||||
touchedTasksArray.push(taskArg);
|
touchedTasksArray.push(taskArg);
|
||||||
|
|
||||||
// run the task cascade
|
// run the task cascade
|
||||||
let localDeferred = plugins.smartpromise.defer();
|
const localDeferred = plugins.smartpromise.defer();
|
||||||
localDeferred.promise
|
localDeferred.promise
|
||||||
.then(() => {
|
.then(() => {
|
||||||
|
// lets run any preTask
|
||||||
if (taskArg.preTask && !isTaskTouched(taskArg.preTask, touchedTasksArray)) {
|
if (taskArg.preTask && !isTaskTouched(taskArg.preTask, touchedTasksArray)) {
|
||||||
return runTask(taskArg.preTask, { x: x, touchedTasksArray: touchedTasksArray });
|
return runTask(taskArg.preTask, { x, touchedTasksArray });
|
||||||
} else {
|
} else {
|
||||||
let done2 = plugins.smartpromise.defer();
|
const done2 = plugins.smartpromise.defer();
|
||||||
done2.resolve(x);
|
done2.resolve(x);
|
||||||
return done2.promise;
|
return done2.promise;
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
.then(x => {
|
.then(async x => {
|
||||||
return taskArg.taskFunction(x);
|
// lets run the main task
|
||||||
|
try {
|
||||||
|
return await taskArg.taskFunction(x);
|
||||||
|
} catch (e) {
|
||||||
|
console.log(e);
|
||||||
|
}
|
||||||
})
|
})
|
||||||
.then(x => {
|
.then(x => {
|
||||||
if (taskArg.afterTask && !isTaskTouched(taskArg.afterTask, touchedTasksArray)) {
|
if (taskArg.afterTask && !isTaskTouched(taskArg.afterTask, touchedTasksArray)) {
|
||||||
return runTask(taskArg.afterTask, { x: x, touchedTasksArray: touchedTasksArray });
|
return runTask(taskArg.afterTask, { x: x, touchedTasksArray: touchedTasksArray });
|
||||||
} else {
|
} else {
|
||||||
let done2 = plugins.smartpromise.defer();
|
const done2 = plugins.smartpromise.defer();
|
||||||
done2.resolve(x);
|
done2.resolve(x);
|
||||||
return done2.promise;
|
return done2.promise;
|
||||||
}
|
}
|
||||||
@ -96,8 +102,8 @@ export class CycleCounter {
|
|||||||
this.task = taskArg;
|
this.task = taskArg;
|
||||||
}
|
}
|
||||||
getPromiseForCycle(cycleCountArg: number) {
|
getPromiseForCycle(cycleCountArg: number) {
|
||||||
let done = plugins.smartpromise.defer();
|
const done = plugins.smartpromise.defer();
|
||||||
let cycleObject: cycleObject = {
|
const cycleObject: cycleObject = {
|
||||||
cycleCounter: cycleCountArg,
|
cycleCounter: cycleCountArg,
|
||||||
deferred: done
|
deferred: done
|
||||||
};
|
};
|
||||||
@ -105,7 +111,7 @@ export class CycleCounter {
|
|||||||
return done.promise;
|
return done.promise;
|
||||||
}
|
}
|
||||||
informOfCycle(x) {
|
informOfCycle(x) {
|
||||||
let newCycleObjectArray: cycleObject[] = [];
|
const newCycleObjectArray: cycleObject[] = [];
|
||||||
this.cycleObjectArray.forEach(cycleObjectArg => {
|
this.cycleObjectArray.forEach(cycleObjectArg => {
|
||||||
cycleObjectArg.cycleCounter--;
|
cycleObjectArg.cycleCounter--;
|
||||||
if (cycleObjectArg.cycleCounter <= 0) {
|
if (cycleObjectArg.cycleCounter <= 0) {
|
||||||
@ -131,7 +137,7 @@ export class BufferRunner {
|
|||||||
if (!(this.bufferCounter >= this.task.bufferMax)) {
|
if (!(this.bufferCounter >= this.task.bufferMax)) {
|
||||||
this.bufferCounter++;
|
this.bufferCounter++;
|
||||||
}
|
}
|
||||||
let returnPromise: Promise<any> = this.task.cycleCounter.getPromiseForCycle(
|
const returnPromise: Promise<any> = this.task.cycleCounter.getPromiseForCycle(
|
||||||
this.bufferCounter + 1
|
this.bufferCounter + 1
|
||||||
);
|
);
|
||||||
if (!this.running) {
|
if (!this.running) {
|
||||||
@ -141,7 +147,7 @@ export class BufferRunner {
|
|||||||
}
|
}
|
||||||
|
|
||||||
private _run(x) {
|
private _run(x) {
|
||||||
let recursiveBufferRunner = x => {
|
const recursiveBufferRunner = x => {
|
||||||
if (this.bufferCounter >= 0) {
|
if (this.bufferCounter >= 0) {
|
||||||
this.running = true;
|
this.running = true;
|
||||||
this.task.running = true;
|
this.task.running = true;
|
||||||
|
@ -100,7 +100,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');
|
plugins.smartlog.defaultLogger.log('error', 'state type ' + stateArg + ' could not be set');
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -29,7 +29,7 @@ export class Taskchain extends Task {
|
|||||||
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);
|
plugins.smartlog.defaultLogger.log('info', this.taskArray[taskCounter].name);
|
||||||
taskCounter++;
|
taskCounter++;
|
||||||
iterateTasks(x);
|
iterateTasks(x);
|
||||||
});
|
});
|
||||||
|
@ -1,12 +1,16 @@
|
|||||||
import * as plugins from './taskbuffer.plugins';
|
import * as plugins from './taskbuffer.plugins';
|
||||||
import { Task } from './taskbuffer.classes.task';
|
import { Task } from './taskbuffer.classes.task';
|
||||||
|
|
||||||
// interfaces
|
export interface ICronJob {
|
||||||
import { Objectmap } from '@pushrocks/lik';
|
cronString: string;
|
||||||
|
taskNameArg: string;
|
||||||
|
job: any;
|
||||||
|
}
|
||||||
|
|
||||||
export class TaskManager {
|
export class TaskManager {
|
||||||
taskMap = new plugins.lik.Objectmap<Task>();
|
public taskMap = new plugins.lik.Objectmap<Task>();
|
||||||
private cronJobMap = new plugins.lik.Objectmap<ICronJob>();
|
private cronJobMap = new plugins.lik.Objectmap<ICronJob>();
|
||||||
|
|
||||||
constructor() {
|
constructor() {
|
||||||
// nothing here
|
// nothing here
|
||||||
}
|
}
|
||||||
@ -15,7 +19,7 @@ export class TaskManager {
|
|||||||
* checks if a task is already present
|
* checks if a task is already present
|
||||||
* @param taskNameArg
|
* @param taskNameArg
|
||||||
*/
|
*/
|
||||||
getTaskByName(taskNameArg): Task {
|
public getTaskByName(taskNameArg): Task {
|
||||||
return this.taskMap.find(itemArg => {
|
return this.taskMap.find(itemArg => {
|
||||||
return itemArg.name === taskNameArg;
|
return itemArg.name === taskNameArg;
|
||||||
});
|
});
|
||||||
@ -25,7 +29,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,9 +41,9 @@ 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;
|
const taskName = taskArg.name;
|
||||||
this.scheduleTaskByName(taskName, cronStringArg);
|
this.scheduleTaskByName(taskName, cronStringArg);
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -47,21 +51,25 @@ export class TaskManager {
|
|||||||
* 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 job = new plugins.cron.CronJob({
|
||||||
cronTime: cronStringArg,
|
cronTime: cronStringArg,
|
||||||
onTick: () => {
|
onTick: () => {
|
||||||
this.triggerTaskByName(taskNameArg);
|
this.triggerTaskByName(taskNameArg);
|
||||||
@ -71,25 +79,31 @@ export class TaskManager {
|
|||||||
this.cronJobMap.add({
|
this.cronJobMap.add({
|
||||||
taskNameArg: taskToSchedule.name,
|
taskNameArg: taskToSchedule.name,
|
||||||
cronString: cronStringArg,
|
cronString: cronStringArg,
|
||||||
job: job
|
job
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
descheduleTaskByName(taskNameArg: string) {
|
/**
|
||||||
let descheduledCron = this.cronJobMap.findOneAndRemove(itemArg => {
|
* deschedules a task by name
|
||||||
|
* @param taskNameArg
|
||||||
|
*/
|
||||||
|
public descheduleTaskByName(taskNameArg: string) {
|
||||||
|
const descheduledCron = this.cronJobMap.findOneAndRemove(itemArg => {
|
||||||
return itemArg.taskNameArg === taskNameArg;
|
return itemArg.taskNameArg === taskNameArg;
|
||||||
});
|
});
|
||||||
descheduledCron.job.stop();
|
descheduledCron.job.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;
|
|
||||||
taskNameArg: string;
|
|
||||||
job: any;
|
|
||||||
}
|
}
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
import * as smartlog from '@pushrocks/smartlog';
|
import * as smartlog from '@pushrocks/smartlog';
|
||||||
let cron = require('cron');
|
import cron from 'cron';
|
||||||
import * as lik from '@pushrocks/lik';
|
import * as lik from '@pushrocks/lik';
|
||||||
import * as rxjs from 'rxjs';
|
import * as rxjs from 'rxjs';
|
||||||
import * as smartpromise from '@pushrocks/smartpromise';
|
import * as smartpromise from '@pushrocks/smartpromise';
|
||||||
|
16
tslint.json
16
tslint.json
@ -1,3 +1,17 @@
|
|||||||
{
|
{
|
||||||
"extends": "tslint-config-standard"
|
"extends": ["tslint:latest", "tslint-config-prettier"],
|
||||||
|
"rules": {
|
||||||
|
"semicolon": [true, "always"],
|
||||||
|
"no-console": false,
|
||||||
|
"ordered-imports": false,
|
||||||
|
"object-literal-sort-keys": false,
|
||||||
|
"member-ordering": {
|
||||||
|
"options":{
|
||||||
|
"order": [
|
||||||
|
"static-method"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"defaultSeverity": "warning"
|
||||||
}
|
}
|
||||||
|
Reference in New Issue
Block a user