Compare commits

..

16 Commits

Author SHA1 Message Date
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
27 changed files with 3266 additions and 1828 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,141 +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
before_script:
- npm install -g @shipzone/npmci
# ====================
# security stage
# ====================
mirror:
stage: security
script:
- npmci git mirror
only:
- tags
tags:
- lossless
- docker
- notpriv
auditProductionDependencies:
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
stage: security
script:
- npmci npm prepare
- 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
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
# ====================
testStable:
stage: test
script:
- npmci npm prepare
- npmci node install stable
- npmci npm install
- npmci npm test
coverage: /\d+.?\d+?\%\s*coverage/
tags:
- docker
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:
- docker
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
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:
- 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

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

View File

@ -1,6 +1,6 @@
{ {
"name": "@pushrocks/taskbuffer", "name": "@push.rocks/taskbuffer",
"version": "3.0.9", "version": "3.1.1",
"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",
@ -8,7 +8,8 @@
"type": "module", "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",
@ -28,21 +29,21 @@
}, },
"homepage": "https://gitlab.com/pushrocks/taskbuffer#readme", "homepage": "https://gitlab.com/pushrocks/taskbuffer#readme",
"dependencies": { "dependencies": {
"@pushrocks/isounique": "^1.0.5", "@push.rocks/isounique": "^1.0.5",
"@pushrocks/lik": "^6.0.0", "@push.rocks/lik": "^6.0.3",
"@pushrocks/smartdelay": "^2.0.13", "@push.rocks/smartdelay": "^3.0.5",
"@pushrocks/smartlog": "^3.0.1", "@push.rocks/smartlog": "^3.0.3",
"@pushrocks/smartpromise": "^3.1.7", "@push.rocks/smartpromise": "^4.0.3",
"@pushrocks/smartrx": "^3.0.0", "@push.rocks/smartrx": "^3.0.6",
"@pushrocks/smarttime": "^4.0.1" "@push.rocks/smarttime": "^4.0.4"
}, },
"devDependencies": { "devDependencies": {
"@gitzone/tsbuild": "^2.1.63", "@gitzone/tsbuild": "^2.1.66",
"@gitzone/tsbundle": "^2.0.6", "@gitzone/tsbundle": "^2.0.8",
"@gitzone/tsrun": "^1.2.39", "@gitzone/tsrun": "^1.2.44",
"@gitzone/tstest": "^1.0.72", "@gitzone/tstest": "^1.0.77",
"@pushrocks/tapbundle": "^5.0.4", "@push.rocks/tapbundle": "^5.0.15",
"@types/node": "^18.11.18" "@types/node": "^20.4.10"
}, },
"files": [ "files": [
"ts/**/*", "ts/**/*",

4191
pnpm-lock.yaml generated

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,23 +1,33 @@
import { expect, tap } from '@pushrocks/tapbundle'; import { expect, tap } from '@push.rocks/tapbundle';
import * as taskbuffer from '../ts/index.js'; import * as taskbuffer from '../ts/index.js';
import * as smartpromise from '@push.rocks/smartpromise';
import * as smartdelay from '@push.rocks/smartdelay';
import * as smartpromise from '@pushrocks/smartpromise'; tap.test('new Task() should return a new task', async () => {
import * as smartdelay from '@pushrocks/smartdelay'; const testTask = new taskbuffer.Task({
// setup some testData to work with
let testTask: taskbuffer.Task;
let testPreTask = new taskbuffer.Task({
taskFunction: async () => { taskFunction: async () => {
console.log('preTask executed'); console.log('executed twice');
}, },
preTask: testTask, });
expect(testTask).toBeInstanceOf(taskbuffer.Task);
}); });
// some more tasks to test with tap.test('should have bufferMax set to the provided value', async () => {
let task1Counter = 0; // how often task 1 is being executed const task2 = new taskbuffer.Task({
let task1 = 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('should be able to trigger tasks multiple times', async () => {
let task1Counter = 0;
const task1 = new taskbuffer.Task({
name: 'Task 1', name: 'Task 1',
taskFunction: () => { taskFunction: () => {
let done = smartpromise.defer(); let done = smartpromise.defer();
@ -30,10 +40,22 @@ let task1 = new taskbuffer.Task({
return done.promise; return done.promise;
}, },
}); });
await task1.trigger();
await task1.trigger();
expect(task1Counter).toEqual(2);
});
let task2 = new taskbuffer.Task({ tap.test('should execute setup function before the task function', async () => {
name: 'Task 1', const task2 = new taskbuffer.Task({
taskFunction: async () => { 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(); const done = smartpromise.defer();
console.log('Task2 started'); console.log('Task2 started');
setTimeout(() => { setTimeout(() => {
@ -43,74 +65,25 @@ let task2 = new taskbuffer.Task({
await done.promise; await done.promise;
}, },
}); });
await task2.trigger();
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('should not exceed bufferMax when task is buffered', async () => {
testTask = new taskbuffer.Task({ let counter = 0;
const bufferedTask = new taskbuffer.Task({
taskFunction: async () => { taskFunction: async () => {
console.log('executed twice'); counter++;
}, await smartdelay.delayFor(2000);
preTask: testPreTask, counter--;
});
});
tap.test('expect testTask to be an instance of Task', async () => {
expect(testTask).toBeInstanceOf(taskbuffer.Task);
});
tap.test('expect testTask.idle is true', async () => {
if (!testTask.idle) {
throw new Error('testTask.idle is not true');
}
});
tap.test('testTask.running should be of type boolean and initially false', async () => {
expect(testTask.running).toBeTypeofBoolean();
// tslint:disable-next-line:no-unused-expression
expect(testTask.running).toBeFalse();
});
tap.test('testTask.trigger() should return Promise', async () => {
expect(testTask.trigger()).toBeInstanceOf(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();
});
tap.test('expect task to run in buffered mode', async () => {
let localTestTask = new taskbuffer.Task({
taskFunction: async () => {
await smartdelay.delayFor(3000);
}, },
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,9 +1,9 @@
import { expect, tap } from '@pushrocks/tapbundle'; import { expect, tap } from '@push.rocks/tapbundle';
import * as taskbuffer from '../ts/index.js'; import * as taskbuffer from '../ts/index.js';
import * as smartpromise from '@pushrocks/smartpromise'; import * as smartpromise from '@push.rocks/smartpromise';
import * as smartdelay from '@pushrocks/smartdelay'; import * as smartdelay from '@push.rocks/smartdelay';
let task1Executed = false; let task1Executed = false;
const task1 = new taskbuffer.Task({ const task1 = new taskbuffer.Task({

View File

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

View File

@ -1,9 +1,9 @@
import { expect, tap } from '@pushrocks/tapbundle'; import { expect, tap } from '@push.rocks/tapbundle';
import * as taskbuffer from '../ts/index.js'; import * as taskbuffer from '../ts/index.js';
import * as smartpromise from '@pushrocks/smartpromise'; import * as smartpromise from '@push.rocks/smartpromise';
import * as smartdelay from '@pushrocks/smartdelay'; import * as smartdelay from '@push.rocks/smartdelay';
let myTaskManager: taskbuffer.TaskManager; let myTaskManager: taskbuffer.TaskManager;
let taskRunCounter = 0; let taskRunCounter = 0;

View File

@ -1,9 +1,9 @@
import { expect, tap } from '@pushrocks/tapbundle'; import { expect, tap } from '@push.rocks/tapbundle';
import * as taskbuffer from '../ts/index.js'; import * as taskbuffer from '../ts/index.js';
import * as smartpromise from '@pushrocks/smartpromise'; import * as smartpromise from '@push.rocks/smartpromise';
import * as smartdelay from '@pushrocks/smartdelay'; import * as smartdelay from '@push.rocks/smartdelay';
const flowTask1 = new taskbuffer.Task({ const flowTask1 = new taskbuffer.Task({
taskFunction: (x: number) => { taskFunction: (x: number) => {

View File

@ -1,4 +1,4 @@
import { expect, tap } from '@pushrocks/tapbundle'; import { expect, tap } from '@push.rocks/tapbundle';
import * as taskbuffer from '../ts/index.js'; import * as taskbuffer from '../ts/index.js';

View File

@ -1,4 +1,4 @@
import { tap, expect } from '@pushrocks/tapbundle'; import { tap, expect } from '@push.rocks/tapbundle';
import * as taskbuffer from '../ts/index.js'; import * as taskbuffer from '../ts/index.js';

View File

@ -1,4 +1,4 @@
import { tap, expect } from '@pushrocks/tapbundle'; import { tap, expect } from '@push.rocks/tapbundle';
import * as taskbuffer from '../ts/index.js'; import * as taskbuffer from '../ts/index.js';

View File

@ -1,4 +1,4 @@
import { tap, expect } from '@pushrocks/tapbundle'; import { tap, expect } from '@push.rocks/tapbundle';
import * as taskbuffer from '../ts/index.js'; import * as taskbuffer from '../ts/index.js';

View File

@ -2,7 +2,7 @@
* autocreated commitinfo by @pushrocks/commitinfo * autocreated commitinfo by @pushrocks/commitinfo
*/ */
export const commitinfo = { export const commitinfo = {
name: '@pushrocks/taskbuffer', name: '@push.rocks/taskbuffer',
version: '3.0.9', version: '3.1.1',
description: 'flexible task management. TypeScript ready!' description: 'flexible task management. TypeScript ready!'
} }

View File

@ -1,5 +1,5 @@
export { Task } from './taskbuffer.classes.task.js'; export { Task } from './taskbuffer.classes.task.js';
export type { ITaskFunction } from './taskbuffer.classes.task.js' export type { ITaskFunction } from './taskbuffer.classes.task.js';
export { Taskchain } from './taskbuffer.classes.taskchain.js'; export { Taskchain } from './taskbuffer.classes.taskchain.js';
export { Taskparallel } from './taskbuffer.classes.taskparallel.js'; export { Taskparallel } from './taskbuffer.classes.taskparallel.js';
export { TaskManager } from './taskbuffer.classes.taskmanager.js'; export { TaskManager } from './taskbuffer.classes.taskmanager.js';
@ -7,6 +7,4 @@ export { TaskOnce } from './taskbuffer.classes.taskonce.js';
export { TaskRunner } from './taskbuffer.classes.taskrunner.js'; export { TaskRunner } from './taskbuffer.classes.taskrunner.js';
export { TaskDebounced } from './taskbuffer.classes.taskdebounced.js'; export { TaskDebounced } from './taskbuffer.classes.taskdebounced.js';
import * as distributedCoordination from './taskbuffer.classes.distributedcoordinator.js'; import * as distributedCoordination from './taskbuffer.classes.distributedcoordinator.js';
export { export { distributedCoordination };
distributedCoordination
}

View File

@ -2,9 +2,10 @@ 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;
constructor(taskArg: Task) {
constructor(taskArg: Task<any>) {
this.task = taskArg; this.task = taskArg;
} }
@ -13,7 +14,7 @@ export class BufferRunner {
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.task.running) { if (!this.task.running) {
this._run(x); this._run(x);
@ -21,19 +22,13 @@ export class BufferRunner {
return returnPromise; return returnPromise;
} }
private _run(x: any) { private async _run(x: any) {
const recursiveBufferRunner = (x: any) => {
if (this.bufferCounter >= 0) {
this.task.running = true; this.task.running = true;
Task.runTask(this.task, { x: x }).then((x) => { while (this.bufferCounter > 0) {
this.bufferCounter--; // this.bufferCounter drops below 0, the recursion stops. const result = await Task.runTask(this.task, { x: x });
this.task.cycleCounter.informOfCycle(x); this.bufferCounter--;
recursiveBufferRunner(x); this.task.cycleCounter.informOfCycle(result);
}); }
} else {
this.task.running = false; this.task.running = false;
} }
};
recursiveBufferRunner(x);
}
} }

View File

@ -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) {

View File

@ -17,11 +17,14 @@ export interface IDistributedTaskRequest {
status: 'requesting' | 'gotRejected' | 'failed' | 'succeeded'; status: 'requesting' | 'gotRejected' | 'failed' | 'succeeded';
} }
export interface IDsitributedTaskRequestResult { export interface IDistributedTaskRequestResult {
/** /**
* this needs to correlate to the decisionInfoBasis * this needs to correlate to the decisionInfoBasis
*/ */
submitterRandomId: string; submitterRandomId: string;
/**
* can be used while debugging
*/
considered: boolean; considered: boolean;
rank: string; rank: string;
reason: string; reason: string;
@ -29,6 +32,10 @@ export interface IDsitributedTaskRequestResult {
} }
export abstract class AbstractDistributedCoordinator { export abstract class AbstractDistributedCoordinator {
public abstract fireDistributedTaskRequest(infoBasisArg: IDistributedTaskRequest): Promise<IDsitributedTaskRequestResult> public abstract fireDistributedTaskRequest(
public abstract updateDistributedTaskRequest(infoBasisArg: IDistributedTaskRequest): Promise<void> infoBasisArg: IDistributedTaskRequest
): Promise<IDistributedTaskRequestResult>;
public abstract updateDistributedTaskRequest(
infoBasisArg: IDistributedTaskRequest
): Promise<void>;
} }

View File

@ -4,20 +4,25 @@ import { CycleCounter } from './taskbuffer.classes.cyclecounter.js';
import { logger } from './taskbuffer.logging.js'; 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,44 +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?: any; touchedTasksArray?: Task[] } optionsArg: { x?: any; touchedTasksArray?: Task<T>[] }
) => { ) => {
// extracts the task in case it is specified as a return value of a function
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 {
@ -99,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);
} }
@ -125,16 +139,9 @@ export class Task {
return await done.promise; return await done.promise;
}; };
// INSTANCE
// mandatory properties
public name: string; public name: string;
/**
* the version of the task
* should follow semver
* might be important for DistributedCoordinator
*/
public version: string; public version: string;
public taskFunction: ITaskFunction; public taskFunction: ITaskFunction<T>;
public buffered: boolean; public buffered: boolean;
public cronJob: plugins.smarttime.CronJob; public cronJob: plugins.smarttime.CronJob;
@ -142,62 +149,52 @@ export class Task {
public execDelay: number; public execDelay: number;
public timeout: 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;
});
} }
/**
* trigger the task. Will trigger buffered if this.buffered is true
*/
public trigger(x?: any): Promise<any> { public trigger(x?: any): Promise<any> {
if (this.buffered) { if (this.buffered) {
return this.triggerBuffered(x); return this.triggerBuffered(x);
@ -206,31 +203,11 @@ export class Task {
} }
} }
/**
* trigger task unbuffered.
* will actually run the task, not considering any buffered limits.
*/
public triggerUnBuffered(x?: any): Promise<any> { public triggerUnBuffered(x?: any): Promise<any> {
return Task.runTask(this, { x: x }); return Task.runTask<T>(this, { x: x });
} }
/**
* trigger task buffered.
* note: .trigger() also calls this function
*/
public triggerBuffered(x?: any): Promise<any> { public triggerBuffered(x?: any): 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,6 +1,6 @@
import * as plugins from './taskbuffer.plugins.js'; import * as plugins from './taskbuffer.plugins.js';
import { Task, ITaskFunction } from './taskbuffer.classes.task.js'; 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;

View File

@ -9,7 +9,7 @@ export interface ICronJob {
} }
export interface ITaskManagerConstructorOptions { export interface ITaskManagerConstructorOptions {
distributedCoordinator?: AbstractDistributedCoordinator distributedCoordinator?: AbstractDistributedCoordinator;
} }
export class TaskManager { export class TaskManager {
@ -18,11 +18,11 @@ export class TaskManager {
private cronJobManager = new plugins.smarttime.CronManager(); private cronJobManager = new plugins.smarttime.CronManager();
public options: ITaskManagerConstructorOptions = { public options: ITaskManagerConstructorOptions = {
distributedCoordinator: null distributedCoordinator: null,
}; };
constructor(optionosArg: ITaskManagerConstructorOptions = {}) { constructor(optionsArg: ITaskManagerConstructorOptions = {}) {
this.options = Object.assign(this.options, optionosArg); this.options = Object.assign(this.options, optionsArg);
} }
/** /**
@ -78,7 +78,9 @@ export class TaskManager {
*/ */
public scheduleTaskByName(taskNameArg: string, cronStringArg: string) { public scheduleTaskByName(taskNameArg: string, cronStringArg: string) {
const taskToSchedule = this.getTaskByName(taskNameArg); const taskToSchedule = this.getTaskByName(taskNameArg);
const cronJob = this.cronJobManager.addCronjob(cronStringArg, async (triggerTimeArg: number) => { const cronJob = this.cronJobManager.addCronjob(
cronStringArg,
async (triggerTimeArg: number) => {
console.log(`taskbuffer schedule triggered task >>${taskToSchedule.name}<<`); console.log(`taskbuffer schedule triggered task >>${taskToSchedule.name}<<`);
console.log( console.log(
`task >>${taskToSchedule.name}<< is ${ `task >>${taskToSchedule.name}<< is ${
@ -89,7 +91,8 @@ export class TaskManager {
); );
if (this.options.distributedCoordinator) { if (this.options.distributedCoordinator) {
console.log(`Found a distrubuted coordinator, performing distributed consultation.`); console.log(`Found a distrubuted coordinator, performing distributed consultation.`);
const announcementResult = await this.options.distributedCoordinator.fireDistributedTaskRequest({ const announcementResult =
await this.options.distributedCoordinator.fireDistributedTaskRequest({
submitterRandomId: this.randomId, submitterRandomId: this.randomId,
status: 'requesting', status: 'requesting',
taskExecutionParallel: 1, taskExecutionParallel: 1,
@ -100,14 +103,15 @@ export class TaskManager {
}); });
if (!announcementResult.shouldTrigger) { if (!announcementResult.shouldTrigger) {
console.log('distributed coordinator result: NOT EXECUTING') console.log('distributed coordinator result: NOT EXECUTING');
return; return;
} else { } else {
console.log('distributed coordinator result: CHOSEN AND EXECUTING') console.log('distributed coordinator result: CHOSEN AND EXECUTING');
} }
} }
await taskToSchedule.trigger(); await taskToSchedule.trigger();
}); }
);
taskToSchedule.cronJob = cronJob; taskToSchedule.cronJob = cronJob;
} }
@ -133,11 +137,19 @@ export class TaskManager {
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 * returns the schedule of a specific task
* @param taskNameArg * @param taskNameArg
*/ */
public getSchedulesForTaskName(taskNameArg: string) {} public getScheduleForTaskName(taskNameArg: string): string | null {
const task = this.getTaskByName(taskNameArg);
if (!task || !task.cronJob) {
return null;
}
return task.cronJob.cronExpression;
}
/** /**
* starts the taskmanager * starts the taskmanager

View File

@ -1,6 +1,6 @@
import * as plugins from './taskbuffer.plugins.js'; import * as plugins from './taskbuffer.plugins.js';
import { Task, ITaskFunction } from './taskbuffer.classes.task.js'; 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,9 +1,9 @@
import * as isounique from '@pushrocks/isounique'; import * as isounique from '@push.rocks/isounique';
import * as lik from '@pushrocks/lik'; import * as lik from '@push.rocks/lik';
import * as smartlog from '@pushrocks/smartlog'; import * as smartlog from '@push.rocks/smartlog';
import * as smartpromise from '@pushrocks/smartpromise'; import * as smartpromise from '@push.rocks/smartpromise';
import * as smartdelay from '@pushrocks/smartdelay'; import * as smartdelay from '@push.rocks/smartdelay';
import * as smartrx from '@pushrocks/smartrx'; import * as smartrx from '@push.rocks/smartrx';
import * as smarttime from '@pushrocks/smarttime'; import * as smarttime from '@push.rocks/smarttime';
export { isounique, lik, smartlog, smartpromise, smartdelay, smartrx, smarttime }; export { isounique, lik, smartlog, smartpromise, smartdelay, smartrx, smarttime };

View File

@ -5,6 +5,7 @@
"target": "ES2022", "target": "ES2022",
"module": "ES2022", "module": "ES2022",
"moduleResolution": "nodenext", "moduleResolution": "nodenext",
"esModuleInterop": true "esModuleInterop": true,
"verbatimModuleSyntax": true,
} }
} }