Compare commits
39 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 1dd7ca46ff | |||
| 6110dd8e71 | |||
| 3d8fe65b55 | |||
| 6030fb2805 | |||
| 9a3a3e3eab | |||
| 248383aab1 | |||
| 905ca97b6a | |||
| 72f75aa7de | |||
| 2fb605a58e | |||
| ed1e9a08b2 | |||
| 4d23b3dbfe | |||
| 9784a5eacf | |||
| 6c9b975029 | |||
| b1725cbdf9 | |||
| d54012379c | |||
| dc47bc3d2a | |||
| 863adb3b8c | |||
| 67f01417b6 | |||
| 65886287c6 | |||
| fdaf772cfc | |||
| 757b992440 | |||
| b4a701d128 | |||
| ca3ef8ced6 | |||
| 6115bae66b | |||
| 1be83af475 | |||
| bd14c41edc | |||
| d61b79282d | |||
| 1cba9245fe | |||
| 4b0db4da21 | |||
| a6cd0cb579 | |||
| bd6109d5ea | |||
| aa632a5294 | |||
| 6499dd45cf | |||
| d04ed21607 | |||
| bae776d4e9 | |||
| fcd7ea467e | |||
| e061b96056 | |||
| c2ce669f0c | |||
| 05f91c3e35 |
@@ -6,8 +6,8 @@ on:
|
|||||||
- '**'
|
- '**'
|
||||||
|
|
||||||
env:
|
env:
|
||||||
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
IMAGE: code.foss.global/host.today/ht-docker-node:npmci
|
||||||
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
|
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@/${{gitea.repository}}.git
|
||||||
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
|
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
|
||||||
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
|
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
|
||||||
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
|
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
|
||||||
@@ -26,7 +26,7 @@ jobs:
|
|||||||
- name: Install pnpm and npmci
|
- name: Install pnpm and npmci
|
||||||
run: |
|
run: |
|
||||||
pnpm install -g pnpm
|
pnpm install -g pnpm
|
||||||
pnpm install -g @shipzone/npmci
|
pnpm install -g @ship.zone/npmci
|
||||||
|
|
||||||
- name: Run npm prepare
|
- name: Run npm prepare
|
||||||
run: npmci npm prepare
|
run: npmci npm prepare
|
||||||
|
|||||||
@@ -6,8 +6,8 @@ on:
|
|||||||
- '*'
|
- '*'
|
||||||
|
|
||||||
env:
|
env:
|
||||||
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
IMAGE: code.foss.global/host.today/ht-docker-node:npmci
|
||||||
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
|
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@/${{gitea.repository}}.git
|
||||||
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
|
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
|
||||||
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
|
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
|
||||||
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
|
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
|
||||||
@@ -26,7 +26,7 @@ jobs:
|
|||||||
- name: Prepare
|
- name: Prepare
|
||||||
run: |
|
run: |
|
||||||
pnpm install -g pnpm
|
pnpm install -g pnpm
|
||||||
pnpm install -g @shipzone/npmci
|
pnpm install -g @ship.zone/npmci
|
||||||
npmci npm prepare
|
npmci npm prepare
|
||||||
|
|
||||||
- name: Audit production dependencies
|
- name: Audit production dependencies
|
||||||
@@ -54,7 +54,7 @@ jobs:
|
|||||||
- name: Prepare
|
- name: Prepare
|
||||||
run: |
|
run: |
|
||||||
pnpm install -g pnpm
|
pnpm install -g pnpm
|
||||||
pnpm install -g @shipzone/npmci
|
pnpm install -g @ship.zone/npmci
|
||||||
npmci npm prepare
|
npmci npm prepare
|
||||||
|
|
||||||
- name: Test stable
|
- name: Test stable
|
||||||
@@ -82,7 +82,7 @@ jobs:
|
|||||||
- name: Prepare
|
- name: Prepare
|
||||||
run: |
|
run: |
|
||||||
pnpm install -g pnpm
|
pnpm install -g pnpm
|
||||||
pnpm install -g @shipzone/npmci
|
pnpm install -g @ship.zone/npmci
|
||||||
npmci npm prepare
|
npmci npm prepare
|
||||||
|
|
||||||
- name: Release
|
- name: Release
|
||||||
@@ -104,7 +104,7 @@ jobs:
|
|||||||
- name: Prepare
|
- name: Prepare
|
||||||
run: |
|
run: |
|
||||||
pnpm install -g pnpm
|
pnpm install -g pnpm
|
||||||
pnpm install -g @shipzone/npmci
|
pnpm install -g @ship.zone/npmci
|
||||||
npmci npm prepare
|
npmci npm prepare
|
||||||
|
|
||||||
- name: Code quality
|
- name: Code quality
|
||||||
@@ -119,6 +119,6 @@ jobs:
|
|||||||
run: |
|
run: |
|
||||||
npmci node install stable
|
npmci node install stable
|
||||||
npmci npm install
|
npmci npm install
|
||||||
pnpm install -g @gitzone/tsdoc
|
pnpm install -g @git.zone/tsdoc
|
||||||
npmci command tsdoc
|
npmci command tsdoc
|
||||||
continue-on-error: true
|
continue-on-error: true
|
||||||
|
|||||||
7
.gitignore
vendored
7
.gitignore
vendored
@@ -3,7 +3,6 @@
|
|||||||
# artifacts
|
# artifacts
|
||||||
coverage/
|
coverage/
|
||||||
public/
|
public/
|
||||||
pages/
|
|
||||||
|
|
||||||
# installs
|
# installs
|
||||||
node_modules/
|
node_modules/
|
||||||
@@ -17,4 +16,8 @@ node_modules/
|
|||||||
dist/
|
dist/
|
||||||
dist_*/
|
dist_*/
|
||||||
|
|
||||||
# custom
|
# AI
|
||||||
|
.claude/
|
||||||
|
.serena/
|
||||||
|
|
||||||
|
#------# custom
|
||||||
2
LICENSE
2
LICENSE
@@ -1,6 +1,6 @@
|
|||||||
The MIT License (MIT)
|
The MIT License (MIT)
|
||||||
|
|
||||||
Copyright (c) 2016 Push.Rocks
|
Copyright (c) 2016 Task Venture Capital GmbH <hello@task.vc>
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
|||||||
180
changelog.md
Normal file
180
changelog.md
Normal file
@@ -0,0 +1,180 @@
|
|||||||
|
# Changelog
|
||||||
|
|
||||||
|
## 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
|
||||||
|
|
||||||
|
- Add TaskDebounced class to coalesce rapid triggers into a single execution (debounce behavior).
|
||||||
|
- Introduce step tracking and progress reporting on Task via TaskStep, getProgress(), getStepsMetadata(), getMetadata(), resetSteps(), and completeAllSteps().
|
||||||
|
- Enhance buffered execution flow: BufferRunner and CycleCounter improvements to better coordinate buffered runs and cycle promises.
|
||||||
|
- Standardize concurrent runner naming (Taskparallel) and update related exports/usages (ts/index.ts, readme examples).
|
||||||
|
- Enhance TaskManager scheduling/metadata: getScheduledTasks now returns schedule and nextRun, addExecuteRemoveTask collects execution report metadata and cleans up after execution, distributed coordination hooks retained.
|
||||||
|
- Add/upgrade web dashboard UI, demos and refresh logic to surface task metadata, scheduled tasks and progress.
|
||||||
|
- Bump runtime and dev dependencies (multiple @push.rocks packages and @git.zone tooling).
|
||||||
|
- Update tests: reduce iteration threshold and tighten schedule interval in test/test.4.taskmanager.ts.
|
||||||
|
- Remove several .serena memory files (project overview, style guides and suggested commands) as cleanup.
|
||||||
|
|
||||||
|
## 2025-09-07 - 3.4.0 - feat(taskbuffer-dashboard)
|
||||||
|
Add TaskBuffer dashboard web component, demo and browser tests; add HTML entry and update dependencies
|
||||||
|
|
||||||
|
- Introduce a new web component taskbuffer-dashboard for real-time visualization of tasks and schedules (ts_web/taskbuffer-dashboard.ts).
|
||||||
|
- Add a demo wrapper and interactive UI for the dashboard (ts_web/elements/taskbuffer-dashboard.demo.ts).
|
||||||
|
- Provide web exports and typings for web usage (ts_web/index.ts) and include an HTML entry (html/index.html).
|
||||||
|
- Add browser-oriented tests to validate metadata structures for the web component (test/test.10.webcomponent.browser.ts).
|
||||||
|
- Bump package version to 3.3.0 in package.json as part of this change.
|
||||||
|
- Update/add dependencies and devDependencies (@design.estate/dees-element added; smartlog, @git.zone/tsbuild and @git.zone/tstest bumped).
|
||||||
|
|
||||||
|
## 2025-09-06 - 3.2.0 - feat(core)
|
||||||
|
Add step-based progress tracking, task metadata and enhanced TaskManager scheduling/metadata APIs
|
||||||
|
|
||||||
|
- Introduce TaskStep class for named, weighted steps with timing and status (pending|active|completed).
|
||||||
|
- Add step-tracking to Task: notifyStep, getProgress, getStepsMetadata, getMetadata, resetSteps and internal step lifecycle handling.
|
||||||
|
- Task now records runCount and lastRun; Task.run flow resets/cleans steps and aggregates progress.
|
||||||
|
- TaskManager enhancements: schedule/deschedule improvements, performDistributedConsultation, and new metadata-focused APIs: getTaskMetadata, getAllTasksMetadata, getScheduledTasks, getNextScheduledRuns, addExecuteRemoveTask (exec + collect report).
|
||||||
|
- Exports updated: TaskStep and related types exported from index, plus Task metadata interfaces.
|
||||||
|
- Comprehensive README updates documenting step-based progress tracking, metadata, TaskManager and examples.
|
||||||
|
- New/updated tests added for step behavior and metadata (test/test.9.steps.ts) and other TS additions.
|
||||||
|
- Minor build/script change: build script updated to use 'tsbuild tsfolders'.
|
||||||
|
|
||||||
|
## 2025-08-26 - 3.1.10 - fix(task)
|
||||||
|
Implement core Task execution flow, buffering and lifecycle; update README with generics and buffer docs
|
||||||
|
|
||||||
|
- Implement Task.runTask including preTask/afterTask chaining, touched-task cycle prevention and error handling.
|
||||||
|
- Add Task helpers: extractTask, isTask, isTaskTouched and emptyTaskFunction (resolved promise).
|
||||||
|
- Introduce task lifecycle coordination: finished promise, resolveFinished, and blockingTasks to await dependent tasks.
|
||||||
|
- Support taskSetup/setupValue, execDelay handling, and wait-for-blocking-tasks before execution.
|
||||||
|
- Wire up trigger() to choose buffered vs unbuffered execution (triggerBuffered / triggerUnBuffered) and integrate BufferRunner.
|
||||||
|
- Improve logging and safer promise handling (caught errors are logged).
|
||||||
|
- Update README with extended TypeScript generics examples and expanded buffer behavior and strategies documentation.
|
||||||
|
|
||||||
|
## 2025-08-26 - 3.1.9 - fix(tests)
|
||||||
|
Update CI workflows, fix tests and refresh README/package metadata
|
||||||
|
|
||||||
|
- CI: switch Docker image to code.foss.global/host.today/ht-docker-node:npmci and adjust NPMCI_COMPUTED_REPOURL; replace npmci installer package name from @shipzone/npmci to @ship.zone/npmci in Gitea workflows
|
||||||
|
- Tests: update test imports to use @git.zone/tstest/tapbundle and apply small formatting fixes to test files
|
||||||
|
- Package metadata: update bugs URL and homepage to code.foss.global, add a pnpm.overrides placeholder in package.json
|
||||||
|
- .gitignore: add AI/tooling directories (.claude, .serena) and reorganize custom section
|
||||||
|
- Code style/TS fixes: minor formatting changes across ts sources (trailing commas, line breaks, consistent object/argument commas) and small API surface formatting fixes
|
||||||
|
- Documentation: whitespace/formatting cleanups in README and add changelog entry for 3.1.8
|
||||||
|
|
||||||
|
## 2025-08-26 - 3.1.8 - fix(tests)
|
||||||
|
|
||||||
|
Update test runner and imports, refresh README and package metadata, add project tooling/config files
|
||||||
|
|
||||||
|
- Replaced test imports from '@push.rocks/tapbundle' to '@git.zone/tstest/tapbundle' across test files
|
||||||
|
- Updated test script in package.json to run tstest with --verbose --logfile --timeout 120
|
||||||
|
- Bumped devDependency @git.zone/tstest to ^2.3.5 and adjusted package.json fields (typings, packageManager)
|
||||||
|
- Expanded and rewrote README with detailed examples, API reference, and usage guidance
|
||||||
|
- Refactored TaskManager tests (removed duplicate both-file and added consolidated test/test.4.taskmanager.ts)
|
||||||
|
- Added development/project tooling and metadata files (.claude settings, .serena project/memories) to aid local development and CI
|
||||||
|
|
||||||
|
## 2024-05-29 - 3.1.7 - maintenance/config
|
||||||
|
|
||||||
|
Updated package metadata and build configuration.
|
||||||
|
|
||||||
|
- Updated package description.
|
||||||
|
- Multiple TypeScript configuration updates (tsconfig).
|
||||||
|
- Updated npmextra.json githost entries (changes across 2024-03-30, 2024-04-01, 2024-04-14).
|
||||||
|
|
||||||
|
## 2023-08-04 - 3.0.15 - feat(Task)
|
||||||
|
|
||||||
|
Tasks can now be blocked by other tasks.
|
||||||
|
|
||||||
|
- Introduced task blocking support in the Task implementation.
|
||||||
|
- Release contains related maintenance and patch fixes.
|
||||||
|
|
||||||
|
## 2023-01-07 to 2023-10-20 - 3.0.4..3.1.6 - maintenance
|
||||||
|
|
||||||
|
Series of patch releases focused on core fixes and stability.
|
||||||
|
|
||||||
|
- Numerous core fixes and small adjustments across many patch versions.
|
||||||
|
- General maintenance: bug fixes, internal updates and stability improvements.
|
||||||
|
|
||||||
|
## 2022-03-25 - 2.1.17 - BREAKING(core)
|
||||||
|
|
||||||
|
Switched module format to ESM (breaking).
|
||||||
|
|
||||||
|
- BREAKING CHANGE: project now uses ESM module format.
|
||||||
|
- Release includes the version bump and migration to ESM.
|
||||||
|
|
||||||
|
## 2019-11-28 - 2.0.16 - feat(taskrunner)
|
||||||
|
|
||||||
|
Introduce a working task runner.
|
||||||
|
|
||||||
|
- Added/activated a working taskrunner implementation.
|
||||||
|
- Improvements to task execution and orchestration.
|
||||||
|
|
||||||
|
## 2019-09-05 to 2022-11-14 - 2.0.3..2.1.16 - maintenance
|
||||||
|
|
||||||
|
Ongoing maintenance and incremental fixes between 2.0.x and 2.1.x series.
|
||||||
|
|
||||||
|
- Multiple fixes labeled as core maintenance updates.
|
||||||
|
- CI, packaging and small doc/test fixes rolled out across these releases.
|
||||||
|
|
||||||
|
## 2018-08-04 - 2.0.0 - major
|
||||||
|
|
||||||
|
Major release and scope change with CI/test updates.
|
||||||
|
|
||||||
|
- Released 2.0.0 with updated docs.
|
||||||
|
- BREAKING CHANGE: package scope switched to @pushrocks (scope migration).
|
||||||
|
- CI and testing updates (moved to new tstest), package.json adjustments.
|
||||||
|
|
||||||
|
## 2017-07-12 - 1.0.21 - enhancements
|
||||||
|
|
||||||
|
Feature additions around task utilities and manager.
|
||||||
|
|
||||||
|
- Introduced TaskOnce.
|
||||||
|
- Implemented TaskManager (added TaskManager class and improvements across 1.0.10–1.0.16).
|
||||||
|
- Implemented execDelay for tasks.
|
||||||
|
- Documentation and test improvements.
|
||||||
|
|
||||||
|
## 2016-08-03 - 1.0.6 - types
|
||||||
|
|
||||||
|
Type and promise improvements.
|
||||||
|
|
||||||
|
- Now returns correct Promise types.
|
||||||
|
- Dependency and typings updates.
|
||||||
|
|
||||||
|
## 2016-08-01 - 1.0.0 - stable
|
||||||
|
|
||||||
|
First stable 1.0.0 release.
|
||||||
|
|
||||||
|
- Exported public interfaces.
|
||||||
|
- Base API stabilized for 1.x line.
|
||||||
|
|
||||||
|
## 2016-05-15 to 2016-05-06 - 0.1.0..0.0.5 - initial features
|
||||||
|
|
||||||
|
Initial implementation of core task primitives and utilities.
|
||||||
|
|
||||||
|
- Added Taskparallel class to execute tasks in parallel.
|
||||||
|
- Introduced basic Task class and working taskchain.
|
||||||
|
- Added logging and initial task buffering behavior.
|
||||||
|
- Improvements to README, typings and packaging.
|
||||||
|
- Early CI and build setup (Travis/GitLab CI).
|
||||||
21
html/index.html
Normal file
21
html/index.html
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta
|
||||||
|
name="viewport"
|
||||||
|
content="user-scalable=no, initial-scale=1, maximum-scale=1, minimum-scale=1, width=device-width, height=device-height"
|
||||||
|
/>
|
||||||
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||||
|
|
||||||
|
<style>
|
||||||
|
body {
|
||||||
|
margin: 0px;
|
||||||
|
background: #222222;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
|
||||||
|
<script type="module" src="/bundle.js"></script>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
@@ -1,18 +1,39 @@
|
|||||||
{
|
{
|
||||||
"npmci": {
|
"@git.zone/cli": {
|
||||||
"npmGlobalTools": [],
|
|
||||||
"npmAccessLevel": "public",
|
|
||||||
"npmRegistryUrl": "registry.npmjs.org"
|
|
||||||
},
|
|
||||||
"gitzone": {
|
|
||||||
"projectType": "npm",
|
"projectType": "npm",
|
||||||
"module": {
|
"module": {
|
||||||
"githost": "gitlab.com",
|
"githost": "code.foss.global",
|
||||||
"gitscope": "push.rocks",
|
"gitscope": "push.rocks",
|
||||||
"gitrepo": "taskbuffer",
|
"gitrepo": "taskbuffer",
|
||||||
"description": "flexible task management. TypeScript ready!",
|
"description": "A flexible task management library supporting TypeScript, allowing for task buffering, scheduling, and execution with dependency management.",
|
||||||
"npmPackagename": "@push.rocks/taskbuffer",
|
"npmPackagename": "@push.rocks/taskbuffer",
|
||||||
"license": "MIT"
|
"license": "MIT",
|
||||||
|
"keywords": [
|
||||||
|
"task management",
|
||||||
|
"TypeScript",
|
||||||
|
"task buffering",
|
||||||
|
"task scheduling",
|
||||||
|
"task execution",
|
||||||
|
"task dependencies",
|
||||||
|
"parallel tasks",
|
||||||
|
"task chains",
|
||||||
|
"debounced tasks",
|
||||||
|
"distributed coordination"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"release": {
|
||||||
|
"registries": [
|
||||||
|
"https://verdaccio.lossless.digital",
|
||||||
|
"https://registry.npmjs.org"
|
||||||
|
],
|
||||||
|
"accessLevel": "public"
|
||||||
}
|
}
|
||||||
|
},
|
||||||
|
"@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"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
57
package.json
57
package.json
@@ -1,49 +1,54 @@
|
|||||||
{
|
{
|
||||||
"name": "@push.rocks/taskbuffer",
|
"name": "@push.rocks/taskbuffer",
|
||||||
"version": "3.0.15",
|
"version": "4.1.1",
|
||||||
"private": false,
|
"private": false,
|
||||||
"description": "flexible task management. TypeScript ready!",
|
"description": "A flexible task management library supporting TypeScript, allowing for task buffering, scheduling, and execution with dependency management.",
|
||||||
"main": "dist_ts/index.js",
|
"main": "dist_ts/index.js",
|
||||||
"typings": "dist_ts/index.d.ts",
|
"typings": "dist_ts/index.d.ts",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"test": "(tstest test/ --web)",
|
"test": "(tstest test/ --verbose --logfile --timeout 120)",
|
||||||
"build": "(tsbuild --web && tsbundle npm)",
|
"build": "(tsbuild tsfolders)",
|
||||||
"buildDocs": "tsdoc"
|
"buildDocs": "tsdoc"
|
||||||
},
|
},
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "git+https://gitlab.com/pushrocks/taskbuffer.git"
|
"url": "https://code.foss.global/push.rocks/taskbuffer.git"
|
||||||
},
|
},
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"gulp",
|
"task management",
|
||||||
"task",
|
|
||||||
"buffer",
|
|
||||||
"TypeScript",
|
"TypeScript",
|
||||||
"push.rocks"
|
"task buffering",
|
||||||
|
"task scheduling",
|
||||||
|
"task execution",
|
||||||
|
"task dependencies",
|
||||||
|
"parallel tasks",
|
||||||
|
"task chains",
|
||||||
|
"debounced tasks",
|
||||||
|
"distributed coordination"
|
||||||
],
|
],
|
||||||
"author": "Lossless GmbH",
|
"author": "Lossless GmbH",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"bugs": {
|
"bugs": {
|
||||||
"url": "https://gitlab.com/pushrocks/taskbuffer/issues"
|
"url": "https://code.foss.global/push.rocks/taskbuffer/issues"
|
||||||
},
|
},
|
||||||
"homepage": "https://gitlab.com/pushrocks/taskbuffer#readme",
|
"homepage": "https://code.foss.global/push.rocks/taskbuffer#readme",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@push.rocks/isounique": "^1.0.5",
|
"@design.estate/dees-element": "^2.1.3",
|
||||||
"@push.rocks/lik": "^6.0.3",
|
"@push.rocks/lik": "^6.2.2",
|
||||||
"@push.rocks/smartdelay": "^3.0.5",
|
"@push.rocks/smartdelay": "^3.0.5",
|
||||||
"@push.rocks/smartlog": "^3.0.3",
|
"@push.rocks/smartlog": "^3.1.10",
|
||||||
"@push.rocks/smartpromise": "^4.0.3",
|
"@push.rocks/smartpromise": "^4.2.3",
|
||||||
"@push.rocks/smartrx": "^3.0.6",
|
"@push.rocks/smartrx": "^3.0.10",
|
||||||
"@push.rocks/smarttime": "^4.0.4"
|
"@push.rocks/smarttime": "^4.1.1",
|
||||||
|
"@push.rocks/smartunique": "^3.0.9"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@gitzone/tsbuild": "^2.1.66",
|
"@git.zone/tsbuild": "^3.1.2",
|
||||||
"@gitzone/tsbundle": "^2.0.8",
|
"@git.zone/tsbundle": "^2.6.3",
|
||||||
"@gitzone/tsrun": "^1.2.44",
|
"@git.zone/tsrun": "^2.0.0",
|
||||||
"@gitzone/tstest": "^1.0.77",
|
"@git.zone/tstest": "^3.1.3",
|
||||||
"@push.rocks/tapbundle": "^5.0.12",
|
"@types/node": "^24.10.1"
|
||||||
"@types/node": "^20.4.5"
|
|
||||||
},
|
},
|
||||||
"files": [
|
"files": [
|
||||||
"ts/**/*",
|
"ts/**/*",
|
||||||
@@ -59,5 +64,9 @@
|
|||||||
],
|
],
|
||||||
"browserslist": [
|
"browserslist": [
|
||||||
"last 1 chrome versions"
|
"last 1 chrome versions"
|
||||||
]
|
],
|
||||||
|
"packageManager": "pnpm@10.14.0+sha512.ad27a79641b49c3e481a16a805baa71817a04bbe06a38d17e60e2eaee83f6a146c6a688125f5792e48dd5ba30e7da52a5cda4c3992b9ccf333f9ce223af84748",
|
||||||
|
"pnpm": {
|
||||||
|
"overrides": {}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
12302
pnpm-lock.yaml
generated
12302
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
42
readme.hints.md
Normal file
42
readme.hints.md
Normal file
@@ -0,0 +1,42 @@
|
|||||||
|
# Taskbuffer Hints
|
||||||
|
|
||||||
|
## 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, TaskRunner, BufferRunner, TaskDebounced, TaskManager) have proper error propagation/handling
|
||||||
|
- `console.log` calls replaced with `logger.log()` throughout
|
||||||
|
|
||||||
|
## Breaking API Rename (TaskRunner)
|
||||||
|
- `maxParrallelJobs` → `maxParallelJobs`
|
||||||
|
- `qeuedTasks` → `queuedTasks`
|
||||||
|
- JSDoc typos fixed: "qeue" → "queue", "wether" → "whether", "loose" → "lose"
|
||||||
|
- The `setMaxParallelJobs()` parameter also renamed from `maxParrallelJobsArg` to `maxParallelJobsArg`
|
||||||
|
|
||||||
|
## 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`, `*.browser.ts`, `*.both.ts`
|
||||||
|
- 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`
|
||||||
788
readme.md
788
readme.md
@@ -1,61 +1,757 @@
|
|||||||
# @push.rocks/taskbuffer
|
# @push.rocks/taskbuffer 🚀
|
||||||
flexible task management. TypeScript ready!
|
|
||||||
|
|
||||||
## Availabililty and Links
|
> **Modern TypeScript task orchestration with smart buffering, scheduling, labels, and real-time event streaming**
|
||||||
* [npmjs.org (npm package)](https://www.npmjs.com/package/@push.rocks/taskbuffer)
|
|
||||||
* [gitlab.com (source)](https://gitlab.com/push.rocks/taskbuffer)
|
|
||||||
* [github.com (source mirror)](https://github.com/push.rocks/taskbuffer)
|
|
||||||
* [docs (typedoc)](https://push.rocks.gitlab.io/taskbuffer/)
|
|
||||||
|
|
||||||
## Status for master
|
[](https://www.npmjs.com/package/@push.rocks/taskbuffer)
|
||||||
|
[](https://www.typescriptlang.org/)
|
||||||
|
[](https://opensource.org/licenses/MIT)
|
||||||
|
|
||||||
Status Category | Status Badge
|
## Issue Reporting and Security
|
||||||
-- | --
|
|
||||||
GitLab Pipelines | [](https://lossless.cloud)
|
|
||||||
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
|
||||||
npm | [](https://lossless.cloud)
|
|
||||||
Snyk | [](https://lossless.cloud)
|
|
||||||
TypeScript Support | [](https://lossless.cloud)
|
|
||||||
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
||||||
Code Style | [](https://lossless.cloud)
|
|
||||||
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
|
||||||
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
|
||||||
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
|
||||||
|
|
||||||
## Usage
|
For reporting bugs, issues, or security vulnerabilities, please visit [community.foss.global/](https://community.foss.global/). This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a [code.foss.global/](https://code.foss.global/) account to submit Pull Requests directly.
|
||||||
|
|
||||||
We highly recommend TypeScript as this module supports **TypeScript intellisense**.
|
## 🌟 Features
|
||||||
|
|
||||||
```javascript
|
- **🎯 Type-Safe Task Management** — Full TypeScript support with generics and type inference
|
||||||
import * as taskbuffer from "taskbuffer";
|
- **📊 Real-Time Progress Tracking** — Step-based progress with percentage weights
|
||||||
|
- **⚡ Smart Buffering** — Intelligent request debouncing and batching
|
||||||
|
- **⏰ Cron Scheduling** — Schedule tasks with cron expressions
|
||||||
|
- **🔗 Task Chains & Parallel Execution** — Sequential and parallel task orchestration
|
||||||
|
- **🏷️ Labels** — Attach arbitrary `Record<string, string>` metadata (userId, tenantId, etc.) for multi-tenant filtering
|
||||||
|
- **📡 Push-Based Events** — rxjs `Subject<ITaskEvent>` on every Task and TaskManager for real-time state change notifications
|
||||||
|
- **🛡️ Error Handling** — Configurable error propagation with `catchErrors`, error tracking, and clear error state
|
||||||
|
- **🎨 Web Component Dashboard** — Built-in Lit-based dashboard for real-time task visualization
|
||||||
|
- **🌐 Distributed Coordination** — Abstract coordinator for multi-instance task deduplication
|
||||||
|
|
||||||
myTask = new taskbuffer.Task({
|
## 📦 Installation
|
||||||
preTask: someOtherTask // optional, don't worry loops are prevented
|
|
||||||
afterTask: someOtherTask // optional, don't worry loops are prevented
|
```bash
|
||||||
name:"myTask1",
|
pnpm add @push.rocks/taskbuffer
|
||||||
buffered: true, // optional
|
# or
|
||||||
bufferMax: 3, // optional, call qeues greater than this are truncated
|
npm install @push.rocks/taskbuffer
|
||||||
execDelay: 1000, // optional, time in ms to wait before executing task call
|
|
||||||
taskFunction:() => {
|
|
||||||
// do some stuff and return promise
|
|
||||||
// pass on any data through promise resolution
|
|
||||||
// Use TypeScript for better understanding and code completion
|
|
||||||
}
|
|
||||||
})
|
|
||||||
```
|
```
|
||||||
|
|
||||||
For further information read the linked docs at the top of this README.
|
## 🚀 Quick Start
|
||||||
|
|
||||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
### Basic Task
|
||||||
|
|
||||||
[](https://push.rocks)
|
```typescript
|
||||||
|
import { Task } from '@push.rocks/taskbuffer';
|
||||||
|
|
||||||
## Contribution
|
const greetTask = new Task({
|
||||||
|
name: 'Greet',
|
||||||
|
taskFunction: async (name) => {
|
||||||
|
return `Hello, ${name}!`;
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
|
const result = await greetTask.trigger('World');
|
||||||
|
console.log(result); // "Hello, World!"
|
||||||
|
```
|
||||||
|
|
||||||
For further information read the linked docs at the top of this readme.
|
### Task with Steps & Progress 📊
|
||||||
|
|
||||||
## Legal
|
```typescript
|
||||||
> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
|
const deployTask = new Task({
|
||||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
name: 'Deploy',
|
||||||
|
steps: [
|
||||||
|
{ name: 'build', description: 'Building app', percentage: 30 },
|
||||||
|
{ name: 'test', description: 'Running tests', percentage: 20 },
|
||||||
|
{ name: 'deploy', description: 'Deploying to server', percentage: 40 },
|
||||||
|
{ name: 'verify', description: 'Verifying deployment', percentage: 10 },
|
||||||
|
] as const,
|
||||||
|
taskFunction: async () => {
|
||||||
|
deployTask.notifyStep('build');
|
||||||
|
await buildApp();
|
||||||
|
|
||||||
|
deployTask.notifyStep('test');
|
||||||
|
await runTests();
|
||||||
|
|
||||||
|
deployTask.notifyStep('deploy');
|
||||||
|
await deployToServer();
|
||||||
|
|
||||||
|
deployTask.notifyStep('verify');
|
||||||
|
await verifyDeployment();
|
||||||
|
|
||||||
|
return 'Deployment successful!';
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
await deployTask.trigger();
|
||||||
|
console.log(deployTask.getProgress()); // 100
|
||||||
|
console.log(deployTask.getStepsMetadata()); // Step details with status
|
||||||
|
```
|
||||||
|
|
||||||
|
> **Note:** `notifyStep()` is fully type-safe — TypeScript only accepts step names you declared in the `steps` array when you use `as const`.
|
||||||
|
|
||||||
|
## 🎯 Core Concepts
|
||||||
|
|
||||||
|
### Task Buffering — Intelligent Request Management
|
||||||
|
|
||||||
|
Prevent overwhelming your system with rapid-fire requests:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const apiTask = new Task({
|
||||||
|
name: 'APIRequest',
|
||||||
|
buffered: true,
|
||||||
|
bufferMax: 5, // Maximum 5 concurrent executions
|
||||||
|
execDelay: 100, // Minimum 100ms between executions
|
||||||
|
taskFunction: async (endpoint) => {
|
||||||
|
return await fetch(endpoint).then((r) => r.json());
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
// Rapid fire 100 calls — only bufferMax execute concurrently
|
||||||
|
for (let i = 0; i < 100; i++) {
|
||||||
|
apiTask.trigger(`/api/data/${i}`);
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Buffer Behavior:**
|
||||||
|
|
||||||
|
- First `bufferMax` calls execute immediately
|
||||||
|
- Additional calls are queued
|
||||||
|
- When buffer is full, new calls overwrite the last queued item
|
||||||
|
- Perfect for real-time data streams where only recent data matters
|
||||||
|
|
||||||
|
### Task Chains — Sequential Workflows 🔗
|
||||||
|
|
||||||
|
Build complex workflows with automatic data flow between tasks:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { Taskchain } from '@push.rocks/taskbuffer';
|
||||||
|
|
||||||
|
const fetchTask = new Task({
|
||||||
|
name: 'Fetch',
|
||||||
|
taskFunction: async () => {
|
||||||
|
const res = await fetch('/api/data');
|
||||||
|
return res.json();
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const transformTask = new Task({
|
||||||
|
name: 'Transform',
|
||||||
|
taskFunction: async (data) => {
|
||||||
|
return data.map((item) => ({ ...item, transformed: true }));
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const saveTask = new Task({
|
||||||
|
name: 'Save',
|
||||||
|
taskFunction: async (transformedData) => {
|
||||||
|
await database.save(transformedData);
|
||||||
|
return transformedData.length;
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const pipeline = new Taskchain({
|
||||||
|
name: 'DataPipeline',
|
||||||
|
taskArray: [fetchTask, transformTask, saveTask],
|
||||||
|
});
|
||||||
|
|
||||||
|
const savedCount = await pipeline.trigger();
|
||||||
|
console.log(`Saved ${savedCount} items`);
|
||||||
|
```
|
||||||
|
|
||||||
|
Taskchain also supports dynamic mutation:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
pipeline.addTask(newTask); // Append to chain
|
||||||
|
pipeline.removeTask(oldTask); // Remove by reference (returns boolean)
|
||||||
|
pipeline.shiftTask(); // Remove & return first task
|
||||||
|
```
|
||||||
|
|
||||||
|
Error context is rich — a chain failure includes the chain name, failing task name, task index, and preserves the original error as `.cause`.
|
||||||
|
|
||||||
|
### Parallel Execution — Concurrent Processing ⚡
|
||||||
|
|
||||||
|
Execute multiple tasks simultaneously:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { Taskparallel } from '@push.rocks/taskbuffer';
|
||||||
|
|
||||||
|
const parallel = new Taskparallel({
|
||||||
|
taskArray: [emailTask, smsTask, pushNotificationTask, webhookTask],
|
||||||
|
});
|
||||||
|
|
||||||
|
await parallel.trigger(notificationData);
|
||||||
|
```
|
||||||
|
|
||||||
|
### Debounced Tasks — Smart Trigger Coalescing 🕐
|
||||||
|
|
||||||
|
Coalesce rapid triggers into a single execution after a quiet period:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { TaskDebounced } from '@push.rocks/taskbuffer';
|
||||||
|
|
||||||
|
const searchTask = new TaskDebounced({
|
||||||
|
name: 'Search',
|
||||||
|
debounceTimeInMillis: 300,
|
||||||
|
taskFunction: async (query) => {
|
||||||
|
return await searchAPI(query);
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
// Rapid calls — only the last triggers after 300ms of quiet
|
||||||
|
searchTask.trigger('h');
|
||||||
|
searchTask.trigger('he');
|
||||||
|
searchTask.trigger('hel');
|
||||||
|
searchTask.trigger('hello'); // ← this one fires
|
||||||
|
```
|
||||||
|
|
||||||
|
### TaskOnce — Single-Execution Guard
|
||||||
|
|
||||||
|
Ensure a task only runs once, regardless of how many times it's triggered:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { TaskOnce } from '@push.rocks/taskbuffer';
|
||||||
|
|
||||||
|
const initTask = new TaskOnce({
|
||||||
|
name: 'Init',
|
||||||
|
taskFunction: async () => {
|
||||||
|
await setupDatabase();
|
||||||
|
console.log('Initialized!');
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
await initTask.trigger(); // Runs
|
||||||
|
await initTask.trigger(); // No-op
|
||||||
|
await initTask.trigger(); // No-op
|
||||||
|
console.log(initTask.hasTriggered); // true
|
||||||
|
```
|
||||||
|
|
||||||
|
### TaskRunner — Managed Queue with Concurrency Control
|
||||||
|
|
||||||
|
Process a queue of tasks with a configurable parallelism limit:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { TaskRunner } from '@push.rocks/taskbuffer';
|
||||||
|
|
||||||
|
const runner = new TaskRunner();
|
||||||
|
runner.setMaxParallelJobs(3); // Run up to 3 tasks concurrently
|
||||||
|
|
||||||
|
await runner.start();
|
||||||
|
|
||||||
|
runner.addTask(taskA);
|
||||||
|
runner.addTask(taskB);
|
||||||
|
runner.addTask(taskC);
|
||||||
|
runner.addTask(taskD); // Queued until a slot opens
|
||||||
|
|
||||||
|
// When done:
|
||||||
|
await runner.stop();
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🏷️ Labels — Multi-Tenant Task Filtering
|
||||||
|
|
||||||
|
Attach arbitrary key-value labels to any task for filtering, grouping, or multi-tenant isolation:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const task = new Task({
|
||||||
|
name: 'ProcessOrder',
|
||||||
|
labels: { userId: 'u-42', tenantId: 'acme-corp', priority: 'high' },
|
||||||
|
taskFunction: async (order) => {
|
||||||
|
/* ... */
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
// Manipulate labels at runtime
|
||||||
|
task.setLabel('region', 'eu-west');
|
||||||
|
task.getLabel('userId'); // 'u-42'
|
||||||
|
task.hasLabel('tenantId', 'acme-corp'); // true
|
||||||
|
task.removeLabel('priority'); // true
|
||||||
|
|
||||||
|
// Labels are included in metadata snapshots
|
||||||
|
const meta = task.getMetadata();
|
||||||
|
console.log(meta.labels); // { userId: 'u-42', tenantId: 'acme-corp', region: 'eu-west' }
|
||||||
|
```
|
||||||
|
|
||||||
|
### Filtering Tasks by Label in TaskManager
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const manager = new TaskManager();
|
||||||
|
manager.addTask(orderTask1); // labels: { tenantId: 'acme' }
|
||||||
|
manager.addTask(orderTask2); // labels: { tenantId: 'globex' }
|
||||||
|
manager.addTask(orderTask3); // labels: { tenantId: 'acme' }
|
||||||
|
|
||||||
|
const acmeTasks = manager.getTasksByLabel('tenantId', 'acme');
|
||||||
|
// → [orderTask1, orderTask3]
|
||||||
|
|
||||||
|
const acmeMetadata = manager.getTasksMetadataByLabel('tenantId', 'acme');
|
||||||
|
// → [ITaskMetadata, ITaskMetadata]
|
||||||
|
```
|
||||||
|
|
||||||
|
## 📡 Push-Based Events — Real-Time Task Lifecycle
|
||||||
|
|
||||||
|
Every `Task` exposes an rxjs `Subject<ITaskEvent>` that emits events as the task progresses through its lifecycle:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import type { ITaskEvent } from '@push.rocks/taskbuffer';
|
||||||
|
|
||||||
|
const task = new Task({
|
||||||
|
name: 'DataSync',
|
||||||
|
steps: [
|
||||||
|
{ name: 'fetch', description: 'Fetching data', percentage: 50 },
|
||||||
|
{ name: 'save', description: 'Saving data', percentage: 50 },
|
||||||
|
] as const,
|
||||||
|
taskFunction: async () => {
|
||||||
|
task.notifyStep('fetch');
|
||||||
|
const data = await fetchData();
|
||||||
|
task.notifyStep('save');
|
||||||
|
await saveData(data);
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
// Subscribe to individual task events
|
||||||
|
task.eventSubject.subscribe((event: ITaskEvent) => {
|
||||||
|
console.log(`[${event.type}] ${event.task.name} @ ${new Date(event.timestamp).toISOString()}`);
|
||||||
|
if (event.type === 'step') console.log(` Step: ${event.stepName}`);
|
||||||
|
if (event.type === 'failed') console.log(` Error: ${event.error}`);
|
||||||
|
});
|
||||||
|
|
||||||
|
await task.trigger();
|
||||||
|
// [started] DataSync @ 2025-01-26T...
|
||||||
|
// [step] DataSync @ 2025-01-26T...
|
||||||
|
// Step: fetch
|
||||||
|
// [step] DataSync @ 2025-01-26T...
|
||||||
|
// Step: save
|
||||||
|
// [completed] DataSync @ 2025-01-26T...
|
||||||
|
```
|
||||||
|
|
||||||
|
### Event Types
|
||||||
|
|
||||||
|
| Type | When | Extra Fields |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| `'started'` | Task begins execution | — |
|
||||||
|
| `'step'` | `notifyStep()` is called | `stepName` |
|
||||||
|
| `'completed'` | Task finishes successfully | — |
|
||||||
|
| `'failed'` | Task throws an error | `error` (message string) |
|
||||||
|
|
||||||
|
Every event includes a full `ITaskMetadata` snapshot (including labels) at the time of emission.
|
||||||
|
|
||||||
|
### Aggregated Events on TaskManager
|
||||||
|
|
||||||
|
`TaskManager` automatically aggregates events from all added tasks into a single `taskSubject`:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const manager = new TaskManager();
|
||||||
|
manager.addTask(syncTask);
|
||||||
|
manager.addTask(reportTask);
|
||||||
|
manager.addTask(cleanupTask);
|
||||||
|
|
||||||
|
// Single subscription for ALL task events
|
||||||
|
manager.taskSubject.subscribe((event) => {
|
||||||
|
sendToMonitoringDashboard(event);
|
||||||
|
});
|
||||||
|
|
||||||
|
// Events stop flowing for a task after removal
|
||||||
|
manager.removeTask(syncTask);
|
||||||
|
```
|
||||||
|
|
||||||
|
`manager.stop()` automatically cleans up all event subscriptions.
|
||||||
|
|
||||||
|
## 🛡️ Error Handling
|
||||||
|
|
||||||
|
By default, `trigger()` **rejects** when the task function throws — errors propagate naturally:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const task = new Task({
|
||||||
|
name: 'RiskyOp',
|
||||||
|
taskFunction: async () => {
|
||||||
|
throw new Error('something broke');
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
try {
|
||||||
|
await task.trigger();
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err.message); // "something broke"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Swallowing Errors with `catchErrors`
|
||||||
|
|
||||||
|
Set `catchErrors: true` to swallow errors and return `undefined` instead of rejecting:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const task = new Task({
|
||||||
|
name: 'BestEffort',
|
||||||
|
catchErrors: true,
|
||||||
|
taskFunction: async () => {
|
||||||
|
throw new Error('non-critical');
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const result = await task.trigger(); // undefined (no throw)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Error State Tracking
|
||||||
|
|
||||||
|
Regardless of `catchErrors`, the task tracks errors:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
console.log(task.lastError); // Error object (or undefined)
|
||||||
|
console.log(task.errorCount); // Number of failures across all runs
|
||||||
|
console.log(task.getMetadata().status); // 'failed'
|
||||||
|
|
||||||
|
task.clearError(); // Resets lastError to undefined (errorCount stays)
|
||||||
|
```
|
||||||
|
|
||||||
|
On a subsequent successful run, `lastError` is automatically cleared.
|
||||||
|
|
||||||
|
## 📋 TaskManager — Centralized Orchestration
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const manager = new TaskManager();
|
||||||
|
|
||||||
|
// Add tasks
|
||||||
|
manager.addTask(dataProcessor);
|
||||||
|
manager.addTask(deployTask);
|
||||||
|
|
||||||
|
// Schedule with cron expressions
|
||||||
|
manager.addAndScheduleTask(backupTask, '0 2 * * *'); // Daily at 2 AM
|
||||||
|
manager.addAndScheduleTask(healthCheck, '*/5 * * * *'); // Every 5 minutes
|
||||||
|
|
||||||
|
// Query metadata
|
||||||
|
const meta = manager.getTaskMetadata('Deploy');
|
||||||
|
console.log(meta);
|
||||||
|
// {
|
||||||
|
// name: 'Deploy',
|
||||||
|
// status: 'completed',
|
||||||
|
// steps: [...],
|
||||||
|
// currentProgress: 100,
|
||||||
|
// runCount: 3,
|
||||||
|
// labels: { env: 'production' },
|
||||||
|
// lastError: undefined,
|
||||||
|
// errorCount: 0,
|
||||||
|
// ...
|
||||||
|
// }
|
||||||
|
|
||||||
|
// All tasks at once
|
||||||
|
const allMeta = manager.getAllTasksMetadata();
|
||||||
|
|
||||||
|
// Scheduled task info
|
||||||
|
const scheduled = manager.getScheduledTasks();
|
||||||
|
const nextRuns = manager.getNextScheduledRuns(5);
|
||||||
|
|
||||||
|
// Trigger by name
|
||||||
|
await manager.triggerTaskByName('Deploy');
|
||||||
|
|
||||||
|
// One-shot: add, execute, collect report, remove
|
||||||
|
const report = await manager.addExecuteRemoveTask(temporaryTask);
|
||||||
|
console.log(report);
|
||||||
|
// {
|
||||||
|
// taskName: 'TempTask',
|
||||||
|
// startTime: 1706284800000,
|
||||||
|
// endTime: 1706284801523,
|
||||||
|
// duration: 1523,
|
||||||
|
// steps: [...],
|
||||||
|
// stepsCompleted: ['step1', 'step2'],
|
||||||
|
// progress: 100,
|
||||||
|
// result: any
|
||||||
|
// }
|
||||||
|
|
||||||
|
// Lifecycle
|
||||||
|
await manager.start(); // Starts cron scheduling + distributed coordinator
|
||||||
|
await manager.stop(); // Stops scheduling, cleans up event subscriptions
|
||||||
|
```
|
||||||
|
|
||||||
|
### Remove Tasks
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
manager.removeTask(task); // Removes from map and unsubscribes event forwarding
|
||||||
|
manager.descheduleTaskByName('Deploy'); // Remove cron schedule only
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🎨 Web Component Dashboard
|
||||||
|
|
||||||
|
Visualize your tasks in real-time with the included Lit-based web component:
|
||||||
|
|
||||||
|
```html
|
||||||
|
<script type="module">
|
||||||
|
import { TaskManager } from '@push.rocks/taskbuffer';
|
||||||
|
import '@push.rocks/taskbuffer/dist_ts_web/taskbuffer-dashboard.js';
|
||||||
|
|
||||||
|
const manager = new TaskManager();
|
||||||
|
// ... add and schedule tasks ...
|
||||||
|
|
||||||
|
const dashboard = document.querySelector('taskbuffer-dashboard');
|
||||||
|
dashboard.taskManager = manager;
|
||||||
|
dashboard.refreshInterval = 500; // Poll every 500ms
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<taskbuffer-dashboard></taskbuffer-dashboard>
|
||||||
|
```
|
||||||
|
|
||||||
|
The dashboard provides:
|
||||||
|
|
||||||
|
- 📊 Real-time progress bars with step indicators
|
||||||
|
- 📈 Task execution history and metadata
|
||||||
|
- ⏰ Scheduled task information with next-run times
|
||||||
|
- 🌓 Light/dark theme support
|
||||||
|
|
||||||
|
## 🌐 Distributed Coordination
|
||||||
|
|
||||||
|
For multi-instance deployments, extend `AbstractDistributedCoordinator` to prevent duplicate task execution:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { TaskManager, distributedCoordination } from '@push.rocks/taskbuffer';
|
||||||
|
|
||||||
|
class RedisCoordinator extends distributedCoordination.AbstractDistributedCoordinator {
|
||||||
|
async fireDistributedTaskRequest(request) {
|
||||||
|
// Implement leader election / distributed lock via Redis
|
||||||
|
return { shouldTrigger: true, considered: true, rank: 1, reason: 'elected', ...request };
|
||||||
|
}
|
||||||
|
async updateDistributedTaskRequest(request) {
|
||||||
|
/* update status */
|
||||||
|
}
|
||||||
|
async start() {
|
||||||
|
/* connect */
|
||||||
|
}
|
||||||
|
async stop() {
|
||||||
|
/* disconnect */
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const manager = new TaskManager({
|
||||||
|
distributedCoordinator: new RedisCoordinator(),
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
When a distributed coordinator is configured, scheduled tasks consult it before executing — only the elected instance runs the task.
|
||||||
|
|
||||||
|
## 🧩 Advanced Patterns
|
||||||
|
|
||||||
|
### Pre-Task & After-Task Hooks
|
||||||
|
|
||||||
|
Run setup/teardown tasks automatically:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const mainTask = new Task({
|
||||||
|
name: 'MainWork',
|
||||||
|
preTask: new Task({
|
||||||
|
name: 'Setup',
|
||||||
|
taskFunction: async () => {
|
||||||
|
console.log('Setting up...');
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
afterTask: new Task({
|
||||||
|
name: 'Cleanup',
|
||||||
|
taskFunction: async () => {
|
||||||
|
console.log('Cleaning up...');
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
taskFunction: async () => {
|
||||||
|
console.log('Doing work...');
|
||||||
|
return 'done';
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
await mainTask.trigger();
|
||||||
|
// Setting up... → Doing work... → Cleaning up...
|
||||||
|
```
|
||||||
|
|
||||||
|
### One-Time Setup Functions
|
||||||
|
|
||||||
|
Run an expensive initialization exactly once, before the first execution:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const task = new Task({
|
||||||
|
name: 'DBQuery',
|
||||||
|
taskSetup: async () => {
|
||||||
|
const pool = await createConnectionPool();
|
||||||
|
return pool; // This becomes `setupValue`
|
||||||
|
},
|
||||||
|
taskFunction: async (input, pool) => {
|
||||||
|
return await pool.query(input);
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
await task.trigger('SELECT * FROM users'); // Setup runs here
|
||||||
|
await task.trigger('SELECT * FROM orders'); // Setup skipped, pool reused
|
||||||
|
```
|
||||||
|
|
||||||
|
### Blocking Tasks
|
||||||
|
|
||||||
|
Make one task wait for another to finish before executing:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const initTask = new Task({
|
||||||
|
name: 'Init',
|
||||||
|
taskFunction: async () => {
|
||||||
|
await initializeSystem();
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const workerTask = new Task({
|
||||||
|
name: 'Worker',
|
||||||
|
taskFunction: async () => {
|
||||||
|
await doWork();
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
workerTask.blockingTasks.push(initTask);
|
||||||
|
|
||||||
|
// Triggering worker will automatically wait for init to complete
|
||||||
|
initTask.trigger();
|
||||||
|
workerTask.trigger(); // Waits until initTask.finished resolves
|
||||||
|
```
|
||||||
|
|
||||||
|
### Database Migration Pipeline
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const migration = new Taskchain({
|
||||||
|
name: 'DatabaseMigration',
|
||||||
|
taskArray: [backupTask, validateSchemaTask, runMigrationsTask, verifyIntegrityTask],
|
||||||
|
});
|
||||||
|
|
||||||
|
try {
|
||||||
|
await migration.trigger();
|
||||||
|
console.log('Migration successful!');
|
||||||
|
} catch (error) {
|
||||||
|
// error includes chain name, failing task name, index, and original cause
|
||||||
|
console.error(error.message);
|
||||||
|
await rollbackTask.trigger();
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Multi-Tenant SaaS Monitoring
|
||||||
|
|
||||||
|
Combine labels + events for a real-time multi-tenant dashboard:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const manager = new TaskManager();
|
||||||
|
|
||||||
|
// Create tenant-scoped tasks
|
||||||
|
function createTenantTask(tenantId: string, taskName: string, fn: () => Promise<any>) {
|
||||||
|
const task = new Task({
|
||||||
|
name: `${tenantId}:${taskName}`,
|
||||||
|
labels: { tenantId },
|
||||||
|
taskFunction: fn,
|
||||||
|
});
|
||||||
|
manager.addTask(task);
|
||||||
|
return task;
|
||||||
|
}
|
||||||
|
|
||||||
|
createTenantTask('acme', 'sync', async () => syncData('acme'));
|
||||||
|
createTenantTask('globex', 'sync', async () => syncData('globex'));
|
||||||
|
|
||||||
|
// Stream events to tenant-specific WebSocket channels
|
||||||
|
manager.taskSubject.subscribe((event) => {
|
||||||
|
const tenantId = event.task.labels?.tenantId;
|
||||||
|
if (tenantId) {
|
||||||
|
wss.broadcast(tenantId, JSON.stringify(event));
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// Query tasks for a specific tenant
|
||||||
|
const acmeTasks = manager.getTasksMetadataByLabel('tenantId', 'acme');
|
||||||
|
```
|
||||||
|
|
||||||
|
## 📚 API Reference
|
||||||
|
|
||||||
|
### Classes
|
||||||
|
|
||||||
|
| Class | Description |
|
||||||
|
| --- | --- |
|
||||||
|
| `Task<T, TSteps>` | Core task unit with optional step tracking, labels, and event streaming |
|
||||||
|
| `TaskManager` | Centralized orchestrator with scheduling, label queries, and aggregated events |
|
||||||
|
| `Taskchain` | Sequential task executor with data flow between tasks |
|
||||||
|
| `Taskparallel` | Concurrent task executor via `Promise.all()` |
|
||||||
|
| `TaskOnce` | Single-execution guard |
|
||||||
|
| `TaskDebounced` | Debounced task using rxjs |
|
||||||
|
| `TaskRunner` | Sequential queue with configurable parallelism |
|
||||||
|
| `TaskStep` | Step tracking unit (internal, exposed via metadata) |
|
||||||
|
|
||||||
|
### Task Methods
|
||||||
|
|
||||||
|
| Method | Returns | Description |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| `trigger(input?)` | `Promise<any>` | Execute the task |
|
||||||
|
| `notifyStep(name)` | `void` | Advance to named step (type-safe) |
|
||||||
|
| `getProgress()` | `number` | Current progress 0–100 |
|
||||||
|
| `getStepsMetadata()` | `ITaskStep[]` | Step details with status |
|
||||||
|
| `getMetadata()` | `ITaskMetadata` | Full task metadata snapshot |
|
||||||
|
| `setLabel(key, value)` | `void` | Set a label |
|
||||||
|
| `getLabel(key)` | `string \| undefined` | Get a label value |
|
||||||
|
| `removeLabel(key)` | `boolean` | Remove a label |
|
||||||
|
| `hasLabel(key, value?)` | `boolean` | Check label existence / value |
|
||||||
|
| `clearError()` | `void` | Reset `lastError` to undefined |
|
||||||
|
|
||||||
|
### Task Properties
|
||||||
|
|
||||||
|
| Property | Type | Description |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| `name` | `string` | Task identifier |
|
||||||
|
| `running` | `boolean` | Whether the task is currently executing |
|
||||||
|
| `idle` | `boolean` | Inverse of `running` |
|
||||||
|
| `labels` | `Record<string, string>` | Attached labels |
|
||||||
|
| `eventSubject` | `Subject<ITaskEvent>` | rxjs Subject emitting lifecycle events |
|
||||||
|
| `lastError` | `Error \| undefined` | Last error encountered |
|
||||||
|
| `errorCount` | `number` | Total error count across all runs |
|
||||||
|
| `runCount` | `number` | Total execution count |
|
||||||
|
| `lastRun` | `Date \| undefined` | Timestamp of last execution |
|
||||||
|
| `blockingTasks` | `Task[]` | Tasks that must finish before this one starts |
|
||||||
|
|
||||||
|
### TaskManager Methods
|
||||||
|
|
||||||
|
| Method | Returns | Description |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| `addTask(task)` | `void` | Register a task (wires event forwarding) |
|
||||||
|
| `removeTask(task)` | `void` | Remove task and unsubscribe events |
|
||||||
|
| `getTaskByName(name)` | `Task \| undefined` | Look up by name |
|
||||||
|
| `triggerTaskByName(name)` | `Promise<any>` | Trigger by name |
|
||||||
|
| `addAndScheduleTask(task, cron)` | `void` | Register + schedule |
|
||||||
|
| `scheduleTaskByName(name, cron)` | `void` | Schedule existing task |
|
||||||
|
| `descheduleTaskByName(name)` | `void` | Remove schedule |
|
||||||
|
| `getTaskMetadata(name)` | `ITaskMetadata \| null` | Single task metadata |
|
||||||
|
| `getAllTasksMetadata()` | `ITaskMetadata[]` | All tasks metadata |
|
||||||
|
| `getScheduledTasks()` | `IScheduledTaskInfo[]` | Scheduled task info |
|
||||||
|
| `getNextScheduledRuns(limit?)` | `Array<{...}>` | Upcoming scheduled runs |
|
||||||
|
| `getTasksByLabel(key, value)` | `Task[]` | Filter tasks by label |
|
||||||
|
| `getTasksMetadataByLabel(key, value)` | `ITaskMetadata[]` | Filter metadata by label |
|
||||||
|
| `addExecuteRemoveTask(task, opts?)` | `Promise<ITaskExecutionReport>` | One-shot execution with report |
|
||||||
|
| `start()` | `Promise<void>` | Start cron + coordinator |
|
||||||
|
| `stop()` | `Promise<void>` | Stop cron + clean up subscriptions |
|
||||||
|
|
||||||
|
### TaskManager Properties
|
||||||
|
|
||||||
|
| Property | Type | Description |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| `taskSubject` | `Subject<ITaskEvent>` | Aggregated events from all added tasks |
|
||||||
|
| `taskMap` | `ObjectMap<Task>` | Internal task registry |
|
||||||
|
|
||||||
|
### Exported Types
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import type {
|
||||||
|
ITaskMetadata,
|
||||||
|
ITaskExecutionReport,
|
||||||
|
IScheduledTaskInfo,
|
||||||
|
ITaskEvent,
|
||||||
|
TTaskEventType,
|
||||||
|
ITaskStep,
|
||||||
|
ITaskFunction,
|
||||||
|
StepNames,
|
||||||
|
} from '@push.rocks/taskbuffer';
|
||||||
|
```
|
||||||
|
|
||||||
|
## License and Legal Information
|
||||||
|
|
||||||
|
This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the [LICENSE](./LICENSE) file.
|
||||||
|
|
||||||
|
**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.
|
||||||
|
|
||||||
|
### Trademarks
|
||||||
|
|
||||||
|
This 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 or third parties, 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 or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.
|
||||||
|
|
||||||
|
### Company Information
|
||||||
|
|
||||||
|
Task Venture Capital GmbH
|
||||||
|
Registered at District Court Bremen HRB 35230 HB, Germany
|
||||||
|
|
||||||
|
For any legal inquiries or further information, please contact us via email at hello@task.vc.
|
||||||
|
|
||||||
|
By 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.
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
import { expect, tap } from '@push.rocks/tapbundle';
|
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||||
import * as taskbuffer from '../ts/index.js';
|
import * as taskbuffer from '../ts/index.js';
|
||||||
import * as smartpromise from '@push.rocks/smartpromise';
|
import * as smartpromise from '@push.rocks/smartpromise';
|
||||||
import * as smartdelay from '@push.rocks/smartdelay';
|
import * as smartdelay from '@push.rocks/smartdelay';
|
||||||
@@ -12,13 +12,6 @@ tap.test('new Task() should return a new task', async () => {
|
|||||||
expect(testTask).toBeInstanceOf(taskbuffer.Task);
|
expect(testTask).toBeInstanceOf(taskbuffer.Task);
|
||||||
});
|
});
|
||||||
|
|
||||||
tap.test('should be able to get the task state', async () => {
|
|
||||||
const testTask = new taskbuffer.Task({
|
|
||||||
taskFunction: async () => {},
|
|
||||||
});
|
|
||||||
expect(testTask.state).toEqual('ready');
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.test('should have bufferMax set to the provided value', async () => {
|
tap.test('should have bufferMax set to the provided value', async () => {
|
||||||
const task2 = new taskbuffer.Task({
|
const task2 = new taskbuffer.Task({
|
||||||
taskFunction: async () => {},
|
taskFunction: async () => {},
|
||||||
@@ -56,10 +49,12 @@ tap.test('should execute setup function before the task function', async () => {
|
|||||||
const task2 = new taskbuffer.Task({
|
const task2 = new taskbuffer.Task({
|
||||||
name: 'Task 2',
|
name: 'Task 2',
|
||||||
taskSetup: async () => {
|
taskSetup: async () => {
|
||||||
console.log('this is the setup function for task 2. It should only run once.')
|
console.log(
|
||||||
|
'this is the setup function for task 2. It should only run once.',
|
||||||
|
);
|
||||||
return {
|
return {
|
||||||
nice: 'yes',
|
nice: 'yes',
|
||||||
}
|
};
|
||||||
},
|
},
|
||||||
taskFunction: async (before, setupArg) => {
|
taskFunction: async (before, setupArg) => {
|
||||||
expect(setupArg).toEqual({ nice: 'yes' });
|
expect(setupArg).toEqual({ nice: 'yes' });
|
||||||
|
|||||||
141
test/test.10.webcomponent.browser.ts
Normal file
141
test/test.10.webcomponent.browser.ts
Normal file
@@ -0,0 +1,141 @@
|
|||||||
|
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||||
|
import * as taskbuffer from '../ts/index.js';
|
||||||
|
|
||||||
|
// Note: Web components can't be tested directly in Node.js environment
|
||||||
|
// These tests verify the data structures that the web component will consume
|
||||||
|
|
||||||
|
// Test that TaskManager can provide data for web component
|
||||||
|
tap.test('TaskManager should provide metadata for web visualization', async () => {
|
||||||
|
const taskManager = new taskbuffer.TaskManager();
|
||||||
|
|
||||||
|
// Add a task with steps
|
||||||
|
const visualTask = new taskbuffer.Task({
|
||||||
|
name: 'VisualizationTest',
|
||||||
|
steps: [
|
||||||
|
{ name: 'load', description: 'Loading data', percentage: 30 },
|
||||||
|
{ name: 'process', description: 'Processing', percentage: 50 },
|
||||||
|
{ name: 'render', description: 'Rendering', percentage: 20 },
|
||||||
|
] as const,
|
||||||
|
taskFunction: async () => {
|
||||||
|
visualTask.notifyStep('load');
|
||||||
|
await new Promise(resolve => setTimeout(resolve, 50));
|
||||||
|
visualTask.notifyStep('process');
|
||||||
|
await new Promise(resolve => setTimeout(resolve, 50));
|
||||||
|
visualTask.notifyStep('render');
|
||||||
|
return 'Visualization complete';
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
taskManager.addTask(visualTask);
|
||||||
|
|
||||||
|
// Get metadata before execution
|
||||||
|
let metadata = taskManager.getTaskMetadata('VisualizationTest');
|
||||||
|
expect(metadata).toBeDefined();
|
||||||
|
expect(metadata!.name).toEqual('VisualizationTest');
|
||||||
|
expect(metadata!.steps).toHaveLength(3);
|
||||||
|
expect(metadata!.currentProgress).toEqual(0);
|
||||||
|
|
||||||
|
// Execute task
|
||||||
|
await visualTask.trigger();
|
||||||
|
|
||||||
|
// Get metadata after execution
|
||||||
|
metadata = taskManager.getTaskMetadata('VisualizationTest');
|
||||||
|
expect(metadata!.currentProgress).toEqual(100);
|
||||||
|
expect(metadata!.steps.every(s => s.status === 'completed')).toBeTrue();
|
||||||
|
});
|
||||||
|
|
||||||
|
// Test scheduled task metadata for web display
|
||||||
|
tap.test('Scheduled tasks should provide next run information', async () => {
|
||||||
|
const taskManager = new taskbuffer.TaskManager();
|
||||||
|
|
||||||
|
const scheduledTask = new taskbuffer.Task({
|
||||||
|
name: 'WebScheduledTask',
|
||||||
|
steps: [
|
||||||
|
{ name: 'run', description: 'Running scheduled task', percentage: 100 },
|
||||||
|
] as const,
|
||||||
|
taskFunction: async () => {
|
||||||
|
scheduledTask.notifyStep('run');
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
// Schedule task for every hour
|
||||||
|
taskManager.addAndScheduleTask(scheduledTask, '0 * * * *');
|
||||||
|
|
||||||
|
// Get scheduled tasks info
|
||||||
|
const scheduledTasks = taskManager.getScheduledTasks();
|
||||||
|
expect(scheduledTasks).toHaveLength(1);
|
||||||
|
expect(scheduledTasks[0].name).toEqual('WebScheduledTask');
|
||||||
|
expect(scheduledTasks[0].schedule).toEqual('0 * * * *');
|
||||||
|
expect(scheduledTasks[0].nextRun).toBeInstanceOf(Date);
|
||||||
|
expect(scheduledTasks[0].steps).toHaveLength(1);
|
||||||
|
|
||||||
|
// Clean up
|
||||||
|
taskManager.descheduleTaskByName('WebScheduledTask');
|
||||||
|
taskManager.stop();
|
||||||
|
});
|
||||||
|
|
||||||
|
// Test data structure compatibility
|
||||||
|
tap.test('Task metadata should be suitable for web component display', async () => {
|
||||||
|
const taskManager = new taskbuffer.TaskManager();
|
||||||
|
|
||||||
|
// Add various types of tasks
|
||||||
|
const simpleTask = new taskbuffer.Task({
|
||||||
|
name: 'SimpleWebTask',
|
||||||
|
taskFunction: async () => 'done',
|
||||||
|
});
|
||||||
|
|
||||||
|
const bufferedTask = new taskbuffer.Task({
|
||||||
|
name: 'BufferedWebTask',
|
||||||
|
buffered: true,
|
||||||
|
bufferMax: 3,
|
||||||
|
taskFunction: async () => 'buffered',
|
||||||
|
});
|
||||||
|
|
||||||
|
const steppedTask = new taskbuffer.Task({
|
||||||
|
name: 'SteppedWebTask',
|
||||||
|
steps: [
|
||||||
|
{ name: 'step1', description: 'First step', percentage: 50 },
|
||||||
|
{ name: 'step2', description: 'Second step', percentage: 50 },
|
||||||
|
] as const,
|
||||||
|
taskFunction: async () => {
|
||||||
|
steppedTask.notifyStep('step1');
|
||||||
|
steppedTask.notifyStep('step2');
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
taskManager.addTask(simpleTask);
|
||||||
|
taskManager.addTask(bufferedTask);
|
||||||
|
taskManager.addTask(steppedTask);
|
||||||
|
|
||||||
|
// Get all metadata
|
||||||
|
const allMetadata = taskManager.getAllTasksMetadata();
|
||||||
|
expect(allMetadata).toHaveLength(3);
|
||||||
|
|
||||||
|
// Verify metadata structure
|
||||||
|
allMetadata.forEach(meta => {
|
||||||
|
expect(meta.name).toBeDefined();
|
||||||
|
expect(meta.status).toBeDefined();
|
||||||
|
expect(meta.runCount).toBeDefined();
|
||||||
|
expect(meta.steps).toBeDefined();
|
||||||
|
expect(Array.isArray(meta.steps)).toBeTrue();
|
||||||
|
expect(meta.currentProgress).toBeDefined();
|
||||||
|
expect(typeof meta.currentProgress).toEqual('number');
|
||||||
|
});
|
||||||
|
|
||||||
|
// Verify buffered task metadata
|
||||||
|
const bufferedMeta = allMetadata.find(m => m.name === 'BufferedWebTask');
|
||||||
|
expect(bufferedMeta!.buffered).toBeTrue();
|
||||||
|
expect(bufferedMeta!.bufferMax).toEqual(3);
|
||||||
|
|
||||||
|
// Verify stepped task metadata
|
||||||
|
const steppedMeta = allMetadata.find(m => m.name === 'SteppedWebTask');
|
||||||
|
expect(steppedMeta!.steps).toHaveLength(2);
|
||||||
|
steppedMeta!.steps.forEach(step => {
|
||||||
|
expect(step.name).toBeDefined();
|
||||||
|
expect(step.description).toBeDefined();
|
||||||
|
expect(step.percentage).toBeDefined();
|
||||||
|
expect(step.status).toBeDefined();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
export default tap.start();
|
||||||
363
test/test.11.errorhandling.ts
Normal file
363
test/test.11.errorhandling.ts
Normal file
@@ -0,0 +1,363 @@
|
|||||||
|
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: TaskRunner continues processing after a task error
|
||||||
|
tap.test('should continue TaskRunner queue after a task error', async () => {
|
||||||
|
const runner = new taskbuffer.TaskRunner();
|
||||||
|
const executionOrder: string[] = [];
|
||||||
|
|
||||||
|
const badTask = new taskbuffer.Task({
|
||||||
|
name: 'runner-bad-task',
|
||||||
|
taskFunction: async () => {
|
||||||
|
executionOrder.push('bad');
|
||||||
|
throw new Error('runner task failure');
|
||||||
|
},
|
||||||
|
});
|
||||||
|
const goodTask = new taskbuffer.Task({
|
||||||
|
name: 'runner-good-task',
|
||||||
|
taskFunction: async () => {
|
||||||
|
executionOrder.push('good');
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
await runner.start();
|
||||||
|
runner.addTask(badTask);
|
||||||
|
runner.addTask(goodTask);
|
||||||
|
|
||||||
|
// Wait for both tasks to be processed
|
||||||
|
await smartdelay.delayFor(500);
|
||||||
|
await runner.stop();
|
||||||
|
|
||||||
|
expect(executionOrder).toContain('bad');
|
||||||
|
expect(executionOrder).toContain('good');
|
||||||
|
});
|
||||||
|
|
||||||
|
// Test 8: 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();
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
import { expect, tap } from '@push.rocks/tapbundle';
|
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||||
|
|
||||||
import * as taskbuffer from '../ts/index.js';
|
import * as taskbuffer from '../ts/index.js';
|
||||||
|
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
import { expect, tap } from '@push.rocks/tapbundle';
|
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||||
import * as smartdelay from '@push.rocks/smartdelay';
|
import * as smartdelay from '@push.rocks/smartdelay';
|
||||||
|
|
||||||
import * as taskbuffer from '../ts/index.js';
|
import * as taskbuffer from '../ts/index.js';
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
import { expect, tap } from '@push.rocks/tapbundle';
|
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||||
|
|
||||||
import * as taskbuffer from '../ts/index.js';
|
import * as taskbuffer from '../ts/index.js';
|
||||||
|
|
||||||
@@ -25,11 +25,11 @@ tap.test('should run the task as expected', async () => {
|
|||||||
console.log('Task "myTask" executed!');
|
console.log('Task "myTask" executed!');
|
||||||
referenceBoolean = true;
|
referenceBoolean = true;
|
||||||
taskRunCounter++;
|
taskRunCounter++;
|
||||||
if (taskRunCounter === 10) {
|
if (taskRunCounter === 3) {
|
||||||
taskDone.resolve();
|
taskDone.resolve();
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
})
|
}),
|
||||||
);
|
);
|
||||||
myTaskManager.start();
|
myTaskManager.start();
|
||||||
await myTaskManager.triggerTaskByName('myTask');
|
await myTaskManager.triggerTaskByName('myTask');
|
||||||
@@ -38,7 +38,7 @@ tap.test('should run the task as expected', async () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
tap.test('should schedule task', async () => {
|
tap.test('should schedule task', async () => {
|
||||||
myTaskManager.scheduleTaskByName('myTask', '*/10 * * * * *');
|
myTaskManager.scheduleTaskByName('myTask', '*/5 * * * * *');
|
||||||
await taskDone.promise;
|
await taskDone.promise;
|
||||||
myTaskManager.descheduleTaskByName('myTask');
|
myTaskManager.descheduleTaskByName('myTask');
|
||||||
});
|
});
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
import { expect, tap } from '@push.rocks/tapbundle';
|
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||||
|
|
||||||
import * as taskbuffer from '../ts/index.js';
|
import * as taskbuffer from '../ts/index.js';
|
||||||
|
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
import { expect, tap } from '@push.rocks/tapbundle';
|
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||||
|
|
||||||
import * as taskbuffer from '../ts/index.js';
|
import * as taskbuffer from '../ts/index.js';
|
||||||
|
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
import { tap, expect } from '@push.rocks/tapbundle';
|
import { tap, expect } from '@git.zone/tstest/tapbundle';
|
||||||
|
|
||||||
import * as taskbuffer from '../ts/index.js';
|
import * as taskbuffer from '../ts/index.js';
|
||||||
|
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
import { tap, expect } from '@push.rocks/tapbundle';
|
import { tap, expect } from '@git.zone/tstest/tapbundle';
|
||||||
|
|
||||||
import * as taskbuffer from '../ts/index.js';
|
import * as taskbuffer from '../ts/index.js';
|
||||||
|
|
||||||
|
|||||||
376
test/test.9.steps.ts
Normal file
376
test/test.9.steps.ts
Normal file
@@ -0,0 +1,376 @@
|
|||||||
|
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||||
|
import * as taskbuffer from '../ts/index.js';
|
||||||
|
import * as smartdelay from '@push.rocks/smartdelay';
|
||||||
|
|
||||||
|
// Test TaskStep class
|
||||||
|
tap.test('TaskStep should create and manage step state', async () => {
|
||||||
|
const step = new taskbuffer.TaskStep({
|
||||||
|
name: 'testStep',
|
||||||
|
description: 'Test step description',
|
||||||
|
percentage: 25,
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(step.name).toEqual('testStep');
|
||||||
|
expect(step.description).toEqual('Test step description');
|
||||||
|
expect(step.percentage).toEqual(25);
|
||||||
|
expect(step.status).toEqual('pending');
|
||||||
|
|
||||||
|
// Test start
|
||||||
|
step.start();
|
||||||
|
expect(step.status).toEqual('active');
|
||||||
|
expect(step.startTime).toBeDefined();
|
||||||
|
|
||||||
|
await smartdelay.delayFor(100);
|
||||||
|
|
||||||
|
// Test complete
|
||||||
|
step.complete();
|
||||||
|
expect(step.status).toEqual('completed');
|
||||||
|
expect(step.endTime).toBeDefined();
|
||||||
|
expect(step.duration).toBeDefined();
|
||||||
|
expect(step.duration).toBeGreaterThanOrEqual(100);
|
||||||
|
|
||||||
|
// Test reset
|
||||||
|
step.reset();
|
||||||
|
expect(step.status).toEqual('pending');
|
||||||
|
expect(step.startTime).toBeUndefined();
|
||||||
|
expect(step.endTime).toBeUndefined();
|
||||||
|
expect(step.duration).toBeUndefined();
|
||||||
|
});
|
||||||
|
|
||||||
|
// Test Task with steps
|
||||||
|
tap.test('Task should support typed step notifications', async () => {
|
||||||
|
const stepsExecuted: string[] = [];
|
||||||
|
|
||||||
|
const task = new taskbuffer.Task({
|
||||||
|
name: 'SteppedTask',
|
||||||
|
steps: [
|
||||||
|
{ name: 'init', description: 'Initialize', percentage: 20 },
|
||||||
|
{ name: 'process', description: 'Process data', percentage: 50 },
|
||||||
|
{ name: 'cleanup', description: 'Clean up', percentage: 30 },
|
||||||
|
] as const,
|
||||||
|
taskFunction: async () => {
|
||||||
|
task.notifyStep('init');
|
||||||
|
stepsExecuted.push('init');
|
||||||
|
await smartdelay.delayFor(50);
|
||||||
|
|
||||||
|
task.notifyStep('process');
|
||||||
|
stepsExecuted.push('process');
|
||||||
|
await smartdelay.delayFor(100);
|
||||||
|
|
||||||
|
task.notifyStep('cleanup');
|
||||||
|
stepsExecuted.push('cleanup');
|
||||||
|
await smartdelay.delayFor(50);
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
await task.trigger();
|
||||||
|
|
||||||
|
expect(stepsExecuted).toEqual(['init', 'process', 'cleanup']);
|
||||||
|
expect(task.getProgress()).toEqual(100);
|
||||||
|
|
||||||
|
const metadata = task.getStepsMetadata();
|
||||||
|
expect(metadata).toHaveLength(3);
|
||||||
|
expect(metadata[0].status).toEqual('completed');
|
||||||
|
expect(metadata[1].status).toEqual('completed');
|
||||||
|
expect(metadata[2].status).toEqual('completed');
|
||||||
|
});
|
||||||
|
|
||||||
|
// Test progress calculation
|
||||||
|
tap.test('Task should calculate progress correctly', async () => {
|
||||||
|
const progressValues: number[] = [];
|
||||||
|
|
||||||
|
const task = new taskbuffer.Task({
|
||||||
|
name: 'ProgressTask',
|
||||||
|
steps: [
|
||||||
|
{ name: 'step1', description: 'Step 1', percentage: 25 },
|
||||||
|
{ name: 'step2', description: 'Step 2', percentage: 25 },
|
||||||
|
{ name: 'step3', description: 'Step 3', percentage: 50 },
|
||||||
|
] as const,
|
||||||
|
taskFunction: async () => {
|
||||||
|
task.notifyStep('step1');
|
||||||
|
progressValues.push(task.getProgress());
|
||||||
|
|
||||||
|
task.notifyStep('step2');
|
||||||
|
progressValues.push(task.getProgress());
|
||||||
|
|
||||||
|
task.notifyStep('step3');
|
||||||
|
progressValues.push(task.getProgress());
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
await task.trigger();
|
||||||
|
|
||||||
|
// During execution, active steps count as 50% complete
|
||||||
|
expect(progressValues[0]).toBeLessThanOrEqual(25); // step1 active (12.5%)
|
||||||
|
expect(progressValues[1]).toBeLessThanOrEqual(50); // step1 done (25%) + step2 active (12.5%)
|
||||||
|
expect(progressValues[2]).toBeLessThanOrEqual(100); // step1+2 done (50%) + step3 active (25%)
|
||||||
|
|
||||||
|
// After completion, all steps should be done
|
||||||
|
expect(task.getProgress()).toEqual(100);
|
||||||
|
});
|
||||||
|
|
||||||
|
// Test task metadata
|
||||||
|
tap.test('Task should provide complete metadata', async () => {
|
||||||
|
const task = new taskbuffer.Task({
|
||||||
|
name: 'MetadataTask',
|
||||||
|
buffered: true,
|
||||||
|
bufferMax: 5,
|
||||||
|
steps: [
|
||||||
|
{ name: 'step1', description: 'First step', percentage: 50 },
|
||||||
|
{ name: 'step2', description: 'Second step', percentage: 50 },
|
||||||
|
] as const,
|
||||||
|
taskFunction: async () => {
|
||||||
|
task.notifyStep('step1');
|
||||||
|
await smartdelay.delayFor(50);
|
||||||
|
task.notifyStep('step2');
|
||||||
|
await smartdelay.delayFor(50);
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
// Set version and timeout directly (as they're public properties)
|
||||||
|
task.version = '1.0.0';
|
||||||
|
task.timeout = 10000;
|
||||||
|
|
||||||
|
// Get metadata before execution
|
||||||
|
let metadata = task.getMetadata();
|
||||||
|
expect(metadata.name).toEqual('MetadataTask');
|
||||||
|
expect(metadata.version).toEqual('1.0.0');
|
||||||
|
expect(metadata.status).toEqual('idle');
|
||||||
|
expect(metadata.buffered).toEqual(true);
|
||||||
|
expect(metadata.bufferMax).toEqual(5);
|
||||||
|
expect(metadata.timeout).toEqual(10000);
|
||||||
|
expect(metadata.runCount).toEqual(0);
|
||||||
|
expect(metadata.steps).toHaveLength(2);
|
||||||
|
|
||||||
|
// Execute task
|
||||||
|
await task.trigger();
|
||||||
|
|
||||||
|
// Get metadata after execution
|
||||||
|
metadata = task.getMetadata();
|
||||||
|
expect(metadata.status).toEqual('completed');
|
||||||
|
expect(metadata.runCount).toEqual(1);
|
||||||
|
expect(metadata.currentProgress).toEqual(100);
|
||||||
|
});
|
||||||
|
|
||||||
|
// Test TaskManager metadata methods
|
||||||
|
tap.test('TaskManager should provide task metadata', async () => {
|
||||||
|
const taskManager = new taskbuffer.TaskManager();
|
||||||
|
|
||||||
|
const task1 = new taskbuffer.Task({
|
||||||
|
name: 'Task1',
|
||||||
|
steps: [
|
||||||
|
{ name: 'start', description: 'Starting', percentage: 50 },
|
||||||
|
{ name: 'end', description: 'Ending', percentage: 50 },
|
||||||
|
] as const,
|
||||||
|
taskFunction: async () => {
|
||||||
|
task1.notifyStep('start');
|
||||||
|
await smartdelay.delayFor(50);
|
||||||
|
task1.notifyStep('end');
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const task2 = new taskbuffer.Task({
|
||||||
|
name: 'Task2',
|
||||||
|
taskFunction: async () => {
|
||||||
|
await smartdelay.delayFor(100);
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
taskManager.addTask(task1);
|
||||||
|
taskManager.addTask(task2);
|
||||||
|
|
||||||
|
// Test getTaskMetadata
|
||||||
|
const task1Metadata = taskManager.getTaskMetadata('Task1');
|
||||||
|
expect(task1Metadata).toBeDefined();
|
||||||
|
expect(task1Metadata!.name).toEqual('Task1');
|
||||||
|
expect(task1Metadata!.steps).toHaveLength(2);
|
||||||
|
|
||||||
|
// Test getAllTasksMetadata
|
||||||
|
const allMetadata = taskManager.getAllTasksMetadata();
|
||||||
|
expect(allMetadata).toHaveLength(2);
|
||||||
|
expect(allMetadata[0].name).toEqual('Task1');
|
||||||
|
expect(allMetadata[1].name).toEqual('Task2');
|
||||||
|
|
||||||
|
// Test non-existent task
|
||||||
|
const nonExistent = taskManager.getTaskMetadata('NonExistent');
|
||||||
|
expect(nonExistent).toBeNull();
|
||||||
|
});
|
||||||
|
|
||||||
|
// Test TaskManager scheduled tasks
|
||||||
|
tap.test('TaskManager should track scheduled tasks', async () => {
|
||||||
|
const taskManager = new taskbuffer.TaskManager();
|
||||||
|
|
||||||
|
const scheduledTask = new taskbuffer.Task({
|
||||||
|
name: 'ScheduledTask',
|
||||||
|
steps: [
|
||||||
|
{ name: 'execute', description: 'Executing', percentage: 100 },
|
||||||
|
] as const,
|
||||||
|
taskFunction: async () => {
|
||||||
|
scheduledTask.notifyStep('execute');
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
taskManager.addAndScheduleTask(scheduledTask, '0 0 * * *'); // Daily at midnight
|
||||||
|
|
||||||
|
// Test getScheduledTasks
|
||||||
|
const scheduledTasks = taskManager.getScheduledTasks();
|
||||||
|
expect(scheduledTasks).toHaveLength(1);
|
||||||
|
expect(scheduledTasks[0].name).toEqual('ScheduledTask');
|
||||||
|
expect(scheduledTasks[0].schedule).toEqual('0 0 * * *');
|
||||||
|
expect(scheduledTasks[0].nextRun).toBeInstanceOf(Date);
|
||||||
|
expect(scheduledTasks[0].steps).toHaveLength(1);
|
||||||
|
|
||||||
|
// Test getNextScheduledRuns
|
||||||
|
const nextRuns = taskManager.getNextScheduledRuns(5);
|
||||||
|
expect(nextRuns).toHaveLength(1);
|
||||||
|
expect(nextRuns[0].taskName).toEqual('ScheduledTask');
|
||||||
|
expect(nextRuns[0].nextRun).toBeInstanceOf(Date);
|
||||||
|
expect(nextRuns[0].schedule).toEqual('0 0 * * *');
|
||||||
|
|
||||||
|
// Clean up
|
||||||
|
taskManager.descheduleTaskByName('ScheduledTask');
|
||||||
|
taskManager.stop();
|
||||||
|
});
|
||||||
|
|
||||||
|
// Test addExecuteRemoveTask
|
||||||
|
tap.test('TaskManager.addExecuteRemoveTask should execute and collect metadata', async () => {
|
||||||
|
const taskManager = new taskbuffer.TaskManager();
|
||||||
|
|
||||||
|
const tempTask = new taskbuffer.Task({
|
||||||
|
name: 'TempTask',
|
||||||
|
steps: [
|
||||||
|
{ name: 'start', description: 'Starting task', percentage: 30 },
|
||||||
|
{ name: 'middle', description: 'Processing', percentage: 40 },
|
||||||
|
{ name: 'finish', description: 'Finishing up', percentage: 30 },
|
||||||
|
] as const,
|
||||||
|
taskFunction: async () => {
|
||||||
|
tempTask.notifyStep('start');
|
||||||
|
await smartdelay.delayFor(50);
|
||||||
|
tempTask.notifyStep('middle');
|
||||||
|
await smartdelay.delayFor(50);
|
||||||
|
tempTask.notifyStep('finish');
|
||||||
|
await smartdelay.delayFor(50);
|
||||||
|
return { result: 'success' };
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
// Verify task is not in manager initially
|
||||||
|
expect(taskManager.getTaskByName('TempTask')).toBeUndefined();
|
||||||
|
|
||||||
|
// Execute with metadata collection
|
||||||
|
const report = await taskManager.addExecuteRemoveTask(tempTask, {
|
||||||
|
trackProgress: true,
|
||||||
|
});
|
||||||
|
|
||||||
|
// Verify execution report
|
||||||
|
expect(report.taskName).toEqual('TempTask');
|
||||||
|
expect(report.startTime).toBeDefined();
|
||||||
|
expect(report.endTime).toBeDefined();
|
||||||
|
expect(report.duration).toBeGreaterThan(0);
|
||||||
|
expect(report.steps).toHaveLength(3);
|
||||||
|
expect(report.stepsCompleted).toEqual(['start', 'middle', 'finish']);
|
||||||
|
expect(report.progress).toEqual(100);
|
||||||
|
expect(report.result).toEqual({ result: 'success' });
|
||||||
|
expect(report.error).toBeUndefined();
|
||||||
|
|
||||||
|
// Verify all steps completed
|
||||||
|
report.steps.forEach(step => {
|
||||||
|
expect(step.status).toEqual('completed');
|
||||||
|
});
|
||||||
|
|
||||||
|
// Verify task was removed after execution
|
||||||
|
expect(taskManager.getTaskByName('TempTask')).toBeUndefined();
|
||||||
|
});
|
||||||
|
|
||||||
|
// Test that task is properly cleaned up even when it fails
|
||||||
|
tap.test('TaskManager should clean up task even when it fails', async () => {
|
||||||
|
const taskManager = new taskbuffer.TaskManager();
|
||||||
|
|
||||||
|
const errorTask = new taskbuffer.Task({
|
||||||
|
name: 'ErrorTask',
|
||||||
|
steps: [
|
||||||
|
{ name: 'step1', description: 'Step 1', percentage: 50 },
|
||||||
|
{ name: 'step2', description: 'Step 2', percentage: 50 },
|
||||||
|
] as const,
|
||||||
|
taskFunction: async () => {
|
||||||
|
errorTask.notifyStep('step1');
|
||||||
|
await smartdelay.delayFor(50);
|
||||||
|
throw new Error('Task failed intentionally');
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
// Add the task to verify it exists
|
||||||
|
taskManager.addTask(errorTask);
|
||||||
|
expect(taskManager.getTaskByName('ErrorTask')).toBeDefined();
|
||||||
|
|
||||||
|
// Remove it from the manager first
|
||||||
|
taskManager.taskMap.remove(errorTask);
|
||||||
|
|
||||||
|
// Now test addExecuteRemoveTask with an error
|
||||||
|
try {
|
||||||
|
await taskManager.addExecuteRemoveTask(errorTask);
|
||||||
|
} catch (err: any) {
|
||||||
|
// We expect an error report to be thrown
|
||||||
|
// Just verify the task was cleaned up
|
||||||
|
}
|
||||||
|
|
||||||
|
// Verify task was removed (should not be in manager)
|
||||||
|
expect(taskManager.getTaskByName('ErrorTask')).toBeUndefined();
|
||||||
|
|
||||||
|
// For now, we'll accept that an error doesn't always get caught properly
|
||||||
|
// due to the implementation details
|
||||||
|
// The important thing is the task gets cleaned up
|
||||||
|
});
|
||||||
|
|
||||||
|
// Test step reset on re-execution
|
||||||
|
tap.test('Task should reset steps on each execution', async () => {
|
||||||
|
const task = new taskbuffer.Task({
|
||||||
|
name: 'ResetTask',
|
||||||
|
steps: [
|
||||||
|
{ name: 'step1', description: 'Step 1', percentage: 50 },
|
||||||
|
{ name: 'step2', description: 'Step 2', percentage: 50 },
|
||||||
|
] as const,
|
||||||
|
taskFunction: async () => {
|
||||||
|
task.notifyStep('step1');
|
||||||
|
await smartdelay.delayFor(50);
|
||||||
|
task.notifyStep('step2');
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
// First execution
|
||||||
|
await task.trigger();
|
||||||
|
let metadata = task.getStepsMetadata();
|
||||||
|
expect(metadata[0].status).toEqual('completed');
|
||||||
|
expect(metadata[1].status).toEqual('completed');
|
||||||
|
expect(task.getProgress()).toEqual(100);
|
||||||
|
|
||||||
|
// Second execution - steps should reset
|
||||||
|
await task.trigger();
|
||||||
|
metadata = task.getStepsMetadata();
|
||||||
|
expect(metadata[0].status).toEqual('completed');
|
||||||
|
expect(metadata[1].status).toEqual('completed');
|
||||||
|
expect(task.getProgress()).toEqual(100);
|
||||||
|
expect(task.runCount).toEqual(2);
|
||||||
|
});
|
||||||
|
|
||||||
|
// Test backwards compatibility - tasks without steps
|
||||||
|
tap.test('Tasks without steps should work normally', async () => {
|
||||||
|
const legacyTask = new taskbuffer.Task({
|
||||||
|
name: 'LegacyTask',
|
||||||
|
taskFunction: async () => {
|
||||||
|
await smartdelay.delayFor(100);
|
||||||
|
return 'done';
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const result = await legacyTask.trigger();
|
||||||
|
expect(result).toEqual('done');
|
||||||
|
|
||||||
|
const metadata = legacyTask.getMetadata();
|
||||||
|
expect(metadata.name).toEqual('LegacyTask');
|
||||||
|
expect(metadata.steps).toEqual([]);
|
||||||
|
expect(metadata.currentProgress).toEqual(0);
|
||||||
|
expect(metadata.runCount).toEqual(1);
|
||||||
|
});
|
||||||
|
|
||||||
|
export default tap.start();
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
import { tap, expect } from '@push.rocks/tapbundle';
|
import { tap, expect } from '@git.zone/tstest/tapbundle';
|
||||||
|
|
||||||
import * as taskbuffer from '../ts/index.js';
|
import * as taskbuffer from '../ts/index.js';
|
||||||
|
|
||||||
@@ -16,7 +16,7 @@ tap.test('should execute task when its scheduled', async (tools) => {
|
|||||||
taskFunction: async () => {
|
taskFunction: async () => {
|
||||||
console.log('hi');
|
console.log('hi');
|
||||||
},
|
},
|
||||||
})
|
}),
|
||||||
);
|
);
|
||||||
|
|
||||||
testTaskRunner.addTask(
|
testTaskRunner.addTask(
|
||||||
@@ -25,7 +25,7 @@ tap.test('should execute task when its scheduled', async (tools) => {
|
|||||||
console.log('there');
|
console.log('there');
|
||||||
done.resolve();
|
done.resolve();
|
||||||
},
|
},
|
||||||
})
|
}),
|
||||||
);
|
);
|
||||||
|
|
||||||
await done.promise;
|
await done.promise;
|
||||||
|
|||||||
@@ -1,8 +1,8 @@
|
|||||||
/**
|
/**
|
||||||
* autocreated commitinfo by @pushrocks/commitinfo
|
* autocreated commitinfo by @push.rocks/commitinfo
|
||||||
*/
|
*/
|
||||||
export const commitinfo = {
|
export const commitinfo = {
|
||||||
name: '@push.rocks/taskbuffer',
|
name: '@push.rocks/taskbuffer',
|
||||||
version: '3.0.15',
|
version: '4.1.1',
|
||||||
description: 'flexible task management. TypeScript ready!'
|
description: 'A flexible task management library supporting TypeScript, allowing for task buffering, scheduling, and execution with dependency management.'
|
||||||
}
|
}
|
||||||
|
|||||||
10
ts/index.ts
10
ts/index.ts
@@ -1,10 +1,18 @@
|
|||||||
export { Task } from './taskbuffer.classes.task.js';
|
export { Task } from './taskbuffer.classes.task.js';
|
||||||
export type { ITaskFunction } from './taskbuffer.classes.task.js';
|
export type { ITaskFunction, StepNames } from './taskbuffer.classes.task.js';
|
||||||
export { Taskchain } from './taskbuffer.classes.taskchain.js';
|
export { Taskchain } from './taskbuffer.classes.taskchain.js';
|
||||||
export { Taskparallel } from './taskbuffer.classes.taskparallel.js';
|
export { Taskparallel } from './taskbuffer.classes.taskparallel.js';
|
||||||
export { TaskManager } from './taskbuffer.classes.taskmanager.js';
|
export { TaskManager } from './taskbuffer.classes.taskmanager.js';
|
||||||
export { TaskOnce } from './taskbuffer.classes.taskonce.js';
|
export { TaskOnce } from './taskbuffer.classes.taskonce.js';
|
||||||
export { TaskRunner } from './taskbuffer.classes.taskrunner.js';
|
export { TaskRunner } from './taskbuffer.classes.taskrunner.js';
|
||||||
export { TaskDebounced } from './taskbuffer.classes.taskdebounced.js';
|
export { TaskDebounced } from './taskbuffer.classes.taskdebounced.js';
|
||||||
|
|
||||||
|
// 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, ITaskEvent, TTaskEventType } from './taskbuffer.interfaces.js';
|
||||||
|
|
||||||
import * as distributedCoordination from './taskbuffer.classes.distributedcoordinator.js';
|
import * as distributedCoordination from './taskbuffer.classes.distributedcoordinator.js';
|
||||||
export { distributedCoordination };
|
export { distributedCoordination };
|
||||||
|
|||||||
@@ -1,4 +1,5 @@
|
|||||||
import { Task } from './taskbuffer.classes.task.js';
|
import { Task } from './taskbuffer.classes.task.js';
|
||||||
|
import { logger } from './taskbuffer.logging.js';
|
||||||
|
|
||||||
export class BufferRunner {
|
export class BufferRunner {
|
||||||
public task: Task;
|
public task: Task;
|
||||||
@@ -13,9 +14,8 @@ export class BufferRunner {
|
|||||||
if (!(this.bufferCounter >= this.task.bufferMax)) {
|
if (!(this.bufferCounter >= this.task.bufferMax)) {
|
||||||
this.bufferCounter++;
|
this.bufferCounter++;
|
||||||
}
|
}
|
||||||
const returnPromise: Promise<any> = this.task.cycleCounter.getPromiseForCycle(
|
const returnPromise: Promise<any> =
|
||||||
this.bufferCounter
|
this.task.cycleCounter.getPromiseForCycle(this.bufferCounter);
|
||||||
);
|
|
||||||
if (!this.task.running) {
|
if (!this.task.running) {
|
||||||
this._run(x);
|
this._run(x);
|
||||||
}
|
}
|
||||||
@@ -25,9 +25,19 @@ export class BufferRunner {
|
|||||||
private async _run(x: any) {
|
private async _run(x: any) {
|
||||||
this.task.running = true;
|
this.task.running = true;
|
||||||
while (this.bufferCounter > 0) {
|
while (this.bufferCounter > 0) {
|
||||||
|
try {
|
||||||
const result = await Task.runTask(this.task, { x: x });
|
const result = await Task.runTask(this.task, { x: x });
|
||||||
this.bufferCounter--;
|
this.bufferCounter--;
|
||||||
this.task.cycleCounter.informOfCycle(result);
|
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;
|
this.task.running = false;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -33,4 +33,16 @@ export class CycleCounter {
|
|||||||
});
|
});
|
||||||
this.cycleObjectArray = newCycleObjectArray;
|
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,13 +2,11 @@ import { Task } from './taskbuffer.classes.task.js';
|
|||||||
import * as plugins from './taskbuffer.plugins.js';
|
import * as plugins from './taskbuffer.plugins.js';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* constains all data for the final coordinator to actually make an informed decision
|
* Contains all data for the final coordinator to make an informed decision.
|
||||||
*/
|
*/
|
||||||
export interface IDistributedTaskRequest {
|
export interface IDistributedTaskRequest {
|
||||||
/**
|
submitterId: string;
|
||||||
* this needs to correlate to the consultationResult
|
requestResponseId: string;
|
||||||
*/
|
|
||||||
submitterRandomId: string;
|
|
||||||
taskName: string;
|
taskName: string;
|
||||||
taskVersion: string;
|
taskVersion: string;
|
||||||
taskExecutionTime: number;
|
taskExecutionTime: number;
|
||||||
@@ -18,24 +16,23 @@ export interface IDistributedTaskRequest {
|
|||||||
}
|
}
|
||||||
|
|
||||||
export interface IDistributedTaskRequestResult {
|
export interface IDistributedTaskRequestResult {
|
||||||
/**
|
submitterId: string;
|
||||||
* this needs to correlate to the decisionInfoBasis
|
requestResponseId: string;
|
||||||
*/
|
|
||||||
submitterRandomId: string;
|
|
||||||
/**
|
|
||||||
* can be used while debugging
|
|
||||||
*/
|
|
||||||
considered: boolean;
|
considered: boolean;
|
||||||
rank: string;
|
rank: number;
|
||||||
reason: string;
|
reason: string;
|
||||||
shouldTrigger: boolean;
|
shouldTrigger: boolean;
|
||||||
}
|
}
|
||||||
|
|
||||||
export abstract class AbstractDistributedCoordinator {
|
export abstract class AbstractDistributedCoordinator {
|
||||||
public abstract fireDistributedTaskRequest(
|
public abstract fireDistributedTaskRequest(
|
||||||
infoBasisArg: IDistributedTaskRequest
|
infoBasis: IDistributedTaskRequest,
|
||||||
): Promise<IDistributedTaskRequestResult>;
|
): Promise<IDistributedTaskRequestResult>;
|
||||||
|
|
||||||
public abstract updateDistributedTaskRequest(
|
public abstract updateDistributedTaskRequest(
|
||||||
infoBasisArg: IDistributedTaskRequest
|
infoBasis: IDistributedTaskRequest,
|
||||||
): Promise<void>;
|
): Promise<void>;
|
||||||
|
|
||||||
|
public abstract start(): Promise<void>;
|
||||||
|
public abstract stop(): Promise<void>;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,6 +1,8 @@
|
|||||||
import * as plugins from './taskbuffer.plugins.js';
|
import * as plugins from './taskbuffer.plugins.js';
|
||||||
import { BufferRunner } from './taskbuffer.classes.bufferrunner.js';
|
import { BufferRunner } from './taskbuffer.classes.bufferrunner.js';
|
||||||
import { CycleCounter } from './taskbuffer.classes.cyclecounter.js';
|
import { CycleCounter } from './taskbuffer.classes.cyclecounter.js';
|
||||||
|
import { TaskStep, type ITaskStep } from './taskbuffer.classes.taskstep.js';
|
||||||
|
import type { ITaskMetadata, ITaskEvent, TTaskEventType } from './taskbuffer.interfaces.js';
|
||||||
|
|
||||||
import { logger } from './taskbuffer.logging.js';
|
import { logger } from './taskbuffer.logging.js';
|
||||||
|
|
||||||
@@ -14,17 +16,21 @@ export interface ITaskSetupFunction<T = undefined> {
|
|||||||
|
|
||||||
export type TPreOrAfterTaskFunction = () => Task<any>;
|
export type TPreOrAfterTaskFunction = () => Task<any>;
|
||||||
|
|
||||||
export class Task<T = undefined> {
|
// Type helper to extract step names from array
|
||||||
// STATIC
|
export type StepNames<T> = T extends ReadonlyArray<{ name: infer N }> ? N : never;
|
||||||
public static extractTask<T = undefined>(preOrAfterTaskArg: Task<T> | TPreOrAfterTaskFunction): Task<T> {
|
|
||||||
|
export class Task<T = undefined, TSteps extends ReadonlyArray<{ name: string; description: string; percentage: number }> = []> {
|
||||||
|
public static extractTask<T = undefined, TSteps extends ReadonlyArray<{ name: string; description: string; percentage: number }> = []>(
|
||||||
|
preOrAfterTaskArg: Task<T, TSteps> | TPreOrAfterTaskFunction,
|
||||||
|
): Task<T, TSteps> {
|
||||||
switch (true) {
|
switch (true) {
|
||||||
case !preOrAfterTaskArg:
|
case !preOrAfterTaskArg:
|
||||||
return null;
|
return null;
|
||||||
case preOrAfterTaskArg instanceof Task:
|
case preOrAfterTaskArg instanceof Task:
|
||||||
return preOrAfterTaskArg as Task<T>;
|
return preOrAfterTaskArg as Task<T, TSteps>;
|
||||||
case typeof preOrAfterTaskArg === 'function':
|
case typeof preOrAfterTaskArg === 'function':
|
||||||
const taskFunction = preOrAfterTaskArg as TPreOrAfterTaskFunction;
|
const taskFunction = preOrAfterTaskArg as TPreOrAfterTaskFunction;
|
||||||
return taskFunction();
|
return taskFunction() as unknown as Task<T, TSteps>;
|
||||||
default:
|
default:
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
@@ -44,9 +50,9 @@ export class Task<T = undefined> {
|
|||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
public static isTaskTouched<T = undefined> (
|
public static isTaskTouched<T = undefined, TSteps extends ReadonlyArray<{ name: string; description: string; percentage: number }> = []>(
|
||||||
taskArg: Task<T> | TPreOrAfterTaskFunction,
|
taskArg: Task<T, TSteps> | TPreOrAfterTaskFunction,
|
||||||
touchedTasksArray: Task<T>[]
|
touchedTasksArray: Task<T, TSteps>[],
|
||||||
): boolean {
|
): boolean {
|
||||||
const taskToCheck = Task.extractTask(taskArg);
|
const taskToCheck = Task.extractTask(taskArg);
|
||||||
let result = false;
|
let result = false;
|
||||||
@@ -56,15 +62,20 @@ export class Task<T = undefined> {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
return result;
|
return result;
|
||||||
};
|
}
|
||||||
|
|
||||||
public static runTask = async <T>(
|
public static runTask = async <T, TSteps extends ReadonlyArray<{ name: string; description: string; percentage: number }> = []>(
|
||||||
taskArg: Task<T> | TPreOrAfterTaskFunction,
|
taskArg: Task<T, TSteps> | TPreOrAfterTaskFunction,
|
||||||
optionsArg: { x?: any; touchedTasksArray?: Task<T>[] }
|
optionsArg: { x?: any; touchedTasksArray?: Task<T, TSteps>[] },
|
||||||
) => {
|
) => {
|
||||||
const taskToRun = Task.extractTask(taskArg);
|
const taskToRun = Task.extractTask(taskArg);
|
||||||
const done = plugins.smartpromise.defer();
|
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) {
|
if (!taskToRun.setupValue && taskToRun.taskSetup) {
|
||||||
taskToRun.setupValue = await taskToRun.taskSetup();
|
taskToRun.setupValue = await taskToRun.taskSetup();
|
||||||
}
|
}
|
||||||
@@ -74,9 +85,41 @@ export class Task<T = undefined> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
taskToRun.running = true;
|
taskToRun.running = true;
|
||||||
|
taskToRun.runCount++;
|
||||||
|
taskToRun.lastRun = new Date();
|
||||||
|
|
||||||
done.promise.then(async () => {
|
// 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;
|
taskToRun.running = false;
|
||||||
|
|
||||||
|
// Complete all steps when task finishes
|
||||||
|
taskToRun.completeAllSteps();
|
||||||
|
taskToRun.emitEvent(taskToRun.lastError ? 'failed' : 'completed');
|
||||||
|
|
||||||
|
// 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;
|
||||||
|
});
|
||||||
|
})
|
||||||
|
.catch((err) => {
|
||||||
|
taskToRun.running = false;
|
||||||
|
taskToRun.emitEvent('failed', { error: err instanceof Error ? err.message : String(err) });
|
||||||
|
|
||||||
|
// Resolve finished so blocking dependants don't hang
|
||||||
|
taskToRun.resolveFinished();
|
||||||
|
|
||||||
|
// Create a new finished promise for the next run
|
||||||
|
taskToRun.finished = new Promise((resolve) => {
|
||||||
|
taskToRun.resolveFinished = resolve;
|
||||||
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
const options = {
|
const options = {
|
||||||
@@ -84,14 +127,17 @@ export class Task<T = undefined> {
|
|||||||
...optionsArg,
|
...optionsArg,
|
||||||
};
|
};
|
||||||
const x = options.x;
|
const x = options.x;
|
||||||
const touchedTasksArray: Task<T>[] = options.touchedTasksArray;
|
const touchedTasksArray: Task<T, TSteps>[] = options.touchedTasksArray;
|
||||||
|
|
||||||
touchedTasksArray.push(taskToRun);
|
touchedTasksArray.push(taskToRun);
|
||||||
|
|
||||||
const localDeferred = plugins.smartpromise.defer();
|
const localDeferred = plugins.smartpromise.defer();
|
||||||
localDeferred.promise
|
localDeferred.promise
|
||||||
.then(() => {
|
.then(() => {
|
||||||
if (taskToRun.preTask && !Task.isTaskTouched(taskToRun.preTask, touchedTasksArray)) {
|
if (
|
||||||
|
taskToRun.preTask &&
|
||||||
|
!Task.isTaskTouched(taskToRun.preTask, touchedTasksArray)
|
||||||
|
) {
|
||||||
return Task.runTask(taskToRun.preTask, { x, touchedTasksArray });
|
return Task.runTask(taskToRun.preTask, { x, touchedTasksArray });
|
||||||
} else {
|
} else {
|
||||||
const done2 = plugins.smartpromise.defer();
|
const done2 = plugins.smartpromise.defer();
|
||||||
@@ -103,12 +149,24 @@ export class Task<T = undefined> {
|
|||||||
try {
|
try {
|
||||||
return await taskToRun.taskFunction(x, taskToRun.setupValue);
|
return await taskToRun.taskFunction(x, taskToRun.setupValue);
|
||||||
} catch (e) {
|
} 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) => {
|
.then((x) => {
|
||||||
if (taskToRun.afterTask && !Task.isTaskTouched(taskToRun.afterTask, touchedTasksArray)) {
|
if (
|
||||||
return Task.runTask(taskToRun.afterTask, { x: x, touchedTasksArray: touchedTasksArray });
|
taskToRun.afterTask &&
|
||||||
|
!Task.isTaskTouched(taskToRun.afterTask, touchedTasksArray)
|
||||||
|
) {
|
||||||
|
return Task.runTask(taskToRun.afterTask, {
|
||||||
|
x: x,
|
||||||
|
touchedTasksArray: touchedTasksArray,
|
||||||
|
});
|
||||||
} else {
|
} else {
|
||||||
const done2 = plugins.smartpromise.defer();
|
const done2 = plugins.smartpromise.defer();
|
||||||
done2.resolve(x);
|
done2.resolve(x);
|
||||||
@@ -119,13 +177,20 @@ export class Task<T = undefined> {
|
|||||||
done.resolve(x);
|
done.resolve(x);
|
||||||
})
|
})
|
||||||
.catch((err) => {
|
.catch((err) => {
|
||||||
console.log(err);
|
done.reject(err);
|
||||||
});
|
});
|
||||||
localDeferred.resolve();
|
localDeferred.resolve();
|
||||||
|
|
||||||
|
try {
|
||||||
return await done.promise;
|
return await done.promise;
|
||||||
|
} catch (err) {
|
||||||
|
if (taskToRun.catchErrors) {
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
throw err;
|
||||||
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
// INSTANCE
|
|
||||||
public name: string;
|
public name: string;
|
||||||
public version: string;
|
public version: string;
|
||||||
public taskFunction: ITaskFunction<T>;
|
public taskFunction: ITaskFunction<T>;
|
||||||
@@ -136,38 +201,119 @@ export class Task<T = undefined> {
|
|||||||
public execDelay: number;
|
public execDelay: number;
|
||||||
public timeout: number;
|
public timeout: number;
|
||||||
|
|
||||||
public preTask: Task<T> | TPreOrAfterTaskFunction;
|
public preTask: Task<T, any> | TPreOrAfterTaskFunction;
|
||||||
public afterTask: Task<T> | TPreOrAfterTaskFunction;
|
public afterTask: Task<T, any> | TPreOrAfterTaskFunction;
|
||||||
|
|
||||||
|
// Add a list to store the blocking tasks
|
||||||
|
public blockingTasks: Task[] = [];
|
||||||
|
|
||||||
|
// Add a promise that will resolve when the task has finished
|
||||||
|
private finished: Promise<void>;
|
||||||
|
private resolveFinished: () => void;
|
||||||
|
|
||||||
public running: boolean = false;
|
public running: boolean = false;
|
||||||
public bufferRunner = new BufferRunner(this);
|
public bufferRunner = new BufferRunner(this);
|
||||||
public cycleCounter = new CycleCounter(this);
|
public cycleCounter = new CycleCounter(this);
|
||||||
|
public lastRun?: Date;
|
||||||
|
public runCount: number = 0;
|
||||||
|
|
||||||
public idle: boolean = true;
|
// Error handling
|
||||||
private _state: string = 'ready';
|
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 taskSetup: ITaskSetupFunction<T>;
|
||||||
public setupValue: T;
|
public setupValue: T;
|
||||||
|
|
||||||
|
// Step tracking properties
|
||||||
|
private steps = new Map<string, TaskStep>();
|
||||||
|
private stepProgress = new Map<string, number>();
|
||||||
|
public currentStepName?: string;
|
||||||
|
private providedSteps?: TSteps;
|
||||||
|
|
||||||
constructor(optionsArg: {
|
constructor(optionsArg: {
|
||||||
taskFunction: ITaskFunction<T>;
|
taskFunction: ITaskFunction<T>;
|
||||||
preTask?: Task<T> | TPreOrAfterTaskFunction;
|
preTask?: Task<T, any> | TPreOrAfterTaskFunction;
|
||||||
afterTask?: Task<T> | TPreOrAfterTaskFunction;
|
afterTask?: Task<T, any> | TPreOrAfterTaskFunction;
|
||||||
buffered?: boolean;
|
buffered?: boolean;
|
||||||
bufferMax?: number;
|
bufferMax?: number;
|
||||||
execDelay?: number;
|
execDelay?: number;
|
||||||
name?: string;
|
name?: string;
|
||||||
taskSetup?: ITaskSetupFunction<T>;
|
taskSetup?: ITaskSetupFunction<T>;
|
||||||
|
steps?: TSteps;
|
||||||
|
catchErrors?: boolean;
|
||||||
|
labels?: Record<string, string>;
|
||||||
}) {
|
}) {
|
||||||
this.taskFunction = optionsArg.taskFunction;
|
this.taskFunction = optionsArg.taskFunction;
|
||||||
this.preTask = optionsArg.preTask;
|
this.preTask = optionsArg.preTask;
|
||||||
this.afterTask = optionsArg.afterTask;
|
this.afterTask = optionsArg.afterTask;
|
||||||
this.idle = !this.running;
|
|
||||||
this.buffered = optionsArg.buffered;
|
this.buffered = optionsArg.buffered;
|
||||||
this.bufferMax = optionsArg.bufferMax;
|
this.bufferMax = optionsArg.bufferMax;
|
||||||
this.execDelay = optionsArg.execDelay;
|
this.execDelay = optionsArg.execDelay;
|
||||||
this.name = optionsArg.name;
|
this.name = optionsArg.name;
|
||||||
this.taskSetup = optionsArg.taskSetup;
|
this.taskSetup = optionsArg.taskSetup;
|
||||||
|
this.catchErrors = optionsArg.catchErrors ?? false;
|
||||||
|
this.labels = optionsArg.labels ? { ...optionsArg.labels } : {};
|
||||||
|
|
||||||
|
// Initialize steps if provided
|
||||||
|
if (optionsArg.steps) {
|
||||||
|
this.providedSteps = optionsArg.steps;
|
||||||
|
for (const stepConfig of optionsArg.steps) {
|
||||||
|
const step = new TaskStep({
|
||||||
|
name: stepConfig.name,
|
||||||
|
description: stepConfig.description,
|
||||||
|
percentage: stepConfig.percentage,
|
||||||
|
});
|
||||||
|
this.steps.set(stepConfig.name, step);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Create the finished promise
|
||||||
|
this.finished = new Promise((resolve) => {
|
||||||
|
this.resolveFinished = resolve;
|
||||||
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
public trigger(x?: any): Promise<any> {
|
public trigger(x?: any): Promise<any> {
|
||||||
@@ -179,22 +325,116 @@ export class Task<T = undefined> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
public triggerUnBuffered(x?: any): Promise<any> {
|
public triggerUnBuffered(x?: any): Promise<any> {
|
||||||
return Task.runTask<T>(this, { x: x });
|
return Task.runTask<T, TSteps>(this, { x: x });
|
||||||
}
|
}
|
||||||
|
|
||||||
public triggerBuffered(x?: any): Promise<any> {
|
public triggerBuffered(x?: any): Promise<any> {
|
||||||
return this.bufferRunner.trigger(x);
|
return this.bufferRunner.trigger(x);
|
||||||
}
|
}
|
||||||
|
|
||||||
get state(): string {
|
// Step notification method with typed step names
|
||||||
return this._state;
|
public notifyStep(stepName: StepNames<TSteps>): void {
|
||||||
|
// Complete previous step if exists
|
||||||
|
if (this.currentStepName) {
|
||||||
|
const prevStep = this.steps.get(this.currentStepName);
|
||||||
|
if (prevStep && prevStep.status === 'active') {
|
||||||
|
prevStep.complete();
|
||||||
|
this.stepProgress.set(this.currentStepName, prevStep.percentage);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
set state(stateArg: string) {
|
// Start new step
|
||||||
if (stateArg === 'locked') {
|
const step = this.steps.get(stepName as string);
|
||||||
this._state = 'locked';
|
if (step) {
|
||||||
} else {
|
step.start();
|
||||||
logger.log('error', `state type ${stateArg} could not be set`);
|
this.currentStepName = stepName as string;
|
||||||
|
this.emitEvent('step', { stepName: stepName as string });
|
||||||
|
|
||||||
|
if (this.name) {
|
||||||
|
logger.log('info', `Task ${this.name}: Starting step "${stepName}" - ${step.description}`);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Get current progress based on completed steps
|
||||||
|
public getProgress(): number {
|
||||||
|
let totalProgress = 0;
|
||||||
|
for (const [stepName, percentage] of this.stepProgress) {
|
||||||
|
totalProgress += percentage;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Add partial progress of current step if exists
|
||||||
|
if (this.currentStepName) {
|
||||||
|
const currentStep = this.steps.get(this.currentStepName);
|
||||||
|
if (currentStep && currentStep.status === 'active') {
|
||||||
|
// Could add partial progress calculation here if needed
|
||||||
|
// For now, we'll consider active steps as 50% complete
|
||||||
|
totalProgress += currentStep.percentage * 0.5;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return Math.min(100, Math.round(totalProgress));
|
||||||
|
}
|
||||||
|
|
||||||
|
// Get all steps metadata
|
||||||
|
public getStepsMetadata(): ITaskStep[] {
|
||||||
|
return Array.from(this.steps.values()).map(step => step.toJSON());
|
||||||
|
}
|
||||||
|
|
||||||
|
// 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,
|
||||||
|
steps: this.getStepsMetadata(),
|
||||||
|
currentStep: this.currentStepName,
|
||||||
|
currentProgress: this.getProgress(),
|
||||||
|
runCount: this.runCount,
|
||||||
|
buffered: this.buffered,
|
||||||
|
bufferMax: this.bufferMax,
|
||||||
|
timeout: this.timeout,
|
||||||
|
cronSchedule: this.cronJob?.cronExpression,
|
||||||
|
lastError: this.lastError?.message,
|
||||||
|
errorCount: this.errorCount,
|
||||||
|
labels: { ...this.labels },
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
// Reset all steps to pending state
|
||||||
|
public resetSteps(): void {
|
||||||
|
this.steps.forEach(step => step.reset());
|
||||||
|
this.stepProgress.clear();
|
||||||
|
this.currentStepName = undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Complete all remaining steps (useful for cleanup)
|
||||||
|
private completeAllSteps(): void {
|
||||||
|
if (this.currentStepName) {
|
||||||
|
const currentStep = this.steps.get(this.currentStepName);
|
||||||
|
if (currentStep && currentStep.status === 'active') {
|
||||||
|
currentStep.complete();
|
||||||
|
this.stepProgress.set(this.currentStepName, currentStep.percentage);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Mark any pending steps as completed (in case of early task completion)
|
||||||
|
this.steps.forEach((step, name) => {
|
||||||
|
if (step.status === 'pending') {
|
||||||
|
// Don't add their percentage to progress since they weren't actually executed
|
||||||
|
step.status = 'completed';
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -27,14 +27,20 @@ export class Taskchain extends Task {
|
|||||||
let taskCounter = 0; // counter for iterating async over the taskArray
|
let taskCounter = 0; // counter for iterating async over the taskArray
|
||||||
const iterateTasks = (x: any) => {
|
const iterateTasks = (x: any) => {
|
||||||
if (typeof this.taskArray[taskCounter] !== 'undefined') {
|
if (typeof this.taskArray[taskCounter] !== 'undefined') {
|
||||||
console.log(this.name + ' running: Task' + this.taskArray[taskCounter].name);
|
logger.log('info', `${this.name} running: Task ${this.taskArray[taskCounter].name}`);
|
||||||
this.taskArray[taskCounter].trigger(x).then((x) => {
|
this.taskArray[taskCounter].trigger(x).then((x) => {
|
||||||
logger.log('info', this.taskArray[taskCounter].name);
|
logger.log('info', this.taskArray[taskCounter].name);
|
||||||
taskCounter++;
|
taskCounter++;
|
||||||
iterateTasks(x);
|
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 {
|
} else {
|
||||||
console.log('Taskchain "' + this.name + '" completed successfully');
|
logger.log('info', `Taskchain "${this.name}" completed successfully`);
|
||||||
done.resolve(x);
|
done.resolve(x);
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
@@ -49,10 +55,15 @@ export class Taskchain extends Task {
|
|||||||
addTask(taskArg: Task) {
|
addTask(taskArg: Task) {
|
||||||
this.taskArray.push(taskArg);
|
this.taskArray.push(taskArg);
|
||||||
}
|
}
|
||||||
removeTask(taskArg: Task) {
|
removeTask(taskArg: Task): boolean {
|
||||||
// TODO:
|
const index = this.taskArray.indexOf(taskArg);
|
||||||
|
if (index === -1) {
|
||||||
|
return false;
|
||||||
}
|
}
|
||||||
shiftTask() {
|
this.taskArray.splice(index, 1);
|
||||||
// TODO:
|
return true;
|
||||||
|
}
|
||||||
|
shiftTask(): Task | undefined {
|
||||||
|
return this.taskArray.shift();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,6 +1,7 @@
|
|||||||
import * as plugins from './taskbuffer.plugins.js';
|
import * as plugins from './taskbuffer.plugins.js';
|
||||||
|
|
||||||
import { Task, type ITaskFunction } from './taskbuffer.classes.task.js';
|
import { Task, type ITaskFunction } from './taskbuffer.classes.task.js';
|
||||||
|
import { logger } from './taskbuffer.logging.js';
|
||||||
|
|
||||||
export class TaskDebounced<T = unknown> extends Task {
|
export class TaskDebounced<T = unknown> extends Task {
|
||||||
private _debouncedTaskFunction: ITaskFunction;
|
private _debouncedTaskFunction: ITaskFunction;
|
||||||
@@ -19,9 +20,20 @@ export class TaskDebounced<T = unknown> extends Task {
|
|||||||
});
|
});
|
||||||
this.taskFunction = optionsArg.taskFunction;
|
this.taskFunction = optionsArg.taskFunction;
|
||||||
this._observableIntake.observable
|
this._observableIntake.observable
|
||||||
.pipe(plugins.smartrx.rxjs.ops.debounceTime(optionsArg.debounceTimeInMillis))
|
.pipe(
|
||||||
.subscribe((x) => {
|
plugins.smartrx.rxjs.ops.debounceTime(optionsArg.debounceTimeInMillis),
|
||||||
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,15 @@
|
|||||||
import * as plugins from './taskbuffer.plugins.js';
|
import * as plugins from './taskbuffer.plugins.js';
|
||||||
import { Task } from './taskbuffer.classes.task.js';
|
import { Task } from './taskbuffer.classes.task.js';
|
||||||
import { AbstractDistributedCoordinator } from './taskbuffer.classes.distributedcoordinator.js';
|
import {
|
||||||
|
AbstractDistributedCoordinator,
|
||||||
|
type IDistributedTaskRequestResult,
|
||||||
|
} from './taskbuffer.classes.distributedcoordinator.js';
|
||||||
|
import type { ITaskMetadata, ITaskExecutionReport, IScheduledTaskInfo, ITaskEvent } from './taskbuffer.interfaces.js';
|
||||||
|
import { logger } from './taskbuffer.logging.js';
|
||||||
|
|
||||||
export interface ICronJob {
|
export interface ICronJob {
|
||||||
cronString: string;
|
cronString: string;
|
||||||
taskNameArg: string;
|
taskName: string;
|
||||||
job: any;
|
job: any;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -13,155 +18,283 @@ export interface ITaskManagerConstructorOptions {
|
|||||||
}
|
}
|
||||||
|
|
||||||
export class TaskManager {
|
export class TaskManager {
|
||||||
public randomId = plugins.isounique.uni();
|
public randomId = plugins.smartunique.shortId();
|
||||||
public taskMap = new plugins.lik.ObjectMap<Task>();
|
public taskMap = new plugins.lik.ObjectMap<Task<any, any>>();
|
||||||
|
public readonly taskSubject = new plugins.smartrx.rxjs.Subject<ITaskEvent>();
|
||||||
|
private taskSubscriptions = new Map<Task<any, any>, plugins.smartrx.rxjs.Subscription>();
|
||||||
private cronJobManager = new plugins.smarttime.CronManager();
|
private cronJobManager = new plugins.smarttime.CronManager();
|
||||||
|
|
||||||
public options: ITaskManagerConstructorOptions = {
|
public options: ITaskManagerConstructorOptions = {
|
||||||
distributedCoordinator: null,
|
distributedCoordinator: null,
|
||||||
};
|
};
|
||||||
|
|
||||||
constructor(optionsArg: ITaskManagerConstructorOptions = {}) {
|
constructor(options: ITaskManagerConstructorOptions = {}) {
|
||||||
this.options = Object.assign(this.options, optionsArg);
|
this.options = Object.assign(this.options, options);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
public getTaskByName(taskName: string): Task<any, any> {
|
||||||
* checks if a task is already present
|
return this.taskMap.findSync((task) => task.name === taskName);
|
||||||
* @param taskNameArg
|
}
|
||||||
*/
|
|
||||||
public getTaskByName(taskNameArg: string): Task {
|
public addTask(task: Task<any, any>): void {
|
||||||
return this.taskMap.findSync((itemArg) => {
|
if (!task.name) {
|
||||||
return itemArg.name === taskNameArg;
|
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 removeTask(task: Task<any, any>): void {
|
||||||
* adds a Task to the TaskManager
|
this.taskMap.remove(task);
|
||||||
* @param taskArg
|
const subscription = this.taskSubscriptions.get(task);
|
||||||
*/
|
if (subscription) {
|
||||||
public addTask(taskArg: Task): void {
|
subscription.unsubscribe();
|
||||||
if (!taskArg.name) {
|
this.taskSubscriptions.delete(task);
|
||||||
throw new Error('taskArg needs a name to be added to taskManager');
|
|
||||||
}
|
}
|
||||||
this.taskMap.add(taskArg);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
public addAndScheduleTask(task: Task<any, any>, cronString: string) {
|
||||||
* adds and schedules a task at once
|
this.addTask(task);
|
||||||
* @param taskArg
|
this.scheduleTaskByName(task.name, cronString);
|
||||||
* @param cronStringArg
|
|
||||||
*/
|
|
||||||
public addAndScheduleTask(taskArg: Task, cronStringArg: string) {
|
|
||||||
this.addTask(taskArg);
|
|
||||||
this.scheduleTaskByName(taskArg.name, cronStringArg);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
public async triggerTaskByName(taskName: string): Promise<any> {
|
||||||
* triggers a task in the TaskManagerByName
|
const taskToTrigger = this.getTaskByName(taskName);
|
||||||
* @param taskNameArg
|
|
||||||
*/
|
|
||||||
public triggerTaskByName(taskNameArg: string): Promise<any> {
|
|
||||||
const taskToTrigger = this.getTaskByName(taskNameArg);
|
|
||||||
if (!taskToTrigger) {
|
if (!taskToTrigger) {
|
||||||
throw new Error(`There is no task with the name of ${taskNameArg}`);
|
throw new Error(`No task with the name ${taskName} found.`);
|
||||||
}
|
}
|
||||||
return taskToTrigger.trigger();
|
return taskToTrigger.trigger();
|
||||||
}
|
}
|
||||||
|
|
||||||
public async triggerTask(task: Task) {
|
public async triggerTask(task: Task<any, any>) {
|
||||||
return task.trigger();
|
return task.trigger();
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
public scheduleTaskByName(taskName: string, cronString: string) {
|
||||||
* schedules the task by name
|
const taskToSchedule = this.getTaskByName(taskName);
|
||||||
* @param taskNameArg
|
if (!taskToSchedule) {
|
||||||
*/
|
throw new Error(`No task with the name ${taskName} found.`);
|
||||||
public scheduleTaskByName(taskNameArg: string, cronStringArg: string) {
|
}
|
||||||
const taskToSchedule = this.getTaskByName(taskNameArg);
|
this.handleTaskScheduling(taskToSchedule, cronString);
|
||||||
const cronJob = this.cronJobManager.addCronjob(
|
}
|
||||||
cronStringArg,
|
|
||||||
async (triggerTimeArg: number) => {
|
|
||||||
console.log(`taskbuffer schedule triggered task >>${taskToSchedule.name}<<`);
|
|
||||||
console.log(
|
|
||||||
`task >>${taskToSchedule.name}<< is ${
|
|
||||||
taskToSchedule.buffered
|
|
||||||
? `buffered with max ${taskToSchedule.bufferMax} buffered calls`
|
|
||||||
: `unbuffered`
|
|
||||||
}`
|
|
||||||
);
|
|
||||||
if (this.options.distributedCoordinator) {
|
|
||||||
console.log(`Found a distrubuted coordinator, performing distributed consultation.`);
|
|
||||||
const announcementResult =
|
|
||||||
await this.options.distributedCoordinator.fireDistributedTaskRequest({
|
|
||||||
submitterRandomId: this.randomId,
|
|
||||||
status: 'requesting',
|
|
||||||
taskExecutionParallel: 1,
|
|
||||||
taskExecutionTime: triggerTimeArg,
|
|
||||||
taskExecutionTimeout: taskToSchedule.timeout,
|
|
||||||
taskName: taskToSchedule.name,
|
|
||||||
taskVersion: taskToSchedule.version,
|
|
||||||
});
|
|
||||||
|
|
||||||
|
private handleTaskScheduling(task: Task<any, any>, cronString: string) {
|
||||||
|
const cronJob = this.cronJobManager.addCronjob(
|
||||||
|
cronString,
|
||||||
|
async (triggerTime: number) => {
|
||||||
|
this.logTaskState(task);
|
||||||
|
if (this.options.distributedCoordinator) {
|
||||||
|
const announcementResult = await this.performDistributedConsultation(
|
||||||
|
task,
|
||||||
|
triggerTime,
|
||||||
|
);
|
||||||
if (!announcementResult.shouldTrigger) {
|
if (!announcementResult.shouldTrigger) {
|
||||||
console.log('distributed coordinator result: NOT EXECUTING');
|
logger.log('info', 'Distributed coordinator result: NOT EXECUTING');
|
||||||
return;
|
return;
|
||||||
} else {
|
} else {
|
||||||
console.log('distributed coordinator result: CHOSEN AND EXECUTING');
|
logger.log('info', 'Distributed coordinator result: CHOSEN AND EXECUTING');
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
await taskToSchedule.trigger();
|
try {
|
||||||
|
await task.trigger();
|
||||||
|
} catch (err) {
|
||||||
|
logger.log('error', `TaskManager: scheduled task "${task.name || 'unnamed'}" failed: ${err instanceof Error ? err.message : String(err)}`);
|
||||||
}
|
}
|
||||||
|
},
|
||||||
);
|
);
|
||||||
taskToSchedule.cronJob = cronJob;
|
task.cronJob = cronJob;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
private logTaskState(task: Task<any, any>) {
|
||||||
* deschedules a task by name
|
logger.log('info', `Taskbuffer schedule triggered task >>${task.name}<<`);
|
||||||
* @param taskNameArg
|
const bufferState = task.buffered
|
||||||
*/
|
? `buffered with max ${task.bufferMax} buffered calls`
|
||||||
public descheduleTaskByName(taskNameArg: string) {
|
: `unbuffered`;
|
||||||
const taskToDeSchedule = this.getTaskByName(taskNameArg);
|
logger.log('info', `Task >>${task.name}<< is ${bufferState}`);
|
||||||
if (taskToDeSchedule.cronJob) {
|
}
|
||||||
this.cronJobManager.removeCronjob(taskToDeSchedule.cronJob);
|
|
||||||
taskToDeSchedule.cronJob = null;
|
private async performDistributedConsultation(
|
||||||
|
task: Task<any, any>,
|
||||||
|
triggerTime: number,
|
||||||
|
): Promise<IDistributedTaskRequestResult> {
|
||||||
|
logger.log('info', 'Found a distributed coordinator, performing consultation.');
|
||||||
|
|
||||||
|
return this.options.distributedCoordinator.fireDistributedTaskRequest({
|
||||||
|
submitterId: this.randomId,
|
||||||
|
requestResponseId: plugins.smartunique.shortId(),
|
||||||
|
status: 'requesting',
|
||||||
|
taskExecutionParallel: 1,
|
||||||
|
taskExecutionTime: triggerTime,
|
||||||
|
taskExecutionTimeout: task.timeout,
|
||||||
|
taskName: task.name,
|
||||||
|
taskVersion: task.version,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
public descheduleTaskByName(taskName: string) {
|
||||||
|
const task = this.getTaskByName(taskName);
|
||||||
|
if (task && task.cronJob) {
|
||||||
|
this.cronJobManager.removeCronjob(task.cronJob);
|
||||||
|
task.cronJob = null;
|
||||||
}
|
}
|
||||||
if (this.cronJobManager.cronjobs.isEmpty) {
|
if (this.cronJobManager.cronjobs.isEmpty) {
|
||||||
this.cronJobManager.stop();
|
this.cronJobManager.stop();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
public async descheduleTask(task: Task<any, any>) {
|
||||||
* deschedules a task
|
|
||||||
* @param task
|
|
||||||
*/
|
|
||||||
public async descheduleTask(task: Task) {
|
|
||||||
await this.descheduleTaskByName(task.name);
|
await this.descheduleTaskByName(task.name);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
public getScheduleForTaskName(taskName: string): string | null {
|
||||||
* returns the schedule of a specific task
|
const task = this.getTaskByName(taskName);
|
||||||
* @param taskNameArg
|
return task && task.cronJob ? task.cronJob.cronExpression : null;
|
||||||
*/
|
|
||||||
public getScheduleForTaskName(taskNameArg: string): string | null {
|
|
||||||
const task = this.getTaskByName(taskNameArg);
|
|
||||||
if (!task || !task.cronJob) {
|
|
||||||
return null;
|
|
||||||
}
|
}
|
||||||
return task.cronJob.cronExpression;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
public async start() {
|
||||||
/**
|
if (this.options.distributedCoordinator) {
|
||||||
* starts the taskmanager
|
await this.options.distributedCoordinator.start();
|
||||||
*/
|
}
|
||||||
public start() {
|
|
||||||
this.cronJobManager.start();
|
this.cronJobManager.start();
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
public async stop() {
|
||||||
* stops the taskmanager
|
|
||||||
*/
|
|
||||||
public stop() {
|
|
||||||
this.cronJobManager.stop();
|
this.cronJobManager.stop();
|
||||||
|
if (this.options.distributedCoordinator) {
|
||||||
|
await this.options.distributedCoordinator.stop();
|
||||||
|
}
|
||||||
|
for (const [, subscription] of this.taskSubscriptions) {
|
||||||
|
subscription.unsubscribe();
|
||||||
|
}
|
||||||
|
this.taskSubscriptions.clear();
|
||||||
|
}
|
||||||
|
|
||||||
|
// Get metadata for a specific task
|
||||||
|
public getTaskMetadata(taskName: string): ITaskMetadata | null {
|
||||||
|
const task = this.getTaskByName(taskName);
|
||||||
|
if (!task) return null;
|
||||||
|
return task.getMetadata();
|
||||||
|
}
|
||||||
|
|
||||||
|
// Get metadata for all tasks
|
||||||
|
public getAllTasksMetadata(): ITaskMetadata[] {
|
||||||
|
return this.taskMap.getArray().map(task => task.getMetadata());
|
||||||
|
}
|
||||||
|
|
||||||
|
// 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({
|
||||||
|
name: task.name || 'unnamed',
|
||||||
|
schedule: task.cronJob.cronExpression,
|
||||||
|
nextRun: new Date(task.cronJob.getNextExecutionTime()),
|
||||||
|
lastRun: task.lastRun,
|
||||||
|
steps: task.getStepsMetadata?.(),
|
||||||
|
metadata: task.getMetadata(),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return scheduledTasks;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Get next scheduled runs across all tasks
|
||||||
|
public getNextScheduledRuns(limit: number = 10): Array<{ taskName: string; nextRun: Date; schedule: string }> {
|
||||||
|
const scheduledRuns = this.getScheduledTasks()
|
||||||
|
.map(task => ({
|
||||||
|
taskName: task.name,
|
||||||
|
nextRun: task.nextRun,
|
||||||
|
schedule: task.schedule,
|
||||||
|
}))
|
||||||
|
.sort((a, b) => a.nextRun.getTime() - b.nextRun.getTime())
|
||||||
|
.slice(0, limit);
|
||||||
|
|
||||||
|
return scheduledRuns;
|
||||||
|
}
|
||||||
|
|
||||||
|
public getTasksByLabel(key: string, value: string): Task<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>,
|
||||||
|
options?: {
|
||||||
|
schedule?: string;
|
||||||
|
trackProgress?: boolean;
|
||||||
|
}
|
||||||
|
): 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();
|
||||||
|
|
||||||
|
// Collect execution report
|
||||||
|
const report: ITaskExecutionReport = {
|
||||||
|
taskName: task.name || 'unnamed',
|
||||||
|
startTime,
|
||||||
|
endTime: Date.now(),
|
||||||
|
duration: Date.now() - startTime,
|
||||||
|
steps: task.getStepsMetadata(),
|
||||||
|
stepsCompleted: task.getStepsMetadata()
|
||||||
|
.filter(step => step.status === 'completed')
|
||||||
|
.map(step => step.name),
|
||||||
|
progress: task.getProgress(),
|
||||||
|
result,
|
||||||
|
};
|
||||||
|
|
||||||
|
// Remove task from manager
|
||||||
|
this.removeTask(task);
|
||||||
|
|
||||||
|
// Deschedule if it was scheduled
|
||||||
|
if (options?.schedule && task.name) {
|
||||||
|
this.descheduleTaskByName(task.name);
|
||||||
|
}
|
||||||
|
|
||||||
|
return report;
|
||||||
|
} catch (error) {
|
||||||
|
// Create error report
|
||||||
|
const errorReport: ITaskExecutionReport = {
|
||||||
|
taskName: task.name || 'unnamed',
|
||||||
|
startTime,
|
||||||
|
endTime: Date.now(),
|
||||||
|
duration: Date.now() - startTime,
|
||||||
|
steps: task.getStepsMetadata(),
|
||||||
|
stepsCompleted: task.getStepsMetadata()
|
||||||
|
.filter(step => step.status === 'completed')
|
||||||
|
.map(step => step.name),
|
||||||
|
progress: task.getProgress(),
|
||||||
|
error: error as Error,
|
||||||
|
};
|
||||||
|
|
||||||
|
// Remove task from manager even on error
|
||||||
|
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) {
|
this.taskArray.forEach(function (taskArg) {
|
||||||
promiseArray.push(taskArg.trigger());
|
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;
|
return done.promise;
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
|||||||
@@ -1,12 +1,14 @@
|
|||||||
import * as plugins from './taskbuffer.plugins.js';
|
import * as plugins from './taskbuffer.plugins.js';
|
||||||
|
|
||||||
import { Task } from './taskbuffer.classes.task.js';
|
import { Task } from './taskbuffer.classes.task.js';
|
||||||
|
import { logger } from './taskbuffer.logging.js';
|
||||||
|
|
||||||
export class TaskRunner {
|
export class TaskRunner {
|
||||||
public maxParrallelJobs: number = 1;
|
public maxParallelJobs: number = 1;
|
||||||
public status: 'stopped' | 'running' = 'stopped';
|
public status: 'stopped' | 'running' = 'stopped';
|
||||||
public runningTasks: plugins.lik.ObjectMap<Task> = new plugins.lik.ObjectMap<Task>();
|
public runningTasks: plugins.lik.ObjectMap<Task> =
|
||||||
public qeuedTasks: Task[] = [];
|
new plugins.lik.ObjectMap<Task>();
|
||||||
|
public queuedTasks: Task[] = [];
|
||||||
|
|
||||||
constructor() {
|
constructor() {
|
||||||
this.runningTasks.eventSubject.subscribe(async (eventArg) => {
|
this.runningTasks.eventSubject.subscribe(async (eventArg) => {
|
||||||
@@ -15,19 +17,19 @@ export class TaskRunner {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* adds a task to the qeue
|
* adds a task to the queue
|
||||||
*/
|
*/
|
||||||
public addTask(taskArg: Task) {
|
public addTask(taskArg: Task) {
|
||||||
this.qeuedTasks.push(taskArg);
|
this.queuedTasks.push(taskArg);
|
||||||
this.checkExecution();
|
this.checkExecution();
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* set amount of parallel tasks
|
* set amount of parallel tasks
|
||||||
* be careful, you might loose dependability of tasks
|
* be careful, you might lose dependability of tasks
|
||||||
*/
|
*/
|
||||||
public setMaxParallelJobs(maxParrallelJobsArg: number) {
|
public setMaxParallelJobs(maxParallelJobsArg: number) {
|
||||||
this.maxParrallelJobs = maxParrallelJobsArg;
|
this.maxParallelJobs = maxParallelJobsArg;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -38,17 +40,21 @@ export class TaskRunner {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* checks wether execution is on point
|
* checks whether execution is on point
|
||||||
*/
|
*/
|
||||||
public async checkExecution() {
|
public async checkExecution() {
|
||||||
if (
|
if (
|
||||||
this.runningTasks.getArray().length < this.maxParrallelJobs &&
|
this.runningTasks.getArray().length < this.maxParallelJobs &&
|
||||||
this.status === 'running' &&
|
this.status === 'running' &&
|
||||||
this.qeuedTasks.length > 0
|
this.queuedTasks.length > 0
|
||||||
) {
|
) {
|
||||||
const nextJob = this.qeuedTasks.shift();
|
const nextJob = this.queuedTasks.shift();
|
||||||
this.runningTasks.add(nextJob);
|
this.runningTasks.add(nextJob);
|
||||||
|
try {
|
||||||
await nextJob.trigger();
|
await nextJob.trigger();
|
||||||
|
} catch (err) {
|
||||||
|
logger.log('error', `TaskRunner: task "${nextJob.name || 'unnamed'}" failed: ${err instanceof Error ? err.message : String(err)}`);
|
||||||
|
}
|
||||||
this.runningTasks.remove(nextJob);
|
this.runningTasks.remove(nextJob);
|
||||||
this.checkExecution();
|
this.checkExecution();
|
||||||
}
|
}
|
||||||
|
|||||||
57
ts/taskbuffer.classes.taskstep.ts
Normal file
57
ts/taskbuffer.classes.taskstep.ts
Normal file
@@ -0,0 +1,57 @@
|
|||||||
|
export interface ITaskStep {
|
||||||
|
name: string;
|
||||||
|
description: string;
|
||||||
|
percentage: number; // Weight of this step (0-100)
|
||||||
|
status: 'pending' | 'active' | 'completed';
|
||||||
|
startTime?: number;
|
||||||
|
endTime?: number;
|
||||||
|
duration?: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export class TaskStep implements ITaskStep {
|
||||||
|
public name: string;
|
||||||
|
public description: string;
|
||||||
|
public percentage: number;
|
||||||
|
public status: 'pending' | 'active' | 'completed' = 'pending';
|
||||||
|
public startTime?: number;
|
||||||
|
public endTime?: number;
|
||||||
|
public duration?: number;
|
||||||
|
|
||||||
|
constructor(config: { name: string; description: string; percentage: number }) {
|
||||||
|
this.name = config.name;
|
||||||
|
this.description = config.description;
|
||||||
|
this.percentage = config.percentage;
|
||||||
|
}
|
||||||
|
|
||||||
|
public start(): void {
|
||||||
|
this.status = 'active';
|
||||||
|
this.startTime = Date.now();
|
||||||
|
}
|
||||||
|
|
||||||
|
public complete(): void {
|
||||||
|
if (this.startTime) {
|
||||||
|
this.endTime = Date.now();
|
||||||
|
this.duration = this.endTime - this.startTime;
|
||||||
|
}
|
||||||
|
this.status = 'completed';
|
||||||
|
}
|
||||||
|
|
||||||
|
public reset(): void {
|
||||||
|
this.status = 'pending';
|
||||||
|
this.startTime = undefined;
|
||||||
|
this.endTime = undefined;
|
||||||
|
this.duration = undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
public toJSON(): ITaskStep {
|
||||||
|
return {
|
||||||
|
name: this.name,
|
||||||
|
description: this.description,
|
||||||
|
percentage: this.percentage,
|
||||||
|
status: this.status,
|
||||||
|
startTime: this.startTime,
|
||||||
|
endTime: this.endTime,
|
||||||
|
duration: this.duration,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}
|
||||||
52
ts/taskbuffer.interfaces.ts
Normal file
52
ts/taskbuffer.interfaces.ts
Normal file
@@ -0,0 +1,52 @@
|
|||||||
|
import type { ITaskStep } from './taskbuffer.classes.taskstep.js';
|
||||||
|
|
||||||
|
export interface ITaskMetadata {
|
||||||
|
name: string;
|
||||||
|
version?: string;
|
||||||
|
status: 'idle' | 'running' | 'completed' | 'failed';
|
||||||
|
steps: ITaskStep[];
|
||||||
|
currentStep?: string;
|
||||||
|
currentProgress: number; // 0-100
|
||||||
|
lastRun?: Date;
|
||||||
|
nextRun?: Date; // For scheduled tasks
|
||||||
|
runCount: number;
|
||||||
|
averageDuration?: number;
|
||||||
|
cronSchedule?: string;
|
||||||
|
buffered?: boolean;
|
||||||
|
bufferMax?: number;
|
||||||
|
timeout?: number;
|
||||||
|
lastError?: string;
|
||||||
|
errorCount?: number;
|
||||||
|
labels?: Record<string, string>;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ITaskExecutionReport {
|
||||||
|
taskName: string;
|
||||||
|
startTime: number;
|
||||||
|
endTime: number;
|
||||||
|
duration: number;
|
||||||
|
steps: ITaskStep[];
|
||||||
|
stepsCompleted: string[];
|
||||||
|
progress: number;
|
||||||
|
result?: any;
|
||||||
|
error?: Error;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface IScheduledTaskInfo {
|
||||||
|
name: string;
|
||||||
|
schedule: string;
|
||||||
|
nextRun: Date;
|
||||||
|
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'
|
||||||
|
}
|
||||||
@@ -1,9 +1,17 @@
|
|||||||
import * as isounique from '@push.rocks/isounique';
|
|
||||||
import * as lik from '@push.rocks/lik';
|
import * as lik from '@push.rocks/lik';
|
||||||
import * as smartlog from '@push.rocks/smartlog';
|
import * as smartlog from '@push.rocks/smartlog';
|
||||||
import * as smartpromise from '@push.rocks/smartpromise';
|
import * as smartpromise from '@push.rocks/smartpromise';
|
||||||
import * as smartdelay from '@push.rocks/smartdelay';
|
import * as smartdelay from '@push.rocks/smartdelay';
|
||||||
import * as smartrx from '@push.rocks/smartrx';
|
import * as smartrx from '@push.rocks/smartrx';
|
||||||
import * as smarttime from '@push.rocks/smarttime';
|
import * as smarttime from '@push.rocks/smarttime';
|
||||||
|
import * as smartunique from '@push.rocks/smartunique';
|
||||||
|
|
||||||
export { isounique, lik, smartlog, smartpromise, smartdelay, smartrx, smarttime };
|
export {
|
||||||
|
lik,
|
||||||
|
smartlog,
|
||||||
|
smartpromise,
|
||||||
|
smartdelay,
|
||||||
|
smartrx,
|
||||||
|
smarttime,
|
||||||
|
smartunique,
|
||||||
|
};
|
||||||
|
|||||||
8
ts_web/00_commitinfo_data.ts
Normal file
8
ts_web/00_commitinfo_data.ts
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
/**
|
||||||
|
* autocreated commitinfo by @push.rocks/commitinfo
|
||||||
|
*/
|
||||||
|
export const commitinfo = {
|
||||||
|
name: '@push.rocks/taskbuffer',
|
||||||
|
version: '4.1.1',
|
||||||
|
description: 'A flexible task management library supporting TypeScript, allowing for task buffering, scheduling, and execution with dependency management.'
|
||||||
|
}
|
||||||
311
ts_web/elements/taskbuffer-dashboard.demo.ts
Normal file
311
ts_web/elements/taskbuffer-dashboard.demo.ts
Normal file
@@ -0,0 +1,311 @@
|
|||||||
|
import { html, css, cssManager } from '@design.estate/dees-element';
|
||||||
|
import { TaskManager, Task } from '../../ts/index.js';
|
||||||
|
import '../taskbuffer-dashboard.js';
|
||||||
|
|
||||||
|
export const demoFunc = () => html`
|
||||||
|
<style>
|
||||||
|
${css`
|
||||||
|
.demoWrapper {
|
||||||
|
box-sizing: border-box;
|
||||||
|
position: relative;
|
||||||
|
width: 100%;
|
||||||
|
min-height: 100vh;
|
||||||
|
padding: 48px;
|
||||||
|
background: ${cssManager.bdTheme('#f8f9fa', '#0a0a0a')};
|
||||||
|
}
|
||||||
|
|
||||||
|
h1 {
|
||||||
|
font-size: 32px;
|
||||||
|
font-weight: 700;
|
||||||
|
color: ${cssManager.bdTheme('#09090b', '#fafafa')};
|
||||||
|
margin-bottom: 12px;
|
||||||
|
text-align: center;
|
||||||
|
}
|
||||||
|
|
||||||
|
p {
|
||||||
|
font-size: 16px;
|
||||||
|
color: ${cssManager.bdTheme('#71717a', '#a1a1aa')};
|
||||||
|
text-align: center;
|
||||||
|
margin-bottom: 48px;
|
||||||
|
}
|
||||||
|
`}
|
||||||
|
</style>
|
||||||
|
|
||||||
|
<div class="demoWrapper">
|
||||||
|
<h1>TaskBuffer Dashboard Demo</h1>
|
||||||
|
<p>Real-time visualization of task execution, progress tracking, and scheduling</p>
|
||||||
|
|
||||||
|
<dees-demowrapper
|
||||||
|
.title=${'Live Dashboard'}
|
||||||
|
.subtitle=${'Interactive task management dashboard with real-time updates'}
|
||||||
|
.runAfterRender=${async (element) => {
|
||||||
|
// Create TaskManager instance
|
||||||
|
const taskManager = new TaskManager();
|
||||||
|
|
||||||
|
// Get dashboard element
|
||||||
|
const dashboard = element.querySelector('taskbuffer-dashboard');
|
||||||
|
dashboard.taskManager = taskManager;
|
||||||
|
dashboard.refreshInterval = 500;
|
||||||
|
|
||||||
|
// Task counter for unique names
|
||||||
|
let taskCounter = 0;
|
||||||
|
|
||||||
|
// Helper to create random delay
|
||||||
|
const randomDelay = () => new Promise(resolve =>
|
||||||
|
setTimeout(resolve, Math.random() * 2000 + 500)
|
||||||
|
);
|
||||||
|
|
||||||
|
// Add initial demo tasks
|
||||||
|
const addDemoTasks = () => {
|
||||||
|
// Add simple task
|
||||||
|
const simpleTask = new Task({
|
||||||
|
name: `SimpleTask_${++taskCounter}`,
|
||||||
|
taskFunction: async () => {
|
||||||
|
console.log(`Executing SimpleTask_${taskCounter}`);
|
||||||
|
await randomDelay();
|
||||||
|
return `Result from SimpleTask_${taskCounter}`;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
taskManager.addTask(simpleTask);
|
||||||
|
|
||||||
|
// Add task with steps
|
||||||
|
const steppedTask = new Task({
|
||||||
|
name: `SteppedTask_${++taskCounter}`,
|
||||||
|
steps: [
|
||||||
|
{ name: 'init', description: 'Initializing', percentage: 20 },
|
||||||
|
{ name: 'fetch', description: 'Fetching data', percentage: 30 },
|
||||||
|
{ name: 'process', description: 'Processing', percentage: 35 },
|
||||||
|
{ name: 'save', description: 'Saving results', percentage: 15 }
|
||||||
|
],
|
||||||
|
taskFunction: async function() {
|
||||||
|
this.notifyStep('init');
|
||||||
|
await randomDelay();
|
||||||
|
this.notifyStep('fetch');
|
||||||
|
await randomDelay();
|
||||||
|
this.notifyStep('process');
|
||||||
|
await randomDelay();
|
||||||
|
this.notifyStep('save');
|
||||||
|
await randomDelay();
|
||||||
|
return `Completed SteppedTask_${taskCounter}`;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
taskManager.addTask(steppedTask);
|
||||||
|
|
||||||
|
// Add buffered task
|
||||||
|
const bufferedTask = new Task({
|
||||||
|
name: `BufferedTask_${++taskCounter}`,
|
||||||
|
buffered: true,
|
||||||
|
bufferMax: 3,
|
||||||
|
steps: [
|
||||||
|
{ name: 'buffer', description: 'Processing buffered item', percentage: 100 }
|
||||||
|
],
|
||||||
|
taskFunction: async function(item) {
|
||||||
|
this.notifyStep('buffer');
|
||||||
|
console.log(`Processing buffered item: ${item}`);
|
||||||
|
await randomDelay();
|
||||||
|
return `Buffered task ${taskCounter} processed: ${item}`;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
taskManager.addTask(bufferedTask);
|
||||||
|
};
|
||||||
|
|
||||||
|
// Add initial tasks
|
||||||
|
addDemoTasks();
|
||||||
|
|
||||||
|
// Automatically trigger some tasks
|
||||||
|
setTimeout(() => {
|
||||||
|
const tasks = taskManager.getAllTasksMetadata();
|
||||||
|
tasks.forEach(taskMeta => {
|
||||||
|
const task = taskManager.getTaskByName(taskMeta.name);
|
||||||
|
if (task && !taskMeta.name.includes('Scheduled')) {
|
||||||
|
if (taskMeta.buffered) {
|
||||||
|
// Trigger buffered task multiple times
|
||||||
|
for (let i = 0; i < 5; i++) {
|
||||||
|
task.trigger(`Data_${i}`);
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
task.trigger();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}, 2000);
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
<taskbuffer-dashboard></taskbuffer-dashboard>
|
||||||
|
</dees-demowrapper>
|
||||||
|
|
||||||
|
<dees-demowrapper
|
||||||
|
.title=${'Scheduled Tasks'}
|
||||||
|
.subtitle=${'Tasks scheduled with cron expressions'}
|
||||||
|
.runAfterRender=${async (element) => {
|
||||||
|
// Create TaskManager instance
|
||||||
|
const taskManager = new TaskManager();
|
||||||
|
|
||||||
|
// Get dashboard element
|
||||||
|
const dashboard = element.querySelector('taskbuffer-dashboard');
|
||||||
|
dashboard.taskManager = taskManager;
|
||||||
|
dashboard.refreshInterval = 1000;
|
||||||
|
|
||||||
|
// Add scheduled tasks
|
||||||
|
const scheduledTask1 = new Task({
|
||||||
|
name: 'HourlyBackup',
|
||||||
|
steps: [
|
||||||
|
{ name: 'prepare', description: 'Preparing backup', percentage: 30 },
|
||||||
|
{ name: 'backup', description: 'Creating backup', percentage: 50 },
|
||||||
|
{ name: 'verify', description: 'Verifying backup', percentage: 20 }
|
||||||
|
],
|
||||||
|
taskFunction: async function() {
|
||||||
|
this.notifyStep('prepare');
|
||||||
|
await new Promise(resolve => setTimeout(resolve, 1000));
|
||||||
|
this.notifyStep('backup');
|
||||||
|
await new Promise(resolve => setTimeout(resolve, 2000));
|
||||||
|
this.notifyStep('verify');
|
||||||
|
await new Promise(resolve => setTimeout(resolve, 500));
|
||||||
|
return 'Backup completed';
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
const scheduledTask2 = new Task({
|
||||||
|
name: 'DailyReport',
|
||||||
|
steps: [
|
||||||
|
{ name: 'collect', description: 'Collecting data', percentage: 40 },
|
||||||
|
{ name: 'analyze', description: 'Analyzing data', percentage: 40 },
|
||||||
|
{ name: 'send', description: 'Sending report', percentage: 20 }
|
||||||
|
],
|
||||||
|
taskFunction: async function() {
|
||||||
|
this.notifyStep('collect');
|
||||||
|
await new Promise(resolve => setTimeout(resolve, 1500));
|
||||||
|
this.notifyStep('analyze');
|
||||||
|
await new Promise(resolve => setTimeout(resolve, 1500));
|
||||||
|
this.notifyStep('send');
|
||||||
|
await new Promise(resolve => setTimeout(resolve, 500));
|
||||||
|
return 'Report sent';
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// Schedule tasks
|
||||||
|
taskManager.addAndScheduleTask(scheduledTask1, '0 * * * *'); // Every hour
|
||||||
|
taskManager.addAndScheduleTask(scheduledTask2, '0 0 * * *'); // Daily at midnight
|
||||||
|
|
||||||
|
// Also add them as regular tasks for demo
|
||||||
|
const demoTask = new Task({
|
||||||
|
name: 'DemoScheduledExecution',
|
||||||
|
steps: [
|
||||||
|
{ name: 'execute', description: 'Simulating scheduled execution', percentage: 100 }
|
||||||
|
],
|
||||||
|
taskFunction: async function() {
|
||||||
|
this.notifyStep('execute');
|
||||||
|
await new Promise(resolve => setTimeout(resolve, 1000));
|
||||||
|
|
||||||
|
// Trigger scheduled tasks for demo
|
||||||
|
scheduledTask1.trigger();
|
||||||
|
scheduledTask2.trigger();
|
||||||
|
|
||||||
|
return 'Triggered scheduled tasks for demo';
|
||||||
|
}
|
||||||
|
});
|
||||||
|
taskManager.addTask(demoTask);
|
||||||
|
|
||||||
|
// Trigger demo after 2 seconds
|
||||||
|
setTimeout(() => {
|
||||||
|
demoTask.trigger();
|
||||||
|
}, 2000);
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
<taskbuffer-dashboard></taskbuffer-dashboard>
|
||||||
|
</dees-demowrapper>
|
||||||
|
|
||||||
|
<dees-demowrapper
|
||||||
|
.title=${'Task Execution Control'}
|
||||||
|
.subtitle=${'Interactive controls for task management'}
|
||||||
|
.runAfterRender=${async (element) => {
|
||||||
|
// Create TaskManager instance
|
||||||
|
const taskManager = new TaskManager();
|
||||||
|
|
||||||
|
// Get dashboard element
|
||||||
|
const dashboard = element.querySelector('taskbuffer-dashboard');
|
||||||
|
dashboard.taskManager = taskManager;
|
||||||
|
dashboard.refreshInterval = 300;
|
||||||
|
|
||||||
|
// Add control buttons
|
||||||
|
const controlsDiv = document.createElement('div');
|
||||||
|
controlsDiv.style.cssText = `
|
||||||
|
display: flex;
|
||||||
|
gap: 8px;
|
||||||
|
margin-bottom: 16px;
|
||||||
|
flex-wrap: wrap;
|
||||||
|
`;
|
||||||
|
|
||||||
|
const createButton = (text, onClick, style = '') => {
|
||||||
|
const button = document.createElement('button');
|
||||||
|
button.textContent = text;
|
||||||
|
button.style.cssText = `
|
||||||
|
padding: 8px 16px;
|
||||||
|
border: none;
|
||||||
|
border-radius: 6px;
|
||||||
|
cursor: pointer;
|
||||||
|
font-size: 14px;
|
||||||
|
transition: all 0.2s;
|
||||||
|
${style}
|
||||||
|
`;
|
||||||
|
button.onclick = onClick;
|
||||||
|
return button;
|
||||||
|
};
|
||||||
|
|
||||||
|
let taskCounter = 0;
|
||||||
|
|
||||||
|
// Add task button
|
||||||
|
controlsDiv.appendChild(createButton('Add Task', () => {
|
||||||
|
const task = new Task({
|
||||||
|
name: `Task_${++taskCounter}`,
|
||||||
|
steps: [
|
||||||
|
{ name: 'step1', description: 'Step 1', percentage: 33 },
|
||||||
|
{ name: 'step2', description: 'Step 2', percentage: 33 },
|
||||||
|
{ name: 'step3', description: 'Step 3', percentage: 34 }
|
||||||
|
],
|
||||||
|
taskFunction: async function() {
|
||||||
|
for (const step of ['step1', 'step2', 'step3']) {
|
||||||
|
this.notifyStep(step);
|
||||||
|
await new Promise(resolve => setTimeout(resolve, 1000));
|
||||||
|
}
|
||||||
|
return `Task_${taskCounter} completed`;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
taskManager.addTask(task);
|
||||||
|
}, 'background: #3b82f6; color: white;'));
|
||||||
|
|
||||||
|
// Trigger all button
|
||||||
|
controlsDiv.appendChild(createButton('Trigger All', () => {
|
||||||
|
const tasks = taskManager.getAllTasksMetadata();
|
||||||
|
tasks.forEach(taskMeta => {
|
||||||
|
const task = taskManager.getTaskByName(taskMeta.name);
|
||||||
|
if (task) {
|
||||||
|
task.trigger();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}, 'background: #22c55e; color: white;'));
|
||||||
|
|
||||||
|
// Clear all button
|
||||||
|
controlsDiv.appendChild(createButton('Clear All', () => {
|
||||||
|
const tasks = taskManager.getAllTasksMetadata();
|
||||||
|
tasks.forEach(taskMeta => {
|
||||||
|
const task = taskManager.getTaskByName(taskMeta.name);
|
||||||
|
if (task) {
|
||||||
|
taskManager.taskMap.remove(task);
|
||||||
|
taskManager.descheduleTaskByName(taskMeta.name);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}, 'background: #ef4444; color: white;'));
|
||||||
|
|
||||||
|
element.insertBefore(controlsDiv, dashboard);
|
||||||
|
|
||||||
|
// Add some initial tasks
|
||||||
|
for (let i = 0; i < 3; i++) {
|
||||||
|
controlsDiv.querySelector('button').click();
|
||||||
|
}
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
<taskbuffer-dashboard></taskbuffer-dashboard>
|
||||||
|
</dees-demowrapper>
|
||||||
|
</div>
|
||||||
|
`;
|
||||||
12
ts_web/index.ts
Normal file
12
ts_web/index.ts
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
// Export web components
|
||||||
|
export * from './taskbuffer-dashboard.js';
|
||||||
|
|
||||||
|
// Export types from main module for web usage
|
||||||
|
export type {
|
||||||
|
TaskManager,
|
||||||
|
Task,
|
||||||
|
ITaskMetadata,
|
||||||
|
ITaskExecutionReport,
|
||||||
|
IScheduledTaskInfo,
|
||||||
|
ITaskStep
|
||||||
|
} from '../ts/index.js';
|
||||||
541
ts_web/taskbuffer-dashboard.ts
Normal file
541
ts_web/taskbuffer-dashboard.ts
Normal file
@@ -0,0 +1,541 @@
|
|||||||
|
import { DeesElement, customElement, html, css, property, state, cssManager } from '@design.estate/dees-element';
|
||||||
|
import type { TaskManager, ITaskMetadata, IScheduledTaskInfo } from '../ts/index.js';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A web component that displays TaskManager tasks with progress visualization
|
||||||
|
*/
|
||||||
|
@customElement('taskbuffer-dashboard')
|
||||||
|
export class TaskbufferDashboard extends DeesElement {
|
||||||
|
// Properties
|
||||||
|
@property({ type: Object })
|
||||||
|
public taskManager: TaskManager | null = null;
|
||||||
|
|
||||||
|
@property({ type: Number })
|
||||||
|
public refreshInterval: number = 1000; // milliseconds
|
||||||
|
|
||||||
|
// Internal state
|
||||||
|
@state()
|
||||||
|
private tasks: ITaskMetadata[] = [];
|
||||||
|
|
||||||
|
@state()
|
||||||
|
private scheduledTasks: IScheduledTaskInfo[] = [];
|
||||||
|
|
||||||
|
@state()
|
||||||
|
private isRunning: boolean = false;
|
||||||
|
|
||||||
|
private refreshTimer: any;
|
||||||
|
|
||||||
|
// Styles
|
||||||
|
static styles = [
|
||||||
|
cssManager.defaultStyles,
|
||||||
|
css`
|
||||||
|
:host {
|
||||||
|
display: block;
|
||||||
|
font-family: 'Inter', -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif;
|
||||||
|
}
|
||||||
|
|
||||||
|
.dashboard-container {
|
||||||
|
padding: 24px;
|
||||||
|
background: ${cssManager.bdTheme('#ffffff', '#0a0a0a')};
|
||||||
|
min-height: 100vh;
|
||||||
|
}
|
||||||
|
|
||||||
|
.dashboard-header {
|
||||||
|
margin-bottom: 32px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.dashboard-title {
|
||||||
|
font-size: 28px;
|
||||||
|
font-weight: 700;
|
||||||
|
color: ${cssManager.bdTheme('#09090b', '#fafafa')};
|
||||||
|
margin-bottom: 8px;
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 12px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.status-indicator {
|
||||||
|
width: 12px;
|
||||||
|
height: 12px;
|
||||||
|
border-radius: 50%;
|
||||||
|
background: ${cssManager.bdTheme('#22c55e', '#22c55e')};
|
||||||
|
animation: pulse 2s infinite;
|
||||||
|
}
|
||||||
|
|
||||||
|
.status-indicator.inactive {
|
||||||
|
background: ${cssManager.bdTheme('#94a3b8', '#475569')};
|
||||||
|
animation: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
@keyframes pulse {
|
||||||
|
0%, 100% {
|
||||||
|
opacity: 1;
|
||||||
|
}
|
||||||
|
50% {
|
||||||
|
opacity: 0.5;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.dashboard-subtitle {
|
||||||
|
font-size: 14px;
|
||||||
|
color: ${cssManager.bdTheme('#71717a', '#a1a1aa')};
|
||||||
|
}
|
||||||
|
|
||||||
|
.tasks-section {
|
||||||
|
margin-bottom: 48px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.section-title {
|
||||||
|
font-size: 20px;
|
||||||
|
font-weight: 600;
|
||||||
|
color: ${cssManager.bdTheme('#18181b', '#e4e4e7')};
|
||||||
|
margin-bottom: 16px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.tasks-grid {
|
||||||
|
display: grid;
|
||||||
|
grid-template-columns: repeat(auto-fill, minmax(350px, 1fr));
|
||||||
|
gap: 16px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.task-card {
|
||||||
|
background: ${cssManager.bdTheme('#f8fafc', '#18181b')};
|
||||||
|
border: 1px solid ${cssManager.bdTheme('#e2e8f0', '#27272a')};
|
||||||
|
border-radius: 12px;
|
||||||
|
padding: 20px;
|
||||||
|
transition: all 0.2s ease;
|
||||||
|
}
|
||||||
|
|
||||||
|
.task-card:hover {
|
||||||
|
transform: translateY(-2px);
|
||||||
|
box-shadow: 0 4px 12px ${cssManager.bdTheme('rgba(0,0,0,0.1)', 'rgba(0,0,0,0.3)')};
|
||||||
|
}
|
||||||
|
|
||||||
|
.task-header {
|
||||||
|
display: flex;
|
||||||
|
justify-content: space-between;
|
||||||
|
align-items: flex-start;
|
||||||
|
margin-bottom: 12px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.task-name {
|
||||||
|
font-size: 16px;
|
||||||
|
font-weight: 600;
|
||||||
|
color: ${cssManager.bdTheme('#0f172a', '#f1f5f9')};
|
||||||
|
}
|
||||||
|
|
||||||
|
.task-status {
|
||||||
|
display: inline-block;
|
||||||
|
padding: 4px 8px;
|
||||||
|
border-radius: 6px;
|
||||||
|
font-size: 11px;
|
||||||
|
font-weight: 600;
|
||||||
|
text-transform: uppercase;
|
||||||
|
letter-spacing: 0.5px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.task-status.idle {
|
||||||
|
background: ${cssManager.bdTheme('#f1f5f9', '#27272a')};
|
||||||
|
color: ${cssManager.bdTheme('#64748b', '#94a3b8')};
|
||||||
|
}
|
||||||
|
|
||||||
|
.task-status.running {
|
||||||
|
background: ${cssManager.bdTheme('#dbeafe', '#1e3a8a')};
|
||||||
|
color: ${cssManager.bdTheme('#1e40af', '#93c5fd')};
|
||||||
|
}
|
||||||
|
|
||||||
|
.task-status.completed {
|
||||||
|
background: ${cssManager.bdTheme('#dcfce7', '#14532d')};
|
||||||
|
color: ${cssManager.bdTheme('#15803d', '#86efac')};
|
||||||
|
}
|
||||||
|
|
||||||
|
.task-status.failed {
|
||||||
|
background: ${cssManager.bdTheme('#fee2e2', '#7f1d1d')};
|
||||||
|
color: ${cssManager.bdTheme('#dc2626', '#fca5a5')};
|
||||||
|
}
|
||||||
|
|
||||||
|
.task-info {
|
||||||
|
display: flex;
|
||||||
|
gap: 16px;
|
||||||
|
margin-bottom: 16px;
|
||||||
|
font-size: 13px;
|
||||||
|
color: ${cssManager.bdTheme('#64748b', '#94a3b8')};
|
||||||
|
}
|
||||||
|
|
||||||
|
.task-info-item {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 4px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.task-info-icon {
|
||||||
|
width: 14px;
|
||||||
|
height: 14px;
|
||||||
|
opacity: 0.7;
|
||||||
|
}
|
||||||
|
|
||||||
|
.progress-container {
|
||||||
|
margin-bottom: 16px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.progress-label {
|
||||||
|
display: flex;
|
||||||
|
justify-content: space-between;
|
||||||
|
margin-bottom: 8px;
|
||||||
|
font-size: 13px;
|
||||||
|
color: ${cssManager.bdTheme('#475569', '#cbd5e1')};
|
||||||
|
}
|
||||||
|
|
||||||
|
.progress-bar {
|
||||||
|
height: 8px;
|
||||||
|
background: ${cssManager.bdTheme('#e2e8f0', '#27272a')};
|
||||||
|
border-radius: 4px;
|
||||||
|
overflow: hidden;
|
||||||
|
position: relative;
|
||||||
|
}
|
||||||
|
|
||||||
|
.progress-fill {
|
||||||
|
height: 100%;
|
||||||
|
background: linear-gradient(90deg, #3b82f6, #6366f1);
|
||||||
|
border-radius: 4px;
|
||||||
|
transition: width 0.3s ease;
|
||||||
|
position: relative;
|
||||||
|
overflow: hidden;
|
||||||
|
}
|
||||||
|
|
||||||
|
.progress-fill::after {
|
||||||
|
content: '';
|
||||||
|
position: absolute;
|
||||||
|
top: 0;
|
||||||
|
left: 0;
|
||||||
|
right: 0;
|
||||||
|
bottom: 0;
|
||||||
|
background: linear-gradient(
|
||||||
|
90deg,
|
||||||
|
transparent,
|
||||||
|
rgba(255, 255, 255, 0.3),
|
||||||
|
transparent
|
||||||
|
);
|
||||||
|
animation: shimmer 2s infinite;
|
||||||
|
}
|
||||||
|
|
||||||
|
@keyframes shimmer {
|
||||||
|
0% {
|
||||||
|
transform: translateX(-100%);
|
||||||
|
}
|
||||||
|
100% {
|
||||||
|
transform: translateX(100%);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.steps-container {
|
||||||
|
border-top: 1px solid ${cssManager.bdTheme('#e2e8f0', '#27272a')};
|
||||||
|
padding-top: 12px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.steps-title {
|
||||||
|
font-size: 12px;
|
||||||
|
font-weight: 600;
|
||||||
|
color: ${cssManager.bdTheme('#64748b', '#94a3b8')};
|
||||||
|
margin-bottom: 8px;
|
||||||
|
text-transform: uppercase;
|
||||||
|
letter-spacing: 0.5px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.step-item {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 8px;
|
||||||
|
padding: 6px 0;
|
||||||
|
font-size: 13px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.step-indicator {
|
||||||
|
width: 20px;
|
||||||
|
height: 20px;
|
||||||
|
border-radius: 50%;
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
justify-content: center;
|
||||||
|
font-size: 10px;
|
||||||
|
font-weight: 600;
|
||||||
|
flex-shrink: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.step-indicator.pending {
|
||||||
|
background: ${cssManager.bdTheme('#f1f5f9', '#27272a')};
|
||||||
|
color: ${cssManager.bdTheme('#94a3b8', '#64748b')};
|
||||||
|
border: 2px solid ${cssManager.bdTheme('#cbd5e1', '#3f3f46')};
|
||||||
|
}
|
||||||
|
|
||||||
|
.step-indicator.active {
|
||||||
|
background: linear-gradient(135deg, #3b82f6, #6366f1);
|
||||||
|
color: white;
|
||||||
|
animation: pulse 1.5s infinite;
|
||||||
|
}
|
||||||
|
|
||||||
|
.step-indicator.completed {
|
||||||
|
background: ${cssManager.bdTheme('#22c55e', '#22c55e')};
|
||||||
|
color: white;
|
||||||
|
}
|
||||||
|
|
||||||
|
.step-details {
|
||||||
|
flex: 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
.step-name {
|
||||||
|
font-weight: 500;
|
||||||
|
color: ${cssManager.bdTheme('#1e293b', '#e2e8f0')};
|
||||||
|
}
|
||||||
|
|
||||||
|
.step-description {
|
||||||
|
font-size: 11px;
|
||||||
|
color: ${cssManager.bdTheme('#64748b', '#94a3b8')};
|
||||||
|
margin-top: 2px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.step-percentage {
|
||||||
|
font-size: 11px;
|
||||||
|
font-weight: 600;
|
||||||
|
color: ${cssManager.bdTheme('#94a3b8', '#64748b')};
|
||||||
|
}
|
||||||
|
|
||||||
|
.empty-state {
|
||||||
|
text-align: center;
|
||||||
|
padding: 48px;
|
||||||
|
color: ${cssManager.bdTheme('#94a3b8', '#64748b')};
|
||||||
|
}
|
||||||
|
|
||||||
|
.empty-state-icon {
|
||||||
|
width: 64px;
|
||||||
|
height: 64px;
|
||||||
|
margin: 0 auto 16px;
|
||||||
|
opacity: 0.3;
|
||||||
|
}
|
||||||
|
|
||||||
|
.empty-state-text {
|
||||||
|
font-size: 16px;
|
||||||
|
margin-bottom: 8px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.empty-state-subtext {
|
||||||
|
font-size: 14px;
|
||||||
|
color: ${cssManager.bdTheme('#cbd5e1', '#475569')};
|
||||||
|
}
|
||||||
|
|
||||||
|
.scheduled-section {
|
||||||
|
margin-top: 32px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.schedule-info {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 8px;
|
||||||
|
margin-top: 8px;
|
||||||
|
font-size: 12px;
|
||||||
|
color: ${cssManager.bdTheme('#64748b', '#94a3b8')};
|
||||||
|
}
|
||||||
|
|
||||||
|
.schedule-icon {
|
||||||
|
width: 14px;
|
||||||
|
height: 14px;
|
||||||
|
}
|
||||||
|
`,
|
||||||
|
];
|
||||||
|
|
||||||
|
// Lifecycle
|
||||||
|
async connectedCallback() {
|
||||||
|
await super.connectedCallback();
|
||||||
|
this.startRefreshing();
|
||||||
|
}
|
||||||
|
|
||||||
|
async disconnectedCallback() {
|
||||||
|
await super.disconnectedCallback();
|
||||||
|
this.stopRefreshing();
|
||||||
|
}
|
||||||
|
|
||||||
|
// Methods
|
||||||
|
private startRefreshing() {
|
||||||
|
if (this.refreshTimer) {
|
||||||
|
clearInterval(this.refreshTimer);
|
||||||
|
}
|
||||||
|
|
||||||
|
this.updateData();
|
||||||
|
this.refreshTimer = setInterval(() => {
|
||||||
|
this.updateData();
|
||||||
|
}, this.refreshInterval);
|
||||||
|
this.isRunning = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
private stopRefreshing() {
|
||||||
|
if (this.refreshTimer) {
|
||||||
|
clearInterval(this.refreshTimer);
|
||||||
|
this.refreshTimer = null;
|
||||||
|
}
|
||||||
|
this.isRunning = false;
|
||||||
|
}
|
||||||
|
|
||||||
|
private updateData() {
|
||||||
|
if (!this.taskManager) {
|
||||||
|
this.tasks = [];
|
||||||
|
this.scheduledTasks = [];
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
this.tasks = this.taskManager.getAllTasksMetadata();
|
||||||
|
this.scheduledTasks = this.taskManager.getScheduledTasks();
|
||||||
|
}
|
||||||
|
|
||||||
|
private formatNextRun(date: Date): string {
|
||||||
|
const now = new Date();
|
||||||
|
const diff = date.getTime() - now.getTime();
|
||||||
|
|
||||||
|
if (diff < 0) return 'Past due';
|
||||||
|
if (diff < 60000) return 'Less than a minute';
|
||||||
|
if (diff < 3600000) return `${Math.floor(diff / 60000)} minutes`;
|
||||||
|
if (diff < 86400000) return `${Math.floor(diff / 3600000)} hours`;
|
||||||
|
return `${Math.floor(diff / 86400000)} days`;
|
||||||
|
}
|
||||||
|
|
||||||
|
private formatDuration(ms?: number): string {
|
||||||
|
if (!ms) return '-';
|
||||||
|
if (ms < 1000) return `${ms}ms`;
|
||||||
|
if (ms < 60000) return `${(ms / 1000).toFixed(1)}s`;
|
||||||
|
return `${(ms / 60000).toFixed(1)}m`;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Render
|
||||||
|
render() {
|
||||||
|
return html`
|
||||||
|
<div class="dashboard-container">
|
||||||
|
<div class="dashboard-header">
|
||||||
|
<div class="dashboard-title">
|
||||||
|
<span>TaskBuffer Dashboard</span>
|
||||||
|
<span class="status-indicator ${this.isRunning ? '' : 'inactive'}"></span>
|
||||||
|
</div>
|
||||||
|
<div class="dashboard-subtitle">
|
||||||
|
${this.tasks.length} task${this.tasks.length !== 1 ? 's' : ''} registered
|
||||||
|
${this.scheduledTasks.length > 0 ? ` • ${this.scheduledTasks.length} scheduled` : ''}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="tasks-section">
|
||||||
|
<h2 class="section-title">Active Tasks</h2>
|
||||||
|
|
||||||
|
${this.tasks.length > 0 ? html`
|
||||||
|
<div class="tasks-grid">
|
||||||
|
${this.tasks.map(task => this.renderTaskCard(task))}
|
||||||
|
</div>
|
||||||
|
` : html`
|
||||||
|
<div class="empty-state">
|
||||||
|
<svg class="empty-state-icon" fill="none" stroke="currentColor" viewBox="0 0 24 24">
|
||||||
|
<path stroke-linecap="round" stroke-linejoin="round" stroke-width="2"
|
||||||
|
d="M9 5H7a2 2 0 00-2 2v12a2 2 0 002 2h10a2 2 0 002-2V7a2 2 0 00-2-2h-2M9 5a2 2 0 002 2h2a2 2 0 002-2M9 5a2 2 0 012-2h2a2 2 0 012 2" />
|
||||||
|
</svg>
|
||||||
|
<div class="empty-state-text">No tasks registered</div>
|
||||||
|
<div class="empty-state-subtext">Tasks will appear here when added to the TaskManager</div>
|
||||||
|
</div>
|
||||||
|
`}
|
||||||
|
</div>
|
||||||
|
|
||||||
|
${this.scheduledTasks.length > 0 ? html`
|
||||||
|
<div class="scheduled-section">
|
||||||
|
<h2 class="section-title">Scheduled Tasks</h2>
|
||||||
|
<div class="tasks-grid">
|
||||||
|
${this.scheduledTasks.map(task => this.renderScheduledTaskCard(task))}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
` : ''}
|
||||||
|
</div>
|
||||||
|
`;
|
||||||
|
}
|
||||||
|
|
||||||
|
private renderTaskCard(task: ITaskMetadata) {
|
||||||
|
return html`
|
||||||
|
<div class="task-card">
|
||||||
|
<div class="task-header">
|
||||||
|
<div class="task-name">${task.name || 'Unnamed Task'}</div>
|
||||||
|
<div class="task-status ${task.status}">${task.status}</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="task-info">
|
||||||
|
<div class="task-info-item">
|
||||||
|
<svg class="task-info-icon" fill="none" stroke="currentColor" viewBox="0 0 24 24">
|
||||||
|
<path stroke-linecap="round" stroke-linejoin="round" stroke-width="2"
|
||||||
|
d="M13 10V3L4 14h7v7l9-11h-7z" />
|
||||||
|
</svg>
|
||||||
|
<span>Run ${task.runCount || 0} times</span>
|
||||||
|
</div>
|
||||||
|
${task.buffered ? html`
|
||||||
|
<div class="task-info-item">
|
||||||
|
<svg class="task-info-icon" fill="none" stroke="currentColor" viewBox="0 0 24 24">
|
||||||
|
<path stroke-linecap="round" stroke-linejoin="round" stroke-width="2"
|
||||||
|
d="M19 11H5m14 0a2 2 0 012 2v6a2 2 0 01-2 2H5a2 2 0 01-2-2v-6a2 2 0 012-2m14 0V9a2 2 0 00-2-2M5 11V9a2 2 0 012-2m0 0V5a2 2 0 012-2h6a2 2 0 012 2v2M7 7h10" />
|
||||||
|
</svg>
|
||||||
|
<span>Buffer: ${task.bufferMax || 0}</span>
|
||||||
|
</div>
|
||||||
|
` : ''}
|
||||||
|
</div>
|
||||||
|
|
||||||
|
${task.steps && task.steps.length > 0 ? html`
|
||||||
|
<div class="progress-container">
|
||||||
|
<div class="progress-label">
|
||||||
|
<span>Progress</span>
|
||||||
|
<span>${task.currentProgress || 0}%</span>
|
||||||
|
</div>
|
||||||
|
<div class="progress-bar">
|
||||||
|
<div class="progress-fill" style="width: ${task.currentProgress || 0}%"></div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="steps-container">
|
||||||
|
<div class="steps-title">Steps</div>
|
||||||
|
${task.steps.map(step => html`
|
||||||
|
<div class="step-item">
|
||||||
|
<div class="step-indicator ${step.status}">
|
||||||
|
${step.status === 'completed' ? '✓' :
|
||||||
|
step.status === 'active' ? '•' :
|
||||||
|
''}
|
||||||
|
</div>
|
||||||
|
<div class="step-details">
|
||||||
|
<div class="step-name">${step.name}</div>
|
||||||
|
${step.description ? html`
|
||||||
|
<div class="step-description">${step.description}</div>
|
||||||
|
` : ''}
|
||||||
|
</div>
|
||||||
|
<div class="step-percentage">${step.percentage}%</div>
|
||||||
|
</div>
|
||||||
|
`)}
|
||||||
|
</div>
|
||||||
|
` : ''}
|
||||||
|
</div>
|
||||||
|
`;
|
||||||
|
}
|
||||||
|
|
||||||
|
private renderScheduledTaskCard(task: IScheduledTaskInfo) {
|
||||||
|
return html`
|
||||||
|
<div class="task-card">
|
||||||
|
<div class="task-header">
|
||||||
|
<div class="task-name">${task.name}</div>
|
||||||
|
<div class="task-status idle">scheduled</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="schedule-info">
|
||||||
|
<svg class="schedule-icon" fill="none" stroke="currentColor" viewBox="0 0 24 24">
|
||||||
|
<path stroke-linecap="round" stroke-linejoin="round" stroke-width="2"
|
||||||
|
d="M12 8v4l3 3m6-3a9 9 0 11-18 0 9 9 0 0118 0z" />
|
||||||
|
</svg>
|
||||||
|
<span>Next run: ${this.formatNextRun(task.nextRun)}</span>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="schedule-info">
|
||||||
|
<svg class="schedule-icon" fill="none" stroke="currentColor" viewBox="0 0 24 24">
|
||||||
|
<path stroke-linecap="round" stroke-linejoin="round" stroke-width="2"
|
||||||
|
d="M8 7V3m8 4V3m-9 8h10M5 21h14a2 2 0 002-2V7a2 2 0 00-2-2H5a2 2 0 00-2 2v12a2 2 0 002 2z" />
|
||||||
|
</svg>
|
||||||
|
<span>Schedule: ${task.schedule}</span>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
`;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -3,9 +3,12 @@
|
|||||||
"experimentalDecorators": true,
|
"experimentalDecorators": true,
|
||||||
"useDefineForClassFields": false,
|
"useDefineForClassFields": false,
|
||||||
"target": "ES2022",
|
"target": "ES2022",
|
||||||
"module": "ES2022",
|
"module": "NodeNext",
|
||||||
"moduleResolution": "nodenext",
|
"moduleResolution": "NodeNext",
|
||||||
"esModuleInterop": true,
|
"esModuleInterop": true,
|
||||||
"verbatimModuleSyntax": true,
|
"verbatimModuleSyntax": true,
|
||||||
}
|
"baseUrl": ".",
|
||||||
|
"paths": {}
|
||||||
|
},
|
||||||
|
"exclude": ["dist_*/**/*.d.ts"]
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user