Compare commits
14 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 33d1c334c4 | |||
| b2c0553e30 | |||
| 450b62fe5d | |||
| d3e8ff1a11 | |||
| 9d78933a46 | |||
| 28d9ad1746 | |||
| 28312972e0 | |||
| a0abcdda90 | |||
| 1dd7ca46ff | |||
| 6110dd8e71 | |||
| 3d8fe65b55 | |||
| 6030fb2805 | |||
| 9a3a3e3eab | |||
| 248383aab1 |
63
changelog.md
63
changelog.md
@@ -1,5 +1,68 @@
|
||||
# Changelog
|
||||
|
||||
## 2026-02-15 - 5.0.1 - fix(tests)
|
||||
add and tighten constraint-related tests covering return values, error propagation, concurrency, cooldown timing, and constraint removal
|
||||
|
||||
- Tightened cooldown timing assertion from >=100ms to >=250ms to reflect 300ms cooldown with 50ms tolerance.
|
||||
- Added tests for queued task return values, error propagation when catchErrors is false, and error swallowing behavior when catchErrors is true.
|
||||
- Added concurrency and cooldown interaction tests to ensure maxConcurrent is respected and batch timing is correct.
|
||||
- Added test verifying removing a constraint group unblocks queued tasks and drain behavior completes correctly.
|
||||
|
||||
## 2026-02-15 - 5.0.0 - BREAKING CHANGE(taskbuffer)
|
||||
Introduce constraint-based concurrency with TaskConstraintGroup and TaskManager integration; remove legacy TaskRunner and several Task APIs (breaking); add typed Task.data and update exports and tests.
|
||||
|
||||
- Add TaskConstraintGroup class with per-key maxConcurrent, cooldownMs, and helper methods (canRun, acquireSlot, releaseSlot, getCooldownRemaining, getRunningCount, reset).
|
||||
- Task generic signature extended to Task<T, TSteps, TData> and a new typed data property (data) with default {}.
|
||||
- TaskManager now supports addConstraintGroup/removeConstraintGroup, triggerTaskConstrained, queues blocked tasks, drains queue with cooldown timers, and routes triggerTask/triggerTaskByName through the constraint system.
|
||||
- Removed TaskRunner, plus Task APIs: blockingTasks, execDelay, finished promise and associated behavior have been removed (breaking changes).
|
||||
- Exports and interfaces updated: TaskConstraintGroup and ITaskConstraintGroupOptions added; TaskRunner removed from public API.
|
||||
- Updated README and added comprehensive tests for constraint behavior; adjusted other tests to remove TaskRunner usage and reflect new APIs.
|
||||
|
||||
## 2026-02-15 - 4.2.1 - fix(deps)
|
||||
bump @push.rocks/smartlog and @types/node; update dependency list version and license link in docs
|
||||
|
||||
- package.json: update @push.rocks/smartlog from ^3.1.10 to ^3.1.11
|
||||
- package.json: update @types/node from ^25.1.0 to ^25.2.3
|
||||
- readme.hints.md: update 'Dependencies (as of v4.1.1)' to 'Dependencies (as of v4.2.0)' and reflect bumped dependency versions
|
||||
- readme.md: change license link text to '[LICENSE](./license.md)'
|
||||
|
||||
## 2026-01-29 - 4.2.0 - feat(ts_web)
|
||||
support TC39 'accessor' decorators for web components; bump dependencies and devDependencies; rename browser tests to .chromium.ts; move LICENSE to license.md and update readme
|
||||
|
||||
- Convert web component class fields to use the TC39 'accessor' keyword in ts_web/taskbuffer-dashboard.ts to be compatible with @design.estate/dees-element v2.1.6
|
||||
- Bump @design.estate/dees-element to ^2.1.6 and update devDependencies (@git.zone/tsbuild, @git.zone/tsbundle, @git.zone/tsrun, @git.zone/tstest, @types/node) to newer versions
|
||||
- Replace test/test.10.webcomponent.browser.ts with test/test.10.webcomponent.chromium.ts and update testing guidance in readme.hints.md to prefer .chromium.ts
|
||||
- Move LICENSE file content to license.md and update readme.md to reference the new license file
|
||||
- Small test cleanups: remove obsolete tslint:disable comments
|
||||
|
||||
## 2026-01-26 - 4.1.1 - fix(ts_web)
|
||||
fix web dashboard typings and update generated commit info
|
||||
|
||||
- Updated generated commit info file ts_web/00_commitinfo_data.ts to version 4.1.0
|
||||
- Large changes applied to web/TS build files (net +529 additions, -399 deletions) — likely fixes and typing/refactor improvements in ts_web/dashboard
|
||||
- package.json remains at 4.1.0; recommend a patch bump to 4.1.1 for these fixes
|
||||
|
||||
## 2026-01-26 - 4.1.0 - feat(task)
|
||||
add task labels and push-based task events
|
||||
|
||||
- Introduce Task labels: Task accepts labels in constructor and exposes setLabel/getLabel/removeLabel/hasLabel; labels are included (shallow copy) in getMetadata().
|
||||
- Add push-based events: Task.eventSubject (rxjs Subject<ITaskEvent>) emits 'started','step','completed','failed' with timestamp; 'step' includes stepName and 'failed' includes error string.
|
||||
- Task now emits events during lifecycle: emits 'started' at run start, 'step' on notifyStep, and 'completed' or 'failed' when finished or errored. getMetadata() now includes labels.
|
||||
- TaskManager aggregates task events into taskSubject, subscribes on addTask and unsubscribes on removeTask/stop; includes helper methods getTasksByLabel and getTasksMetadataByLabel.
|
||||
- Public API updated: exported ITaskEvent and TTaskEventType in ts/index.ts and interfaces updated (labels in metadata, new event types).
|
||||
- Tests and docs: added test/test.12.labels-and-events.ts and updated readme.hints.md to document labels and push-based events.
|
||||
|
||||
## 2026-01-25 - 4.0.0 - BREAKING CHANGE(taskbuffer)
|
||||
Change default Task error handling: trigger() now rejects when taskFunction throws; add catchErrors option (default false) to preserve previous swallow behavior; track errors (lastError, errorCount) and expose them in metadata; improve error propagation and logging across runners, chains, parallels and debounced tasks; add tests and documentation for new behavior.
|
||||
|
||||
- Introduce catchErrors option on Task (default: false) — previously errors were swallowed by default
|
||||
- Tasks now set lastError and increment errorCount when failures occur; clearError() added to reset error state
|
||||
- getMetadata() now reports status 'failed' and includes lastError and errorCount
|
||||
- Task.run flow updated to reset error state at start, log errors, and either swallow or rethrow based on catchErrors
|
||||
- BufferRunner, TaskRunner, Taskchain, Taskparallel, TaskDebounced and TaskManager updated to handle errors, avoid hanging promises, and use logger instead of console
|
||||
- Added comprehensive tests (test/test.11.errorhandling.ts) and readme hints documenting the new error-handling behavior (v3.6.0+)
|
||||
- npmextra.json updated for @git.zone/cli and release registries
|
||||
|
||||
## 2025-12-04 - 3.5.0 - feat(core)
|
||||
Add debounced tasks and step-based progress tracking; upgrade deps and improve dashboard and scheduling
|
||||
|
||||
|
||||
@@ -1,10 +1,5 @@
|
||||
{
|
||||
"npmci": {
|
||||
"npmGlobalTools": [],
|
||||
"npmAccessLevel": "public",
|
||||
"npmRegistryUrl": "registry.npmjs.org"
|
||||
},
|
||||
"gitzone": {
|
||||
"@git.zone/cli": {
|
||||
"projectType": "npm",
|
||||
"module": {
|
||||
"githost": "code.foss.global",
|
||||
@@ -25,9 +20,20 @@
|
||||
"debounced tasks",
|
||||
"distributed coordination"
|
||||
]
|
||||
},
|
||||
"release": {
|
||||
"registries": [
|
||||
"https://verdaccio.lossless.digital",
|
||||
"https://registry.npmjs.org"
|
||||
],
|
||||
"accessLevel": "public"
|
||||
}
|
||||
},
|
||||
"tsdoc": {
|
||||
"@git.zone/tsdoc": {
|
||||
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
|
||||
},
|
||||
"@ship.zone/szci": {
|
||||
"npmGlobalTools": [],
|
||||
"npmRegistryUrl": "registry.npmjs.org"
|
||||
}
|
||||
}
|
||||
}
|
||||
18
package.json
18
package.json
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@push.rocks/taskbuffer",
|
||||
"version": "3.5.0",
|
||||
"version": "5.0.1",
|
||||
"private": false,
|
||||
"description": "A flexible task management library supporting TypeScript, allowing for task buffering, scheduling, and execution with dependency management.",
|
||||
"main": "dist_ts/index.js",
|
||||
@@ -27,28 +27,28 @@
|
||||
"debounced tasks",
|
||||
"distributed coordination"
|
||||
],
|
||||
"author": "Lossless GmbH",
|
||||
"author": "Task Venture Capital GmbH <hello@task.vc>",
|
||||
"license": "MIT",
|
||||
"bugs": {
|
||||
"url": "https://code.foss.global/push.rocks/taskbuffer/issues"
|
||||
},
|
||||
"homepage": "https://code.foss.global/push.rocks/taskbuffer#readme",
|
||||
"dependencies": {
|
||||
"@design.estate/dees-element": "^2.1.3",
|
||||
"@design.estate/dees-element": "^2.1.6",
|
||||
"@push.rocks/lik": "^6.2.2",
|
||||
"@push.rocks/smartdelay": "^3.0.5",
|
||||
"@push.rocks/smartlog": "^3.1.10",
|
||||
"@push.rocks/smartlog": "^3.1.11",
|
||||
"@push.rocks/smartpromise": "^4.2.3",
|
||||
"@push.rocks/smartrx": "^3.0.10",
|
||||
"@push.rocks/smarttime": "^4.1.1",
|
||||
"@push.rocks/smartunique": "^3.0.9"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@git.zone/tsbuild": "^3.1.2",
|
||||
"@git.zone/tsbundle": "^2.6.3",
|
||||
"@git.zone/tsrun": "^2.0.0",
|
||||
"@git.zone/tstest": "^3.1.3",
|
||||
"@types/node": "^24.10.1"
|
||||
"@git.zone/tsbuild": "^4.1.2",
|
||||
"@git.zone/tsbundle": "^2.8.3",
|
||||
"@git.zone/tsrun": "^2.0.1",
|
||||
"@git.zone/tstest": "^3.1.8",
|
||||
"@types/node": "^25.2.3"
|
||||
},
|
||||
"files": [
|
||||
"ts/**/*",
|
||||
|
||||
4750
pnpm-lock.yaml
generated
4750
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
@@ -1 +1,91 @@
|
||||
|
||||
# Taskbuffer Hints
|
||||
|
||||
## Task Constraint System (v5.0.0+) — Breaking Changes
|
||||
- **`TaskRunner` removed** — replaced by `TaskManager` + `TaskConstraintGroup`
|
||||
- **`blockingTasks` removed** from `Task` — use `TaskConstraintGroup` with `maxConcurrent: 1`
|
||||
- **`execDelay` removed** from `Task` — use `TaskConstraintGroup` with `cooldownMs`
|
||||
- **`finished` promise removed** from `Task` — no longer needed
|
||||
- **`Task` generic signature**: `Task<T, TSteps, TData>` (3rd param added for typed data)
|
||||
|
||||
### Task.data
|
||||
- `Task` constructor accepts optional `data?: TData` (defaults to `{}`)
|
||||
- Typed data bag accessible as `task.data`
|
||||
|
||||
### TaskConstraintGroup
|
||||
- `new TaskConstraintGroup<TData>({ name, constraintKeyForTask, maxConcurrent?, cooldownMs? })`
|
||||
- `constraintKeyForTask(task)` returns a string key (constraint applies) or `null` (skip)
|
||||
- `maxConcurrent` (default: `Infinity`) — max concurrent tasks per key
|
||||
- `cooldownMs` (default: `0`) — minimum ms gap between completions per key
|
||||
- Methods: `canRun(key)`, `acquireSlot(key)`, `releaseSlot(key)`, `getCooldownRemaining(key)`, `getRunningCount(key)`, `reset()`
|
||||
|
||||
### TaskManager Constraint Integration
|
||||
- `manager.addConstraintGroup(group)` / `manager.removeConstraintGroup(name)`
|
||||
- `triggerTaskByName()`, `triggerTask()`, `addExecuteRemoveTask()`, cron callbacks all route through `triggerTaskConstrained()`
|
||||
- `triggerTaskConstrained(task, input?)` — evaluates constraints, queues if blocked, drains after completion
|
||||
- Cooldown-blocked entries auto-drain via timer
|
||||
|
||||
### Exported from index.ts
|
||||
- `TaskConstraintGroup` class
|
||||
- `ITaskConstraintGroupOptions` type
|
||||
|
||||
## Error Handling (v3.6.0+)
|
||||
- `Task` now has `catchErrors` constructor option (default: `false`)
|
||||
- Default behavior: `trigger()` rejects when taskFunction throws (breaking change from pre-3.6)
|
||||
- Set `catchErrors: true` to swallow errors (old behavior) - returns `undefined` on error
|
||||
- Error state tracked via `lastError?: Error`, `errorCount: number`, `clearError()`
|
||||
- `getMetadata()` status uses all four values: `'idle'` | `'running'` | `'completed'` | `'failed'`
|
||||
- All peripheral classes (Taskchain, Taskparallel, BufferRunner, TaskDebounced, TaskManager) have proper error propagation/handling
|
||||
- `console.log` calls replaced with `logger.log()` throughout
|
||||
|
||||
## Error Context Improvements
|
||||
- **TaskChain**: Errors now wrap the original with context: chain name, failing task name, and task index. Original error preserved via `.cause`
|
||||
- **BufferRunner**: When `catchErrors: false`, buffered task errors now reject the trigger promise (via `CycleCounter.informOfCycleError`) instead of silently resolving with `undefined`
|
||||
- **TaskChain stubs completed**: `removeTask(task)` returns `boolean`, `shiftTask()` returns `Task | undefined`
|
||||
|
||||
## Task Labels (v4.1.0+)
|
||||
- `Task` constructor accepts optional `labels?: Record<string, string>`
|
||||
- Helper methods: `setLabel(key, value)`, `getLabel(key)`, `removeLabel(key)`, `hasLabel(key, value?)`
|
||||
- `getMetadata()` includes `labels` (shallow copy)
|
||||
- `TaskManager.getTasksByLabel(key, value)` returns matching `Task[]`
|
||||
- `TaskManager.getTasksMetadataByLabel(key, value)` returns matching `ITaskMetadata[]`
|
||||
|
||||
## Push-Based Events (v4.1.0+)
|
||||
- `Task.eventSubject`: rxjs `Subject<ITaskEvent>` emitting `'started'`, `'step'`, `'completed'`, `'failed'` events
|
||||
- `TaskManager.taskSubject`: aggregated `Subject<ITaskEvent>` from all added tasks
|
||||
- `TaskManager.removeTask(task)` unsubscribes and removes from map
|
||||
- `TaskManager.stop()` cleans up all event subscriptions
|
||||
- Exported types: `ITaskEvent`, `TTaskEventType`
|
||||
|
||||
## Project Structure
|
||||
- Source in `ts/`, web components in `ts_web/`
|
||||
- Tests in `test/` - naming: `*.node.ts`, `*.chromium.ts` (preferred), `*.both.ts`
|
||||
- Note: `*.browser.ts` is deprecated, use `*.chromium.ts` for browser tests
|
||||
- Logger: `ts/taskbuffer.logging.ts` exports `logger` (ConsoleLog from smartlog)
|
||||
- Build: `pnpm build` (tsbuild tsfolders)
|
||||
- Test: `pnpm test` or `tstest test/test.XX.name.ts --verbose`
|
||||
|
||||
## Web Components (ts_web/)
|
||||
- Uses `@design.estate/dees-element` with TC39 decorators
|
||||
- Decorators require the `accessor` keyword:
|
||||
```typescript
|
||||
@property({ type: String })
|
||||
accessor myProp = 'default';
|
||||
|
||||
@state()
|
||||
accessor count = 0;
|
||||
```
|
||||
|
||||
## Dependencies (as of v4.2.0)
|
||||
- `@design.estate/dees-element` ^2.1.6 - TC39 decorators with `accessor` keyword
|
||||
- `@push.rocks/lik` ^6.2.2 - Data structures
|
||||
- `@push.rocks/smartdelay` ^3.0.5 - Delay utilities
|
||||
- `@push.rocks/smartlog` ^3.1.11 - Logging
|
||||
- `@push.rocks/smartpromise` ^4.2.3 - Promise utilities
|
||||
- `@push.rocks/smartrx` ^3.0.10 - RxJS wrapper
|
||||
- `@push.rocks/smarttime` ^4.1.1 - Time/cron utilities
|
||||
- `@push.rocks/smartunique` ^3.0.9 - Unique ID generation
|
||||
- `@git.zone/tsbuild` ^4.1.2 - Build tool
|
||||
- `@git.zone/tsbundle` ^2.8.3 - Bundler (for browser tests)
|
||||
- `@git.zone/tsrun` ^2.0.1 - TypeScript runner
|
||||
- `@git.zone/tstest` ^3.1.8 - Test runner (supports `.chromium.ts` files)
|
||||
- `@types/node` ^25.2.3 - Node.js type definitions
|
||||
|
||||
332
test/test.11.errorhandling.ts
Normal file
332
test/test.11.errorhandling.ts
Normal file
@@ -0,0 +1,332 @@
|
||||
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||
import * as taskbuffer from '../ts/index.js';
|
||||
import * as smartdelay from '@push.rocks/smartdelay';
|
||||
|
||||
// Test 1: Default task rejects on error (catchErrors: false)
|
||||
tap.test('should reject when taskFunction throws (default catchErrors: false)', async () => {
|
||||
const failingTask = new taskbuffer.Task({
|
||||
name: 'failing-task-default',
|
||||
taskFunction: async () => {
|
||||
throw new Error('intentional failure');
|
||||
},
|
||||
});
|
||||
|
||||
let didReject = false;
|
||||
try {
|
||||
await failingTask.trigger();
|
||||
} catch (err) {
|
||||
didReject = true;
|
||||
expect(err).toBeInstanceOf(Error);
|
||||
expect((err as Error).message).toEqual('intentional failure');
|
||||
}
|
||||
expect(didReject).toBeTrue();
|
||||
});
|
||||
|
||||
// Test 2: Task with catchErrors: true resolves on error
|
||||
tap.test('should resolve with undefined when catchErrors is true', async () => {
|
||||
const failingTask = new taskbuffer.Task({
|
||||
name: 'failing-task-catch',
|
||||
catchErrors: true,
|
||||
taskFunction: async () => {
|
||||
throw new Error('swallowed failure');
|
||||
},
|
||||
});
|
||||
|
||||
const result = await failingTask.trigger();
|
||||
expect(result).toBeUndefined();
|
||||
});
|
||||
|
||||
// Test 3: lastError and errorCount are set after failure
|
||||
tap.test('should set lastError and errorCount after failure', async () => {
|
||||
const failingTask = new taskbuffer.Task({
|
||||
name: 'failing-task-state',
|
||||
catchErrors: true,
|
||||
taskFunction: async () => {
|
||||
throw new Error('tracked failure');
|
||||
},
|
||||
});
|
||||
|
||||
await failingTask.trigger();
|
||||
expect(failingTask.lastError).toBeInstanceOf(Error);
|
||||
expect(failingTask.lastError.message).toEqual('tracked failure');
|
||||
expect(failingTask.errorCount).toEqual(1);
|
||||
|
||||
// Run again to verify errorCount increments
|
||||
await failingTask.trigger();
|
||||
expect(failingTask.errorCount).toEqual(2);
|
||||
});
|
||||
|
||||
// Test 4: Error state resets on successful re-run
|
||||
tap.test('should reset lastError on successful re-run', async () => {
|
||||
let shouldFail = true;
|
||||
const task = new taskbuffer.Task({
|
||||
name: 'intermittent-task',
|
||||
catchErrors: true,
|
||||
taskFunction: async () => {
|
||||
if (shouldFail) {
|
||||
throw new Error('first run fails');
|
||||
}
|
||||
return 'success';
|
||||
},
|
||||
});
|
||||
|
||||
// First run: fail
|
||||
await task.trigger();
|
||||
expect(task.lastError).toBeInstanceOf(Error);
|
||||
expect(task.errorCount).toEqual(1);
|
||||
|
||||
// Second run: succeed
|
||||
shouldFail = false;
|
||||
const result = await task.trigger();
|
||||
expect(result).toEqual('success');
|
||||
expect(task.lastError).toBeUndefined();
|
||||
// errorCount should still be 1 since the second run succeeded
|
||||
expect(task.errorCount).toEqual(1);
|
||||
});
|
||||
|
||||
// Test 5: Taskchain rejects when a child task throws
|
||||
tap.test('should reject Taskchain when a child task throws', async () => {
|
||||
const goodTask = new taskbuffer.Task({
|
||||
name: 'good-chain-task',
|
||||
taskFunction: async () => 'ok',
|
||||
});
|
||||
const badTask = new taskbuffer.Task({
|
||||
name: 'bad-chain-task',
|
||||
taskFunction: async () => {
|
||||
throw new Error('chain failure');
|
||||
},
|
||||
});
|
||||
|
||||
const chain = new taskbuffer.Taskchain({
|
||||
name: 'test-chain',
|
||||
taskArray: [goodTask, badTask],
|
||||
});
|
||||
|
||||
let didReject = false;
|
||||
try {
|
||||
await chain.trigger();
|
||||
} catch (err) {
|
||||
didReject = true;
|
||||
}
|
||||
expect(didReject).toBeTrue();
|
||||
});
|
||||
|
||||
// Test 6: Taskparallel rejects when a child task throws
|
||||
tap.test('should reject Taskparallel when a child task throws', async () => {
|
||||
const goodTask = new taskbuffer.Task({
|
||||
name: 'good-parallel-task',
|
||||
taskFunction: async () => 'ok',
|
||||
});
|
||||
const badTask = new taskbuffer.Task({
|
||||
name: 'bad-parallel-task',
|
||||
taskFunction: async () => {
|
||||
throw new Error('parallel failure');
|
||||
},
|
||||
});
|
||||
|
||||
const parallel = new taskbuffer.Taskparallel({
|
||||
taskArray: [goodTask, badTask],
|
||||
});
|
||||
|
||||
let didReject = false;
|
||||
try {
|
||||
await parallel.trigger();
|
||||
} catch (err) {
|
||||
didReject = true;
|
||||
}
|
||||
expect(didReject).toBeTrue();
|
||||
});
|
||||
|
||||
// Test 7: BufferRunner handles errors without hanging
|
||||
tap.test('should handle BufferRunner errors without hanging', async () => {
|
||||
let callCount = 0;
|
||||
const bufferedTask = new taskbuffer.Task({
|
||||
name: 'buffer-error-task',
|
||||
buffered: true,
|
||||
bufferMax: 3,
|
||||
catchErrors: true,
|
||||
taskFunction: async () => {
|
||||
callCount++;
|
||||
throw new Error('buffer failure');
|
||||
},
|
||||
});
|
||||
|
||||
await bufferedTask.trigger();
|
||||
// The task should have executed and not hung
|
||||
expect(callCount).toBeGreaterThan(0);
|
||||
});
|
||||
|
||||
// Test 9: clearError() resets error state
|
||||
tap.test('should reset error state with clearError()', async () => {
|
||||
const task = new taskbuffer.Task({
|
||||
name: 'clearable-task',
|
||||
catchErrors: true,
|
||||
taskFunction: async () => {
|
||||
throw new Error('to be cleared');
|
||||
},
|
||||
});
|
||||
|
||||
await task.trigger();
|
||||
expect(task.lastError).toBeInstanceOf(Error);
|
||||
|
||||
task.clearError();
|
||||
expect(task.lastError).toBeUndefined();
|
||||
// errorCount should remain unchanged
|
||||
expect(task.errorCount).toEqual(1);
|
||||
});
|
||||
|
||||
// Test 10: getMetadata() reflects error state
|
||||
tap.test('should reflect error state in getMetadata()', async () => {
|
||||
const task = new taskbuffer.Task({
|
||||
name: 'metadata-error-task',
|
||||
catchErrors: true,
|
||||
taskFunction: async () => {
|
||||
throw new Error('metadata failure');
|
||||
},
|
||||
});
|
||||
|
||||
// Before any run
|
||||
let metadata = task.getMetadata();
|
||||
expect(metadata.status).toEqual('idle');
|
||||
expect(metadata.errorCount).toEqual(0);
|
||||
|
||||
// After failing
|
||||
await task.trigger();
|
||||
metadata = task.getMetadata();
|
||||
expect(metadata.status).toEqual('failed');
|
||||
expect(metadata.lastError).toEqual('metadata failure');
|
||||
expect(metadata.errorCount).toEqual(1);
|
||||
});
|
||||
|
||||
// Test 11: TaskChain error includes task name and index context
|
||||
tap.test('should include task name and index in TaskChain error message', async () => {
|
||||
const goodTask = new taskbuffer.Task({
|
||||
name: 'chain-step-ok',
|
||||
taskFunction: async () => 'ok',
|
||||
});
|
||||
const badTask = new taskbuffer.Task({
|
||||
name: 'chain-step-fail',
|
||||
taskFunction: async () => {
|
||||
throw new Error('step exploded');
|
||||
},
|
||||
});
|
||||
|
||||
const chain = new taskbuffer.Taskchain({
|
||||
name: 'context-chain',
|
||||
taskArray: [goodTask, badTask],
|
||||
});
|
||||
|
||||
let caughtError: Error | null = null;
|
||||
try {
|
||||
await chain.trigger();
|
||||
} catch (err) {
|
||||
caughtError = err as Error;
|
||||
}
|
||||
expect(caughtError).toBeInstanceOf(Error);
|
||||
expect(caughtError.message).toInclude('context-chain');
|
||||
expect(caughtError.message).toInclude('chain-step-fail');
|
||||
expect(caughtError.message).toInclude('index 1');
|
||||
expect((caughtError as any).cause).toBeInstanceOf(Error);
|
||||
expect(((caughtError as any).cause as Error).message).toEqual('step exploded');
|
||||
});
|
||||
|
||||
// Test 12: BufferRunner error propagation with catchErrors: false
|
||||
tap.test('should reject buffered task when catchErrors is false', async () => {
|
||||
const bufferedTask = new taskbuffer.Task({
|
||||
name: 'buffer-reject-task',
|
||||
buffered: true,
|
||||
bufferMax: 3,
|
||||
catchErrors: false,
|
||||
taskFunction: async () => {
|
||||
throw new Error('buffer reject failure');
|
||||
},
|
||||
});
|
||||
|
||||
let didReject = false;
|
||||
try {
|
||||
await bufferedTask.trigger();
|
||||
} catch (err) {
|
||||
didReject = true;
|
||||
expect(err).toBeInstanceOf(Error);
|
||||
expect((err as Error).message).toEqual('buffer reject failure');
|
||||
}
|
||||
expect(didReject).toBeTrue();
|
||||
});
|
||||
|
||||
// Test 13: Taskchain removeTask removes and returns true
|
||||
tap.test('should remove a task from Taskchain', async () => {
|
||||
const task1 = new taskbuffer.Task({
|
||||
name: 'removable-1',
|
||||
taskFunction: async () => 'a',
|
||||
});
|
||||
const task2 = new taskbuffer.Task({
|
||||
name: 'removable-2',
|
||||
taskFunction: async () => 'b',
|
||||
});
|
||||
|
||||
const chain = new taskbuffer.Taskchain({
|
||||
name: 'remove-chain',
|
||||
taskArray: [task1, task2],
|
||||
});
|
||||
|
||||
const removed = chain.removeTask(task1);
|
||||
expect(removed).toBeTrue();
|
||||
expect(chain.taskArray.length).toEqual(1);
|
||||
expect(chain.taskArray[0] === task2).toBeTrue();
|
||||
});
|
||||
|
||||
// Test 14: Taskchain removeTask returns false for unknown task
|
||||
tap.test('should return false when removing a task not in Taskchain', async () => {
|
||||
const task1 = new taskbuffer.Task({
|
||||
name: 'existing',
|
||||
taskFunction: async () => 'a',
|
||||
});
|
||||
const unknown = new taskbuffer.Task({
|
||||
name: 'unknown',
|
||||
taskFunction: async () => 'b',
|
||||
});
|
||||
|
||||
const chain = new taskbuffer.Taskchain({
|
||||
name: 'remove-false-chain',
|
||||
taskArray: [task1],
|
||||
});
|
||||
|
||||
const removed = chain.removeTask(unknown);
|
||||
expect(removed).toBeFalse();
|
||||
expect(chain.taskArray.length).toEqual(1);
|
||||
});
|
||||
|
||||
// Test 15: Taskchain shiftTask returns first task and shortens array
|
||||
tap.test('should shift the first task from Taskchain', async () => {
|
||||
const task1 = new taskbuffer.Task({
|
||||
name: 'shift-1',
|
||||
taskFunction: async () => 'a',
|
||||
});
|
||||
const task2 = new taskbuffer.Task({
|
||||
name: 'shift-2',
|
||||
taskFunction: async () => 'b',
|
||||
});
|
||||
|
||||
const chain = new taskbuffer.Taskchain({
|
||||
name: 'shift-chain',
|
||||
taskArray: [task1, task2],
|
||||
});
|
||||
|
||||
const shifted = chain.shiftTask();
|
||||
expect(shifted === task1).toBeTrue();
|
||||
expect(chain.taskArray.length).toEqual(1);
|
||||
expect(chain.taskArray[0] === task2).toBeTrue();
|
||||
});
|
||||
|
||||
// Test 16: Taskchain shiftTask returns undefined on empty array
|
||||
tap.test('should return undefined when shifting from empty Taskchain', async () => {
|
||||
const chain = new taskbuffer.Taskchain({
|
||||
name: 'empty-shift-chain',
|
||||
taskArray: [],
|
||||
});
|
||||
|
||||
const shifted = chain.shiftTask();
|
||||
expect(shifted).toBeUndefined();
|
||||
});
|
||||
|
||||
export default tap.start();
|
||||
249
test/test.12.labels-and-events.ts
Normal file
249
test/test.12.labels-and-events.ts
Normal file
@@ -0,0 +1,249 @@
|
||||
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||
import * as taskbuffer from '../ts/index.js';
|
||||
import type { ITaskEvent } from '../ts/index.js';
|
||||
|
||||
// ─── Labels ───
|
||||
|
||||
tap.test('should accept labels in constructor', async () => {
|
||||
const task = new taskbuffer.Task({
|
||||
name: 'labelled-task',
|
||||
taskFunction: async () => 'ok',
|
||||
labels: { userId: 'u1', tenantId: 't1' },
|
||||
});
|
||||
expect(task.labels).toEqual({ userId: 'u1', tenantId: 't1' });
|
||||
});
|
||||
|
||||
tap.test('should default labels to empty object', async () => {
|
||||
const task = new taskbuffer.Task({
|
||||
name: 'no-labels-task',
|
||||
taskFunction: async () => 'ok',
|
||||
});
|
||||
expect(task.labels).toEqual({});
|
||||
});
|
||||
|
||||
tap.test('setLabel / getLabel / removeLabel / hasLabel should work', async () => {
|
||||
const task = new taskbuffer.Task({
|
||||
name: 'label-helpers-task',
|
||||
taskFunction: async () => 'ok',
|
||||
});
|
||||
|
||||
task.setLabel('env', 'prod');
|
||||
expect(task.getLabel('env')).toEqual('prod');
|
||||
expect(task.hasLabel('env')).toBeTrue();
|
||||
expect(task.hasLabel('env', 'prod')).toBeTrue();
|
||||
expect(task.hasLabel('env', 'dev')).toBeFalse();
|
||||
expect(task.hasLabel('missing')).toBeFalse();
|
||||
|
||||
const removed = task.removeLabel('env');
|
||||
expect(removed).toBeTrue();
|
||||
expect(task.getLabel('env')).toBeUndefined();
|
||||
|
||||
const removedAgain = task.removeLabel('env');
|
||||
expect(removedAgain).toBeFalse();
|
||||
});
|
||||
|
||||
tap.test('getMetadata() should include labels', async () => {
|
||||
const task = new taskbuffer.Task({
|
||||
name: 'metadata-labels-task',
|
||||
taskFunction: async () => 'ok',
|
||||
labels: { region: 'eu' },
|
||||
});
|
||||
|
||||
const meta = task.getMetadata();
|
||||
expect(meta.labels).toEqual({ region: 'eu' });
|
||||
|
||||
// Returned labels should be a copy
|
||||
meta.labels!['region'] = 'us';
|
||||
expect(task.labels['region']).toEqual('eu');
|
||||
});
|
||||
|
||||
tap.test('TaskManager.getTasksByLabel should filter correctly', async () => {
|
||||
const manager = new taskbuffer.TaskManager();
|
||||
const t1 = new taskbuffer.Task({
|
||||
name: 'label-filter-1',
|
||||
taskFunction: async () => 'ok',
|
||||
labels: { userId: 'alice' },
|
||||
});
|
||||
const t2 = new taskbuffer.Task({
|
||||
name: 'label-filter-2',
|
||||
taskFunction: async () => 'ok',
|
||||
labels: { userId: 'bob' },
|
||||
});
|
||||
const t3 = new taskbuffer.Task({
|
||||
name: 'label-filter-3',
|
||||
taskFunction: async () => 'ok',
|
||||
labels: { userId: 'alice' },
|
||||
});
|
||||
|
||||
manager.addTask(t1);
|
||||
manager.addTask(t2);
|
||||
manager.addTask(t3);
|
||||
|
||||
const aliceTasks = manager.getTasksByLabel('userId', 'alice');
|
||||
expect(aliceTasks.length).toEqual(2);
|
||||
expect(aliceTasks.map((t) => t.name).sort()).toEqual(['label-filter-1', 'label-filter-3']);
|
||||
|
||||
const bobMeta = manager.getTasksMetadataByLabel('userId', 'bob');
|
||||
expect(bobMeta.length).toEqual(1);
|
||||
expect(bobMeta[0].name).toEqual('label-filter-2');
|
||||
|
||||
await manager.stop();
|
||||
});
|
||||
|
||||
// ─── Events ───
|
||||
|
||||
tap.test('should emit started + completed on successful trigger', async () => {
|
||||
const events: ITaskEvent[] = [];
|
||||
const task = new taskbuffer.Task({
|
||||
name: 'event-success-task',
|
||||
taskFunction: async () => 'ok',
|
||||
});
|
||||
|
||||
task.eventSubject.subscribe((e) => events.push(e));
|
||||
await task.trigger();
|
||||
|
||||
expect(events.length).toEqual(2);
|
||||
expect(events[0].type).toEqual('started');
|
||||
expect(events[1].type).toEqual('completed');
|
||||
expect(events[0].task.name).toEqual('event-success-task');
|
||||
expect(typeof events[0].timestamp).toEqual('number');
|
||||
});
|
||||
|
||||
tap.test('should emit step events on notifyStep', async () => {
|
||||
const steps = [
|
||||
{ name: 'build', description: 'Build artifacts', percentage: 50 },
|
||||
{ name: 'deploy', description: 'Deploy to prod', percentage: 50 },
|
||||
] as const;
|
||||
|
||||
const events: ITaskEvent[] = [];
|
||||
const task = new taskbuffer.Task({
|
||||
name: 'step-event-task',
|
||||
steps,
|
||||
taskFunction: async () => {
|
||||
task.notifyStep('build');
|
||||
task.notifyStep('deploy');
|
||||
return 'done';
|
||||
},
|
||||
});
|
||||
|
||||
task.eventSubject.subscribe((e) => events.push(e));
|
||||
await task.trigger();
|
||||
|
||||
const stepEvents = events.filter((e) => e.type === 'step');
|
||||
expect(stepEvents.length).toEqual(2);
|
||||
expect(stepEvents[0].stepName).toEqual('build');
|
||||
expect(stepEvents[1].stepName).toEqual('deploy');
|
||||
});
|
||||
|
||||
tap.test('should emit started + failed on error', async () => {
|
||||
const events: ITaskEvent[] = [];
|
||||
const task = new taskbuffer.Task({
|
||||
name: 'event-fail-task',
|
||||
taskFunction: async () => {
|
||||
throw new Error('boom');
|
||||
},
|
||||
});
|
||||
|
||||
task.eventSubject.subscribe((e) => events.push(e));
|
||||
|
||||
try {
|
||||
await task.trigger();
|
||||
} catch {
|
||||
// expected
|
||||
}
|
||||
|
||||
expect(events.length).toEqual(2);
|
||||
expect(events[0].type).toEqual('started');
|
||||
expect(events[1].type).toEqual('failed');
|
||||
expect(events[1].error).toEqual('boom');
|
||||
});
|
||||
|
||||
tap.test('should emit failed via done.then path when catchErrors is true', async () => {
|
||||
const events: ITaskEvent[] = [];
|
||||
const task = new taskbuffer.Task({
|
||||
name: 'event-catch-fail-task',
|
||||
catchErrors: true,
|
||||
taskFunction: async () => {
|
||||
throw new Error('swallowed');
|
||||
},
|
||||
});
|
||||
|
||||
task.eventSubject.subscribe((e) => events.push(e));
|
||||
await task.trigger();
|
||||
|
||||
const types = events.map((e) => e.type);
|
||||
expect(types).toContain('started');
|
||||
expect(types).toContain('failed');
|
||||
});
|
||||
|
||||
tap.test('TaskManager.taskSubject should aggregate events from added tasks', async () => {
|
||||
const manager = new taskbuffer.TaskManager();
|
||||
const events: ITaskEvent[] = [];
|
||||
|
||||
const t1 = new taskbuffer.Task({
|
||||
name: 'agg-task-1',
|
||||
taskFunction: async () => 'a',
|
||||
});
|
||||
const t2 = new taskbuffer.Task({
|
||||
name: 'agg-task-2',
|
||||
taskFunction: async () => 'b',
|
||||
});
|
||||
|
||||
manager.addTask(t1);
|
||||
manager.addTask(t2);
|
||||
|
||||
manager.taskSubject.subscribe((e) => events.push(e));
|
||||
|
||||
await t1.trigger();
|
||||
await t2.trigger();
|
||||
|
||||
const names = [...new Set(events.map((e) => e.task.name))];
|
||||
expect(names.sort()).toEqual(['agg-task-1', 'agg-task-2']);
|
||||
expect(events.filter((e) => e.type === 'started').length).toEqual(2);
|
||||
expect(events.filter((e) => e.type === 'completed').length).toEqual(2);
|
||||
|
||||
await manager.stop();
|
||||
});
|
||||
|
||||
tap.test('events should stop after removeTask', async () => {
|
||||
const manager = new taskbuffer.TaskManager();
|
||||
const events: ITaskEvent[] = [];
|
||||
|
||||
const task = new taskbuffer.Task({
|
||||
name: 'removable-event-task',
|
||||
taskFunction: async () => 'ok',
|
||||
});
|
||||
|
||||
manager.addTask(task);
|
||||
manager.taskSubject.subscribe((e) => events.push(e));
|
||||
|
||||
await task.trigger();
|
||||
const countBefore = events.length;
|
||||
expect(countBefore).toBeGreaterThan(0);
|
||||
|
||||
manager.removeTask(task);
|
||||
|
||||
// Trigger again — events should NOT appear on manager subject
|
||||
await task.trigger();
|
||||
expect(events.length).toEqual(countBefore);
|
||||
|
||||
await manager.stop();
|
||||
});
|
||||
|
||||
tap.test('event metadata snapshots should include correct labels', async () => {
|
||||
const events: ITaskEvent[] = [];
|
||||
const task = new taskbuffer.Task({
|
||||
name: 'labelled-event-task',
|
||||
taskFunction: async () => 'ok',
|
||||
labels: { team: 'platform' },
|
||||
});
|
||||
|
||||
task.eventSubject.subscribe((e) => events.push(e));
|
||||
await task.trigger();
|
||||
|
||||
for (const e of events) {
|
||||
expect(e.task.labels).toEqual({ team: 'platform' });
|
||||
}
|
||||
});
|
||||
|
||||
export default tap.start();
|
||||
693
test/test.13.constraints.ts
Normal file
693
test/test.13.constraints.ts
Normal file
@@ -0,0 +1,693 @@
|
||||
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||
import * as taskbuffer from '../ts/index.js';
|
||||
import * as smartdelay from '@push.rocks/smartdelay';
|
||||
|
||||
// Test 1: Task data property — typed data accessible
|
||||
tap.test('should have typed data property on task', async () => {
|
||||
const task = new taskbuffer.Task<undefined, [], { domain: string; priority: number }>({
|
||||
name: 'data-task',
|
||||
data: { domain: 'example.com', priority: 1 },
|
||||
taskFunction: async () => {},
|
||||
});
|
||||
|
||||
expect(task.data.domain).toEqual('example.com');
|
||||
expect(task.data.priority).toEqual(1);
|
||||
});
|
||||
|
||||
// Test 2: Task data defaults to empty object
|
||||
tap.test('should default data to empty object when not provided', async () => {
|
||||
const task = new taskbuffer.Task({
|
||||
name: 'no-data-task',
|
||||
taskFunction: async () => {},
|
||||
});
|
||||
|
||||
expect(task.data).toBeTruthy();
|
||||
expect(typeof task.data).toEqual('object');
|
||||
});
|
||||
|
||||
// Test 3: No-constraint passthrough — behavior unchanged
|
||||
tap.test('should run tasks directly when no constraints are configured', async () => {
|
||||
const manager = new taskbuffer.TaskManager();
|
||||
let executed = false;
|
||||
|
||||
const task = new taskbuffer.Task({
|
||||
name: 'passthrough-task',
|
||||
taskFunction: async () => {
|
||||
executed = true;
|
||||
return 'done';
|
||||
},
|
||||
});
|
||||
|
||||
manager.addTask(task);
|
||||
const result = await manager.triggerTaskByName('passthrough-task');
|
||||
expect(executed).toBeTrue();
|
||||
expect(result).toEqual('done');
|
||||
await manager.stop();
|
||||
});
|
||||
|
||||
// Test 4: Group concurrency — 3 tasks, max 2 concurrent, 3rd queues
|
||||
tap.test('should enforce group concurrency limit', async () => {
|
||||
const manager = new taskbuffer.TaskManager();
|
||||
let running = 0;
|
||||
let maxRunning = 0;
|
||||
|
||||
const constraint = new taskbuffer.TaskConstraintGroup<{ group: string }>({
|
||||
name: 'concurrency-test',
|
||||
maxConcurrent: 2,
|
||||
constraintKeyForTask: (task) =>
|
||||
task.data.group === 'workers' ? 'workers' : null,
|
||||
});
|
||||
manager.addConstraintGroup(constraint);
|
||||
|
||||
const makeTask = (id: number) =>
|
||||
new taskbuffer.Task<undefined, [], { group: string }>({
|
||||
name: `worker-${id}`,
|
||||
data: { group: 'workers' },
|
||||
taskFunction: async () => {
|
||||
running++;
|
||||
maxRunning = Math.max(maxRunning, running);
|
||||
await smartdelay.delayFor(200);
|
||||
running--;
|
||||
},
|
||||
});
|
||||
|
||||
const t1 = makeTask(1);
|
||||
const t2 = makeTask(2);
|
||||
const t3 = makeTask(3);
|
||||
|
||||
manager.addTask(t1);
|
||||
manager.addTask(t2);
|
||||
manager.addTask(t3);
|
||||
|
||||
await Promise.all([
|
||||
manager.triggerTaskConstrained(t1),
|
||||
manager.triggerTaskConstrained(t2),
|
||||
manager.triggerTaskConstrained(t3),
|
||||
]);
|
||||
|
||||
expect(maxRunning).toBeLessThanOrEqual(2);
|
||||
await manager.stop();
|
||||
});
|
||||
|
||||
// Test 5: Key-based mutual exclusion — same key sequential, different keys parallel
|
||||
tap.test('should enforce key-based mutual exclusion', async () => {
|
||||
const manager = new taskbuffer.TaskManager();
|
||||
const log: string[] = [];
|
||||
|
||||
const constraint = new taskbuffer.TaskConstraintGroup<{ domain: string }>({
|
||||
name: 'domain-mutex',
|
||||
maxConcurrent: 1,
|
||||
constraintKeyForTask: (task) => task.data.domain,
|
||||
});
|
||||
manager.addConstraintGroup(constraint);
|
||||
|
||||
const makeTask = (name: string, domain: string, delayMs: number) =>
|
||||
new taskbuffer.Task<undefined, [], { domain: string }>({
|
||||
name,
|
||||
data: { domain },
|
||||
taskFunction: async () => {
|
||||
log.push(`${name}-start`);
|
||||
await smartdelay.delayFor(delayMs);
|
||||
log.push(`${name}-end`);
|
||||
},
|
||||
});
|
||||
|
||||
const taskA1 = makeTask('a1', 'a.com', 100);
|
||||
const taskA2 = makeTask('a2', 'a.com', 100);
|
||||
const taskB1 = makeTask('b1', 'b.com', 100);
|
||||
|
||||
manager.addTask(taskA1);
|
||||
manager.addTask(taskA2);
|
||||
manager.addTask(taskB1);
|
||||
|
||||
await Promise.all([
|
||||
manager.triggerTaskConstrained(taskA1),
|
||||
manager.triggerTaskConstrained(taskA2),
|
||||
manager.triggerTaskConstrained(taskB1),
|
||||
]);
|
||||
|
||||
// a1 and a2 should be sequential (same key)
|
||||
const a1EndIdx = log.indexOf('a1-end');
|
||||
const a2StartIdx = log.indexOf('a2-start');
|
||||
expect(a2StartIdx).toBeGreaterThanOrEqual(a1EndIdx);
|
||||
|
||||
// b1 should start concurrently with a1 (different key)
|
||||
const a1StartIdx = log.indexOf('a1-start');
|
||||
const b1StartIdx = log.indexOf('b1-start');
|
||||
// Both should start before a1 ends
|
||||
expect(b1StartIdx).toBeLessThan(a1EndIdx);
|
||||
|
||||
await manager.stop();
|
||||
});
|
||||
|
||||
// Test 6: Cooldown enforcement
|
||||
tap.test('should enforce cooldown between task executions', async () => {
|
||||
const manager = new taskbuffer.TaskManager();
|
||||
const timestamps: number[] = [];
|
||||
|
||||
const constraint = new taskbuffer.TaskConstraintGroup<{ key: string }>({
|
||||
name: 'cooldown-test',
|
||||
maxConcurrent: 1,
|
||||
cooldownMs: 300,
|
||||
constraintKeyForTask: (task) => task.data.key,
|
||||
});
|
||||
manager.addConstraintGroup(constraint);
|
||||
|
||||
const makeTask = (name: string) =>
|
||||
new taskbuffer.Task<undefined, [], { key: string }>({
|
||||
name,
|
||||
data: { key: 'shared' },
|
||||
taskFunction: async () => {
|
||||
timestamps.push(Date.now());
|
||||
},
|
||||
});
|
||||
|
||||
const t1 = makeTask('cool-1');
|
||||
const t2 = makeTask('cool-2');
|
||||
const t3 = makeTask('cool-3');
|
||||
|
||||
manager.addTask(t1);
|
||||
manager.addTask(t2);
|
||||
manager.addTask(t3);
|
||||
|
||||
await Promise.all([
|
||||
manager.triggerTaskConstrained(t1),
|
||||
manager.triggerTaskConstrained(t2),
|
||||
manager.triggerTaskConstrained(t3),
|
||||
]);
|
||||
|
||||
// Each execution should be at least ~300ms apart (with 200ms tolerance)
|
||||
for (let i = 1; i < timestamps.length; i++) {
|
||||
const gap = timestamps[i] - timestamps[i - 1];
|
||||
expect(gap).toBeGreaterThanOrEqual(250); // 300ms cooldown minus 50ms tolerance
|
||||
}
|
||||
|
||||
await manager.stop();
|
||||
});
|
||||
|
||||
// Test 7: Multiple constraint groups on one task
|
||||
tap.test('should apply multiple constraint groups to one task', async () => {
|
||||
const manager = new taskbuffer.TaskManager();
|
||||
let running = 0;
|
||||
let maxRunning = 0;
|
||||
|
||||
const globalConstraint = new taskbuffer.TaskConstraintGroup({
|
||||
name: 'global',
|
||||
maxConcurrent: 3,
|
||||
constraintKeyForTask: () => 'all',
|
||||
});
|
||||
|
||||
const groupConstraint = new taskbuffer.TaskConstraintGroup<{ group: string }>({
|
||||
name: 'group',
|
||||
maxConcurrent: 1,
|
||||
constraintKeyForTask: (task) => task.data.group,
|
||||
});
|
||||
|
||||
manager.addConstraintGroup(globalConstraint);
|
||||
manager.addConstraintGroup(groupConstraint);
|
||||
|
||||
const makeTask = (name: string, group: string) =>
|
||||
new taskbuffer.Task<undefined, [], { group: string }>({
|
||||
name,
|
||||
data: { group },
|
||||
taskFunction: async () => {
|
||||
running++;
|
||||
maxRunning = Math.max(maxRunning, running);
|
||||
await smartdelay.delayFor(100);
|
||||
running--;
|
||||
},
|
||||
});
|
||||
|
||||
// Same group - should be serialized by group constraint
|
||||
const t1 = makeTask('multi-1', 'A');
|
||||
const t2 = makeTask('multi-2', 'A');
|
||||
|
||||
manager.addTask(t1);
|
||||
manager.addTask(t2);
|
||||
|
||||
await Promise.all([
|
||||
manager.triggerTaskConstrained(t1),
|
||||
manager.triggerTaskConstrained(t2),
|
||||
]);
|
||||
|
||||
// With group maxConcurrent: 1, only 1 should run at a time
|
||||
expect(maxRunning).toBeLessThanOrEqual(1);
|
||||
await manager.stop();
|
||||
});
|
||||
|
||||
// Test 8: Matcher returns null — task runs unconstrained
|
||||
tap.test('should run task unconstrained when matcher returns null', async () => {
|
||||
const manager = new taskbuffer.TaskManager();
|
||||
|
||||
const constraint = new taskbuffer.TaskConstraintGroup<{ skip: boolean }>({
|
||||
name: 'selective',
|
||||
maxConcurrent: 1,
|
||||
constraintKeyForTask: (task) => (task.data.skip ? null : 'constrained'),
|
||||
});
|
||||
manager.addConstraintGroup(constraint);
|
||||
|
||||
let unconstrained = false;
|
||||
const task = new taskbuffer.Task<undefined, [], { skip: boolean }>({
|
||||
name: 'skip-task',
|
||||
data: { skip: true },
|
||||
taskFunction: async () => {
|
||||
unconstrained = true;
|
||||
},
|
||||
});
|
||||
|
||||
manager.addTask(task);
|
||||
await manager.triggerTaskConstrained(task);
|
||||
expect(unconstrained).toBeTrue();
|
||||
await manager.stop();
|
||||
});
|
||||
|
||||
// Test 9: Error handling — failed task releases slot, queue drains
|
||||
tap.test('should release slot and drain queue when task fails', async () => {
|
||||
const manager = new taskbuffer.TaskManager();
|
||||
const log: string[] = [];
|
||||
|
||||
const constraint = new taskbuffer.TaskConstraintGroup<{ key: string }>({
|
||||
name: 'error-drain',
|
||||
maxConcurrent: 1,
|
||||
constraintKeyForTask: (task) => task.data.key,
|
||||
});
|
||||
manager.addConstraintGroup(constraint);
|
||||
|
||||
const failTask = new taskbuffer.Task<undefined, [], { key: string }>({
|
||||
name: 'fail-task',
|
||||
data: { key: 'shared' },
|
||||
catchErrors: true,
|
||||
taskFunction: async () => {
|
||||
log.push('fail');
|
||||
throw new Error('intentional');
|
||||
},
|
||||
});
|
||||
|
||||
const successTask = new taskbuffer.Task<undefined, [], { key: string }>({
|
||||
name: 'success-task',
|
||||
data: { key: 'shared' },
|
||||
taskFunction: async () => {
|
||||
log.push('success');
|
||||
},
|
||||
});
|
||||
|
||||
manager.addTask(failTask);
|
||||
manager.addTask(successTask);
|
||||
|
||||
await Promise.all([
|
||||
manager.triggerTaskConstrained(failTask),
|
||||
manager.triggerTaskConstrained(successTask),
|
||||
]);
|
||||
|
||||
expect(log).toContain('fail');
|
||||
expect(log).toContain('success');
|
||||
await manager.stop();
|
||||
});
|
||||
|
||||
// Test 10: TaskManager integration — addConstraintGroup + triggerTaskByName
|
||||
tap.test('should route triggerTaskByName through constraints', async () => {
|
||||
const manager = new taskbuffer.TaskManager();
|
||||
let running = 0;
|
||||
let maxRunning = 0;
|
||||
|
||||
const constraint = new taskbuffer.TaskConstraintGroup({
|
||||
name: 'manager-integration',
|
||||
maxConcurrent: 1,
|
||||
constraintKeyForTask: () => 'all',
|
||||
});
|
||||
manager.addConstraintGroup(constraint);
|
||||
|
||||
const t1 = new taskbuffer.Task({
|
||||
name: 'managed-1',
|
||||
taskFunction: async () => {
|
||||
running++;
|
||||
maxRunning = Math.max(maxRunning, running);
|
||||
await smartdelay.delayFor(100);
|
||||
running--;
|
||||
},
|
||||
});
|
||||
|
||||
const t2 = new taskbuffer.Task({
|
||||
name: 'managed-2',
|
||||
taskFunction: async () => {
|
||||
running++;
|
||||
maxRunning = Math.max(maxRunning, running);
|
||||
await smartdelay.delayFor(100);
|
||||
running--;
|
||||
},
|
||||
});
|
||||
|
||||
manager.addTask(t1);
|
||||
manager.addTask(t2);
|
||||
|
||||
await Promise.all([
|
||||
manager.triggerTaskByName('managed-1'),
|
||||
manager.triggerTaskByName('managed-2'),
|
||||
]);
|
||||
|
||||
expect(maxRunning).toBeLessThanOrEqual(1);
|
||||
await manager.stop();
|
||||
});
|
||||
|
||||
// Test 11: removeConstraintGroup removes by name
|
||||
tap.test('should remove a constraint group by name', async () => {
|
||||
const manager = new taskbuffer.TaskManager();
|
||||
|
||||
const constraint = new taskbuffer.TaskConstraintGroup({
|
||||
name: 'removable',
|
||||
maxConcurrent: 1,
|
||||
constraintKeyForTask: () => 'all',
|
||||
});
|
||||
|
||||
manager.addConstraintGroup(constraint);
|
||||
expect(manager.constraintGroups.length).toEqual(1);
|
||||
|
||||
manager.removeConstraintGroup('removable');
|
||||
expect(manager.constraintGroups.length).toEqual(0);
|
||||
await manager.stop();
|
||||
});
|
||||
|
||||
// Test 12: TaskConstraintGroup reset clears state
|
||||
tap.test('should reset constraint group state', async () => {
|
||||
const constraint = new taskbuffer.TaskConstraintGroup({
|
||||
name: 'resettable',
|
||||
maxConcurrent: 2,
|
||||
cooldownMs: 1000,
|
||||
constraintKeyForTask: () => 'key',
|
||||
});
|
||||
|
||||
// Simulate usage
|
||||
constraint.acquireSlot('key');
|
||||
expect(constraint.getRunningCount('key')).toEqual(1);
|
||||
|
||||
constraint.releaseSlot('key');
|
||||
expect(constraint.getCooldownRemaining('key')).toBeGreaterThan(0);
|
||||
|
||||
constraint.reset();
|
||||
expect(constraint.getRunningCount('key')).toEqual(0);
|
||||
expect(constraint.getCooldownRemaining('key')).toEqual(0);
|
||||
});
|
||||
|
||||
// Test 13: Queued task returns correct result
|
||||
tap.test('should return correct result from queued tasks', async () => {
|
||||
const manager = new taskbuffer.TaskManager();
|
||||
|
||||
const constraint = new taskbuffer.TaskConstraintGroup({
|
||||
name: 'return-value-test',
|
||||
maxConcurrent: 1,
|
||||
constraintKeyForTask: () => 'shared',
|
||||
});
|
||||
manager.addConstraintGroup(constraint);
|
||||
|
||||
const t1 = new taskbuffer.Task({
|
||||
name: 'ret-1',
|
||||
taskFunction: async () => {
|
||||
await smartdelay.delayFor(100);
|
||||
return 'result-A';
|
||||
},
|
||||
});
|
||||
|
||||
const t2 = new taskbuffer.Task({
|
||||
name: 'ret-2',
|
||||
taskFunction: async () => {
|
||||
return 'result-B';
|
||||
},
|
||||
});
|
||||
|
||||
manager.addTask(t1);
|
||||
manager.addTask(t2);
|
||||
|
||||
const [r1, r2] = await Promise.all([
|
||||
manager.triggerTaskConstrained(t1),
|
||||
manager.triggerTaskConstrained(t2),
|
||||
]);
|
||||
|
||||
expect(r1).toEqual('result-A');
|
||||
expect(r2).toEqual('result-B');
|
||||
await manager.stop();
|
||||
});
|
||||
|
||||
// Test 14: Error propagation for queued tasks (catchErrors: false)
|
||||
tap.test('should propagate errors from queued tasks (catchErrors: false)', async () => {
|
||||
const manager = new taskbuffer.TaskManager();
|
||||
|
||||
const constraint = new taskbuffer.TaskConstraintGroup({
|
||||
name: 'error-propagation',
|
||||
maxConcurrent: 1,
|
||||
constraintKeyForTask: () => 'shared',
|
||||
});
|
||||
manager.addConstraintGroup(constraint);
|
||||
|
||||
const t1 = new taskbuffer.Task({
|
||||
name: 'err-first',
|
||||
taskFunction: async () => {
|
||||
await smartdelay.delayFor(100);
|
||||
return 'ok';
|
||||
},
|
||||
});
|
||||
|
||||
const t2 = new taskbuffer.Task({
|
||||
name: 'err-second',
|
||||
catchErrors: false,
|
||||
taskFunction: async () => {
|
||||
throw new Error('queued-error');
|
||||
},
|
||||
});
|
||||
|
||||
manager.addTask(t1);
|
||||
manager.addTask(t2);
|
||||
|
||||
const r1Promise = manager.triggerTaskConstrained(t1);
|
||||
const r2Promise = manager.triggerTaskConstrained(t2);
|
||||
|
||||
const r1 = await r1Promise;
|
||||
expect(r1).toEqual('ok');
|
||||
|
||||
let caughtError: Error | null = null;
|
||||
try {
|
||||
await r2Promise;
|
||||
} catch (err) {
|
||||
caughtError = err as Error;
|
||||
}
|
||||
|
||||
expect(caughtError).toBeTruthy();
|
||||
expect(caughtError!.message).toEqual('queued-error');
|
||||
await manager.stop();
|
||||
});
|
||||
|
||||
// Test 15: triggerTask() routes through constraints
|
||||
tap.test('should route triggerTask() through constraints', async () => {
|
||||
const manager = new taskbuffer.TaskManager();
|
||||
let running = 0;
|
||||
let maxRunning = 0;
|
||||
|
||||
const constraint = new taskbuffer.TaskConstraintGroup({
|
||||
name: 'trigger-task-test',
|
||||
maxConcurrent: 1,
|
||||
constraintKeyForTask: () => 'all',
|
||||
});
|
||||
manager.addConstraintGroup(constraint);
|
||||
|
||||
const makeTask = (id: number) =>
|
||||
new taskbuffer.Task({
|
||||
name: `tt-${id}`,
|
||||
taskFunction: async () => {
|
||||
running++;
|
||||
maxRunning = Math.max(maxRunning, running);
|
||||
await smartdelay.delayFor(100);
|
||||
running--;
|
||||
},
|
||||
});
|
||||
|
||||
const t1 = makeTask(1);
|
||||
const t2 = makeTask(2);
|
||||
|
||||
manager.addTask(t1);
|
||||
manager.addTask(t2);
|
||||
|
||||
await Promise.all([
|
||||
manager.triggerTask(t1),
|
||||
manager.triggerTask(t2),
|
||||
]);
|
||||
|
||||
expect(maxRunning).toBeLessThanOrEqual(1);
|
||||
await manager.stop();
|
||||
});
|
||||
|
||||
// Test 16: addExecuteRemoveTask() routes through constraints
|
||||
tap.test('should route addExecuteRemoveTask() through constraints', async () => {
|
||||
const manager = new taskbuffer.TaskManager();
|
||||
let running = 0;
|
||||
let maxRunning = 0;
|
||||
|
||||
const constraint = new taskbuffer.TaskConstraintGroup({
|
||||
name: 'add-execute-remove-test',
|
||||
maxConcurrent: 1,
|
||||
constraintKeyForTask: () => 'all',
|
||||
});
|
||||
manager.addConstraintGroup(constraint);
|
||||
|
||||
const makeTask = (id: number) =>
|
||||
new taskbuffer.Task({
|
||||
name: `aer-${id}`,
|
||||
taskFunction: async () => {
|
||||
running++;
|
||||
maxRunning = Math.max(maxRunning, running);
|
||||
await smartdelay.delayFor(100);
|
||||
running--;
|
||||
return `done-${id}`;
|
||||
},
|
||||
});
|
||||
|
||||
const t1 = makeTask(1);
|
||||
const t2 = makeTask(2);
|
||||
|
||||
const [report1, report2] = await Promise.all([
|
||||
manager.addExecuteRemoveTask(t1),
|
||||
manager.addExecuteRemoveTask(t2),
|
||||
]);
|
||||
|
||||
expect(maxRunning).toBeLessThanOrEqual(1);
|
||||
expect(report1.result).toEqual('done-1');
|
||||
expect(report2.result).toEqual('done-2');
|
||||
await manager.stop();
|
||||
});
|
||||
|
||||
// Test 17: FIFO ordering of queued tasks
|
||||
tap.test('should execute queued tasks in FIFO order', async () => {
|
||||
const manager = new taskbuffer.TaskManager();
|
||||
const executionOrder: string[] = [];
|
||||
|
||||
const constraint = new taskbuffer.TaskConstraintGroup({
|
||||
name: 'fifo-test',
|
||||
maxConcurrent: 1,
|
||||
constraintKeyForTask: () => 'shared',
|
||||
});
|
||||
manager.addConstraintGroup(constraint);
|
||||
|
||||
const makeTask = (id: string) =>
|
||||
new taskbuffer.Task({
|
||||
name: `fifo-${id}`,
|
||||
taskFunction: async () => {
|
||||
executionOrder.push(id);
|
||||
await smartdelay.delayFor(50);
|
||||
},
|
||||
});
|
||||
|
||||
const tA = makeTask('A');
|
||||
const tB = makeTask('B');
|
||||
const tC = makeTask('C');
|
||||
|
||||
manager.addTask(tA);
|
||||
manager.addTask(tB);
|
||||
manager.addTask(tC);
|
||||
|
||||
await Promise.all([
|
||||
manager.triggerTaskConstrained(tA),
|
||||
manager.triggerTaskConstrained(tB),
|
||||
manager.triggerTaskConstrained(tC),
|
||||
]);
|
||||
|
||||
expect(executionOrder).toEqual(['A', 'B', 'C']);
|
||||
await manager.stop();
|
||||
});
|
||||
|
||||
// Test 18: Combined concurrency + cooldown
|
||||
tap.test('should enforce both concurrency and cooldown together', async () => {
|
||||
const manager = new taskbuffer.TaskManager();
|
||||
let running = 0;
|
||||
let maxRunning = 0;
|
||||
const timestamps: number[] = [];
|
||||
|
||||
const constraint = new taskbuffer.TaskConstraintGroup({
|
||||
name: 'combined-test',
|
||||
maxConcurrent: 2,
|
||||
cooldownMs: 200,
|
||||
constraintKeyForTask: () => 'shared',
|
||||
});
|
||||
manager.addConstraintGroup(constraint);
|
||||
|
||||
const makeTask = (id: number) =>
|
||||
new taskbuffer.Task({
|
||||
name: `combo-${id}`,
|
||||
taskFunction: async () => {
|
||||
running++;
|
||||
maxRunning = Math.max(maxRunning, running);
|
||||
timestamps.push(Date.now());
|
||||
await smartdelay.delayFor(100);
|
||||
running--;
|
||||
},
|
||||
});
|
||||
|
||||
const tasks = [makeTask(1), makeTask(2), makeTask(3), makeTask(4)];
|
||||
for (const t of tasks) {
|
||||
manager.addTask(t);
|
||||
}
|
||||
|
||||
await Promise.all(tasks.map((t) => manager.triggerTaskConstrained(t)));
|
||||
|
||||
// Concurrency never exceeded 2
|
||||
expect(maxRunning).toBeLessThanOrEqual(2);
|
||||
|
||||
// First 2 tasks start nearly together, 3rd task starts after first batch completes + cooldown
|
||||
// First batch completes ~100ms after start, then 200ms cooldown
|
||||
const gap = timestamps[2] - timestamps[0];
|
||||
expect(gap).toBeGreaterThanOrEqual(250); // 100ms task + 200ms cooldown - 50ms tolerance
|
||||
|
||||
await manager.stop();
|
||||
});
|
||||
|
||||
// Test 19: Constraint removal unblocks queued tasks
|
||||
tap.test('should unblock queued tasks when constraint group is removed', async () => {
|
||||
const manager = new taskbuffer.TaskManager();
|
||||
const log: string[] = [];
|
||||
|
||||
const constraint = new taskbuffer.TaskConstraintGroup({
|
||||
name: 'removable-constraint',
|
||||
maxConcurrent: 1,
|
||||
constraintKeyForTask: () => 'shared',
|
||||
});
|
||||
manager.addConstraintGroup(constraint);
|
||||
|
||||
const t1 = new taskbuffer.Task({
|
||||
name: 'block-1',
|
||||
taskFunction: async () => {
|
||||
log.push('t1-start');
|
||||
// Remove constraint while t1 is running so t2 runs unconstrained after drain
|
||||
manager.removeConstraintGroup('removable-constraint');
|
||||
await smartdelay.delayFor(100);
|
||||
log.push('t1-end');
|
||||
},
|
||||
});
|
||||
|
||||
const t2 = new taskbuffer.Task({
|
||||
name: 'block-2',
|
||||
taskFunction: async () => {
|
||||
log.push('t2-start');
|
||||
log.push('t2-end');
|
||||
},
|
||||
});
|
||||
|
||||
manager.addTask(t1);
|
||||
manager.addTask(t2);
|
||||
|
||||
await Promise.all([
|
||||
manager.triggerTaskConstrained(t1),
|
||||
manager.triggerTaskConstrained(t2),
|
||||
]);
|
||||
|
||||
// Both tasks completed (drain didn't deadlock after constraint removal)
|
||||
expect(log).toContain('t1-start');
|
||||
expect(log).toContain('t1-end');
|
||||
expect(log).toContain('t2-start');
|
||||
expect(log).toContain('t2-end');
|
||||
|
||||
// t2 started after t1 completed (drain fires after t1 finishes)
|
||||
const t1EndIdx = log.indexOf('t1-end');
|
||||
const t2StartIdx = log.indexOf('t2-start');
|
||||
expect(t2StartIdx).toBeGreaterThanOrEqual(t1EndIdx);
|
||||
|
||||
await manager.stop();
|
||||
});
|
||||
|
||||
export default tap.start();
|
||||
@@ -36,12 +36,9 @@ tap.test('expect run tasks in sequence', async () => {
|
||||
});
|
||||
const testPromise = testTaskchain.trigger();
|
||||
await smartdelay.delayFor(2100);
|
||||
// tslint:disable-next-line:no-unused-expression
|
||||
expect(task1Executed).toBeTrue();
|
||||
// tslint:disable-next-line:no-unused-expression
|
||||
expect(task2Executed).toBeFalse();
|
||||
await smartdelay.delayFor(2100);
|
||||
// tslint:disable-next-line:no-unused-expression
|
||||
expect(task2Executed).toBeTrue();
|
||||
await testPromise;
|
||||
});
|
||||
|
||||
@@ -33,7 +33,6 @@ tap.test('should run the task as expected', async () => {
|
||||
);
|
||||
myTaskManager.start();
|
||||
await myTaskManager.triggerTaskByName('myTask');
|
||||
// tslint:disable-next-line:no-unused-expression
|
||||
expect(referenceBoolean).toBeTrue();
|
||||
});
|
||||
|
||||
|
||||
@@ -147,7 +147,7 @@ tap.test('Task should provide complete metadata', async () => {
|
||||
|
||||
// Get metadata after execution
|
||||
metadata = task.getMetadata();
|
||||
expect(metadata.status).toEqual('idle');
|
||||
expect(metadata.status).toEqual('completed');
|
||||
expect(metadata.runCount).toEqual(1);
|
||||
expect(metadata.currentProgress).toEqual(100);
|
||||
});
|
||||
|
||||
@@ -1,34 +0,0 @@
|
||||
import { tap, expect } from '@git.zone/tstest/tapbundle';
|
||||
|
||||
import * as taskbuffer from '../ts/index.js';
|
||||
|
||||
let testTaskRunner: taskbuffer.TaskRunner;
|
||||
|
||||
tap.test('should create a valid taskrunner', async () => {
|
||||
testTaskRunner = new taskbuffer.TaskRunner();
|
||||
await testTaskRunner.start();
|
||||
});
|
||||
|
||||
tap.test('should execute task when its scheduled', async (tools) => {
|
||||
const done = tools.defer();
|
||||
testTaskRunner.addTask(
|
||||
new taskbuffer.Task({
|
||||
taskFunction: async () => {
|
||||
console.log('hi');
|
||||
},
|
||||
}),
|
||||
);
|
||||
|
||||
testTaskRunner.addTask(
|
||||
new taskbuffer.Task({
|
||||
taskFunction: async () => {
|
||||
console.log('there');
|
||||
done.resolve();
|
||||
},
|
||||
}),
|
||||
);
|
||||
|
||||
await done.promise;
|
||||
});
|
||||
|
||||
tap.start();
|
||||
@@ -3,6 +3,6 @@
|
||||
*/
|
||||
export const commitinfo = {
|
||||
name: '@push.rocks/taskbuffer',
|
||||
version: '3.5.0',
|
||||
version: '5.0.1',
|
||||
description: 'A flexible task management library supporting TypeScript, allowing for task buffering, scheduling, and execution with dependency management.'
|
||||
}
|
||||
|
||||
@@ -4,15 +4,15 @@ export { Taskchain } from './taskbuffer.classes.taskchain.js';
|
||||
export { Taskparallel } from './taskbuffer.classes.taskparallel.js';
|
||||
export { TaskManager } from './taskbuffer.classes.taskmanager.js';
|
||||
export { TaskOnce } from './taskbuffer.classes.taskonce.js';
|
||||
export { TaskRunner } from './taskbuffer.classes.taskrunner.js';
|
||||
export { TaskDebounced } from './taskbuffer.classes.taskdebounced.js';
|
||||
export { TaskConstraintGroup } from './taskbuffer.classes.taskconstraintgroup.js';
|
||||
|
||||
// Task step system
|
||||
export { TaskStep } from './taskbuffer.classes.taskstep.js';
|
||||
export type { ITaskStep } from './taskbuffer.classes.taskstep.js';
|
||||
|
||||
// Metadata interfaces
|
||||
export type { ITaskMetadata, ITaskExecutionReport, IScheduledTaskInfo } from './taskbuffer.interfaces.js';
|
||||
export type { ITaskMetadata, ITaskExecutionReport, IScheduledTaskInfo, ITaskEvent, TTaskEventType, ITaskConstraintGroupOptions } from './taskbuffer.interfaces.js';
|
||||
|
||||
import * as distributedCoordination from './taskbuffer.classes.distributedcoordinator.js';
|
||||
export { distributedCoordination };
|
||||
|
||||
@@ -1,11 +1,12 @@
|
||||
import { Task } from './taskbuffer.classes.task.js';
|
||||
import { logger } from './taskbuffer.logging.js';
|
||||
|
||||
export class BufferRunner {
|
||||
public task: Task;
|
||||
// initialize by default
|
||||
public bufferCounter: number = 0;
|
||||
|
||||
constructor(taskArg: Task<any>) {
|
||||
constructor(taskArg: Task<any, any, any>) {
|
||||
this.task = taskArg;
|
||||
}
|
||||
|
||||
@@ -24,9 +25,19 @@ export class BufferRunner {
|
||||
private async _run(x: any) {
|
||||
this.task.running = true;
|
||||
while (this.bufferCounter > 0) {
|
||||
const result = await Task.runTask(this.task, { x: x });
|
||||
this.bufferCounter--;
|
||||
this.task.cycleCounter.informOfCycle(result);
|
||||
try {
|
||||
const result = await Task.runTask(this.task, { x: x });
|
||||
this.bufferCounter--;
|
||||
this.task.cycleCounter.informOfCycle(result);
|
||||
} catch (err) {
|
||||
logger.log('error', `BufferRunner: task "${this.task.name || 'unnamed'}" failed: ${err instanceof Error ? err.message : String(err)}`);
|
||||
this.bufferCounter--;
|
||||
if (this.task.catchErrors) {
|
||||
this.task.cycleCounter.informOfCycle(undefined);
|
||||
} else {
|
||||
this.task.cycleCounter.informOfCycleError(err instanceof Error ? err : new Error(String(err)));
|
||||
}
|
||||
}
|
||||
}
|
||||
this.task.running = false;
|
||||
}
|
||||
|
||||
@@ -9,7 +9,7 @@ export interface ICycleObject {
|
||||
export class CycleCounter {
|
||||
public task: Task;
|
||||
public cycleObjectArray: ICycleObject[] = [];
|
||||
constructor(taskArg: Task<any>) {
|
||||
constructor(taskArg: Task<any, any, any>) {
|
||||
this.task = taskArg;
|
||||
}
|
||||
public getPromiseForCycle(cycleCountArg: number) {
|
||||
@@ -33,4 +33,16 @@ export class CycleCounter {
|
||||
});
|
||||
this.cycleObjectArray = newCycleObjectArray;
|
||||
}
|
||||
public informOfCycleError(err: Error) {
|
||||
const newCycleObjectArray: ICycleObject[] = [];
|
||||
this.cycleObjectArray.forEach((cycleObjectArg) => {
|
||||
cycleObjectArg.cycleCounter--;
|
||||
if (cycleObjectArg.cycleCounter <= 0) {
|
||||
cycleObjectArg.deferred.reject(err);
|
||||
} else {
|
||||
newCycleObjectArray.push(cycleObjectArg);
|
||||
}
|
||||
});
|
||||
this.cycleObjectArray = newCycleObjectArray;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -2,7 +2,7 @@ import * as plugins from './taskbuffer.plugins.js';
|
||||
import { BufferRunner } from './taskbuffer.classes.bufferrunner.js';
|
||||
import { CycleCounter } from './taskbuffer.classes.cyclecounter.js';
|
||||
import { TaskStep, type ITaskStep } from './taskbuffer.classes.taskstep.js';
|
||||
import type { ITaskMetadata } from './taskbuffer.interfaces.js';
|
||||
import type { ITaskMetadata, ITaskEvent, TTaskEventType } from './taskbuffer.interfaces.js';
|
||||
|
||||
import { logger } from './taskbuffer.logging.js';
|
||||
|
||||
@@ -19,18 +19,18 @@ export type TPreOrAfterTaskFunction = () => Task<any>;
|
||||
// Type helper to extract step names from array
|
||||
export type StepNames<T> = T extends ReadonlyArray<{ name: infer N }> ? N : never;
|
||||
|
||||
export class Task<T = undefined, TSteps extends ReadonlyArray<{ name: string; description: string; percentage: number }> = []> {
|
||||
export class Task<T = undefined, TSteps extends ReadonlyArray<{ name: string; description: string; percentage: number }> = [], TData extends Record<string, unknown> = Record<string, unknown>> {
|
||||
public static extractTask<T = undefined, TSteps extends ReadonlyArray<{ name: string; description: string; percentage: number }> = []>(
|
||||
preOrAfterTaskArg: Task<T, TSteps> | TPreOrAfterTaskFunction,
|
||||
): Task<T, TSteps> {
|
||||
preOrAfterTaskArg: Task<T, TSteps, any> | TPreOrAfterTaskFunction,
|
||||
): Task<T, TSteps, any> {
|
||||
switch (true) {
|
||||
case !preOrAfterTaskArg:
|
||||
return null;
|
||||
case preOrAfterTaskArg instanceof Task:
|
||||
return preOrAfterTaskArg as Task<T, TSteps>;
|
||||
return preOrAfterTaskArg as Task<T, TSteps, any>;
|
||||
case typeof preOrAfterTaskArg === 'function':
|
||||
const taskFunction = preOrAfterTaskArg as TPreOrAfterTaskFunction;
|
||||
return taskFunction() as unknown as Task<T, TSteps>;
|
||||
return taskFunction() as unknown as Task<T, TSteps, any>;
|
||||
default:
|
||||
return null;
|
||||
}
|
||||
@@ -42,7 +42,7 @@ export class Task<T = undefined, TSteps extends ReadonlyArray<{ name: string; de
|
||||
return done.promise;
|
||||
};
|
||||
|
||||
public static isTask = (taskArg: Task<any>): boolean => {
|
||||
public static isTask = (taskArg: Task<any, any, any>): boolean => {
|
||||
if (taskArg instanceof Task && typeof taskArg.taskFunction === 'function') {
|
||||
return true;
|
||||
} else {
|
||||
@@ -51,8 +51,8 @@ export class Task<T = undefined, TSteps extends ReadonlyArray<{ name: string; de
|
||||
};
|
||||
|
||||
public static isTaskTouched<T = undefined, TSteps extends ReadonlyArray<{ name: string; description: string; percentage: number }> = []>(
|
||||
taskArg: Task<T, TSteps> | TPreOrAfterTaskFunction,
|
||||
touchedTasksArray: Task<T, TSteps>[],
|
||||
taskArg: Task<T, TSteps, any> | TPreOrAfterTaskFunction,
|
||||
touchedTasksArray: Task<T, TSteps, any>[],
|
||||
): boolean {
|
||||
const taskToCheck = Task.extractTask(taskArg);
|
||||
let result = false;
|
||||
@@ -65,53 +65,44 @@ export class Task<T = undefined, TSteps extends ReadonlyArray<{ name: string; de
|
||||
}
|
||||
|
||||
public static runTask = async <T, TSteps extends ReadonlyArray<{ name: string; description: string; percentage: number }> = []>(
|
||||
taskArg: Task<T, TSteps> | TPreOrAfterTaskFunction,
|
||||
optionsArg: { x?: any; touchedTasksArray?: Task<T, TSteps>[] },
|
||||
taskArg: Task<T, TSteps, any> | TPreOrAfterTaskFunction,
|
||||
optionsArg: { x?: any; touchedTasksArray?: Task<T, TSteps, any>[] },
|
||||
) => {
|
||||
const taskToRun = Task.extractTask(taskArg);
|
||||
const done = plugins.smartpromise.defer();
|
||||
|
||||
// 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) {
|
||||
await plugins.smartdelay.delayFor(taskToRun.execDelay);
|
||||
}
|
||||
|
||||
taskToRun.running = true;
|
||||
taskToRun.runCount++;
|
||||
taskToRun.lastRun = new Date();
|
||||
|
||||
// Reset steps at the beginning of task execution
|
||||
|
||||
// Reset steps and error state at the beginning of task execution
|
||||
taskToRun.resetSteps();
|
||||
taskToRun.lastError = undefined;
|
||||
taskToRun.emitEvent('started');
|
||||
|
||||
done.promise.then(async () => {
|
||||
taskToRun.running = false;
|
||||
|
||||
// Complete all steps when task finishes
|
||||
taskToRun.completeAllSteps();
|
||||
done.promise
|
||||
.then(async () => {
|
||||
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;
|
||||
// Complete all steps when task finishes
|
||||
taskToRun.completeAllSteps();
|
||||
taskToRun.emitEvent(taskToRun.lastError ? 'failed' : 'completed');
|
||||
})
|
||||
.catch((err) => {
|
||||
taskToRun.running = false;
|
||||
taskToRun.emitEvent('failed', { error: err instanceof Error ? err.message : String(err) });
|
||||
});
|
||||
});
|
||||
|
||||
const options = {
|
||||
...{ x: undefined, touchedTasksArray: [] },
|
||||
...optionsArg,
|
||||
};
|
||||
const x = options.x;
|
||||
const touchedTasksArray: Task<T, TSteps>[] = options.touchedTasksArray;
|
||||
const touchedTasksArray: Task<T, TSteps, any>[] = options.touchedTasksArray;
|
||||
|
||||
touchedTasksArray.push(taskToRun);
|
||||
|
||||
@@ -133,7 +124,13 @@ export class Task<T = undefined, TSteps extends ReadonlyArray<{ name: string; de
|
||||
try {
|
||||
return await taskToRun.taskFunction(x, taskToRun.setupValue);
|
||||
} catch (e) {
|
||||
console.log(e);
|
||||
taskToRun.lastError = e instanceof Error ? e : new Error(String(e));
|
||||
taskToRun.errorCount++;
|
||||
logger.log('error', `Task "${taskToRun.name || 'unnamed'}" failed: ${taskToRun.lastError.message}`);
|
||||
if (taskToRun.catchErrors) {
|
||||
return undefined;
|
||||
}
|
||||
throw e;
|
||||
}
|
||||
})
|
||||
.then((x) => {
|
||||
@@ -155,10 +152,18 @@ export class Task<T = undefined, TSteps extends ReadonlyArray<{ name: string; de
|
||||
done.resolve(x);
|
||||
})
|
||||
.catch((err) => {
|
||||
console.log(err);
|
||||
done.reject(err);
|
||||
});
|
||||
localDeferred.resolve();
|
||||
return await done.promise;
|
||||
|
||||
try {
|
||||
return await done.promise;
|
||||
} catch (err) {
|
||||
if (taskToRun.catchErrors) {
|
||||
return undefined;
|
||||
}
|
||||
throw err;
|
||||
}
|
||||
};
|
||||
|
||||
public name: string;
|
||||
@@ -168,18 +173,12 @@ export class Task<T = undefined, TSteps extends ReadonlyArray<{ name: string; de
|
||||
public cronJob: plugins.smarttime.CronJob;
|
||||
|
||||
public bufferMax: number;
|
||||
public execDelay: number;
|
||||
public timeout: number;
|
||||
|
||||
public preTask: Task<T, any> | TPreOrAfterTaskFunction;
|
||||
public afterTask: Task<T, any> | TPreOrAfterTaskFunction;
|
||||
public data: TData;
|
||||
|
||||
// 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;
|
||||
public preTask: Task<T, any, any> | TPreOrAfterTaskFunction;
|
||||
public afterTask: Task<T, any, any> | TPreOrAfterTaskFunction;
|
||||
|
||||
public running: boolean = false;
|
||||
public bufferRunner = new BufferRunner(this);
|
||||
@@ -187,10 +186,53 @@ export class Task<T = undefined, TSteps extends ReadonlyArray<{ name: string; de
|
||||
public lastRun?: Date;
|
||||
public runCount: number = 0;
|
||||
|
||||
// Error handling
|
||||
public catchErrors: boolean = false;
|
||||
public lastError?: Error;
|
||||
public errorCount: number = 0;
|
||||
public labels: Record<string, string> = {};
|
||||
public readonly eventSubject = new plugins.smartrx.rxjs.Subject<ITaskEvent>();
|
||||
|
||||
public get idle() {
|
||||
return !this.running;
|
||||
}
|
||||
|
||||
public clearError(): void {
|
||||
this.lastError = undefined;
|
||||
}
|
||||
|
||||
public setLabel(key: string, value: string): void {
|
||||
this.labels[key] = value;
|
||||
}
|
||||
|
||||
public getLabel(key: string): string | undefined {
|
||||
return this.labels[key];
|
||||
}
|
||||
|
||||
public removeLabel(key: string): boolean {
|
||||
if (key in this.labels) {
|
||||
delete this.labels[key];
|
||||
return true;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
public hasLabel(key: string, value?: string): boolean {
|
||||
if (value !== undefined) {
|
||||
return this.labels[key] === value;
|
||||
}
|
||||
return key in this.labels;
|
||||
}
|
||||
|
||||
private emitEvent(type: TTaskEventType, extra?: Partial<ITaskEvent>): void {
|
||||
this.eventSubject.next({
|
||||
type,
|
||||
task: this.getMetadata(),
|
||||
timestamp: Date.now(),
|
||||
...extra,
|
||||
});
|
||||
}
|
||||
|
||||
public taskSetup: ITaskSetupFunction<T>;
|
||||
public setupValue: T;
|
||||
|
||||
@@ -202,23 +244,27 @@ export class Task<T = undefined, TSteps extends ReadonlyArray<{ name: string; de
|
||||
|
||||
constructor(optionsArg: {
|
||||
taskFunction: ITaskFunction<T>;
|
||||
preTask?: Task<T, any> | TPreOrAfterTaskFunction;
|
||||
afterTask?: Task<T, any> | TPreOrAfterTaskFunction;
|
||||
preTask?: Task<T, any, any> | TPreOrAfterTaskFunction;
|
||||
afterTask?: Task<T, any, any> | TPreOrAfterTaskFunction;
|
||||
buffered?: boolean;
|
||||
bufferMax?: number;
|
||||
execDelay?: number;
|
||||
name?: string;
|
||||
data?: TData;
|
||||
taskSetup?: ITaskSetupFunction<T>;
|
||||
steps?: TSteps;
|
||||
catchErrors?: boolean;
|
||||
labels?: Record<string, string>;
|
||||
}) {
|
||||
this.taskFunction = optionsArg.taskFunction;
|
||||
this.preTask = optionsArg.preTask;
|
||||
this.afterTask = optionsArg.afterTask;
|
||||
this.buffered = optionsArg.buffered;
|
||||
this.bufferMax = optionsArg.bufferMax;
|
||||
this.execDelay = optionsArg.execDelay;
|
||||
this.name = optionsArg.name;
|
||||
this.data = optionsArg.data ?? ({} as TData);
|
||||
this.taskSetup = optionsArg.taskSetup;
|
||||
this.catchErrors = optionsArg.catchErrors ?? false;
|
||||
this.labels = optionsArg.labels ? { ...optionsArg.labels } : {};
|
||||
|
||||
// Initialize steps if provided
|
||||
if (optionsArg.steps) {
|
||||
@@ -232,11 +278,6 @@ export class Task<T = undefined, TSteps extends ReadonlyArray<{ name: string; de
|
||||
this.steps.set(stepConfig.name, step);
|
||||
}
|
||||
}
|
||||
|
||||
// Create the finished promise
|
||||
this.finished = new Promise((resolve) => {
|
||||
this.resolveFinished = resolve;
|
||||
});
|
||||
}
|
||||
|
||||
public trigger(x?: any): Promise<any> {
|
||||
@@ -271,8 +312,8 @@ export class Task<T = undefined, TSteps extends ReadonlyArray<{ name: string; de
|
||||
if (step) {
|
||||
step.start();
|
||||
this.currentStepName = stepName as string;
|
||||
|
||||
// Emit event for frontend updates (could be enhanced with event emitter)
|
||||
this.emitEvent('step', { stepName: stepName as string });
|
||||
|
||||
if (this.name) {
|
||||
logger.log('info', `Task ${this.name}: Starting step "${stepName}" - ${step.description}`);
|
||||
}
|
||||
@@ -306,10 +347,21 @@ export class Task<T = undefined, TSteps extends ReadonlyArray<{ name: string; de
|
||||
|
||||
// Get task metadata
|
||||
public getMetadata(): ITaskMetadata {
|
||||
let status: 'idle' | 'running' | 'completed' | 'failed';
|
||||
if (this.running) {
|
||||
status = 'running';
|
||||
} else if (this.lastError) {
|
||||
status = 'failed';
|
||||
} else if (this.runCount > 0) {
|
||||
status = 'completed';
|
||||
} else {
|
||||
status = 'idle';
|
||||
}
|
||||
|
||||
return {
|
||||
name: this.name || 'unnamed',
|
||||
version: this.version,
|
||||
status: this.running ? 'running' : 'idle',
|
||||
status,
|
||||
steps: this.getStepsMetadata(),
|
||||
currentStep: this.currentStepName,
|
||||
currentProgress: this.getProgress(),
|
||||
@@ -318,6 +370,9 @@ export class Task<T = undefined, TSteps extends ReadonlyArray<{ name: string; de
|
||||
bufferMax: this.bufferMax,
|
||||
timeout: this.timeout,
|
||||
cronSchedule: this.cronJob?.cronExpression,
|
||||
lastError: this.lastError?.message,
|
||||
errorCount: this.errorCount,
|
||||
labels: { ...this.labels },
|
||||
};
|
||||
}
|
||||
|
||||
|
||||
@@ -27,18 +27,20 @@ export class Taskchain extends Task {
|
||||
let taskCounter = 0; // counter for iterating async over the taskArray
|
||||
const iterateTasks = (x: any) => {
|
||||
if (typeof this.taskArray[taskCounter] !== 'undefined') {
|
||||
console.log(
|
||||
this.name + ' running: Task' + this.taskArray[taskCounter].name,
|
||||
);
|
||||
logger.log('info', `${this.name} running: Task ${this.taskArray[taskCounter].name}`);
|
||||
this.taskArray[taskCounter].trigger(x).then((x) => {
|
||||
logger.log('info', this.taskArray[taskCounter].name);
|
||||
taskCounter++;
|
||||
iterateTasks(x);
|
||||
}).catch((err) => {
|
||||
const chainError = new Error(
|
||||
`Taskchain "${this.name}": task "${this.taskArray[taskCounter].name || 'unnamed'}" (index ${taskCounter}) failed: ${err instanceof Error ? err.message : String(err)}`
|
||||
);
|
||||
(chainError as any).cause = err;
|
||||
done.reject(chainError);
|
||||
});
|
||||
} else {
|
||||
console.log(
|
||||
'Taskchain "' + this.name + '" completed successfully',
|
||||
);
|
||||
logger.log('info', `Taskchain "${this.name}" completed successfully`);
|
||||
done.resolve(x);
|
||||
}
|
||||
};
|
||||
@@ -53,10 +55,15 @@ export class Taskchain extends Task {
|
||||
addTask(taskArg: Task) {
|
||||
this.taskArray.push(taskArg);
|
||||
}
|
||||
removeTask(taskArg: Task) {
|
||||
// TODO:
|
||||
removeTask(taskArg: Task): boolean {
|
||||
const index = this.taskArray.indexOf(taskArg);
|
||||
if (index === -1) {
|
||||
return false;
|
||||
}
|
||||
this.taskArray.splice(index, 1);
|
||||
return true;
|
||||
}
|
||||
shiftTask() {
|
||||
// TODO:
|
||||
shiftTask(): Task | undefined {
|
||||
return this.taskArray.shift();
|
||||
}
|
||||
}
|
||||
|
||||
80
ts/taskbuffer.classes.taskconstraintgroup.ts
Normal file
80
ts/taskbuffer.classes.taskconstraintgroup.ts
Normal file
@@ -0,0 +1,80 @@
|
||||
import type { Task } from './taskbuffer.classes.task.js';
|
||||
import type { ITaskConstraintGroupOptions } from './taskbuffer.interfaces.js';
|
||||
|
||||
export class TaskConstraintGroup<TData extends Record<string, unknown> = Record<string, unknown>> {
|
||||
public name: string;
|
||||
public maxConcurrent: number;
|
||||
public cooldownMs: number;
|
||||
private constraintKeyForTask: (task: Task<any, any, TData>) => string | null | undefined;
|
||||
|
||||
private runningCounts = new Map<string, number>();
|
||||
private lastCompletionTimes = new Map<string, number>();
|
||||
|
||||
constructor(options: ITaskConstraintGroupOptions<TData>) {
|
||||
this.name = options.name;
|
||||
this.constraintKeyForTask = options.constraintKeyForTask;
|
||||
this.maxConcurrent = options.maxConcurrent ?? Infinity;
|
||||
this.cooldownMs = options.cooldownMs ?? 0;
|
||||
}
|
||||
|
||||
public getConstraintKey(task: Task<any, any, TData>): string | null {
|
||||
const key = this.constraintKeyForTask(task);
|
||||
return key ?? null;
|
||||
}
|
||||
|
||||
public canRun(subGroupKey: string): boolean {
|
||||
const running = this.runningCounts.get(subGroupKey) ?? 0;
|
||||
if (running >= this.maxConcurrent) {
|
||||
return false;
|
||||
}
|
||||
|
||||
if (this.cooldownMs > 0) {
|
||||
const lastCompletion = this.lastCompletionTimes.get(subGroupKey);
|
||||
if (lastCompletion !== undefined) {
|
||||
const elapsed = Date.now() - lastCompletion;
|
||||
if (elapsed < this.cooldownMs) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
public acquireSlot(subGroupKey: string): void {
|
||||
const current = this.runningCounts.get(subGroupKey) ?? 0;
|
||||
this.runningCounts.set(subGroupKey, current + 1);
|
||||
}
|
||||
|
||||
public releaseSlot(subGroupKey: string): void {
|
||||
const current = this.runningCounts.get(subGroupKey) ?? 0;
|
||||
const next = Math.max(0, current - 1);
|
||||
if (next === 0) {
|
||||
this.runningCounts.delete(subGroupKey);
|
||||
} else {
|
||||
this.runningCounts.set(subGroupKey, next);
|
||||
}
|
||||
this.lastCompletionTimes.set(subGroupKey, Date.now());
|
||||
}
|
||||
|
||||
public getCooldownRemaining(subGroupKey: string): number {
|
||||
if (this.cooldownMs <= 0) {
|
||||
return 0;
|
||||
}
|
||||
const lastCompletion = this.lastCompletionTimes.get(subGroupKey);
|
||||
if (lastCompletion === undefined) {
|
||||
return 0;
|
||||
}
|
||||
const elapsed = Date.now() - lastCompletion;
|
||||
return Math.max(0, this.cooldownMs - elapsed);
|
||||
}
|
||||
|
||||
public getRunningCount(subGroupKey: string): number {
|
||||
return this.runningCounts.get(subGroupKey) ?? 0;
|
||||
}
|
||||
|
||||
public reset(): void {
|
||||
this.runningCounts.clear();
|
||||
this.lastCompletionTimes.clear();
|
||||
}
|
||||
}
|
||||
@@ -1,6 +1,7 @@
|
||||
import * as plugins from './taskbuffer.plugins.js';
|
||||
|
||||
import { Task, type ITaskFunction } from './taskbuffer.classes.task.js';
|
||||
import { logger } from './taskbuffer.logging.js';
|
||||
|
||||
export class TaskDebounced<T = unknown> extends Task {
|
||||
private _debouncedTaskFunction: ITaskFunction;
|
||||
@@ -22,8 +23,17 @@ export class TaskDebounced<T = unknown> extends Task {
|
||||
.pipe(
|
||||
plugins.smartrx.rxjs.ops.debounceTime(optionsArg.debounceTimeInMillis),
|
||||
)
|
||||
.subscribe((x) => {
|
||||
this.taskFunction(x);
|
||||
.subscribe({
|
||||
next: async (x) => {
|
||||
try {
|
||||
await this.taskFunction(x);
|
||||
} catch (err) {
|
||||
logger.log('error', `TaskDebounced "${this.name || 'unnamed'}" failed: ${err instanceof Error ? err.message : String(err)}`);
|
||||
}
|
||||
},
|
||||
error: (err) => {
|
||||
logger.log('error', `TaskDebounced "${this.name || 'unnamed'}" observable error: ${err instanceof Error ? err.message : String(err)}`);
|
||||
},
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,10 +1,12 @@
|
||||
import * as plugins from './taskbuffer.plugins.js';
|
||||
import { Task } from './taskbuffer.classes.task.js';
|
||||
import { TaskConstraintGroup } from './taskbuffer.classes.taskconstraintgroup.js';
|
||||
import {
|
||||
AbstractDistributedCoordinator,
|
||||
type IDistributedTaskRequestResult,
|
||||
} from './taskbuffer.classes.distributedcoordinator.js';
|
||||
import type { ITaskMetadata, ITaskExecutionReport, IScheduledTaskInfo } from './taskbuffer.interfaces.js';
|
||||
import type { ITaskMetadata, ITaskExecutionReport, IScheduledTaskInfo, ITaskEvent, IConstrainedTaskEntry } from './taskbuffer.interfaces.js';
|
||||
import { logger } from './taskbuffer.logging.js';
|
||||
|
||||
export interface ICronJob {
|
||||
cronString: string;
|
||||
@@ -18,42 +20,175 @@ export interface ITaskManagerConstructorOptions {
|
||||
|
||||
export class TaskManager {
|
||||
public randomId = plugins.smartunique.shortId();
|
||||
public taskMap = new plugins.lik.ObjectMap<Task<any, any>>();
|
||||
public taskMap = new plugins.lik.ObjectMap<Task<any, any, any>>();
|
||||
public readonly taskSubject = new plugins.smartrx.rxjs.Subject<ITaskEvent>();
|
||||
private taskSubscriptions = new Map<Task<any, any, any>, plugins.smartrx.rxjs.Subscription>();
|
||||
private cronJobManager = new plugins.smarttime.CronManager();
|
||||
public options: ITaskManagerConstructorOptions = {
|
||||
distributedCoordinator: null,
|
||||
};
|
||||
|
||||
// Constraint system
|
||||
public constraintGroups: TaskConstraintGroup<any>[] = [];
|
||||
private constraintQueue: IConstrainedTaskEntry[] = [];
|
||||
private drainTimer: ReturnType<typeof setTimeout> | null = null;
|
||||
|
||||
constructor(options: ITaskManagerConstructorOptions = {}) {
|
||||
this.options = Object.assign(this.options, options);
|
||||
}
|
||||
|
||||
public getTaskByName(taskName: string): Task<any, any> {
|
||||
public getTaskByName(taskName: string): Task<any, any, any> {
|
||||
return this.taskMap.findSync((task) => task.name === taskName);
|
||||
}
|
||||
|
||||
public addTask(task: Task<any, any>): void {
|
||||
public addTask(task: Task<any, any, any>): void {
|
||||
if (!task.name) {
|
||||
throw new Error('Task must have a name to be added to taskManager');
|
||||
}
|
||||
this.taskMap.add(task);
|
||||
const subscription = task.eventSubject.subscribe((event) => {
|
||||
this.taskSubject.next(event);
|
||||
});
|
||||
this.taskSubscriptions.set(task, subscription);
|
||||
}
|
||||
|
||||
public addAndScheduleTask(task: Task<any, any>, cronString: string) {
|
||||
public removeTask(task: Task<any, any, any>): void {
|
||||
this.taskMap.remove(task);
|
||||
const subscription = this.taskSubscriptions.get(task);
|
||||
if (subscription) {
|
||||
subscription.unsubscribe();
|
||||
this.taskSubscriptions.delete(task);
|
||||
}
|
||||
}
|
||||
|
||||
public addAndScheduleTask(task: Task<any, any, any>, cronString: string) {
|
||||
this.addTask(task);
|
||||
this.scheduleTaskByName(task.name, cronString);
|
||||
}
|
||||
|
||||
// Constraint group management
|
||||
public addConstraintGroup(group: TaskConstraintGroup<any>): void {
|
||||
this.constraintGroups.push(group);
|
||||
}
|
||||
|
||||
public removeConstraintGroup(name: string): void {
|
||||
this.constraintGroups = this.constraintGroups.filter((g) => g.name !== name);
|
||||
}
|
||||
|
||||
// Core constraint evaluation
|
||||
public async triggerTaskConstrained(task: Task<any, any, any>, input?: any): Promise<any> {
|
||||
// Gather applicable constraints
|
||||
const applicableGroups: Array<{ group: TaskConstraintGroup<any>; key: string }> = [];
|
||||
for (const group of this.constraintGroups) {
|
||||
const key = group.getConstraintKey(task);
|
||||
if (key !== null) {
|
||||
applicableGroups.push({ group, key });
|
||||
}
|
||||
}
|
||||
|
||||
// No constraints apply → trigger directly
|
||||
if (applicableGroups.length === 0) {
|
||||
return task.trigger(input);
|
||||
}
|
||||
|
||||
// Check if all constraints allow running
|
||||
const allCanRun = applicableGroups.every(({ group, key }) => group.canRun(key));
|
||||
if (allCanRun) {
|
||||
return this.executeWithConstraintTracking(task, input, applicableGroups);
|
||||
}
|
||||
|
||||
// Blocked → enqueue with deferred promise
|
||||
const deferred = plugins.smartpromise.defer<any>();
|
||||
this.constraintQueue.push({ task, input, deferred });
|
||||
return deferred.promise;
|
||||
}
|
||||
|
||||
private async executeWithConstraintTracking(
|
||||
task: Task<any, any, any>,
|
||||
input: any,
|
||||
groups: Array<{ group: TaskConstraintGroup<any>; key: string }>,
|
||||
): Promise<any> {
|
||||
// Acquire slots
|
||||
for (const { group, key } of groups) {
|
||||
group.acquireSlot(key);
|
||||
}
|
||||
|
||||
try {
|
||||
return await task.trigger(input);
|
||||
} finally {
|
||||
// Release slots
|
||||
for (const { group, key } of groups) {
|
||||
group.releaseSlot(key);
|
||||
}
|
||||
this.drainConstraintQueue();
|
||||
}
|
||||
}
|
||||
|
||||
private drainConstraintQueue(): void {
|
||||
let shortestCooldown = Infinity;
|
||||
const stillQueued: IConstrainedTaskEntry[] = [];
|
||||
|
||||
for (const entry of this.constraintQueue) {
|
||||
const applicableGroups: Array<{ group: TaskConstraintGroup<any>; key: string }> = [];
|
||||
for (const group of this.constraintGroups) {
|
||||
const key = group.getConstraintKey(entry.task);
|
||||
if (key !== null) {
|
||||
applicableGroups.push({ group, key });
|
||||
}
|
||||
}
|
||||
|
||||
// No constraints apply anymore (group removed?) → run directly
|
||||
if (applicableGroups.length === 0) {
|
||||
entry.task.trigger(entry.input).then(
|
||||
(result) => entry.deferred.resolve(result),
|
||||
(err) => entry.deferred.reject(err),
|
||||
);
|
||||
continue;
|
||||
}
|
||||
|
||||
const allCanRun = applicableGroups.every(({ group, key }) => group.canRun(key));
|
||||
if (allCanRun) {
|
||||
this.executeWithConstraintTracking(entry.task, entry.input, applicableGroups).then(
|
||||
(result) => entry.deferred.resolve(result),
|
||||
(err) => entry.deferred.reject(err),
|
||||
);
|
||||
} else {
|
||||
stillQueued.push(entry);
|
||||
// Track shortest cooldown for timer scheduling
|
||||
for (const { group, key } of applicableGroups) {
|
||||
const remaining = group.getCooldownRemaining(key);
|
||||
if (remaining > 0 && remaining < shortestCooldown) {
|
||||
shortestCooldown = remaining;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
this.constraintQueue = stillQueued;
|
||||
|
||||
// Schedule next drain if there are cooldown-blocked entries
|
||||
if (this.drainTimer) {
|
||||
clearTimeout(this.drainTimer);
|
||||
this.drainTimer = null;
|
||||
}
|
||||
if (stillQueued.length > 0 && shortestCooldown < Infinity) {
|
||||
this.drainTimer = setTimeout(() => {
|
||||
this.drainTimer = null;
|
||||
this.drainConstraintQueue();
|
||||
}, shortestCooldown + 1);
|
||||
}
|
||||
}
|
||||
|
||||
public async triggerTaskByName(taskName: string): Promise<any> {
|
||||
const taskToTrigger = this.getTaskByName(taskName);
|
||||
if (!taskToTrigger) {
|
||||
throw new Error(`No task with the name ${taskName} found.`);
|
||||
}
|
||||
return taskToTrigger.trigger();
|
||||
return this.triggerTaskConstrained(taskToTrigger);
|
||||
}
|
||||
|
||||
public async triggerTask(task: Task<any, any>) {
|
||||
return task.trigger();
|
||||
public async triggerTask(task: Task<any, any, any>) {
|
||||
return this.triggerTaskConstrained(task);
|
||||
}
|
||||
|
||||
public scheduleTaskByName(taskName: string, cronString: string) {
|
||||
@@ -64,7 +199,7 @@ export class TaskManager {
|
||||
this.handleTaskScheduling(taskToSchedule, cronString);
|
||||
}
|
||||
|
||||
private handleTaskScheduling(task: Task<any, any>, cronString: string) {
|
||||
private handleTaskScheduling(task: Task<any, any, any>, cronString: string) {
|
||||
const cronJob = this.cronJobManager.addCronjob(
|
||||
cronString,
|
||||
async (triggerTime: number) => {
|
||||
@@ -75,31 +210,35 @@ export class TaskManager {
|
||||
triggerTime,
|
||||
);
|
||||
if (!announcementResult.shouldTrigger) {
|
||||
console.log('Distributed coordinator result: NOT EXECUTING');
|
||||
logger.log('info', 'Distributed coordinator result: NOT EXECUTING');
|
||||
return;
|
||||
} else {
|
||||
console.log('Distributed coordinator result: CHOSEN AND EXECUTING');
|
||||
logger.log('info', 'Distributed coordinator result: CHOSEN AND EXECUTING');
|
||||
}
|
||||
}
|
||||
await task.trigger();
|
||||
try {
|
||||
await this.triggerTaskConstrained(task);
|
||||
} catch (err) {
|
||||
logger.log('error', `TaskManager: scheduled task "${task.name || 'unnamed'}" failed: ${err instanceof Error ? err.message : String(err)}`);
|
||||
}
|
||||
},
|
||||
);
|
||||
task.cronJob = cronJob;
|
||||
}
|
||||
|
||||
private logTaskState(task: Task<any, any>) {
|
||||
console.log(`Taskbuffer schedule triggered task >>${task.name}<<`);
|
||||
private logTaskState(task: Task<any, any, any>) {
|
||||
logger.log('info', `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}`);
|
||||
logger.log('info', `Task >>${task.name}<< is ${bufferState}`);
|
||||
}
|
||||
|
||||
private async performDistributedConsultation(
|
||||
task: Task<any, any>,
|
||||
task: Task<any, any, any>,
|
||||
triggerTime: number,
|
||||
): Promise<IDistributedTaskRequestResult> {
|
||||
console.log('Found a distributed coordinator, performing consultation.');
|
||||
logger.log('info', 'Found a distributed coordinator, performing consultation.');
|
||||
|
||||
return this.options.distributedCoordinator.fireDistributedTaskRequest({
|
||||
submitterId: this.randomId,
|
||||
@@ -124,7 +263,7 @@ export class TaskManager {
|
||||
}
|
||||
}
|
||||
|
||||
public async descheduleTask(task: Task<any, any>) {
|
||||
public async descheduleTask(task: Task<any, any, any>) {
|
||||
await this.descheduleTaskByName(task.name);
|
||||
}
|
||||
|
||||
@@ -145,6 +284,14 @@ export class TaskManager {
|
||||
if (this.options.distributedCoordinator) {
|
||||
await this.options.distributedCoordinator.stop();
|
||||
}
|
||||
for (const [, subscription] of this.taskSubscriptions) {
|
||||
subscription.unsubscribe();
|
||||
}
|
||||
this.taskSubscriptions.clear();
|
||||
if (this.drainTimer) {
|
||||
clearTimeout(this.drainTimer);
|
||||
this.drainTimer = null;
|
||||
}
|
||||
}
|
||||
|
||||
// Get metadata for a specific task
|
||||
@@ -162,7 +309,7 @@ export class TaskManager {
|
||||
// Get scheduled tasks with their schedules and next run times
|
||||
public getScheduledTasks(): IScheduledTaskInfo[] {
|
||||
const scheduledTasks: IScheduledTaskInfo[] = [];
|
||||
|
||||
|
||||
for (const task of this.taskMap.getArray()) {
|
||||
if (task.cronJob) {
|
||||
scheduledTasks.push({
|
||||
@@ -175,7 +322,7 @@ export class TaskManager {
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
return scheduledTasks;
|
||||
}
|
||||
|
||||
@@ -189,13 +336,21 @@ export class TaskManager {
|
||||
}))
|
||||
.sort((a, b) => a.nextRun.getTime() - b.nextRun.getTime())
|
||||
.slice(0, limit);
|
||||
|
||||
|
||||
return scheduledRuns;
|
||||
}
|
||||
|
||||
public getTasksByLabel(key: string, value: string): Task<any, any, any>[] {
|
||||
return this.taskMap.getArray().filter(task => task.labels[key] === value);
|
||||
}
|
||||
|
||||
public getTasksMetadataByLabel(key: string, value: string): ITaskMetadata[] {
|
||||
return this.getTasksByLabel(key, value).map(task => task.getMetadata());
|
||||
}
|
||||
|
||||
// Add, execute, and remove a task while collecting metadata
|
||||
public async addExecuteRemoveTask<T, TSteps extends ReadonlyArray<{ name: string; description: string; percentage: number }>>(
|
||||
task: Task<T, TSteps>,
|
||||
task: Task<T, TSteps, any>,
|
||||
options?: {
|
||||
schedule?: string;
|
||||
trackProgress?: boolean;
|
||||
@@ -203,19 +358,18 @@ export class TaskManager {
|
||||
): Promise<ITaskExecutionReport> {
|
||||
// Add task to manager
|
||||
this.addTask(task);
|
||||
|
||||
|
||||
// Optionally schedule it
|
||||
if (options?.schedule) {
|
||||
this.scheduleTaskByName(task.name!, options.schedule);
|
||||
}
|
||||
|
||||
|
||||
const startTime = Date.now();
|
||||
const progressUpdates: Array<{ stepName: string; timestamp: number }> = [];
|
||||
|
||||
|
||||
try {
|
||||
// Execute the task
|
||||
const result = await task.trigger();
|
||||
|
||||
// Execute the task through constraints
|
||||
const result = await this.triggerTaskConstrained(task);
|
||||
|
||||
// Collect execution report
|
||||
const report: ITaskExecutionReport = {
|
||||
taskName: task.name || 'unnamed',
|
||||
@@ -229,15 +383,15 @@ export class TaskManager {
|
||||
progress: task.getProgress(),
|
||||
result,
|
||||
};
|
||||
|
||||
|
||||
// Remove task from manager
|
||||
this.taskMap.remove(task);
|
||||
|
||||
this.removeTask(task);
|
||||
|
||||
// Deschedule if it was scheduled
|
||||
if (options?.schedule && task.name) {
|
||||
this.descheduleTaskByName(task.name);
|
||||
}
|
||||
|
||||
|
||||
return report;
|
||||
} catch (error) {
|
||||
// Create error report
|
||||
@@ -253,15 +407,15 @@ export class TaskManager {
|
||||
progress: task.getProgress(),
|
||||
error: error as Error,
|
||||
};
|
||||
|
||||
|
||||
// Remove task from manager even on error
|
||||
this.taskMap.remove(task);
|
||||
|
||||
this.removeTask(task);
|
||||
|
||||
// Deschedule if it was scheduled
|
||||
if (options?.schedule && task.name) {
|
||||
this.descheduleTaskByName(task.name);
|
||||
}
|
||||
|
||||
|
||||
throw errorReport;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -13,7 +13,9 @@ export class Taskparallel extends Task {
|
||||
this.taskArray.forEach(function (taskArg) {
|
||||
promiseArray.push(taskArg.trigger());
|
||||
});
|
||||
Promise.all(promiseArray).then(done.resolve);
|
||||
Promise.all(promiseArray)
|
||||
.then((results) => done.resolve(results))
|
||||
.catch((err) => done.reject(err));
|
||||
return done.promise;
|
||||
},
|
||||
},
|
||||
|
||||
@@ -1,64 +0,0 @@
|
||||
import * as plugins from './taskbuffer.plugins.js';
|
||||
|
||||
import { Task } from './taskbuffer.classes.task.js';
|
||||
|
||||
export class TaskRunner {
|
||||
public maxParrallelJobs: number = 1;
|
||||
public status: 'stopped' | 'running' = 'stopped';
|
||||
public runningTasks: plugins.lik.ObjectMap<Task> =
|
||||
new plugins.lik.ObjectMap<Task>();
|
||||
public qeuedTasks: Task[] = [];
|
||||
|
||||
constructor() {
|
||||
this.runningTasks.eventSubject.subscribe(async (eventArg) => {
|
||||
this.checkExecution();
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* adds a task to the qeue
|
||||
*/
|
||||
public addTask(taskArg: Task) {
|
||||
this.qeuedTasks.push(taskArg);
|
||||
this.checkExecution();
|
||||
}
|
||||
|
||||
/**
|
||||
* set amount of parallel tasks
|
||||
* be careful, you might loose dependability of tasks
|
||||
*/
|
||||
public setMaxParallelJobs(maxParrallelJobsArg: number) {
|
||||
this.maxParrallelJobs = maxParrallelJobsArg;
|
||||
}
|
||||
|
||||
/**
|
||||
* starts the task queue
|
||||
*/
|
||||
public async start() {
|
||||
this.status = 'running';
|
||||
}
|
||||
|
||||
/**
|
||||
* checks wether execution is on point
|
||||
*/
|
||||
public async checkExecution() {
|
||||
if (
|
||||
this.runningTasks.getArray().length < this.maxParrallelJobs &&
|
||||
this.status === 'running' &&
|
||||
this.qeuedTasks.length > 0
|
||||
) {
|
||||
const nextJob = this.qeuedTasks.shift();
|
||||
this.runningTasks.add(nextJob);
|
||||
await nextJob.trigger();
|
||||
this.runningTasks.remove(nextJob);
|
||||
this.checkExecution();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* stops the task queue
|
||||
*/
|
||||
public async stop() {
|
||||
this.status = 'stopped';
|
||||
}
|
||||
}
|
||||
@@ -1,4 +1,18 @@
|
||||
import type { ITaskStep } from './taskbuffer.classes.taskstep.js';
|
||||
import type { Task } from './taskbuffer.classes.task.js';
|
||||
|
||||
export interface ITaskConstraintGroupOptions<TData extends Record<string, unknown> = Record<string, unknown>> {
|
||||
name: string;
|
||||
constraintKeyForTask: (task: Task<any, any, TData>) => string | null | undefined;
|
||||
maxConcurrent?: number; // default: Infinity
|
||||
cooldownMs?: number; // default: 0
|
||||
}
|
||||
|
||||
export interface IConstrainedTaskEntry {
|
||||
task: Task<any, any, any>;
|
||||
input: any;
|
||||
deferred: import('@push.rocks/smartpromise').Deferred<any>;
|
||||
}
|
||||
|
||||
export interface ITaskMetadata {
|
||||
name: string;
|
||||
@@ -15,6 +29,9 @@ export interface ITaskMetadata {
|
||||
buffered?: boolean;
|
||||
bufferMax?: number;
|
||||
timeout?: number;
|
||||
lastError?: string;
|
||||
errorCount?: number;
|
||||
labels?: Record<string, string>;
|
||||
}
|
||||
|
||||
export interface ITaskExecutionReport {
|
||||
@@ -36,4 +53,14 @@ export interface IScheduledTaskInfo {
|
||||
lastRun?: Date;
|
||||
steps?: ITaskStep[];
|
||||
metadata?: ITaskMetadata;
|
||||
}
|
||||
|
||||
export type TTaskEventType = 'started' | 'step' | 'completed' | 'failed';
|
||||
|
||||
export interface ITaskEvent {
|
||||
type: TTaskEventType;
|
||||
task: ITaskMetadata;
|
||||
timestamp: number;
|
||||
stepName?: string; // present when type === 'step'
|
||||
error?: string; // present when type === 'failed'
|
||||
}
|
||||
@@ -3,6 +3,6 @@
|
||||
*/
|
||||
export const commitinfo = {
|
||||
name: '@push.rocks/taskbuffer',
|
||||
version: '3.5.0',
|
||||
version: '5.0.1',
|
||||
description: 'A flexible task management library supporting TypeScript, allowing for task buffering, scheduling, and execution with dependency management.'
|
||||
}
|
||||
|
||||
@@ -8,20 +8,20 @@ import type { TaskManager, ITaskMetadata, IScheduledTaskInfo } from '../ts/index
|
||||
export class TaskbufferDashboard extends DeesElement {
|
||||
// Properties
|
||||
@property({ type: Object })
|
||||
public taskManager: TaskManager | null = null;
|
||||
accessor taskManager: TaskManager | null = null;
|
||||
|
||||
@property({ type: Number })
|
||||
public refreshInterval: number = 1000; // milliseconds
|
||||
accessor refreshInterval: number = 1000; // milliseconds
|
||||
|
||||
// Internal state
|
||||
@state()
|
||||
private tasks: ITaskMetadata[] = [];
|
||||
accessor tasks: ITaskMetadata[] = [];
|
||||
|
||||
@state()
|
||||
private scheduledTasks: IScheduledTaskInfo[] = [];
|
||||
accessor scheduledTasks: IScheduledTaskInfo[] = [];
|
||||
|
||||
@state()
|
||||
private isRunning: boolean = false;
|
||||
accessor isRunning: boolean = false;
|
||||
|
||||
private refreshTimer: any;
|
||||
|
||||
|
||||
Reference in New Issue
Block a user