Compare commits

...

66 Commits

Author SHA1 Message Date
aa632a5294 3.1.3 2023-08-13 09:37:24 +02:00
6499dd45cf fix(core): update 2023-08-13 09:37:23 +02:00
d04ed21607 3.1.2 2023-08-12 12:24:11 +02:00
bae776d4e9 fix(core): update 2023-08-12 12:24:10 +02:00
fcd7ea467e 3.1.1 2023-08-12 12:10:38 +02:00
e061b96056 fix(core): update 2023-08-12 12:10:37 +02:00
c2ce669f0c 3.1.0 2023-08-04 13:03:29 +02:00
05f91c3e35 feat(Task): Tasks can now be blocked by other tasks. 2023-08-04 13:03:28 +02:00
94e327c722 3.0.15 2023-08-04 11:58:54 +02:00
57a27604a7 fix(core): update 2023-08-04 11:58:53 +02:00
b077bd7a1b 3.0.14 2023-08-02 02:30:14 +02:00
f2c2dab782 fix(core): update 2023-08-02 02:30:13 +02:00
53a67c0ebe 3.0.13 2023-08-02 00:51:44 +02:00
5240a80cb3 fix(core): update 2023-08-02 00:51:43 +02:00
fa8be6b6d3 3.0.12 2023-08-02 00:07:22 +02:00
b5981d67cf fix(core): update 2023-08-02 00:07:21 +02:00
493cd83dda 3.0.11 2023-07-26 14:16:34 +02:00
86b2842ed2 fix(core): update 2023-07-26 14:16:33 +02:00
801e2ad266 3.0.10 2023-01-19 14:21:36 +01:00
7f837c70fc fix(core): update 2023-01-19 14:21:36 +01:00
f5ca4a696c 3.0.9 2023-01-19 14:20:45 +01:00
b48d42dfb9 fix(core): update 2023-01-19 14:20:44 +01:00
5bf568d0cd 3.0.8 2023-01-19 14:09:57 +01:00
173e1ca35d fix(core): update 2023-01-19 14:09:56 +01:00
ce258c76d2 3.0.7 2023-01-09 18:40:39 +01:00
4d2756b743 fix(core): update 2023-01-09 18:40:38 +01:00
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
36 changed files with 6456 additions and 10503 deletions

View File

@ -0,0 +1,66 @@
name: Default (not tags)
on:
push:
tags-ignore:
- '**'
env:
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
jobs:
security:
runs-on: ubuntu-latest
continue-on-error: true
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Install pnpm and npmci
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
- name: Run npm prepare
run: npmci npm prepare
- name: Audit production dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --prod
continue-on-error: true
- name: Audit development dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --dev
continue-on-error: true
test:
if: ${{ always() }}
needs: security
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Test stable
run: |
npmci node install stable
npmci npm install
npmci npm test
- name: Test build
run: |
npmci node install stable
npmci npm install
npmci npm build

View File

@ -0,0 +1,124 @@
name: Default (tags)
on:
push:
tags:
- '*'
env:
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
jobs:
security:
runs-on: ubuntu-latest
continue-on-error: true
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
npmci npm prepare
- name: Audit production dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --prod
continue-on-error: true
- name: Audit development dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --dev
continue-on-error: true
test:
if: ${{ always() }}
needs: security
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
npmci npm prepare
- name: Test stable
run: |
npmci node install stable
npmci npm install
npmci npm test
- name: Test build
run: |
npmci node install stable
npmci npm install
npmci npm build
release:
needs: test
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
npmci npm prepare
- name: Release
run: |
npmci node install stable
npmci npm publish
metadata:
needs: test
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
continue-on-error: true
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
npmci npm prepare
- name: Code quality
run: |
npmci command npm install -g typescript
npmci npm install
- name: Trigger
run: npmci trigger
- name: Build docs and upload artifacts
run: |
npmci node install stable
npmci npm install
pnpm install -g @gitzone/tsdoc
npmci command tsdoc
continue-on-error: true

View File

@ -1,127 +0,0 @@
# gitzone ci_default
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
cache:
paths:
- .npmci_cache/
key: '$CI_BUILD_STAGE'
stages:
- security
- test
- release
- metadata
# ====================
# security stage
# ====================
mirror:
stage: security
script:
- npmci git mirror
tags:
- lossless
- docker
- notpriv
audit:
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
tags:
- lossless
- docker
- notpriv
# ====================
# test stage
# ====================
testStable:
stage: test
script:
- npmci npm prepare
- npmci node install stable
- npmci npm install
- npmci npm test
coverage: /\d+.?\d+?\%\s*coverage/
tags:
- lossless
- docker
- priv
testBuild:
stage: test
script:
- npmci npm prepare
- npmci node install stable
- npmci npm install
- npmci command npm run build
coverage: /\d+.?\d+?\%\s*coverage/
tags:
- lossless
- docker
- notpriv
release:
stage: release
script:
- npmci node install stable
- npmci npm publish
only:
- tags
tags:
- lossless
- docker
- notpriv
# ====================
# metadata stage
# ====================
codequality:
stage: metadata
allow_failure: true
script:
- npmci command npm install -g tslint typescript
- npmci npm prepare
- npmci npm install
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
tags:
- lossless
- docker
- priv
trigger:
stage: metadata
script:
- npmci trigger
only:
- tags
tags:
- lossless
- docker
- notpriv
pages:
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:
- tags
artifacts:
expire_in: 1 week
paths:
- public
allow_failure: true

24
.vscode/launch.json vendored
View File

@ -2,28 +2,10 @@
"version": "0.2.0", "version": "0.2.0",
"configurations": [ "configurations": [
{ {
"name": "current file", "command": "npm test",
"type": "node", "name": "Run npm test",
"request": "launch", "request": "launch",
"args": [ "type": "node-terminal"
"${relativeFile}"
],
"runtimeArgs": ["-r", "@gitzone/tsrun"],
"cwd": "${workspaceRoot}",
"protocol": "inspector",
"internalConsoleOptions": "openOnSessionStart"
},
{
"name": "test.ts",
"type": "node",
"request": "launch",
"args": [
"test/test.ts"
],
"runtimeArgs": ["-r", "@gitzone/tsrun"],
"cwd": "${workspaceRoot}",
"protocol": "inspector",
"internalConsoleOptions": "openOnSessionStart"
} }
] ]
} }

View File

@ -15,7 +15,7 @@
"properties": { "properties": {
"projectType": { "projectType": {
"type": "string", "type": "string",
"enum": ["website", "element", "service", "npm"] "enum": ["website", "element", "service", "npm", "wcc"]
} }
} }
} }

View File

@ -8,10 +8,10 @@
"projectType": "npm", "projectType": "npm",
"module": { "module": {
"githost": "gitlab.com", "githost": "gitlab.com",
"gitscope": "pushrocks", "gitscope": "push.rocks",
"gitrepo": "taskbuffer", "gitrepo": "taskbuffer",
"shortDescription": "flexible task management. TypeScript ready!", "description": "flexible task management. TypeScript ready!",
"npmPackagename": "@pushrocks/taskbuffer", "npmPackagename": "@push.rocks/taskbuffer",
"license": "MIT" "license": "MIT"
} }
} }

9916
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,13 +1,15 @@
{ {
"name": "@pushrocks/taskbuffer", "name": "@push.rocks/taskbuffer",
"version": "2.1.4", "version": "3.1.3",
"private": false, "private": false,
"description": "flexible task management. TypeScript ready!", "description": "flexible task management. TypeScript ready!",
"main": "dist_ts/index.js", "main": "dist_ts/index.js",
"typings": "dist_ts/index.d.ts", "typings": "dist_ts/index.d.ts",
"type": "module",
"scripts": { "scripts": {
"test": "(tstest test/ --web)", "test": "(tstest test/ --web)",
"build": "(tsbuild --web && tsbundle npm)" "build": "(tsbuild --web && tsbundle npm)",
"buildDocs": "tsdoc"
}, },
"repository": { "repository": {
"type": "git", "type": "git",
@ -27,22 +29,21 @@
}, },
"homepage": "https://gitlab.com/pushrocks/taskbuffer#readme", "homepage": "https://gitlab.com/pushrocks/taskbuffer#readme",
"dependencies": { "dependencies": {
"@pushrocks/lik": "^4.0.14", "@push.rocks/isounique": "^1.0.5",
"@pushrocks/smartdelay": "^2.0.10", "@push.rocks/lik": "^6.0.3",
"@pushrocks/smartlog": "^2.0.35", "@push.rocks/smartdelay": "^3.0.5",
"@pushrocks/smartpromise": "^3.0.6", "@push.rocks/smartlog": "^3.0.3",
"@pushrocks/smartrx": "^2.0.18", "@push.rocks/smartpromise": "^4.0.3",
"@pushrocks/smarttime": "^3.0.24", "@push.rocks/smartrx": "^3.0.6",
"@types/cron": "^1.7.2" "@push.rocks/smarttime": "^4.0.4"
}, },
"devDependencies": { "devDependencies": {
"@gitzone/tsbuild": "^2.1.24", "@gitzone/tsbuild": "^2.1.66",
"@gitzone/tsbundle": "^1.0.72", "@gitzone/tsbundle": "^2.0.8",
"@gitzone/tstest": "^1.0.43", "@gitzone/tsrun": "^1.2.44",
"@pushrocks/tapbundle": "^3.2.9", "@gitzone/tstest": "^1.0.77",
"@types/node": "^14.0.22", "@push.rocks/tapbundle": "^5.0.15",
"tslint": "^6.1.2", "@types/node": "^20.4.10"
"tslint-config-prettier": "^1.18.0"
}, },
"files": [ "files": [
"ts/**/*", "ts/**/*",

5776
pnpm-lock.yaml generated Normal file

File diff suppressed because it is too large Load Diff

View File

@ -1,27 +1,26 @@
# @pushrocks/taskbuffer # @push.rocks/taskbuffer
flexible task management. TypeScript ready! flexible task management. TypeScript ready!
## Availabililty and Links ## Availabililty and Links
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/taskbuffer) * [npmjs.org (npm package)](https://www.npmjs.com/package/@push.rocks/taskbuffer)
* [gitlab.com (source)](https://gitlab.com/pushrocks/taskbuffer) * [gitlab.com (source)](https://gitlab.com/push.rocks/taskbuffer)
* [github.com (source mirror)](https://github.com/pushrocks/taskbuffer) * [github.com (source mirror)](https://github.com/push.rocks/taskbuffer)
* [docs (typedoc)](https://pushrocks.gitlab.io/taskbuffer/) * [docs (typedoc)](https://push.rocks.gitlab.io/taskbuffer/)
## Status for master ## Status for master
Status Category | Status Badge Status Category | Status Badge
-- | -- -- | --
GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/taskbuffer/badges/master/pipeline.svg)](https://lossless.cloud) GitLab Pipelines | [![pipeline status](https://gitlab.com/push.rocks/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) GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/push.rocks/taskbuffer/badges/master/coverage.svg)](https://lossless.cloud)
npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/taskbuffer)](https://lossless.cloud) npm | [![npm downloads per month](https://badgen.net/npm/dy/@push.rocks/taskbuffer)](https://lossless.cloud)
Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/taskbuffer)](https://lossless.cloud) Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/push.rocks/taskbuffer)](https://lossless.cloud)
TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](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/) 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) 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 (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@push.rocks/taskbuffer)](https://lossless.cloud)
PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/taskbuffer)](https://lossless.cloud) PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@push.rocks/taskbuffer)](https://lossless.cloud)
BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/taskbuffer)](https://lossless.cloud) BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@push.rocks/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 ## Usage
@ -57,7 +56,6 @@ We are always happy for code contributions. If you are not the code contributing
For further information read the linked docs at the top of this readme. For further information read the linked docs at the top of this readme.
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh) ## Legal
> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy) | 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,115 +1,89 @@
import { expect, tap } from '@pushrocks/tapbundle'; import { expect, tap } from '@push.rocks/tapbundle';
import taskbuffer = require('../ts/index'); import * as taskbuffer from '../ts/index.js';
import * as smartpromise from '@push.rocks/smartpromise';
import * as smartpromise from '@pushrocks/smartpromise'; import * as smartdelay from '@push.rocks/smartdelay';
import * as smartdelay from '@pushrocks/smartdelay';
// setup some testData to work with
let testTask: taskbuffer.Task;
let testPreTask = new taskbuffer.Task({
taskFunction: async () => {
console.log('preTask executed');
},
preTask: testTask,
});
// some more tasks to test with
let task1Counter = 0; // how often task 1 is being executed
let task1 = new taskbuffer.Task({
name: 'Task 1',
taskFunction: () => {
let done = smartpromise.defer();
console.log('Task1 started');
setTimeout(() => {
task1Counter++;
console.log('Task1 executed');
done.resolve();
}, 5000);
return done.promise;
},
});
let task2 = new taskbuffer.Task({
name: 'Task 1',
taskFunction: async () => {
const done = smartpromise.defer();
console.log('Task2 started');
setTimeout(() => {
console.log('Task2 executed');
done.resolve();
}, 5000);
await done.promise;
},
});
let task3 = new taskbuffer.Task({
name: 'Task 3',
taskFunction: () => {
let done = smartpromise.defer();
console.log('Task3 started');
setTimeout(() => {
console.log('Task3 executed');
done.resolve();
}, 5000);
return done.promise;
},
});
tap.test('new Task() should return a new task', async () => { tap.test('new Task() should return a new task', async () => {
testTask = new taskbuffer.Task({ const testTask = new taskbuffer.Task({
taskFunction: async () => { taskFunction: async () => {
console.log('executed twice'); console.log('executed twice');
}, },
preTask: testPreTask,
}); });
expect(testTask).toBeInstanceOf(taskbuffer.Task);
}); });
tap.test('expect testTask to be an instance of Task', async () => { tap.test('should have bufferMax set to the provided value', async () => {
expect(testTask).to.be.instanceof(taskbuffer.Task); const task2 = new taskbuffer.Task({
taskFunction: async () => {},
});
expect(task2.bufferMax).toBeUndefined(); // test for a task without bufferMax set
const bufferedTask = new taskbuffer.Task({
taskFunction: async () => {},
buffered: true,
bufferMax: 3,
});
expect(bufferedTask.bufferMax).toEqual(3);
}); });
tap.test('expect testTask.idle is true', async () => { tap.test('should be able to trigger tasks multiple times', async () => {
if (!testTask.idle) { let task1Counter = 0;
throw new Error('testTask.idle is not true'); const task1 = new taskbuffer.Task({
} name: 'Task 1',
}); taskFunction: () => {
let done = smartpromise.defer();
tap.test('testTask.running should be of type boolean and initially false', async () => { console.log('Task1 started');
expect(testTask.running).to.be.a('boolean'); setTimeout(() => {
// tslint:disable-next-line:no-unused-expression task1Counter++;
expect(testTask.running).to.be.false; console.log('Task1 executed');
}); done.resolve();
}, 5000);
tap.test('testTask.trigger() should return Promise', async () => { return done.promise;
expect(testTask.trigger()).to.be.instanceof(Promise);
});
tap.test('testTask.trigger() returned Promise should be fullfilled', async () => {
await testTask.trigger();
});
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(); await task1.trigger();
await task1.trigger();
expect(task1Counter).toEqual(2);
}); });
tap.test('expect task to run in buffered mode', async () => { tap.test('should execute setup function before the task function', async () => {
let localTestTask = new taskbuffer.Task({ const task2 = new taskbuffer.Task({
name: 'Task 2',
taskSetup: async () => {
console.log('this is the setup function for task 2. It should only run once.')
return {
nice: 'yes',
}
},
taskFunction: async (before, setupArg) => {
expect(setupArg).toEqual({ nice: 'yes' });
const done = smartpromise.defer();
console.log('Task2 started');
setTimeout(() => {
console.log('Task2 executed');
done.resolve();
}, 5000);
await done.promise;
},
});
await task2.trigger();
});
tap.test('should not exceed bufferMax when task is buffered', async () => {
let counter = 0;
const bufferedTask = new taskbuffer.Task({
taskFunction: async () => { taskFunction: async () => {
await smartdelay.delayFor(3000); counter++;
await smartdelay.delayFor(2000);
counter--;
}, },
buffered: true, buffered: true,
bufferMax: 2, bufferMax: 2,
}); });
localTestTask.trigger(); bufferedTask.trigger();
localTestTask.trigger(); bufferedTask.trigger();
localTestTask.trigger(); bufferedTask.trigger();
await localTestTask.trigger(); await smartdelay.delayFor(100);
expect(counter <= bufferedTask.bufferMax).toBeTrue();
}); });
tap.start(); tap.start();

View File

@ -1,8 +1,9 @@
import { expect, tap } from '@pushrocks/tapbundle'; import { expect, tap } from '@push.rocks/tapbundle';
import taskbuffer = require('../ts/index');
import * as smartpromise from '@pushrocks/smartpromise'; import * as taskbuffer from '../ts/index.js';
import * as smartdelay from '@pushrocks/smartdelay';
import * as smartpromise from '@push.rocks/smartpromise';
import * as smartdelay from '@push.rocks/smartdelay';
let task1Executed = false; let task1Executed = false;
const task1 = new taskbuffer.Task({ const task1 = new taskbuffer.Task({
@ -36,12 +37,12 @@ tap.test('expect run tasks in sequence', async () => {
const 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,6 +1,7 @@
import { expect, tap } from '@pushrocks/tapbundle'; import { expect, tap } from '@push.rocks/tapbundle';
import taskbuffer = require('../ts/index'); import * as smartdelay from '@push.rocks/smartdelay';
import * as smartdelay from '@pushrocks/smartdelay';
import * as taskbuffer from '../ts/index.js';
let task1Executed = false; let task1Executed = false;
const task1 = new taskbuffer.Task({ const task1 = new taskbuffer.Task({

View File

@ -1,8 +1,9 @@
import { expect, tap } from '@pushrocks/tapbundle'; import { expect, tap } from '@push.rocks/tapbundle';
import taskbuffer = require('../ts/index');
import * as smartpromise from '@pushrocks/smartpromise'; import * as taskbuffer from '../ts/index.js';
import * as smartdelay from '@pushrocks/smartdelay';
import * as smartpromise from '@push.rocks/smartpromise';
import * as smartdelay from '@push.rocks/smartdelay';
let myTaskManager: taskbuffer.TaskManager; let myTaskManager: taskbuffer.TaskManager;
let taskRunCounter = 0; let taskRunCounter = 0;
@ -10,7 +11,7 @@ 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,8 +19,10 @@ 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) {
@ -28,15 +31,20 @@ tap.test('should run the task as expected', async () => {
}, },
}) })
); );
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,42 +0,0 @@
import { expect, tap } from '@pushrocks/tapbundle';
import taskbuffer = require('../ts/index');
import * as smartpromise from '@pushrocks/smartpromise';
import * as smartdelay from '@pushrocks/smartdelay';
let myTaskManager: taskbuffer.TaskManager;
let taskRunCounter = 0;
const taskDone = smartpromise.defer();
tap.test('should create an instance of TaskManager', async () => {
myTaskManager = new taskbuffer.TaskManager();
expect(myTaskManager).to.be.instanceof(taskbuffer.TaskManager);
});
tap.test('should run the task as expected', async () => {
let referenceBoolean = false;
myTaskManager.addTask(
new taskbuffer.Task({
name: 'myTask',
taskFunction: async () => {
console.log('Task executed!');
referenceBoolean = true;
taskRunCounter++;
if (taskRunCounter === 10) {
taskDone.resolve();
}
},
})
);
await myTaskManager.triggerTaskByName('myTask');
// tslint:disable-next-line:no-unused-expression
expect(referenceBoolean).to.be.true;
});
tap.test('should schedule task', async () => {
myTaskManager.scheduleTaskByName('myTask', '* * * * * *');
await taskDone.promise;
myTaskManager.descheduleTaskByName('myTask');
});
tap.start();

View File

@ -1,8 +1,9 @@
import { expect, tap } from '@pushrocks/tapbundle'; import { expect, tap } from '@push.rocks/tapbundle';
import taskbuffer = require('../ts/index');
import * as smartpromise from '@pushrocks/smartpromise'; import * as taskbuffer from '../ts/index.js';
import * as smartdelay from '@pushrocks/smartdelay';
import * as smartpromise from '@push.rocks/smartpromise';
import * as smartdelay from '@push.rocks/smartdelay';
const flowTask1 = new taskbuffer.Task({ const flowTask1 = new taskbuffer.Task({
taskFunction: (x: number) => { taskFunction: (x: number) => {
@ -43,22 +44,22 @@ const flowTask3 = new taskbuffer.Taskchain({
tap.test('should let a value flow through a task', async () => { tap.test('should let a value flow through a task', async () => {
const 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 () => {
const 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 () => {
const 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 () => {
const 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 '@push.rocks/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;
@ -11,18 +11,18 @@ tap.test('should create a valid instance of TaskOnce', 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();

View File

@ -1,6 +1,6 @@
import { tap, expect } from '@pushrocks/tapbundle'; import { tap, expect } from '@push.rocks/tapbundle';
import * as taskbuffer from '../ts'; import * as taskbuffer from '../ts/index.js';
let preTask: taskbuffer.Task; let preTask: taskbuffer.Task;
let afterTask: taskbuffer.Task; let afterTask: taskbuffer.Task;

View File

@ -0,0 +1,52 @@
import { tap, expect } from '@push.rocks/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();

View File

@ -1,5 +1,6 @@
import { tap, expect } from '@pushrocks/tapbundle'; import { tap, expect } from '@push.rocks/tapbundle';
import * as taskbuffer from '../ts/index';
import * as taskbuffer from '../ts/index.js';
let testTaskRunner: taskbuffer.TaskRunner; let testTaskRunner: taskbuffer.TaskRunner;

8
ts/00_commitinfo_data.ts Normal file
View File

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

View File

@ -1,7 +1,10 @@
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 { TaskRunner } from './taskbuffer.classes.taskrunner'; export { TaskOnce } from './taskbuffer.classes.taskonce.js';
export { TaskDebounced } from './taskbuffer.classes.taskdebounced'; export { TaskRunner } from './taskbuffer.classes.taskrunner.js';
export { TaskDebounced } from './taskbuffer.classes.taskdebounced.js';
import * as distributedCoordination from './taskbuffer.classes.distributedcoordinator.js';
export { distributedCoordination };

View File

@ -1,42 +1,34 @@
import { Task } from './taskbuffer.classes.task'; import { Task } from './taskbuffer.classes.task.js';
export class BufferRunner { export class BufferRunner {
public task: Task; public task: Task;
// initialze by default // initialize by default
public bufferCounter: number = 0; public bufferCounter: number = 0;
public running: boolean = false;
constructor(taskArg: Task) { constructor(taskArg: Task<any>) {
this.task = taskArg; this.task = taskArg;
} }
public trigger(x): Promise<any> { public trigger(x: any): Promise<any> {
if (!(this.bufferCounter >= this.task.bufferMax)) { if (!(this.bufferCounter >= this.task.bufferMax)) {
this.bufferCounter++; this.bufferCounter++;
} }
const returnPromise: Promise<any> = this.task.cycleCounter.getPromiseForCycle( const returnPromise: Promise<any> = this.task.cycleCounter.getPromiseForCycle(
this.bufferCounter + 1 this.bufferCounter
); );
if (!this.running) { if (!this.task.running) {
this._run(x); this._run(x);
} }
return returnPromise; return returnPromise;
} }
private _run(x) { private async _run(x: any) {
const recursiveBufferRunner = (x) => { this.task.running = true;
if (this.bufferCounter >= 0) { while (this.bufferCounter > 0) {
this.running = true; const result = await Task.runTask(this.task, { x: x });
this.task.running = true; this.bufferCounter--;
Task.runTask(this.task, { x: x }).then((x) => { this.task.cycleCounter.informOfCycle(result);
this.bufferCounter--; }
this.task.cycleCounter.informOfCycle(x); this.task.running = false;
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 * as plugins from './taskbuffer.plugins.js';
import { Task } from './taskbuffer.classes.task'; import { Task } from './taskbuffer.classes.task.js';
export interface ICycleObject { export interface ICycleObject {
cycleCounter: number; cycleCounter: number;
@ -9,7 +9,7 @@ export interface ICycleObject {
export class CycleCounter { export class CycleCounter {
public task: Task; public task: Task;
public cycleObjectArray: ICycleObject[] = []; public cycleObjectArray: ICycleObject[] = [];
constructor(taskArg: Task) { constructor(taskArg: Task<any>) {
this.task = taskArg; this.task = taskArg;
} }
public getPromiseForCycle(cycleCountArg: number) { public getPromiseForCycle(cycleCountArg: number) {
@ -21,7 +21,7 @@ export class CycleCounter {
this.cycleObjectArray.push(cycleObject); this.cycleObjectArray.push(cycleObject);
return done.promise; return done.promise;
} }
public informOfCycle(x) { public informOfCycle(x: any) {
const newCycleObjectArray: ICycleObject[] = []; const newCycleObjectArray: ICycleObject[] = [];
this.cycleObjectArray.forEach((cycleObjectArg) => { this.cycleObjectArray.forEach((cycleObjectArg) => {
cycleObjectArg.cycleCounter--; cycleObjectArg.cycleCounter--;

View File

@ -0,0 +1,36 @@
import { Task } from './taskbuffer.classes.task.js';
import * as plugins from './taskbuffer.plugins.js';
/**
* Contains all data for the final coordinator to make an informed decision.
*/
export interface IDistributedTaskRequest {
submitterId: string;
taskName: string;
taskVersion: string;
taskExecutionTime: number;
taskExecutionTimeout: number;
taskExecutionParallel: number;
status: 'requesting' | 'gotRejected' | 'failed' | 'succeeded';
}
export interface IDistributedTaskRequestResult {
submitterId: string;
considered: boolean;
rank: number;
reason: string;
shouldTrigger: boolean;
}
export abstract class AbstractDistributedCoordinator {
public abstract fireDistributedTaskRequest(
infoBasis: IDistributedTaskRequest
): Promise<IDistributedTaskRequestResult>;
public abstract updateDistributedTaskRequest(
infoBasis: IDistributedTaskRequest
): Promise<void>;
public abstract start(): Promise<void>;
public abstract stop(): Promise<void>;
}

View File

@ -1,23 +1,28 @@
import * as plugins from './taskbuffer.plugins'; import * as plugins from './taskbuffer.plugins.js';
import { BufferRunner } from './taskbuffer.classes.bufferrunner'; import { BufferRunner } from './taskbuffer.classes.bufferrunner.js';
import { CycleCounter } from './taskbuffer.classes.cyclecounter'; import { CycleCounter } from './taskbuffer.classes.cyclecounter.js';
import { logger } from './taskbuffer.logging'; import { logger } from './taskbuffer.logging.js';
export interface ITaskFunction { export interface ITaskFunction<T = undefined> {
(x?: any): PromiseLike<any>; (x?: any, setupValue?: T): PromiseLike<any>;
} }
export type TPreOrAfterTaskFunction = () => Task; export interface ITaskSetupFunction<T = undefined> {
(): Promise<T>;
}
export class Task { export type TPreOrAfterTaskFunction = () => Task<any>;
// STATIC
public static extractTask(preOrAfterTaskArg: Task | TPreOrAfterTaskFunction): Task { export class Task<T = undefined> {
public static extractTask<T = undefined>(
preOrAfterTaskArg: Task<T> | TPreOrAfterTaskFunction
): Task<T> {
switch (true) { switch (true) {
case !preOrAfterTaskArg: case !preOrAfterTaskArg:
return null; return null;
case preOrAfterTaskArg instanceof Task: case preOrAfterTaskArg instanceof Task:
return preOrAfterTaskArg as Task; return preOrAfterTaskArg as Task<T>;
case typeof preOrAfterTaskArg === 'function': case typeof preOrAfterTaskArg === 'function':
const taskFunction = preOrAfterTaskArg as TPreOrAfterTaskFunction; const taskFunction = preOrAfterTaskArg as TPreOrAfterTaskFunction;
return taskFunction(); return taskFunction();
@ -32,7 +37,7 @@ export class Task {
return done.promise; return done.promise;
}; };
public static isTask = (taskArg: Task): boolean => { public static isTask = (taskArg: Task<any>): boolean => {
if (taskArg instanceof Task && typeof taskArg.taskFunction === 'function') { if (taskArg instanceof Task && typeof taskArg.taskFunction === 'function') {
return true; return true;
} else { } else {
@ -40,10 +45,10 @@ export class Task {
} }
}; };
public static isTaskTouched = ( public static isTaskTouched<T = undefined>(
taskArg: Task | TPreOrAfterTaskFunction, taskArg: Task<T> | TPreOrAfterTaskFunction,
touchedTasksArray: Task[] touchedTasksArray: Task<T>[]
): boolean => { ): boolean {
const taskToCheck = Task.extractTask(taskArg); const taskToCheck = Task.extractTask(taskArg);
let result = false; let result = false;
for (const keyArg in touchedTasksArray) { for (const keyArg in touchedTasksArray) {
@ -52,43 +57,54 @@ export class Task {
} }
} }
return result; return result;
}; }
public static runTask = async ( public static runTask = async <T>(
taskArg: Task | TPreOrAfterTaskFunction, taskArg: Task<T> | TPreOrAfterTaskFunction,
optionsArg: { x?; touchedTasksArray?: Task[] } optionsArg: { x?: any; touchedTasksArray?: Task<T>[] }
) => { ) => {
const taskToRun = Task.extractTask(taskArg); const taskToRun = Task.extractTask(taskArg);
const done = plugins.smartpromise.defer(); const done = plugins.smartpromise.defer();
// pay respect to execDelay // Wait for all blocking tasks to finish
for (const task of taskToRun.blockingTasks) {
await task.finished;
}
if (!taskToRun.setupValue && taskToRun.taskSetup) {
taskToRun.setupValue = await taskToRun.taskSetup();
}
if (taskToRun.execDelay) { if (taskToRun.execDelay) {
await plugins.smartdelay.delayFor(taskToRun.execDelay); await plugins.smartdelay.delayFor(taskToRun.execDelay);
} }
// set running params
taskToRun.running = true; taskToRun.running = true;
done.promise.then(async () => { done.promise.then(async () => {
taskToRun.running = false; taskToRun.running = false;
// When the task has finished running, resolve the finished promise
taskToRun.resolveFinished();
// Create a new finished promise for the next run
taskToRun.finished = new Promise((resolve) => {
taskToRun.resolveFinished = resolve;
});
}); });
// handle options
const options = { const options = {
...{ x: undefined, touchedTasksArray: [] }, ...{ x: undefined, touchedTasksArray: [] },
...optionsArg, ...optionsArg,
}; };
const x = options.x; const x = options.x;
const touchedTasksArray: Task[] = options.touchedTasksArray; const touchedTasksArray: Task<T>[] = options.touchedTasksArray;
touchedTasksArray.push(taskToRun); touchedTasksArray.push(taskToRun);
// run the task cascade
const localDeferred = plugins.smartpromise.defer(); const localDeferred = plugins.smartpromise.defer();
localDeferred.promise localDeferred.promise
.then(() => { .then(() => {
// lets run any preTask
if (taskToRun.preTask && !Task.isTaskTouched(taskToRun.preTask, touchedTasksArray)) { if (taskToRun.preTask && !Task.isTaskTouched(taskToRun.preTask, touchedTasksArray)) {
return Task.runTask(taskToRun.preTask, { x, touchedTasksArray }); return Task.runTask(taskToRun.preTask, { x, touchedTasksArray });
} else { } else {
@ -98,9 +114,8 @@ export class Task {
} }
}) })
.then(async (x) => { .then(async (x) => {
// lets run the main task
try { try {
return await taskToRun.taskFunction(x); return await taskToRun.taskFunction(x, taskToRun.setupValue);
} catch (e) { } catch (e) {
console.log(e); console.log(e);
} }
@ -124,73 +139,63 @@ export class Task {
return await done.promise; return await done.promise;
}; };
// INSTANCE
// man datory properties
public name: string; public name: string;
public taskFunction: ITaskFunction; public version: string;
public taskFunction: ITaskFunction<T>;
public buffered: boolean; public buffered: boolean;
public cronJob: plugins.smarttime.CronJob; public cronJob: plugins.smarttime.CronJob;
public bufferMax: number; public bufferMax: number;
public execDelay: number; public execDelay: number;
public timeout: number;
// tasks to run before and after public preTask: Task<T> | TPreOrAfterTaskFunction;
public preTask: Task | TPreOrAfterTaskFunction; public afterTask: Task<T> | TPreOrAfterTaskFunction;
public afterTask: Task | TPreOrAfterTaskFunction;
// Add a list to store the blocking tasks
public blockingTasks: Task[] = [];
// Add a promise that will resolve when the task has finished
private finished: Promise<void>;
private resolveFinished: () => void;
// initialize by default
public running: boolean = false; public running: boolean = false;
public bufferRunner = new BufferRunner(this); public bufferRunner = new BufferRunner(this);
public cycleCounter = new CycleCounter(this); public cycleCounter = new CycleCounter(this);
public idle: boolean = true; public get idle() {
private _state: string = 'ready'; return !this.running;
}
public taskSetup: ITaskSetupFunction<T>;
public setupValue: T;
constructor(optionsArg: { constructor(optionsArg: {
/** taskFunction: ITaskFunction<T>;
* the task function to run, must return promise preTask?: Task<T> | TPreOrAfterTaskFunction;
*/ afterTask?: Task<T> | TPreOrAfterTaskFunction;
taskFunction: ITaskFunction;
/**
* any other task to run before
*/
preTask?: Task | TPreOrAfterTaskFunction;
/**
* any other task to run after
*/
afterTask?: Task | TPreOrAfterTaskFunction;
/**
* wether this task should run buffered
*/
buffered?: boolean; buffered?: boolean;
/**
* the maximum buffer
*/
bufferMax?: number; bufferMax?: number;
/**
* the execution delay, before the task is executed
* only makes sense when running in buffered mode
*/
execDelay?: number; execDelay?: number;
/**
* the name of the task
*/
name?: string; name?: string;
taskSetup?: ITaskSetupFunction<T>;
}) { }) {
this.taskFunction = optionsArg.taskFunction; this.taskFunction = optionsArg.taskFunction;
this.preTask = optionsArg.preTask; this.preTask = optionsArg.preTask;
this.afterTask = optionsArg.afterTask; this.afterTask = optionsArg.afterTask;
this.idle = !this.running;
this.buffered = optionsArg.buffered; this.buffered = optionsArg.buffered;
this.bufferMax = optionsArg.bufferMax; this.bufferMax = optionsArg.bufferMax;
this.execDelay = optionsArg.execDelay; this.execDelay = optionsArg.execDelay;
this.name = optionsArg.name; this.name = optionsArg.name;
this.taskSetup = optionsArg.taskSetup;
// Create the finished promise
this.finished = new Promise((resolve) => {
this.resolveFinished = resolve;
});
} }
/** public trigger(x?: any): Promise<any> {
* trigger the task. Will trigger buffered if this.buffered is true
*/
public trigger(x?): Promise<any> {
if (this.buffered) { if (this.buffered) {
return this.triggerBuffered(x); return this.triggerBuffered(x);
} else { } else {
@ -198,29 +203,11 @@ export class Task {
} }
} }
/** public triggerUnBuffered(x?: any): Promise<any> {
* trigger task unbuffered. return Task.runTask<T>(this, { x: x });
*/
public triggerUnBuffered(x?): Promise<any> {
return Task.runTask(this, { x: x });
} }
/** public triggerBuffered(x?: any): Promise<any> {
* trigger task buffered.
*/
public triggerBuffered(x?): Promise<any> {
return this.bufferRunner.trigger(x); return this.bufferRunner.trigger(x);
} }
get state(): string {
return this._state;
}
set state(stateArg: string) {
if (stateArg === 'locked') {
this._state = 'locked';
} else {
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 { logger } from './taskbuffer.logging'; import { logger } from './taskbuffer.logging.js';
export class Taskchain extends Task { export class Taskchain extends Task {
taskArray: Task[]; taskArray: Task[];
@ -25,7 +25,7 @@ export class Taskchain extends Task {
// this is the function that gets executed when TaskChain is triggered // this is the function that gets executed when TaskChain is triggered
const 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
const 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) => {

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, type ITaskFunction } from './taskbuffer.classes.task.js';
export class TaskDebounced<T = unknown> extends Task { export class TaskDebounced<T = unknown> extends Task {
private _debouncedTaskFunction: ITaskFunction; private _debouncedTaskFunction: ITaskFunction;
@ -15,11 +15,13 @@ export class TaskDebounced<T = unknown> extends Task {
name: optionsArg.name, name: optionsArg.name,
taskFunction: async (x: T) => { taskFunction: async (x: T) => {
this._observableIntake.push(x); this._observableIntake.push(x);
} },
}); });
this.taskFunction = optionsArg.taskFunction; this.taskFunction = optionsArg.taskFunction;
this._observableIntake.observable.pipe(plugins.smartrx.rxjs.ops.debounceTime(optionsArg.debounceTimeInMillis)).subscribe((x) => { this._observableIntake.observable
this.taskFunction(x); .pipe(plugins.smartrx.rxjs.ops.debounceTime(optionsArg.debounceTimeInMillis))
}); .subscribe((x) => {
this.taskFunction(x);
});
} }
} }

View File

@ -1,61 +1,49 @@
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 { threadId } from 'worker_threads'; import { AbstractDistributedCoordinator, type IDistributedTaskRequestResult } from './taskbuffer.classes.distributedcoordinator.js';
export interface ICronJob { export interface ICronJob {
cronString: string; cronString: string;
taskNameArg: string; taskName: string;
job: any; job: any;
} }
export interface ITaskManagerConstructorOptions {
distributedCoordinator?: AbstractDistributedCoordinator;
}
export class TaskManager { export class TaskManager {
public randomId = plugins.isounique.uni();
public taskMap = new plugins.lik.ObjectMap<Task>(); public taskMap = new plugins.lik.ObjectMap<Task>();
private cronJobManager = new plugins.smarttime.CronManager(); private cronJobManager = new plugins.smarttime.CronManager();
public options: ITaskManagerConstructorOptions = {
distributedCoordinator: null,
};
constructor() { constructor(options: ITaskManagerConstructorOptions = {}) {
// nothing here this.options = Object.assign(this.options, options);
} }
/** public getTaskByName(taskName: string): Task {
* checks if a task is already present return this.taskMap.findSync((task) => task.name === taskName);
* @param taskNameArg
*/
public getTaskByName(taskNameArg): Task {
return this.taskMap.find((itemArg) => {
return itemArg.name === taskNameArg;
});
} }
/** public addTask(task: Task): void {
* adds a Task to the TaskManager if (!task.name) {
* @param taskArg throw new Error('Task must have a name to be added to taskManager');
*/
public addTask(taskArg: Task): void {
if (!taskArg.name) {
throw new Error('taskArg needs a name to be added to taskManager');
} }
this.taskMap.add(taskArg); this.taskMap.add(task);
} }
/** public addAndScheduleTask(task: Task, cronString: string) {
* adds and schedules a task at once this.addTask(task);
* @param taskArg this.scheduleTaskByName(task.name, cronString);
* @param cronStringArg
*/
public addAndScheduleTask(taskArg: Task, cronStringArg: string) {
this.addTask(taskArg);
const taskName = taskArg.name;
this.scheduleTaskByName(taskName, cronStringArg);
} }
/** public async triggerTaskByName(taskName: string): Promise<any> {
* triggers a task in the TaskManagerByName const taskToTrigger = this.getTaskByName(taskName);
* @param taskNameArg
*/
public triggerTaskByName(taskNameArg: string): Promise<any> {
const taskToTrigger = this.getTaskByName(taskNameArg);
if (!taskToTrigger) { if (!taskToTrigger) {
throw new Error(`There is no task with the name of ${taskNameArg}`); throw new Error(`No task with the name ${taskName} found.`);
} }
return taskToTrigger.trigger(); return taskToTrigger.trigger();
} }
@ -64,44 +52,86 @@ export class TaskManager {
return task.trigger(); return task.trigger();
} }
/** public scheduleTaskByName(taskName: string, cronString: string) {
* schedules the task by name const taskToSchedule = this.getTaskByName(taskName);
* @param taskNameArg if (!taskToSchedule) {
*/ throw new Error(`No task with the name ${taskName} found.`);
public scheduleTaskByName(taskNameArg: string, cronStringArg: string) { }
const taskToSchedule = this.getTaskByName(taskNameArg); this.handleTaskScheduling(taskToSchedule, cronString);
const cronJob = this.cronJobManager.addCronjob(cronStringArg, async () => {
await taskToSchedule.triggerBuffered();
});
taskToSchedule.cronJob = cronJob;
this.cronJobManager.start();
} }
/** private handleTaskScheduling(task: Task, cronString: string) {
* deschedules a task by name const cronJob = this.cronJobManager.addCronjob(
* @param taskNameArg cronString,
*/ async (triggerTime: number) => {
public descheduleTaskByName(taskNameArg: string) { this.logTaskState(task);
const taskToDeSchedule = this.getTaskByName(taskNameArg); if (this.options.distributedCoordinator) {
if (taskToDeSchedule.cronJob) { const announcementResult = await this.performDistributedConsultation(task, triggerTime);
this.cronJobManager.removeCronjob(taskToDeSchedule.cronJob); if (!announcementResult.shouldTrigger) {
taskToDeSchedule.cronJob = null; console.log('Distributed coordinator result: NOT EXECUTING');
return;
} else {
console.log('Distributed coordinator result: CHOSEN AND EXECUTING');
}
}
await task.trigger();
}
);
task.cronJob = cronJob;
}
private logTaskState(task: Task) {
console.log(`Taskbuffer schedule triggered task >>${task.name}<<`);
const bufferState = task.buffered
? `buffered with max ${task.bufferMax} buffered calls`
: `unbuffered`;
console.log(`Task >>${task.name}<< is ${bufferState}`);
}
private async performDistributedConsultation(task: Task, triggerTime: number): Promise<IDistributedTaskRequestResult> {
console.log('Found a distributed coordinator, performing consultation.');
return this.options.distributedCoordinator.fireDistributedTaskRequest({
submitterId: this.randomId,
status: 'requesting',
taskExecutionParallel: 1,
taskExecutionTime: triggerTime,
taskExecutionTimeout: task.timeout,
taskName: task.name,
taskVersion: task.version,
});
}
public descheduleTaskByName(taskName: string) {
const task = this.getTaskByName(taskName);
if (task && task.cronJob) {
this.cronJobManager.removeCronjob(task.cronJob);
task.cronJob = null;
} }
if (this.cronJobManager.cronjobs.isEmpty) { if (this.cronJobManager.cronjobs.isEmpty) {
this.cronJobManager.stop(); this.cronJobManager.stop();
} }
} }
/**
* deschedules a task
* @param task
*/
public async descheduleTask(task: Task) { public async descheduleTask(task: Task) {
await this.descheduleTaskByName(task.name); await this.descheduleTaskByName(task.name);
} }
/**
* returns all schedules of a specific task public getScheduleForTaskName(taskName: string): string | null {
* @param taskNameArg const task = this.getTaskByName(taskName);
*/ return task && task.cronJob ? task.cronJob.cronExpression : null;
public getSchedulesForTaskName(taskNameArg: string) {} }
public async start() {
if (this.options.distributedCoordinator) {
await this.options.distributedCoordinator.start();
}
this.cronJobManager.start();
}
public async stop() {
this.cronJobManager.stop();
if (this.options.distributedCoordinator) {
await this.options.distributedCoordinator.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, type 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

View File

@ -1,5 +1,5 @@
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 Taskparallel extends Task { export class Taskparallel extends Task {
public taskArray: Task[]; public taskArray: Task[];

View File

@ -1,6 +1,6 @@
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 { export class TaskRunner {
public maxParrallelJobs: number = 1; public maxParrallelJobs: number = 1;

View File

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

View File

@ -1,8 +1,9 @@
import * as smartlog from '@pushrocks/smartlog'; import * as isounique from '@push.rocks/isounique';
import * as lik from '@pushrocks/lik'; import * as lik from '@push.rocks/lik';
import * as smartpromise from '@pushrocks/smartpromise'; import * as smartlog from '@push.rocks/smartlog';
import * as smartdelay from '@pushrocks/smartdelay'; import * as smartpromise from '@push.rocks/smartpromise';
import * as smartrx from '@pushrocks/smartrx'; import * as smartdelay from '@push.rocks/smartdelay';
import * as smarttime from '@pushrocks/smarttime'; import * as smartrx from '@push.rocks/smartrx';
import * as smarttime from '@push.rocks/smarttime';
export { smartlog, lik, smartpromise, smartdelay, smartrx, smarttime }; export { isounique, lik, smartlog, smartpromise, smartdelay, smartrx, smarttime };

11
tsconfig.json Normal file
View File

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

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