Compare commits

..

38 Commits

Author SHA1 Message Date
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
31 changed files with 18106 additions and 1272 deletions

4
.gitignore vendored
View File

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

View File

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

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

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

18639
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,13 +1,14 @@
{
"name": "@pushrocks/taskbuffer",
"version": "2.0.16",
"version": "3.0.0",
"private": false,
"description": "flexible task management. TypeScript ready!",
"main": "dist/index.js",
"typings": "dist/index.d.ts",
"main": "dist_ts/index.js",
"typings": "dist_ts/index.d.ts",
"type": "module",
"scripts": {
"test": "(tstest test/)",
"build": "(tsbuild)"
"test": "(tstest test/ --web)",
"build": "(tsbuild --web && tsbundle npm)"
},
"repository": {
"type": "git",
@ -27,31 +28,36 @@
},
"homepage": "https://gitlab.com/pushrocks/taskbuffer#readme",
"dependencies": {
"@pushrocks/lik": "^3.0.13",
"@pushrocks/smartdelay": "^2.0.6",
"@pushrocks/smartlog": "^2.0.21",
"@pushrocks/smartpromise": "^3.0.6",
"@types/cron": "^1.7.1",
"cron": "^1.7.2",
"rxjs": "^6.5.3"
"@pushrocks/lik": "^5.0.4",
"@pushrocks/smartdelay": "^2.0.13",
"@pushrocks/smartlog": "^2.0.44",
"@pushrocks/smartpromise": "^3.1.7",
"@pushrocks/smartrx": "^2.0.25",
"@pushrocks/smarttime": "^3.0.45",
"@types/cron": "^1.7.3"
},
"devDependencies": {
"@gitzone/tsbuild": "^2.1.17",
"@gitzone/tstest": "^1.0.28",
"@pushrocks/tapbundle": "^3.2.0",
"@types/node": "^12.12.14",
"tslint": "^5.20.1",
"@gitzone/tsbuild": "^2.1.61",
"@gitzone/tsbundle": "^1.0.101",
"@gitzone/tstest": "^1.0.70",
"@pushrocks/tapbundle": "^5.0.3",
"@types/node": "^17.0.23",
"tslint": "^6.1.3",
"tslint-config-prettier": "^1.18.0"
},
"files": [
"ts/*",
"ts_web/*",
"dist/*",
"dist_web/*",
"dist_ts_web/*",
"assets/*",
"ts/**/*",
"ts_web/**/*",
"dist/**/*",
"dist_*/**/*",
"dist_ts/**/*",
"dist_ts_web/**/*",
"assets/**/*",
"cli.js",
"npmextra.json",
"readme.md"
],
"browserslist": [
"last 1 chrome versions"
]
}

View File

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

View File

@ -1,5 +1,6 @@
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 smartdelay from '@pushrocks/smartdelay';
@ -11,7 +12,7 @@ let testPreTask = new taskbuffer.Task({
taskFunction: async () => {
console.log('preTask executed');
},
preTask: testTask
preTask: testTask,
});
// some more tasks to test with
@ -27,7 +28,7 @@ let task1 = new taskbuffer.Task({
done.resolve();
}, 5000);
return done.promise;
}
},
});
let task2 = new taskbuffer.Task({
@ -40,7 +41,7 @@ let task2 = new taskbuffer.Task({
done.resolve();
}, 5000);
await done.promise;
}
},
});
let task3 = new taskbuffer.Task({
@ -53,7 +54,7 @@ let task3 = new taskbuffer.Task({
done.resolve();
}, 5000);
return done.promise;
}
},
});
tap.test('new Task() should return a new task', async () => {
@ -61,12 +62,12 @@ tap.test('new Task() should return a new task', async () => {
taskFunction: async () => {
console.log('executed twice');
},
preTask: testPreTask
preTask: testPreTask,
});
});
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 () => {
@ -76,13 +77,13 @@ tap.test('expect testTask.idle is true', 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
expect(testTask.running).to.be.false;
expect(testTask.running).toBeFalse();
});
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 () => {
@ -93,7 +94,7 @@ tap.test('expect to run a task without pre and afterTask errorless', async () =>
let localTestTask = new taskbuffer.Task({
taskFunction: async () => {
console.log('only once');
}
},
});
await localTestTask.trigger();
});
@ -104,7 +105,7 @@ tap.test('expect task to run in buffered mode', async () => {
await smartdelay.delayFor(3000);
},
buffered: true,
bufferMax: 2
bufferMax: 2,
});
localTestTask.trigger();
localTestTask.trigger();

View File

@ -1,5 +1,6 @@
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 smartdelay from '@pushrocks/smartdelay';
@ -9,7 +10,7 @@ const task1 = new taskbuffer.Task({
taskFunction: async () => {
await smartdelay.delayFor(2000);
task1Executed = true;
}
},
});
let task2Executed = false;
@ -17,7 +18,7 @@ const task2 = new taskbuffer.Task({
taskFunction: async () => {
await smartdelay.delayFor(2000);
task2Executed = true;
}
},
});
let task3Executed = false;
@ -25,23 +26,23 @@ const task3 = new taskbuffer.Task({
taskFunction: async () => {
await smartdelay.delayFor(2000);
task3Executed = true;
}
},
});
tap.test('expect run tasks in sequence', async () => {
const testTaskchain = new taskbuffer.Taskchain({
name: 'Taskchain1',
taskArray: [task1, task2, task3]
taskArray: [task1, task2, task3],
});
const testPromise = testTaskchain.trigger();
await smartdelay.delayFor(2100);
// tslint:disable-next-line:no-unused-expression
expect(task1Executed).to.be.true;
expect(task1Executed).toBeTrue();
// tslint:disable-next-line:no-unused-expression
expect(task2Executed).to.be.false;
expect(task2Executed).toBeFalse();
await smartdelay.delayFor(2100);
// tslint:disable-next-line:no-unused-expression
expect(task2Executed).to.be.true;
expect(task2Executed).toBeTrue();
await testPromise;
});

View File

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

View File

@ -1,5 +1,6 @@
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 smartdelay from '@pushrocks/smartdelay';
@ -10,7 +11,7 @@ const taskDone = smartpromise.defer();
tap.test('should create an instance of TaskManager', async () => {
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 () => {
@ -18,25 +19,32 @@ tap.test('should run the task as expected', async () => {
myTaskManager.addTask(
new taskbuffer.Task({
name: 'myTask',
bufferMax: 1,
buffered: true,
taskFunction: async () => {
console.log('Task executed!');
console.log('Task "myTask" executed!');
referenceBoolean = true;
taskRunCounter++;
if (taskRunCounter === 10) {
taskDone.resolve();
}
}
},
})
);
myTaskManager.start();
await myTaskManager.triggerTaskByName('myTask');
// tslint:disable-next-line:no-unused-expression
expect(referenceBoolean).to.be.true;
expect(referenceBoolean).toBeTrue();
});
tap.test('should schedule task', async () => {
myTaskManager.scheduleTaskByName('myTask', '* * * * * *');
myTaskManager.scheduleTaskByName('myTask', '*/10 * * * * *');
await taskDone.promise;
myTaskManager.descheduleTaskByName('myTask');
});
tap.test('should stop the taskmanager', async () => {
myTaskManager.stop();
});
tap.start();

View File

@ -1,5 +1,6 @@
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 smartdelay from '@pushrocks/smartdelay';
@ -11,7 +12,7 @@ const flowTask1 = new taskbuffer.Task({
console.log(x);
done.resolve(x);
return done.promise;
}
},
});
const flowTaskBuffered = new taskbuffer.Task({
@ -23,7 +24,7 @@ const flowTaskBuffered = new taskbuffer.Task({
return done.promise;
},
buffered: true,
bufferMax: 1
bufferMax: 1,
});
const flowTask2 = new taskbuffer.Task({
@ -34,31 +35,31 @@ const flowTask2 = new taskbuffer.Task({
done.resolve(x);
return done.promise;
},
preTask: flowTask1
preTask: flowTask1,
});
const flowTask3 = new taskbuffer.Taskchain({
taskArray: [flowTask1, flowTask2]
taskArray: [flowTask1, flowTask2],
});
tap.test('should let a value flow through a task', async () => {
const result = await flowTask1.trigger(12);
expect(result).to.equal(12);
expect(result).toEqual(12);
});
tap.test('expect values to flow between tasks', async () => {
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 () => {
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 () => {
const result = await flowTask3.trigger(12);
expect(result).to.equal(12);
expect(result).toEqual(12);
});
tap.start();

View File

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

View File

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

View File

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

View File

@ -1,42 +1,39 @@
import { Task } from "./taskbuffer.classes.task";
import { Task } from './taskbuffer.classes.task.js';
export class BufferRunner {
public task: Task;
// initialze by default
public bufferCounter: number = 0;
public running: boolean = false;
constructor(taskArg: Task) {
this.task = taskArg;
}
public trigger(x): Promise<any> {
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.running) {
if (!this.task.running) {
this._run(x);
}
return returnPromise;
}
private _run(x) {
const recursiveBufferRunner = x => {
private _run(x: any) {
const recursiveBufferRunner = (x: any) => {
if (this.bufferCounter >= 0) {
this.running = true;
this.task.running = true;
Task.runTask(this.task, { x: x }).then(x => {
this.bufferCounter--;
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.running = false;
this.task.running = false;
}
};
recursiveBufferRunner(x);
}
}
}

View File

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

View File

@ -1,5 +0,0 @@
import plugins = require('./taskbuffer.plugins');
import { Task, ITaskFunction } from './taskbuffer.classes.task';

View File

@ -1,7 +1,8 @@
import * as plugins from './taskbuffer.plugins';
import * as helpers from './taskbuffer.classes.helpers';
import { BufferRunner } from './taskbuffer.classes.bufferrunner';
import { CycleCounter } from './taskbuffer.classes.cyclecounter';
import * as plugins from './taskbuffer.plugins.js';
import { BufferRunner } from './taskbuffer.classes.bufferrunner.js';
import { CycleCounter } from './taskbuffer.classes.cyclecounter.js';
import { logger } from './taskbuffer.logging.js';
export interface ITaskFunction {
(x?: any): PromiseLike<any>;
@ -12,12 +13,12 @@ export type TPreOrAfterTaskFunction = () => Task;
export class Task {
// STATIC
public static extractTask(preOrAfterTaskArg: Task | TPreOrAfterTaskFunction): Task {
switch(true) {
case (!preOrAfterTaskArg):
switch (true) {
case !preOrAfterTaskArg:
return null;
case (preOrAfterTaskArg instanceof Task):
case preOrAfterTaskArg instanceof Task:
return preOrAfterTaskArg as Task;
case typeof preOrAfterTaskArg === "function":
case typeof preOrAfterTaskArg === 'function':
const taskFunction = preOrAfterTaskArg as TPreOrAfterTaskFunction;
return taskFunction();
default:
@ -25,13 +26,12 @@ export class Task {
}
}
public static emptyTaskFunction: ITaskFunction = function(x) {
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;
@ -39,8 +39,11 @@ export class Task {
return false;
}
};
public static isTaskTouched = (taskArg: Task | TPreOrAfterTaskFunction, touchedTasksArray: Task[]): boolean => {
public static isTaskTouched = (
taskArg: Task | TPreOrAfterTaskFunction,
touchedTasksArray: Task[]
): boolean => {
const taskToCheck = Task.extractTask(taskArg);
let result = false;
for (const keyArg in touchedTasksArray) {
@ -50,39 +53,43 @@ export class Task {
}
return result;
};
public static runTask = async (taskArg: Task | TPreOrAfterTaskFunction, optionsArg: { x?; touchedTasksArray?: Task[] }) => {
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
...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 {
@ -91,7 +98,7 @@ export class Task {
return done2.promise;
}
})
.then(async x => {
.then(async (x) => {
// lets run the main task
try {
return await taskToRun.taskFunction(x);
@ -99,7 +106,7 @@ export class Task {
console.log(e);
}
})
.then(x => {
.then((x) => {
if (taskToRun.afterTask && !Task.isTaskTouched(taskToRun.afterTask, touchedTasksArray)) {
return Task.runTask(taskToRun.afterTask, { x: x, touchedTasksArray: touchedTasksArray });
} else {
@ -108,21 +115,22 @@ export class Task {
return done2.promise;
}
})
.then(x => {
.then((x) => {
done.resolve(x);
})
.catch(err => {
.catch((err) => {
console.log(err);
});
localDeferred.resolve();
return await done.promise;
}
};
// INSTANCE
// man datory properties
// mandatory properties
public name: string;
public taskFunction: ITaskFunction;
public buffered: boolean;
public cronJob: plugins.smarttime.CronJob;
public bufferMax: number;
public execDelay: number;
@ -183,7 +191,7 @@ export class Task {
/**
* trigger the task. Will trigger buffered if this.buffered is true
*/
public trigger(x?): Promise<any> {
public trigger(x?: any): Promise<any> {
if (this.buffered) {
return this.triggerBuffered(x);
} else {
@ -193,15 +201,17 @@ export class Task {
/**
* trigger task unbuffered.
* will actually run the task, not considering any buffered limits.
*/
public triggerUnBuffered(x?): Promise<any> {
public triggerUnBuffered(x?: any): Promise<any> {
return Task.runTask(this, { x: x });
}
/**
* trigger task buffered.
* note: .trigger() also calls this function
*/
public triggerBuffered(x?): Promise<any> {
public triggerBuffered(x?: any): Promise<any> {
return this.bufferRunner.trigger(x);
}
@ -213,7 +223,7 @@ export class Task {
if (stateArg === 'locked') {
this._state = 'locked';
} else {
plugins.smartlog.defaultLogger.log('error', 'state type ' + stateArg + ' could not be set');
logger.log('error', `state type ${stateArg} could not be set`);
}
}
}

View File

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

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

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

View File

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

View File

@ -1,18 +1,25 @@
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';
export class TaskRunner {
public maxParrallelJobs: number = 1;
public status: 'stopped' | 'running' = 'stopped';
public runningTasks: plugins.lik.Objectmap<Task> = new plugins.lik.Objectmap<Task>();
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();
}
/**
@ -26,23 +33,31 @@ export class TaskRunner {
/**
* starts the task queue
*/
public start() {
public async start() {
this.status = 'running';
}
/**
* checks wether execution is on point
*/
public async checkExecution() {
if (this.runningTasks.getArray().length < this.maxParrallelJobs) {
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 stop() {
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,8 @@
import * as smartlog from '@pushrocks/smartlog';
import cron from 'cron';
import * as lik from '@pushrocks/lik';
import * as rxjs from 'rxjs';
import * as smartpromise from '@pushrocks/smartpromise';
import * as smartdelay from '@pushrocks/smartdelay';
import * as smartrx from '@pushrocks/smartrx';
import * as smarttime from '@pushrocks/smarttime';
export { smartlog, cron, lik, rxjs, smartpromise, smartdelay };
export { smartlog, lik, smartpromise, smartdelay, smartrx, smarttime };

View File

@ -1,17 +0,0 @@
{
"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"
}