Compare commits
8 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 1dd7ca46ff | |||
| 6110dd8e71 | |||
| 3d8fe65b55 | |||
| 6030fb2805 | |||
| 9a3a3e3eab | |||
| 248383aab1 | |||
| 905ca97b6a | |||
| 72f75aa7de |
Binary file not shown.
@@ -1,35 +0,0 @@
|
||||
# Code Style and Conventions for TaskBuffer
|
||||
|
||||
## File Structure
|
||||
- Source code in `ts/` directory
|
||||
- Tests in `test/` directory
|
||||
- Compiled output in `dist_ts/`
|
||||
- All filenames must be lowercase
|
||||
|
||||
## Naming Conventions
|
||||
- **Interfaces**: Prefix with `I` (e.g., `ITaskFunction`)
|
||||
- **Types**: Prefix with `T` (e.g., `TPreOrAfterTaskFunction`)
|
||||
- **Classes**: PascalCase (e.g., `TaskManager`)
|
||||
- **Files**: `taskbuffer.classes.{classname}.ts` pattern
|
||||
- **Test files**: `test.{number}.{feature}.ts` pattern
|
||||
|
||||
## TypeScript Conventions
|
||||
- Use ES modules (import/export)
|
||||
- Avoid ENums when possible
|
||||
- Import dependencies through `plugins.ts`
|
||||
- Reference with full path: `plugins.myModule.myClass()`
|
||||
- Use async/await patterns consistently
|
||||
- Strong typing throughout
|
||||
|
||||
## Testing Conventions
|
||||
- Import expect from `@git.zone/tstest/tapbundle`
|
||||
- Test files end with `export default tap.start()`
|
||||
- Use descriptive test names with tap.test()
|
||||
- Test both browser and node when applicable
|
||||
|
||||
## Code Quality
|
||||
- Make focused, goal-oriented changes
|
||||
- Preserve necessary complexity
|
||||
- Keep code elegant and maintainable
|
||||
- No inline documentation unless requested
|
||||
- Complete implementations only (no partial work)
|
||||
@@ -1,27 +0,0 @@
|
||||
# TaskBuffer Project Overview
|
||||
|
||||
## Purpose
|
||||
@push.rocks/taskbuffer is a powerful TypeScript-first task management library for orchestrating asynchronous operations. It provides flexible task execution patterns including buffered execution, task chains, parallel execution, scheduling, debouncing, and one-time execution.
|
||||
|
||||
## Tech Stack
|
||||
- **Language**: TypeScript (ES modules)
|
||||
- **Runtime**: Node.js
|
||||
- **Build Tool**: tsbuild, tsbundle
|
||||
- **Test Framework**: @git.zone/tstest (tapbundle)
|
||||
- **Package Manager**: pnpm
|
||||
- **Module System**: ES modules (type: "module")
|
||||
|
||||
## Key Features
|
||||
- Task: Basic unit of work with async function wrapping
|
||||
- Taskchain: Sequential task execution with result passing
|
||||
- Taskparallel: Parallel task execution
|
||||
- TaskManager: Cron-based task scheduling
|
||||
- TaskDebounced: Debounced execution pattern
|
||||
- TaskOnce: Singleton execution pattern
|
||||
- TaskRunner: Distributed task execution
|
||||
- BufferRunner: Smart concurrent execution control
|
||||
|
||||
## Main Entry Points
|
||||
- Main export: `ts/index.ts`
|
||||
- Compiled output: `dist_ts/index.js`
|
||||
- All classes exported from index for clean API
|
||||
@@ -1,67 +0,0 @@
|
||||
# Suggested Commands for TaskBuffer Development
|
||||
|
||||
## Build and Test Commands
|
||||
```bash
|
||||
# Build the project
|
||||
pnpm run build
|
||||
|
||||
# Run tests
|
||||
pnpm test
|
||||
|
||||
# Type checking
|
||||
tsbuild check test/**/* --skiplibcheck
|
||||
|
||||
# Build documentation
|
||||
pnpm run buildDocs
|
||||
```
|
||||
|
||||
## Development Workflow
|
||||
```bash
|
||||
# Install dependencies
|
||||
pnpm install
|
||||
|
||||
# Add development dependency
|
||||
pnpm install --save-dev <package>
|
||||
|
||||
# Add production dependency
|
||||
pnpm add <package>
|
||||
|
||||
# Run specific test
|
||||
tstest test/test.some.ts --verbose
|
||||
|
||||
# Run tests with logging
|
||||
tstest test/test.some.ts --logfile
|
||||
```
|
||||
|
||||
## Git Commands
|
||||
```bash
|
||||
# View status
|
||||
git status
|
||||
|
||||
# Stage changes
|
||||
git add .
|
||||
|
||||
# Commit with message
|
||||
git commit -m "message"
|
||||
|
||||
# Use git mv for file operations to preserve history
|
||||
git mv oldfile newfile
|
||||
```
|
||||
|
||||
## System Commands (Linux)
|
||||
```bash
|
||||
# List files
|
||||
ls -la
|
||||
|
||||
# Find files
|
||||
find . -name "*.ts"
|
||||
|
||||
# Search in files
|
||||
rg "pattern" # Use ripgrep instead of grep
|
||||
|
||||
# View file
|
||||
cat filename
|
||||
|
||||
# Create directory
|
||||
mkdir -p path/to/dir
|
||||
```
|
||||
@@ -1,37 +0,0 @@
|
||||
# Task Completion Checklist for TaskBuffer
|
||||
|
||||
## Before Marking Any Task Complete
|
||||
|
||||
### 1. Code Quality Checks
|
||||
- [ ] Run build to ensure TypeScript compiles: `pnpm run build`
|
||||
- [ ] Run tests to ensure nothing breaks: `pnpm test`
|
||||
- [ ] Type check test files: `tsbuild check test/**/* --skiplibcheck`
|
||||
|
||||
### 2. Code Review
|
||||
- [ ] All changes are focused and purposeful
|
||||
- [ ] No unnecessary modifications made
|
||||
- [ ] Code follows project naming conventions
|
||||
- [ ] Imports use the plugins.ts pattern where applicable
|
||||
- [ ] All async operations use proper async/await
|
||||
|
||||
### 3. Testing
|
||||
- [ ] New features have corresponding tests
|
||||
- [ ] Existing tests still pass
|
||||
- [ ] Test files end with `export default tap.start()`
|
||||
- [ ] Tests use proper expect from tapbundle
|
||||
|
||||
### 4. Documentation
|
||||
- [ ] readme.md updated if new features added
|
||||
- [ ] Code is self-explanatory (no comments unless requested)
|
||||
- [ ] API changes documented
|
||||
|
||||
### 5. Git Hygiene
|
||||
- [ ] Changes are staged appropriately
|
||||
- [ ] Commit message is clear and focused
|
||||
- [ ] NO commits made without explicit user approval
|
||||
|
||||
## Common Issues to Check
|
||||
- No uppercase filenames
|
||||
- No direct npm usage (use pnpm)
|
||||
- No guessing APIs (always check documentation)
|
||||
- No partial implementations
|
||||
@@ -1,68 +0,0 @@
|
||||
# language of the project (csharp, python, rust, java, typescript, go, cpp, or ruby)
|
||||
# * For C, use cpp
|
||||
# * For JavaScript, use typescript
|
||||
# Special requirements:
|
||||
# * csharp: Requires the presence of a .sln file in the project folder.
|
||||
language: typescript
|
||||
|
||||
# whether to use the project's gitignore file to ignore files
|
||||
# Added on 2025-04-07
|
||||
ignore_all_files_in_gitignore: true
|
||||
# list of additional paths to ignore
|
||||
# same syntax as gitignore, so you can use * and **
|
||||
# Was previously called `ignored_dirs`, please update your config if you are using that.
|
||||
# Added (renamed) on 2025-04-07
|
||||
ignored_paths: []
|
||||
|
||||
# whether the project is in read-only mode
|
||||
# If set to true, all editing tools will be disabled and attempts to use them will result in an error
|
||||
# Added on 2025-04-18
|
||||
read_only: false
|
||||
|
||||
|
||||
# list of tool names to exclude. We recommend not excluding any tools, see the readme for more details.
|
||||
# Below is the complete list of tools for convenience.
|
||||
# To make sure you have the latest list of tools, and to view their descriptions,
|
||||
# execute `uv run scripts/print_tool_overview.py`.
|
||||
#
|
||||
# * `activate_project`: Activates a project by name.
|
||||
# * `check_onboarding_performed`: Checks whether project onboarding was already performed.
|
||||
# * `create_text_file`: Creates/overwrites a file in the project directory.
|
||||
# * `delete_lines`: Deletes a range of lines within a file.
|
||||
# * `delete_memory`: Deletes a memory from Serena's project-specific memory store.
|
||||
# * `execute_shell_command`: Executes a shell command.
|
||||
# * `find_referencing_code_snippets`: Finds code snippets in which the symbol at the given location is referenced.
|
||||
# * `find_referencing_symbols`: Finds symbols that reference the symbol at the given location (optionally filtered by type).
|
||||
# * `find_symbol`: Performs a global (or local) search for symbols with/containing a given name/substring (optionally filtered by type).
|
||||
# * `get_current_config`: Prints the current configuration of the agent, including the active and available projects, tools, contexts, and modes.
|
||||
# * `get_symbols_overview`: Gets an overview of the top-level symbols defined in a given file.
|
||||
# * `initial_instructions`: Gets the initial instructions for the current project.
|
||||
# Should only be used in settings where the system prompt cannot be set,
|
||||
# e.g. in clients you have no control over, like Claude Desktop.
|
||||
# * `insert_after_symbol`: Inserts content after the end of the definition of a given symbol.
|
||||
# * `insert_at_line`: Inserts content at a given line in a file.
|
||||
# * `insert_before_symbol`: Inserts content before the beginning of the definition of a given symbol.
|
||||
# * `list_dir`: Lists files and directories in the given directory (optionally with recursion).
|
||||
# * `list_memories`: Lists memories in Serena's project-specific memory store.
|
||||
# * `onboarding`: Performs onboarding (identifying the project structure and essential tasks, e.g. for testing or building).
|
||||
# * `prepare_for_new_conversation`: Provides instructions for preparing for a new conversation (in order to continue with the necessary context).
|
||||
# * `read_file`: Reads a file within the project directory.
|
||||
# * `read_memory`: Reads the memory with the given name from Serena's project-specific memory store.
|
||||
# * `remove_project`: Removes a project from the Serena configuration.
|
||||
# * `replace_lines`: Replaces a range of lines within a file with new content.
|
||||
# * `replace_symbol_body`: Replaces the full definition of a symbol.
|
||||
# * `restart_language_server`: Restarts the language server, may be necessary when edits not through Serena happen.
|
||||
# * `search_for_pattern`: Performs a search for a pattern in the project.
|
||||
# * `summarize_changes`: Provides instructions for summarizing the changes made to the codebase.
|
||||
# * `switch_modes`: Activates modes by providing a list of their names
|
||||
# * `think_about_collected_information`: Thinking tool for pondering the completeness of collected information.
|
||||
# * `think_about_task_adherence`: Thinking tool for determining whether the agent is still on track with the current task.
|
||||
# * `think_about_whether_you_are_done`: Thinking tool for determining whether the task is truly completed.
|
||||
# * `write_memory`: Writes a named memory (for future reference) to Serena's project-specific memory store.
|
||||
excluded_tools: []
|
||||
|
||||
# initial prompt for the project. It will always be given to the LLM upon activating the project
|
||||
# (contrary to the memories, which are loaded on demand).
|
||||
initial_prompt: ""
|
||||
|
||||
project_name: "taskbuffer"
|
||||
41
changelog.md
41
changelog.md
@@ -1,5 +1,46 @@
|
||||
# Changelog
|
||||
|
||||
## 2026-01-26 - 4.1.1 - fix(ts_web)
|
||||
fix web dashboard typings and update generated commit info
|
||||
|
||||
- Updated generated commit info file ts_web/00_commitinfo_data.ts to version 4.1.0
|
||||
- Large changes applied to web/TS build files (net +529 additions, -399 deletions) — likely fixes and typing/refactor improvements in ts_web/dashboard
|
||||
- package.json remains at 4.1.0; recommend a patch bump to 4.1.1 for these fixes
|
||||
|
||||
## 2026-01-26 - 4.1.0 - feat(task)
|
||||
add task labels and push-based task events
|
||||
|
||||
- Introduce Task labels: Task accepts labels in constructor and exposes setLabel/getLabel/removeLabel/hasLabel; labels are included (shallow copy) in getMetadata().
|
||||
- Add push-based events: Task.eventSubject (rxjs Subject<ITaskEvent>) emits 'started','step','completed','failed' with timestamp; 'step' includes stepName and 'failed' includes error string.
|
||||
- Task now emits events during lifecycle: emits 'started' at run start, 'step' on notifyStep, and 'completed' or 'failed' when finished or errored. getMetadata() now includes labels.
|
||||
- TaskManager aggregates task events into taskSubject, subscribes on addTask and unsubscribes on removeTask/stop; includes helper methods getTasksByLabel and getTasksMetadataByLabel.
|
||||
- Public API updated: exported ITaskEvent and TTaskEventType in ts/index.ts and interfaces updated (labels in metadata, new event types).
|
||||
- Tests and docs: added test/test.12.labels-and-events.ts and updated readme.hints.md to document labels and push-based events.
|
||||
|
||||
## 2026-01-25 - 4.0.0 - BREAKING CHANGE(taskbuffer)
|
||||
Change default Task error handling: trigger() now rejects when taskFunction throws; add catchErrors option (default false) to preserve previous swallow behavior; track errors (lastError, errorCount) and expose them in metadata; improve error propagation and logging across runners, chains, parallels and debounced tasks; add tests and documentation for new behavior.
|
||||
|
||||
- Introduce catchErrors option on Task (default: false) — previously errors were swallowed by default
|
||||
- Tasks now set lastError and increment errorCount when failures occur; clearError() added to reset error state
|
||||
- getMetadata() now reports status 'failed' and includes lastError and errorCount
|
||||
- Task.run flow updated to reset error state at start, log errors, and either swallow or rethrow based on catchErrors
|
||||
- BufferRunner, TaskRunner, Taskchain, Taskparallel, TaskDebounced and TaskManager updated to handle errors, avoid hanging promises, and use logger instead of console
|
||||
- Added comprehensive tests (test/test.11.errorhandling.ts) and readme hints documenting the new error-handling behavior (v3.6.0+)
|
||||
- npmextra.json updated for @git.zone/cli and release registries
|
||||
|
||||
## 2025-12-04 - 3.5.0 - feat(core)
|
||||
Add debounced tasks and step-based progress tracking; upgrade deps and improve dashboard and scheduling
|
||||
|
||||
- Add TaskDebounced class to coalesce rapid triggers into a single execution (debounce behavior).
|
||||
- Introduce step tracking and progress reporting on Task via TaskStep, getProgress(), getStepsMetadata(), getMetadata(), resetSteps(), and completeAllSteps().
|
||||
- Enhance buffered execution flow: BufferRunner and CycleCounter improvements to better coordinate buffered runs and cycle promises.
|
||||
- Standardize concurrent runner naming (Taskparallel) and update related exports/usages (ts/index.ts, readme examples).
|
||||
- Enhance TaskManager scheduling/metadata: getScheduledTasks now returns schedule and nextRun, addExecuteRemoveTask collects execution report metadata and cleans up after execution, distributed coordination hooks retained.
|
||||
- Add/upgrade web dashboard UI, demos and refresh logic to surface task metadata, scheduled tasks and progress.
|
||||
- Bump runtime and dev dependencies (multiple @push.rocks packages and @git.zone tooling).
|
||||
- Update tests: reduce iteration threshold and tighten schedule interval in test/test.4.taskmanager.ts.
|
||||
- Remove several .serena memory files (project overview, style guides and suggested commands) as cleanup.
|
||||
|
||||
## 2025-09-07 - 3.4.0 - feat(taskbuffer-dashboard)
|
||||
Add TaskBuffer dashboard web component, demo and browser tests; add HTML entry and update dependencies
|
||||
|
||||
|
||||
@@ -1,10 +1,5 @@
|
||||
{
|
||||
"npmci": {
|
||||
"npmGlobalTools": [],
|
||||
"npmAccessLevel": "public",
|
||||
"npmRegistryUrl": "registry.npmjs.org"
|
||||
},
|
||||
"gitzone": {
|
||||
"@git.zone/cli": {
|
||||
"projectType": "npm",
|
||||
"module": {
|
||||
"githost": "code.foss.global",
|
||||
@@ -25,9 +20,20 @@
|
||||
"debounced tasks",
|
||||
"distributed coordination"
|
||||
]
|
||||
},
|
||||
"release": {
|
||||
"registries": [
|
||||
"https://verdaccio.lossless.digital",
|
||||
"https://registry.npmjs.org"
|
||||
],
|
||||
"accessLevel": "public"
|
||||
}
|
||||
},
|
||||
"tsdoc": {
|
||||
"@git.zone/tsdoc": {
|
||||
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
|
||||
},
|
||||
"@ship.zone/szci": {
|
||||
"npmGlobalTools": [],
|
||||
"npmRegistryUrl": "registry.npmjs.org"
|
||||
}
|
||||
}
|
||||
26
package.json
26
package.json
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@push.rocks/taskbuffer",
|
||||
"version": "3.4.0",
|
||||
"version": "4.1.1",
|
||||
"private": false,
|
||||
"description": "A flexible task management library supporting TypeScript, allowing for task buffering, scheduling, and execution with dependency management.",
|
||||
"main": "dist_ts/index.js",
|
||||
@@ -34,21 +34,21 @@
|
||||
},
|
||||
"homepage": "https://code.foss.global/push.rocks/taskbuffer#readme",
|
||||
"dependencies": {
|
||||
"@design.estate/dees-element": "^2.1.2",
|
||||
"@push.rocks/lik": "^6.0.5",
|
||||
"@design.estate/dees-element": "^2.1.3",
|
||||
"@push.rocks/lik": "^6.2.2",
|
||||
"@push.rocks/smartdelay": "^3.0.5",
|
||||
"@push.rocks/smartlog": "^3.1.9",
|
||||
"@push.rocks/smartpromise": "^4.0.3",
|
||||
"@push.rocks/smartrx": "^3.0.6",
|
||||
"@push.rocks/smarttime": "^4.0.6",
|
||||
"@push.rocks/smartunique": "^3.0.6"
|
||||
"@push.rocks/smartlog": "^3.1.10",
|
||||
"@push.rocks/smartpromise": "^4.2.3",
|
||||
"@push.rocks/smartrx": "^3.0.10",
|
||||
"@push.rocks/smarttime": "^4.1.1",
|
||||
"@push.rocks/smartunique": "^3.0.9"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@git.zone/tsbuild": "^2.6.8",
|
||||
"@git.zone/tsbundle": "^2.0.8",
|
||||
"@git.zone/tsrun": "^1.2.44",
|
||||
"@git.zone/tstest": "^2.3.6",
|
||||
"@types/node": "^20.8.7"
|
||||
"@git.zone/tsbuild": "^3.1.2",
|
||||
"@git.zone/tsbundle": "^2.6.3",
|
||||
"@git.zone/tsrun": "^2.0.0",
|
||||
"@git.zone/tstest": "^3.1.3",
|
||||
"@types/node": "^24.10.1"
|
||||
},
|
||||
"files": [
|
||||
"ts/**/*",
|
||||
|
||||
3263
pnpm-lock.yaml
generated
3263
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
@@ -1 +1,42 @@
|
||||
# Taskbuffer Hints
|
||||
|
||||
## Error Handling (v3.6.0+)
|
||||
- `Task` now has `catchErrors` constructor option (default: `false`)
|
||||
- Default behavior: `trigger()` rejects when taskFunction throws (breaking change from pre-3.6)
|
||||
- Set `catchErrors: true` to swallow errors (old behavior) - returns `undefined` on error
|
||||
- Error state tracked via `lastError?: Error`, `errorCount: number`, `clearError()`
|
||||
- `getMetadata()` status uses all four values: `'idle'` | `'running'` | `'completed'` | `'failed'`
|
||||
- All peripheral classes (Taskchain, Taskparallel, TaskRunner, BufferRunner, TaskDebounced, TaskManager) have proper error propagation/handling
|
||||
- `console.log` calls replaced with `logger.log()` throughout
|
||||
|
||||
## Breaking API Rename (TaskRunner)
|
||||
- `maxParrallelJobs` → `maxParallelJobs`
|
||||
- `qeuedTasks` → `queuedTasks`
|
||||
- JSDoc typos fixed: "qeue" → "queue", "wether" → "whether", "loose" → "lose"
|
||||
- The `setMaxParallelJobs()` parameter also renamed from `maxParrallelJobsArg` to `maxParallelJobsArg`
|
||||
|
||||
## Error Context Improvements
|
||||
- **TaskChain**: Errors now wrap the original with context: chain name, failing task name, and task index. Original error preserved via `.cause`
|
||||
- **BufferRunner**: When `catchErrors: false`, buffered task errors now reject the trigger promise (via `CycleCounter.informOfCycleError`) instead of silently resolving with `undefined`
|
||||
- **TaskChain stubs completed**: `removeTask(task)` returns `boolean`, `shiftTask()` returns `Task | undefined`
|
||||
|
||||
## Task Labels (v4.1.0+)
|
||||
- `Task` constructor accepts optional `labels?: Record<string, string>`
|
||||
- Helper methods: `setLabel(key, value)`, `getLabel(key)`, `removeLabel(key)`, `hasLabel(key, value?)`
|
||||
- `getMetadata()` includes `labels` (shallow copy)
|
||||
- `TaskManager.getTasksByLabel(key, value)` returns matching `Task[]`
|
||||
- `TaskManager.getTasksMetadataByLabel(key, value)` returns matching `ITaskMetadata[]`
|
||||
|
||||
## Push-Based Events (v4.1.0+)
|
||||
- `Task.eventSubject`: rxjs `Subject<ITaskEvent>` emitting `'started'`, `'step'`, `'completed'`, `'failed'` events
|
||||
- `TaskManager.taskSubject`: aggregated `Subject<ITaskEvent>` from all added tasks
|
||||
- `TaskManager.removeTask(task)` unsubscribes and removes from map
|
||||
- `TaskManager.stop()` cleans up all event subscriptions
|
||||
- Exported types: `ITaskEvent`, `TTaskEventType`
|
||||
|
||||
## Project Structure
|
||||
- Source in `ts/`, web components in `ts_web/`
|
||||
- Tests in `test/` - naming: `*.node.ts`, `*.browser.ts`, `*.both.ts`
|
||||
- Logger: `ts/taskbuffer.logging.ts` exports `logger` (ConsoleLog from smartlog)
|
||||
- Build: `pnpm build` (tsbuild tsfolders)
|
||||
- Test: `pnpm test` or `tstest test/test.XX.name.ts --verbose`
|
||||
|
||||
363
test/test.11.errorhandling.ts
Normal file
363
test/test.11.errorhandling.ts
Normal file
@@ -0,0 +1,363 @@
|
||||
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||
import * as taskbuffer from '../ts/index.js';
|
||||
import * as smartdelay from '@push.rocks/smartdelay';
|
||||
|
||||
// Test 1: Default task rejects on error (catchErrors: false)
|
||||
tap.test('should reject when taskFunction throws (default catchErrors: false)', async () => {
|
||||
const failingTask = new taskbuffer.Task({
|
||||
name: 'failing-task-default',
|
||||
taskFunction: async () => {
|
||||
throw new Error('intentional failure');
|
||||
},
|
||||
});
|
||||
|
||||
let didReject = false;
|
||||
try {
|
||||
await failingTask.trigger();
|
||||
} catch (err) {
|
||||
didReject = true;
|
||||
expect(err).toBeInstanceOf(Error);
|
||||
expect((err as Error).message).toEqual('intentional failure');
|
||||
}
|
||||
expect(didReject).toBeTrue();
|
||||
});
|
||||
|
||||
// Test 2: Task with catchErrors: true resolves on error
|
||||
tap.test('should resolve with undefined when catchErrors is true', async () => {
|
||||
const failingTask = new taskbuffer.Task({
|
||||
name: 'failing-task-catch',
|
||||
catchErrors: true,
|
||||
taskFunction: async () => {
|
||||
throw new Error('swallowed failure');
|
||||
},
|
||||
});
|
||||
|
||||
const result = await failingTask.trigger();
|
||||
expect(result).toBeUndefined();
|
||||
});
|
||||
|
||||
// Test 3: lastError and errorCount are set after failure
|
||||
tap.test('should set lastError and errorCount after failure', async () => {
|
||||
const failingTask = new taskbuffer.Task({
|
||||
name: 'failing-task-state',
|
||||
catchErrors: true,
|
||||
taskFunction: async () => {
|
||||
throw new Error('tracked failure');
|
||||
},
|
||||
});
|
||||
|
||||
await failingTask.trigger();
|
||||
expect(failingTask.lastError).toBeInstanceOf(Error);
|
||||
expect(failingTask.lastError.message).toEqual('tracked failure');
|
||||
expect(failingTask.errorCount).toEqual(1);
|
||||
|
||||
// Run again to verify errorCount increments
|
||||
await failingTask.trigger();
|
||||
expect(failingTask.errorCount).toEqual(2);
|
||||
});
|
||||
|
||||
// Test 4: Error state resets on successful re-run
|
||||
tap.test('should reset lastError on successful re-run', async () => {
|
||||
let shouldFail = true;
|
||||
const task = new taskbuffer.Task({
|
||||
name: 'intermittent-task',
|
||||
catchErrors: true,
|
||||
taskFunction: async () => {
|
||||
if (shouldFail) {
|
||||
throw new Error('first run fails');
|
||||
}
|
||||
return 'success';
|
||||
},
|
||||
});
|
||||
|
||||
// First run: fail
|
||||
await task.trigger();
|
||||
expect(task.lastError).toBeInstanceOf(Error);
|
||||
expect(task.errorCount).toEqual(1);
|
||||
|
||||
// Second run: succeed
|
||||
shouldFail = false;
|
||||
const result = await task.trigger();
|
||||
expect(result).toEqual('success');
|
||||
expect(task.lastError).toBeUndefined();
|
||||
// errorCount should still be 1 since the second run succeeded
|
||||
expect(task.errorCount).toEqual(1);
|
||||
});
|
||||
|
||||
// Test 5: Taskchain rejects when a child task throws
|
||||
tap.test('should reject Taskchain when a child task throws', async () => {
|
||||
const goodTask = new taskbuffer.Task({
|
||||
name: 'good-chain-task',
|
||||
taskFunction: async () => 'ok',
|
||||
});
|
||||
const badTask = new taskbuffer.Task({
|
||||
name: 'bad-chain-task',
|
||||
taskFunction: async () => {
|
||||
throw new Error('chain failure');
|
||||
},
|
||||
});
|
||||
|
||||
const chain = new taskbuffer.Taskchain({
|
||||
name: 'test-chain',
|
||||
taskArray: [goodTask, badTask],
|
||||
});
|
||||
|
||||
let didReject = false;
|
||||
try {
|
||||
await chain.trigger();
|
||||
} catch (err) {
|
||||
didReject = true;
|
||||
}
|
||||
expect(didReject).toBeTrue();
|
||||
});
|
||||
|
||||
// Test 6: Taskparallel rejects when a child task throws
|
||||
tap.test('should reject Taskparallel when a child task throws', async () => {
|
||||
const goodTask = new taskbuffer.Task({
|
||||
name: 'good-parallel-task',
|
||||
taskFunction: async () => 'ok',
|
||||
});
|
||||
const badTask = new taskbuffer.Task({
|
||||
name: 'bad-parallel-task',
|
||||
taskFunction: async () => {
|
||||
throw new Error('parallel failure');
|
||||
},
|
||||
});
|
||||
|
||||
const parallel = new taskbuffer.Taskparallel({
|
||||
taskArray: [goodTask, badTask],
|
||||
});
|
||||
|
||||
let didReject = false;
|
||||
try {
|
||||
await parallel.trigger();
|
||||
} catch (err) {
|
||||
didReject = true;
|
||||
}
|
||||
expect(didReject).toBeTrue();
|
||||
});
|
||||
|
||||
// Test 7: TaskRunner continues processing after a task error
|
||||
tap.test('should continue TaskRunner queue after a task error', async () => {
|
||||
const runner = new taskbuffer.TaskRunner();
|
||||
const executionOrder: string[] = [];
|
||||
|
||||
const badTask = new taskbuffer.Task({
|
||||
name: 'runner-bad-task',
|
||||
taskFunction: async () => {
|
||||
executionOrder.push('bad');
|
||||
throw new Error('runner task failure');
|
||||
},
|
||||
});
|
||||
const goodTask = new taskbuffer.Task({
|
||||
name: 'runner-good-task',
|
||||
taskFunction: async () => {
|
||||
executionOrder.push('good');
|
||||
},
|
||||
});
|
||||
|
||||
await runner.start();
|
||||
runner.addTask(badTask);
|
||||
runner.addTask(goodTask);
|
||||
|
||||
// Wait for both tasks to be processed
|
||||
await smartdelay.delayFor(500);
|
||||
await runner.stop();
|
||||
|
||||
expect(executionOrder).toContain('bad');
|
||||
expect(executionOrder).toContain('good');
|
||||
});
|
||||
|
||||
// Test 8: BufferRunner handles errors without hanging
|
||||
tap.test('should handle BufferRunner errors without hanging', async () => {
|
||||
let callCount = 0;
|
||||
const bufferedTask = new taskbuffer.Task({
|
||||
name: 'buffer-error-task',
|
||||
buffered: true,
|
||||
bufferMax: 3,
|
||||
catchErrors: true,
|
||||
taskFunction: async () => {
|
||||
callCount++;
|
||||
throw new Error('buffer failure');
|
||||
},
|
||||
});
|
||||
|
||||
await bufferedTask.trigger();
|
||||
// The task should have executed and not hung
|
||||
expect(callCount).toBeGreaterThan(0);
|
||||
});
|
||||
|
||||
// Test 9: clearError() resets error state
|
||||
tap.test('should reset error state with clearError()', async () => {
|
||||
const task = new taskbuffer.Task({
|
||||
name: 'clearable-task',
|
||||
catchErrors: true,
|
||||
taskFunction: async () => {
|
||||
throw new Error('to be cleared');
|
||||
},
|
||||
});
|
||||
|
||||
await task.trigger();
|
||||
expect(task.lastError).toBeInstanceOf(Error);
|
||||
|
||||
task.clearError();
|
||||
expect(task.lastError).toBeUndefined();
|
||||
// errorCount should remain unchanged
|
||||
expect(task.errorCount).toEqual(1);
|
||||
});
|
||||
|
||||
// Test 10: getMetadata() reflects error state
|
||||
tap.test('should reflect error state in getMetadata()', async () => {
|
||||
const task = new taskbuffer.Task({
|
||||
name: 'metadata-error-task',
|
||||
catchErrors: true,
|
||||
taskFunction: async () => {
|
||||
throw new Error('metadata failure');
|
||||
},
|
||||
});
|
||||
|
||||
// Before any run
|
||||
let metadata = task.getMetadata();
|
||||
expect(metadata.status).toEqual('idle');
|
||||
expect(metadata.errorCount).toEqual(0);
|
||||
|
||||
// After failing
|
||||
await task.trigger();
|
||||
metadata = task.getMetadata();
|
||||
expect(metadata.status).toEqual('failed');
|
||||
expect(metadata.lastError).toEqual('metadata failure');
|
||||
expect(metadata.errorCount).toEqual(1);
|
||||
});
|
||||
|
||||
// Test 11: TaskChain error includes task name and index context
|
||||
tap.test('should include task name and index in TaskChain error message', async () => {
|
||||
const goodTask = new taskbuffer.Task({
|
||||
name: 'chain-step-ok',
|
||||
taskFunction: async () => 'ok',
|
||||
});
|
||||
const badTask = new taskbuffer.Task({
|
||||
name: 'chain-step-fail',
|
||||
taskFunction: async () => {
|
||||
throw new Error('step exploded');
|
||||
},
|
||||
});
|
||||
|
||||
const chain = new taskbuffer.Taskchain({
|
||||
name: 'context-chain',
|
||||
taskArray: [goodTask, badTask],
|
||||
});
|
||||
|
||||
let caughtError: Error | null = null;
|
||||
try {
|
||||
await chain.trigger();
|
||||
} catch (err) {
|
||||
caughtError = err as Error;
|
||||
}
|
||||
expect(caughtError).toBeInstanceOf(Error);
|
||||
expect(caughtError.message).toInclude('context-chain');
|
||||
expect(caughtError.message).toInclude('chain-step-fail');
|
||||
expect(caughtError.message).toInclude('index 1');
|
||||
expect((caughtError as any).cause).toBeInstanceOf(Error);
|
||||
expect(((caughtError as any).cause as Error).message).toEqual('step exploded');
|
||||
});
|
||||
|
||||
// Test 12: BufferRunner error propagation with catchErrors: false
|
||||
tap.test('should reject buffered task when catchErrors is false', async () => {
|
||||
const bufferedTask = new taskbuffer.Task({
|
||||
name: 'buffer-reject-task',
|
||||
buffered: true,
|
||||
bufferMax: 3,
|
||||
catchErrors: false,
|
||||
taskFunction: async () => {
|
||||
throw new Error('buffer reject failure');
|
||||
},
|
||||
});
|
||||
|
||||
let didReject = false;
|
||||
try {
|
||||
await bufferedTask.trigger();
|
||||
} catch (err) {
|
||||
didReject = true;
|
||||
expect(err).toBeInstanceOf(Error);
|
||||
expect((err as Error).message).toEqual('buffer reject failure');
|
||||
}
|
||||
expect(didReject).toBeTrue();
|
||||
});
|
||||
|
||||
// Test 13: Taskchain removeTask removes and returns true
|
||||
tap.test('should remove a task from Taskchain', async () => {
|
||||
const task1 = new taskbuffer.Task({
|
||||
name: 'removable-1',
|
||||
taskFunction: async () => 'a',
|
||||
});
|
||||
const task2 = new taskbuffer.Task({
|
||||
name: 'removable-2',
|
||||
taskFunction: async () => 'b',
|
||||
});
|
||||
|
||||
const chain = new taskbuffer.Taskchain({
|
||||
name: 'remove-chain',
|
||||
taskArray: [task1, task2],
|
||||
});
|
||||
|
||||
const removed = chain.removeTask(task1);
|
||||
expect(removed).toBeTrue();
|
||||
expect(chain.taskArray.length).toEqual(1);
|
||||
expect(chain.taskArray[0] === task2).toBeTrue();
|
||||
});
|
||||
|
||||
// Test 14: Taskchain removeTask returns false for unknown task
|
||||
tap.test('should return false when removing a task not in Taskchain', async () => {
|
||||
const task1 = new taskbuffer.Task({
|
||||
name: 'existing',
|
||||
taskFunction: async () => 'a',
|
||||
});
|
||||
const unknown = new taskbuffer.Task({
|
||||
name: 'unknown',
|
||||
taskFunction: async () => 'b',
|
||||
});
|
||||
|
||||
const chain = new taskbuffer.Taskchain({
|
||||
name: 'remove-false-chain',
|
||||
taskArray: [task1],
|
||||
});
|
||||
|
||||
const removed = chain.removeTask(unknown);
|
||||
expect(removed).toBeFalse();
|
||||
expect(chain.taskArray.length).toEqual(1);
|
||||
});
|
||||
|
||||
// Test 15: Taskchain shiftTask returns first task and shortens array
|
||||
tap.test('should shift the first task from Taskchain', async () => {
|
||||
const task1 = new taskbuffer.Task({
|
||||
name: 'shift-1',
|
||||
taskFunction: async () => 'a',
|
||||
});
|
||||
const task2 = new taskbuffer.Task({
|
||||
name: 'shift-2',
|
||||
taskFunction: async () => 'b',
|
||||
});
|
||||
|
||||
const chain = new taskbuffer.Taskchain({
|
||||
name: 'shift-chain',
|
||||
taskArray: [task1, task2],
|
||||
});
|
||||
|
||||
const shifted = chain.shiftTask();
|
||||
expect(shifted === task1).toBeTrue();
|
||||
expect(chain.taskArray.length).toEqual(1);
|
||||
expect(chain.taskArray[0] === task2).toBeTrue();
|
||||
});
|
||||
|
||||
// Test 16: Taskchain shiftTask returns undefined on empty array
|
||||
tap.test('should return undefined when shifting from empty Taskchain', async () => {
|
||||
const chain = new taskbuffer.Taskchain({
|
||||
name: 'empty-shift-chain',
|
||||
taskArray: [],
|
||||
});
|
||||
|
||||
const shifted = chain.shiftTask();
|
||||
expect(shifted).toBeUndefined();
|
||||
});
|
||||
|
||||
export default tap.start();
|
||||
249
test/test.12.labels-and-events.ts
Normal file
249
test/test.12.labels-and-events.ts
Normal file
@@ -0,0 +1,249 @@
|
||||
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||
import * as taskbuffer from '../ts/index.js';
|
||||
import type { ITaskEvent } from '../ts/index.js';
|
||||
|
||||
// ─── Labels ───
|
||||
|
||||
tap.test('should accept labels in constructor', async () => {
|
||||
const task = new taskbuffer.Task({
|
||||
name: 'labelled-task',
|
||||
taskFunction: async () => 'ok',
|
||||
labels: { userId: 'u1', tenantId: 't1' },
|
||||
});
|
||||
expect(task.labels).toEqual({ userId: 'u1', tenantId: 't1' });
|
||||
});
|
||||
|
||||
tap.test('should default labels to empty object', async () => {
|
||||
const task = new taskbuffer.Task({
|
||||
name: 'no-labels-task',
|
||||
taskFunction: async () => 'ok',
|
||||
});
|
||||
expect(task.labels).toEqual({});
|
||||
});
|
||||
|
||||
tap.test('setLabel / getLabel / removeLabel / hasLabel should work', async () => {
|
||||
const task = new taskbuffer.Task({
|
||||
name: 'label-helpers-task',
|
||||
taskFunction: async () => 'ok',
|
||||
});
|
||||
|
||||
task.setLabel('env', 'prod');
|
||||
expect(task.getLabel('env')).toEqual('prod');
|
||||
expect(task.hasLabel('env')).toBeTrue();
|
||||
expect(task.hasLabel('env', 'prod')).toBeTrue();
|
||||
expect(task.hasLabel('env', 'dev')).toBeFalse();
|
||||
expect(task.hasLabel('missing')).toBeFalse();
|
||||
|
||||
const removed = task.removeLabel('env');
|
||||
expect(removed).toBeTrue();
|
||||
expect(task.getLabel('env')).toBeUndefined();
|
||||
|
||||
const removedAgain = task.removeLabel('env');
|
||||
expect(removedAgain).toBeFalse();
|
||||
});
|
||||
|
||||
tap.test('getMetadata() should include labels', async () => {
|
||||
const task = new taskbuffer.Task({
|
||||
name: 'metadata-labels-task',
|
||||
taskFunction: async () => 'ok',
|
||||
labels: { region: 'eu' },
|
||||
});
|
||||
|
||||
const meta = task.getMetadata();
|
||||
expect(meta.labels).toEqual({ region: 'eu' });
|
||||
|
||||
// Returned labels should be a copy
|
||||
meta.labels!['region'] = 'us';
|
||||
expect(task.labels['region']).toEqual('eu');
|
||||
});
|
||||
|
||||
tap.test('TaskManager.getTasksByLabel should filter correctly', async () => {
|
||||
const manager = new taskbuffer.TaskManager();
|
||||
const t1 = new taskbuffer.Task({
|
||||
name: 'label-filter-1',
|
||||
taskFunction: async () => 'ok',
|
||||
labels: { userId: 'alice' },
|
||||
});
|
||||
const t2 = new taskbuffer.Task({
|
||||
name: 'label-filter-2',
|
||||
taskFunction: async () => 'ok',
|
||||
labels: { userId: 'bob' },
|
||||
});
|
||||
const t3 = new taskbuffer.Task({
|
||||
name: 'label-filter-3',
|
||||
taskFunction: async () => 'ok',
|
||||
labels: { userId: 'alice' },
|
||||
});
|
||||
|
||||
manager.addTask(t1);
|
||||
manager.addTask(t2);
|
||||
manager.addTask(t3);
|
||||
|
||||
const aliceTasks = manager.getTasksByLabel('userId', 'alice');
|
||||
expect(aliceTasks.length).toEqual(2);
|
||||
expect(aliceTasks.map((t) => t.name).sort()).toEqual(['label-filter-1', 'label-filter-3']);
|
||||
|
||||
const bobMeta = manager.getTasksMetadataByLabel('userId', 'bob');
|
||||
expect(bobMeta.length).toEqual(1);
|
||||
expect(bobMeta[0].name).toEqual('label-filter-2');
|
||||
|
||||
await manager.stop();
|
||||
});
|
||||
|
||||
// ─── Events ───
|
||||
|
||||
tap.test('should emit started + completed on successful trigger', async () => {
|
||||
const events: ITaskEvent[] = [];
|
||||
const task = new taskbuffer.Task({
|
||||
name: 'event-success-task',
|
||||
taskFunction: async () => 'ok',
|
||||
});
|
||||
|
||||
task.eventSubject.subscribe((e) => events.push(e));
|
||||
await task.trigger();
|
||||
|
||||
expect(events.length).toEqual(2);
|
||||
expect(events[0].type).toEqual('started');
|
||||
expect(events[1].type).toEqual('completed');
|
||||
expect(events[0].task.name).toEqual('event-success-task');
|
||||
expect(typeof events[0].timestamp).toEqual('number');
|
||||
});
|
||||
|
||||
tap.test('should emit step events on notifyStep', async () => {
|
||||
const steps = [
|
||||
{ name: 'build', description: 'Build artifacts', percentage: 50 },
|
||||
{ name: 'deploy', description: 'Deploy to prod', percentage: 50 },
|
||||
] as const;
|
||||
|
||||
const events: ITaskEvent[] = [];
|
||||
const task = new taskbuffer.Task({
|
||||
name: 'step-event-task',
|
||||
steps,
|
||||
taskFunction: async () => {
|
||||
task.notifyStep('build');
|
||||
task.notifyStep('deploy');
|
||||
return 'done';
|
||||
},
|
||||
});
|
||||
|
||||
task.eventSubject.subscribe((e) => events.push(e));
|
||||
await task.trigger();
|
||||
|
||||
const stepEvents = events.filter((e) => e.type === 'step');
|
||||
expect(stepEvents.length).toEqual(2);
|
||||
expect(stepEvents[0].stepName).toEqual('build');
|
||||
expect(stepEvents[1].stepName).toEqual('deploy');
|
||||
});
|
||||
|
||||
tap.test('should emit started + failed on error', async () => {
|
||||
const events: ITaskEvent[] = [];
|
||||
const task = new taskbuffer.Task({
|
||||
name: 'event-fail-task',
|
||||
taskFunction: async () => {
|
||||
throw new Error('boom');
|
||||
},
|
||||
});
|
||||
|
||||
task.eventSubject.subscribe((e) => events.push(e));
|
||||
|
||||
try {
|
||||
await task.trigger();
|
||||
} catch {
|
||||
// expected
|
||||
}
|
||||
|
||||
expect(events.length).toEqual(2);
|
||||
expect(events[0].type).toEqual('started');
|
||||
expect(events[1].type).toEqual('failed');
|
||||
expect(events[1].error).toEqual('boom');
|
||||
});
|
||||
|
||||
tap.test('should emit failed via done.then path when catchErrors is true', async () => {
|
||||
const events: ITaskEvent[] = [];
|
||||
const task = new taskbuffer.Task({
|
||||
name: 'event-catch-fail-task',
|
||||
catchErrors: true,
|
||||
taskFunction: async () => {
|
||||
throw new Error('swallowed');
|
||||
},
|
||||
});
|
||||
|
||||
task.eventSubject.subscribe((e) => events.push(e));
|
||||
await task.trigger();
|
||||
|
||||
const types = events.map((e) => e.type);
|
||||
expect(types).toContain('started');
|
||||
expect(types).toContain('failed');
|
||||
});
|
||||
|
||||
tap.test('TaskManager.taskSubject should aggregate events from added tasks', async () => {
|
||||
const manager = new taskbuffer.TaskManager();
|
||||
const events: ITaskEvent[] = [];
|
||||
|
||||
const t1 = new taskbuffer.Task({
|
||||
name: 'agg-task-1',
|
||||
taskFunction: async () => 'a',
|
||||
});
|
||||
const t2 = new taskbuffer.Task({
|
||||
name: 'agg-task-2',
|
||||
taskFunction: async () => 'b',
|
||||
});
|
||||
|
||||
manager.addTask(t1);
|
||||
manager.addTask(t2);
|
||||
|
||||
manager.taskSubject.subscribe((e) => events.push(e));
|
||||
|
||||
await t1.trigger();
|
||||
await t2.trigger();
|
||||
|
||||
const names = [...new Set(events.map((e) => e.task.name))];
|
||||
expect(names.sort()).toEqual(['agg-task-1', 'agg-task-2']);
|
||||
expect(events.filter((e) => e.type === 'started').length).toEqual(2);
|
||||
expect(events.filter((e) => e.type === 'completed').length).toEqual(2);
|
||||
|
||||
await manager.stop();
|
||||
});
|
||||
|
||||
tap.test('events should stop after removeTask', async () => {
|
||||
const manager = new taskbuffer.TaskManager();
|
||||
const events: ITaskEvent[] = [];
|
||||
|
||||
const task = new taskbuffer.Task({
|
||||
name: 'removable-event-task',
|
||||
taskFunction: async () => 'ok',
|
||||
});
|
||||
|
||||
manager.addTask(task);
|
||||
manager.taskSubject.subscribe((e) => events.push(e));
|
||||
|
||||
await task.trigger();
|
||||
const countBefore = events.length;
|
||||
expect(countBefore).toBeGreaterThan(0);
|
||||
|
||||
manager.removeTask(task);
|
||||
|
||||
// Trigger again — events should NOT appear on manager subject
|
||||
await task.trigger();
|
||||
expect(events.length).toEqual(countBefore);
|
||||
|
||||
await manager.stop();
|
||||
});
|
||||
|
||||
tap.test('event metadata snapshots should include correct labels', async () => {
|
||||
const events: ITaskEvent[] = [];
|
||||
const task = new taskbuffer.Task({
|
||||
name: 'labelled-event-task',
|
||||
taskFunction: async () => 'ok',
|
||||
labels: { team: 'platform' },
|
||||
});
|
||||
|
||||
task.eventSubject.subscribe((e) => events.push(e));
|
||||
await task.trigger();
|
||||
|
||||
for (const e of events) {
|
||||
expect(e.task.labels).toEqual({ team: 'platform' });
|
||||
}
|
||||
});
|
||||
|
||||
export default tap.start();
|
||||
@@ -25,7 +25,7 @@ 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();
|
||||
}
|
||||
},
|
||||
@@ -38,7 +38,7 @@ tap.test('should run the task as expected', async () => {
|
||||
});
|
||||
|
||||
tap.test('should schedule task', async () => {
|
||||
myTaskManager.scheduleTaskByName('myTask', '*/10 * * * * *');
|
||||
myTaskManager.scheduleTaskByName('myTask', '*/5 * * * * *');
|
||||
await taskDone.promise;
|
||||
myTaskManager.descheduleTaskByName('myTask');
|
||||
});
|
||||
|
||||
@@ -147,7 +147,7 @@ tap.test('Task should provide complete metadata', async () => {
|
||||
|
||||
// Get metadata after execution
|
||||
metadata = task.getMetadata();
|
||||
expect(metadata.status).toEqual('idle');
|
||||
expect(metadata.status).toEqual('completed');
|
||||
expect(metadata.runCount).toEqual(1);
|
||||
expect(metadata.currentProgress).toEqual(100);
|
||||
});
|
||||
|
||||
@@ -3,6 +3,6 @@
|
||||
*/
|
||||
export const commitinfo = {
|
||||
name: '@push.rocks/taskbuffer',
|
||||
version: '3.4.0',
|
||||
version: '4.1.1',
|
||||
description: 'A flexible task management library supporting TypeScript, allowing for task buffering, scheduling, and execution with dependency management.'
|
||||
}
|
||||
|
||||
@@ -12,7 +12,7 @@ export { TaskStep } from './taskbuffer.classes.taskstep.js';
|
||||
export type { ITaskStep } from './taskbuffer.classes.taskstep.js';
|
||||
|
||||
// Metadata interfaces
|
||||
export type { ITaskMetadata, ITaskExecutionReport, IScheduledTaskInfo } from './taskbuffer.interfaces.js';
|
||||
export type { ITaskMetadata, ITaskExecutionReport, IScheduledTaskInfo, ITaskEvent, TTaskEventType } from './taskbuffer.interfaces.js';
|
||||
|
||||
import * as distributedCoordination from './taskbuffer.classes.distributedcoordinator.js';
|
||||
export { distributedCoordination };
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
import { Task } from './taskbuffer.classes.task.js';
|
||||
import { logger } from './taskbuffer.logging.js';
|
||||
|
||||
export class BufferRunner {
|
||||
public task: Task;
|
||||
@@ -24,9 +25,19 @@ export class BufferRunner {
|
||||
private async _run(x: any) {
|
||||
this.task.running = true;
|
||||
while (this.bufferCounter > 0) {
|
||||
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;
|
||||
}
|
||||
|
||||
@@ -33,4 +33,16 @@ export class CycleCounter {
|
||||
});
|
||||
this.cycleObjectArray = newCycleObjectArray;
|
||||
}
|
||||
public informOfCycleError(err: Error) {
|
||||
const newCycleObjectArray: ICycleObject[] = [];
|
||||
this.cycleObjectArray.forEach((cycleObjectArg) => {
|
||||
cycleObjectArg.cycleCounter--;
|
||||
if (cycleObjectArg.cycleCounter <= 0) {
|
||||
cycleObjectArg.deferred.reject(err);
|
||||
} else {
|
||||
newCycleObjectArray.push(cycleObjectArg);
|
||||
}
|
||||
});
|
||||
this.cycleObjectArray = newCycleObjectArray;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -2,7 +2,7 @@ import * as plugins from './taskbuffer.plugins.js';
|
||||
import { BufferRunner } from './taskbuffer.classes.bufferrunner.js';
|
||||
import { CycleCounter } from './taskbuffer.classes.cyclecounter.js';
|
||||
import { TaskStep, type ITaskStep } from './taskbuffer.classes.taskstep.js';
|
||||
import type { ITaskMetadata } from './taskbuffer.interfaces.js';
|
||||
import type { ITaskMetadata, ITaskEvent, TTaskEventType } from './taskbuffer.interfaces.js';
|
||||
|
||||
import { logger } from './taskbuffer.logging.js';
|
||||
|
||||
@@ -88,18 +88,34 @@ export class Task<T = undefined, TSteps extends ReadonlyArray<{ name: string; de
|
||||
taskToRun.runCount++;
|
||||
taskToRun.lastRun = new Date();
|
||||
|
||||
// Reset steps at the beginning of task execution
|
||||
// Reset steps and error state at the beginning of task execution
|
||||
taskToRun.resetSteps();
|
||||
taskToRun.lastError = undefined;
|
||||
taskToRun.emitEvent('started');
|
||||
|
||||
done.promise.then(async () => {
|
||||
done.promise
|
||||
.then(async () => {
|
||||
taskToRun.running = false;
|
||||
|
||||
// Complete all steps when task finishes
|
||||
taskToRun.completeAllSteps();
|
||||
taskToRun.emitEvent(taskToRun.lastError ? 'failed' : 'completed');
|
||||
|
||||
// When the task has finished running, resolve the finished promise
|
||||
taskToRun.resolveFinished();
|
||||
|
||||
// Create a new finished promise for the next run
|
||||
taskToRun.finished = new Promise((resolve) => {
|
||||
taskToRun.resolveFinished = resolve;
|
||||
});
|
||||
})
|
||||
.catch((err) => {
|
||||
taskToRun.running = false;
|
||||
taskToRun.emitEvent('failed', { error: err instanceof Error ? err.message : String(err) });
|
||||
|
||||
// Resolve finished so blocking dependants don't hang
|
||||
taskToRun.resolveFinished();
|
||||
|
||||
// Create a new finished promise for the next run
|
||||
taskToRun.finished = new Promise((resolve) => {
|
||||
taskToRun.resolveFinished = resolve;
|
||||
@@ -133,7 +149,13 @@ export class Task<T = undefined, TSteps extends ReadonlyArray<{ name: string; de
|
||||
try {
|
||||
return await taskToRun.taskFunction(x, taskToRun.setupValue);
|
||||
} catch (e) {
|
||||
console.log(e);
|
||||
taskToRun.lastError = e instanceof Error ? e : new Error(String(e));
|
||||
taskToRun.errorCount++;
|
||||
logger.log('error', `Task "${taskToRun.name || 'unnamed'}" failed: ${taskToRun.lastError.message}`);
|
||||
if (taskToRun.catchErrors) {
|
||||
return undefined;
|
||||
}
|
||||
throw e;
|
||||
}
|
||||
})
|
||||
.then((x) => {
|
||||
@@ -155,10 +177,18 @@ export class Task<T = undefined, TSteps extends ReadonlyArray<{ name: string; de
|
||||
done.resolve(x);
|
||||
})
|
||||
.catch((err) => {
|
||||
console.log(err);
|
||||
done.reject(err);
|
||||
});
|
||||
localDeferred.resolve();
|
||||
|
||||
try {
|
||||
return await done.promise;
|
||||
} catch (err) {
|
||||
if (taskToRun.catchErrors) {
|
||||
return undefined;
|
||||
}
|
||||
throw err;
|
||||
}
|
||||
};
|
||||
|
||||
public name: string;
|
||||
@@ -187,10 +217,53 @@ export class Task<T = undefined, TSteps extends ReadonlyArray<{ name: string; de
|
||||
public lastRun?: Date;
|
||||
public runCount: number = 0;
|
||||
|
||||
// Error handling
|
||||
public catchErrors: boolean = false;
|
||||
public lastError?: Error;
|
||||
public errorCount: number = 0;
|
||||
public labels: Record<string, string> = {};
|
||||
public readonly eventSubject = new plugins.smartrx.rxjs.Subject<ITaskEvent>();
|
||||
|
||||
public get idle() {
|
||||
return !this.running;
|
||||
}
|
||||
|
||||
public clearError(): void {
|
||||
this.lastError = undefined;
|
||||
}
|
||||
|
||||
public setLabel(key: string, value: string): void {
|
||||
this.labels[key] = value;
|
||||
}
|
||||
|
||||
public getLabel(key: string): string | undefined {
|
||||
return this.labels[key];
|
||||
}
|
||||
|
||||
public removeLabel(key: string): boolean {
|
||||
if (key in this.labels) {
|
||||
delete this.labels[key];
|
||||
return true;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
public hasLabel(key: string, value?: string): boolean {
|
||||
if (value !== undefined) {
|
||||
return this.labels[key] === value;
|
||||
}
|
||||
return key in this.labels;
|
||||
}
|
||||
|
||||
private emitEvent(type: TTaskEventType, extra?: Partial<ITaskEvent>): void {
|
||||
this.eventSubject.next({
|
||||
type,
|
||||
task: this.getMetadata(),
|
||||
timestamp: Date.now(),
|
||||
...extra,
|
||||
});
|
||||
}
|
||||
|
||||
public taskSetup: ITaskSetupFunction<T>;
|
||||
public setupValue: T;
|
||||
|
||||
@@ -210,6 +283,8 @@ export class Task<T = undefined, TSteps extends ReadonlyArray<{ name: string; de
|
||||
name?: string;
|
||||
taskSetup?: ITaskSetupFunction<T>;
|
||||
steps?: TSteps;
|
||||
catchErrors?: boolean;
|
||||
labels?: Record<string, string>;
|
||||
}) {
|
||||
this.taskFunction = optionsArg.taskFunction;
|
||||
this.preTask = optionsArg.preTask;
|
||||
@@ -219,6 +294,8 @@ export class Task<T = undefined, TSteps extends ReadonlyArray<{ name: string; de
|
||||
this.execDelay = optionsArg.execDelay;
|
||||
this.name = optionsArg.name;
|
||||
this.taskSetup = optionsArg.taskSetup;
|
||||
this.catchErrors = optionsArg.catchErrors ?? false;
|
||||
this.labels = optionsArg.labels ? { ...optionsArg.labels } : {};
|
||||
|
||||
// Initialize steps if provided
|
||||
if (optionsArg.steps) {
|
||||
@@ -271,8 +348,8 @@ export class Task<T = undefined, TSteps extends ReadonlyArray<{ name: string; de
|
||||
if (step) {
|
||||
step.start();
|
||||
this.currentStepName = stepName as string;
|
||||
this.emitEvent('step', { stepName: stepName as string });
|
||||
|
||||
// Emit event for frontend updates (could be enhanced with event emitter)
|
||||
if (this.name) {
|
||||
logger.log('info', `Task ${this.name}: Starting step "${stepName}" - ${step.description}`);
|
||||
}
|
||||
@@ -306,10 +383,21 @@ export class Task<T = undefined, TSteps extends ReadonlyArray<{ name: string; de
|
||||
|
||||
// Get task metadata
|
||||
public getMetadata(): ITaskMetadata {
|
||||
let status: 'idle' | 'running' | 'completed' | 'failed';
|
||||
if (this.running) {
|
||||
status = 'running';
|
||||
} else if (this.lastError) {
|
||||
status = 'failed';
|
||||
} else if (this.runCount > 0) {
|
||||
status = 'completed';
|
||||
} else {
|
||||
status = 'idle';
|
||||
}
|
||||
|
||||
return {
|
||||
name: this.name || 'unnamed',
|
||||
version: this.version,
|
||||
status: this.running ? 'running' : 'idle',
|
||||
status,
|
||||
steps: this.getStepsMetadata(),
|
||||
currentStep: this.currentStepName,
|
||||
currentProgress: this.getProgress(),
|
||||
@@ -318,6 +406,9 @@ export class Task<T = undefined, TSteps extends ReadonlyArray<{ name: string; de
|
||||
bufferMax: this.bufferMax,
|
||||
timeout: this.timeout,
|
||||
cronSchedule: this.cronJob?.cronExpression,
|
||||
lastError: this.lastError?.message,
|
||||
errorCount: this.errorCount,
|
||||
labels: { ...this.labels },
|
||||
};
|
||||
}
|
||||
|
||||
|
||||
@@ -27,18 +27,20 @@ export class Taskchain extends Task {
|
||||
let taskCounter = 0; // counter for iterating async over the taskArray
|
||||
const iterateTasks = (x: any) => {
|
||||
if (typeof this.taskArray[taskCounter] !== 'undefined') {
|
||||
console.log(
|
||||
this.name + ' running: Task' + this.taskArray[taskCounter].name,
|
||||
);
|
||||
logger.log('info', `${this.name} running: Task ${this.taskArray[taskCounter].name}`);
|
||||
this.taskArray[taskCounter].trigger(x).then((x) => {
|
||||
logger.log('info', this.taskArray[taskCounter].name);
|
||||
taskCounter++;
|
||||
iterateTasks(x);
|
||||
}).catch((err) => {
|
||||
const chainError = new Error(
|
||||
`Taskchain "${this.name}": task "${this.taskArray[taskCounter].name || 'unnamed'}" (index ${taskCounter}) failed: ${err instanceof Error ? err.message : String(err)}`
|
||||
);
|
||||
(chainError as any).cause = err;
|
||||
done.reject(chainError);
|
||||
});
|
||||
} else {
|
||||
console.log(
|
||||
'Taskchain "' + this.name + '" completed successfully',
|
||||
);
|
||||
logger.log('info', `Taskchain "${this.name}" completed successfully`);
|
||||
done.resolve(x);
|
||||
}
|
||||
};
|
||||
@@ -53,10 +55,15 @@ export class Taskchain extends Task {
|
||||
addTask(taskArg: Task) {
|
||||
this.taskArray.push(taskArg);
|
||||
}
|
||||
removeTask(taskArg: Task) {
|
||||
// TODO:
|
||||
removeTask(taskArg: Task): boolean {
|
||||
const index = this.taskArray.indexOf(taskArg);
|
||||
if (index === -1) {
|
||||
return false;
|
||||
}
|
||||
shiftTask() {
|
||||
// TODO:
|
||||
this.taskArray.splice(index, 1);
|
||||
return true;
|
||||
}
|
||||
shiftTask(): Task | undefined {
|
||||
return this.taskArray.shift();
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
import * as plugins from './taskbuffer.plugins.js';
|
||||
|
||||
import { Task, type ITaskFunction } from './taskbuffer.classes.task.js';
|
||||
import { logger } from './taskbuffer.logging.js';
|
||||
|
||||
export class TaskDebounced<T = unknown> extends Task {
|
||||
private _debouncedTaskFunction: ITaskFunction;
|
||||
@@ -22,8 +23,17 @@ export class TaskDebounced<T = unknown> extends Task {
|
||||
.pipe(
|
||||
plugins.smartrx.rxjs.ops.debounceTime(optionsArg.debounceTimeInMillis),
|
||||
)
|
||||
.subscribe((x) => {
|
||||
this.taskFunction(x);
|
||||
.subscribe({
|
||||
next: async (x) => {
|
||||
try {
|
||||
await this.taskFunction(x);
|
||||
} catch (err) {
|
||||
logger.log('error', `TaskDebounced "${this.name || 'unnamed'}" failed: ${err instanceof Error ? err.message : String(err)}`);
|
||||
}
|
||||
},
|
||||
error: (err) => {
|
||||
logger.log('error', `TaskDebounced "${this.name || 'unnamed'}" observable error: ${err instanceof Error ? err.message : String(err)}`);
|
||||
},
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -4,7 +4,8 @@ import {
|
||||
AbstractDistributedCoordinator,
|
||||
type IDistributedTaskRequestResult,
|
||||
} from './taskbuffer.classes.distributedcoordinator.js';
|
||||
import type { ITaskMetadata, ITaskExecutionReport, IScheduledTaskInfo } from './taskbuffer.interfaces.js';
|
||||
import type { ITaskMetadata, ITaskExecutionReport, IScheduledTaskInfo, ITaskEvent } from './taskbuffer.interfaces.js';
|
||||
import { logger } from './taskbuffer.logging.js';
|
||||
|
||||
export interface ICronJob {
|
||||
cronString: string;
|
||||
@@ -19,6 +20,8 @@ export interface ITaskManagerConstructorOptions {
|
||||
export class TaskManager {
|
||||
public randomId = plugins.smartunique.shortId();
|
||||
public taskMap = new plugins.lik.ObjectMap<Task<any, any>>();
|
||||
public readonly taskSubject = new plugins.smartrx.rxjs.Subject<ITaskEvent>();
|
||||
private taskSubscriptions = new Map<Task<any, any>, plugins.smartrx.rxjs.Subscription>();
|
||||
private cronJobManager = new plugins.smarttime.CronManager();
|
||||
public options: ITaskManagerConstructorOptions = {
|
||||
distributedCoordinator: null,
|
||||
@@ -37,6 +40,19 @@ export class TaskManager {
|
||||
throw new Error('Task must have a name to be added to taskManager');
|
||||
}
|
||||
this.taskMap.add(task);
|
||||
const subscription = task.eventSubject.subscribe((event) => {
|
||||
this.taskSubject.next(event);
|
||||
});
|
||||
this.taskSubscriptions.set(task, subscription);
|
||||
}
|
||||
|
||||
public removeTask(task: Task<any, any>): void {
|
||||
this.taskMap.remove(task);
|
||||
const subscription = this.taskSubscriptions.get(task);
|
||||
if (subscription) {
|
||||
subscription.unsubscribe();
|
||||
this.taskSubscriptions.delete(task);
|
||||
}
|
||||
}
|
||||
|
||||
public addAndScheduleTask(task: Task<any, any>, cronString: string) {
|
||||
@@ -75,31 +91,35 @@ export class TaskManager {
|
||||
triggerTime,
|
||||
);
|
||||
if (!announcementResult.shouldTrigger) {
|
||||
console.log('Distributed coordinator result: NOT EXECUTING');
|
||||
logger.log('info', 'Distributed coordinator result: NOT EXECUTING');
|
||||
return;
|
||||
} else {
|
||||
console.log('Distributed coordinator result: CHOSEN AND EXECUTING');
|
||||
logger.log('info', 'Distributed coordinator result: CHOSEN AND EXECUTING');
|
||||
}
|
||||
}
|
||||
try {
|
||||
await task.trigger();
|
||||
} catch (err) {
|
||||
logger.log('error', `TaskManager: scheduled task "${task.name || 'unnamed'}" failed: ${err instanceof Error ? err.message : String(err)}`);
|
||||
}
|
||||
},
|
||||
);
|
||||
task.cronJob = cronJob;
|
||||
}
|
||||
|
||||
private logTaskState(task: Task<any, any>) {
|
||||
console.log(`Taskbuffer schedule triggered task >>${task.name}<<`);
|
||||
logger.log('info', `Taskbuffer schedule triggered task >>${task.name}<<`);
|
||||
const bufferState = task.buffered
|
||||
? `buffered with max ${task.bufferMax} buffered calls`
|
||||
: `unbuffered`;
|
||||
console.log(`Task >>${task.name}<< is ${bufferState}`);
|
||||
logger.log('info', `Task >>${task.name}<< is ${bufferState}`);
|
||||
}
|
||||
|
||||
private async performDistributedConsultation(
|
||||
task: Task<any, any>,
|
||||
triggerTime: number,
|
||||
): Promise<IDistributedTaskRequestResult> {
|
||||
console.log('Found a distributed coordinator, performing consultation.');
|
||||
logger.log('info', 'Found a distributed coordinator, performing consultation.');
|
||||
|
||||
return this.options.distributedCoordinator.fireDistributedTaskRequest({
|
||||
submitterId: this.randomId,
|
||||
@@ -145,6 +165,10 @@ export class TaskManager {
|
||||
if (this.options.distributedCoordinator) {
|
||||
await this.options.distributedCoordinator.stop();
|
||||
}
|
||||
for (const [, subscription] of this.taskSubscriptions) {
|
||||
subscription.unsubscribe();
|
||||
}
|
||||
this.taskSubscriptions.clear();
|
||||
}
|
||||
|
||||
// Get metadata for a specific task
|
||||
@@ -193,6 +217,14 @@ export class TaskManager {
|
||||
return scheduledRuns;
|
||||
}
|
||||
|
||||
public getTasksByLabel(key: string, value: string): Task<any, any>[] {
|
||||
return this.taskMap.getArray().filter(task => task.labels[key] === value);
|
||||
}
|
||||
|
||||
public getTasksMetadataByLabel(key: string, value: string): ITaskMetadata[] {
|
||||
return this.getTasksByLabel(key, value).map(task => task.getMetadata());
|
||||
}
|
||||
|
||||
// Add, execute, and remove a task while collecting metadata
|
||||
public async addExecuteRemoveTask<T, TSteps extends ReadonlyArray<{ name: string; description: string; percentage: number }>>(
|
||||
task: Task<T, TSteps>,
|
||||
@@ -231,7 +263,7 @@ export class TaskManager {
|
||||
};
|
||||
|
||||
// Remove task from manager
|
||||
this.taskMap.remove(task);
|
||||
this.removeTask(task);
|
||||
|
||||
// Deschedule if it was scheduled
|
||||
if (options?.schedule && task.name) {
|
||||
@@ -255,7 +287,7 @@ export class TaskManager {
|
||||
};
|
||||
|
||||
// Remove task from manager even on error
|
||||
this.taskMap.remove(task);
|
||||
this.removeTask(task);
|
||||
|
||||
// Deschedule if it was scheduled
|
||||
if (options?.schedule && task.name) {
|
||||
|
||||
@@ -13,7 +13,9 @@ export class Taskparallel extends Task {
|
||||
this.taskArray.forEach(function (taskArg) {
|
||||
promiseArray.push(taskArg.trigger());
|
||||
});
|
||||
Promise.all(promiseArray).then(done.resolve);
|
||||
Promise.all(promiseArray)
|
||||
.then((results) => done.resolve(results))
|
||||
.catch((err) => done.reject(err));
|
||||
return done.promise;
|
||||
},
|
||||
},
|
||||
|
||||
@@ -1,13 +1,14 @@
|
||||
import * as plugins from './taskbuffer.plugins.js';
|
||||
|
||||
import { Task } from './taskbuffer.classes.task.js';
|
||||
import { logger } from './taskbuffer.logging.js';
|
||||
|
||||
export class TaskRunner {
|
||||
public maxParrallelJobs: number = 1;
|
||||
public maxParallelJobs: number = 1;
|
||||
public status: 'stopped' | 'running' = 'stopped';
|
||||
public runningTasks: plugins.lik.ObjectMap<Task> =
|
||||
new plugins.lik.ObjectMap<Task>();
|
||||
public qeuedTasks: Task[] = [];
|
||||
public queuedTasks: Task[] = [];
|
||||
|
||||
constructor() {
|
||||
this.runningTasks.eventSubject.subscribe(async (eventArg) => {
|
||||
@@ -16,19 +17,19 @@ export class TaskRunner {
|
||||
}
|
||||
|
||||
/**
|
||||
* adds a task to the qeue
|
||||
* adds a task to the queue
|
||||
*/
|
||||
public addTask(taskArg: Task) {
|
||||
this.qeuedTasks.push(taskArg);
|
||||
this.queuedTasks.push(taskArg);
|
||||
this.checkExecution();
|
||||
}
|
||||
|
||||
/**
|
||||
* set amount of parallel tasks
|
||||
* be careful, you might loose dependability of tasks
|
||||
* be careful, you might lose dependability of tasks
|
||||
*/
|
||||
public setMaxParallelJobs(maxParrallelJobsArg: number) {
|
||||
this.maxParrallelJobs = maxParrallelJobsArg;
|
||||
public setMaxParallelJobs(maxParallelJobsArg: number) {
|
||||
this.maxParallelJobs = maxParallelJobsArg;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -39,17 +40,21 @@ export class TaskRunner {
|
||||
}
|
||||
|
||||
/**
|
||||
* checks wether execution is on point
|
||||
* checks whether execution is on point
|
||||
*/
|
||||
public async checkExecution() {
|
||||
if (
|
||||
this.runningTasks.getArray().length < this.maxParrallelJobs &&
|
||||
this.runningTasks.getArray().length < this.maxParallelJobs &&
|
||||
this.status === 'running' &&
|
||||
this.qeuedTasks.length > 0
|
||||
this.queuedTasks.length > 0
|
||||
) {
|
||||
const nextJob = this.qeuedTasks.shift();
|
||||
const nextJob = this.queuedTasks.shift();
|
||||
this.runningTasks.add(nextJob);
|
||||
try {
|
||||
await nextJob.trigger();
|
||||
} catch (err) {
|
||||
logger.log('error', `TaskRunner: task "${nextJob.name || 'unnamed'}" failed: ${err instanceof Error ? err.message : String(err)}`);
|
||||
}
|
||||
this.runningTasks.remove(nextJob);
|
||||
this.checkExecution();
|
||||
}
|
||||
|
||||
@@ -15,6 +15,9 @@ export interface ITaskMetadata {
|
||||
buffered?: boolean;
|
||||
bufferMax?: number;
|
||||
timeout?: number;
|
||||
lastError?: string;
|
||||
errorCount?: number;
|
||||
labels?: Record<string, string>;
|
||||
}
|
||||
|
||||
export interface ITaskExecutionReport {
|
||||
@@ -37,3 +40,13 @@ export interface IScheduledTaskInfo {
|
||||
steps?: ITaskStep[];
|
||||
metadata?: ITaskMetadata;
|
||||
}
|
||||
|
||||
export type TTaskEventType = 'started' | 'step' | 'completed' | 'failed';
|
||||
|
||||
export interface ITaskEvent {
|
||||
type: TTaskEventType;
|
||||
task: ITaskMetadata;
|
||||
timestamp: number;
|
||||
stepName?: string; // present when type === 'step'
|
||||
error?: string; // present when type === 'failed'
|
||||
}
|
||||
@@ -3,6 +3,6 @@
|
||||
*/
|
||||
export const commitinfo = {
|
||||
name: '@push.rocks/taskbuffer',
|
||||
version: '3.4.0',
|
||||
version: '4.1.1',
|
||||
description: 'A flexible task management library supporting TypeScript, allowing for task buffering, scheduling, and execution with dependency management.'
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user