Compare commits

..

57 Commits

Author SHA1 Message Date
587cfffbe4 v8.0.2 2026-03-23 14:59:59 +00:00
820811cca2 fix(servicemanager): cancel startup timeout once service initialization completes 2026-03-23 14:59:59 +00:00
e25271f9db v8.0.1 2026-03-23 14:40:17 +00:00
709f9fa894 fix(servicemanager): cancel shutdown timeouts after services stop 2026-03-23 14:40:17 +00:00
99430fbde4 v8.0.0 2026-03-21 10:57:27 +00:00
0f93e86cc1 BREAKING CHANGE(service): expand service lifecycle management with instance-aware hooks, startup timeouts, labels, readiness waits, and auto-restart support 2026-03-21 10:57:27 +00:00
0b78b05101 v7.0.0 2026-03-20 15:24:16 +00:00
e91e782113 feat(service): add Service and ServiceManager for component lifecycle management
Adds two new classes:
- Service: long-running component with start/stop lifecycle, health checks, builder pattern and subclass support
- ServiceManager: orchestrates multiple services with dependency-ordered startup, failure isolation, retry with backoff, and reverse-order shutdown
2026-03-20 15:24:12 +00:00
6e43e2ea68 v6.1.2 2026-02-15 23:14:45 +00:00
2a345f6514 fix(deps): bump @push.rocks/smarttime to ^4.2.3 2026-02-15 23:14:45 +00:00
b536dc8ba2 v6.1.1 2026-02-15 21:56:39 +00:00
6ca6cf6bc0 fix(tests): improve buffered task tests: add chain, concurrency and queue behavior tests 2026-02-15 21:56:39 +00:00
ed3bd99406 v6.1.0 2026-02-15 21:51:55 +00:00
3ab90d9895 feat(taskbuffer): add sliding-window rate limiting and result-sharing to TaskConstraintGroup and integrate with TaskManager 2026-02-15 21:51:55 +00:00
aee7236e5f v6.0.1 2026-02-15 21:08:38 +00:00
c89da9e2b0 fix(taskbuffer): no changes to commit 2026-02-15 21:08:38 +00:00
fae13bb944 v6.0.0 2026-02-15 15:15:37 +00:00
0811b04dfd BREAKING CHANGE(constraints): make TaskConstraintGroup constraint matcher input-aware and add shouldExecute pre-execution hook 2026-02-15 15:15:37 +00:00
33d1c334c4 v5.0.1 2026-02-15 12:36:57 +00:00
b2c0553e30 fix(tests): add and tighten constraint-related tests covering return values, error propagation, concurrency, cooldown timing, and constraint removal 2026-02-15 12:36:57 +00:00
450b62fe5d v5.0.0 2026-02-15 12:20:01 +00:00
d3e8ff1a11 BREAKING CHANGE(taskbuffer): Introduce constraint-based concurrency with TaskConstraintGroup and TaskManager integration; remove legacy TaskRunner and several Task APIs (breaking); add typed Task.data and update exports and tests. 2026-02-15 12:20:01 +00:00
9d78933a46 v4.2.1 2026-02-15 10:50:30 +00:00
28d9ad1746 fix(deps): bump @push.rocks/smartlog and @types/node; update dependency list version and license link in docs 2026-02-15 10:50:30 +00:00
28312972e0 v4.2.0 2026-01-29 15:13:34 +00:00
a0abcdda90 feat(ts_web): support TC39 accessor decorators for web components; bump dependencies and devDependencies; rename browser tests to .chromium.ts; move LICENSE to license.md and update readme 2026-01-29 15:13:34 +00:00
1dd7ca46ff v4.1.1 2026-01-26 00:54:13 +00:00
6110dd8e71 fix(ts_web): fix web dashboard typings and update generated commit info 2026-01-26 00:54:12 +00:00
3d8fe65b55 v4.1.0 2026-01-26 00:39:30 +00:00
6030fb2805 feat(task): add task labels and push-based task events 2026-01-26 00:39:30 +00:00
9a3a3e3eab v4.0.0 2026-01-25 23:29:00 +00:00
248383aab1 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. 2026-01-25 23:29:00 +00:00
905ca97b6a v3.5.0 2025-12-04 08:47:52 +00:00
72f75aa7de feat(core): Add debounced tasks and step-based progress tracking; upgrade deps and improve dashboard and scheduling 2025-12-04 08:47:52 +00:00
2fb605a58e 3.4.0 2025-09-07 08:51:47 +00:00
ed1e9a08b2 feat(taskbuffer-dashboard): Add TaskBuffer dashboard web component, demo and browser tests; add HTML entry and update dependencies 2025-09-07 08:51:47 +00:00
4d23b3dbfe 3.2.0 2025-09-06 13:36:04 +00:00
9784a5eacf feat(core): Add step-based progress tracking, task metadata and enhanced TaskManager scheduling/metadata APIs 2025-09-06 13:36:04 +00:00
6c9b975029 3.1.10 2025-08-26 20:42:52 +00:00
b1725cbdf9 fix(task): Implement core Task execution flow, buffering and lifecycle; update README with generics and buffer docs 2025-08-26 20:42:52 +00:00
d54012379c 3.1.9 2025-08-26 20:16:47 +00:00
dc47bc3d2a fix(tests): Update CI workflows, fix tests and refresh README/package metadata 2025-08-26 20:16:47 +00:00
863adb3b8c 3.1.8 2025-08-26 20:15:46 +00:00
67f01417b6 fix(tests): Update test runner and imports, refresh README and package metadata, add project tooling/config files 2025-08-26 20:15:46 +00:00
65886287c6 update description 2024-05-29 14:17:28 +02:00
fdaf772cfc update tsconfig 2024-04-14 18:38:20 +02:00
757b992440 update tsconfig 2024-04-01 21:42:31 +02:00
b4a701d128 update npmextra.json: githost 2024-04-01 20:00:12 +02:00
ca3ef8ced6 update npmextra.json: githost 2024-03-30 21:49:13 +01:00
6115bae66b 3.1.7 2023-10-20 13:05:40 +02:00
1be83af475 fix(core): update 2023-10-20 13:05:39 +02:00
bd14c41edc 3.1.6 2023-08-21 12:40:24 +02:00
d61b79282d fix(core): update 2023-08-21 12:40:24 +02:00
1cba9245fe 3.1.5 2023-08-15 12:02:45 +02:00
4b0db4da21 fix(core): update 2023-08-15 12:02:44 +02:00
a6cd0cb579 3.1.4 2023-08-15 11:39:32 +02:00
bd6109d5ea fix(core): update 2023-08-15 11:39:31 +02:00
48 changed files with 15586 additions and 5316 deletions

View File

@@ -6,8 +6,8 @@ on:
- '**'
env:
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
IMAGE: code.foss.global/host.today/ht-docker-node:npmci
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@/${{gitea.repository}}.git
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
@@ -26,7 +26,7 @@ jobs:
- name: Install pnpm and npmci
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
pnpm install -g @ship.zone/npmci
- name: Run npm prepare
run: npmci npm prepare

View File

@@ -6,8 +6,8 @@ on:
- '*'
env:
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
IMAGE: code.foss.global/host.today/ht-docker-node:npmci
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@/${{gitea.repository}}.git
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
@@ -26,7 +26,7 @@ jobs:
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
pnpm install -g @ship.zone/npmci
npmci npm prepare
- name: Audit production dependencies
@@ -54,7 +54,7 @@ jobs:
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
pnpm install -g @ship.zone/npmci
npmci npm prepare
- name: Test stable
@@ -82,7 +82,7 @@ jobs:
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
pnpm install -g @ship.zone/npmci
npmci npm prepare
- name: Release
@@ -104,7 +104,7 @@ jobs:
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
pnpm install -g @ship.zone/npmci
npmci npm prepare
- name: Code quality
@@ -119,6 +119,6 @@ jobs:
run: |
npmci node install stable
npmci npm install
pnpm install -g @gitzone/tsdoc
pnpm install -g @git.zone/tsdoc
npmci command tsdoc
continue-on-error: true

7
.gitignore vendored
View File

@@ -3,7 +3,6 @@
# artifacts
coverage/
public/
pages/
# installs
node_modules/
@@ -17,4 +16,8 @@ node_modules/
dist/
dist_*/
# custom
# AI
.claude/
.serena/
#------# custom

274
changelog.md Normal file
View File

@@ -0,0 +1,274 @@
# Changelog
## 2026-03-23 - 8.0.2 - fix(servicemanager)
cancel startup timeout once service initialization completes
- Replaces the startup timeout race delay with a cancellable Timeout instance
- Prevents the global startup timeout from lingering after startup finishes or fails
## 2026-03-23 - 8.0.1 - fix(servicemanager)
cancel shutdown timeouts after services stop
- Replace the shutdown race delay with a cancellable Timeout in ServiceManager.
- Prevent timeout handlers from lingering after a service stops successfully during shutdown.
## 2026-03-20 - 8.0.0 - BREAKING CHANGE(service)
expand service lifecycle management with instance-aware hooks, startup timeouts, labels, readiness waits, and auto-restart support
- Change service stop and health check callbacks to receive the started instance and expose it via service.instance
- Add per-service and global startup timeout handling plus waitForState, waitForRunning, and waitForStopped readiness helpers
- Support service labels, label-based manager queries, and auto-restart lifecycle events with configurable backoff
## 2026-02-15 - 6.1.2 - fix(deps)
bump @push.rocks/smarttime to ^4.2.3
- Updated @push.rocks/smarttime from ^4.1.1 to ^4.2.3
- Non-breaking dependency version bump; increment patch version
## 2026-02-15 - 6.1.1 - fix(tests)
improve buffered task tests: add chain, concurrency and queue behavior tests
- Replace tools.delayFor with @push.rocks/smartdelay for more deterministic timing in tests
- Add tests for afterTask chaining, bufferMax concurrency, queued-run limits, and re-trigger behavior
- Rename tasks to descriptive names and fix afterTask chaining order to avoid circular references
- Change test runner invocation to export default tap.start() instead of calling tap.start() directly
## 2026-02-15 - 6.1.0 - feat(taskbuffer)
add sliding-window rate limiting and result-sharing to TaskConstraintGroup and integrate with TaskManager
- Added IRateLimitConfig and TResultSharingMode types and exported them from the public index
- TaskConstraintGroup: added rateLimit and resultSharingMode options, internal completion timestamp tracking, and last-result storage
- TaskConstraintGroup: new helpers - pruneCompletionTimestamps, getRateLimitDelay, getNextAvailableDelay, recordResult, getLastResult, hasResultSharing
- TaskConstraintGroup: rate-limit logic enforces maxPerWindow (counts running + completions) and composes with cooldown/maxConcurrent
- TaskManager: records successful task results to constraint groups and resolves queued entries immediately when a shared result exists
- TaskManager: queue drain now considers unified next-available delay (cooldown + rate limit) when scheduling retries
- Documentation updated: README and hints with usage examples for sliding-window rate limiting and result sharing
- Comprehensive tests added for rate limiting, concurrency interaction, and result-sharing behavior
## 2026-02-15 - 6.0.1 - fix(taskbuffer)
no changes to commit
- Git diff shows no changes
- package.json current version is 6.0.0; no version bump required
## 2026-02-15 - 6.0.0 - BREAKING CHANGE(constraints)
make TaskConstraintGroup constraint matcher input-aware and add shouldExecute pre-execution hook
- Rename ITaskConstraintGroupOptions.constraintKeyForTask -> constraintKeyForExecution(task, input?) and update TaskConstraintGroup.getConstraintKey signature
- Add optional shouldExecute(task, input?) hook; TaskManager checks shouldExecute before immediate runs, after acquiring slots, and when draining the constraint queue (queued tasks are skipped when shouldExecute returns false)
- Export ITaskExecution type and store constraintKeys on queued entries (IConstrainedTaskEntry.constraintKeys)
- Documentation and tests updated to demonstrate input-aware constraint keys and shouldExecute pruning
## 2026-02-15 - 5.0.1 - fix(tests)
add and tighten constraint-related tests covering return values, error propagation, concurrency, cooldown timing, and constraint removal
- Tightened cooldown timing assertion from >=100ms to >=250ms to reflect 300ms cooldown with 50ms tolerance.
- Added tests for queued task return values, error propagation when catchErrors is false, and error swallowing behavior when catchErrors is true.
- Added concurrency and cooldown interaction tests to ensure maxConcurrent is respected and batch timing is correct.
- Added test verifying removing a constraint group unblocks queued tasks and drain behavior completes correctly.
## 2026-02-15 - 5.0.0 - BREAKING CHANGE(taskbuffer)
Introduce constraint-based concurrency with TaskConstraintGroup and TaskManager integration; remove legacy TaskRunner and several Task APIs (breaking); add typed Task.data and update exports and tests.
- Add TaskConstraintGroup class with per-key maxConcurrent, cooldownMs, and helper methods (canRun, acquireSlot, releaseSlot, getCooldownRemaining, getRunningCount, reset).
- Task generic signature extended to Task<T, TSteps, TData> and a new typed data property (data) with default {}.
- TaskManager now supports addConstraintGroup/removeConstraintGroup, triggerTaskConstrained, queues blocked tasks, drains queue with cooldown timers, and routes triggerTask/triggerTaskByName through the constraint system.
- Removed TaskRunner, plus Task APIs: blockingTasks, execDelay, finished promise and associated behavior have been removed (breaking changes).
- Exports and interfaces updated: TaskConstraintGroup and ITaskConstraintGroupOptions added; TaskRunner removed from public API.
- Updated README and added comprehensive tests for constraint behavior; adjusted other tests to remove TaskRunner usage and reflect new APIs.
## 2026-02-15 - 4.2.1 - fix(deps)
bump @push.rocks/smartlog and @types/node; update dependency list version and license link in docs
- package.json: update @push.rocks/smartlog from ^3.1.10 to ^3.1.11
- package.json: update @types/node from ^25.1.0 to ^25.2.3
- readme.hints.md: update 'Dependencies (as of v4.1.1)' to 'Dependencies (as of v4.2.0)' and reflect bumped dependency versions
- readme.md: change license link text to '[LICENSE](./license.md)'
## 2026-01-29 - 4.2.0 - feat(ts_web)
support TC39 'accessor' decorators for web components; bump dependencies and devDependencies; rename browser tests to .chromium.ts; move LICENSE to license.md and update readme
- Convert web component class fields to use the TC39 'accessor' keyword in ts_web/taskbuffer-dashboard.ts to be compatible with @design.estate/dees-element v2.1.6
- Bump @design.estate/dees-element to ^2.1.6 and update devDependencies (@git.zone/tsbuild, @git.zone/tsbundle, @git.zone/tsrun, @git.zone/tstest, @types/node) to newer versions
- Replace test/test.10.webcomponent.browser.ts with test/test.10.webcomponent.chromium.ts and update testing guidance in readme.hints.md to prefer .chromium.ts
- Move LICENSE file content to license.md and update readme.md to reference the new license file
- Small test cleanups: remove obsolete tslint:disable comments
## 2026-01-26 - 4.1.1 - fix(ts_web)
fix web dashboard typings and update generated commit info
- Updated generated commit info file ts_web/00_commitinfo_data.ts to version 4.1.0
- Large changes applied to web/TS build files (net +529 additions, -399 deletions) — likely fixes and typing/refactor improvements in ts_web/dashboard
- package.json remains at 4.1.0; recommend a patch bump to 4.1.1 for these fixes
## 2026-01-26 - 4.1.0 - feat(task)
add task labels and push-based task events
- Introduce Task labels: Task accepts labels in constructor and exposes setLabel/getLabel/removeLabel/hasLabel; labels are included (shallow copy) in getMetadata().
- Add push-based events: Task.eventSubject (rxjs Subject<ITaskEvent>) emits 'started','step','completed','failed' with timestamp; 'step' includes stepName and 'failed' includes error string.
- Task now emits events during lifecycle: emits 'started' at run start, 'step' on notifyStep, and 'completed' or 'failed' when finished or errored. getMetadata() now includes labels.
- TaskManager aggregates task events into taskSubject, subscribes on addTask and unsubscribes on removeTask/stop; includes helper methods getTasksByLabel and getTasksMetadataByLabel.
- Public API updated: exported ITaskEvent and TTaskEventType in ts/index.ts and interfaces updated (labels in metadata, new event types).
- Tests and docs: added test/test.12.labels-and-events.ts and updated readme.hints.md to document labels and push-based events.
## 2026-01-25 - 4.0.0 - BREAKING CHANGE(taskbuffer)
Change default Task error handling: trigger() now rejects when taskFunction throws; add catchErrors option (default false) to preserve previous swallow behavior; track errors (lastError, errorCount) and expose them in metadata; improve error propagation and logging across runners, chains, parallels and debounced tasks; add tests and documentation for new behavior.
- Introduce catchErrors option on Task (default: false) — previously errors were swallowed by default
- Tasks now set lastError and increment errorCount when failures occur; clearError() added to reset error state
- getMetadata() now reports status 'failed' and includes lastError and errorCount
- Task.run flow updated to reset error state at start, log errors, and either swallow or rethrow based on catchErrors
- BufferRunner, TaskRunner, Taskchain, Taskparallel, TaskDebounced and TaskManager updated to handle errors, avoid hanging promises, and use logger instead of console
- Added comprehensive tests (test/test.11.errorhandling.ts) and readme hints documenting the new error-handling behavior (v3.6.0+)
- npmextra.json updated for @git.zone/cli and release registries
## 2025-12-04 - 3.5.0 - feat(core)
Add debounced tasks and step-based progress tracking; upgrade deps and improve dashboard and scheduling
- 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.101.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
View 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>

View File

@@ -1,6 +1,6 @@
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
of this software and associated documentation files (the "Software"), to deal

View File

@@ -1,18 +1,39 @@
{
"npmci": {
"npmGlobalTools": [],
"npmAccessLevel": "public",
"npmRegistryUrl": "registry.npmjs.org"
},
"gitzone": {
"@git.zone/cli": {
"projectType": "npm",
"module": {
"githost": "gitlab.com",
"githost": "code.foss.global",
"gitscope": "push.rocks",
"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",
"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"
}
}

View File

@@ -1,49 +1,54 @@
{
"name": "@push.rocks/taskbuffer",
"version": "3.1.3",
"version": "8.0.2",
"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",
"typings": "dist_ts/index.d.ts",
"type": "module",
"scripts": {
"test": "(tstest test/ --web)",
"build": "(tsbuild --web && tsbundle npm)",
"test": "(tstest test/ --verbose --logfile --timeout 300)",
"build": "(tsbuild tsfolders)",
"buildDocs": "tsdoc"
},
"repository": {
"type": "git",
"url": "git+https://gitlab.com/pushrocks/taskbuffer.git"
"url": "https://code.foss.global/push.rocks/taskbuffer.git"
},
"keywords": [
"gulp",
"task",
"buffer",
"task management",
"TypeScript",
"push.rocks"
"task buffering",
"task scheduling",
"task execution",
"task dependencies",
"parallel tasks",
"task chains",
"debounced tasks",
"distributed coordination"
],
"author": "Lossless GmbH",
"author": "Task Venture Capital GmbH <hello@task.vc>",
"license": "MIT",
"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": {
"@push.rocks/isounique": "^1.0.5",
"@push.rocks/lik": "^6.0.3",
"@design.estate/dees-element": "^2.2.3",
"@push.rocks/lik": "^6.3.1",
"@push.rocks/smartdelay": "^3.0.5",
"@push.rocks/smartlog": "^3.0.3",
"@push.rocks/smartpromise": "^4.0.3",
"@push.rocks/smartrx": "^3.0.6",
"@push.rocks/smarttime": "^4.0.4"
"@push.rocks/smartlog": "^3.2.1",
"@push.rocks/smartpromise": "^4.2.3",
"@push.rocks/smartrx": "^3.0.10",
"@push.rocks/smarttime": "^4.2.3",
"@push.rocks/smartunique": "^3.0.9"
},
"devDependencies": {
"@gitzone/tsbuild": "^2.1.66",
"@gitzone/tsbundle": "^2.0.8",
"@gitzone/tsrun": "^1.2.44",
"@gitzone/tstest": "^1.0.77",
"@push.rocks/tapbundle": "^5.0.15",
"@types/node": "^20.4.10"
"@git.zone/tsbuild": "^4.3.0",
"@git.zone/tsbundle": "^2.9.1",
"@git.zone/tsrun": "^2.0.1",
"@git.zone/tstest": "^3.5.0",
"@types/node": "^25.5.0"
},
"files": [
"ts/**/*",
@@ -59,5 +64,9 @@
],
"browserslist": [
"last 1 chrome versions"
]
],
"packageManager": "pnpm@10.14.0+sha512.ad27a79641b49c3e481a16a805baa71817a04bbe06a38d17e60e2eaee83f6a146c6a688125f5792e48dd5ba30e7da52a5cda4c3992b9ccf333f9ce223af84748",
"pnpm": {
"overrides": {}
}
}

12113
pnpm-lock.yaml generated

File diff suppressed because it is too large Load Diff

138
readme.hints.md Normal file
View File

@@ -0,0 +1,138 @@
# Taskbuffer Hints
## Task Constraint System (v5.0.0+) — Breaking Changes
- **`TaskRunner` removed** — replaced by `TaskManager` + `TaskConstraintGroup`
- **`blockingTasks` removed** from `Task` — use `TaskConstraintGroup` with `maxConcurrent: 1`
- **`execDelay` removed** from `Task` — use `TaskConstraintGroup` with `cooldownMs`
- **`finished` promise removed** from `Task` — no longer needed
- **`Task` generic signature**: `Task<T, TSteps, TData>` (3rd param added for typed data)
### Task.data
- `Task` constructor accepts optional `data?: TData` (defaults to `{}`)
- Typed data bag accessible as `task.data`
### TaskConstraintGroup
- `new TaskConstraintGroup<TData>({ name, constraintKeyForExecution, maxConcurrent?, cooldownMs?, shouldExecute?, rateLimit?, resultSharingMode? })`
- `constraintKeyForExecution(task, input?)` returns a string key (constraint applies) or `null` (skip). Receives both task and runtime input.
- `shouldExecute(task, input?)` — optional pre-execution check. Returns `false` to skip (deferred resolves `undefined`). Can be async.
- `maxConcurrent` (default: `Infinity`) — max concurrent tasks per key
- `cooldownMs` (default: `0`) — minimum ms gap between completions per key
- `rateLimit` (optional) — `{ maxPerWindow: number, windowMs: number }` sliding window rate limiter. Counts both running + completed tasks in window.
- `resultSharingMode` (default: `'none'`) — `'none'` | `'share-latest'`. When `'share-latest'`, queued tasks for the same key resolve with the first task's result without executing.
- Methods: `getConstraintKey(task, input?)`, `checkShouldExecute(task, input?)`, `canRun(key)`, `acquireSlot(key)`, `releaseSlot(key)`, `getCooldownRemaining(key)`, `getRateLimitDelay(key)`, `getNextAvailableDelay(key)`, `getRunningCount(key)`, `recordResult(key, result)`, `getLastResult(key)`, `hasResultSharing()`, `reset()`
- `ITaskExecution<TData>` type exported from index — `{ task, input }` tuple
### Rate Limiting (v6.1.0+)
- Sliding window rate limiter: `rateLimit: { maxPerWindow: N, windowMs: ms }`
- Counts running + completed tasks against the window cap
- Per-key independence: saturating key A doesn't block key B
- Composable with `maxConcurrent` and `cooldownMs`
- `getNextAvailableDelay(key)` returns `Math.max(cooldownRemaining, rateLimitDelay)` — unified "how long until I can run" answer
- Drain timer auto-schedules based on shortest delay across all constraints
### Result Sharing (v6.1.0+)
- `resultSharingMode: 'share-latest'` — queued tasks for the same key get the first task's result without executing
- Only successful results are shared (errors from `catchErrors: true` or thrown errors are NOT shared)
- `shouldExecute` is NOT called for shared results (the task's purpose was already fulfilled)
- `lastResults` persists until `reset()` — for time-bounded sharing, use `shouldExecute` to control staleness
- Composable with rate limiting: rate-limited waiters get shared result without waiting for the window
### TaskManager Constraint Integration
- `manager.addConstraintGroup(group)` / `manager.removeConstraintGroup(name)`
- `triggerTaskByName()`, `triggerTask()`, `addExecuteRemoveTask()`, cron callbacks all route through `triggerTaskConstrained()`
- `triggerTaskConstrained(task, input?)` — evaluates constraints, queues if blocked, drains after completion
- Cooldown-blocked entries auto-drain via timer
### Exported from index.ts
- `TaskConstraintGroup` class
- `ITaskConstraintGroupOptions`, `IRateLimitConfig`, `TResultSharingMode` types
## Error Handling (v3.6.0+)
- `Task` now has `catchErrors` constructor option (default: `false`)
- Default behavior: `trigger()` rejects when taskFunction throws (breaking change from pre-3.6)
- Set `catchErrors: true` to swallow errors (old behavior) - returns `undefined` on error
- Error state tracked via `lastError?: Error`, `errorCount: number`, `clearError()`
- `getMetadata()` status uses all four values: `'idle'` | `'running'` | `'completed'` | `'failed'`
- All peripheral classes (Taskchain, Taskparallel, BufferRunner, TaskDebounced, TaskManager) have proper error propagation/handling
- `console.log` calls replaced with `logger.log()` throughout
## Error Context Improvements
- **TaskChain**: Errors now wrap the original with context: chain name, failing task name, and task index. Original error preserved via `.cause`
- **BufferRunner**: When `catchErrors: false`, buffered task errors now reject the trigger promise (via `CycleCounter.informOfCycleError`) instead of silently resolving with `undefined`
- **TaskChain stubs completed**: `removeTask(task)` returns `boolean`, `shiftTask()` returns `Task | undefined`
## Task Labels (v4.1.0+)
- `Task` constructor accepts optional `labels?: Record<string, string>`
- Helper methods: `setLabel(key, value)`, `getLabel(key)`, `removeLabel(key)`, `hasLabel(key, value?)`
- `getMetadata()` includes `labels` (shallow copy)
- `TaskManager.getTasksByLabel(key, value)` returns matching `Task[]`
- `TaskManager.getTasksMetadataByLabel(key, value)` returns matching `ITaskMetadata[]`
## Push-Based Events (v4.1.0+)
- `Task.eventSubject`: rxjs `Subject<ITaskEvent>` emitting `'started'`, `'step'`, `'completed'`, `'failed'` events
- `TaskManager.taskSubject`: aggregated `Subject<ITaskEvent>` from all added tasks
- `TaskManager.removeTask(task)` unsubscribes and removes from map
- `TaskManager.stop()` cleans up all event subscriptions
- Exported types: `ITaskEvent`, `TTaskEventType`
## Project Structure
- Source in `ts/`, web components in `ts_web/`
- Tests in `test/` - naming: `*.node.ts`, `*.chromium.ts` (preferred), `*.both.ts`
- Note: `*.browser.ts` is deprecated, use `*.chromium.ts` for browser tests
- Logger: `ts/taskbuffer.logging.ts` exports `logger` (ConsoleLog from smartlog)
- Build: `pnpm build` (tsbuild tsfolders)
- Test: `pnpm test` or `tstest test/test.XX.name.ts --verbose`
## Web Components (ts_web/)
- Uses `@design.estate/dees-element` with TC39 decorators
- Decorators require the `accessor` keyword:
```typescript
@property({ type: String })
accessor myProp = 'default';
@state()
accessor count = 0;
```
## Service Lifecycle System (v7.0.0+)
### Service<T>
- `new Service<T>(name)` or `new Service<T>(options: IServiceOptions<T>)`
- Builder pattern: `.critical()`, `.optional()`, `.dependsOn(...)`, `.withStart(fn)`, `.withStop(fn)`, `.withHealthCheck(fn, config?)`, `.withRetry(config)`, `.withStartupTimeout(ms)`, `.withLabels(labels)`
- Subclass pattern: override `serviceStart()`, `serviceStop()`, `serviceHealthCheck()`
- State machine: `stopped` → `starting` → `running` → `degraded` → `failed` → `stopping`
- `service.instance` — stores the value returned from `start()` (e.g. a database pool)
- `withStop(fn)` and `withHealthCheck(fn)` receive the instance as argument: `(instance: T) => Promise<void>`
- `waitForState(target, timeoutMs?)`, `waitForRunning(timeoutMs?)`, `waitForStopped(timeoutMs?)` — programmatic readiness gates
- Per-service startup timeout via `withStartupTimeout(ms)` or `startupTimeoutMs` in options
- Labels: `setLabel`, `getLabel`, `removeLabel`, `hasLabel`, `withLabels`
- Health checks: configurable via `IHealthCheckConfig` with `intervalMs`, `timeoutMs`, `failuresBeforeDegraded`, `failuresBeforeFailed`
- Auto-restart on health failure: `autoRestart: true` in `IHealthCheckConfig` with `maxAutoRestarts`, `autoRestartDelayMs`, `autoRestartBackoffFactor`
- Events via `eventSubject`: `'started'`, `'stopped'`, `'failed'`, `'degraded'`, `'recovered'`, `'retrying'`, `'healthCheck'`, `'autoRestarting'`
### ServiceManager
- `manager.addService(service)` / `manager.addServiceFromOptions(options)` / `manager.removeService(name)`
- Dependency-ordered startup via topological sort (Kahn's algorithm), level-by-level parallel
- Critical service failure aborts startup with rollback; optional service failure continues
- Retry with exponential backoff + jitter
- Reverse-dependency-ordered shutdown with per-service timeout
- `restartService(name)` — cascade stops dependents, restarts target, restarts dependents
- `getHealth()` — aggregated `'healthy' | 'degraded' | 'unhealthy'` status
- `getServicesByLabel(key, value)` / `getServicesStatusByLabel(key, value)` — label-based queries
- Circular dependency detection
- Global startup timeout enforcement via `startupTimeoutMs` in `IServiceManagerOptions`
## Dependencies (as of v7.0.0)
- `@design.estate/dees-element` ^2.2.3 - TC39 decorators with `accessor` keyword
- `@push.rocks/lik` ^6.3.1 - Data structures
- `@push.rocks/smartdelay` ^3.0.5 - Delay utilities
- `@push.rocks/smartlog` ^3.2.1 - Logging
- `@push.rocks/smartpromise` ^4.2.3 - Promise utilities
- `@push.rocks/smartrx` ^3.0.10 - RxJS wrapper
- `@push.rocks/smarttime` ^4.2.3 - Time/cron utilities
- `@push.rocks/smartunique` ^3.0.9 - Unique ID generation
- `@git.zone/tsbuild` ^4.3.0 - Build tool
- `@git.zone/tsbundle` ^2.9.1 - Bundler (for browser tests)
- `@git.zone/tsrun` ^2.0.1 - TypeScript runner
- `@git.zone/tstest` ^3.5.0 - Test runner (supports `.chromium.ts` files)
- `@types/node` ^25.5.0 - Node.js type definitions

1419
readme.md

File diff suppressed because it is too large Load Diff

View File

@@ -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 smartpromise from '@push.rocks/smartpromise';
import * as smartdelay from '@push.rocks/smartdelay';
@@ -16,7 +16,7 @@ tap.test('should have bufferMax set to the provided value', async () => {
const task2 = new taskbuffer.Task({
taskFunction: async () => {},
});
expect(task2.bufferMax).toBeUndefined(); // test for a task without bufferMax set
expect(task2.bufferMax).toBeUndefined(); // test for a task without bufferMax set
const bufferedTask = new taskbuffer.Task({
taskFunction: async () => {},
buffered: true,
@@ -26,7 +26,7 @@ tap.test('should have bufferMax set to the provided value', async () => {
});
tap.test('should be able to trigger tasks multiple times', async () => {
let task1Counter = 0;
let task1Counter = 0;
const task1 = new taskbuffer.Task({
name: 'Task 1',
taskFunction: () => {
@@ -49,10 +49,12 @@ tap.test('should execute setup function before the task function', async () => {
const task2 = new taskbuffer.Task({
name: 'Task 2',
taskSetup: async () => {
console.log('this is the setup function for task 2. It should only run once.')
console.log(
'this is the setup function for task 2. It should only run once.',
);
return {
nice: 'yes',
}
};
},
taskFunction: async (before, setupArg) => {
expect(setupArg).toEqual({ nice: 'yes' });

View 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();

View File

@@ -0,0 +1,332 @@
import { expect, tap } from '@git.zone/tstest/tapbundle';
import * as taskbuffer from '../ts/index.js';
import * as smartdelay from '@push.rocks/smartdelay';
// Test 1: Default task rejects on error (catchErrors: false)
tap.test('should reject when taskFunction throws (default catchErrors: false)', async () => {
const failingTask = new taskbuffer.Task({
name: 'failing-task-default',
taskFunction: async () => {
throw new Error('intentional failure');
},
});
let didReject = false;
try {
await failingTask.trigger();
} catch (err) {
didReject = true;
expect(err).toBeInstanceOf(Error);
expect((err as Error).message).toEqual('intentional failure');
}
expect(didReject).toBeTrue();
});
// Test 2: Task with catchErrors: true resolves on error
tap.test('should resolve with undefined when catchErrors is true', async () => {
const failingTask = new taskbuffer.Task({
name: 'failing-task-catch',
catchErrors: true,
taskFunction: async () => {
throw new Error('swallowed failure');
},
});
const result = await failingTask.trigger();
expect(result).toBeUndefined();
});
// Test 3: lastError and errorCount are set after failure
tap.test('should set lastError and errorCount after failure', async () => {
const failingTask = new taskbuffer.Task({
name: 'failing-task-state',
catchErrors: true,
taskFunction: async () => {
throw new Error('tracked failure');
},
});
await failingTask.trigger();
expect(failingTask.lastError).toBeInstanceOf(Error);
expect(failingTask.lastError.message).toEqual('tracked failure');
expect(failingTask.errorCount).toEqual(1);
// Run again to verify errorCount increments
await failingTask.trigger();
expect(failingTask.errorCount).toEqual(2);
});
// Test 4: Error state resets on successful re-run
tap.test('should reset lastError on successful re-run', async () => {
let shouldFail = true;
const task = new taskbuffer.Task({
name: 'intermittent-task',
catchErrors: true,
taskFunction: async () => {
if (shouldFail) {
throw new Error('first run fails');
}
return 'success';
},
});
// First run: fail
await task.trigger();
expect(task.lastError).toBeInstanceOf(Error);
expect(task.errorCount).toEqual(1);
// Second run: succeed
shouldFail = false;
const result = await task.trigger();
expect(result).toEqual('success');
expect(task.lastError).toBeUndefined();
// errorCount should still be 1 since the second run succeeded
expect(task.errorCount).toEqual(1);
});
// Test 5: Taskchain rejects when a child task throws
tap.test('should reject Taskchain when a child task throws', async () => {
const goodTask = new taskbuffer.Task({
name: 'good-chain-task',
taskFunction: async () => 'ok',
});
const badTask = new taskbuffer.Task({
name: 'bad-chain-task',
taskFunction: async () => {
throw new Error('chain failure');
},
});
const chain = new taskbuffer.Taskchain({
name: 'test-chain',
taskArray: [goodTask, badTask],
});
let didReject = false;
try {
await chain.trigger();
} catch (err) {
didReject = true;
}
expect(didReject).toBeTrue();
});
// Test 6: Taskparallel rejects when a child task throws
tap.test('should reject Taskparallel when a child task throws', async () => {
const goodTask = new taskbuffer.Task({
name: 'good-parallel-task',
taskFunction: async () => 'ok',
});
const badTask = new taskbuffer.Task({
name: 'bad-parallel-task',
taskFunction: async () => {
throw new Error('parallel failure');
},
});
const parallel = new taskbuffer.Taskparallel({
taskArray: [goodTask, badTask],
});
let didReject = false;
try {
await parallel.trigger();
} catch (err) {
didReject = true;
}
expect(didReject).toBeTrue();
});
// Test 7: BufferRunner handles errors without hanging
tap.test('should handle BufferRunner errors without hanging', async () => {
let callCount = 0;
const bufferedTask = new taskbuffer.Task({
name: 'buffer-error-task',
buffered: true,
bufferMax: 3,
catchErrors: true,
taskFunction: async () => {
callCount++;
throw new Error('buffer failure');
},
});
await bufferedTask.trigger();
// The task should have executed and not hung
expect(callCount).toBeGreaterThan(0);
});
// Test 9: clearError() resets error state
tap.test('should reset error state with clearError()', async () => {
const task = new taskbuffer.Task({
name: 'clearable-task',
catchErrors: true,
taskFunction: async () => {
throw new Error('to be cleared');
},
});
await task.trigger();
expect(task.lastError).toBeInstanceOf(Error);
task.clearError();
expect(task.lastError).toBeUndefined();
// errorCount should remain unchanged
expect(task.errorCount).toEqual(1);
});
// Test 10: getMetadata() reflects error state
tap.test('should reflect error state in getMetadata()', async () => {
const task = new taskbuffer.Task({
name: 'metadata-error-task',
catchErrors: true,
taskFunction: async () => {
throw new Error('metadata failure');
},
});
// Before any run
let metadata = task.getMetadata();
expect(metadata.status).toEqual('idle');
expect(metadata.errorCount).toEqual(0);
// After failing
await task.trigger();
metadata = task.getMetadata();
expect(metadata.status).toEqual('failed');
expect(metadata.lastError).toEqual('metadata failure');
expect(metadata.errorCount).toEqual(1);
});
// Test 11: TaskChain error includes task name and index context
tap.test('should include task name and index in TaskChain error message', async () => {
const goodTask = new taskbuffer.Task({
name: 'chain-step-ok',
taskFunction: async () => 'ok',
});
const badTask = new taskbuffer.Task({
name: 'chain-step-fail',
taskFunction: async () => {
throw new Error('step exploded');
},
});
const chain = new taskbuffer.Taskchain({
name: 'context-chain',
taskArray: [goodTask, badTask],
});
let caughtError: Error | null = null;
try {
await chain.trigger();
} catch (err) {
caughtError = err as Error;
}
expect(caughtError).toBeInstanceOf(Error);
expect(caughtError.message).toInclude('context-chain');
expect(caughtError.message).toInclude('chain-step-fail');
expect(caughtError.message).toInclude('index 1');
expect((caughtError as any).cause).toBeInstanceOf(Error);
expect(((caughtError as any).cause as Error).message).toEqual('step exploded');
});
// Test 12: BufferRunner error propagation with catchErrors: false
tap.test('should reject buffered task when catchErrors is false', async () => {
const bufferedTask = new taskbuffer.Task({
name: 'buffer-reject-task',
buffered: true,
bufferMax: 3,
catchErrors: false,
taskFunction: async () => {
throw new Error('buffer reject failure');
},
});
let didReject = false;
try {
await bufferedTask.trigger();
} catch (err) {
didReject = true;
expect(err).toBeInstanceOf(Error);
expect((err as Error).message).toEqual('buffer reject failure');
}
expect(didReject).toBeTrue();
});
// Test 13: Taskchain removeTask removes and returns true
tap.test('should remove a task from Taskchain', async () => {
const task1 = new taskbuffer.Task({
name: 'removable-1',
taskFunction: async () => 'a',
});
const task2 = new taskbuffer.Task({
name: 'removable-2',
taskFunction: async () => 'b',
});
const chain = new taskbuffer.Taskchain({
name: 'remove-chain',
taskArray: [task1, task2],
});
const removed = chain.removeTask(task1);
expect(removed).toBeTrue();
expect(chain.taskArray.length).toEqual(1);
expect(chain.taskArray[0] === task2).toBeTrue();
});
// Test 14: Taskchain removeTask returns false for unknown task
tap.test('should return false when removing a task not in Taskchain', async () => {
const task1 = new taskbuffer.Task({
name: 'existing',
taskFunction: async () => 'a',
});
const unknown = new taskbuffer.Task({
name: 'unknown',
taskFunction: async () => 'b',
});
const chain = new taskbuffer.Taskchain({
name: 'remove-false-chain',
taskArray: [task1],
});
const removed = chain.removeTask(unknown);
expect(removed).toBeFalse();
expect(chain.taskArray.length).toEqual(1);
});
// Test 15: Taskchain shiftTask returns first task and shortens array
tap.test('should shift the first task from Taskchain', async () => {
const task1 = new taskbuffer.Task({
name: 'shift-1',
taskFunction: async () => 'a',
});
const task2 = new taskbuffer.Task({
name: 'shift-2',
taskFunction: async () => 'b',
});
const chain = new taskbuffer.Taskchain({
name: 'shift-chain',
taskArray: [task1, task2],
});
const shifted = chain.shiftTask();
expect(shifted === task1).toBeTrue();
expect(chain.taskArray.length).toEqual(1);
expect(chain.taskArray[0] === task2).toBeTrue();
});
// Test 16: Taskchain shiftTask returns undefined on empty array
tap.test('should return undefined when shifting from empty Taskchain', async () => {
const chain = new taskbuffer.Taskchain({
name: 'empty-shift-chain',
taskArray: [],
});
const shifted = chain.shiftTask();
expect(shifted).toBeUndefined();
});
export default tap.start();

View 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();

1435
test/test.13.constraints.ts Normal file

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,894 @@
import { expect, tap } from '@git.zone/tstest/tapbundle';
import * as taskbuffer from '../ts/index.js';
import * as smartdelay from '@push.rocks/smartdelay';
// ── Test 1: Basic service start/stop lifecycle ─────────────
tap.test('should start and stop a simple service', async () => {
let started = false;
let stopped = false;
const service = new taskbuffer.Service('TestService')
.withStart(async () => { started = true; })
.withStop(async () => { stopped = true; });
expect(service.state).toEqual('stopped');
await service.start();
expect(service.state).toEqual('running');
expect(started).toBeTrue();
await service.stop();
expect(service.state).toEqual('stopped');
expect(stopped).toBeTrue();
});
// ── Test 2: Builder pattern chaining ───────────────────────
tap.test('should support builder pattern chaining', async () => {
const service = new taskbuffer.Service('ChainedService')
.critical()
.dependsOn('Dep1', 'Dep2')
.withStart(async () => 'result')
.withStop(async () => {})
.withRetry({ maxRetries: 5, baseDelayMs: 100 });
expect(service.criticality).toEqual('critical');
expect(service.dependencies).toEqual(['Dep1', 'Dep2']);
expect(service.retryConfig).toBeTruthy();
expect(service.retryConfig!.maxRetries).toEqual(5);
});
// ── Test 3: Subclass pattern ───────────────────────────────
tap.test('should support subclass pattern', async () => {
class MyService extends taskbuffer.Service<string> {
public startCalled = false;
public stopCalled = false;
constructor() {
super('MySubclassService');
this.optional();
}
protected async serviceStart(): Promise<string> {
this.startCalled = true;
return 'hello';
}
protected async serviceStop(): Promise<void> {
this.stopCalled = true;
}
}
const service = new MyService();
const result = await service.start();
expect(service.startCalled).toBeTrue();
expect(service.state).toEqual('running');
await service.stop();
expect(service.stopCalled).toBeTrue();
expect(service.state).toEqual('stopped');
});
// ── Test 4: Constructor with options object ────────────────
tap.test('should accept options object in constructor', async () => {
let started = false;
const service = new taskbuffer.Service({
name: 'OptionsService',
criticality: 'critical',
dependencies: ['A', 'B'],
start: async () => { started = true; },
stop: async () => {},
retry: { maxRetries: 10 },
});
expect(service.name).toEqual('OptionsService');
expect(service.criticality).toEqual('critical');
expect(service.dependencies).toEqual(['A', 'B']);
await service.start();
expect(started).toBeTrue();
await service.stop();
});
// ── Test 5: ServiceManager dependency ordering ─────────────
tap.test('should start services in dependency order', async () => {
const order: string[] = [];
const manager = new taskbuffer.ServiceManager({ name: 'TestManager' });
manager.addService(
new taskbuffer.Service('C')
.dependsOn('B')
.withStart(async () => { order.push('C'); })
.withStop(async () => {}),
);
manager.addService(
new taskbuffer.Service('A')
.withStart(async () => { order.push('A'); })
.withStop(async () => {}),
);
manager.addService(
new taskbuffer.Service('B')
.dependsOn('A')
.withStart(async () => { order.push('B'); })
.withStop(async () => {}),
);
await manager.start();
// A must come before B, B must come before C
expect(order.indexOf('A')).toBeLessThan(order.indexOf('B'));
expect(order.indexOf('B')).toBeLessThan(order.indexOf('C'));
await manager.stop();
});
// ── Test 6: Critical service failure aborts startup ────────
tap.test('should abort startup when a critical service fails', async () => {
const manager = new taskbuffer.ServiceManager({ name: 'CriticalTest' });
let serviceCStopped = false;
manager.addService(
new taskbuffer.Service('Working')
.critical()
.withStart(async () => {})
.withStop(async () => {}),
);
manager.addService(
new taskbuffer.Service('Broken')
.critical()
.withStart(async () => { throw new Error('boom'); })
.withStop(async () => {})
.withRetry({ maxRetries: 0 }),
);
manager.addService(
new taskbuffer.Service('AfterBroken')
.dependsOn('Broken')
.withStart(async () => { serviceCStopped = true; })
.withStop(async () => {}),
);
let caught = false;
try {
await manager.start();
} catch (err) {
caught = true;
expect((err as Error).message).toInclude('Broken');
}
expect(caught).toBeTrue();
// AfterBroken should never have started because Broken (its dep) failed
expect(serviceCStopped).toBeFalse();
});
// ── Test 7: Optional service failure continues startup ─────
tap.test('should continue startup when an optional service fails', async () => {
const manager = new taskbuffer.ServiceManager({ name: 'OptionalTest' });
let criticalStarted = false;
manager.addService(
new taskbuffer.Service('Critical')
.critical()
.withStart(async () => { criticalStarted = true; })
.withStop(async () => {})
.withRetry({ maxRetries: 0 }),
);
manager.addService(
new taskbuffer.Service('Optional')
.optional()
.withStart(async () => { throw new Error('oops'); })
.withStop(async () => {})
.withRetry({ maxRetries: 0 }),
);
// Should NOT throw
await manager.start();
expect(criticalStarted).toBeTrue();
const health = manager.getHealth();
expect(health.overall).toEqual('degraded');
const optionalStatus = manager.getServiceStatus('Optional');
expect(optionalStatus!.state).toEqual('failed');
await manager.stop();
});
// ── Test 8: Retry with backoff for optional services ───────
tap.test('should retry failed optional services', async () => {
const manager = new taskbuffer.ServiceManager({ name: 'RetryTest' });
let attempts = 0;
manager.addService(
new taskbuffer.Service('Flaky')
.optional()
.withStart(async () => {
attempts++;
if (attempts < 3) {
throw new Error(`attempt ${attempts} failed`);
}
})
.withStop(async () => {})
.withRetry({ maxRetries: 5, baseDelayMs: 50, maxDelayMs: 100, backoffFactor: 1 }),
);
await manager.start();
expect(attempts).toEqual(3);
const status = manager.getServiceStatus('Flaky');
expect(status!.state).toEqual('running');
await manager.stop();
});
// ── Test 9: Reverse-order shutdown ─────────────────────────
tap.test('should stop services in reverse dependency order', async () => {
const order: string[] = [];
const manager = new taskbuffer.ServiceManager({ name: 'ShutdownTest' });
manager.addService(
new taskbuffer.Service('Base')
.withStart(async () => {})
.withStop(async () => { order.push('Base'); }),
);
manager.addService(
new taskbuffer.Service('Middle')
.dependsOn('Base')
.withStart(async () => {})
.withStop(async () => { order.push('Middle'); }),
);
manager.addService(
new taskbuffer.Service('Top')
.dependsOn('Middle')
.withStart(async () => {})
.withStop(async () => { order.push('Top'); }),
);
await manager.start();
await manager.stop();
// Top should stop before Middle, Middle before Base
expect(order.indexOf('Top')).toBeLessThan(order.indexOf('Middle'));
expect(order.indexOf('Middle')).toBeLessThan(order.indexOf('Base'));
});
// ── Test 10: Circular dependency detection ─────────────────
tap.test('should throw on circular dependency', async () => {
const manager = new taskbuffer.ServiceManager({ name: 'CycleTest' });
manager.addService(
new taskbuffer.Service('A')
.dependsOn('B')
.withStart(async () => {})
.withStop(async () => {}),
);
manager.addService(
new taskbuffer.Service('B')
.dependsOn('A')
.withStart(async () => {})
.withStop(async () => {}),
);
let caught = false;
try {
await manager.start();
} catch (err) {
caught = true;
expect((err as Error).message).toInclude('Circular dependency');
}
expect(caught).toBeTrue();
});
// ── Test 11: restartService cascades to dependents ─────────
tap.test('should restart service and its dependents', async () => {
const startOrder: string[] = [];
const stopOrder: string[] = [];
const manager = new taskbuffer.ServiceManager({ name: 'RestartTest' });
manager.addService(
new taskbuffer.Service('Base')
.withStart(async () => { startOrder.push('Base'); })
.withStop(async () => { stopOrder.push('Base'); })
.withRetry({ maxRetries: 0 }),
);
manager.addService(
new taskbuffer.Service('Dep')
.dependsOn('Base')
.withStart(async () => { startOrder.push('Dep'); })
.withStop(async () => { stopOrder.push('Dep'); })
.withRetry({ maxRetries: 0 }),
);
await manager.start();
expect(startOrder).toEqual(['Base', 'Dep']);
// Clear tracking
startOrder.length = 0;
stopOrder.length = 0;
await manager.restartService('Base');
// Dep should be stopped first, then Base, then Base restarted, then Dep
expect(stopOrder).toEqual(['Dep', 'Base']);
expect(startOrder).toEqual(['Base', 'Dep']);
await manager.stop();
});
// ── Test 12: getHealth returns correct aggregated status ───
tap.test('should return correct health aggregation', async () => {
const manager = new taskbuffer.ServiceManager({ name: 'HealthTest' });
manager.addService(
new taskbuffer.Service('OK')
.critical()
.withStart(async () => {})
.withStop(async () => {})
.withRetry({ maxRetries: 0 }),
);
manager.addService(
new taskbuffer.Service('AlsoOK')
.optional()
.withStart(async () => {})
.withStop(async () => {})
.withRetry({ maxRetries: 0 }),
);
await manager.start();
const health = manager.getHealth();
expect(health.overall).toEqual('healthy');
expect(health.services.length).toEqual(2);
expect(health.startedAt).toBeTruthy();
expect(health.uptime).toBeGreaterThanOrEqual(0);
await manager.stop();
});
// ── Test 13: Events emitted on state transitions ───────────
tap.test('should emit events on state transitions', async () => {
const events: taskbuffer.IServiceEvent[] = [];
const manager = new taskbuffer.ServiceManager({ name: 'EventTest' });
manager.addService(
new taskbuffer.Service('Svc')
.withStart(async () => {})
.withStop(async () => {})
.withRetry({ maxRetries: 0 }),
);
manager.serviceSubject.subscribe((event) => {
events.push(event);
});
await manager.start();
await manager.stop();
const types = events.map((e) => e.type);
expect(types).toContain('started');
expect(types).toContain('stopped');
});
// ── Test 14: Parallel startup of independent services ──────
tap.test('should start independent services in parallel', async () => {
const manager = new taskbuffer.ServiceManager({ name: 'ParallelTest' });
const startTimes: Record<string, number> = {};
manager.addService(
new taskbuffer.Service('A')
.withStart(async () => {
startTimes['A'] = Date.now();
await smartdelay.delayFor(100);
})
.withStop(async () => {}),
);
manager.addService(
new taskbuffer.Service('B')
.withStart(async () => {
startTimes['B'] = Date.now();
await smartdelay.delayFor(100);
})
.withStop(async () => {}),
);
await manager.start();
// Both should start at roughly the same time (within 50ms)
const diff = Math.abs(startTimes['A'] - startTimes['B']);
expect(diff).toBeLessThan(50);
await manager.stop();
});
// ── Test 15: getStatus snapshot ────────────────────────────
tap.test('should return accurate status snapshot', async () => {
const service = new taskbuffer.Service('StatusTest')
.critical()
.dependsOn('X')
.withStart(async () => {})
.withStop(async () => {});
const statusBefore = service.getStatus();
expect(statusBefore.state).toEqual('stopped');
expect(statusBefore.name).toEqual('StatusTest');
expect(statusBefore.criticality).toEqual('critical');
expect(statusBefore.dependencies).toEqual(['X']);
expect(statusBefore.errorCount).toEqual(0);
await service.start();
const statusAfter = service.getStatus();
expect(statusAfter.state).toEqual('running');
expect(statusAfter.startedAt).toBeTruthy();
expect(statusAfter.uptime).toBeGreaterThanOrEqual(0);
await service.stop();
});
// ── Test 16: Missing dependency detection ──────────────────
tap.test('should throw when a dependency is not registered', async () => {
const manager = new taskbuffer.ServiceManager({ name: 'MissingDepTest' });
manager.addService(
new taskbuffer.Service('Lonely')
.dependsOn('Ghost')
.withStart(async () => {})
.withStop(async () => {}),
);
let caught = false;
try {
await manager.start();
} catch (err) {
caught = true;
expect((err as Error).message).toInclude('Ghost');
expect((err as Error).message).toInclude('not registered');
}
expect(caught).toBeTrue();
});
// ── Test 17: No-op on double start/stop ────────────────────
tap.test('should be a no-op when starting an already-running service', async () => {
let startCount = 0;
const service = new taskbuffer.Service('DoubleStart')
.withStart(async () => { startCount++; })
.withStop(async () => {});
await service.start();
await service.start(); // should be no-op
expect(startCount).toEqual(1);
await service.stop();
await service.stop(); // should be no-op
});
// ── Test 18: addServiceFromOptions convenience ─────────────
tap.test('should support addServiceFromOptions', async () => {
const manager = new taskbuffer.ServiceManager({ name: 'ConvenienceTest' });
let started = false;
const service = manager.addServiceFromOptions({
name: 'Easy',
start: async () => { started = true; },
stop: async () => {},
});
expect(service).toBeInstanceOf(taskbuffer.Service);
expect(service.name).toEqual('Easy');
await manager.start();
expect(started).toBeTrue();
await manager.stop();
});
// ═══════════════════════════════════════════════════════════
// NEW TESTS: Improvements 1-5
// ═══════════════════════════════════════════════════════════
// ── Test 19: service.instance stores start result ──────────
tap.test('should store start result as service.instance', async () => {
const pool = { query: (sql: string) => `result: ${sql}` };
const service = new taskbuffer.Service<typeof pool>('DB')
.withStart(async () => pool)
.withStop(async (inst) => {});
expect(service.instance).toBeUndefined();
const result = await service.start();
expect(result).toEqual(pool);
expect(service.instance).toEqual(pool);
expect(service.instance!.query('SELECT 1')).toEqual('result: SELECT 1');
// Status should report hasInstance
expect(service.getStatus().hasInstance).toBeTrue();
await service.stop();
expect(service.instance).toBeUndefined();
expect(service.getStatus().hasInstance).toBeFalse();
});
// ── Test 20: stop receives the instance ────────────────────
tap.test('should pass instance to stop function', async () => {
let receivedInstance: any = null;
const service = new taskbuffer.Service<{ id: number }>('InstanceStop')
.withStart(async () => ({ id: 42 }))
.withStop(async (inst) => { receivedInstance = inst; });
await service.start();
await service.stop();
expect(receivedInstance).toBeTruthy();
expect(receivedInstance.id).toEqual(42);
});
// ── Test 21: healthCheck receives the instance ─────────────
tap.test('should pass instance to health check function', async () => {
let checkedInstance: any = null;
const service = new taskbuffer.Service<{ healthy: boolean }>('InstanceHealth')
.withStart(async () => ({ healthy: true }))
.withStop(async () => {})
.withHealthCheck(async (inst) => {
checkedInstance = inst;
return inst.healthy;
}, { intervalMs: 60000 }); // long interval so it doesn't auto-run
await service.start();
// Manually trigger health check
const ok = await service.checkHealth();
expect(ok).toBeTrue();
expect(checkedInstance).toBeTruthy();
expect(checkedInstance.healthy).toBeTrue();
await service.stop();
});
// ── Test 22: double start returns existing instance ────────
tap.test('should return existing instance on double start', async () => {
let callCount = 0;
const service = new taskbuffer.Service<number>('DoubleInstance')
.withStart(async () => { callCount++; return callCount; })
.withStop(async () => {});
const first = await service.start();
const second = await service.start();
expect(first).toEqual(1);
expect(second).toEqual(1); // should return same instance, not call start again
expect(callCount).toEqual(1);
await service.stop();
});
// ── Test 23: Labels on Service ─────────────────────────────
tap.test('should support labels on services', async () => {
const service = new taskbuffer.Service('LabeledService')
.withLabels({ type: 'database', env: 'production' })
.withStart(async () => {})
.withStop(async () => {});
expect(service.hasLabel('type')).toBeTrue();
expect(service.hasLabel('type', 'database')).toBeTrue();
expect(service.hasLabel('type', 'cache')).toBeFalse();
expect(service.getLabel('env')).toEqual('production');
service.setLabel('region', 'eu-west');
expect(service.hasLabel('region')).toBeTrue();
service.removeLabel('env');
expect(service.hasLabel('env')).toBeFalse();
// Labels in status
const status = service.getStatus();
expect(status.labels).toBeTruthy();
expect(status.labels!.type).toEqual('database');
expect(status.labels!.region).toEqual('eu-west');
});
// ── Test 24: Labels via IServiceOptions ────────────────────
tap.test('should accept labels in options constructor', async () => {
const service = new taskbuffer.Service({
name: 'OptionsLabeled',
start: async () => {},
stop: async () => {},
labels: { kind: 'cache' },
});
expect(service.hasLabel('kind', 'cache')).toBeTrue();
});
// ── Test 25: ServiceManager.getServicesByLabel ─────────────
tap.test('should query services by label in ServiceManager', async () => {
const manager = new taskbuffer.ServiceManager({ name: 'LabelQueryTest' });
manager.addService(
new taskbuffer.Service('Redis')
.withLabels({ type: 'cache', tier: 'fast' })
.withStart(async () => {})
.withStop(async () => {}),
);
manager.addService(
new taskbuffer.Service('Memcached')
.withLabels({ type: 'cache', tier: 'fast' })
.withStart(async () => {})
.withStop(async () => {}),
);
manager.addService(
new taskbuffer.Service('Postgres')
.withLabels({ type: 'database', tier: 'slow' })
.withStart(async () => {})
.withStop(async () => {}),
);
const caches = manager.getServicesByLabel('type', 'cache');
expect(caches.length).toEqual(2);
const databases = manager.getServicesByLabel('type', 'database');
expect(databases.length).toEqual(1);
expect(databases[0].name).toEqual('Postgres');
const statuses = manager.getServicesStatusByLabel('tier', 'fast');
expect(statuses.length).toEqual(2);
await manager.stop();
});
// ── Test 26: waitForState / waitForRunning ──────────────────
tap.test('should support waitForState and waitForRunning', async () => {
const service = new taskbuffer.Service('WaitService')
.withStart(async () => {
await smartdelay.delayFor(50);
})
.withStop(async () => {});
// Start in background
const startPromise = service.start();
// Wait for running state
await service.waitForRunning(2000);
expect(service.state).toEqual('running');
await startPromise;
// Now wait for stopped
const stopPromise = service.stop();
await service.waitForStopped(2000);
expect(service.state).toEqual('stopped');
await stopPromise;
});
// ── Test 27: waitForState timeout ──────────────────────────
tap.test('should timeout when waiting for a state that never comes', async () => {
const service = new taskbuffer.Service('TimeoutWait')
.withStart(async () => {})
.withStop(async () => {});
// Service is stopped, wait for 'running' with a short timeout
let caught = false;
try {
await service.waitForState('running', 100);
} catch (err) {
caught = true;
expect((err as Error).message).toInclude('timed out');
expect((err as Error).message).toInclude('running');
}
expect(caught).toBeTrue();
});
// ── Test 28: waitForState already in target state ──────────
tap.test('should resolve immediately if already in target state', async () => {
const service = new taskbuffer.Service('AlreadyThere')
.withStart(async () => {})
.withStop(async () => {});
// Already stopped
await service.waitForState('stopped', 100); // should not throw
await service.start();
await service.waitForState('running', 100); // should not throw
await service.stop();
});
// ── Test 29: Per-service startup timeout ───────────────────
tap.test('should timeout when serviceStart hangs', async () => {
const service = new taskbuffer.Service('SlowStart')
.withStart(async () => {
await smartdelay.delayFor(5000); // very slow
})
.withStop(async () => {})
.withStartupTimeout(100); // 100ms timeout
let caught = false;
try {
await service.start();
} catch (err) {
caught = true;
expect((err as Error).message).toInclude('startup timed out');
expect((err as Error).message).toInclude('100ms');
}
expect(caught).toBeTrue();
expect(service.state).toEqual('failed');
});
// ── Test 30: Startup timeout via options ────────────────────
tap.test('should accept startupTimeoutMs in options constructor', async () => {
const service = new taskbuffer.Service({
name: 'TimeoutOptions',
start: async () => { await smartdelay.delayFor(5000); },
stop: async () => {},
startupTimeoutMs: 100,
});
let caught = false;
try {
await service.start();
} catch (err) {
caught = true;
expect((err as Error).message).toInclude('startup timed out');
}
expect(caught).toBeTrue();
});
// ── Test 31: Auto-restart on health check failure ──────────
tap.test('should auto-restart when health checks fail', async () => {
let startCount = 0;
let healthy = false;
const service = new taskbuffer.Service('AutoRestart')
.withStart(async () => {
startCount++;
// After first restart, become healthy
if (startCount >= 2) {
healthy = true;
}
})
.withStop(async () => {})
.withHealthCheck(async () => healthy, {
intervalMs: 30000, // we'll call checkHealth manually
failuresBeforeDegraded: 1,
failuresBeforeFailed: 2,
autoRestart: true,
maxAutoRestarts: 3,
autoRestartDelayMs: 50,
autoRestartBackoffFactor: 1,
});
await service.start();
expect(startCount).toEqual(1);
// Fail health checks manually to push to failed
await service.checkHealth(); // 1 failure -> degraded
expect(service.state).toEqual('degraded');
await service.checkHealth(); // 2 failures -> failed + auto-restart scheduled
expect(service.state).toEqual('failed');
// Wait for auto-restart to complete
await service.waitForRunning(2000);
expect(service.state).toEqual('running');
expect(startCount).toEqual(2);
await service.stop();
});
// ── Test 32: Auto-restart max attempts ─────────────────────
tap.test('should stop auto-restarting after max attempts', async () => {
let startCount = 0;
const events: string[] = [];
const service = new taskbuffer.Service('MaxRestart')
.withStart(async () => {
startCount++;
if (startCount > 1) {
throw new Error('always fails');
}
})
.withStop(async () => {})
.withHealthCheck(async () => false, {
intervalMs: 60000,
failuresBeforeDegraded: 1,
failuresBeforeFailed: 2,
autoRestart: true,
maxAutoRestarts: 2,
autoRestartDelayMs: 50,
autoRestartBackoffFactor: 1,
});
service.eventSubject.subscribe((e) => events.push(e.type));
await service.start();
expect(startCount).toEqual(1);
// Push to failed
await service.checkHealth();
await service.checkHealth();
// Wait for auto-restart attempts to exhaust
await smartdelay.delayFor(500);
// Should have emitted autoRestarting events
expect(events).toContain('autoRestarting');
// Service should be in failed state (restarts exhausted)
expect(service.state).toEqual('failed');
// Clean up
await service.stop();
});
// ── Test 33: Builder chaining with new methods ─────────────
tap.test('should chain all new builder methods', async () => {
const service = new taskbuffer.Service('FullBuilder')
.critical()
.dependsOn('A')
.withStart(async () => ({ conn: true }))
.withStop(async (inst) => {})
.withHealthCheck(async (inst) => inst.conn)
.withRetry({ maxRetries: 3 })
.withStartupTimeout(5000)
.withLabels({ env: 'test' });
expect(service.criticality).toEqual('critical');
expect(service.startupTimeoutMs).toEqual(5000);
expect(service.hasLabel('env', 'test')).toBeTrue();
});
export default tap.start();

View File

@@ -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';
@@ -36,12 +36,9 @@ tap.test('expect run tasks in sequence', async () => {
});
const testPromise = testTaskchain.trigger();
await smartdelay.delayFor(2100);
// tslint:disable-next-line:no-unused-expression
expect(task1Executed).toBeTrue();
// tslint:disable-next-line:no-unused-expression
expect(task2Executed).toBeFalse();
await smartdelay.delayFor(2100);
// tslint:disable-next-line:no-unused-expression
expect(task2Executed).toBeTrue();
await testPromise;
});

View File

@@ -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 taskbuffer from '../ts/index.js';

View File

@@ -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';
@@ -25,20 +25,19 @@ tap.test('should run the task as expected', async () => {
console.log('Task "myTask" executed!');
referenceBoolean = true;
taskRunCounter++;
if (taskRunCounter === 10) {
if (taskRunCounter === 3) {
taskDone.resolve();
}
},
})
}),
);
myTaskManager.start();
await myTaskManager.triggerTaskByName('myTask');
// tslint:disable-next-line:no-unused-expression
expect(referenceBoolean).toBeTrue();
});
tap.test('should schedule task', async () => {
myTaskManager.scheduleTaskByName('myTask', '*/10 * * * * *');
myTaskManager.scheduleTaskByName('myTask', '*/5 * * * * *');
await taskDone.promise;
myTaskManager.descheduleTaskByName('myTask');
});

View File

@@ -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';

View File

@@ -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';

View File

@@ -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';

View File

@@ -1,52 +1,151 @@
import { tap, expect } from '@push.rocks/tapbundle';
import { tap, expect } from '@git.zone/tstest/tapbundle';
import * as taskbuffer from '../ts/index.js';
import * as smartdelay from '@push.rocks/smartdelay';
let counter1 = 0;
let counter2 = 0;
let counter3 = 0;
// Test 1: Basic buffered execution with afterTask chain
tap.test('should run buffered tasks with afterTask chain', async () => {
let counter1 = 0;
let counter2 = 0;
let counter3 = 0;
tap.test('should run buffered', async (tools) => {
const task = new taskbuffer.Task({
name: 'a buffered task',
taskFunction: async () => {
counter1++;
await tools.delayFor(2000);
console.log(`task 1 ran ${counter1} times`);
},
buffered: true,
bufferMax: 1,
afterTask: () => {
return task2;
},
});
const task2 = new taskbuffer.Task({
name: 'a buffered task',
taskFunction: async () => {
counter2++;
await tools.delayFor(2000);
console.log(`task2 ran ${counter2} times`);
},
buffered: true,
bufferMax: 1,
afterTask: () => {
return task3;
},
});
const task3 = new taskbuffer.Task({
name: 'a buffered task',
name: 'buffered-chain-3',
taskFunction: async () => {
counter3++;
await tools.delayFor(2000);
console.log(`task3 ran ${counter3} times`);
await smartdelay.delayFor(50);
},
buffered: true,
bufferMax: 1,
});
while (counter1 < 10) {
await tools.delayFor(5000);
task.trigger();
const task2 = new taskbuffer.Task({
name: 'buffered-chain-2',
taskFunction: async () => {
counter2++;
await smartdelay.delayFor(50);
},
buffered: true,
bufferMax: 1,
afterTask: () => task3,
});
const task1 = new taskbuffer.Task({
name: 'buffered-chain-1',
taskFunction: async () => {
counter1++;
await smartdelay.delayFor(50);
},
buffered: true,
bufferMax: 1,
afterTask: () => task2,
});
// Trigger 3 times with enough spacing for the chain to complete
for (let i = 0; i < 3; i++) {
task1.trigger();
await smartdelay.delayFor(250); // enough for chain of 3 x 50ms tasks
}
// Wait for final chain to finish
await smartdelay.delayFor(500);
// Each task in the chain should have run at least once
expect(counter1).toBeGreaterThanOrEqual(1);
expect(counter2).toBeGreaterThanOrEqual(1);
expect(counter3).toBeGreaterThanOrEqual(1);
// afterTask chain means task2 count should match task1 (each trigger chains)
expect(counter2).toEqual(counter1);
expect(counter3).toEqual(counter1);
});
tap.start();
// Test 2: bufferMax limits concurrent buffered executions
tap.test('should respect bufferMax for concurrent buffered calls', async () => {
let running = 0;
let maxRunning = 0;
let totalRuns = 0;
const task = new taskbuffer.Task({
name: 'buffer-max-test',
taskFunction: async () => {
running++;
maxRunning = Math.max(maxRunning, running);
totalRuns++;
await smartdelay.delayFor(100);
running--;
},
buffered: true,
bufferMax: 2,
});
// Fire many triggers rapidly — only bufferMax should run concurrently
for (let i = 0; i < 10; i++) {
task.trigger();
}
// Wait for all buffered executions to complete
await smartdelay.delayFor(1000);
expect(maxRunning).toBeLessThanOrEqual(2);
expect(totalRuns).toBeGreaterThanOrEqual(1);
});
// Test 3: bufferMax limits how many runs are queued during execution
tap.test('should limit queued runs to bufferMax during execution', async () => {
let runCount = 0;
const task = new taskbuffer.Task({
name: 'buffer-queue-test',
taskFunction: async () => {
runCount++;
await smartdelay.delayFor(100);
},
buffered: true,
bufferMax: 2,
});
// Rapid-fire 5 triggers — bufferMax:2 means counter caps at 2
// so only 2 runs will happen (the initial run + 1 buffered rerun)
task.trigger();
task.trigger();
task.trigger();
task.trigger();
task.trigger();
await smartdelay.delayFor(500);
expect(runCount).toEqual(2);
});
// Test 4: Triggers spaced after completion queue new runs
tap.test('should re-trigger after previous buffered run completes', async () => {
let runCount = 0;
const task = new taskbuffer.Task({
name: 'retrigger-test',
taskFunction: async () => {
runCount++;
await smartdelay.delayFor(50);
},
buffered: true,
bufferMax: 1,
});
// First trigger starts execution
task.trigger();
// Wait for it to complete
await smartdelay.delayFor(100);
// Second trigger starts a new execution (task is now idle)
task.trigger();
await smartdelay.delayFor(100);
// Third trigger
task.trigger();
await smartdelay.delayFor(100);
expect(runCount).toEqual(3);
});
export default tap.start();

376
test/test.9.steps.ts Normal file
View 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();

View File

@@ -1,34 +0,0 @@
import { tap, expect } from '@push.rocks/tapbundle';
import * as taskbuffer from '../ts/index.js';
let testTaskRunner: taskbuffer.TaskRunner;
tap.test('should create a valid taskrunner', async () => {
testTaskRunner = new taskbuffer.TaskRunner();
await testTaskRunner.start();
});
tap.test('should execute task when its scheduled', async (tools) => {
const done = tools.defer();
testTaskRunner.addTask(
new taskbuffer.Task({
taskFunction: async () => {
console.log('hi');
},
})
);
testTaskRunner.addTask(
new taskbuffer.Task({
taskFunction: async () => {
console.log('there');
done.resolve();
},
})
);
await done.promise;
});
tap.start();

View File

@@ -1,8 +1,8 @@
/**
* autocreated commitinfo by @pushrocks/commitinfo
* autocreated commitinfo by @push.rocks/commitinfo
*/
export const commitinfo = {
name: '@push.rocks/taskbuffer',
version: '3.1.3',
description: 'flexible task management. TypeScript ready!'
version: '8.0.2',
description: 'A flexible task management library supporting TypeScript, allowing for task buffering, scheduling, and execution with dependency management.'
}

View File

@@ -1,10 +1,35 @@
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 { Taskparallel } from './taskbuffer.classes.taskparallel.js';
export { TaskManager } from './taskbuffer.classes.taskmanager.js';
export { TaskOnce } from './taskbuffer.classes.taskonce.js';
export { TaskRunner } from './taskbuffer.classes.taskrunner.js';
export { TaskDebounced } from './taskbuffer.classes.taskdebounced.js';
export { TaskConstraintGroup } from './taskbuffer.classes.taskconstraintgroup.js';
// Task step system
export { TaskStep } from './taskbuffer.classes.taskstep.js';
export type { ITaskStep } from './taskbuffer.classes.taskstep.js';
// Metadata interfaces
export type { ITaskMetadata, ITaskExecutionReport, IScheduledTaskInfo, ITaskEvent, TTaskEventType, ITaskConstraintGroupOptions, ITaskExecution, IRateLimitConfig, TResultSharingMode } from './taskbuffer.interfaces.js';
// Service lifecycle system
export { Service } from './taskbuffer.classes.service.js';
export { ServiceManager } from './taskbuffer.classes.servicemanager.js';
export type {
IServiceOptions,
IServiceStatus,
IServiceEvent,
IServiceManagerOptions,
IServiceManagerHealth,
IRetryConfig,
IHealthCheckConfig,
TServiceState,
TServiceCriticality,
TServiceEventType,
TOverallHealth,
} from './taskbuffer.interfaces.js';
import * as distributedCoordination from './taskbuffer.classes.distributedcoordinator.js';
export { distributedCoordination };

View File

@@ -1,11 +1,12 @@
import { Task } from './taskbuffer.classes.task.js';
import { logger } from './taskbuffer.logging.js';
export class BufferRunner {
public task: Task;
// initialize by default
public bufferCounter: number = 0;
constructor(taskArg: Task<any>) {
constructor(taskArg: Task<any, any, any>) {
this.task = taskArg;
}
@@ -13,9 +14,8 @@ export class BufferRunner {
if (!(this.bufferCounter >= this.task.bufferMax)) {
this.bufferCounter++;
}
const returnPromise: Promise<any> = this.task.cycleCounter.getPromiseForCycle(
this.bufferCounter
);
const returnPromise: Promise<any> =
this.task.cycleCounter.getPromiseForCycle(this.bufferCounter);
if (!this.task.running) {
this._run(x);
}
@@ -25,9 +25,19 @@ export class BufferRunner {
private async _run(x: any) {
this.task.running = true;
while (this.bufferCounter > 0) {
const result = await Task.runTask(this.task, { x: x });
this.bufferCounter--;
this.task.cycleCounter.informOfCycle(result);
try {
const result = await Task.runTask(this.task, { x: x });
this.bufferCounter--;
this.task.cycleCounter.informOfCycle(result);
} catch (err) {
logger.log('error', `BufferRunner: task "${this.task.name || 'unnamed'}" failed: ${err instanceof Error ? err.message : String(err)}`);
this.bufferCounter--;
if (this.task.catchErrors) {
this.task.cycleCounter.informOfCycle(undefined);
} else {
this.task.cycleCounter.informOfCycleError(err instanceof Error ? err : new Error(String(err)));
}
}
}
this.task.running = false;
}

View File

@@ -9,7 +9,7 @@ export interface ICycleObject {
export class CycleCounter {
public task: Task;
public cycleObjectArray: ICycleObject[] = [];
constructor(taskArg: Task<any>) {
constructor(taskArg: Task<any, any, any>) {
this.task = taskArg;
}
public getPromiseForCycle(cycleCountArg: number) {
@@ -33,4 +33,16 @@ export class CycleCounter {
});
this.cycleObjectArray = newCycleObjectArray;
}
public informOfCycleError(err: Error) {
const newCycleObjectArray: ICycleObject[] = [];
this.cycleObjectArray.forEach((cycleObjectArg) => {
cycleObjectArg.cycleCounter--;
if (cycleObjectArg.cycleCounter <= 0) {
cycleObjectArg.deferred.reject(err);
} else {
newCycleObjectArray.push(cycleObjectArg);
}
});
this.cycleObjectArray = newCycleObjectArray;
}
}

View File

@@ -6,6 +6,7 @@ import * as plugins from './taskbuffer.plugins.js';
*/
export interface IDistributedTaskRequest {
submitterId: string;
requestResponseId: string;
taskName: string;
taskVersion: string;
taskExecutionTime: number;
@@ -16,6 +17,7 @@ export interface IDistributedTaskRequest {
export interface IDistributedTaskRequestResult {
submitterId: string;
requestResponseId: string;
considered: boolean;
rank: number;
reason: string;
@@ -24,11 +26,11 @@ export interface IDistributedTaskRequestResult {
export abstract class AbstractDistributedCoordinator {
public abstract fireDistributedTaskRequest(
infoBasis: IDistributedTaskRequest
infoBasis: IDistributedTaskRequest,
): Promise<IDistributedTaskRequestResult>;
public abstract updateDistributedTaskRequest(
infoBasis: IDistributedTaskRequest
infoBasis: IDistributedTaskRequest,
): Promise<void>;
public abstract start(): Promise<void>;

View File

@@ -0,0 +1,528 @@
import * as plugins from './taskbuffer.plugins.js';
import { logger } from './taskbuffer.logging.js';
import type {
TServiceState,
TServiceCriticality,
IServiceEvent,
IServiceStatus,
IRetryConfig,
IHealthCheckConfig,
IServiceOptions,
} from './taskbuffer.interfaces.js';
/**
* Service represents a long-running component with start/stop lifecycle,
* health checking, and retry capabilities.
*
* Use via builder pattern:
* new Service('MyService')
* .critical()
* .dependsOn('Database')
* .withStart(async () => { ... })
* .withStop(async (instance) => { ... })
* .withHealthCheck(async (instance) => { ... })
*
* Or extend for complex services:
* class MyService extends Service {
* protected async serviceStart() { ... }
* protected async serviceStop() { ... }
* }
*/
export class Service<T = any> {
public readonly name: string;
public readonly eventSubject = new plugins.smartrx.rxjs.Subject<IServiceEvent>();
// ── Internal state ─────────────────────────────────
private _state: TServiceState = 'stopped';
private _criticality: TServiceCriticality = 'optional';
private _dependencies: string[] = [];
private _retryConfig: IRetryConfig | undefined;
private _healthCheckConfig: IHealthCheckConfig | undefined;
private _startupTimeoutMs: number | undefined;
// Builder-provided functions
private _startFn: (() => Promise<T>) | undefined;
private _stopFn: ((instance: T) => Promise<void>) | undefined;
private _healthCheckFn: ((instance: T) => Promise<boolean>) | undefined;
// Instance: the resolved start result
private _instance: T | undefined;
// Labels
public labels: Record<string, string> = {};
// Runtime tracking
private _startedAt: number | undefined;
private _stoppedAt: number | undefined;
private _errorCount = 0;
private _lastError: string | undefined;
private _retryCount = 0;
// Health check tracking
private _healthCheckTimer: ReturnType<typeof setTimeout> | undefined;
private _lastHealthCheck: number | undefined;
private _healthCheckOk: boolean | undefined;
private _consecutiveHealthFailures = 0;
// Auto-restart tracking
private _autoRestartCount = 0;
private _autoRestartTimer: ReturnType<typeof setTimeout> | undefined;
constructor(nameOrOptions: string | IServiceOptions<T>) {
if (typeof nameOrOptions === 'string') {
this.name = nameOrOptions;
} else {
this.name = nameOrOptions.name;
this._startFn = nameOrOptions.start;
this._stopFn = nameOrOptions.stop;
this._healthCheckFn = nameOrOptions.healthCheck;
this._criticality = nameOrOptions.criticality || 'optional';
this._dependencies = nameOrOptions.dependencies || [];
this._retryConfig = nameOrOptions.retry;
this._healthCheckConfig = nameOrOptions.healthCheckConfig;
this._startupTimeoutMs = nameOrOptions.startupTimeoutMs;
if (nameOrOptions.labels) {
this.labels = { ...nameOrOptions.labels };
}
}
}
// ── Builder methods ──────────────────────────────────
public critical(): this {
this._criticality = 'critical';
return this;
}
public optional(): this {
this._criticality = 'optional';
return this;
}
public dependsOn(...serviceNames: string[]): this {
this._dependencies.push(...serviceNames);
return this;
}
public withStart(fn: () => Promise<T>): this {
this._startFn = fn;
return this;
}
public withStop(fn: (instance: T) => Promise<void>): this {
this._stopFn = fn;
return this;
}
public withHealthCheck(fn: (instance: T) => Promise<boolean>, config?: IHealthCheckConfig): this {
this._healthCheckFn = fn;
if (config) {
this._healthCheckConfig = config;
}
return this;
}
public withRetry(config: IRetryConfig): this {
this._retryConfig = config;
return this;
}
public withStartupTimeout(ms: number): this {
this._startupTimeoutMs = ms;
return this;
}
public withLabels(labelsArg: Record<string, string>): this {
Object.assign(this.labels, labelsArg);
return this;
}
// ── Label helpers ──────────────────────────────────
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;
}
// ── Overridable hooks (for subclassing) ──────────────
protected async serviceStart(): Promise<T> {
if (this._startFn) {
return this._startFn();
}
throw new Error(`Service '${this.name}': no start function provided. Use withStart() or override serviceStart().`);
}
protected async serviceStop(): Promise<void> {
if (this._stopFn) {
return this._stopFn(this._instance as T);
}
// Default: no-op stop is fine (some services don't need explicit cleanup)
}
protected async serviceHealthCheck(): Promise<boolean> {
if (this._healthCheckFn) {
return this._healthCheckFn(this._instance as T);
}
// No health check configured — assume healthy if running
return this._state === 'running';
}
// ── Lifecycle (called by ServiceManager) ─────────────
public async start(): Promise<T> {
if (this._state === 'running') {
return this._instance as T;
}
this.setState('starting');
try {
let result: T;
if (this._startupTimeoutMs) {
result = await Promise.race([
this.serviceStart(),
new Promise<never>((_, reject) =>
setTimeout(() => reject(new Error(`Service '${this.name}': startup timed out after ${this._startupTimeoutMs}ms`)), this._startupTimeoutMs)
),
]);
} else {
result = await this.serviceStart();
}
this._instance = result;
this._startedAt = Date.now();
this._stoppedAt = undefined;
this._consecutiveHealthFailures = 0;
this._healthCheckOk = true;
this._autoRestartCount = 0;
this.setState('running');
this.emitEvent('started');
this.startHealthCheckTimer();
return result;
} catch (err) {
this._errorCount++;
this._lastError = err instanceof Error ? err.message : String(err);
this.setState('failed');
this.emitEvent('failed', { error: this._lastError });
throw err;
}
}
public async stop(): Promise<void> {
if (this._state === 'stopped' || this._state === 'stopping') {
return;
}
this.stopHealthCheckTimer();
this.clearAutoRestartTimer();
this.setState('stopping');
try {
await this.serviceStop();
} catch (err) {
logger.log('warn', `Service '${this.name}' error during stop: ${err instanceof Error ? err.message : String(err)}`);
}
this._instance = undefined;
this._stoppedAt = Date.now();
this.setState('stopped');
this.emitEvent('stopped');
}
public async checkHealth(): Promise<boolean | undefined> {
if (!this._healthCheckFn && !this.hasOverriddenHealthCheck()) {
return undefined;
}
try {
const config = this._healthCheckConfig;
const timeoutMs = config?.timeoutMs ?? 5000;
const result = await Promise.race([
this.serviceHealthCheck(),
new Promise<boolean>((_, reject) =>
setTimeout(() => reject(new Error('Health check timed out')), timeoutMs)
),
]);
this._lastHealthCheck = Date.now();
this._healthCheckOk = result;
if (result) {
this._consecutiveHealthFailures = 0;
if (this._state === 'degraded') {
this.setState('running');
this.emitEvent('recovered');
}
} else {
this._consecutiveHealthFailures++;
this.handleHealthFailure();
}
this.emitEvent('healthCheck');
return result;
} catch (err) {
this._lastHealthCheck = Date.now();
this._healthCheckOk = false;
this._consecutiveHealthFailures++;
this.handleHealthFailure();
this.emitEvent('healthCheck');
return false;
}
}
// ── Wait / readiness ──────────────────────────────────
public async waitForState(
targetState: TServiceState | TServiceState[],
timeoutMs?: number,
): Promise<void> {
const states = Array.isArray(targetState) ? targetState : [targetState];
// Already in target state
if (states.includes(this._state)) {
return;
}
return new Promise<void>((resolve, reject) => {
let timer: ReturnType<typeof setTimeout> | undefined;
let settled = false;
const settle = (fn: () => void) => {
if (settled) return;
settled = true;
subscription.unsubscribe();
if (timer) clearTimeout(timer);
fn();
};
const subscription = this.eventSubject.subscribe((event) => {
if (states.includes(event.state)) {
settle(resolve);
}
});
// Re-check after subscribing to close the race window
if (states.includes(this._state)) {
settle(resolve);
return;
}
if (timeoutMs !== undefined) {
timer = setTimeout(() => {
settle(() =>
reject(
new Error(
`Service '${this.name}': timed out waiting for state [${states.join(', ')}] after ${timeoutMs}ms (current: ${this._state})`,
),
),
);
}, timeoutMs);
}
});
}
public async waitForRunning(timeoutMs?: number): Promise<void> {
return this.waitForState('running', timeoutMs);
}
public async waitForStopped(timeoutMs?: number): Promise<void> {
return this.waitForState('stopped', timeoutMs);
}
// ── State ────────────────────────────────────────────
public get state(): TServiceState {
return this._state;
}
public get criticality(): TServiceCriticality {
return this._criticality;
}
public get dependencies(): string[] {
return [...this._dependencies];
}
public get retryConfig(): IRetryConfig | undefined {
return this._retryConfig;
}
public get startupTimeoutMs(): number | undefined {
return this._startupTimeoutMs;
}
public get instance(): T | undefined {
return this._instance;
}
public get errorCount(): number {
return this._errorCount;
}
public get retryCount(): number {
return this._retryCount;
}
public set retryCount(value: number) {
this._retryCount = value;
}
public getStatus(): IServiceStatus {
return {
name: this.name,
state: this._state,
criticality: this._criticality,
startedAt: this._startedAt,
stoppedAt: this._stoppedAt,
lastHealthCheck: this._lastHealthCheck,
healthCheckOk: this._healthCheckOk,
uptime: this._startedAt && this._state === 'running'
? Date.now() - this._startedAt
: undefined,
errorCount: this._errorCount,
lastError: this._lastError,
retryCount: this._retryCount,
dependencies: [...this._dependencies],
labels: { ...this.labels },
hasInstance: this._instance !== undefined,
};
}
// ── Internal helpers ─────────────────────────────────
private setState(state: TServiceState): void {
this._state = state;
}
private emitEvent(type: IServiceEvent['type'], extra?: Partial<IServiceEvent>): void {
this.eventSubject.next({
type,
serviceName: this.name,
state: this._state,
timestamp: Date.now(),
...extra,
});
}
private handleHealthFailure(): void {
const config = this._healthCheckConfig;
const failuresBeforeDegraded = config?.failuresBeforeDegraded ?? 3;
const failuresBeforeFailed = config?.failuresBeforeFailed ?? 5;
if (this._state === 'running' && this._consecutiveHealthFailures >= failuresBeforeDegraded) {
this.setState('degraded');
this.emitEvent('degraded');
}
if (this._consecutiveHealthFailures >= failuresBeforeFailed) {
this.setState('failed');
this._lastError = `Health check failed ${this._consecutiveHealthFailures} consecutive times`;
this.emitEvent('failed', { error: this._lastError });
this.stopHealthCheckTimer();
// Auto-restart if configured
if (config?.autoRestart) {
this.scheduleAutoRestart();
}
}
}
private scheduleAutoRestart(): void {
const config = this._healthCheckConfig;
const maxRestarts = config?.maxAutoRestarts ?? 3;
if (maxRestarts > 0 && this._autoRestartCount >= maxRestarts) {
logger.log('warn', `Service '${this.name}': max auto-restarts (${maxRestarts}) exceeded`);
return;
}
const baseDelay = config?.autoRestartDelayMs ?? 5000;
const factor = config?.autoRestartBackoffFactor ?? 2;
const delay = Math.min(baseDelay * Math.pow(factor, this._autoRestartCount), 60000);
this._autoRestartCount++;
this.emitEvent('autoRestarting', { attempt: this._autoRestartCount });
this._autoRestartTimer = setTimeout(async () => {
this._autoRestartTimer = undefined;
try {
// Stop first to clean up, then start fresh
this._instance = undefined;
this._stoppedAt = Date.now();
this.setState('stopped');
await this.start();
// Success — reset counter
this._autoRestartCount = 0;
} catch (err) {
logger.log('warn', `Service '${this.name}': auto-restart attempt ${this._autoRestartCount} failed: ${err instanceof Error ? err.message : String(err)}`);
// Schedule another attempt
this.scheduleAutoRestart();
}
}, delay);
if (this._autoRestartTimer && typeof this._autoRestartTimer === 'object' && 'unref' in this._autoRestartTimer) {
(this._autoRestartTimer as any).unref();
}
}
private clearAutoRestartTimer(): void {
if (this._autoRestartTimer) {
clearTimeout(this._autoRestartTimer);
this._autoRestartTimer = undefined;
}
}
private startHealthCheckTimer(): void {
if (!this._healthCheckFn && !this.hasOverriddenHealthCheck()) {
return;
}
const config = this._healthCheckConfig;
const intervalMs = config?.intervalMs ?? 30000;
this.stopHealthCheckTimer();
const tick = () => {
if (this._state !== 'running' && this._state !== 'degraded') {
return;
}
this.checkHealth().catch(() => {});
this._healthCheckTimer = setTimeout(tick, intervalMs);
if (this._healthCheckTimer && typeof this._healthCheckTimer === 'object' && 'unref' in this._healthCheckTimer) {
(this._healthCheckTimer as any).unref();
}
};
this._healthCheckTimer = setTimeout(tick, intervalMs);
if (this._healthCheckTimer && typeof this._healthCheckTimer === 'object' && 'unref' in this._healthCheckTimer) {
(this._healthCheckTimer as any).unref();
}
}
private stopHealthCheckTimer(): void {
if (this._healthCheckTimer) {
clearTimeout(this._healthCheckTimer);
this._healthCheckTimer = undefined;
}
}
private hasOverriddenHealthCheck(): boolean {
return this.serviceHealthCheck !== Service.prototype.serviceHealthCheck;
}
}

View File

@@ -0,0 +1,436 @@
import * as plugins from './taskbuffer.plugins.js';
import { logger } from './taskbuffer.logging.js';
import { Service } from './taskbuffer.classes.service.js';
import type {
IServiceEvent,
IServiceStatus,
IServiceManagerOptions,
IServiceManagerHealth,
IServiceOptions,
IRetryConfig,
TOverallHealth,
} from './taskbuffer.interfaces.js';
/**
* ServiceManager orchestrates multiple Service instances with:
* - Dependency-ordered startup (topological sort, level-by-level parallel)
* - Failure isolation (optional services don't crash the system)
* - Retry with exponential backoff for failed optional services
* - Reverse-dependency-ordered shutdown
* - Aggregated health status
*/
export class ServiceManager {
public readonly name: string;
public readonly serviceSubject = new plugins.smartrx.rxjs.Subject<IServiceEvent>();
private services = new Map<string, Service>();
private startupOrder: string[][] = []; // levels of service names
private options: Required<IServiceManagerOptions>;
private _startedAt: number | undefined;
private subscriptions: plugins.smartrx.rxjs.Subscription[] = [];
constructor(options?: IServiceManagerOptions) {
this.name = options?.name || 'ServiceManager';
this.options = {
name: this.name,
defaultRetry: options?.defaultRetry || { maxRetries: 3, baseDelayMs: 1000, maxDelayMs: 30000, backoffFactor: 2 },
defaultHealthCheck: options?.defaultHealthCheck || {},
startupTimeoutMs: options?.startupTimeoutMs ?? 120000,
shutdownTimeoutMs: options?.shutdownTimeoutMs ?? 30000,
};
}
// ── Service Registration ─────────────────────────────
public addService(service: Service): void {
if (this.services.has(service.name)) {
throw new Error(`Service '${service.name}' is already registered`);
}
this.services.set(service.name, service);
// Forward service events to the aggregated subject
const sub = service.eventSubject.subscribe((event) => {
this.serviceSubject.next(event);
});
this.subscriptions.push(sub);
}
public addServiceFromOptions<T>(options: IServiceOptions<T>): Service<T> {
const service = new Service<T>(options);
this.addService(service);
return service;
}
public removeService(name: string): void {
// Check no other service depends on this one
for (const [svcName, svc] of this.services) {
if (svc.dependencies.includes(name)) {
throw new Error(`Cannot remove service '${name}': service '${svcName}' depends on it`);
}
}
this.services.delete(name);
}
// ── Lifecycle ────────────────────────────────────────
public async start(): Promise<void> {
// Build startup order via topological sort
this.startupOrder = this.topologicalSort();
this._startedAt = Date.now();
const startupPromise = this.startAllLevels();
// Enforce global startup timeout
if (this.options.startupTimeoutMs) {
const timeout = new plugins.smartdelay.Timeout(this.options.startupTimeoutMs);
const timeoutPromise = timeout.promise.then(() => {
throw new Error(`${this.name}: global startup timeout exceeded (${this.options.startupTimeoutMs}ms)`);
});
try {
await Promise.race([startupPromise, timeoutPromise]);
} finally {
timeout.cancel();
}
} else {
await startupPromise;
}
}
private async startAllLevels(): Promise<void> {
const startedServices: string[] = [];
logger.log('info', `${this.name}: starting ${this.services.size} services in ${this.startupOrder.length} levels`);
for (let levelIdx = 0; levelIdx < this.startupOrder.length; levelIdx++) {
const level = this.startupOrder[levelIdx];
logger.log('info', `${this.name}: starting level ${levelIdx}: [${level.join(', ')}]`);
const results = await Promise.allSettled(
level.map(async (name) => {
const service = this.services.get(name)!;
try {
await this.startServiceWithRetry(service);
startedServices.push(name);
} catch (err) {
if (service.criticality === 'critical') {
throw err;
}
// Optional service — log and continue
logger.log('warn', `${this.name}: optional service '${name}' failed to start: ${err instanceof Error ? err.message : String(err)}`);
}
}),
);
// Check if any critical service failed
for (let i = 0; i < results.length; i++) {
const result = results[i];
if (result.status === 'rejected') {
const name = level[i];
const service = this.services.get(name);
if (service && service.criticality === 'critical') {
logger.log('error', `${this.name}: critical service '${name}' failed, aborting startup`);
// Rollback: stop all started services in reverse order
await this.stopServices(startedServices.reverse());
throw new Error(`Critical service '${name}' failed to start: ${result.reason instanceof Error ? result.reason.message : String(result.reason)}`);
}
}
}
}
const statuses = this.getAllStatuses();
const running = statuses.filter((s) => s.state === 'running').length;
const failed = statuses.filter((s) => s.state === 'failed').length;
logger.log('info', `${this.name}: startup complete — ${running} running, ${failed} failed`);
}
public async stop(): Promise<void> {
logger.log('info', `${this.name}: stopping all services`);
// Stop in reverse startup order
const reversedLevels = [...this.startupOrder].reverse();
for (const level of reversedLevels) {
const runningInLevel = level.filter((name) => {
const svc = this.services.get(name);
return svc && svc.state !== 'stopped';
});
if (runningInLevel.length === 0) continue;
await Promise.allSettled(
runningInLevel.map(async (name) => {
const service = this.services.get(name)!;
try {
const timeout = new plugins.smartdelay.Timeout(this.options.shutdownTimeoutMs);
const timeoutPromise = timeout.promise.then(() => {
throw new Error(`Timeout stopping service '${name}'`);
});
try {
await Promise.race([service.stop(), timeoutPromise]);
} finally {
timeout.cancel();
}
} catch (err) {
logger.log('warn', `${this.name}: error stopping '${name}': ${err instanceof Error ? err.message : String(err)}`);
}
}),
);
}
// Clean up subscriptions
for (const sub of this.subscriptions) {
sub.unsubscribe();
}
this.subscriptions = [];
this._startedAt = undefined;
logger.log('info', `${this.name}: all services stopped`);
}
// ── Querying ─────────────────────────────────────────
public getService(name: string): Service | undefined {
return this.services.get(name);
}
public getServiceStatus(name: string): IServiceStatus | undefined {
return this.services.get(name)?.getStatus();
}
public getAllStatuses(): IServiceStatus[] {
return Array.from(this.services.values()).map((s) => s.getStatus());
}
public getServicesByLabel(key: string, value: string): Service[] {
return Array.from(this.services.values()).filter((s) => s.labels[key] === value);
}
public getServicesStatusByLabel(key: string, value: string): IServiceStatus[] {
return this.getServicesByLabel(key, value).map((s) => s.getStatus());
}
public getHealth(): IServiceManagerHealth {
const statuses = this.getAllStatuses();
let overall: TOverallHealth = 'healthy';
const hasCriticalDown = statuses.some(
(s) => s.criticality === 'critical' && s.state !== 'running' && s.state !== 'stopped',
);
const hasAnyDown = statuses.some(
(s) => s.state !== 'running' && s.state !== 'stopped',
);
if (hasCriticalDown) {
overall = 'unhealthy';
} else if (hasAnyDown) {
overall = 'degraded';
}
return {
overall,
services: statuses,
startedAt: this._startedAt,
uptime: this._startedAt ? Date.now() - this._startedAt : undefined,
};
}
// ── Runtime Operations ───────────────────────────────
public async restartService(name: string): Promise<void> {
const service = this.services.get(name);
if (!service) {
throw new Error(`Service '${name}' not found`);
}
// Find all transitive dependents
const dependents = this.getTransitiveDependents(name);
// Stop dependents in reverse dependency order
const dependentLevels = this.getLevelsForServices(dependents).reverse();
for (const level of dependentLevels) {
await Promise.allSettled(
level.map((depName) => {
const svc = this.services.get(depName);
return svc && svc.state !== 'stopped' ? svc.stop() : Promise.resolve();
}),
);
}
// Stop the target service
await service.stop();
// Start the target service
await this.startServiceWithRetry(service);
// Restart dependents in dependency order
const dependentLevelsForward = this.getLevelsForServices(dependents);
for (const level of dependentLevelsForward) {
await Promise.allSettled(
level.map(async (depName) => {
const svc = this.services.get(depName)!;
try {
await this.startServiceWithRetry(svc);
} catch (err) {
logger.log('warn', `${this.name}: failed to restart dependent '${depName}': ${err instanceof Error ? err.message : String(err)}`);
}
}),
);
}
}
// ── Internal helpers ─────────────────────────────────
private async startServiceWithRetry(service: Service): Promise<void> {
const retryConfig = service.retryConfig || this.options.defaultRetry;
const maxRetries = retryConfig.maxRetries ?? 3;
const baseDelay = retryConfig.baseDelayMs ?? 1000;
const maxDelay = retryConfig.maxDelayMs ?? 30000;
const factor = retryConfig.backoffFactor ?? 2;
let lastError: Error | undefined;
for (let attempt = 0; attempt <= maxRetries; attempt++) {
try {
await service.start();
return;
} catch (err) {
lastError = err instanceof Error ? err : new Error(String(err));
service.retryCount = attempt + 1;
if (attempt < maxRetries) {
const delay = Math.min(baseDelay * Math.pow(factor, attempt), maxDelay);
const jitter = 0.8 + Math.random() * 0.4;
const actualDelay = Math.floor(delay * jitter);
service.eventSubject.next({
type: 'retrying',
serviceName: service.name,
state: service.state,
timestamp: Date.now(),
error: lastError.message,
attempt: attempt + 1,
});
logger.log('info', `${this.name}: retrying '${service.name}' in ${actualDelay}ms (attempt ${attempt + 1}/${maxRetries})`);
await plugins.smartdelay.delayFor(actualDelay);
}
}
}
throw lastError!;
}
private async stopServices(names: string[]): Promise<void> {
await Promise.allSettled(
names.map(async (name) => {
const service = this.services.get(name);
if (service && service.state !== 'stopped') {
try {
await service.stop();
} catch (err) {
logger.log('warn', `${this.name}: error stopping '${name}' during rollback: ${err instanceof Error ? err.message : String(err)}`);
}
}
}),
);
}
/**
* Topological sort using Kahn's algorithm.
* Returns levels of service names — services within a level can start in parallel.
*/
private topologicalSort(): string[][] {
const names = new Set(this.services.keys());
const inDegree = new Map<string, number>();
const dependents = new Map<string, string[]>(); // dep -> services that depend on it
// Initialize
for (const name of names) {
inDegree.set(name, 0);
dependents.set(name, []);
}
// Build graph
for (const [name, service] of this.services) {
for (const dep of service.dependencies) {
if (!names.has(dep)) {
throw new Error(`Service '${name}' depends on '${dep}', which is not registered`);
}
inDegree.set(name, (inDegree.get(name) || 0) + 1);
dependents.get(dep)!.push(name);
}
}
// Process level by level
const levels: string[][] = [];
const remaining = new Set(names);
while (remaining.size > 0) {
const level: string[] = [];
for (const name of remaining) {
if ((inDegree.get(name) || 0) === 0) {
level.push(name);
}
}
if (level.length === 0) {
// Cycle detected
const cycleNodes = Array.from(remaining).join(', ');
throw new Error(`Circular dependency detected involving services: ${cycleNodes}`);
}
// Remove this level's nodes and update in-degrees
for (const name of level) {
remaining.delete(name);
for (const dependent of dependents.get(name) || []) {
inDegree.set(dependent, (inDegree.get(dependent) || 0) - 1);
}
}
levels.push(level);
}
return levels;
}
/**
* Get all services that transitively depend on the given service.
*/
private getTransitiveDependents(name: string): string[] {
const result = new Set<string>();
const queue = [name];
while (queue.length > 0) {
const current = queue.shift()!;
for (const [svcName, svc] of this.services) {
if (svc.dependencies.includes(current) && !result.has(svcName)) {
result.add(svcName);
queue.push(svcName);
}
}
}
return Array.from(result);
}
/**
* Organize a set of service names into dependency-ordered levels.
*/
private getLevelsForServices(names: string[]): string[][] {
if (names.length === 0) return [];
const nameSet = new Set(names);
const levels: string[][] = [];
// Simple approach: filter the global startup order to include only the given names
for (const level of this.startupOrder) {
const filtered = level.filter((n) => nameSet.has(n));
if (filtered.length > 0) {
levels.push(filtered);
}
}
return levels;
}
}

View File

@@ -1,6 +1,8 @@
import * as plugins from './taskbuffer.plugins.js';
import { BufferRunner } from './taskbuffer.classes.bufferrunner.js';
import { CycleCounter } from './taskbuffer.classes.cyclecounter.js';
import { TaskStep, type ITaskStep } from './taskbuffer.classes.taskstep.js';
import type { ITaskMetadata, ITaskEvent, TTaskEventType } from './taskbuffer.interfaces.js';
import { logger } from './taskbuffer.logging.js';
@@ -14,18 +16,21 @@ export interface ITaskSetupFunction<T = undefined> {
export type TPreOrAfterTaskFunction = () => Task<any>;
export class Task<T = undefined> {
public static extractTask<T = undefined>(
preOrAfterTaskArg: Task<T> | TPreOrAfterTaskFunction
): Task<T> {
// Type helper to extract step names from array
export type StepNames<T> = T extends ReadonlyArray<{ name: infer N }> ? N : never;
export class Task<T = undefined, TSteps extends ReadonlyArray<{ name: string; description: string; percentage: number }> = [], TData extends Record<string, unknown> = Record<string, unknown>> {
public static extractTask<T = undefined, TSteps extends ReadonlyArray<{ name: string; description: string; percentage: number }> = []>(
preOrAfterTaskArg: Task<T, TSteps, any> | TPreOrAfterTaskFunction,
): Task<T, TSteps, any> {
switch (true) {
case !preOrAfterTaskArg:
return null;
case preOrAfterTaskArg instanceof Task:
return preOrAfterTaskArg as Task<T>;
return preOrAfterTaskArg as Task<T, TSteps, any>;
case typeof preOrAfterTaskArg === 'function':
const taskFunction = preOrAfterTaskArg as TPreOrAfterTaskFunction;
return taskFunction();
return taskFunction() as unknown as Task<T, TSteps, any>;
default:
return null;
}
@@ -37,7 +42,7 @@ export class Task<T = undefined> {
return done.promise;
};
public static isTask = (taskArg: Task<any>): boolean => {
public static isTask = (taskArg: Task<any, any, any>): boolean => {
if (taskArg instanceof Task && typeof taskArg.taskFunction === 'function') {
return true;
} else {
@@ -45,9 +50,9 @@ export class Task<T = undefined> {
}
};
public static isTaskTouched<T = undefined>(
taskArg: Task<T> | TPreOrAfterTaskFunction,
touchedTasksArray: Task<T>[]
public static isTaskTouched<T = undefined, TSteps extends ReadonlyArray<{ name: string; description: string; percentage: number }> = []>(
taskArg: Task<T, TSteps, any> | TPreOrAfterTaskFunction,
touchedTasksArray: Task<T, TSteps, any>[],
): boolean {
const taskToCheck = Task.extractTask(taskArg);
let result = false;
@@ -59,53 +64,55 @@ export class Task<T = undefined> {
return result;
}
public static runTask = async <T>(
taskArg: Task<T> | TPreOrAfterTaskFunction,
optionsArg: { x?: any; touchedTasksArray?: Task<T>[] }
public static runTask = async <T, TSteps extends ReadonlyArray<{ name: string; description: string; percentage: number }> = []>(
taskArg: Task<T, TSteps, any> | TPreOrAfterTaskFunction,
optionsArg: { x?: any; touchedTasksArray?: Task<T, TSteps, any>[] },
) => {
const taskToRun = Task.extractTask(taskArg);
const done = plugins.smartpromise.defer();
// Wait for all blocking tasks to finish
for (const task of taskToRun.blockingTasks) {
await task.finished;
}
if (!taskToRun.setupValue && taskToRun.taskSetup) {
taskToRun.setupValue = await taskToRun.taskSetup();
}
if (taskToRun.execDelay) {
await plugins.smartdelay.delayFor(taskToRun.execDelay);
}
taskToRun.running = true;
taskToRun.runCount++;
taskToRun.lastRun = new Date();
done.promise.then(async () => {
taskToRun.running = false;
// Reset steps and error state at the beginning of task execution
taskToRun.resetSteps();
taskToRun.lastError = undefined;
taskToRun.emitEvent('started');
// When the task has finished running, resolve the finished promise
taskToRun.resolveFinished();
done.promise
.then(async () => {
taskToRun.running = false;
// Create a new finished promise for the next run
taskToRun.finished = new Promise((resolve) => {
taskToRun.resolveFinished = resolve;
// Complete all steps when task finishes
taskToRun.completeAllSteps();
taskToRun.emitEvent(taskToRun.lastError ? 'failed' : 'completed');
})
.catch((err) => {
taskToRun.running = false;
taskToRun.emitEvent('failed', { error: err instanceof Error ? err.message : String(err) });
});
});
const options = {
...{ x: undefined, touchedTasksArray: [] },
...optionsArg,
};
const x = options.x;
const touchedTasksArray: Task<T>[] = options.touchedTasksArray;
const touchedTasksArray: Task<T, TSteps, any>[] = options.touchedTasksArray;
touchedTasksArray.push(taskToRun);
const localDeferred = plugins.smartpromise.defer();
localDeferred.promise
.then(() => {
if (taskToRun.preTask && !Task.isTaskTouched(taskToRun.preTask, touchedTasksArray)) {
if (
taskToRun.preTask &&
!Task.isTaskTouched(taskToRun.preTask, touchedTasksArray)
) {
return Task.runTask(taskToRun.preTask, { x, touchedTasksArray });
} else {
const done2 = plugins.smartpromise.defer();
@@ -117,12 +124,24 @@ export class Task<T = undefined> {
try {
return await taskToRun.taskFunction(x, taskToRun.setupValue);
} catch (e) {
console.log(e);
taskToRun.lastError = e instanceof Error ? e : new Error(String(e));
taskToRun.errorCount++;
logger.log('error', `Task "${taskToRun.name || 'unnamed'}" failed: ${taskToRun.lastError.message}`);
if (taskToRun.catchErrors) {
return undefined;
}
throw e;
}
})
.then((x) => {
if (taskToRun.afterTask && !Task.isTaskTouched(taskToRun.afterTask, touchedTasksArray)) {
return Task.runTask(taskToRun.afterTask, { x: x, touchedTasksArray: touchedTasksArray });
if (
taskToRun.afterTask &&
!Task.isTaskTouched(taskToRun.afterTask, touchedTasksArray)
) {
return Task.runTask(taskToRun.afterTask, {
x: x,
touchedTasksArray: touchedTasksArray,
});
} else {
const done2 = plugins.smartpromise.defer();
done2.resolve(x);
@@ -133,10 +152,18 @@ export class Task<T = undefined> {
done.resolve(x);
})
.catch((err) => {
console.log(err);
done.reject(err);
});
localDeferred.resolve();
return await done.promise;
try {
return await done.promise;
} catch (err) {
if (taskToRun.catchErrors) {
return undefined;
}
throw err;
}
};
public name: string;
@@ -146,53 +173,111 @@ export class Task<T = undefined> {
public cronJob: plugins.smarttime.CronJob;
public bufferMax: number;
public execDelay: number;
public timeout: number;
public preTask: Task<T> | TPreOrAfterTaskFunction;
public afterTask: Task<T> | TPreOrAfterTaskFunction;
public data: TData;
// Add a list to store the blocking tasks
public blockingTasks: Task[] = [];
// Add a promise that will resolve when the task has finished
private finished: Promise<void>;
private resolveFinished: () => void;
public preTask: Task<T, any, any> | TPreOrAfterTaskFunction;
public afterTask: Task<T, any, any> | TPreOrAfterTaskFunction;
public running: boolean = false;
public bufferRunner = new BufferRunner(this);
public cycleCounter = new CycleCounter(this);
public lastRun?: Date;
public runCount: number = 0;
// Error handling
public catchErrors: boolean = false;
public lastError?: Error;
public errorCount: number = 0;
public labels: Record<string, string> = {};
public readonly eventSubject = new plugins.smartrx.rxjs.Subject<ITaskEvent>();
public get idle() {
return !this.running;
}
public clearError(): void {
this.lastError = undefined;
}
public setLabel(key: string, value: string): void {
this.labels[key] = value;
}
public getLabel(key: string): string | undefined {
return this.labels[key];
}
public removeLabel(key: string): boolean {
if (key in this.labels) {
delete this.labels[key];
return true;
}
return false;
}
public hasLabel(key: string, value?: string): boolean {
if (value !== undefined) {
return this.labels[key] === value;
}
return key in this.labels;
}
private emitEvent(type: TTaskEventType, extra?: Partial<ITaskEvent>): void {
this.eventSubject.next({
type,
task: this.getMetadata(),
timestamp: Date.now(),
...extra,
});
}
public taskSetup: ITaskSetupFunction<T>;
public setupValue: T;
// Step tracking properties
private steps = new Map<string, TaskStep>();
private stepProgress = new Map<string, number>();
public currentStepName?: string;
private providedSteps?: TSteps;
constructor(optionsArg: {
taskFunction: ITaskFunction<T>;
preTask?: Task<T> | TPreOrAfterTaskFunction;
afterTask?: Task<T> | TPreOrAfterTaskFunction;
preTask?: Task<T, any, any> | TPreOrAfterTaskFunction;
afterTask?: Task<T, any, any> | TPreOrAfterTaskFunction;
buffered?: boolean;
bufferMax?: number;
execDelay?: number;
name?: string;
data?: TData;
taskSetup?: ITaskSetupFunction<T>;
steps?: TSteps;
catchErrors?: boolean;
labels?: Record<string, string>;
}) {
this.taskFunction = optionsArg.taskFunction;
this.preTask = optionsArg.preTask;
this.afterTask = optionsArg.afterTask;
this.buffered = optionsArg.buffered;
this.bufferMax = optionsArg.bufferMax;
this.execDelay = optionsArg.execDelay;
this.name = optionsArg.name;
this.data = optionsArg.data ?? ({} as TData);
this.taskSetup = optionsArg.taskSetup;
this.catchErrors = optionsArg.catchErrors ?? false;
this.labels = optionsArg.labels ? { ...optionsArg.labels } : {};
// Create the finished promise
this.finished = new Promise((resolve) => {
this.resolveFinished = resolve;
});
// 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);
}
}
}
public trigger(x?: any): Promise<any> {
@@ -204,10 +289,116 @@ export class Task<T = undefined> {
}
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> {
return this.bufferRunner.trigger(x);
}
// Step notification method with typed step names
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);
}
}
// Start new step
const step = this.steps.get(stepName as string);
if (step) {
step.start();
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';
}
});
}
}

View File

@@ -27,14 +27,20 @@ export class Taskchain extends Task {
let taskCounter = 0; // counter for iterating async over the taskArray
const iterateTasks = (x: any) => {
if (typeof this.taskArray[taskCounter] !== 'undefined') {
console.log(this.name + ' running: Task' + this.taskArray[taskCounter].name);
logger.log('info', `${this.name} running: Task ${this.taskArray[taskCounter].name}`);
this.taskArray[taskCounter].trigger(x).then((x) => {
logger.log('info', this.taskArray[taskCounter].name);
taskCounter++;
iterateTasks(x);
}).catch((err) => {
const chainError = new Error(
`Taskchain "${this.name}": task "${this.taskArray[taskCounter].name || 'unnamed'}" (index ${taskCounter}) failed: ${err instanceof Error ? err.message : String(err)}`
);
(chainError as any).cause = err;
done.reject(chainError);
});
} else {
console.log('Taskchain "' + this.name + '" completed successfully');
logger.log('info', `Taskchain "${this.name}" completed successfully`);
done.resolve(x);
}
};
@@ -49,10 +55,15 @@ export class Taskchain extends Task {
addTask(taskArg: Task) {
this.taskArray.push(taskArg);
}
removeTask(taskArg: Task) {
// TODO:
removeTask(taskArg: Task): boolean {
const index = this.taskArray.indexOf(taskArg);
if (index === -1) {
return false;
}
this.taskArray.splice(index, 1);
return true;
}
shiftTask() {
// TODO:
shiftTask(): Task | undefined {
return this.taskArray.shift();
}
}

View File

@@ -0,0 +1,164 @@
import type { Task } from './taskbuffer.classes.task.js';
import type { ITaskConstraintGroupOptions, IRateLimitConfig, TResultSharingMode } from './taskbuffer.interfaces.js';
export class TaskConstraintGroup<TData extends Record<string, unknown> = Record<string, unknown>> {
public name: string;
public maxConcurrent: number;
public cooldownMs: number;
public rateLimit: IRateLimitConfig | null;
public resultSharingMode: TResultSharingMode;
private constraintKeyForExecution: (task: Task<any, any, TData>, input?: any) => string | null | undefined;
private shouldExecuteFn?: (task: Task<any, any, TData>, input?: any) => boolean | Promise<boolean>;
private runningCounts = new Map<string, number>();
private lastCompletionTimes = new Map<string, number>();
private completionTimestamps = new Map<string, number[]>();
private lastResults = new Map<string, { result: any; timestamp: number }>();
constructor(options: ITaskConstraintGroupOptions<TData>) {
this.name = options.name;
this.constraintKeyForExecution = options.constraintKeyForExecution;
this.maxConcurrent = options.maxConcurrent ?? Infinity;
this.cooldownMs = options.cooldownMs ?? 0;
this.shouldExecuteFn = options.shouldExecute;
this.rateLimit = options.rateLimit ?? null;
this.resultSharingMode = options.resultSharingMode ?? 'none';
}
public getConstraintKey(task: Task<any, any, TData>, input?: any): string | null {
const key = this.constraintKeyForExecution(task, input);
return key ?? null;
}
public async checkShouldExecute(task: Task<any, any, TData>, input?: any): Promise<boolean> {
if (!this.shouldExecuteFn) {
return true;
}
return this.shouldExecuteFn(task, input);
}
public canRun(subGroupKey: string): boolean {
const running = this.runningCounts.get(subGroupKey) ?? 0;
if (running >= this.maxConcurrent) {
return false;
}
if (this.cooldownMs > 0) {
const lastCompletion = this.lastCompletionTimes.get(subGroupKey);
if (lastCompletion !== undefined) {
const elapsed = Date.now() - lastCompletion;
if (elapsed < this.cooldownMs) {
return false;
}
}
}
if (this.rateLimit) {
this.pruneCompletionTimestamps(subGroupKey);
const timestamps = this.completionTimestamps.get(subGroupKey);
const completedInWindow = timestamps ? timestamps.length : 0;
const running = this.runningCounts.get(subGroupKey) ?? 0;
if (completedInWindow + running >= this.rateLimit.maxPerWindow) {
return false;
}
}
return true;
}
public acquireSlot(subGroupKey: string): void {
const current = this.runningCounts.get(subGroupKey) ?? 0;
this.runningCounts.set(subGroupKey, current + 1);
}
public releaseSlot(subGroupKey: string): void {
const current = this.runningCounts.get(subGroupKey) ?? 0;
const next = Math.max(0, current - 1);
if (next === 0) {
this.runningCounts.delete(subGroupKey);
} else {
this.runningCounts.set(subGroupKey, next);
}
this.lastCompletionTimes.set(subGroupKey, Date.now());
if (this.rateLimit) {
const timestamps = this.completionTimestamps.get(subGroupKey) ?? [];
timestamps.push(Date.now());
this.completionTimestamps.set(subGroupKey, timestamps);
}
}
public getCooldownRemaining(subGroupKey: string): number {
if (this.cooldownMs <= 0) {
return 0;
}
const lastCompletion = this.lastCompletionTimes.get(subGroupKey);
if (lastCompletion === undefined) {
return 0;
}
const elapsed = Date.now() - lastCompletion;
return Math.max(0, this.cooldownMs - elapsed);
}
public getRunningCount(subGroupKey: string): number {
return this.runningCounts.get(subGroupKey) ?? 0;
}
// Rate limit helpers
private pruneCompletionTimestamps(subGroupKey: string): void {
const timestamps = this.completionTimestamps.get(subGroupKey);
if (!timestamps || !this.rateLimit) return;
const cutoff = Date.now() - this.rateLimit.windowMs;
let i = 0;
while (i < timestamps.length && timestamps[i] <= cutoff) {
i++;
}
if (i > 0) {
timestamps.splice(0, i);
}
}
public getRateLimitDelay(subGroupKey: string): number {
if (!this.rateLimit) return 0;
this.pruneCompletionTimestamps(subGroupKey);
const timestamps = this.completionTimestamps.get(subGroupKey);
const completedInWindow = timestamps ? timestamps.length : 0;
const running = this.runningCounts.get(subGroupKey) ?? 0;
if (completedInWindow + running < this.rateLimit.maxPerWindow) {
return 0;
}
// If only running tasks fill the window (no completions yet), we can't compute a delay
if (!timestamps || timestamps.length === 0) {
return 1; // minimal delay; drain will re-check after running tasks complete
}
// The oldest timestamp in the window determines when a slot opens
const oldestInWindow = timestamps[0];
const expiry = oldestInWindow + this.rateLimit.windowMs;
return Math.max(0, expiry - Date.now());
}
public getNextAvailableDelay(subGroupKey: string): number {
return Math.max(this.getCooldownRemaining(subGroupKey), this.getRateLimitDelay(subGroupKey));
}
// Result sharing helpers
public recordResult(subGroupKey: string, result: any): void {
if (this.resultSharingMode === 'none') return;
this.lastResults.set(subGroupKey, { result, timestamp: Date.now() });
}
public getLastResult(subGroupKey: string): { result: any; timestamp: number } | undefined {
return this.lastResults.get(subGroupKey);
}
public hasResultSharing(): boolean {
return this.resultSharingMode !== 'none';
}
public reset(): void {
this.runningCounts.clear();
this.lastCompletionTimes.clear();
this.completionTimestamps.clear();
this.lastResults.clear();
}
}

View File

@@ -1,6 +1,7 @@
import * as plugins from './taskbuffer.plugins.js';
import { Task, type ITaskFunction } from './taskbuffer.classes.task.js';
import { logger } from './taskbuffer.logging.js';
export class TaskDebounced<T = unknown> extends Task {
private _debouncedTaskFunction: ITaskFunction;
@@ -19,9 +20,20 @@ export class TaskDebounced<T = unknown> extends Task {
});
this.taskFunction = optionsArg.taskFunction;
this._observableIntake.observable
.pipe(plugins.smartrx.rxjs.ops.debounceTime(optionsArg.debounceTimeInMillis))
.subscribe((x) => {
this.taskFunction(x);
.pipe(
plugins.smartrx.rxjs.ops.debounceTime(optionsArg.debounceTimeInMillis),
)
.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)}`);
},
});
}
}

View File

@@ -1,6 +1,12 @@
import * as plugins from './taskbuffer.plugins.js';
import { Task } from './taskbuffer.classes.task.js';
import { AbstractDistributedCoordinator, type IDistributedTaskRequestResult } from './taskbuffer.classes.distributedcoordinator.js';
import { TaskConstraintGroup } from './taskbuffer.classes.taskconstraintgroup.js';
import {
AbstractDistributedCoordinator,
type IDistributedTaskRequestResult,
} from './taskbuffer.classes.distributedcoordinator.js';
import type { ITaskMetadata, ITaskExecutionReport, IScheduledTaskInfo, ITaskEvent, IConstrainedTaskEntry } from './taskbuffer.interfaces.js';
import { logger } from './taskbuffer.logging.js';
export interface ICronJob {
cronString: string;
@@ -13,43 +19,231 @@ export interface ITaskManagerConstructorOptions {
}
export class TaskManager {
public randomId = plugins.isounique.uni();
public taskMap = new plugins.lik.ObjectMap<Task>();
public randomId = plugins.smartunique.shortId();
public taskMap = new plugins.lik.ObjectMap<Task<any, any, any>>();
public readonly taskSubject = new plugins.smartrx.rxjs.Subject<ITaskEvent>();
private taskSubscriptions = new Map<Task<any, any, any>, plugins.smartrx.rxjs.Subscription>();
private cronJobManager = new plugins.smarttime.CronManager();
public options: ITaskManagerConstructorOptions = {
distributedCoordinator: null,
};
// Constraint system
public constraintGroups: TaskConstraintGroup<any>[] = [];
private constraintQueue: IConstrainedTaskEntry[] = [];
private drainTimer: ReturnType<typeof setTimeout> | null = null;
constructor(options: ITaskManagerConstructorOptions = {}) {
this.options = Object.assign(this.options, options);
}
public getTaskByName(taskName: string): Task {
public getTaskByName(taskName: string): Task<any, any, any> {
return this.taskMap.findSync((task) => task.name === taskName);
}
public addTask(task: Task): void {
public addTask(task: Task<any, any, any>): void {
if (!task.name) {
throw new Error('Task must have a name to be added to taskManager');
}
this.taskMap.add(task);
const subscription = task.eventSubject.subscribe((event) => {
this.taskSubject.next(event);
});
this.taskSubscriptions.set(task, subscription);
}
public addAndScheduleTask(task: Task, cronString: string) {
public removeTask(task: Task<any, any, any>): void {
this.taskMap.remove(task);
const subscription = this.taskSubscriptions.get(task);
if (subscription) {
subscription.unsubscribe();
this.taskSubscriptions.delete(task);
}
}
public addAndScheduleTask(task: Task<any, any, any>, cronString: string) {
this.addTask(task);
this.scheduleTaskByName(task.name, cronString);
}
// Constraint group management
public addConstraintGroup(group: TaskConstraintGroup<any>): void {
this.constraintGroups.push(group);
}
public removeConstraintGroup(name: string): void {
this.constraintGroups = this.constraintGroups.filter((g) => g.name !== name);
}
// Core constraint evaluation
public async triggerTaskConstrained(task: Task<any, any, any>, input?: any): Promise<any> {
// Gather applicable constraints
const applicableGroups: Array<{ group: TaskConstraintGroup<any>; key: string }> = [];
for (const group of this.constraintGroups) {
const key = group.getConstraintKey(task, input);
if (key !== null) {
applicableGroups.push({ group, key });
}
}
// No constraints apply → check shouldExecute then trigger directly
if (applicableGroups.length === 0) {
const shouldRun = await this.checkAllShouldExecute(task, input);
if (!shouldRun) {
return undefined;
}
return task.trigger(input);
}
// Check if all constraints allow running
const allCanRun = applicableGroups.every(({ group, key }) => group.canRun(key));
if (allCanRun) {
return this.executeWithConstraintTracking(task, input, applicableGroups);
}
// Blocked → enqueue with deferred promise and cached constraint keys
const deferred = plugins.smartpromise.defer<any>();
const constraintKeys = new Map<string, string>();
for (const { group, key } of applicableGroups) {
constraintKeys.set(group.name, key);
}
this.constraintQueue.push({ task, input, deferred, constraintKeys });
return deferred.promise;
}
private async checkAllShouldExecute(task: Task<any, any, any>, input?: any): Promise<boolean> {
for (const group of this.constraintGroups) {
const shouldRun = await group.checkShouldExecute(task, input);
if (!shouldRun) {
return false;
}
}
return true;
}
private async executeWithConstraintTracking(
task: Task<any, any, any>,
input: any,
groups: Array<{ group: TaskConstraintGroup<any>; key: string }>,
): Promise<any> {
// Acquire slots synchronously to prevent race conditions
for (const { group, key } of groups) {
group.acquireSlot(key);
}
// Check shouldExecute after acquiring slots
const shouldRun = await this.checkAllShouldExecute(task, input);
if (!shouldRun) {
// Release slots and drain queue
for (const { group, key } of groups) {
group.releaseSlot(key);
}
this.drainConstraintQueue();
return undefined;
}
try {
const result = await task.trigger(input);
// Record result for groups with result sharing (only on true success, not caught errors)
if (!task.lastError) {
for (const { group, key } of groups) {
group.recordResult(key, result);
}
}
return result;
} finally {
// Release slots
for (const { group, key } of groups) {
group.releaseSlot(key);
}
this.drainConstraintQueue();
}
}
private drainConstraintQueue(): void {
let shortestCooldown = Infinity;
const stillQueued: IConstrainedTaskEntry[] = [];
for (const entry of this.constraintQueue) {
const applicableGroups: Array<{ group: TaskConstraintGroup<any>; key: string }> = [];
for (const group of this.constraintGroups) {
const key = group.getConstraintKey(entry.task, entry.input);
if (key !== null) {
applicableGroups.push({ group, key });
}
}
// No constraints apply anymore (group removed?) → check shouldExecute then run
if (applicableGroups.length === 0) {
this.checkAllShouldExecute(entry.task, entry.input).then((shouldRun) => {
if (!shouldRun) {
entry.deferred.resolve(undefined);
return;
}
entry.task.trigger(entry.input).then(
(result) => entry.deferred.resolve(result),
(err) => entry.deferred.reject(err),
);
});
continue;
}
// Check result sharing — if any applicable group has a shared result, resolve immediately
const sharingGroups = applicableGroups.filter(({ group }) => group.hasResultSharing());
if (sharingGroups.length > 0) {
const groupWithResult = sharingGroups.find(({ group, key }) =>
group.getLastResult(key) !== undefined
);
if (groupWithResult) {
entry.deferred.resolve(groupWithResult.group.getLastResult(groupWithResult.key)!.result);
continue;
}
}
const allCanRun = applicableGroups.every(({ group, key }) => group.canRun(key));
if (allCanRun) {
// executeWithConstraintTracking handles shouldExecute check internally
this.executeWithConstraintTracking(entry.task, entry.input, applicableGroups).then(
(result) => entry.deferred.resolve(result),
(err) => entry.deferred.reject(err),
);
} else {
stillQueued.push(entry);
// Track shortest delay for timer scheduling (cooldown + rate limit)
for (const { group, key } of applicableGroups) {
const remaining = group.getNextAvailableDelay(key);
if (remaining > 0 && remaining < shortestCooldown) {
shortestCooldown = remaining;
}
}
}
}
this.constraintQueue = stillQueued;
// Schedule next drain if there are cooldown-blocked entries
if (this.drainTimer) {
clearTimeout(this.drainTimer);
this.drainTimer = null;
}
if (stillQueued.length > 0 && shortestCooldown < Infinity) {
this.drainTimer = setTimeout(() => {
this.drainTimer = null;
this.drainConstraintQueue();
}, shortestCooldown + 1);
}
}
public async triggerTaskByName(taskName: string): Promise<any> {
const taskToTrigger = this.getTaskByName(taskName);
if (!taskToTrigger) {
throw new Error(`No task with the name ${taskName} found.`);
}
return taskToTrigger.trigger();
return this.triggerTaskConstrained(taskToTrigger);
}
public async triggerTask(task: Task) {
return task.trigger();
public async triggerTask(task: Task<any, any, any>) {
return this.triggerTaskConstrained(task);
}
public scheduleTaskByName(taskName: string, cronString: string) {
@@ -60,38 +254,50 @@ export class TaskManager {
this.handleTaskScheduling(taskToSchedule, cronString);
}
private handleTaskScheduling(task: Task, cronString: string) {
private handleTaskScheduling(task: Task<any, 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);
const announcementResult = await this.performDistributedConsultation(
task,
triggerTime,
);
if (!announcementResult.shouldTrigger) {
console.log('Distributed coordinator result: NOT EXECUTING');
logger.log('info', 'Distributed coordinator result: NOT EXECUTING');
return;
} else {
console.log('Distributed coordinator result: CHOSEN AND EXECUTING');
logger.log('info', 'Distributed coordinator result: CHOSEN AND EXECUTING');
}
}
await task.trigger();
}
try {
await this.triggerTaskConstrained(task);
} catch (err) {
logger.log('error', `TaskManager: scheduled task "${task.name || 'unnamed'}" failed: ${err instanceof Error ? err.message : String(err)}`);
}
},
);
task.cronJob = cronJob;
}
private logTaskState(task: Task) {
console.log(`Taskbuffer schedule triggered task >>${task.name}<<`);
private logTaskState(task: Task<any, any, any>) {
logger.log('info', `Taskbuffer schedule triggered task >>${task.name}<<`);
const bufferState = task.buffered
? `buffered with max ${task.bufferMax} buffered calls`
: `unbuffered`;
console.log(`Task >>${task.name}<< is ${bufferState}`);
logger.log('info', `Task >>${task.name}<< is ${bufferState}`);
}
private async performDistributedConsultation(task: Task, triggerTime: number): Promise<IDistributedTaskRequestResult> {
console.log('Found a distributed coordinator, performing consultation.');
private async performDistributedConsultation(
task: Task<any, 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,
@@ -112,7 +318,7 @@ export class TaskManager {
}
}
public async descheduleTask(task: Task) {
public async descheduleTask(task: Task<any, any, any>) {
await this.descheduleTaskByName(task.name);
}
@@ -133,5 +339,139 @@ export class TaskManager {
if (this.options.distributedCoordinator) {
await this.options.distributedCoordinator.stop();
}
for (const [, subscription] of this.taskSubscriptions) {
subscription.unsubscribe();
}
this.taskSubscriptions.clear();
if (this.drainTimer) {
clearTimeout(this.drainTimer);
this.drainTimer = null;
}
}
// Get metadata for a specific task
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, 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, any>,
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();
try {
// Execute the task through constraints
const result = await this.triggerTaskConstrained(task);
// 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;
}
}
}

View File

@@ -13,7 +13,9 @@ export class Taskparallel extends Task {
this.taskArray.forEach(function (taskArg) {
promiseArray.push(taskArg.trigger());
});
Promise.all(promiseArray).then(done.resolve);
Promise.all(promiseArray)
.then((results) => done.resolve(results))
.catch((err) => done.reject(err));
return done.promise;
},
},

View File

@@ -1,63 +0,0 @@
import * as plugins from './taskbuffer.plugins.js';
import { Task } from './taskbuffer.classes.task.js';
export class TaskRunner {
public maxParrallelJobs: number = 1;
public status: 'stopped' | 'running' = 'stopped';
public runningTasks: plugins.lik.ObjectMap<Task> = new plugins.lik.ObjectMap<Task>();
public qeuedTasks: Task[] = [];
constructor() {
this.runningTasks.eventSubject.subscribe(async (eventArg) => {
this.checkExecution();
});
}
/**
* adds a task to the qeue
*/
public addTask(taskArg: Task) {
this.qeuedTasks.push(taskArg);
this.checkExecution();
}
/**
* set amount of parallel tasks
* be careful, you might loose dependability of tasks
*/
public setMaxParallelJobs(maxParrallelJobsArg: number) {
this.maxParrallelJobs = maxParrallelJobsArg;
}
/**
* starts the task queue
*/
public async start() {
this.status = 'running';
}
/**
* checks wether execution is on point
*/
public async checkExecution() {
if (
this.runningTasks.getArray().length < this.maxParrallelJobs &&
this.status === 'running' &&
this.qeuedTasks.length > 0
) {
const nextJob = this.qeuedTasks.shift();
this.runningTasks.add(nextJob);
await nextJob.trigger();
this.runningTasks.remove(nextJob);
this.checkExecution();
}
}
/**
* stops the task queue
*/
public async stop() {
this.status = 'stopped';
}
}

View 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,
};
}
}

192
ts/taskbuffer.interfaces.ts Normal file
View File

@@ -0,0 +1,192 @@
import type { ITaskStep } from './taskbuffer.classes.taskstep.js';
import type { Task } from './taskbuffer.classes.task.js';
export interface IRateLimitConfig {
maxPerWindow: number; // max completions allowed within the sliding window
windowMs: number; // sliding window duration in ms
}
export type TResultSharingMode = 'none' | 'share-latest';
export interface ITaskConstraintGroupOptions<TData extends Record<string, unknown> = Record<string, unknown>> {
name: string;
constraintKeyForExecution: (task: Task<any, any, TData>, input?: any) => string | null | undefined;
maxConcurrent?: number; // default: Infinity
cooldownMs?: number; // default: 0
shouldExecute?: (task: Task<any, any, TData>, input?: any) => boolean | Promise<boolean>;
rateLimit?: IRateLimitConfig;
resultSharingMode?: TResultSharingMode; // default: 'none'
}
export interface ITaskExecution<TData extends Record<string, unknown> = Record<string, unknown>> {
task: Task<any, any, TData>;
input: any;
}
export interface IConstrainedTaskEntry {
task: Task<any, any, any>;
input: any;
deferred: import('@push.rocks/smartpromise').Deferred<any>;
constraintKeys: Map<string, string>; // groupName -> key
}
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'
}
// ── Service Lifecycle Types ──────────────────────────────────────
export type TServiceState =
| 'stopped'
| 'starting'
| 'running'
| 'degraded'
| 'failed'
| 'stopping';
export type TServiceCriticality = 'critical' | 'optional';
export type TServiceEventType =
| 'started'
| 'stopped'
| 'failed'
| 'degraded'
| 'recovered'
| 'retrying'
| 'healthCheck'
| 'autoRestarting';
export interface IServiceEvent {
type: TServiceEventType;
serviceName: string;
state: TServiceState;
timestamp: number;
error?: string;
attempt?: number;
}
export interface IServiceStatus {
name: string;
state: TServiceState;
criticality: TServiceCriticality;
startedAt?: number;
stoppedAt?: number;
lastHealthCheck?: number;
healthCheckOk?: boolean;
uptime?: number;
errorCount: number;
lastError?: string;
retryCount: number;
dependencies: string[];
labels?: Record<string, string>;
hasInstance?: boolean;
}
export interface IRetryConfig {
/** Maximum retry attempts. 0 = no retries. Default: 3 */
maxRetries?: number;
/** Base delay in ms. Default: 1000 */
baseDelayMs?: number;
/** Maximum delay cap in ms. Default: 30000 */
maxDelayMs?: number;
/** Multiplier per attempt. Default: 2 */
backoffFactor?: number;
}
export interface IHealthCheckConfig {
/** Interval in ms between health checks. Default: 30000 */
intervalMs?: number;
/** Timeout for a single health check call. Default: 5000 */
timeoutMs?: number;
/** Consecutive failures before marking degraded. Default: 3 */
failuresBeforeDegraded?: number;
/** Consecutive failures before marking failed. Default: 5 */
failuresBeforeFailed?: number;
/** Auto-restart the service when it transitions to failed. Default: false */
autoRestart?: boolean;
/** Maximum number of auto-restart attempts. 0 = unlimited. Default: 3 */
maxAutoRestarts?: number;
/** Base delay in ms before first auto-restart. Default: 5000 */
autoRestartDelayMs?: number;
/** Backoff multiplier per auto-restart attempt. Default: 2 */
autoRestartBackoffFactor?: number;
}
export interface IServiceOptions<T = any> {
name: string;
start: () => Promise<T>;
stop: (instance: T) => Promise<void>;
healthCheck?: (instance: T) => Promise<boolean>;
criticality?: TServiceCriticality;
dependencies?: string[];
retry?: IRetryConfig;
healthCheckConfig?: IHealthCheckConfig;
startupTimeoutMs?: number;
labels?: Record<string, string>;
}
export interface IServiceManagerOptions {
name?: string;
defaultRetry?: IRetryConfig;
defaultHealthCheck?: IHealthCheckConfig;
/** Timeout in ms for the entire startup sequence. Default: 120000 */
startupTimeoutMs?: number;
/** Timeout in ms for the entire shutdown sequence. Default: 30000 */
shutdownTimeoutMs?: number;
}
export type TOverallHealth = 'healthy' | 'degraded' | 'unhealthy';
export interface IServiceManagerHealth {
overall: TOverallHealth;
services: IServiceStatus[];
startedAt?: number;
uptime?: number;
}

View File

@@ -1,9 +1,17 @@
import * as isounique from '@push.rocks/isounique';
import * as lik from '@push.rocks/lik';
import * as smartlog from '@push.rocks/smartlog';
import * as smartpromise from '@push.rocks/smartpromise';
import * as smartdelay from '@push.rocks/smartdelay';
import * as smartrx from '@push.rocks/smartrx';
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,
};

View File

@@ -0,0 +1,8 @@
/**
* autocreated commitinfo by @push.rocks/commitinfo
*/
export const commitinfo = {
name: '@push.rocks/taskbuffer',
version: '8.0.2',
description: 'A flexible task management library supporting TypeScript, allowing for task buffering, scheduling, and execution with dependency management.'
}

View 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
View 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';

View 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 })
accessor taskManager: TaskManager | null = null;
@property({ type: Number })
accessor refreshInterval: number = 1000; // milliseconds
// Internal state
@state()
accessor tasks: ITaskMetadata[] = [];
@state()
accessor scheduledTasks: IScheduledTaskInfo[] = [];
@state()
accessor 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>
`;
}
}

View File

@@ -3,9 +3,12 @@
"experimentalDecorators": true,
"useDefineForClassFields": false,
"target": "ES2022",
"module": "ES2022",
"moduleResolution": "nodenext",
"module": "NodeNext",
"moduleResolution": "NodeNext",
"esModuleInterop": true,
"verbatimModuleSyntax": true,
}
"baseUrl": ".",
"paths": {}
},
"exclude": ["dist_*/**/*.d.ts"]
}