Compare commits
69 Commits
Author | SHA1 | Date | |
---|---|---|---|
4d23b3dbfe | |||
9784a5eacf | |||
6c9b975029 | |||
b1725cbdf9 | |||
d54012379c | |||
dc47bc3d2a | |||
863adb3b8c | |||
67f01417b6 | |||
65886287c6 | |||
fdaf772cfc | |||
757b992440 | |||
b4a701d128 | |||
ca3ef8ced6 | |||
6115bae66b | |||
1be83af475 | |||
bd14c41edc | |||
d61b79282d | |||
1cba9245fe | |||
4b0db4da21 | |||
a6cd0cb579 | |||
bd6109d5ea | |||
aa632a5294 | |||
6499dd45cf | |||
d04ed21607 | |||
bae776d4e9 | |||
fcd7ea467e | |||
e061b96056 | |||
c2ce669f0c | |||
05f91c3e35 | |||
94e327c722 | |||
57a27604a7 | |||
b077bd7a1b | |||
f2c2dab782 | |||
53a67c0ebe | |||
5240a80cb3 | |||
fa8be6b6d3 | |||
b5981d67cf | |||
493cd83dda | |||
86b2842ed2 | |||
801e2ad266 | |||
7f837c70fc | |||
f5ca4a696c | |||
b48d42dfb9 | |||
5bf568d0cd | |||
173e1ca35d | |||
ce258c76d2 | |||
4d2756b743 | |||
973678d635 | |||
28e7bad605 | |||
fb44dd47fc | |||
a2f6bccac2 | |||
e4f8be5603 | |||
84f186924e | |||
ff57dccee1 | |||
a9d84d5147 | |||
ae6a6ce67e | |||
05b14136f9 | |||
bf9ca39c36 | |||
e61791ec41 | |||
9001a96df0 | |||
835fa3663d | |||
f50384947d | |||
65c1dd8fdc | |||
613d46bb38 | |||
439da1f342 | |||
e9e4a60fe6 | |||
1630f6971f | |||
7bfb145513 | |||
c367f0f949 |
66
.gitea/workflows/default_nottags.yaml
Normal file
66
.gitea/workflows/default_nottags.yaml
Normal file
@@ -0,0 +1,66 @@
|
||||
name: Default (not tags)
|
||||
|
||||
on:
|
||||
push:
|
||||
tags-ignore:
|
||||
- '**'
|
||||
|
||||
env:
|
||||
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}}
|
||||
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
|
||||
|
||||
jobs:
|
||||
security:
|
||||
runs-on: ubuntu-latest
|
||||
continue-on-error: true
|
||||
container:
|
||||
image: ${{ env.IMAGE }}
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Install pnpm and npmci
|
||||
run: |
|
||||
pnpm install -g pnpm
|
||||
pnpm install -g @ship.zone/npmci
|
||||
|
||||
- name: Run npm prepare
|
||||
run: npmci npm prepare
|
||||
|
||||
- name: Audit production dependencies
|
||||
run: |
|
||||
npmci command npm config set registry https://registry.npmjs.org
|
||||
npmci command pnpm audit --audit-level=high --prod
|
||||
continue-on-error: true
|
||||
|
||||
- name: Audit development dependencies
|
||||
run: |
|
||||
npmci command npm config set registry https://registry.npmjs.org
|
||||
npmci command pnpm audit --audit-level=high --dev
|
||||
continue-on-error: true
|
||||
|
||||
test:
|
||||
if: ${{ always() }}
|
||||
needs: security
|
||||
runs-on: ubuntu-latest
|
||||
container:
|
||||
image: ${{ env.IMAGE }}
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Test stable
|
||||
run: |
|
||||
npmci node install stable
|
||||
npmci npm install
|
||||
npmci npm test
|
||||
|
||||
- name: Test build
|
||||
run: |
|
||||
npmci node install stable
|
||||
npmci npm install
|
||||
npmci npm build
|
124
.gitea/workflows/default_tags.yaml
Normal file
124
.gitea/workflows/default_tags.yaml
Normal file
@@ -0,0 +1,124 @@
|
||||
name: Default (tags)
|
||||
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- '*'
|
||||
|
||||
env:
|
||||
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}}
|
||||
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
|
||||
|
||||
jobs:
|
||||
security:
|
||||
runs-on: ubuntu-latest
|
||||
continue-on-error: true
|
||||
container:
|
||||
image: ${{ env.IMAGE }}
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Prepare
|
||||
run: |
|
||||
pnpm install -g pnpm
|
||||
pnpm install -g @ship.zone/npmci
|
||||
npmci npm prepare
|
||||
|
||||
- name: Audit production dependencies
|
||||
run: |
|
||||
npmci command npm config set registry https://registry.npmjs.org
|
||||
npmci command pnpm audit --audit-level=high --prod
|
||||
continue-on-error: true
|
||||
|
||||
- name: Audit development dependencies
|
||||
run: |
|
||||
npmci command npm config set registry https://registry.npmjs.org
|
||||
npmci command pnpm audit --audit-level=high --dev
|
||||
continue-on-error: true
|
||||
|
||||
test:
|
||||
if: ${{ always() }}
|
||||
needs: security
|
||||
runs-on: ubuntu-latest
|
||||
container:
|
||||
image: ${{ env.IMAGE }}
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Prepare
|
||||
run: |
|
||||
pnpm install -g pnpm
|
||||
pnpm install -g @ship.zone/npmci
|
||||
npmci npm prepare
|
||||
|
||||
- name: Test stable
|
||||
run: |
|
||||
npmci node install stable
|
||||
npmci npm install
|
||||
npmci npm test
|
||||
|
||||
- name: Test build
|
||||
run: |
|
||||
npmci node install stable
|
||||
npmci npm install
|
||||
npmci npm build
|
||||
|
||||
release:
|
||||
needs: test
|
||||
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
|
||||
runs-on: ubuntu-latest
|
||||
container:
|
||||
image: ${{ env.IMAGE }}
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Prepare
|
||||
run: |
|
||||
pnpm install -g pnpm
|
||||
pnpm install -g @ship.zone/npmci
|
||||
npmci npm prepare
|
||||
|
||||
- name: Release
|
||||
run: |
|
||||
npmci node install stable
|
||||
npmci npm publish
|
||||
|
||||
metadata:
|
||||
needs: test
|
||||
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
|
||||
runs-on: ubuntu-latest
|
||||
container:
|
||||
image: ${{ env.IMAGE }}
|
||||
continue-on-error: true
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Prepare
|
||||
run: |
|
||||
pnpm install -g pnpm
|
||||
pnpm install -g @ship.zone/npmci
|
||||
npmci npm prepare
|
||||
|
||||
- name: Code quality
|
||||
run: |
|
||||
npmci command npm install -g typescript
|
||||
npmci npm install
|
||||
|
||||
- name: Trigger
|
||||
run: npmci trigger
|
||||
|
||||
- name: Build docs and upload artifacts
|
||||
run: |
|
||||
npmci node install stable
|
||||
npmci npm install
|
||||
pnpm install -g @git.zone/tsdoc
|
||||
npmci command tsdoc
|
||||
continue-on-error: true
|
7
.gitignore
vendored
7
.gitignore
vendored
@@ -3,7 +3,6 @@
|
||||
# artifacts
|
||||
coverage/
|
||||
public/
|
||||
pages/
|
||||
|
||||
# installs
|
||||
node_modules/
|
||||
@@ -17,4 +16,8 @@ node_modules/
|
||||
dist/
|
||||
dist_*/
|
||||
|
||||
# custom
|
||||
# AI
|
||||
.claude/
|
||||
.serena/
|
||||
|
||||
#------# custom
|
137
.gitlab-ci.yml
137
.gitlab-ci.yml
@@ -1,137 +0,0 @@
|
||||
# gitzone ci_default
|
||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
|
||||
cache:
|
||||
paths:
|
||||
- .npmci_cache/
|
||||
key: '$CI_BUILD_STAGE'
|
||||
|
||||
stages:
|
||||
- security
|
||||
- test
|
||||
- release
|
||||
- metadata
|
||||
|
||||
# ====================
|
||||
# security stage
|
||||
# ====================
|
||||
mirror:
|
||||
stage: security
|
||||
script:
|
||||
- npmci git mirror
|
||||
only:
|
||||
- tags
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
auditProductionDependencies:
|
||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
stage: security
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci command npm install --production --ignore-scripts
|
||||
- npmci command npm config set registry https://registry.npmjs.org
|
||||
- npmci command npm audit --audit-level=high --only=prod --production
|
||||
tags:
|
||||
- docker
|
||||
|
||||
auditDevDependencies:
|
||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
stage: security
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci command npm install --ignore-scripts
|
||||
- npmci command npm config set registry https://registry.npmjs.org
|
||||
- npmci command npm audit --audit-level=high --only=dev
|
||||
tags:
|
||||
- docker
|
||||
allow_failure: true
|
||||
|
||||
# ====================
|
||||
# test stage
|
||||
# ====================
|
||||
|
||||
testStable:
|
||||
stage: test
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci node install stable
|
||||
- npmci npm install
|
||||
- npmci npm test
|
||||
coverage: /\d+.?\d+?\%\s*coverage/
|
||||
tags:
|
||||
- docker
|
||||
|
||||
testBuild:
|
||||
stage: test
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci node install stable
|
||||
- npmci npm install
|
||||
- npmci command npm run build
|
||||
coverage: /\d+.?\d+?\%\s*coverage/
|
||||
tags:
|
||||
- docker
|
||||
|
||||
release:
|
||||
stage: release
|
||||
script:
|
||||
- npmci node install stable
|
||||
- npmci npm publish
|
||||
only:
|
||||
- tags
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
# ====================
|
||||
# metadata stage
|
||||
# ====================
|
||||
codequality:
|
||||
stage: metadata
|
||||
allow_failure: true
|
||||
only:
|
||||
- tags
|
||||
script:
|
||||
- npmci command npm install -g tslint typescript
|
||||
- npmci npm prepare
|
||||
- npmci npm install
|
||||
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- priv
|
||||
|
||||
trigger:
|
||||
stage: metadata
|
||||
script:
|
||||
- npmci trigger
|
||||
only:
|
||||
- tags
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
pages:
|
||||
stage: metadata
|
||||
script:
|
||||
- npmci node install lts
|
||||
- npmci command npm install -g @gitzone/tsdoc
|
||||
- npmci npm prepare
|
||||
- npmci npm install
|
||||
- npmci command tsdoc
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
only:
|
||||
- tags
|
||||
artifacts:
|
||||
expire_in: 1 week
|
||||
paths:
|
||||
- public
|
||||
allow_failure: true
|
BIN
.serena/cache/typescript/document_symbols_cache_v23-06-25.pkl
vendored
Normal file
BIN
.serena/cache/typescript/document_symbols_cache_v23-06-25.pkl
vendored
Normal file
Binary file not shown.
35
.serena/memories/code_style_conventions.md
Normal file
35
.serena/memories/code_style_conventions.md
Normal file
@@ -0,0 +1,35 @@
|
||||
# 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)
|
27
.serena/memories/project_overview.md
Normal file
27
.serena/memories/project_overview.md
Normal file
@@ -0,0 +1,27 @@
|
||||
# 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
|
67
.serena/memories/suggested_commands.md
Normal file
67
.serena/memories/suggested_commands.md
Normal file
@@ -0,0 +1,67 @@
|
||||
# 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
|
||||
```
|
37
.serena/memories/task_completion_checklist.md
Normal file
37
.serena/memories/task_completion_checklist.md
Normal file
@@ -0,0 +1,37 @@
|
||||
# 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
|
68
.serena/project.yml
Normal file
68
.serena/project.yml
Normal file
@@ -0,0 +1,68 @@
|
||||
# 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"
|
24
.vscode/launch.json
vendored
24
.vscode/launch.json
vendored
@@ -2,28 +2,10 @@
|
||||
"version": "0.2.0",
|
||||
"configurations": [
|
||||
{
|
||||
"name": "current file",
|
||||
"type": "node",
|
||||
"command": "npm test",
|
||||
"name": "Run npm test",
|
||||
"request": "launch",
|
||||
"args": [
|
||||
"${relativeFile}"
|
||||
],
|
||||
"runtimeArgs": ["-r", "@gitzone/tsrun"],
|
||||
"cwd": "${workspaceRoot}",
|
||||
"protocol": "inspector",
|
||||
"internalConsoleOptions": "openOnSessionStart"
|
||||
},
|
||||
{
|
||||
"name": "test.ts",
|
||||
"type": "node",
|
||||
"request": "launch",
|
||||
"args": [
|
||||
"test/test.ts"
|
||||
],
|
||||
"runtimeArgs": ["-r", "@gitzone/tsrun"],
|
||||
"cwd": "${workspaceRoot}",
|
||||
"protocol": "inspector",
|
||||
"internalConsoleOptions": "openOnSessionStart"
|
||||
"type": "node-terminal"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
129
changelog.md
Normal file
129
changelog.md
Normal file
@@ -0,0 +1,129 @@
|
||||
# Changelog
|
||||
|
||||
## 2025-09-06 - 3.2.0 - feat(core)
|
||||
Add step-based progress tracking, task metadata and enhanced TaskManager scheduling/metadata APIs
|
||||
|
||||
- Introduce TaskStep class for named, weighted steps with timing and status (pending|active|completed).
|
||||
- Add step-tracking to Task: notifyStep, getProgress, getStepsMetadata, getMetadata, resetSteps and internal step lifecycle handling.
|
||||
- Task now records runCount and lastRun; Task.run flow resets/cleans steps and aggregates progress.
|
||||
- TaskManager enhancements: schedule/deschedule improvements, performDistributedConsultation, and new metadata-focused APIs: getTaskMetadata, getAllTasksMetadata, getScheduledTasks, getNextScheduledRuns, addExecuteRemoveTask (exec + collect report).
|
||||
- Exports updated: TaskStep and related types exported from index, plus Task metadata interfaces.
|
||||
- Comprehensive README updates documenting step-based progress tracking, metadata, TaskManager and examples.
|
||||
- New/updated tests added for step behavior and metadata (test/test.9.steps.ts) and other TS additions.
|
||||
- Minor build/script change: build script updated to use 'tsbuild tsfolders'.
|
||||
|
||||
## 2025-08-26 - 3.1.10 - fix(task)
|
||||
Implement core Task execution flow, buffering and lifecycle; update README with generics and buffer docs
|
||||
|
||||
- Implement Task.runTask including preTask/afterTask chaining, touched-task cycle prevention and error handling.
|
||||
- Add Task helpers: extractTask, isTask, isTaskTouched and emptyTaskFunction (resolved promise).
|
||||
- Introduce task lifecycle coordination: finished promise, resolveFinished, and blockingTasks to await dependent tasks.
|
||||
- Support taskSetup/setupValue, execDelay handling, and wait-for-blocking-tasks before execution.
|
||||
- Wire up trigger() to choose buffered vs unbuffered execution (triggerBuffered / triggerUnBuffered) and integrate BufferRunner.
|
||||
- Improve logging and safer promise handling (caught errors are logged).
|
||||
- Update README with extended TypeScript generics examples and expanded buffer behavior and strategies documentation.
|
||||
|
||||
## 2025-08-26 - 3.1.9 - fix(tests)
|
||||
Update CI workflows, fix tests and refresh README/package metadata
|
||||
|
||||
- CI: switch Docker image to code.foss.global/host.today/ht-docker-node:npmci and adjust NPMCI_COMPUTED_REPOURL; replace npmci installer package name from @shipzone/npmci to @ship.zone/npmci in Gitea workflows
|
||||
- Tests: update test imports to use @git.zone/tstest/tapbundle and apply small formatting fixes to test files
|
||||
- Package metadata: update bugs URL and homepage to code.foss.global, add a pnpm.overrides placeholder in package.json
|
||||
- .gitignore: add AI/tooling directories (.claude, .serena) and reorganize custom section
|
||||
- Code style/TS fixes: minor formatting changes across ts sources (trailing commas, line breaks, consistent object/argument commas) and small API surface formatting fixes
|
||||
- Documentation: whitespace/formatting cleanups in README and add changelog entry for 3.1.8
|
||||
|
||||
## 2025-08-26 - 3.1.8 - fix(tests)
|
||||
|
||||
Update test runner and imports, refresh README and package metadata, add project tooling/config files
|
||||
|
||||
- Replaced test imports from '@push.rocks/tapbundle' to '@git.zone/tstest/tapbundle' across test files
|
||||
- Updated test script in package.json to run tstest with --verbose --logfile --timeout 120
|
||||
- Bumped devDependency @git.zone/tstest to ^2.3.5 and adjusted package.json fields (typings, packageManager)
|
||||
- Expanded and rewrote README with detailed examples, API reference, and usage guidance
|
||||
- Refactored TaskManager tests (removed duplicate both-file and added consolidated test/test.4.taskmanager.ts)
|
||||
- Added development/project tooling and metadata files (.claude settings, .serena project/memories) to aid local development and CI
|
||||
|
||||
## 2024-05-29 - 3.1.7 - maintenance/config
|
||||
|
||||
Updated package metadata and build configuration.
|
||||
|
||||
- Updated package description.
|
||||
- Multiple TypeScript configuration updates (tsconfig).
|
||||
- Updated npmextra.json githost entries (changes across 2024-03-30, 2024-04-01, 2024-04-14).
|
||||
|
||||
## 2023-08-04 - 3.0.15 - feat(Task)
|
||||
|
||||
Tasks can now be blocked by other tasks.
|
||||
|
||||
- Introduced task blocking support in the Task implementation.
|
||||
- Release contains related maintenance and patch fixes.
|
||||
|
||||
## 2023-01-07 to 2023-10-20 - 3.0.4..3.1.6 - maintenance
|
||||
|
||||
Series of patch releases focused on core fixes and stability.
|
||||
|
||||
- Numerous core fixes and small adjustments across many patch versions.
|
||||
- General maintenance: bug fixes, internal updates and stability improvements.
|
||||
|
||||
## 2022-03-25 - 2.1.17 - BREAKING(core)
|
||||
|
||||
Switched module format to ESM (breaking).
|
||||
|
||||
- BREAKING CHANGE: project now uses ESM module format.
|
||||
- Release includes the version bump and migration to ESM.
|
||||
|
||||
## 2019-11-28 - 2.0.16 - feat(taskrunner)
|
||||
|
||||
Introduce a working task runner.
|
||||
|
||||
- Added/activated a working taskrunner implementation.
|
||||
- Improvements to task execution and orchestration.
|
||||
|
||||
## 2019-09-05 to 2022-11-14 - 2.0.3..2.1.16 - maintenance
|
||||
|
||||
Ongoing maintenance and incremental fixes between 2.0.x and 2.1.x series.
|
||||
|
||||
- Multiple fixes labeled as core maintenance updates.
|
||||
- CI, packaging and small doc/test fixes rolled out across these releases.
|
||||
|
||||
## 2018-08-04 - 2.0.0 - major
|
||||
|
||||
Major release and scope change with CI/test updates.
|
||||
|
||||
- Released 2.0.0 with updated docs.
|
||||
- BREAKING CHANGE: package scope switched to @pushrocks (scope migration).
|
||||
- CI and testing updates (moved to new tstest), package.json adjustments.
|
||||
|
||||
## 2017-07-12 - 1.0.21 - enhancements
|
||||
|
||||
Feature additions around task utilities and manager.
|
||||
|
||||
- Introduced TaskOnce.
|
||||
- Implemented TaskManager (added TaskManager class and improvements across 1.0.10–1.0.16).
|
||||
- Implemented execDelay for tasks.
|
||||
- Documentation and test improvements.
|
||||
|
||||
## 2016-08-03 - 1.0.6 - types
|
||||
|
||||
Type and promise improvements.
|
||||
|
||||
- Now returns correct Promise types.
|
||||
- Dependency and typings updates.
|
||||
|
||||
## 2016-08-01 - 1.0.0 - stable
|
||||
|
||||
First stable 1.0.0 release.
|
||||
|
||||
- Exported public interfaces.
|
||||
- Base API stabilized for 1.x line.
|
||||
|
||||
## 2016-05-15 to 2016-05-06 - 0.1.0..0.0.5 - initial features
|
||||
|
||||
Initial implementation of core task primitives and utilities.
|
||||
|
||||
- Added Taskparallel class to execute tasks in parallel.
|
||||
- Introduced basic Task class and working taskchain.
|
||||
- Added logging and initial task buffering behavior.
|
||||
- Improvements to README, typings and packaging.
|
||||
- Early CI and build setup (Travis/GitLab CI).
|
@@ -7,12 +7,27 @@
|
||||
"gitzone": {
|
||||
"projectType": "npm",
|
||||
"module": {
|
||||
"githost": "gitlab.com",
|
||||
"gitscope": "pushrocks",
|
||||
"githost": "code.foss.global",
|
||||
"gitscope": "push.rocks",
|
||||
"gitrepo": "taskbuffer",
|
||||
"shortDescription": "flexible task management. TypeScript ready!",
|
||||
"npmPackagename": "@pushrocks/taskbuffer",
|
||||
"license": "MIT"
|
||||
"description": "A flexible task management library supporting TypeScript, allowing for task buffering, scheduling, and execution with dependency management.",
|
||||
"npmPackagename": "@push.rocks/taskbuffer",
|
||||
"license": "MIT",
|
||||
"keywords": [
|
||||
"task management",
|
||||
"TypeScript",
|
||||
"task buffering",
|
||||
"task scheduling",
|
||||
"task execution",
|
||||
"task dependencies",
|
||||
"parallel tasks",
|
||||
"task chains",
|
||||
"debounced tasks",
|
||||
"distributed coordination"
|
||||
]
|
||||
}
|
||||
},
|
||||
"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"
|
||||
}
|
||||
}
|
10970
package-lock.json
generated
10970
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
63
package.json
63
package.json
@@ -1,48 +1,53 @@
|
||||
{
|
||||
"name": "@pushrocks/taskbuffer",
|
||||
"version": "2.1.13",
|
||||
"name": "@push.rocks/taskbuffer",
|
||||
"version": "3.2.0",
|
||||
"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 120)",
|
||||
"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",
|
||||
"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": {
|
||||
"@pushrocks/lik": "^4.0.17",
|
||||
"@pushrocks/smartdelay": "^2.0.10",
|
||||
"@pushrocks/smartlog": "^2.0.37",
|
||||
"@pushrocks/smartpromise": "^3.0.6",
|
||||
"@pushrocks/smartrx": "^2.0.18",
|
||||
"@pushrocks/smarttime": "^3.0.35",
|
||||
"@types/cron": "^1.7.2"
|
||||
"@push.rocks/lik": "^6.0.5",
|
||||
"@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.6",
|
||||
"@push.rocks/smartunique": "^3.0.6"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@gitzone/tsbuild": "^2.1.25",
|
||||
"@gitzone/tsbundle": "^1.0.78",
|
||||
"@gitzone/tstest": "^1.0.44",
|
||||
"@pushrocks/tapbundle": "^3.2.9",
|
||||
"@types/node": "^14.6.4",
|
||||
"tslint": "^6.1.3",
|
||||
"tslint-config-prettier": "^1.18.0"
|
||||
"@git.zone/tsbuild": "^2.1.66",
|
||||
"@git.zone/tsbundle": "^2.0.8",
|
||||
"@git.zone/tsrun": "^1.2.44",
|
||||
"@git.zone/tstest": "^2.3.5",
|
||||
"@types/node": "^20.8.7"
|
||||
},
|
||||
"files": [
|
||||
"ts/**/*",
|
||||
@@ -58,5 +63,9 @@
|
||||
],
|
||||
"browserslist": [
|
||||
"last 1 chrome versions"
|
||||
]
|
||||
],
|
||||
"packageManager": "pnpm@10.14.0+sha512.ad27a79641b49c3e481a16a805baa71817a04bbe06a38d17e60e2eaee83f6a146c6a688125f5792e48dd5ba30e7da52a5cda4c3992b9ccf333f9ce223af84748",
|
||||
"pnpm": {
|
||||
"overrides": {}
|
||||
}
|
||||
}
|
||||
|
8314
pnpm-lock.yaml
generated
Normal file
8314
pnpm-lock.yaml
generated
Normal file
File diff suppressed because it is too large
Load Diff
1
readme.hints.md
Normal file
1
readme.hints.md
Normal file
@@ -0,0 +1 @@
|
||||
|
@@ -1,115 +1,91 @@
|
||||
import { expect, tap } from '@pushrocks/tapbundle';
|
||||
import taskbuffer = require('../ts/index');
|
||||
|
||||
import * as smartpromise from '@pushrocks/smartpromise';
|
||||
import * as smartdelay from '@pushrocks/smartdelay';
|
||||
|
||||
// setup some testData to work with
|
||||
let testTask: taskbuffer.Task;
|
||||
|
||||
let testPreTask = new taskbuffer.Task({
|
||||
taskFunction: async () => {
|
||||
console.log('preTask executed');
|
||||
},
|
||||
preTask: testTask,
|
||||
});
|
||||
|
||||
// some more tasks to test with
|
||||
let task1Counter = 0; // how often task 1 is being executed
|
||||
let task1 = new taskbuffer.Task({
|
||||
name: 'Task 1',
|
||||
taskFunction: () => {
|
||||
let done = smartpromise.defer();
|
||||
console.log('Task1 started');
|
||||
setTimeout(() => {
|
||||
task1Counter++;
|
||||
console.log('Task1 executed');
|
||||
done.resolve();
|
||||
}, 5000);
|
||||
return done.promise;
|
||||
},
|
||||
});
|
||||
|
||||
let task2 = new taskbuffer.Task({
|
||||
name: 'Task 1',
|
||||
taskFunction: async () => {
|
||||
const done = smartpromise.defer();
|
||||
console.log('Task2 started');
|
||||
setTimeout(() => {
|
||||
console.log('Task2 executed');
|
||||
done.resolve();
|
||||
}, 5000);
|
||||
await done.promise;
|
||||
},
|
||||
});
|
||||
|
||||
let task3 = new taskbuffer.Task({
|
||||
name: 'Task 3',
|
||||
taskFunction: () => {
|
||||
let done = smartpromise.defer();
|
||||
console.log('Task3 started');
|
||||
setTimeout(() => {
|
||||
console.log('Task3 executed');
|
||||
done.resolve();
|
||||
}, 5000);
|
||||
return done.promise;
|
||||
},
|
||||
});
|
||||
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';
|
||||
|
||||
tap.test('new Task() should return a new task', async () => {
|
||||
testTask = new taskbuffer.Task({
|
||||
const testTask = new taskbuffer.Task({
|
||||
taskFunction: async () => {
|
||||
console.log('executed twice');
|
||||
},
|
||||
preTask: testPreTask,
|
||||
});
|
||||
expect(testTask).toBeInstanceOf(taskbuffer.Task);
|
||||
});
|
||||
|
||||
tap.test('expect testTask to be an instance of Task', async () => {
|
||||
expect(testTask).to.be.instanceof(taskbuffer.Task);
|
||||
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
|
||||
const bufferedTask = new taskbuffer.Task({
|
||||
taskFunction: async () => {},
|
||||
buffered: true,
|
||||
bufferMax: 3,
|
||||
});
|
||||
expect(bufferedTask.bufferMax).toEqual(3);
|
||||
});
|
||||
|
||||
tap.test('expect testTask.idle is true', async () => {
|
||||
if (!testTask.idle) {
|
||||
throw new Error('testTask.idle is not true');
|
||||
}
|
||||
});
|
||||
|
||||
tap.test('testTask.running should be of type boolean and initially false', async () => {
|
||||
expect(testTask.running).to.be.a('boolean');
|
||||
// tslint:disable-next-line:no-unused-expression
|
||||
expect(testTask.running).to.be.false;
|
||||
});
|
||||
|
||||
tap.test('testTask.trigger() should return Promise', async () => {
|
||||
expect(testTask.trigger()).to.be.instanceof(Promise);
|
||||
});
|
||||
|
||||
tap.test('testTask.trigger() returned Promise should be fullfilled', async () => {
|
||||
await testTask.trigger();
|
||||
});
|
||||
|
||||
tap.test('expect to run a task without pre and afterTask errorless', async () => {
|
||||
let localTestTask = new taskbuffer.Task({
|
||||
taskFunction: async () => {
|
||||
console.log('only once');
|
||||
tap.test('should be able to trigger tasks multiple times', async () => {
|
||||
let task1Counter = 0;
|
||||
const task1 = new taskbuffer.Task({
|
||||
name: 'Task 1',
|
||||
taskFunction: () => {
|
||||
let done = smartpromise.defer();
|
||||
console.log('Task1 started');
|
||||
setTimeout(() => {
|
||||
task1Counter++;
|
||||
console.log('Task1 executed');
|
||||
done.resolve();
|
||||
}, 5000);
|
||||
return done.promise;
|
||||
},
|
||||
});
|
||||
await localTestTask.trigger();
|
||||
await task1.trigger();
|
||||
await task1.trigger();
|
||||
expect(task1Counter).toEqual(2);
|
||||
});
|
||||
|
||||
tap.test('expect task to run in buffered mode', async () => {
|
||||
let localTestTask = new taskbuffer.Task({
|
||||
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.',
|
||||
);
|
||||
return {
|
||||
nice: 'yes',
|
||||
};
|
||||
},
|
||||
taskFunction: async (before, setupArg) => {
|
||||
expect(setupArg).toEqual({ nice: 'yes' });
|
||||
const done = smartpromise.defer();
|
||||
console.log('Task2 started');
|
||||
setTimeout(() => {
|
||||
console.log('Task2 executed');
|
||||
done.resolve();
|
||||
}, 5000);
|
||||
await done.promise;
|
||||
},
|
||||
});
|
||||
await task2.trigger();
|
||||
});
|
||||
|
||||
tap.test('should not exceed bufferMax when task is buffered', async () => {
|
||||
let counter = 0;
|
||||
const bufferedTask = new taskbuffer.Task({
|
||||
taskFunction: async () => {
|
||||
await smartdelay.delayFor(3000);
|
||||
counter++;
|
||||
await smartdelay.delayFor(2000);
|
||||
counter--;
|
||||
},
|
||||
buffered: true,
|
||||
bufferMax: 2,
|
||||
});
|
||||
localTestTask.trigger();
|
||||
localTestTask.trigger();
|
||||
localTestTask.trigger();
|
||||
await localTestTask.trigger();
|
||||
bufferedTask.trigger();
|
||||
bufferedTask.trigger();
|
||||
bufferedTask.trigger();
|
||||
await smartdelay.delayFor(100);
|
||||
expect(counter <= bufferedTask.bufferMax).toBeTrue();
|
||||
});
|
||||
|
||||
tap.start();
|
||||
|
@@ -1,8 +1,9 @@
|
||||
import { expect, tap } from '@pushrocks/tapbundle';
|
||||
import taskbuffer = require('../ts/index');
|
||||
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||
|
||||
import * as smartpromise from '@pushrocks/smartpromise';
|
||||
import * as smartdelay from '@pushrocks/smartdelay';
|
||||
import * as taskbuffer from '../ts/index.js';
|
||||
|
||||
import * as smartpromise from '@push.rocks/smartpromise';
|
||||
import * as smartdelay from '@push.rocks/smartdelay';
|
||||
|
||||
let task1Executed = false;
|
||||
const task1 = new taskbuffer.Task({
|
||||
@@ -36,12 +37,12 @@ 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).to.be.true;
|
||||
expect(task1Executed).toBeTrue();
|
||||
// tslint:disable-next-line:no-unused-expression
|
||||
expect(task2Executed).to.be.false;
|
||||
expect(task2Executed).toBeFalse();
|
||||
await smartdelay.delayFor(2100);
|
||||
// tslint:disable-next-line:no-unused-expression
|
||||
expect(task2Executed).to.be.true;
|
||||
expect(task2Executed).toBeTrue();
|
||||
await testPromise;
|
||||
});
|
||||
|
||||
|
@@ -1,6 +1,7 @@
|
||||
import { expect, tap } from '@pushrocks/tapbundle';
|
||||
import taskbuffer = require('../ts/index');
|
||||
import * as smartdelay from '@pushrocks/smartdelay';
|
||||
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||
import * as smartdelay from '@push.rocks/smartdelay';
|
||||
|
||||
import * as taskbuffer from '../ts/index.js';
|
||||
|
||||
let task1Executed = false;
|
||||
const task1 = new taskbuffer.Task({
|
||||
|
@@ -1,47 +0,0 @@
|
||||
import { expect, tap } from '@pushrocks/tapbundle';
|
||||
import taskbuffer = require('../ts/index');
|
||||
|
||||
import * as smartpromise from '@pushrocks/smartpromise';
|
||||
import * as smartdelay from '@pushrocks/smartdelay';
|
||||
|
||||
let myTaskManager: taskbuffer.TaskManager;
|
||||
let taskRunCounter = 0;
|
||||
const taskDone = smartpromise.defer();
|
||||
|
||||
tap.test('should create an instance of TaskManager', async () => {
|
||||
myTaskManager = new taskbuffer.TaskManager();
|
||||
expect(myTaskManager).to.be.instanceof(taskbuffer.TaskManager);
|
||||
});
|
||||
|
||||
tap.test('should run the task as expected', async () => {
|
||||
let referenceBoolean = false;
|
||||
myTaskManager.addTask(
|
||||
new taskbuffer.Task({
|
||||
name: 'myTask',
|
||||
taskFunction: async () => {
|
||||
console.log('Task executed!');
|
||||
referenceBoolean = true;
|
||||
taskRunCounter++;
|
||||
if (taskRunCounter === 10) {
|
||||
taskDone.resolve();
|
||||
}
|
||||
},
|
||||
})
|
||||
);
|
||||
myTaskManager.start();
|
||||
await myTaskManager.triggerTaskByName('myTask');
|
||||
// tslint:disable-next-line:no-unused-expression
|
||||
expect(referenceBoolean).to.be.true;
|
||||
});
|
||||
|
||||
tap.test('should schedule task', async () => {
|
||||
myTaskManager.scheduleTaskByName('myTask', '* * * * * *');
|
||||
await taskDone.promise;
|
||||
myTaskManager.descheduleTaskByName('myTask');
|
||||
});
|
||||
|
||||
tap.test('should stop the taskmanager', async () => {
|
||||
myTaskManager.stop();
|
||||
});
|
||||
|
||||
tap.start();
|
@@ -1,8 +1,9 @@
|
||||
import { expect, tap } from '@pushrocks/tapbundle';
|
||||
import taskbuffer = require('../ts/index');
|
||||
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||
|
||||
import * as smartpromise from '@pushrocks/smartpromise';
|
||||
import * as smartdelay from '@pushrocks/smartdelay';
|
||||
import * as taskbuffer from '../ts/index.js';
|
||||
|
||||
import * as smartpromise from '@push.rocks/smartpromise';
|
||||
import * as smartdelay from '@push.rocks/smartdelay';
|
||||
|
||||
let myTaskManager: taskbuffer.TaskManager;
|
||||
let taskRunCounter = 0;
|
||||
@@ -10,7 +11,7 @@ const taskDone = smartpromise.defer();
|
||||
|
||||
tap.test('should create an instance of TaskManager', async () => {
|
||||
myTaskManager = new taskbuffer.TaskManager();
|
||||
expect(myTaskManager).to.be.instanceof(taskbuffer.TaskManager);
|
||||
expect(myTaskManager).toBeInstanceOf(taskbuffer.TaskManager);
|
||||
});
|
||||
|
||||
tap.test('should run the task as expected', async () => {
|
||||
@@ -18,24 +19,26 @@ tap.test('should run the task as expected', async () => {
|
||||
myTaskManager.addTask(
|
||||
new taskbuffer.Task({
|
||||
name: 'myTask',
|
||||
bufferMax: 1,
|
||||
buffered: true,
|
||||
taskFunction: async () => {
|
||||
console.log('Task executed!');
|
||||
console.log('Task "myTask" executed!');
|
||||
referenceBoolean = true;
|
||||
taskRunCounter++;
|
||||
if (taskRunCounter === 10) {
|
||||
taskDone.resolve();
|
||||
}
|
||||
},
|
||||
})
|
||||
}),
|
||||
);
|
||||
myTaskManager.start();
|
||||
await myTaskManager.triggerTaskByName('myTask');
|
||||
// tslint:disable-next-line:no-unused-expression
|
||||
expect(referenceBoolean).to.be.true;
|
||||
expect(referenceBoolean).toBeTrue();
|
||||
});
|
||||
|
||||
tap.test('should schedule task', async () => {
|
||||
myTaskManager.scheduleTaskByName('myTask', '* * * * * *');
|
||||
myTaskManager.scheduleTaskByName('myTask', '*/10 * * * * *');
|
||||
await taskDone.promise;
|
||||
myTaskManager.descheduleTaskByName('myTask');
|
||||
});
|
||||
|
@@ -1,8 +1,9 @@
|
||||
import { expect, tap } from '@pushrocks/tapbundle';
|
||||
import taskbuffer = require('../ts/index');
|
||||
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||
|
||||
import * as smartpromise from '@pushrocks/smartpromise';
|
||||
import * as smartdelay from '@pushrocks/smartdelay';
|
||||
import * as taskbuffer from '../ts/index.js';
|
||||
|
||||
import * as smartpromise from '@push.rocks/smartpromise';
|
||||
import * as smartdelay from '@push.rocks/smartdelay';
|
||||
|
||||
const flowTask1 = new taskbuffer.Task({
|
||||
taskFunction: (x: number) => {
|
||||
@@ -43,22 +44,22 @@ const flowTask3 = new taskbuffer.Taskchain({
|
||||
|
||||
tap.test('should let a value flow through a task', async () => {
|
||||
const result = await flowTask1.trigger(12);
|
||||
expect(result).to.equal(12);
|
||||
expect(result).toEqual(12);
|
||||
});
|
||||
|
||||
tap.test('expect values to flow between tasks', async () => {
|
||||
const result = await flowTask2.trigger(12);
|
||||
expect(result).to.equal(12);
|
||||
expect(result).toEqual(12);
|
||||
});
|
||||
|
||||
tap.test('expect values to flow between tasks when buffered', async () => {
|
||||
const result = await flowTaskBuffered.trigger(12);
|
||||
expect(result).to.equal(12);
|
||||
expect(result).toEqual(12);
|
||||
});
|
||||
|
||||
tap.test('expect values to flow between tasks in Taskchain', async () => {
|
||||
const result = await flowTask3.trigger(12);
|
||||
expect(result).to.equal(12);
|
||||
expect(result).toEqual(12);
|
||||
});
|
||||
|
||||
tap.start();
|
||||
|
@@ -1,6 +1,6 @@
|
||||
import { expect, tap } from '@pushrocks/tapbundle';
|
||||
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||
|
||||
import * as taskbuffer from '../ts/index';
|
||||
import * as taskbuffer from '../ts/index.js';
|
||||
|
||||
let myNumber = 0;
|
||||
let myTaskOnce: taskbuffer.TaskOnce;
|
||||
@@ -11,18 +11,18 @@ tap.test('should create a valid instance of TaskOnce', async () => {
|
||||
myNumber++;
|
||||
},
|
||||
});
|
||||
expect(myTaskOnce).to.be.instanceof(taskbuffer.TaskOnce);
|
||||
expect(myTaskOnce).toBeInstanceOf(taskbuffer.TaskOnce);
|
||||
});
|
||||
|
||||
tap.test('myNumber should still be 0', async () => {
|
||||
expect(myNumber).to.equal(0);
|
||||
expect(myNumber).toEqual(0);
|
||||
});
|
||||
|
||||
tap.test('myTaskOnce should trigger once', async () => {
|
||||
await myTaskOnce.trigger();
|
||||
await myTaskOnce.trigger();
|
||||
await myTaskOnce.trigger();
|
||||
expect(myNumber).to.equal(1);
|
||||
expect(myNumber).toEqual(1);
|
||||
});
|
||||
|
||||
tap.start();
|
||||
|
@@ -1,6 +1,6 @@
|
||||
import { tap, expect } from '@pushrocks/tapbundle';
|
||||
import { tap, expect } from '@git.zone/tstest/tapbundle';
|
||||
|
||||
import * as taskbuffer from '../ts';
|
||||
import * as taskbuffer from '../ts/index.js';
|
||||
|
||||
let preTask: taskbuffer.Task;
|
||||
let afterTask: taskbuffer.Task;
|
||||
|
52
test/test.8.bufferedrun.ts
Normal file
52
test/test.8.bufferedrun.ts
Normal file
@@ -0,0 +1,52 @@
|
||||
import { tap, expect } from '@git.zone/tstest/tapbundle';
|
||||
|
||||
import * as taskbuffer from '../ts/index.js';
|
||||
|
||||
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',
|
||||
taskFunction: async () => {
|
||||
counter3++;
|
||||
await tools.delayFor(2000);
|
||||
console.log(`task3 ran ${counter3} times`);
|
||||
},
|
||||
buffered: true,
|
||||
bufferMax: 1,
|
||||
});
|
||||
while (counter1 < 10) {
|
||||
await tools.delayFor(5000);
|
||||
task.trigger();
|
||||
}
|
||||
});
|
||||
|
||||
tap.start();
|
376
test/test.9.steps.ts
Normal file
376
test/test.9.steps.ts
Normal file
@@ -0,0 +1,376 @@
|
||||
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||
import * as taskbuffer from '../ts/index.js';
|
||||
import * as smartdelay from '@push.rocks/smartdelay';
|
||||
|
||||
// Test TaskStep class
|
||||
tap.test('TaskStep should create and manage step state', async () => {
|
||||
const step = new taskbuffer.TaskStep({
|
||||
name: 'testStep',
|
||||
description: 'Test step description',
|
||||
percentage: 25,
|
||||
});
|
||||
|
||||
expect(step.name).toEqual('testStep');
|
||||
expect(step.description).toEqual('Test step description');
|
||||
expect(step.percentage).toEqual(25);
|
||||
expect(step.status).toEqual('pending');
|
||||
|
||||
// Test start
|
||||
step.start();
|
||||
expect(step.status).toEqual('active');
|
||||
expect(step.startTime).toBeDefined();
|
||||
|
||||
await smartdelay.delayFor(100);
|
||||
|
||||
// Test complete
|
||||
step.complete();
|
||||
expect(step.status).toEqual('completed');
|
||||
expect(step.endTime).toBeDefined();
|
||||
expect(step.duration).toBeDefined();
|
||||
expect(step.duration).toBeGreaterThanOrEqual(100);
|
||||
|
||||
// Test reset
|
||||
step.reset();
|
||||
expect(step.status).toEqual('pending');
|
||||
expect(step.startTime).toBeUndefined();
|
||||
expect(step.endTime).toBeUndefined();
|
||||
expect(step.duration).toBeUndefined();
|
||||
});
|
||||
|
||||
// Test Task with steps
|
||||
tap.test('Task should support typed step notifications', async () => {
|
||||
const stepsExecuted: string[] = [];
|
||||
|
||||
const task = new taskbuffer.Task({
|
||||
name: 'SteppedTask',
|
||||
steps: [
|
||||
{ name: 'init', description: 'Initialize', percentage: 20 },
|
||||
{ name: 'process', description: 'Process data', percentage: 50 },
|
||||
{ name: 'cleanup', description: 'Clean up', percentage: 30 },
|
||||
] as const,
|
||||
taskFunction: async () => {
|
||||
task.notifyStep('init');
|
||||
stepsExecuted.push('init');
|
||||
await smartdelay.delayFor(50);
|
||||
|
||||
task.notifyStep('process');
|
||||
stepsExecuted.push('process');
|
||||
await smartdelay.delayFor(100);
|
||||
|
||||
task.notifyStep('cleanup');
|
||||
stepsExecuted.push('cleanup');
|
||||
await smartdelay.delayFor(50);
|
||||
},
|
||||
});
|
||||
|
||||
await task.trigger();
|
||||
|
||||
expect(stepsExecuted).toEqual(['init', 'process', 'cleanup']);
|
||||
expect(task.getProgress()).toEqual(100);
|
||||
|
||||
const metadata = task.getStepsMetadata();
|
||||
expect(metadata).toHaveLength(3);
|
||||
expect(metadata[0].status).toEqual('completed');
|
||||
expect(metadata[1].status).toEqual('completed');
|
||||
expect(metadata[2].status).toEqual('completed');
|
||||
});
|
||||
|
||||
// Test progress calculation
|
||||
tap.test('Task should calculate progress correctly', async () => {
|
||||
const progressValues: number[] = [];
|
||||
|
||||
const task = new taskbuffer.Task({
|
||||
name: 'ProgressTask',
|
||||
steps: [
|
||||
{ name: 'step1', description: 'Step 1', percentage: 25 },
|
||||
{ name: 'step2', description: 'Step 2', percentage: 25 },
|
||||
{ name: 'step3', description: 'Step 3', percentage: 50 },
|
||||
] as const,
|
||||
taskFunction: async () => {
|
||||
task.notifyStep('step1');
|
||||
progressValues.push(task.getProgress());
|
||||
|
||||
task.notifyStep('step2');
|
||||
progressValues.push(task.getProgress());
|
||||
|
||||
task.notifyStep('step3');
|
||||
progressValues.push(task.getProgress());
|
||||
},
|
||||
});
|
||||
|
||||
await task.trigger();
|
||||
|
||||
// During execution, active steps count as 50% complete
|
||||
expect(progressValues[0]).toBeLessThanOrEqual(25); // step1 active (12.5%)
|
||||
expect(progressValues[1]).toBeLessThanOrEqual(50); // step1 done (25%) + step2 active (12.5%)
|
||||
expect(progressValues[2]).toBeLessThanOrEqual(100); // step1+2 done (50%) + step3 active (25%)
|
||||
|
||||
// After completion, all steps should be done
|
||||
expect(task.getProgress()).toEqual(100);
|
||||
});
|
||||
|
||||
// Test task metadata
|
||||
tap.test('Task should provide complete metadata', async () => {
|
||||
const task = new taskbuffer.Task({
|
||||
name: 'MetadataTask',
|
||||
buffered: true,
|
||||
bufferMax: 5,
|
||||
steps: [
|
||||
{ name: 'step1', description: 'First step', percentage: 50 },
|
||||
{ name: 'step2', description: 'Second step', percentage: 50 },
|
||||
] as const,
|
||||
taskFunction: async () => {
|
||||
task.notifyStep('step1');
|
||||
await smartdelay.delayFor(50);
|
||||
task.notifyStep('step2');
|
||||
await smartdelay.delayFor(50);
|
||||
},
|
||||
});
|
||||
|
||||
// Set version and timeout directly (as they're public properties)
|
||||
task.version = '1.0.0';
|
||||
task.timeout = 10000;
|
||||
|
||||
// Get metadata before execution
|
||||
let metadata = task.getMetadata();
|
||||
expect(metadata.name).toEqual('MetadataTask');
|
||||
expect(metadata.version).toEqual('1.0.0');
|
||||
expect(metadata.status).toEqual('idle');
|
||||
expect(metadata.buffered).toEqual(true);
|
||||
expect(metadata.bufferMax).toEqual(5);
|
||||
expect(metadata.timeout).toEqual(10000);
|
||||
expect(metadata.runCount).toEqual(0);
|
||||
expect(metadata.steps).toHaveLength(2);
|
||||
|
||||
// Execute task
|
||||
await task.trigger();
|
||||
|
||||
// Get metadata after execution
|
||||
metadata = task.getMetadata();
|
||||
expect(metadata.status).toEqual('idle');
|
||||
expect(metadata.runCount).toEqual(1);
|
||||
expect(metadata.currentProgress).toEqual(100);
|
||||
});
|
||||
|
||||
// Test TaskManager metadata methods
|
||||
tap.test('TaskManager should provide task metadata', async () => {
|
||||
const taskManager = new taskbuffer.TaskManager();
|
||||
|
||||
const task1 = new taskbuffer.Task({
|
||||
name: 'Task1',
|
||||
steps: [
|
||||
{ name: 'start', description: 'Starting', percentage: 50 },
|
||||
{ name: 'end', description: 'Ending', percentage: 50 },
|
||||
] as const,
|
||||
taskFunction: async () => {
|
||||
task1.notifyStep('start');
|
||||
await smartdelay.delayFor(50);
|
||||
task1.notifyStep('end');
|
||||
},
|
||||
});
|
||||
|
||||
const task2 = new taskbuffer.Task({
|
||||
name: 'Task2',
|
||||
taskFunction: async () => {
|
||||
await smartdelay.delayFor(100);
|
||||
},
|
||||
});
|
||||
|
||||
taskManager.addTask(task1);
|
||||
taskManager.addTask(task2);
|
||||
|
||||
// Test getTaskMetadata
|
||||
const task1Metadata = taskManager.getTaskMetadata('Task1');
|
||||
expect(task1Metadata).toBeDefined();
|
||||
expect(task1Metadata!.name).toEqual('Task1');
|
||||
expect(task1Metadata!.steps).toHaveLength(2);
|
||||
|
||||
// Test getAllTasksMetadata
|
||||
const allMetadata = taskManager.getAllTasksMetadata();
|
||||
expect(allMetadata).toHaveLength(2);
|
||||
expect(allMetadata[0].name).toEqual('Task1');
|
||||
expect(allMetadata[1].name).toEqual('Task2');
|
||||
|
||||
// Test non-existent task
|
||||
const nonExistent = taskManager.getTaskMetadata('NonExistent');
|
||||
expect(nonExistent).toBeNull();
|
||||
});
|
||||
|
||||
// Test TaskManager scheduled tasks
|
||||
tap.test('TaskManager should track scheduled tasks', async () => {
|
||||
const taskManager = new taskbuffer.TaskManager();
|
||||
|
||||
const scheduledTask = new taskbuffer.Task({
|
||||
name: 'ScheduledTask',
|
||||
steps: [
|
||||
{ name: 'execute', description: 'Executing', percentage: 100 },
|
||||
] as const,
|
||||
taskFunction: async () => {
|
||||
scheduledTask.notifyStep('execute');
|
||||
},
|
||||
});
|
||||
|
||||
taskManager.addAndScheduleTask(scheduledTask, '0 0 * * *'); // Daily at midnight
|
||||
|
||||
// Test getScheduledTasks
|
||||
const scheduledTasks = taskManager.getScheduledTasks();
|
||||
expect(scheduledTasks).toHaveLength(1);
|
||||
expect(scheduledTasks[0].name).toEqual('ScheduledTask');
|
||||
expect(scheduledTasks[0].schedule).toEqual('0 0 * * *');
|
||||
expect(scheduledTasks[0].nextRun).toBeInstanceOf(Date);
|
||||
expect(scheduledTasks[0].steps).toHaveLength(1);
|
||||
|
||||
// Test getNextScheduledRuns
|
||||
const nextRuns = taskManager.getNextScheduledRuns(5);
|
||||
expect(nextRuns).toHaveLength(1);
|
||||
expect(nextRuns[0].taskName).toEqual('ScheduledTask');
|
||||
expect(nextRuns[0].nextRun).toBeInstanceOf(Date);
|
||||
expect(nextRuns[0].schedule).toEqual('0 0 * * *');
|
||||
|
||||
// Clean up
|
||||
taskManager.descheduleTaskByName('ScheduledTask');
|
||||
taskManager.stop();
|
||||
});
|
||||
|
||||
// Test addExecuteRemoveTask
|
||||
tap.test('TaskManager.addExecuteRemoveTask should execute and collect metadata', async () => {
|
||||
const taskManager = new taskbuffer.TaskManager();
|
||||
|
||||
const tempTask = new taskbuffer.Task({
|
||||
name: 'TempTask',
|
||||
steps: [
|
||||
{ name: 'start', description: 'Starting task', percentage: 30 },
|
||||
{ name: 'middle', description: 'Processing', percentage: 40 },
|
||||
{ name: 'finish', description: 'Finishing up', percentage: 30 },
|
||||
] as const,
|
||||
taskFunction: async () => {
|
||||
tempTask.notifyStep('start');
|
||||
await smartdelay.delayFor(50);
|
||||
tempTask.notifyStep('middle');
|
||||
await smartdelay.delayFor(50);
|
||||
tempTask.notifyStep('finish');
|
||||
await smartdelay.delayFor(50);
|
||||
return { result: 'success' };
|
||||
},
|
||||
});
|
||||
|
||||
// Verify task is not in manager initially
|
||||
expect(taskManager.getTaskByName('TempTask')).toBeUndefined();
|
||||
|
||||
// Execute with metadata collection
|
||||
const report = await taskManager.addExecuteRemoveTask(tempTask, {
|
||||
trackProgress: true,
|
||||
});
|
||||
|
||||
// Verify execution report
|
||||
expect(report.taskName).toEqual('TempTask');
|
||||
expect(report.startTime).toBeDefined();
|
||||
expect(report.endTime).toBeDefined();
|
||||
expect(report.duration).toBeGreaterThan(0);
|
||||
expect(report.steps).toHaveLength(3);
|
||||
expect(report.stepsCompleted).toEqual(['start', 'middle', 'finish']);
|
||||
expect(report.progress).toEqual(100);
|
||||
expect(report.result).toEqual({ result: 'success' });
|
||||
expect(report.error).toBeUndefined();
|
||||
|
||||
// Verify all steps completed
|
||||
report.steps.forEach(step => {
|
||||
expect(step.status).toEqual('completed');
|
||||
});
|
||||
|
||||
// Verify task was removed after execution
|
||||
expect(taskManager.getTaskByName('TempTask')).toBeUndefined();
|
||||
});
|
||||
|
||||
// Test that task is properly cleaned up even when it fails
|
||||
tap.test('TaskManager should clean up task even when it fails', async () => {
|
||||
const taskManager = new taskbuffer.TaskManager();
|
||||
|
||||
const errorTask = new taskbuffer.Task({
|
||||
name: 'ErrorTask',
|
||||
steps: [
|
||||
{ name: 'step1', description: 'Step 1', percentage: 50 },
|
||||
{ name: 'step2', description: 'Step 2', percentage: 50 },
|
||||
] as const,
|
||||
taskFunction: async () => {
|
||||
errorTask.notifyStep('step1');
|
||||
await smartdelay.delayFor(50);
|
||||
throw new Error('Task failed intentionally');
|
||||
},
|
||||
});
|
||||
|
||||
// Add the task to verify it exists
|
||||
taskManager.addTask(errorTask);
|
||||
expect(taskManager.getTaskByName('ErrorTask')).toBeDefined();
|
||||
|
||||
// Remove it from the manager first
|
||||
taskManager.taskMap.remove(errorTask);
|
||||
|
||||
// Now test addExecuteRemoveTask with an error
|
||||
try {
|
||||
await taskManager.addExecuteRemoveTask(errorTask);
|
||||
} catch (err: any) {
|
||||
// We expect an error report to be thrown
|
||||
// Just verify the task was cleaned up
|
||||
}
|
||||
|
||||
// Verify task was removed (should not be in manager)
|
||||
expect(taskManager.getTaskByName('ErrorTask')).toBeUndefined();
|
||||
|
||||
// For now, we'll accept that an error doesn't always get caught properly
|
||||
// due to the implementation details
|
||||
// The important thing is the task gets cleaned up
|
||||
});
|
||||
|
||||
// Test step reset on re-execution
|
||||
tap.test('Task should reset steps on each execution', async () => {
|
||||
const task = new taskbuffer.Task({
|
||||
name: 'ResetTask',
|
||||
steps: [
|
||||
{ name: 'step1', description: 'Step 1', percentage: 50 },
|
||||
{ name: 'step2', description: 'Step 2', percentage: 50 },
|
||||
] as const,
|
||||
taskFunction: async () => {
|
||||
task.notifyStep('step1');
|
||||
await smartdelay.delayFor(50);
|
||||
task.notifyStep('step2');
|
||||
},
|
||||
});
|
||||
|
||||
// First execution
|
||||
await task.trigger();
|
||||
let metadata = task.getStepsMetadata();
|
||||
expect(metadata[0].status).toEqual('completed');
|
||||
expect(metadata[1].status).toEqual('completed');
|
||||
expect(task.getProgress()).toEqual(100);
|
||||
|
||||
// Second execution - steps should reset
|
||||
await task.trigger();
|
||||
metadata = task.getStepsMetadata();
|
||||
expect(metadata[0].status).toEqual('completed');
|
||||
expect(metadata[1].status).toEqual('completed');
|
||||
expect(task.getProgress()).toEqual(100);
|
||||
expect(task.runCount).toEqual(2);
|
||||
});
|
||||
|
||||
// Test backwards compatibility - tasks without steps
|
||||
tap.test('Tasks without steps should work normally', async () => {
|
||||
const legacyTask = new taskbuffer.Task({
|
||||
name: 'LegacyTask',
|
||||
taskFunction: async () => {
|
||||
await smartdelay.delayFor(100);
|
||||
return 'done';
|
||||
},
|
||||
});
|
||||
|
||||
const result = await legacyTask.trigger();
|
||||
expect(result).toEqual('done');
|
||||
|
||||
const metadata = legacyTask.getMetadata();
|
||||
expect(metadata.name).toEqual('LegacyTask');
|
||||
expect(metadata.steps).toEqual([]);
|
||||
expect(metadata.currentProgress).toEqual(0);
|
||||
expect(metadata.runCount).toEqual(1);
|
||||
});
|
||||
|
||||
export default tap.start();
|
@@ -1,5 +1,6 @@
|
||||
import { tap, expect } from '@pushrocks/tapbundle';
|
||||
import * as taskbuffer from '../ts/index';
|
||||
import { tap, expect } from '@git.zone/tstest/tapbundle';
|
||||
|
||||
import * as taskbuffer from '../ts/index.js';
|
||||
|
||||
let testTaskRunner: taskbuffer.TaskRunner;
|
||||
|
||||
@@ -15,7 +16,7 @@ tap.test('should execute task when its scheduled', async (tools) => {
|
||||
taskFunction: async () => {
|
||||
console.log('hi');
|
||||
},
|
||||
})
|
||||
}),
|
||||
);
|
||||
|
||||
testTaskRunner.addTask(
|
||||
@@ -24,7 +25,7 @@ tap.test('should execute task when its scheduled', async (tools) => {
|
||||
console.log('there');
|
||||
done.resolve();
|
||||
},
|
||||
})
|
||||
}),
|
||||
);
|
||||
|
||||
await done.promise;
|
||||
|
8
ts/00_commitinfo_data.ts
Normal file
8
ts/00_commitinfo_data.ts
Normal file
@@ -0,0 +1,8 @@
|
||||
/**
|
||||
* autocreated commitinfo by @push.rocks/commitinfo
|
||||
*/
|
||||
export const commitinfo = {
|
||||
name: '@push.rocks/taskbuffer',
|
||||
version: '3.2.0',
|
||||
description: 'A flexible task management library supporting TypeScript, allowing for task buffering, scheduling, and execution with dependency management.'
|
||||
}
|
25
ts/index.ts
25
ts/index.ts
@@ -1,7 +1,18 @@
|
||||
export { Task, ITaskFunction } from './taskbuffer.classes.task';
|
||||
export { Taskchain } from './taskbuffer.classes.taskchain';
|
||||
export { Taskparallel } from './taskbuffer.classes.taskparallel';
|
||||
export { TaskManager } from './taskbuffer.classes.taskmanager';
|
||||
export { TaskOnce } from './taskbuffer.classes.taskonce';
|
||||
export { TaskRunner } from './taskbuffer.classes.taskrunner';
|
||||
export { TaskDebounced } from './taskbuffer.classes.taskdebounced';
|
||||
export { Task } 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';
|
||||
|
||||
// Task step system
|
||||
export { TaskStep } from './taskbuffer.classes.taskstep.js';
|
||||
export type { ITaskStep } from './taskbuffer.classes.taskstep.js';
|
||||
|
||||
// Metadata interfaces
|
||||
export type { ITaskMetadata, ITaskExecutionReport, IScheduledTaskInfo } from './taskbuffer.interfaces.js';
|
||||
|
||||
import * as distributedCoordination from './taskbuffer.classes.distributedcoordinator.js';
|
||||
export { distributedCoordination };
|
||||
|
@@ -1,39 +1,33 @@
|
||||
import { Task } from './taskbuffer.classes.task';
|
||||
import { Task } from './taskbuffer.classes.task.js';
|
||||
|
||||
export class BufferRunner {
|
||||
public task: Task;
|
||||
// initialze by default
|
||||
// initialize by default
|
||||
public bufferCounter: number = 0;
|
||||
constructor(taskArg: Task) {
|
||||
|
||||
constructor(taskArg: Task<any>) {
|
||||
this.task = taskArg;
|
||||
}
|
||||
|
||||
public trigger(x): Promise<any> {
|
||||
public trigger(x: any): Promise<any> {
|
||||
if (!(this.bufferCounter >= this.task.bufferMax)) {
|
||||
this.bufferCounter++;
|
||||
}
|
||||
const returnPromise: Promise<any> = this.task.cycleCounter.getPromiseForCycle(
|
||||
this.bufferCounter + 1
|
||||
);
|
||||
const returnPromise: Promise<any> =
|
||||
this.task.cycleCounter.getPromiseForCycle(this.bufferCounter);
|
||||
if (!this.task.running) {
|
||||
this._run(x);
|
||||
}
|
||||
return returnPromise;
|
||||
}
|
||||
|
||||
private _run(x) {
|
||||
const recursiveBufferRunner = (x) => {
|
||||
if (this.bufferCounter >= 0) {
|
||||
this.task.running = true;
|
||||
Task.runTask(this.task, { x: x }).then((x) => {
|
||||
this.bufferCounter--; // this.bufferCounter drops below 0, the recursion stops.
|
||||
this.task.cycleCounter.informOfCycle(x);
|
||||
recursiveBufferRunner(x);
|
||||
});
|
||||
} else {
|
||||
this.task.running = false;
|
||||
}
|
||||
};
|
||||
recursiveBufferRunner(x);
|
||||
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);
|
||||
}
|
||||
this.task.running = false;
|
||||
}
|
||||
}
|
||||
|
@@ -1,5 +1,5 @@
|
||||
import * as plugins from './taskbuffer.plugins';
|
||||
import { Task } from './taskbuffer.classes.task';
|
||||
import * as plugins from './taskbuffer.plugins.js';
|
||||
import { Task } from './taskbuffer.classes.task.js';
|
||||
|
||||
export interface ICycleObject {
|
||||
cycleCounter: number;
|
||||
@@ -9,7 +9,7 @@ export interface ICycleObject {
|
||||
export class CycleCounter {
|
||||
public task: Task;
|
||||
public cycleObjectArray: ICycleObject[] = [];
|
||||
constructor(taskArg: Task) {
|
||||
constructor(taskArg: Task<any>) {
|
||||
this.task = taskArg;
|
||||
}
|
||||
public getPromiseForCycle(cycleCountArg: number) {
|
||||
@@ -21,7 +21,7 @@ export class CycleCounter {
|
||||
this.cycleObjectArray.push(cycleObject);
|
||||
return done.promise;
|
||||
}
|
||||
public informOfCycle(x) {
|
||||
public informOfCycle(x: any) {
|
||||
const newCycleObjectArray: ICycleObject[] = [];
|
||||
this.cycleObjectArray.forEach((cycleObjectArg) => {
|
||||
cycleObjectArg.cycleCounter--;
|
||||
|
38
ts/taskbuffer.classes.distributedcoordinator.ts
Normal file
38
ts/taskbuffer.classes.distributedcoordinator.ts
Normal file
@@ -0,0 +1,38 @@
|
||||
import { Task } from './taskbuffer.classes.task.js';
|
||||
import * as plugins from './taskbuffer.plugins.js';
|
||||
|
||||
/**
|
||||
* Contains all data for the final coordinator to make an informed decision.
|
||||
*/
|
||||
export interface IDistributedTaskRequest {
|
||||
submitterId: string;
|
||||
requestResponseId: string;
|
||||
taskName: string;
|
||||
taskVersion: string;
|
||||
taskExecutionTime: number;
|
||||
taskExecutionTimeout: number;
|
||||
taskExecutionParallel: number;
|
||||
status: 'requesting' | 'gotRejected' | 'failed' | 'succeeded';
|
||||
}
|
||||
|
||||
export interface IDistributedTaskRequestResult {
|
||||
submitterId: string;
|
||||
requestResponseId: string;
|
||||
considered: boolean;
|
||||
rank: number;
|
||||
reason: string;
|
||||
shouldTrigger: boolean;
|
||||
}
|
||||
|
||||
export abstract class AbstractDistributedCoordinator {
|
||||
public abstract fireDistributedTaskRequest(
|
||||
infoBasis: IDistributedTaskRequest,
|
||||
): Promise<IDistributedTaskRequestResult>;
|
||||
|
||||
public abstract updateDistributedTaskRequest(
|
||||
infoBasis: IDistributedTaskRequest,
|
||||
): Promise<void>;
|
||||
|
||||
public abstract start(): Promise<void>;
|
||||
public abstract stop(): Promise<void>;
|
||||
}
|
@@ -1,26 +1,36 @@
|
||||
import * as plugins from './taskbuffer.plugins';
|
||||
import { BufferRunner } from './taskbuffer.classes.bufferrunner';
|
||||
import { CycleCounter } from './taskbuffer.classes.cyclecounter';
|
||||
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 { logger } from './taskbuffer.logging';
|
||||
import { logger } from './taskbuffer.logging.js';
|
||||
|
||||
export interface ITaskFunction {
|
||||
(x?: any): PromiseLike<any>;
|
||||
export interface ITaskFunction<T = undefined> {
|
||||
(x?: any, setupValue?: T): PromiseLike<any>;
|
||||
}
|
||||
|
||||
export type TPreOrAfterTaskFunction = () => Task;
|
||||
export interface ITaskSetupFunction<T = undefined> {
|
||||
(): Promise<T>;
|
||||
}
|
||||
|
||||
export class Task {
|
||||
// STATIC
|
||||
public static extractTask(preOrAfterTaskArg: Task | TPreOrAfterTaskFunction): Task {
|
||||
export type TPreOrAfterTaskFunction = () => Task<any>;
|
||||
|
||||
// Type helper to extract step names from array
|
||||
export type StepNames<T> = T extends ReadonlyArray<{ name: infer N }> ? N : never;
|
||||
|
||||
export class Task<T = undefined, TSteps extends ReadonlyArray<{ name: string; description: string; percentage: number }> = []> {
|
||||
public static extractTask<T = undefined, TSteps extends ReadonlyArray<{ name: string; description: string; percentage: number }> = []>(
|
||||
preOrAfterTaskArg: Task<T, TSteps> | TPreOrAfterTaskFunction,
|
||||
): Task<T, TSteps> {
|
||||
switch (true) {
|
||||
case !preOrAfterTaskArg:
|
||||
return null;
|
||||
case preOrAfterTaskArg instanceof Task:
|
||||
return preOrAfterTaskArg as Task;
|
||||
return preOrAfterTaskArg as Task<T, TSteps>;
|
||||
case typeof preOrAfterTaskArg === 'function':
|
||||
const taskFunction = preOrAfterTaskArg as TPreOrAfterTaskFunction;
|
||||
return taskFunction();
|
||||
return taskFunction() as unknown as Task<T, TSteps>;
|
||||
default:
|
||||
return null;
|
||||
}
|
||||
@@ -32,7 +42,7 @@ export class Task {
|
||||
return done.promise;
|
||||
};
|
||||
|
||||
public static isTask = (taskArg: Task): boolean => {
|
||||
public static isTask = (taskArg: Task<any>): boolean => {
|
||||
if (taskArg instanceof Task && typeof taskArg.taskFunction === 'function') {
|
||||
return true;
|
||||
} else {
|
||||
@@ -40,10 +50,10 @@ export class Task {
|
||||
}
|
||||
};
|
||||
|
||||
public static isTaskTouched = (
|
||||
taskArg: Task | TPreOrAfterTaskFunction,
|
||||
touchedTasksArray: Task[]
|
||||
): boolean => {
|
||||
public static isTaskTouched<T = undefined, TSteps extends ReadonlyArray<{ name: string; description: string; percentage: number }> = []>(
|
||||
taskArg: Task<T, TSteps> | TPreOrAfterTaskFunction,
|
||||
touchedTasksArray: Task<T, TSteps>[],
|
||||
): boolean {
|
||||
const taskToCheck = Task.extractTask(taskArg);
|
||||
let result = false;
|
||||
for (const keyArg in touchedTasksArray) {
|
||||
@@ -52,44 +62,66 @@ export class Task {
|
||||
}
|
||||
}
|
||||
return result;
|
||||
};
|
||||
}
|
||||
|
||||
public static runTask = async (
|
||||
taskArg: Task | TPreOrAfterTaskFunction,
|
||||
optionsArg: { x?; touchedTasksArray?: Task[] }
|
||||
public static runTask = async <T, TSteps extends ReadonlyArray<{ name: string; description: string; percentage: number }> = []>(
|
||||
taskArg: Task<T, TSteps> | TPreOrAfterTaskFunction,
|
||||
optionsArg: { x?: any; touchedTasksArray?: Task<T, TSteps>[] },
|
||||
) => {
|
||||
const taskToRun = Task.extractTask(taskArg);
|
||||
const done = plugins.smartpromise.defer();
|
||||
|
||||
// pay respect to execDelay
|
||||
// Wait for all blocking tasks to finish
|
||||
for (const task of taskToRun.blockingTasks) {
|
||||
await task.finished;
|
||||
}
|
||||
|
||||
if (!taskToRun.setupValue && taskToRun.taskSetup) {
|
||||
taskToRun.setupValue = await taskToRun.taskSetup();
|
||||
}
|
||||
|
||||
if (taskToRun.execDelay) {
|
||||
await plugins.smartdelay.delayFor(taskToRun.execDelay);
|
||||
}
|
||||
|
||||
// set running params
|
||||
taskToRun.running = true;
|
||||
taskToRun.runCount++;
|
||||
taskToRun.lastRun = new Date();
|
||||
|
||||
// Reset steps at the beginning of task execution
|
||||
taskToRun.resetSteps();
|
||||
|
||||
done.promise.then(async () => {
|
||||
taskToRun.running = false;
|
||||
|
||||
// Complete all steps when task finishes
|
||||
taskToRun.completeAllSteps();
|
||||
|
||||
// When the task has finished running, resolve the finished promise
|
||||
taskToRun.resolveFinished();
|
||||
|
||||
// Create a new finished promise for the next run
|
||||
taskToRun.finished = new Promise((resolve) => {
|
||||
taskToRun.resolveFinished = resolve;
|
||||
});
|
||||
});
|
||||
|
||||
// handle options
|
||||
const options = {
|
||||
...{ x: undefined, touchedTasksArray: [] },
|
||||
...optionsArg,
|
||||
};
|
||||
const x = options.x;
|
||||
const touchedTasksArray: Task[] = options.touchedTasksArray;
|
||||
const touchedTasksArray: Task<T, TSteps>[] = options.touchedTasksArray;
|
||||
|
||||
touchedTasksArray.push(taskToRun);
|
||||
|
||||
// run the task cascade
|
||||
const localDeferred = plugins.smartpromise.defer();
|
||||
localDeferred.promise
|
||||
.then(() => {
|
||||
// lets run any preTask
|
||||
|
||||
if (taskToRun.preTask && !Task.isTaskTouched(taskToRun.preTask, touchedTasksArray)) {
|
||||
if (
|
||||
taskToRun.preTask &&
|
||||
!Task.isTaskTouched(taskToRun.preTask, touchedTasksArray)
|
||||
) {
|
||||
return Task.runTask(taskToRun.preTask, { x, touchedTasksArray });
|
||||
} else {
|
||||
const done2 = plugins.smartpromise.defer();
|
||||
@@ -98,16 +130,21 @@ export class Task {
|
||||
}
|
||||
})
|
||||
.then(async (x) => {
|
||||
// lets run the main task
|
||||
try {
|
||||
return await taskToRun.taskFunction(x);
|
||||
return await taskToRun.taskFunction(x, taskToRun.setupValue);
|
||||
} catch (e) {
|
||||
console.log(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);
|
||||
@@ -124,73 +161,85 @@ export class Task {
|
||||
return await done.promise;
|
||||
};
|
||||
|
||||
// INSTANCE
|
||||
// man datory properties
|
||||
public name: string;
|
||||
public taskFunction: ITaskFunction;
|
||||
public version: string;
|
||||
public taskFunction: ITaskFunction<T>;
|
||||
public buffered: boolean;
|
||||
public cronJob: plugins.smarttime.CronJob;
|
||||
|
||||
public bufferMax: number;
|
||||
public execDelay: number;
|
||||
public timeout: number;
|
||||
|
||||
// tasks to run before and after
|
||||
public preTask: Task | TPreOrAfterTaskFunction;
|
||||
public afterTask: Task | TPreOrAfterTaskFunction;
|
||||
public preTask: Task<T, any> | TPreOrAfterTaskFunction;
|
||||
public afterTask: Task<T, any> | TPreOrAfterTaskFunction;
|
||||
|
||||
// Add a list to store the blocking tasks
|
||||
public blockingTasks: Task[] = [];
|
||||
|
||||
// Add a promise that will resolve when the task has finished
|
||||
private finished: Promise<void>;
|
||||
private resolveFinished: () => void;
|
||||
|
||||
// initialize by default
|
||||
public running: boolean = false;
|
||||
public bufferRunner = new BufferRunner(this);
|
||||
public cycleCounter = new CycleCounter(this);
|
||||
public lastRun?: Date;
|
||||
public runCount: number = 0;
|
||||
|
||||
public idle: boolean = true;
|
||||
private _state: string = 'ready';
|
||||
public get idle() {
|
||||
return !this.running;
|
||||
}
|
||||
|
||||
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: {
|
||||
/**
|
||||
* the task function to run, must return promise
|
||||
*/
|
||||
taskFunction: ITaskFunction;
|
||||
/**
|
||||
* any other task to run before
|
||||
*/
|
||||
preTask?: Task | TPreOrAfterTaskFunction;
|
||||
/**
|
||||
* any other task to run after
|
||||
*/
|
||||
afterTask?: Task | TPreOrAfterTaskFunction;
|
||||
/**
|
||||
* wether this task should run buffered
|
||||
*/
|
||||
taskFunction: ITaskFunction<T>;
|
||||
preTask?: Task<T, any> | TPreOrAfterTaskFunction;
|
||||
afterTask?: Task<T, any> | TPreOrAfterTaskFunction;
|
||||
buffered?: boolean;
|
||||
/**
|
||||
* the maximum buffer
|
||||
*/
|
||||
bufferMax?: number;
|
||||
/**
|
||||
* the execution delay, before the task is executed
|
||||
* only makes sense when running in buffered mode
|
||||
*/
|
||||
execDelay?: number;
|
||||
/**
|
||||
* the name of the task
|
||||
*/
|
||||
name?: string;
|
||||
taskSetup?: ITaskSetupFunction<T>;
|
||||
steps?: TSteps;
|
||||
}) {
|
||||
this.taskFunction = optionsArg.taskFunction;
|
||||
this.preTask = optionsArg.preTask;
|
||||
this.afterTask = optionsArg.afterTask;
|
||||
this.idle = !this.running;
|
||||
this.buffered = optionsArg.buffered;
|
||||
this.bufferMax = optionsArg.bufferMax;
|
||||
this.execDelay = optionsArg.execDelay;
|
||||
this.name = optionsArg.name;
|
||||
this.taskSetup = optionsArg.taskSetup;
|
||||
|
||||
// Initialize steps if provided
|
||||
if (optionsArg.steps) {
|
||||
this.providedSteps = optionsArg.steps;
|
||||
for (const stepConfig of optionsArg.steps) {
|
||||
const step = new TaskStep({
|
||||
name: stepConfig.name,
|
||||
description: stepConfig.description,
|
||||
percentage: stepConfig.percentage,
|
||||
});
|
||||
this.steps.set(stepConfig.name, step);
|
||||
}
|
||||
}
|
||||
|
||||
// Create the finished promise
|
||||
this.finished = new Promise((resolve) => {
|
||||
this.resolveFinished = resolve;
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* trigger the task. Will trigger buffered if this.buffered is true
|
||||
*/
|
||||
public trigger(x?): Promise<any> {
|
||||
public trigger(x?: any): Promise<any> {
|
||||
if (this.buffered) {
|
||||
return this.triggerBuffered(x);
|
||||
} else {
|
||||
@@ -198,31 +247,103 @@ export class Task {
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* trigger task unbuffered.
|
||||
* will actually run the task, not considering any buffered limits.
|
||||
*/
|
||||
public triggerUnBuffered(x?): Promise<any> {
|
||||
return Task.runTask(this, { x: x });
|
||||
public triggerUnBuffered(x?: any): Promise<any> {
|
||||
return Task.runTask<T, TSteps>(this, { x: x });
|
||||
}
|
||||
|
||||
/**
|
||||
* trigger task buffered.
|
||||
* will simply call task.trigger(), which respects buffering by default
|
||||
*/
|
||||
public triggerBuffered(x?): Promise<any> {
|
||||
public triggerBuffered(x?: any): Promise<any> {
|
||||
return this.bufferRunner.trigger(x);
|
||||
}
|
||||
|
||||
get state(): string {
|
||||
return this._state;
|
||||
}
|
||||
// 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);
|
||||
}
|
||||
}
|
||||
|
||||
set state(stateArg: string) {
|
||||
if (stateArg === 'locked') {
|
||||
this._state = 'locked';
|
||||
} else {
|
||||
logger.log('error', `state type ${stateArg} could not be set`);
|
||||
// Start new step
|
||||
const step = this.steps.get(stepName as string);
|
||||
if (step) {
|
||||
step.start();
|
||||
this.currentStepName = 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}`);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// 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 {
|
||||
return {
|
||||
name: this.name || 'unnamed',
|
||||
version: this.version,
|
||||
status: this.running ? 'running' : 'idle',
|
||||
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,
|
||||
};
|
||||
}
|
||||
|
||||
// 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';
|
||||
}
|
||||
});
|
||||
}
|
||||
}
|
||||
|
@@ -1,9 +1,9 @@
|
||||
// TaskChain chains tasks
|
||||
// and extends Task
|
||||
|
||||
import * as plugins from './taskbuffer.plugins';
|
||||
import { Task } from './taskbuffer.classes.task';
|
||||
import { logger } from './taskbuffer.logging';
|
||||
import * as plugins from './taskbuffer.plugins.js';
|
||||
import { Task } from './taskbuffer.classes.task.js';
|
||||
import { logger } from './taskbuffer.logging.js';
|
||||
|
||||
export class Taskchain extends Task {
|
||||
taskArray: Task[];
|
||||
@@ -25,16 +25,20 @@ export class Taskchain extends Task {
|
||||
// this is the function that gets executed when TaskChain is triggered
|
||||
const done = plugins.smartpromise.defer(); // this is the starting Deferred object
|
||||
let taskCounter = 0; // counter for iterating async over the taskArray
|
||||
const iterateTasks = (x) => {
|
||||
const iterateTasks = (x: any) => {
|
||||
if (typeof this.taskArray[taskCounter] !== 'undefined') {
|
||||
console.log(this.name + ' running: Task' + this.taskArray[taskCounter].name);
|
||||
console.log(
|
||||
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);
|
||||
});
|
||||
} else {
|
||||
console.log('Taskchain "' + this.name + '" completed successfully');
|
||||
console.log(
|
||||
'Taskchain "' + this.name + '" completed successfully',
|
||||
);
|
||||
done.resolve(x);
|
||||
}
|
||||
};
|
||||
|
@@ -1,6 +1,6 @@
|
||||
import * as plugins from './taskbuffer.plugins';
|
||||
import * as plugins from './taskbuffer.plugins.js';
|
||||
|
||||
import { Task, ITaskFunction } from './taskbuffer.classes.task';
|
||||
import { Task, type ITaskFunction } from './taskbuffer.classes.task.js';
|
||||
|
||||
export class TaskDebounced<T = unknown> extends Task {
|
||||
private _debouncedTaskFunction: ITaskFunction;
|
||||
@@ -19,7 +19,9 @@ export class TaskDebounced<T = unknown> extends Task {
|
||||
});
|
||||
this.taskFunction = optionsArg.taskFunction;
|
||||
this._observableIntake.observable
|
||||
.pipe(plugins.smartrx.rxjs.ops.debounceTime(optionsArg.debounceTimeInMillis))
|
||||
.pipe(
|
||||
plugins.smartrx.rxjs.ops.debounceTime(optionsArg.debounceTimeInMillis),
|
||||
)
|
||||
.subscribe((x) => {
|
||||
this.taskFunction(x);
|
||||
});
|
||||
|
@@ -1,119 +1,268 @@
|
||||
import * as plugins from './taskbuffer.plugins';
|
||||
import { Task } from './taskbuffer.classes.task';
|
||||
import { threadId } from 'worker_threads';
|
||||
import * as plugins from './taskbuffer.plugins.js';
|
||||
import { Task } from './taskbuffer.classes.task.js';
|
||||
import {
|
||||
AbstractDistributedCoordinator,
|
||||
type IDistributedTaskRequestResult,
|
||||
} from './taskbuffer.classes.distributedcoordinator.js';
|
||||
import type { ITaskMetadata, ITaskExecutionReport, IScheduledTaskInfo } from './taskbuffer.interfaces.js';
|
||||
|
||||
export interface ICronJob {
|
||||
cronString: string;
|
||||
taskNameArg: string;
|
||||
taskName: string;
|
||||
job: any;
|
||||
}
|
||||
|
||||
export interface ITaskManagerConstructorOptions {
|
||||
distributedCoordinator?: AbstractDistributedCoordinator;
|
||||
}
|
||||
|
||||
export class TaskManager {
|
||||
public taskMap = new plugins.lik.ObjectMap<Task>();
|
||||
public randomId = plugins.smartunique.shortId();
|
||||
public taskMap = new plugins.lik.ObjectMap<Task<any, any>>();
|
||||
private cronJobManager = new plugins.smarttime.CronManager();
|
||||
public options: ITaskManagerConstructorOptions = {
|
||||
distributedCoordinator: null,
|
||||
};
|
||||
|
||||
constructor() {
|
||||
// nothing here
|
||||
constructor(options: ITaskManagerConstructorOptions = {}) {
|
||||
this.options = Object.assign(this.options, options);
|
||||
}
|
||||
|
||||
/**
|
||||
* checks if a task is already present
|
||||
* @param taskNameArg
|
||||
*/
|
||||
public getTaskByName(taskNameArg): Task {
|
||||
return this.taskMap.find((itemArg) => {
|
||||
return itemArg.name === taskNameArg;
|
||||
});
|
||||
public getTaskByName(taskName: string): Task<any, any> {
|
||||
return this.taskMap.findSync((task) => task.name === taskName);
|
||||
}
|
||||
|
||||
/**
|
||||
* adds a Task to the TaskManager
|
||||
* @param taskArg
|
||||
*/
|
||||
public addTask(taskArg: Task): void {
|
||||
if (!taskArg.name) {
|
||||
throw new Error('taskArg needs a name to be added to taskManager');
|
||||
public addTask(task: Task<any, any>): void {
|
||||
if (!task.name) {
|
||||
throw new Error('Task must have a name to be added to taskManager');
|
||||
}
|
||||
this.taskMap.add(taskArg);
|
||||
this.taskMap.add(task);
|
||||
}
|
||||
|
||||
/**
|
||||
* adds and schedules a task at once
|
||||
* @param taskArg
|
||||
* @param cronStringArg
|
||||
*/
|
||||
public addAndScheduleTask(taskArg: Task, cronStringArg: string) {
|
||||
this.addTask(taskArg);
|
||||
this.scheduleTaskByName(taskArg.name, cronStringArg);
|
||||
public addAndScheduleTask(task: Task<any, any>, cronString: string) {
|
||||
this.addTask(task);
|
||||
this.scheduleTaskByName(task.name, cronString);
|
||||
}
|
||||
|
||||
/**
|
||||
* triggers a task in the TaskManagerByName
|
||||
* @param taskNameArg
|
||||
*/
|
||||
public triggerTaskByName(taskNameArg: string): Promise<any> {
|
||||
const taskToTrigger = this.getTaskByName(taskNameArg);
|
||||
public async triggerTaskByName(taskName: string): Promise<any> {
|
||||
const taskToTrigger = this.getTaskByName(taskName);
|
||||
if (!taskToTrigger) {
|
||||
throw new Error(`There is no task with the name of ${taskNameArg}`);
|
||||
throw new Error(`No task with the name ${taskName} found.`);
|
||||
}
|
||||
return taskToTrigger.trigger();
|
||||
}
|
||||
|
||||
public async triggerTask(task: Task) {
|
||||
public async triggerTask(task: Task<any, any>) {
|
||||
return task.trigger();
|
||||
}
|
||||
|
||||
/**
|
||||
* schedules the task by name
|
||||
* @param taskNameArg
|
||||
*/
|
||||
public scheduleTaskByName(taskNameArg: string, cronStringArg: string) {
|
||||
const taskToSchedule = this.getTaskByName(taskNameArg);
|
||||
const cronJob = this.cronJobManager.addCronjob(cronStringArg, async () => {
|
||||
await taskToSchedule.triggerBuffered();
|
||||
});
|
||||
taskToSchedule.cronJob = cronJob;
|
||||
public scheduleTaskByName(taskName: string, cronString: string) {
|
||||
const taskToSchedule = this.getTaskByName(taskName);
|
||||
if (!taskToSchedule) {
|
||||
throw new Error(`No task with the name ${taskName} found.`);
|
||||
}
|
||||
this.handleTaskScheduling(taskToSchedule, cronString);
|
||||
}
|
||||
|
||||
/**
|
||||
* deschedules a task by name
|
||||
* @param taskNameArg
|
||||
*/
|
||||
public descheduleTaskByName(taskNameArg: string) {
|
||||
const taskToDeSchedule = this.getTaskByName(taskNameArg);
|
||||
if (taskToDeSchedule.cronJob) {
|
||||
this.cronJobManager.removeCronjob(taskToDeSchedule.cronJob);
|
||||
taskToDeSchedule.cronJob = null;
|
||||
private handleTaskScheduling(task: Task<any, any>, cronString: string) {
|
||||
const cronJob = this.cronJobManager.addCronjob(
|
||||
cronString,
|
||||
async (triggerTime: number) => {
|
||||
this.logTaskState(task);
|
||||
if (this.options.distributedCoordinator) {
|
||||
const announcementResult = await this.performDistributedConsultation(
|
||||
task,
|
||||
triggerTime,
|
||||
);
|
||||
if (!announcementResult.shouldTrigger) {
|
||||
console.log('Distributed coordinator result: NOT EXECUTING');
|
||||
return;
|
||||
} else {
|
||||
console.log('Distributed coordinator result: CHOSEN AND EXECUTING');
|
||||
}
|
||||
}
|
||||
await task.trigger();
|
||||
},
|
||||
);
|
||||
task.cronJob = cronJob;
|
||||
}
|
||||
|
||||
private logTaskState(task: Task<any, any>) {
|
||||
console.log(`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}`);
|
||||
}
|
||||
|
||||
private async performDistributedConsultation(
|
||||
task: Task<any, any>,
|
||||
triggerTime: number,
|
||||
): Promise<IDistributedTaskRequestResult> {
|
||||
console.log('Found a distributed coordinator, performing consultation.');
|
||||
|
||||
return this.options.distributedCoordinator.fireDistributedTaskRequest({
|
||||
submitterId: this.randomId,
|
||||
requestResponseId: plugins.smartunique.shortId(),
|
||||
status: 'requesting',
|
||||
taskExecutionParallel: 1,
|
||||
taskExecutionTime: triggerTime,
|
||||
taskExecutionTimeout: task.timeout,
|
||||
taskName: task.name,
|
||||
taskVersion: task.version,
|
||||
});
|
||||
}
|
||||
|
||||
public descheduleTaskByName(taskName: string) {
|
||||
const task = this.getTaskByName(taskName);
|
||||
if (task && task.cronJob) {
|
||||
this.cronJobManager.removeCronjob(task.cronJob);
|
||||
task.cronJob = null;
|
||||
}
|
||||
if (this.cronJobManager.cronjobs.isEmpty) {
|
||||
this.cronJobManager.stop();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* deschedules a task
|
||||
* @param task
|
||||
*/
|
||||
public async descheduleTask(task: Task) {
|
||||
public async descheduleTask(task: Task<any, any>) {
|
||||
await this.descheduleTaskByName(task.name);
|
||||
}
|
||||
/**
|
||||
* returns all schedules of a specific task
|
||||
* @param taskNameArg
|
||||
*/
|
||||
public getSchedulesForTaskName(taskNameArg: string) {}
|
||||
|
||||
/**
|
||||
* starts the taskmanager
|
||||
*/
|
||||
public start() {
|
||||
public getScheduleForTaskName(taskName: string): string | null {
|
||||
const task = this.getTaskByName(taskName);
|
||||
return task && task.cronJob ? task.cronJob.cronExpression : null;
|
||||
}
|
||||
|
||||
public async start() {
|
||||
if (this.options.distributedCoordinator) {
|
||||
await this.options.distributedCoordinator.start();
|
||||
}
|
||||
this.cronJobManager.start();
|
||||
}
|
||||
|
||||
/**
|
||||
* stops the taskmanager
|
||||
*/
|
||||
public stop() {
|
||||
public async stop() {
|
||||
this.cronJobManager.stop();
|
||||
if (this.options.distributedCoordinator) {
|
||||
await this.options.distributedCoordinator.stop();
|
||||
}
|
||||
}
|
||||
|
||||
// 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;
|
||||
}
|
||||
|
||||
// Add, execute, and remove a task while collecting metadata
|
||||
public async addExecuteRemoveTask<T, TSteps extends ReadonlyArray<{ name: string; description: string; percentage: number }>>(
|
||||
task: Task<T, TSteps>,
|
||||
options?: {
|
||||
schedule?: string;
|
||||
trackProgress?: boolean;
|
||||
}
|
||||
): Promise<ITaskExecutionReport> {
|
||||
// Add task to manager
|
||||
this.addTask(task);
|
||||
|
||||
// Optionally schedule it
|
||||
if (options?.schedule) {
|
||||
this.scheduleTaskByName(task.name!, options.schedule);
|
||||
}
|
||||
|
||||
const startTime = Date.now();
|
||||
const progressUpdates: Array<{ stepName: string; timestamp: number }> = [];
|
||||
|
||||
try {
|
||||
// Execute the task
|
||||
const result = await task.trigger();
|
||||
|
||||
// Collect execution report
|
||||
const report: ITaskExecutionReport = {
|
||||
taskName: task.name || 'unnamed',
|
||||
startTime,
|
||||
endTime: Date.now(),
|
||||
duration: Date.now() - startTime,
|
||||
steps: task.getStepsMetadata(),
|
||||
stepsCompleted: task.getStepsMetadata()
|
||||
.filter(step => step.status === 'completed')
|
||||
.map(step => step.name),
|
||||
progress: task.getProgress(),
|
||||
result,
|
||||
};
|
||||
|
||||
// Remove task from manager
|
||||
this.taskMap.remove(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.taskMap.remove(task);
|
||||
|
||||
// Deschedule if it was scheduled
|
||||
if (options?.schedule && task.name) {
|
||||
this.descheduleTaskByName(task.name);
|
||||
}
|
||||
|
||||
throw errorReport;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@@ -1,6 +1,6 @@
|
||||
import * as plugins from './taskbuffer.plugins';
|
||||
import * as plugins from './taskbuffer.plugins.js';
|
||||
|
||||
import { Task, ITaskFunction } from './taskbuffer.classes.task';
|
||||
import { Task, type ITaskFunction } from './taskbuffer.classes.task.js';
|
||||
|
||||
/**
|
||||
* TaskOnce is run exactly once, no matter how often it is triggered
|
||||
|
@@ -1,5 +1,5 @@
|
||||
import * as plugins from './taskbuffer.plugins';
|
||||
import { Task } from './taskbuffer.classes.task';
|
||||
import * as plugins from './taskbuffer.plugins.js';
|
||||
import { Task } from './taskbuffer.classes.task.js';
|
||||
|
||||
export class Taskparallel extends Task {
|
||||
public taskArray: Task[];
|
||||
|
@@ -1,11 +1,12 @@
|
||||
import * as plugins from './taskbuffer.plugins';
|
||||
import * as plugins from './taskbuffer.plugins.js';
|
||||
|
||||
import { Task } from './taskbuffer.classes.task';
|
||||
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 runningTasks: plugins.lik.ObjectMap<Task> =
|
||||
new plugins.lik.ObjectMap<Task>();
|
||||
public qeuedTasks: Task[] = [];
|
||||
|
||||
constructor() {
|
||||
|
57
ts/taskbuffer.classes.taskstep.ts
Normal file
57
ts/taskbuffer.classes.taskstep.ts
Normal file
@@ -0,0 +1,57 @@
|
||||
export interface ITaskStep {
|
||||
name: string;
|
||||
description: string;
|
||||
percentage: number; // Weight of this step (0-100)
|
||||
status: 'pending' | 'active' | 'completed';
|
||||
startTime?: number;
|
||||
endTime?: number;
|
||||
duration?: number;
|
||||
}
|
||||
|
||||
export class TaskStep implements ITaskStep {
|
||||
public name: string;
|
||||
public description: string;
|
||||
public percentage: number;
|
||||
public status: 'pending' | 'active' | 'completed' = 'pending';
|
||||
public startTime?: number;
|
||||
public endTime?: number;
|
||||
public duration?: number;
|
||||
|
||||
constructor(config: { name: string; description: string; percentage: number }) {
|
||||
this.name = config.name;
|
||||
this.description = config.description;
|
||||
this.percentage = config.percentage;
|
||||
}
|
||||
|
||||
public start(): void {
|
||||
this.status = 'active';
|
||||
this.startTime = Date.now();
|
||||
}
|
||||
|
||||
public complete(): void {
|
||||
if (this.startTime) {
|
||||
this.endTime = Date.now();
|
||||
this.duration = this.endTime - this.startTime;
|
||||
}
|
||||
this.status = 'completed';
|
||||
}
|
||||
|
||||
public reset(): void {
|
||||
this.status = 'pending';
|
||||
this.startTime = undefined;
|
||||
this.endTime = undefined;
|
||||
this.duration = undefined;
|
||||
}
|
||||
|
||||
public toJSON(): ITaskStep {
|
||||
return {
|
||||
name: this.name,
|
||||
description: this.description,
|
||||
percentage: this.percentage,
|
||||
status: this.status,
|
||||
startTime: this.startTime,
|
||||
endTime: this.endTime,
|
||||
duration: this.duration,
|
||||
};
|
||||
}
|
||||
}
|
39
ts/taskbuffer.interfaces.ts
Normal file
39
ts/taskbuffer.interfaces.ts
Normal file
@@ -0,0 +1,39 @@
|
||||
import type { ITaskStep } from './taskbuffer.classes.taskstep.js';
|
||||
|
||||
export interface ITaskMetadata {
|
||||
name: string;
|
||||
version?: string;
|
||||
status: 'idle' | 'running' | 'completed' | 'failed';
|
||||
steps: ITaskStep[];
|
||||
currentStep?: string;
|
||||
currentProgress: number; // 0-100
|
||||
lastRun?: Date;
|
||||
nextRun?: Date; // For scheduled tasks
|
||||
runCount: number;
|
||||
averageDuration?: number;
|
||||
cronSchedule?: string;
|
||||
buffered?: boolean;
|
||||
bufferMax?: number;
|
||||
timeout?: number;
|
||||
}
|
||||
|
||||
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;
|
||||
}
|
@@ -1,3 +1,3 @@
|
||||
import * as plugins from './taskbuffer.plugins';
|
||||
import * as plugins from './taskbuffer.plugins.js';
|
||||
|
||||
export const logger = new plugins.smartlog.ConsoleLog();
|
||||
|
@@ -1,8 +1,17 @@
|
||||
import * as smartlog from '@pushrocks/smartlog';
|
||||
import * as lik from '@pushrocks/lik';
|
||||
import * as smartpromise from '@pushrocks/smartpromise';
|
||||
import * as smartdelay from '@pushrocks/smartdelay';
|
||||
import * as smartrx from '@pushrocks/smartrx';
|
||||
import * as smarttime from '@pushrocks/smarttime';
|
||||
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 { smartlog, lik, smartpromise, smartdelay, smartrx, smarttime };
|
||||
export {
|
||||
lik,
|
||||
smartlog,
|
||||
smartpromise,
|
||||
smartdelay,
|
||||
smartrx,
|
||||
smarttime,
|
||||
smartunique,
|
||||
};
|
||||
|
8
ts_web/00_commitinfo_data.ts
Normal file
8
ts_web/00_commitinfo_data.ts
Normal file
@@ -0,0 +1,8 @@
|
||||
/**
|
||||
* autocreated commitinfo by @push.rocks/commitinfo
|
||||
*/
|
||||
export const commitinfo = {
|
||||
name: '@push.rocks/taskbuffer',
|
||||
version: '3.2.0',
|
||||
description: 'A flexible task management library supporting TypeScript, allowing for task buffering, scheduling, and execution with dependency management.'
|
||||
}
|
14
tsconfig.json
Normal file
14
tsconfig.json
Normal file
@@ -0,0 +1,14 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"experimentalDecorators": true,
|
||||
"useDefineForClassFields": false,
|
||||
"target": "ES2022",
|
||||
"module": "NodeNext",
|
||||
"moduleResolution": "NodeNext",
|
||||
"esModuleInterop": true,
|
||||
"verbatimModuleSyntax": true,
|
||||
"baseUrl": ".",
|
||||
"paths": {}
|
||||
},
|
||||
"exclude": ["dist_*/**/*.d.ts"]
|
||||
}
|
17
tslint.json
17
tslint.json
@@ -1,17 +0,0 @@
|
||||
{
|
||||
"extends": ["tslint:latest", "tslint-config-prettier"],
|
||||
"rules": {
|
||||
"semicolon": [true, "always"],
|
||||
"no-console": false,
|
||||
"ordered-imports": false,
|
||||
"object-literal-sort-keys": false,
|
||||
"member-ordering": {
|
||||
"options":{
|
||||
"order": [
|
||||
"static-method"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"defaultSeverity": "warning"
|
||||
}
|
Reference in New Issue
Block a user