Compare commits
43 Commits
Author | SHA1 | Date | |
---|---|---|---|
2fb605a58e | |||
ed1e9a08b2 | |||
4d23b3dbfe | |||
9784a5eacf | |||
6c9b975029 | |||
b1725cbdf9 | |||
d54012379c | |||
dc47bc3d2a | |||
863adb3b8c | |||
67f01417b6 | |||
65886287c6 | |||
fdaf772cfc | |||
757b992440 | |||
b4a701d128 | |||
ca3ef8ced6 | |||
6115bae66b | |||
1be83af475 | |||
bd14c41edc | |||
d61b79282d | |||
1cba9245fe | |||
4b0db4da21 | |||
a6cd0cb579 | |||
bd6109d5ea | |||
aa632a5294 | |||
6499dd45cf | |||
d04ed21607 | |||
bae776d4e9 | |||
fcd7ea467e | |||
e061b96056 | |||
c2ce669f0c | |||
05f91c3e35 | |||
94e327c722 | |||
57a27604a7 | |||
b077bd7a1b | |||
f2c2dab782 | |||
53a67c0ebe | |||
5240a80cb3 | |||
fa8be6b6d3 | |||
b5981d67cf | |||
493cd83dda | |||
86b2842ed2 | |||
801e2ad266 | |||
7f837c70fc |
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
|
# artifacts
|
||||||
coverage/
|
coverage/
|
||||||
public/
|
public/
|
||||||
pages/
|
|
||||||
|
|
||||||
# installs
|
# installs
|
||||||
node_modules/
|
node_modules/
|
||||||
@@ -17,4 +16,8 @@ node_modules/
|
|||||||
dist/
|
dist/
|
||||||
dist_*/
|
dist_*/
|
||||||
|
|
||||||
# custom
|
# AI
|
||||||
|
.claude/
|
||||||
|
.serena/
|
||||||
|
|
||||||
|
#------# custom
|
141
.gitlab-ci.yml
141
.gitlab-ci.yml
@@ -1,141 +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
|
|
||||||
|
|
||||||
before_script:
|
|
||||||
- npm install -g @shipzone/npmci
|
|
||||||
|
|
||||||
# ====================
|
|
||||||
# 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
|
|
||||||
allow_failure: true
|
|
||||||
|
|
||||||
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"
|
2
LICENSE
2
LICENSE
@@ -1,6 +1,6 @@
|
|||||||
The MIT License (MIT)
|
The MIT License (MIT)
|
||||||
|
|
||||||
Copyright (c) 2016 Push.Rocks
|
Copyright (c) 2016 Task Venture Capital GmbH <hello@task.vc>
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
139
changelog.md
Normal file
139
changelog.md
Normal file
@@ -0,0 +1,139 @@
|
|||||||
|
# Changelog
|
||||||
|
|
||||||
|
## 2025-09-07 - 3.4.0 - feat(taskbuffer-dashboard)
|
||||||
|
Add TaskBuffer dashboard web component, demo and browser tests; add HTML entry and update dependencies
|
||||||
|
|
||||||
|
- Introduce a new web component taskbuffer-dashboard for real-time visualization of tasks and schedules (ts_web/taskbuffer-dashboard.ts).
|
||||||
|
- Add a demo wrapper and interactive UI for the dashboard (ts_web/elements/taskbuffer-dashboard.demo.ts).
|
||||||
|
- Provide web exports and typings for web usage (ts_web/index.ts) and include an HTML entry (html/index.html).
|
||||||
|
- Add browser-oriented tests to validate metadata structures for the web component (test/test.10.webcomponent.browser.ts).
|
||||||
|
- Bump package version to 3.3.0 in package.json as part of this change.
|
||||||
|
- Update/add dependencies and devDependencies (@design.estate/dees-element added; smartlog, @git.zone/tsbuild and @git.zone/tstest bumped).
|
||||||
|
|
||||||
|
## 2025-09-06 - 3.2.0 - feat(core)
|
||||||
|
Add step-based progress tracking, task metadata and enhanced TaskManager scheduling/metadata APIs
|
||||||
|
|
||||||
|
- Introduce TaskStep class for named, weighted steps with timing and status (pending|active|completed).
|
||||||
|
- Add step-tracking to Task: notifyStep, getProgress, getStepsMetadata, getMetadata, resetSteps and internal step lifecycle handling.
|
||||||
|
- Task now records runCount and lastRun; Task.run flow resets/cleans steps and aggregates progress.
|
||||||
|
- TaskManager enhancements: schedule/deschedule improvements, performDistributedConsultation, and new metadata-focused APIs: getTaskMetadata, getAllTasksMetadata, getScheduledTasks, getNextScheduledRuns, addExecuteRemoveTask (exec + collect report).
|
||||||
|
- Exports updated: TaskStep and related types exported from index, plus Task metadata interfaces.
|
||||||
|
- Comprehensive README updates documenting step-based progress tracking, metadata, TaskManager and examples.
|
||||||
|
- New/updated tests added for step behavior and metadata (test/test.9.steps.ts) and other TS additions.
|
||||||
|
- Minor build/script change: build script updated to use 'tsbuild tsfolders'.
|
||||||
|
|
||||||
|
## 2025-08-26 - 3.1.10 - fix(task)
|
||||||
|
Implement core Task execution flow, buffering and lifecycle; update README with generics and buffer docs
|
||||||
|
|
||||||
|
- Implement Task.runTask including preTask/afterTask chaining, touched-task cycle prevention and error handling.
|
||||||
|
- Add Task helpers: extractTask, isTask, isTaskTouched and emptyTaskFunction (resolved promise).
|
||||||
|
- Introduce task lifecycle coordination: finished promise, resolveFinished, and blockingTasks to await dependent tasks.
|
||||||
|
- Support taskSetup/setupValue, execDelay handling, and wait-for-blocking-tasks before execution.
|
||||||
|
- Wire up trigger() to choose buffered vs unbuffered execution (triggerBuffered / triggerUnBuffered) and integrate BufferRunner.
|
||||||
|
- Improve logging and safer promise handling (caught errors are logged).
|
||||||
|
- Update README with extended TypeScript generics examples and expanded buffer behavior and strategies documentation.
|
||||||
|
|
||||||
|
## 2025-08-26 - 3.1.9 - fix(tests)
|
||||||
|
Update CI workflows, fix tests and refresh README/package metadata
|
||||||
|
|
||||||
|
- CI: switch Docker image to code.foss.global/host.today/ht-docker-node:npmci and adjust NPMCI_COMPUTED_REPOURL; replace npmci installer package name from @shipzone/npmci to @ship.zone/npmci in Gitea workflows
|
||||||
|
- Tests: update test imports to use @git.zone/tstest/tapbundle and apply small formatting fixes to test files
|
||||||
|
- Package metadata: update bugs URL and homepage to code.foss.global, add a pnpm.overrides placeholder in package.json
|
||||||
|
- .gitignore: add AI/tooling directories (.claude, .serena) and reorganize custom section
|
||||||
|
- Code style/TS fixes: minor formatting changes across ts sources (trailing commas, line breaks, consistent object/argument commas) and small API surface formatting fixes
|
||||||
|
- Documentation: whitespace/formatting cleanups in README and add changelog entry for 3.1.8
|
||||||
|
|
||||||
|
## 2025-08-26 - 3.1.8 - fix(tests)
|
||||||
|
|
||||||
|
Update test runner and imports, refresh README and package metadata, add project tooling/config files
|
||||||
|
|
||||||
|
- Replaced test imports from '@push.rocks/tapbundle' to '@git.zone/tstest/tapbundle' across test files
|
||||||
|
- Updated test script in package.json to run tstest with --verbose --logfile --timeout 120
|
||||||
|
- Bumped devDependency @git.zone/tstest to ^2.3.5 and adjusted package.json fields (typings, packageManager)
|
||||||
|
- Expanded and rewrote README with detailed examples, API reference, and usage guidance
|
||||||
|
- Refactored TaskManager tests (removed duplicate both-file and added consolidated test/test.4.taskmanager.ts)
|
||||||
|
- Added development/project tooling and metadata files (.claude settings, .serena project/memories) to aid local development and CI
|
||||||
|
|
||||||
|
## 2024-05-29 - 3.1.7 - maintenance/config
|
||||||
|
|
||||||
|
Updated package metadata and build configuration.
|
||||||
|
|
||||||
|
- Updated package description.
|
||||||
|
- Multiple TypeScript configuration updates (tsconfig).
|
||||||
|
- Updated npmextra.json githost entries (changes across 2024-03-30, 2024-04-01, 2024-04-14).
|
||||||
|
|
||||||
|
## 2023-08-04 - 3.0.15 - feat(Task)
|
||||||
|
|
||||||
|
Tasks can now be blocked by other tasks.
|
||||||
|
|
||||||
|
- Introduced task blocking support in the Task implementation.
|
||||||
|
- Release contains related maintenance and patch fixes.
|
||||||
|
|
||||||
|
## 2023-01-07 to 2023-10-20 - 3.0.4..3.1.6 - maintenance
|
||||||
|
|
||||||
|
Series of patch releases focused on core fixes and stability.
|
||||||
|
|
||||||
|
- Numerous core fixes and small adjustments across many patch versions.
|
||||||
|
- General maintenance: bug fixes, internal updates and stability improvements.
|
||||||
|
|
||||||
|
## 2022-03-25 - 2.1.17 - BREAKING(core)
|
||||||
|
|
||||||
|
Switched module format to ESM (breaking).
|
||||||
|
|
||||||
|
- BREAKING CHANGE: project now uses ESM module format.
|
||||||
|
- Release includes the version bump and migration to ESM.
|
||||||
|
|
||||||
|
## 2019-11-28 - 2.0.16 - feat(taskrunner)
|
||||||
|
|
||||||
|
Introduce a working task runner.
|
||||||
|
|
||||||
|
- Added/activated a working taskrunner implementation.
|
||||||
|
- Improvements to task execution and orchestration.
|
||||||
|
|
||||||
|
## 2019-09-05 to 2022-11-14 - 2.0.3..2.1.16 - maintenance
|
||||||
|
|
||||||
|
Ongoing maintenance and incremental fixes between 2.0.x and 2.1.x series.
|
||||||
|
|
||||||
|
- Multiple fixes labeled as core maintenance updates.
|
||||||
|
- CI, packaging and small doc/test fixes rolled out across these releases.
|
||||||
|
|
||||||
|
## 2018-08-04 - 2.0.0 - major
|
||||||
|
|
||||||
|
Major release and scope change with CI/test updates.
|
||||||
|
|
||||||
|
- Released 2.0.0 with updated docs.
|
||||||
|
- BREAKING CHANGE: package scope switched to @pushrocks (scope migration).
|
||||||
|
- CI and testing updates (moved to new tstest), package.json adjustments.
|
||||||
|
|
||||||
|
## 2017-07-12 - 1.0.21 - enhancements
|
||||||
|
|
||||||
|
Feature additions around task utilities and manager.
|
||||||
|
|
||||||
|
- Introduced TaskOnce.
|
||||||
|
- Implemented TaskManager (added TaskManager class and improvements across 1.0.10–1.0.16).
|
||||||
|
- Implemented execDelay for tasks.
|
||||||
|
- Documentation and test improvements.
|
||||||
|
|
||||||
|
## 2016-08-03 - 1.0.6 - types
|
||||||
|
|
||||||
|
Type and promise improvements.
|
||||||
|
|
||||||
|
- Now returns correct Promise types.
|
||||||
|
- Dependency and typings updates.
|
||||||
|
|
||||||
|
## 2016-08-01 - 1.0.0 - stable
|
||||||
|
|
||||||
|
First stable 1.0.0 release.
|
||||||
|
|
||||||
|
- Exported public interfaces.
|
||||||
|
- Base API stabilized for 1.x line.
|
||||||
|
|
||||||
|
## 2016-05-15 to 2016-05-06 - 0.1.0..0.0.5 - initial features
|
||||||
|
|
||||||
|
Initial implementation of core task primitives and utilities.
|
||||||
|
|
||||||
|
- Added Taskparallel class to execute tasks in parallel.
|
||||||
|
- Introduced basic Task class and working taskchain.
|
||||||
|
- Added logging and initial task buffering behavior.
|
||||||
|
- Improvements to README, typings and packaging.
|
||||||
|
- Early CI and build setup (Travis/GitLab CI).
|
21
html/index.html
Normal file
21
html/index.html
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta
|
||||||
|
name="viewport"
|
||||||
|
content="user-scalable=no, initial-scale=1, maximum-scale=1, minimum-scale=1, width=device-width, height=device-height"
|
||||||
|
/>
|
||||||
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||||
|
|
||||||
|
<style>
|
||||||
|
body {
|
||||||
|
margin: 0px;
|
||||||
|
background: #222222;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
|
||||||
|
<script type="module" src="/bundle.js"></script>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
</body>
|
||||||
|
</html>
|
@@ -7,12 +7,27 @@
|
|||||||
"gitzone": {
|
"gitzone": {
|
||||||
"projectType": "npm",
|
"projectType": "npm",
|
||||||
"module": {
|
"module": {
|
||||||
"githost": "gitlab.com",
|
"githost": "code.foss.global",
|
||||||
"gitscope": "pushrocks",
|
"gitscope": "push.rocks",
|
||||||
"gitrepo": "taskbuffer",
|
"gitrepo": "taskbuffer",
|
||||||
"shortDescription": "flexible task management. TypeScript ready!",
|
"description": "A flexible task management library supporting TypeScript, allowing for task buffering, scheduling, and execution with dependency management.",
|
||||||
"npmPackagename": "@pushrocks/taskbuffer",
|
"npmPackagename": "@push.rocks/taskbuffer",
|
||||||
"license": "MIT"
|
"license": "MIT",
|
||||||
|
"keywords": [
|
||||||
|
"task management",
|
||||||
|
"TypeScript",
|
||||||
|
"task buffering",
|
||||||
|
"task scheduling",
|
||||||
|
"task execution",
|
||||||
|
"task dependencies",
|
||||||
|
"parallel tasks",
|
||||||
|
"task chains",
|
||||||
|
"debounced tasks",
|
||||||
|
"distributed coordination"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
|
},
|
||||||
|
"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"
|
||||||
}
|
}
|
||||||
}
|
}
|
62
package.json
62
package.json
@@ -1,48 +1,54 @@
|
|||||||
{
|
{
|
||||||
"name": "@pushrocks/taskbuffer",
|
"name": "@push.rocks/taskbuffer",
|
||||||
"version": "3.0.9",
|
"version": "3.4.0",
|
||||||
"private": false,
|
"private": false,
|
||||||
"description": "flexible task management. TypeScript ready!",
|
"description": "A flexible task management library supporting TypeScript, allowing for task buffering, scheduling, and execution with dependency management.",
|
||||||
"main": "dist_ts/index.js",
|
"main": "dist_ts/index.js",
|
||||||
"typings": "dist_ts/index.d.ts",
|
"typings": "dist_ts/index.d.ts",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"test": "(tstest test/ --web)",
|
"test": "(tstest test/ --verbose --logfile --timeout 120)",
|
||||||
"build": "(tsbuild --web && tsbundle npm)"
|
"build": "(tsbuild tsfolders)",
|
||||||
|
"buildDocs": "tsdoc"
|
||||||
},
|
},
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "git+https://gitlab.com/pushrocks/taskbuffer.git"
|
"url": "https://code.foss.global/push.rocks/taskbuffer.git"
|
||||||
},
|
},
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"gulp",
|
"task management",
|
||||||
"task",
|
|
||||||
"buffer",
|
|
||||||
"TypeScript",
|
"TypeScript",
|
||||||
"push.rocks"
|
"task buffering",
|
||||||
|
"task scheduling",
|
||||||
|
"task execution",
|
||||||
|
"task dependencies",
|
||||||
|
"parallel tasks",
|
||||||
|
"task chains",
|
||||||
|
"debounced tasks",
|
||||||
|
"distributed coordination"
|
||||||
],
|
],
|
||||||
"author": "Lossless GmbH",
|
"author": "Lossless GmbH",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"bugs": {
|
"bugs": {
|
||||||
"url": "https://gitlab.com/pushrocks/taskbuffer/issues"
|
"url": "https://code.foss.global/push.rocks/taskbuffer/issues"
|
||||||
},
|
},
|
||||||
"homepage": "https://gitlab.com/pushrocks/taskbuffer#readme",
|
"homepage": "https://code.foss.global/push.rocks/taskbuffer#readme",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@pushrocks/isounique": "^1.0.5",
|
"@design.estate/dees-element": "^2.1.2",
|
||||||
"@pushrocks/lik": "^6.0.0",
|
"@push.rocks/lik": "^6.0.5",
|
||||||
"@pushrocks/smartdelay": "^2.0.13",
|
"@push.rocks/smartdelay": "^3.0.5",
|
||||||
"@pushrocks/smartlog": "^3.0.1",
|
"@push.rocks/smartlog": "^3.1.9",
|
||||||
"@pushrocks/smartpromise": "^3.1.7",
|
"@push.rocks/smartpromise": "^4.0.3",
|
||||||
"@pushrocks/smartrx": "^3.0.0",
|
"@push.rocks/smartrx": "^3.0.6",
|
||||||
"@pushrocks/smarttime": "^4.0.1"
|
"@push.rocks/smarttime": "^4.0.6",
|
||||||
|
"@push.rocks/smartunique": "^3.0.6"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@gitzone/tsbuild": "^2.1.63",
|
"@git.zone/tsbuild": "^2.6.8",
|
||||||
"@gitzone/tsbundle": "^2.0.6",
|
"@git.zone/tsbundle": "^2.0.8",
|
||||||
"@gitzone/tsrun": "^1.2.39",
|
"@git.zone/tsrun": "^1.2.44",
|
||||||
"@gitzone/tstest": "^1.0.72",
|
"@git.zone/tstest": "^2.3.6",
|
||||||
"@pushrocks/tapbundle": "^5.0.4",
|
"@types/node": "^20.8.7"
|
||||||
"@types/node": "^18.11.18"
|
|
||||||
},
|
},
|
||||||
"files": [
|
"files": [
|
||||||
"ts/**/*",
|
"ts/**/*",
|
||||||
@@ -58,5 +64,9 @@
|
|||||||
],
|
],
|
||||||
"browserslist": [
|
"browserslist": [
|
||||||
"last 1 chrome versions"
|
"last 1 chrome versions"
|
||||||
]
|
],
|
||||||
|
"packageManager": "pnpm@10.14.0+sha512.ad27a79641b49c3e481a16a805baa71817a04bbe06a38d17e60e2eaee83f6a146c6a688125f5792e48dd5ba30e7da52a5cda4c3992b9ccf333f9ce223af84748",
|
||||||
|
"pnpm": {
|
||||||
|
"overrides": {}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
10857
pnpm-lock.yaml
generated
10857
pnpm-lock.yaml
generated
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 @@
|
|||||||
|
|
635
readme.md
635
readme.md
@@ -1,63 +1,602 @@
|
|||||||
# @pushrocks/taskbuffer
|
# @push.rocks/taskbuffer 🚀
|
||||||
flexible task management. TypeScript ready!
|
|
||||||
|
|
||||||
## Availabililty and Links
|
> **Modern TypeScript task orchestration with smart buffering, scheduling, and real-time progress tracking**
|
||||||
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/taskbuffer)
|
|
||||||
* [gitlab.com (source)](https://gitlab.com/pushrocks/taskbuffer)
|
|
||||||
* [github.com (source mirror)](https://github.com/pushrocks/taskbuffer)
|
|
||||||
* [docs (typedoc)](https://pushrocks.gitlab.io/taskbuffer/)
|
|
||||||
|
|
||||||
## Status for master
|
[](https://www.npmjs.com/package/@push.rocks/taskbuffer)
|
||||||
|
[](https://www.typescriptlang.org/)
|
||||||
|
[](https://opensource.org/licenses/MIT)
|
||||||
|
|
||||||
Status Category | Status Badge
|
## 🌟 Features
|
||||||
-- | --
|
|
||||||
GitLab Pipelines | [](https://lossless.cloud)
|
|
||||||
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
|
||||||
npm | [](https://lossless.cloud)
|
|
||||||
Snyk | [](https://lossless.cloud)
|
|
||||||
TypeScript Support | [](https://lossless.cloud)
|
|
||||||
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
||||||
Code Style | [](https://lossless.cloud)
|
|
||||||
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
|
||||||
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
|
||||||
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
|
||||||
Platform support | [](https://lossless.cloud) [](https://lossless.cloud)
|
|
||||||
|
|
||||||
## Usage
|
- **🎯 Type-Safe Task Management** - Full TypeScript support with generics and type inference
|
||||||
|
- **📊 Real-Time Progress Tracking** - Step-based progress with percentage weights
|
||||||
|
- **⚡ Smart Buffering** - Intelligent request debouncing and batching
|
||||||
|
- **⏰ Cron Scheduling** - Schedule tasks with cron expressions
|
||||||
|
- **🔄 Task Chains & Parallel Execution** - Sequential and parallel task orchestration
|
||||||
|
- **🎨 Web Component Dashboard** - Real-time visualization of task execution
|
||||||
|
- **📈 Comprehensive Metadata** - Track execution history, duration, and status
|
||||||
|
- **🔒 Thread-Safe Operations** - Concurrency control and execution limits
|
||||||
|
- **🎭 Event-Driven Architecture** - Observable task lifecycle events
|
||||||
|
|
||||||
We highly recommend TypeScript as this module supports **TypeScript intellisense**.
|
## 📦 Installation
|
||||||
|
|
||||||
```javascript
|
```bash
|
||||||
import * as taskbuffer from "taskbuffer";
|
npm install @push.rocks/taskbuffer
|
||||||
|
# or
|
||||||
myTask = new taskbuffer.Task({
|
pnpm add @push.rocks/taskbuffer
|
||||||
preTask: someOtherTask // optional, don't worry loops are prevented
|
# or
|
||||||
afterTask: someOtherTask // optional, don't worry loops are prevented
|
yarn add @push.rocks/taskbuffer
|
||||||
name:"myTask1",
|
|
||||||
buffered: true, // optional
|
|
||||||
bufferMax: 3, // optional, call qeues greater than this are truncated
|
|
||||||
execDelay: 1000, // optional, time in ms to wait before executing task call
|
|
||||||
taskFunction:() => {
|
|
||||||
// do some stuff and return promise
|
|
||||||
// pass on any data through promise resolution
|
|
||||||
// Use TypeScript for better understanding and code completion
|
|
||||||
}
|
|
||||||
})
|
|
||||||
```
|
```
|
||||||
|
|
||||||
For further information read the linked docs at the top of this README.
|
## 🚀 Quick Start
|
||||||
|
|
||||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
### Basic Task Creation
|
||||||
|
|
||||||
[](https://push.rocks)
|
```typescript
|
||||||
|
import { Task, TaskManager } from '@push.rocks/taskbuffer';
|
||||||
|
|
||||||
## Contribution
|
// Create a simple task
|
||||||
|
const dataProcessor = new Task({
|
||||||
|
name: 'ProcessData',
|
||||||
|
taskFunction: async (data) => {
|
||||||
|
console.log(`Processing: ${data}`);
|
||||||
|
// Your async logic here
|
||||||
|
return `Processed: ${data}`;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
|
// Execute the task
|
||||||
|
const result = await dataProcessor.trigger('my-data');
|
||||||
|
console.log(result); // "Processed: my-data"
|
||||||
|
```
|
||||||
|
|
||||||
For further information read the linked docs at the top of this readme.
|
### Tasks with Progress Tracking 📊
|
||||||
|
|
||||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
```typescript
|
||||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
const deploymentTask = new Task({
|
||||||
|
name: 'DeployApplication',
|
||||||
|
steps: [
|
||||||
|
{ name: 'build', description: 'Building application', percentage: 30 },
|
||||||
|
{ name: 'test', description: 'Running tests', percentage: 20 },
|
||||||
|
{ name: 'deploy', description: 'Deploying to server', percentage: 40 },
|
||||||
|
{ name: 'verify', description: 'Verifying deployment', percentage: 10 }
|
||||||
|
] as const, // Use 'as const' for type inference
|
||||||
|
taskFunction: async function() {
|
||||||
|
// TypeScript knows these step names!
|
||||||
|
this.notifyStep('build');
|
||||||
|
await buildApplication();
|
||||||
|
|
||||||
[](https://maintainedby.lossless.com)
|
this.notifyStep('test');
|
||||||
|
await runTests();
|
||||||
|
|
||||||
|
this.notifyStep('deploy');
|
||||||
|
await deployToServer();
|
||||||
|
|
||||||
|
this.notifyStep('verify');
|
||||||
|
await verifyDeployment();
|
||||||
|
|
||||||
|
return 'Deployment successful!';
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// Monitor progress
|
||||||
|
console.log(deploymentTask.getProgress()); // 0-100
|
||||||
|
console.log(deploymentTask.getStepsMetadata()); // Detailed step info
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🎯 Core Concepts
|
||||||
|
|
||||||
|
### Task Buffering - Intelligent Request Management
|
||||||
|
|
||||||
|
TaskBuffer's buffering system prevents overwhelming your system with rapid-fire requests:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const apiTask = new Task({
|
||||||
|
name: 'APIRequest',
|
||||||
|
taskFunction: async (endpoint) => {
|
||||||
|
return await fetch(endpoint).then(r => r.json());
|
||||||
|
},
|
||||||
|
buffered: true,
|
||||||
|
bufferMax: 5, // Maximum 5 concurrent executions
|
||||||
|
execDelay: 100 // Minimum 100ms between executions
|
||||||
|
});
|
||||||
|
|
||||||
|
// Rapid fire 100 calls - only 5 will execute concurrently
|
||||||
|
for (let i = 0; i < 100; i++) {
|
||||||
|
apiTask.trigger(`/api/data/${i}`);
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Buffer Behavior:**
|
||||||
|
- First `bufferMax` calls execute immediately
|
||||||
|
- Additional calls are queued
|
||||||
|
- When buffer is full, new calls overwrite the last queued item
|
||||||
|
- Perfect for real-time data streams where only recent data matters
|
||||||
|
|
||||||
|
### Task Chains - Sequential Workflows
|
||||||
|
|
||||||
|
Build complex workflows with automatic data flow:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { Task, Taskchain } from '@push.rocks/taskbuffer';
|
||||||
|
|
||||||
|
const fetchTask = new Task({
|
||||||
|
name: 'FetchData',
|
||||||
|
taskFunction: async () => {
|
||||||
|
const response = await fetch('/api/data');
|
||||||
|
return response.json();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
const transformTask = new Task({
|
||||||
|
name: 'TransformData',
|
||||||
|
taskFunction: async (data) => {
|
||||||
|
return data.map(item => ({
|
||||||
|
...item,
|
||||||
|
transformed: true,
|
||||||
|
timestamp: Date.now()
|
||||||
|
}));
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
const saveTask = new Task({
|
||||||
|
name: 'SaveData',
|
||||||
|
taskFunction: async (transformedData) => {
|
||||||
|
await database.save(transformedData);
|
||||||
|
return transformedData.length;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// Create and execute chain
|
||||||
|
const dataChain = new Taskchain({
|
||||||
|
name: 'DataPipeline',
|
||||||
|
tasks: [fetchTask, transformTask, saveTask]
|
||||||
|
});
|
||||||
|
|
||||||
|
const savedCount = await dataChain.trigger();
|
||||||
|
console.log(`Saved ${savedCount} items`);
|
||||||
|
```
|
||||||
|
|
||||||
|
### Parallel Execution - Concurrent Processing
|
||||||
|
|
||||||
|
Execute multiple tasks simultaneously:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { TaskParallel } from '@push.rocks/taskbuffer';
|
||||||
|
|
||||||
|
const parallel = new TaskParallel({
|
||||||
|
name: 'ParallelProcessor',
|
||||||
|
tasks: [
|
||||||
|
emailTask,
|
||||||
|
smsTask,
|
||||||
|
pushNotificationTask,
|
||||||
|
webhookTask
|
||||||
|
]
|
||||||
|
});
|
||||||
|
|
||||||
|
// All tasks execute concurrently
|
||||||
|
const results = await parallel.trigger(notificationData);
|
||||||
|
// results = [emailResult, smsResult, pushResult, webhookResult]
|
||||||
|
```
|
||||||
|
|
||||||
|
### TaskManager - Centralized Orchestration
|
||||||
|
|
||||||
|
Manage all your tasks from a single point:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const taskManager = new TaskManager();
|
||||||
|
|
||||||
|
// Add tasks
|
||||||
|
taskManager.addTask(dataProcessor);
|
||||||
|
taskManager.addTask(deploymentTask);
|
||||||
|
|
||||||
|
// Schedule tasks with cron
|
||||||
|
taskManager.addAndScheduleTask(backupTask, '0 2 * * *'); // Daily at 2 AM
|
||||||
|
taskManager.addAndScheduleTask(healthCheck, '*/5 * * * *'); // Every 5 minutes
|
||||||
|
|
||||||
|
// Get task metadata
|
||||||
|
const metadata = taskManager.getTaskMetadata('DeployApplication');
|
||||||
|
console.log(metadata);
|
||||||
|
// {
|
||||||
|
// name: 'DeployApplication',
|
||||||
|
// status: 'idle' | 'running' | 'completed' | 'failed',
|
||||||
|
// steps: [...],
|
||||||
|
// currentProgress: 75,
|
||||||
|
// runCount: 12,
|
||||||
|
// lastRun: Date,
|
||||||
|
// buffered: false,
|
||||||
|
// bufferMax: undefined,
|
||||||
|
// version: '1.0.0',
|
||||||
|
// timeout: 30000
|
||||||
|
// }
|
||||||
|
|
||||||
|
// Get all scheduled tasks
|
||||||
|
const scheduled = taskManager.getScheduledTasks();
|
||||||
|
scheduled.forEach(task => {
|
||||||
|
console.log(`${task.name}: Next run at ${task.nextRun}`);
|
||||||
|
});
|
||||||
|
|
||||||
|
// Execute and remove pattern
|
||||||
|
const report = await taskManager.addExecuteRemoveTask(temporaryTask, {
|
||||||
|
trackProgress: true
|
||||||
|
});
|
||||||
|
console.log(report);
|
||||||
|
// {
|
||||||
|
// taskName: 'TempTask',
|
||||||
|
// startTime: Date,
|
||||||
|
// endTime: Date,
|
||||||
|
// duration: 1523,
|
||||||
|
// steps: [...],
|
||||||
|
// stepsCompleted: ['step1', 'step2'],
|
||||||
|
// progress: 100,
|
||||||
|
// result: any,
|
||||||
|
// error?: Error
|
||||||
|
// }
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🎨 Web Component Dashboard
|
||||||
|
|
||||||
|
Visualize your tasks in real-time with the included web component:
|
||||||
|
|
||||||
|
```html
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<script type="module">
|
||||||
|
import { TaskManager } from '@push.rocks/taskbuffer';
|
||||||
|
import '@push.rocks/taskbuffer/dist_ts_web/taskbuffer-dashboard.js';
|
||||||
|
|
||||||
|
const taskManager = new TaskManager();
|
||||||
|
|
||||||
|
// Attach to dashboard
|
||||||
|
const dashboard = document.querySelector('taskbuffer-dashboard');
|
||||||
|
dashboard.taskManager = taskManager;
|
||||||
|
dashboard.refreshInterval = 500; // Update every 500ms
|
||||||
|
</script>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<taskbuffer-dashboard></taskbuffer-dashboard>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
```
|
||||||
|
|
||||||
|
The dashboard provides:
|
||||||
|
- 📊 Real-time progress bars with step indicators
|
||||||
|
- 📈 Task execution history
|
||||||
|
- ⏰ Scheduled task information
|
||||||
|
- 🎯 Interactive task controls
|
||||||
|
- 🌓 Light/dark theme support
|
||||||
|
|
||||||
|
## 🧩 Advanced Patterns
|
||||||
|
|
||||||
|
### Dynamic Task Routing
|
||||||
|
|
||||||
|
Route tasks based on conditions:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const routerTask = new Task({
|
||||||
|
name: 'Router',
|
||||||
|
taskFunction: async (request) => {
|
||||||
|
if (request.priority === 'high') {
|
||||||
|
return await expressProcessor.trigger(request);
|
||||||
|
} else if (request.size > 1000000) {
|
||||||
|
return await bulkProcessor.trigger(request);
|
||||||
|
} else {
|
||||||
|
return await standardProcessor.trigger(request);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
### Task Pools
|
||||||
|
|
||||||
|
Create reusable task pools for load distribution:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
class TaskPool {
|
||||||
|
private tasks: Task[] = [];
|
||||||
|
private currentIndex = 0;
|
||||||
|
|
||||||
|
constructor(poolSize: number, taskConfig: any) {
|
||||||
|
for (let i = 0; i < poolSize; i++) {
|
||||||
|
this.tasks.push(new Task({
|
||||||
|
...taskConfig,
|
||||||
|
name: `${taskConfig.name}_${i}`
|
||||||
|
}));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async execute(data: any) {
|
||||||
|
const task = this.tasks[this.currentIndex];
|
||||||
|
this.currentIndex = (this.currentIndex + 1) % this.tasks.length;
|
||||||
|
return await task.trigger(data);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const processorPool = new TaskPool(5, {
|
||||||
|
name: 'DataProcessor',
|
||||||
|
taskFunction: async (data) => processData(data)
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
### Error Recovery & Retry
|
||||||
|
|
||||||
|
Implement robust error handling:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const resilientTask = new Task({
|
||||||
|
name: 'ResilientTask',
|
||||||
|
taskFunction: async (data, retryCount = 0) => {
|
||||||
|
try {
|
||||||
|
return await riskyOperation(data);
|
||||||
|
} catch (error) {
|
||||||
|
if (retryCount < 3) {
|
||||||
|
console.log(`Retry ${retryCount + 1}/3`);
|
||||||
|
await new Promise(r => setTimeout(r, 1000 * Math.pow(2, retryCount)));
|
||||||
|
return await resilientTask.trigger(data, retryCount + 1);
|
||||||
|
}
|
||||||
|
throw error;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
### Task Composition
|
||||||
|
|
||||||
|
Compose complex behaviors from simple tasks:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const compositeTask = new Task({
|
||||||
|
name: 'CompositeOperation',
|
||||||
|
steps: [
|
||||||
|
{ name: 'validate', description: 'Validating input', percentage: 20 },
|
||||||
|
{ name: 'process', description: 'Processing data', percentage: 60 },
|
||||||
|
{ name: 'notify', description: 'Sending notifications', percentage: 20 }
|
||||||
|
] as const,
|
||||||
|
taskFunction: async function(data) {
|
||||||
|
this.notifyStep('validate');
|
||||||
|
const validated = await validationTask.trigger(data);
|
||||||
|
|
||||||
|
this.notifyStep('process');
|
||||||
|
const processed = await processingTask.trigger(validated);
|
||||||
|
|
||||||
|
this.notifyStep('notify');
|
||||||
|
await notificationTask.trigger(processed);
|
||||||
|
|
||||||
|
return processed;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🔧 Configuration
|
||||||
|
|
||||||
|
### Task Options
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
interface TaskOptions<T = undefined, TSteps = []> {
|
||||||
|
name?: string; // Task identifier
|
||||||
|
taskFunction: Function; // Async function to execute
|
||||||
|
buffered?: boolean; // Enable buffering
|
||||||
|
bufferMax?: number; // Max concurrent executions
|
||||||
|
execDelay?: number; // Min delay between executions
|
||||||
|
timeout?: number; // Task timeout in ms
|
||||||
|
version?: string; // Task version
|
||||||
|
steps?: TSteps; // Progress steps configuration
|
||||||
|
taskSetup?: Function; // One-time setup function
|
||||||
|
beforeTask?: Function; // Runs before each execution
|
||||||
|
afterTask?: Function; // Runs after each execution
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### TaskManager Options
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const taskManager = new TaskManager({
|
||||||
|
maxConcurrentTasks: 10, // Global concurrency limit
|
||||||
|
defaultTimeout: 30000, // Default task timeout
|
||||||
|
logLevel: 'info' // Logging verbosity
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
## 📊 Monitoring & Observability
|
||||||
|
|
||||||
|
### Task Events
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
task.on('started', () => console.log('Task started'));
|
||||||
|
task.on('completed', (result) => console.log('Task completed:', result));
|
||||||
|
task.on('failed', (error) => console.error('Task failed:', error));
|
||||||
|
task.on('stepChange', (step) => console.log('Step:', step.name));
|
||||||
|
```
|
||||||
|
|
||||||
|
### Execution Metrics
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const metrics = task.getMetrics();
|
||||||
|
console.log({
|
||||||
|
totalRuns: metrics.runCount,
|
||||||
|
averageDuration: metrics.avgDuration,
|
||||||
|
successRate: metrics.successRate,
|
||||||
|
lastError: metrics.lastError
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🧪 Testing
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { expect, tap } from '@git.zone/tstest';
|
||||||
|
import { Task } from '@push.rocks/taskbuffer';
|
||||||
|
|
||||||
|
tap.test('Task should execute with progress tracking', async () => {
|
||||||
|
const task = new Task({
|
||||||
|
name: 'TestTask',
|
||||||
|
steps: [
|
||||||
|
{ name: 'step1', description: 'Step 1', percentage: 50 },
|
||||||
|
{ name: 'step2', description: 'Step 2', percentage: 50 }
|
||||||
|
] as const,
|
||||||
|
taskFunction: async function() {
|
||||||
|
this.notifyStep('step1');
|
||||||
|
await new Promise(r => setTimeout(r, 100));
|
||||||
|
this.notifyStep('step2');
|
||||||
|
return 'done';
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
const result = await task.trigger();
|
||||||
|
expect(result).toEqual('done');
|
||||||
|
expect(task.getProgress()).toEqual(100);
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🌐 Real-World Examples
|
||||||
|
|
||||||
|
### API Rate Limiter
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const apiLimiter = new Task({
|
||||||
|
name: 'APIRateLimiter',
|
||||||
|
buffered: true,
|
||||||
|
bufferMax: 10, // Max 10 requests per second
|
||||||
|
execDelay: 100, // 100ms between requests
|
||||||
|
taskFunction: async (endpoint, data) => {
|
||||||
|
return await fetch(endpoint, {
|
||||||
|
method: 'POST',
|
||||||
|
body: JSON.stringify(data)
|
||||||
|
});
|
||||||
|
}
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
### Database Migration Pipeline
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const migrationChain = new Taskchain({
|
||||||
|
name: 'DatabaseMigration',
|
||||||
|
tasks: [
|
||||||
|
backupDatabaseTask,
|
||||||
|
validateSchemaTask,
|
||||||
|
runMigrationsTask,
|
||||||
|
verifyIntegrityTask,
|
||||||
|
updateIndexesTask
|
||||||
|
]
|
||||||
|
});
|
||||||
|
|
||||||
|
// Execute with rollback on failure
|
||||||
|
try {
|
||||||
|
await migrationChain.trigger();
|
||||||
|
console.log('Migration successful!');
|
||||||
|
} catch (error) {
|
||||||
|
await rollbackTask.trigger();
|
||||||
|
throw error;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Distributed Job Queue
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const jobQueue = new TaskManager();
|
||||||
|
|
||||||
|
// Worker tasks
|
||||||
|
const imageProcessor = new Task({
|
||||||
|
name: 'ImageProcessor',
|
||||||
|
buffered: true,
|
||||||
|
bufferMax: 5,
|
||||||
|
steps: [
|
||||||
|
{ name: 'download', description: 'Downloading', percentage: 20 },
|
||||||
|
{ name: 'resize', description: 'Resizing', percentage: 40 },
|
||||||
|
{ name: 'optimize', description: 'Optimizing', percentage: 30 },
|
||||||
|
{ name: 'upload', description: 'Uploading', percentage: 10 }
|
||||||
|
] as const,
|
||||||
|
taskFunction: async function(job) {
|
||||||
|
this.notifyStep('download');
|
||||||
|
const image = await downloadImage(job.url);
|
||||||
|
|
||||||
|
this.notifyStep('resize');
|
||||||
|
const resized = await resizeImage(image, job.dimensions);
|
||||||
|
|
||||||
|
this.notifyStep('optimize');
|
||||||
|
const optimized = await optimizeImage(resized);
|
||||||
|
|
||||||
|
this.notifyStep('upload');
|
||||||
|
return await uploadToCDN(optimized);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
jobQueue.addTask(imageProcessor);
|
||||||
|
|
||||||
|
// Process incoming jobs
|
||||||
|
messageQueue.on('job', async (job) => {
|
||||||
|
const result = await jobQueue.getTaskByName('ImageProcessor').trigger(job);
|
||||||
|
await messageQueue.ack(job.id, result);
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🚀 Performance Tips
|
||||||
|
|
||||||
|
1. **Use Buffering Wisely** - Enable buffering for I/O-bound tasks
|
||||||
|
2. **Set Appropriate Delays** - Use `execDelay` to prevent API rate limits
|
||||||
|
3. **Leverage Task Pools** - Distribute load across multiple task instances
|
||||||
|
4. **Monitor Progress** - Use step tracking for long-running operations
|
||||||
|
5. **Clean Up** - Use `addExecuteRemoveTask` for one-time operations
|
||||||
|
|
||||||
|
## 🔍 Debugging
|
||||||
|
|
||||||
|
Enable detailed logging:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { logger } from '@push.rocks/smartlog';
|
||||||
|
|
||||||
|
logger.enableConsole();
|
||||||
|
logger.level = 'debug';
|
||||||
|
|
||||||
|
// Tasks will now output detailed execution logs
|
||||||
|
```
|
||||||
|
|
||||||
|
## 📚 API Reference
|
||||||
|
|
||||||
|
### Core Classes
|
||||||
|
|
||||||
|
- **`Task<T, TSteps>`** - Basic task unit with optional step tracking
|
||||||
|
- **`TaskManager`** - Central orchestrator for task management
|
||||||
|
- **`Taskchain`** - Sequential task executor
|
||||||
|
- **`TaskParallel`** - Concurrent task executor
|
||||||
|
- **`TaskOnce`** - Single-execution task
|
||||||
|
- **`TaskLoop`** - Repeating task with conditions
|
||||||
|
|
||||||
|
### Key Methods
|
||||||
|
|
||||||
|
#### Task Methods
|
||||||
|
- `trigger(input?: T): Promise<any>` - Execute the task
|
||||||
|
- `notifyStep(stepName: StepNames<TSteps>): void` - Update current step
|
||||||
|
- `getProgress(): number` - Get progress percentage (0-100)
|
||||||
|
- `getStepsMetadata(): ITaskStep[]` - Get detailed step information
|
||||||
|
- `getMetadata(): ITaskMetadata` - Get complete task metadata
|
||||||
|
|
||||||
|
#### TaskManager Methods
|
||||||
|
- `addTask(task: Task): void` - Register a task
|
||||||
|
- `getTaskByName(name: string): Task | undefined` - Retrieve task by name
|
||||||
|
- `addAndScheduleTask(task: Task, cronExpression: string): void` - Schedule task
|
||||||
|
- `descheduleTaskByName(name: string): void` - Remove scheduling
|
||||||
|
- `getTaskMetadata(name: string): ITaskMetadata | null` - Get task metadata
|
||||||
|
- `getAllTasksMetadata(): ITaskMetadata[]` - Get all tasks metadata
|
||||||
|
- `getScheduledTasks(): IScheduledTaskInfo[]` - List scheduled tasks
|
||||||
|
- `addExecuteRemoveTask(task, options?): Promise<ITaskExecutionReport>` - Execute once
|
||||||
|
|
||||||
|
## License and Legal Information
|
||||||
|
|
||||||
|
This 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.
|
||||||
|
|
||||||
|
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
|
||||||
|
|
||||||
|
### Trademarks
|
||||||
|
|
||||||
|
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH 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.
|
||||||
|
|
||||||
|
### Company Information
|
||||||
|
|
||||||
|
Task Venture Capital GmbH
|
||||||
|
Registered at District court Bremen HRB 35230 HB, Germany
|
||||||
|
|
||||||
|
For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
|
||||||
|
|
||||||
|
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.
|
@@ -1,23 +1,33 @@
|
|||||||
import { expect, tap } from '@pushrocks/tapbundle';
|
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||||
|
|
||||||
import * as taskbuffer from '../ts/index.js';
|
import * as taskbuffer from '../ts/index.js';
|
||||||
|
import * as smartpromise from '@push.rocks/smartpromise';
|
||||||
|
import * as smartdelay from '@push.rocks/smartdelay';
|
||||||
|
|
||||||
import * as smartpromise from '@pushrocks/smartpromise';
|
tap.test('new Task() should return a new task', async () => {
|
||||||
import * as smartdelay from '@pushrocks/smartdelay';
|
const testTask = new taskbuffer.Task({
|
||||||
|
|
||||||
// setup some testData to work with
|
|
||||||
let testTask: taskbuffer.Task;
|
|
||||||
|
|
||||||
let testPreTask = new taskbuffer.Task({
|
|
||||||
taskFunction: async () => {
|
taskFunction: async () => {
|
||||||
console.log('preTask executed');
|
console.log('executed twice');
|
||||||
},
|
},
|
||||||
preTask: testTask,
|
});
|
||||||
|
expect(testTask).toBeInstanceOf(taskbuffer.Task);
|
||||||
});
|
});
|
||||||
|
|
||||||
// some more tasks to test with
|
tap.test('should have bufferMax set to the provided value', async () => {
|
||||||
let task1Counter = 0; // how often task 1 is being executed
|
const task2 = new taskbuffer.Task({
|
||||||
let task1 = 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('should be able to trigger tasks multiple times', async () => {
|
||||||
|
let task1Counter = 0;
|
||||||
|
const task1 = new taskbuffer.Task({
|
||||||
name: 'Task 1',
|
name: 'Task 1',
|
||||||
taskFunction: () => {
|
taskFunction: () => {
|
||||||
let done = smartpromise.defer();
|
let done = smartpromise.defer();
|
||||||
@@ -29,11 +39,25 @@ let task1 = new taskbuffer.Task({
|
|||||||
}, 5000);
|
}, 5000);
|
||||||
return done.promise;
|
return done.promise;
|
||||||
},
|
},
|
||||||
|
});
|
||||||
|
await task1.trigger();
|
||||||
|
await task1.trigger();
|
||||||
|
expect(task1Counter).toEqual(2);
|
||||||
});
|
});
|
||||||
|
|
||||||
let task2 = new taskbuffer.Task({
|
tap.test('should execute setup function before the task function', async () => {
|
||||||
name: 'Task 1',
|
const task2 = new taskbuffer.Task({
|
||||||
taskFunction: async () => {
|
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();
|
const done = smartpromise.defer();
|
||||||
console.log('Task2 started');
|
console.log('Task2 started');
|
||||||
setTimeout(() => {
|
setTimeout(() => {
|
||||||
@@ -42,75 +66,26 @@ let task2 = new taskbuffer.Task({
|
|||||||
}, 5000);
|
}, 5000);
|
||||||
await done.promise;
|
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;
|
|
||||||
},
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.test('new Task() should return a new task', async () => {
|
|
||||||
testTask = new taskbuffer.Task({
|
|
||||||
taskFunction: async () => {
|
|
||||||
console.log('executed twice');
|
|
||||||
},
|
|
||||||
preTask: testPreTask,
|
|
||||||
});
|
});
|
||||||
|
await task2.trigger();
|
||||||
});
|
});
|
||||||
|
|
||||||
tap.test('expect testTask to be an instance of Task', async () => {
|
tap.test('should not exceed bufferMax when task is buffered', async () => {
|
||||||
expect(testTask).toBeInstanceOf(taskbuffer.Task);
|
let counter = 0;
|
||||||
});
|
const bufferedTask = new taskbuffer.Task({
|
||||||
|
|
||||||
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).toBeTypeofBoolean();
|
|
||||||
// tslint:disable-next-line:no-unused-expression
|
|
||||||
expect(testTask.running).toBeFalse();
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.test('testTask.trigger() should return Promise', async () => {
|
|
||||||
expect(testTask.trigger()).toBeInstanceOf(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 () => {
|
taskFunction: async () => {
|
||||||
console.log('only once');
|
counter++;
|
||||||
},
|
await smartdelay.delayFor(2000);
|
||||||
});
|
counter--;
|
||||||
await localTestTask.trigger();
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.test('expect task to run in buffered mode', async () => {
|
|
||||||
let localTestTask = new taskbuffer.Task({
|
|
||||||
taskFunction: async () => {
|
|
||||||
await smartdelay.delayFor(3000);
|
|
||||||
},
|
},
|
||||||
buffered: true,
|
buffered: true,
|
||||||
bufferMax: 2,
|
bufferMax: 2,
|
||||||
});
|
});
|
||||||
localTestTask.trigger();
|
bufferedTask.trigger();
|
||||||
localTestTask.trigger();
|
bufferedTask.trigger();
|
||||||
localTestTask.trigger();
|
bufferedTask.trigger();
|
||||||
await localTestTask.trigger();
|
await smartdelay.delayFor(100);
|
||||||
|
expect(counter <= bufferedTask.bufferMax).toBeTrue();
|
||||||
});
|
});
|
||||||
|
|
||||||
tap.start();
|
tap.start();
|
||||||
|
141
test/test.10.webcomponent.browser.ts
Normal file
141
test/test.10.webcomponent.browser.ts
Normal file
@@ -0,0 +1,141 @@
|
|||||||
|
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||||
|
import * as taskbuffer from '../ts/index.js';
|
||||||
|
|
||||||
|
// Note: Web components can't be tested directly in Node.js environment
|
||||||
|
// These tests verify the data structures that the web component will consume
|
||||||
|
|
||||||
|
// Test that TaskManager can provide data for web component
|
||||||
|
tap.test('TaskManager should provide metadata for web visualization', async () => {
|
||||||
|
const taskManager = new taskbuffer.TaskManager();
|
||||||
|
|
||||||
|
// Add a task with steps
|
||||||
|
const visualTask = new taskbuffer.Task({
|
||||||
|
name: 'VisualizationTest',
|
||||||
|
steps: [
|
||||||
|
{ name: 'load', description: 'Loading data', percentage: 30 },
|
||||||
|
{ name: 'process', description: 'Processing', percentage: 50 },
|
||||||
|
{ name: 'render', description: 'Rendering', percentage: 20 },
|
||||||
|
] as const,
|
||||||
|
taskFunction: async () => {
|
||||||
|
visualTask.notifyStep('load');
|
||||||
|
await new Promise(resolve => setTimeout(resolve, 50));
|
||||||
|
visualTask.notifyStep('process');
|
||||||
|
await new Promise(resolve => setTimeout(resolve, 50));
|
||||||
|
visualTask.notifyStep('render');
|
||||||
|
return 'Visualization complete';
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
taskManager.addTask(visualTask);
|
||||||
|
|
||||||
|
// Get metadata before execution
|
||||||
|
let metadata = taskManager.getTaskMetadata('VisualizationTest');
|
||||||
|
expect(metadata).toBeDefined();
|
||||||
|
expect(metadata!.name).toEqual('VisualizationTest');
|
||||||
|
expect(metadata!.steps).toHaveLength(3);
|
||||||
|
expect(metadata!.currentProgress).toEqual(0);
|
||||||
|
|
||||||
|
// Execute task
|
||||||
|
await visualTask.trigger();
|
||||||
|
|
||||||
|
// Get metadata after execution
|
||||||
|
metadata = taskManager.getTaskMetadata('VisualizationTest');
|
||||||
|
expect(metadata!.currentProgress).toEqual(100);
|
||||||
|
expect(metadata!.steps.every(s => s.status === 'completed')).toBeTrue();
|
||||||
|
});
|
||||||
|
|
||||||
|
// Test scheduled task metadata for web display
|
||||||
|
tap.test('Scheduled tasks should provide next run information', async () => {
|
||||||
|
const taskManager = new taskbuffer.TaskManager();
|
||||||
|
|
||||||
|
const scheduledTask = new taskbuffer.Task({
|
||||||
|
name: 'WebScheduledTask',
|
||||||
|
steps: [
|
||||||
|
{ name: 'run', description: 'Running scheduled task', percentage: 100 },
|
||||||
|
] as const,
|
||||||
|
taskFunction: async () => {
|
||||||
|
scheduledTask.notifyStep('run');
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
// Schedule task for every hour
|
||||||
|
taskManager.addAndScheduleTask(scheduledTask, '0 * * * *');
|
||||||
|
|
||||||
|
// Get scheduled tasks info
|
||||||
|
const scheduledTasks = taskManager.getScheduledTasks();
|
||||||
|
expect(scheduledTasks).toHaveLength(1);
|
||||||
|
expect(scheduledTasks[0].name).toEqual('WebScheduledTask');
|
||||||
|
expect(scheduledTasks[0].schedule).toEqual('0 * * * *');
|
||||||
|
expect(scheduledTasks[0].nextRun).toBeInstanceOf(Date);
|
||||||
|
expect(scheduledTasks[0].steps).toHaveLength(1);
|
||||||
|
|
||||||
|
// Clean up
|
||||||
|
taskManager.descheduleTaskByName('WebScheduledTask');
|
||||||
|
taskManager.stop();
|
||||||
|
});
|
||||||
|
|
||||||
|
// Test data structure compatibility
|
||||||
|
tap.test('Task metadata should be suitable for web component display', async () => {
|
||||||
|
const taskManager = new taskbuffer.TaskManager();
|
||||||
|
|
||||||
|
// Add various types of tasks
|
||||||
|
const simpleTask = new taskbuffer.Task({
|
||||||
|
name: 'SimpleWebTask',
|
||||||
|
taskFunction: async () => 'done',
|
||||||
|
});
|
||||||
|
|
||||||
|
const bufferedTask = new taskbuffer.Task({
|
||||||
|
name: 'BufferedWebTask',
|
||||||
|
buffered: true,
|
||||||
|
bufferMax: 3,
|
||||||
|
taskFunction: async () => 'buffered',
|
||||||
|
});
|
||||||
|
|
||||||
|
const steppedTask = new taskbuffer.Task({
|
||||||
|
name: 'SteppedWebTask',
|
||||||
|
steps: [
|
||||||
|
{ name: 'step1', description: 'First step', percentage: 50 },
|
||||||
|
{ name: 'step2', description: 'Second step', percentage: 50 },
|
||||||
|
] as const,
|
||||||
|
taskFunction: async () => {
|
||||||
|
steppedTask.notifyStep('step1');
|
||||||
|
steppedTask.notifyStep('step2');
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
taskManager.addTask(simpleTask);
|
||||||
|
taskManager.addTask(bufferedTask);
|
||||||
|
taskManager.addTask(steppedTask);
|
||||||
|
|
||||||
|
// Get all metadata
|
||||||
|
const allMetadata = taskManager.getAllTasksMetadata();
|
||||||
|
expect(allMetadata).toHaveLength(3);
|
||||||
|
|
||||||
|
// Verify metadata structure
|
||||||
|
allMetadata.forEach(meta => {
|
||||||
|
expect(meta.name).toBeDefined();
|
||||||
|
expect(meta.status).toBeDefined();
|
||||||
|
expect(meta.runCount).toBeDefined();
|
||||||
|
expect(meta.steps).toBeDefined();
|
||||||
|
expect(Array.isArray(meta.steps)).toBeTrue();
|
||||||
|
expect(meta.currentProgress).toBeDefined();
|
||||||
|
expect(typeof meta.currentProgress).toEqual('number');
|
||||||
|
});
|
||||||
|
|
||||||
|
// Verify buffered task metadata
|
||||||
|
const bufferedMeta = allMetadata.find(m => m.name === 'BufferedWebTask');
|
||||||
|
expect(bufferedMeta!.buffered).toBeTrue();
|
||||||
|
expect(bufferedMeta!.bufferMax).toEqual(3);
|
||||||
|
|
||||||
|
// Verify stepped task metadata
|
||||||
|
const steppedMeta = allMetadata.find(m => m.name === 'SteppedWebTask');
|
||||||
|
expect(steppedMeta!.steps).toHaveLength(2);
|
||||||
|
steppedMeta!.steps.forEach(step => {
|
||||||
|
expect(step.name).toBeDefined();
|
||||||
|
expect(step.description).toBeDefined();
|
||||||
|
expect(step.percentage).toBeDefined();
|
||||||
|
expect(step.status).toBeDefined();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
export default tap.start();
|
@@ -1,9 +1,9 @@
|
|||||||
import { expect, tap } from '@pushrocks/tapbundle';
|
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||||
|
|
||||||
import * as taskbuffer from '../ts/index.js';
|
import * as taskbuffer from '../ts/index.js';
|
||||||
|
|
||||||
import * as smartpromise from '@pushrocks/smartpromise';
|
import * as smartpromise from '@push.rocks/smartpromise';
|
||||||
import * as smartdelay from '@pushrocks/smartdelay';
|
import * as smartdelay from '@push.rocks/smartdelay';
|
||||||
|
|
||||||
let task1Executed = false;
|
let task1Executed = false;
|
||||||
const task1 = new taskbuffer.Task({
|
const task1 = new taskbuffer.Task({
|
||||||
|
@@ -1,5 +1,5 @@
|
|||||||
import { expect, tap } from '@pushrocks/tapbundle';
|
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||||
import * as smartdelay from '@pushrocks/smartdelay';
|
import * as smartdelay from '@push.rocks/smartdelay';
|
||||||
|
|
||||||
import * as taskbuffer from '../ts/index.js';
|
import * as taskbuffer from '../ts/index.js';
|
||||||
|
|
||||||
|
@@ -1,9 +1,9 @@
|
|||||||
import { expect, tap } from '@pushrocks/tapbundle';
|
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||||
|
|
||||||
import * as taskbuffer from '../ts/index.js';
|
import * as taskbuffer from '../ts/index.js';
|
||||||
|
|
||||||
import * as smartpromise from '@pushrocks/smartpromise';
|
import * as smartpromise from '@push.rocks/smartpromise';
|
||||||
import * as smartdelay from '@pushrocks/smartdelay';
|
import * as smartdelay from '@push.rocks/smartdelay';
|
||||||
|
|
||||||
let myTaskManager: taskbuffer.TaskManager;
|
let myTaskManager: taskbuffer.TaskManager;
|
||||||
let taskRunCounter = 0;
|
let taskRunCounter = 0;
|
||||||
@@ -29,7 +29,7 @@ tap.test('should run the task as expected', async () => {
|
|||||||
taskDone.resolve();
|
taskDone.resolve();
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
})
|
}),
|
||||||
);
|
);
|
||||||
myTaskManager.start();
|
myTaskManager.start();
|
||||||
await myTaskManager.triggerTaskByName('myTask');
|
await myTaskManager.triggerTaskByName('myTask');
|
@@ -1,9 +1,9 @@
|
|||||||
import { expect, tap } from '@pushrocks/tapbundle';
|
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||||
|
|
||||||
import * as taskbuffer from '../ts/index.js';
|
import * as taskbuffer from '../ts/index.js';
|
||||||
|
|
||||||
import * as smartpromise from '@pushrocks/smartpromise';
|
import * as smartpromise from '@push.rocks/smartpromise';
|
||||||
import * as smartdelay from '@pushrocks/smartdelay';
|
import * as smartdelay from '@push.rocks/smartdelay';
|
||||||
|
|
||||||
const flowTask1 = new taskbuffer.Task({
|
const flowTask1 = new taskbuffer.Task({
|
||||||
taskFunction: (x: number) => {
|
taskFunction: (x: number) => {
|
||||||
|
@@ -1,4 +1,4 @@
|
|||||||
import { expect, tap } from '@pushrocks/tapbundle';
|
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||||
|
|
||||||
import * as taskbuffer from '../ts/index.js';
|
import * as taskbuffer from '../ts/index.js';
|
||||||
|
|
||||||
|
@@ -1,4 +1,4 @@
|
|||||||
import { tap, expect } from '@pushrocks/tapbundle';
|
import { tap, expect } from '@git.zone/tstest/tapbundle';
|
||||||
|
|
||||||
import * as taskbuffer from '../ts/index.js';
|
import * as taskbuffer from '../ts/index.js';
|
||||||
|
|
||||||
|
@@ -1,4 +1,4 @@
|
|||||||
import { tap, expect } from '@pushrocks/tapbundle';
|
import { tap, expect } from '@git.zone/tstest/tapbundle';
|
||||||
|
|
||||||
import * as taskbuffer from '../ts/index.js';
|
import * as taskbuffer from '../ts/index.js';
|
||||||
|
|
||||||
|
376
test/test.9.steps.ts
Normal file
376
test/test.9.steps.ts
Normal file
@@ -0,0 +1,376 @@
|
|||||||
|
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||||
|
import * as taskbuffer from '../ts/index.js';
|
||||||
|
import * as smartdelay from '@push.rocks/smartdelay';
|
||||||
|
|
||||||
|
// Test TaskStep class
|
||||||
|
tap.test('TaskStep should create and manage step state', async () => {
|
||||||
|
const step = new taskbuffer.TaskStep({
|
||||||
|
name: 'testStep',
|
||||||
|
description: 'Test step description',
|
||||||
|
percentage: 25,
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(step.name).toEqual('testStep');
|
||||||
|
expect(step.description).toEqual('Test step description');
|
||||||
|
expect(step.percentage).toEqual(25);
|
||||||
|
expect(step.status).toEqual('pending');
|
||||||
|
|
||||||
|
// Test start
|
||||||
|
step.start();
|
||||||
|
expect(step.status).toEqual('active');
|
||||||
|
expect(step.startTime).toBeDefined();
|
||||||
|
|
||||||
|
await smartdelay.delayFor(100);
|
||||||
|
|
||||||
|
// Test complete
|
||||||
|
step.complete();
|
||||||
|
expect(step.status).toEqual('completed');
|
||||||
|
expect(step.endTime).toBeDefined();
|
||||||
|
expect(step.duration).toBeDefined();
|
||||||
|
expect(step.duration).toBeGreaterThanOrEqual(100);
|
||||||
|
|
||||||
|
// Test reset
|
||||||
|
step.reset();
|
||||||
|
expect(step.status).toEqual('pending');
|
||||||
|
expect(step.startTime).toBeUndefined();
|
||||||
|
expect(step.endTime).toBeUndefined();
|
||||||
|
expect(step.duration).toBeUndefined();
|
||||||
|
});
|
||||||
|
|
||||||
|
// Test Task with steps
|
||||||
|
tap.test('Task should support typed step notifications', async () => {
|
||||||
|
const stepsExecuted: string[] = [];
|
||||||
|
|
||||||
|
const task = new taskbuffer.Task({
|
||||||
|
name: 'SteppedTask',
|
||||||
|
steps: [
|
||||||
|
{ name: 'init', description: 'Initialize', percentage: 20 },
|
||||||
|
{ name: 'process', description: 'Process data', percentage: 50 },
|
||||||
|
{ name: 'cleanup', description: 'Clean up', percentage: 30 },
|
||||||
|
] as const,
|
||||||
|
taskFunction: async () => {
|
||||||
|
task.notifyStep('init');
|
||||||
|
stepsExecuted.push('init');
|
||||||
|
await smartdelay.delayFor(50);
|
||||||
|
|
||||||
|
task.notifyStep('process');
|
||||||
|
stepsExecuted.push('process');
|
||||||
|
await smartdelay.delayFor(100);
|
||||||
|
|
||||||
|
task.notifyStep('cleanup');
|
||||||
|
stepsExecuted.push('cleanup');
|
||||||
|
await smartdelay.delayFor(50);
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
await task.trigger();
|
||||||
|
|
||||||
|
expect(stepsExecuted).toEqual(['init', 'process', 'cleanup']);
|
||||||
|
expect(task.getProgress()).toEqual(100);
|
||||||
|
|
||||||
|
const metadata = task.getStepsMetadata();
|
||||||
|
expect(metadata).toHaveLength(3);
|
||||||
|
expect(metadata[0].status).toEqual('completed');
|
||||||
|
expect(metadata[1].status).toEqual('completed');
|
||||||
|
expect(metadata[2].status).toEqual('completed');
|
||||||
|
});
|
||||||
|
|
||||||
|
// Test progress calculation
|
||||||
|
tap.test('Task should calculate progress correctly', async () => {
|
||||||
|
const progressValues: number[] = [];
|
||||||
|
|
||||||
|
const task = new taskbuffer.Task({
|
||||||
|
name: 'ProgressTask',
|
||||||
|
steps: [
|
||||||
|
{ name: 'step1', description: 'Step 1', percentage: 25 },
|
||||||
|
{ name: 'step2', description: 'Step 2', percentage: 25 },
|
||||||
|
{ name: 'step3', description: 'Step 3', percentage: 50 },
|
||||||
|
] as const,
|
||||||
|
taskFunction: async () => {
|
||||||
|
task.notifyStep('step1');
|
||||||
|
progressValues.push(task.getProgress());
|
||||||
|
|
||||||
|
task.notifyStep('step2');
|
||||||
|
progressValues.push(task.getProgress());
|
||||||
|
|
||||||
|
task.notifyStep('step3');
|
||||||
|
progressValues.push(task.getProgress());
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
await task.trigger();
|
||||||
|
|
||||||
|
// During execution, active steps count as 50% complete
|
||||||
|
expect(progressValues[0]).toBeLessThanOrEqual(25); // step1 active (12.5%)
|
||||||
|
expect(progressValues[1]).toBeLessThanOrEqual(50); // step1 done (25%) + step2 active (12.5%)
|
||||||
|
expect(progressValues[2]).toBeLessThanOrEqual(100); // step1+2 done (50%) + step3 active (25%)
|
||||||
|
|
||||||
|
// After completion, all steps should be done
|
||||||
|
expect(task.getProgress()).toEqual(100);
|
||||||
|
});
|
||||||
|
|
||||||
|
// Test task metadata
|
||||||
|
tap.test('Task should provide complete metadata', async () => {
|
||||||
|
const task = new taskbuffer.Task({
|
||||||
|
name: 'MetadataTask',
|
||||||
|
buffered: true,
|
||||||
|
bufferMax: 5,
|
||||||
|
steps: [
|
||||||
|
{ name: 'step1', description: 'First step', percentage: 50 },
|
||||||
|
{ name: 'step2', description: 'Second step', percentage: 50 },
|
||||||
|
] as const,
|
||||||
|
taskFunction: async () => {
|
||||||
|
task.notifyStep('step1');
|
||||||
|
await smartdelay.delayFor(50);
|
||||||
|
task.notifyStep('step2');
|
||||||
|
await smartdelay.delayFor(50);
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
// Set version and timeout directly (as they're public properties)
|
||||||
|
task.version = '1.0.0';
|
||||||
|
task.timeout = 10000;
|
||||||
|
|
||||||
|
// Get metadata before execution
|
||||||
|
let metadata = task.getMetadata();
|
||||||
|
expect(metadata.name).toEqual('MetadataTask');
|
||||||
|
expect(metadata.version).toEqual('1.0.0');
|
||||||
|
expect(metadata.status).toEqual('idle');
|
||||||
|
expect(metadata.buffered).toEqual(true);
|
||||||
|
expect(metadata.bufferMax).toEqual(5);
|
||||||
|
expect(metadata.timeout).toEqual(10000);
|
||||||
|
expect(metadata.runCount).toEqual(0);
|
||||||
|
expect(metadata.steps).toHaveLength(2);
|
||||||
|
|
||||||
|
// Execute task
|
||||||
|
await task.trigger();
|
||||||
|
|
||||||
|
// Get metadata after execution
|
||||||
|
metadata = task.getMetadata();
|
||||||
|
expect(metadata.status).toEqual('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,4 +1,4 @@
|
|||||||
import { tap, expect } from '@pushrocks/tapbundle';
|
import { tap, expect } from '@git.zone/tstest/tapbundle';
|
||||||
|
|
||||||
import * as taskbuffer from '../ts/index.js';
|
import * as taskbuffer from '../ts/index.js';
|
||||||
|
|
||||||
@@ -16,7 +16,7 @@ tap.test('should execute task when its scheduled', async (tools) => {
|
|||||||
taskFunction: async () => {
|
taskFunction: async () => {
|
||||||
console.log('hi');
|
console.log('hi');
|
||||||
},
|
},
|
||||||
})
|
}),
|
||||||
);
|
);
|
||||||
|
|
||||||
testTaskRunner.addTask(
|
testTaskRunner.addTask(
|
||||||
@@ -25,7 +25,7 @@ tap.test('should execute task when its scheduled', async (tools) => {
|
|||||||
console.log('there');
|
console.log('there');
|
||||||
done.resolve();
|
done.resolve();
|
||||||
},
|
},
|
||||||
})
|
}),
|
||||||
);
|
);
|
||||||
|
|
||||||
await done.promise;
|
await done.promise;
|
||||||
|
@@ -1,8 +1,8 @@
|
|||||||
/**
|
/**
|
||||||
* autocreated commitinfo by @pushrocks/commitinfo
|
* autocreated commitinfo by @push.rocks/commitinfo
|
||||||
*/
|
*/
|
||||||
export const commitinfo = {
|
export const commitinfo = {
|
||||||
name: '@pushrocks/taskbuffer',
|
name: '@push.rocks/taskbuffer',
|
||||||
version: '3.0.9',
|
version: '3.4.0',
|
||||||
description: 'flexible task management. TypeScript ready!'
|
description: 'A flexible task management library supporting TypeScript, allowing for task buffering, scheduling, and execution with dependency management.'
|
||||||
}
|
}
|
||||||
|
14
ts/index.ts
14
ts/index.ts
@@ -1,12 +1,18 @@
|
|||||||
export { Task } from './taskbuffer.classes.task.js';
|
export { Task } from './taskbuffer.classes.task.js';
|
||||||
export type { ITaskFunction } from './taskbuffer.classes.task.js'
|
export type { ITaskFunction, StepNames } from './taskbuffer.classes.task.js';
|
||||||
export { Taskchain } from './taskbuffer.classes.taskchain.js';
|
export { Taskchain } from './taskbuffer.classes.taskchain.js';
|
||||||
export { Taskparallel } from './taskbuffer.classes.taskparallel.js';
|
export { Taskparallel } from './taskbuffer.classes.taskparallel.js';
|
||||||
export { TaskManager } from './taskbuffer.classes.taskmanager.js';
|
export { TaskManager } from './taskbuffer.classes.taskmanager.js';
|
||||||
export { TaskOnce } from './taskbuffer.classes.taskonce.js';
|
export { TaskOnce } from './taskbuffer.classes.taskonce.js';
|
||||||
export { TaskRunner } from './taskbuffer.classes.taskrunner.js';
|
export { TaskRunner } from './taskbuffer.classes.taskrunner.js';
|
||||||
export { TaskDebounced } from './taskbuffer.classes.taskdebounced.js';
|
export { TaskDebounced } from './taskbuffer.classes.taskdebounced.js';
|
||||||
|
|
||||||
|
// Task step system
|
||||||
|
export { TaskStep } from './taskbuffer.classes.taskstep.js';
|
||||||
|
export type { ITaskStep } from './taskbuffer.classes.taskstep.js';
|
||||||
|
|
||||||
|
// Metadata interfaces
|
||||||
|
export type { ITaskMetadata, ITaskExecutionReport, IScheduledTaskInfo } from './taskbuffer.interfaces.js';
|
||||||
|
|
||||||
import * as distributedCoordination from './taskbuffer.classes.distributedcoordinator.js';
|
import * as distributedCoordination from './taskbuffer.classes.distributedcoordinator.js';
|
||||||
export {
|
export { distributedCoordination };
|
||||||
distributedCoordination
|
|
||||||
}
|
|
||||||
|
@@ -2,9 +2,10 @@ import { Task } from './taskbuffer.classes.task.js';
|
|||||||
|
|
||||||
export class BufferRunner {
|
export class BufferRunner {
|
||||||
public task: Task;
|
public task: Task;
|
||||||
// initialze by default
|
// initialize by default
|
||||||
public bufferCounter: number = 0;
|
public bufferCounter: number = 0;
|
||||||
constructor(taskArg: Task) {
|
|
||||||
|
constructor(taskArg: Task<any>) {
|
||||||
this.task = taskArg;
|
this.task = taskArg;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -12,28 +13,21 @@ export class BufferRunner {
|
|||||||
if (!(this.bufferCounter >= this.task.bufferMax)) {
|
if (!(this.bufferCounter >= this.task.bufferMax)) {
|
||||||
this.bufferCounter++;
|
this.bufferCounter++;
|
||||||
}
|
}
|
||||||
const returnPromise: Promise<any> = this.task.cycleCounter.getPromiseForCycle(
|
const returnPromise: Promise<any> =
|
||||||
this.bufferCounter + 1
|
this.task.cycleCounter.getPromiseForCycle(this.bufferCounter);
|
||||||
);
|
|
||||||
if (!this.task.running) {
|
if (!this.task.running) {
|
||||||
this._run(x);
|
this._run(x);
|
||||||
}
|
}
|
||||||
return returnPromise;
|
return returnPromise;
|
||||||
}
|
}
|
||||||
|
|
||||||
private _run(x: any) {
|
private async _run(x: any) {
|
||||||
const recursiveBufferRunner = (x: any) => {
|
|
||||||
if (this.bufferCounter >= 0) {
|
|
||||||
this.task.running = true;
|
this.task.running = true;
|
||||||
Task.runTask(this.task, { x: x }).then((x) => {
|
while (this.bufferCounter > 0) {
|
||||||
this.bufferCounter--; // this.bufferCounter drops below 0, the recursion stops.
|
const result = await Task.runTask(this.task, { x: x });
|
||||||
this.task.cycleCounter.informOfCycle(x);
|
this.bufferCounter--;
|
||||||
recursiveBufferRunner(x);
|
this.task.cycleCounter.informOfCycle(result);
|
||||||
});
|
}
|
||||||
} else {
|
|
||||||
this.task.running = false;
|
this.task.running = false;
|
||||||
}
|
}
|
||||||
};
|
|
||||||
recursiveBufferRunner(x);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
@@ -9,7 +9,7 @@ export interface ICycleObject {
|
|||||||
export class CycleCounter {
|
export class CycleCounter {
|
||||||
public task: Task;
|
public task: Task;
|
||||||
public cycleObjectArray: ICycleObject[] = [];
|
public cycleObjectArray: ICycleObject[] = [];
|
||||||
constructor(taskArg: Task) {
|
constructor(taskArg: Task<any>) {
|
||||||
this.task = taskArg;
|
this.task = taskArg;
|
||||||
}
|
}
|
||||||
public getPromiseForCycle(cycleCountArg: number) {
|
public getPromiseForCycle(cycleCountArg: number) {
|
||||||
|
@@ -2,13 +2,11 @@ import { Task } from './taskbuffer.classes.task.js';
|
|||||||
import * as plugins from './taskbuffer.plugins.js';
|
import * as plugins from './taskbuffer.plugins.js';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* constains all data for the final coordinator to actually make an informed decision
|
* Contains all data for the final coordinator to make an informed decision.
|
||||||
*/
|
*/
|
||||||
export interface IDistributedTaskRequest {
|
export interface IDistributedTaskRequest {
|
||||||
/**
|
submitterId: string;
|
||||||
* this needs to correlate to the consultationResult
|
requestResponseId: string;
|
||||||
*/
|
|
||||||
submitterRandomId: string;
|
|
||||||
taskName: string;
|
taskName: string;
|
||||||
taskVersion: string;
|
taskVersion: string;
|
||||||
taskExecutionTime: number;
|
taskExecutionTime: number;
|
||||||
@@ -17,18 +15,24 @@ export interface IDistributedTaskRequest {
|
|||||||
status: 'requesting' | 'gotRejected' | 'failed' | 'succeeded';
|
status: 'requesting' | 'gotRejected' | 'failed' | 'succeeded';
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface IDsitributedTaskRequestResult {
|
export interface IDistributedTaskRequestResult {
|
||||||
/**
|
submitterId: string;
|
||||||
* this needs to correlate to the decisionInfoBasis
|
requestResponseId: string;
|
||||||
*/
|
|
||||||
submitterRandomId: string;
|
|
||||||
considered: boolean;
|
considered: boolean;
|
||||||
rank: string;
|
rank: number;
|
||||||
reason: string;
|
reason: string;
|
||||||
shouldTrigger: boolean;
|
shouldTrigger: boolean;
|
||||||
}
|
}
|
||||||
|
|
||||||
export abstract class AbstractDistributedCoordinator {
|
export abstract class AbstractDistributedCoordinator {
|
||||||
public abstract fireDistributedTaskRequest(infoBasisArg: IDistributedTaskRequest): Promise<IDsitributedTaskRequestResult>
|
public abstract fireDistributedTaskRequest(
|
||||||
public abstract updateDistributedTaskRequest(infoBasisArg: IDistributedTaskRequest): Promise<void>
|
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.js';
|
import * as plugins from './taskbuffer.plugins.js';
|
||||||
import { BufferRunner } from './taskbuffer.classes.bufferrunner.js';
|
import { BufferRunner } from './taskbuffer.classes.bufferrunner.js';
|
||||||
import { CycleCounter } from './taskbuffer.classes.cyclecounter.js';
|
import { CycleCounter } from './taskbuffer.classes.cyclecounter.js';
|
||||||
|
import { TaskStep, type ITaskStep } from './taskbuffer.classes.taskstep.js';
|
||||||
|
import type { ITaskMetadata } from './taskbuffer.interfaces.js';
|
||||||
|
|
||||||
import { logger } from './taskbuffer.logging.js';
|
import { logger } from './taskbuffer.logging.js';
|
||||||
|
|
||||||
export interface ITaskFunction {
|
export interface ITaskFunction<T = undefined> {
|
||||||
(x?: any): PromiseLike<any>;
|
(x?: any, setupValue?: T): PromiseLike<any>;
|
||||||
}
|
}
|
||||||
|
|
||||||
export type TPreOrAfterTaskFunction = () => Task;
|
export interface ITaskSetupFunction<T = undefined> {
|
||||||
|
(): Promise<T>;
|
||||||
|
}
|
||||||
|
|
||||||
export class Task {
|
export type TPreOrAfterTaskFunction = () => Task<any>;
|
||||||
// STATIC
|
|
||||||
public static extractTask(preOrAfterTaskArg: Task | TPreOrAfterTaskFunction): Task {
|
// 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) {
|
switch (true) {
|
||||||
case !preOrAfterTaskArg:
|
case !preOrAfterTaskArg:
|
||||||
return null;
|
return null;
|
||||||
case preOrAfterTaskArg instanceof Task:
|
case preOrAfterTaskArg instanceof Task:
|
||||||
return preOrAfterTaskArg as Task;
|
return preOrAfterTaskArg as Task<T, TSteps>;
|
||||||
case typeof preOrAfterTaskArg === 'function':
|
case typeof preOrAfterTaskArg === 'function':
|
||||||
const taskFunction = preOrAfterTaskArg as TPreOrAfterTaskFunction;
|
const taskFunction = preOrAfterTaskArg as TPreOrAfterTaskFunction;
|
||||||
return taskFunction();
|
return taskFunction() as unknown as Task<T, TSteps>;
|
||||||
default:
|
default:
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
@@ -32,7 +42,7 @@ export class Task {
|
|||||||
return done.promise;
|
return done.promise;
|
||||||
};
|
};
|
||||||
|
|
||||||
public static isTask = (taskArg: Task): boolean => {
|
public static isTask = (taskArg: Task<any>): boolean => {
|
||||||
if (taskArg instanceof Task && typeof taskArg.taskFunction === 'function') {
|
if (taskArg instanceof Task && typeof taskArg.taskFunction === 'function') {
|
||||||
return true;
|
return true;
|
||||||
} else {
|
} else {
|
||||||
@@ -40,10 +50,10 @@ export class Task {
|
|||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
public static isTaskTouched = (
|
public static isTaskTouched<T = undefined, TSteps extends ReadonlyArray<{ name: string; description: string; percentage: number }> = []>(
|
||||||
taskArg: Task | TPreOrAfterTaskFunction,
|
taskArg: Task<T, TSteps> | TPreOrAfterTaskFunction,
|
||||||
touchedTasksArray: Task[]
|
touchedTasksArray: Task<T, TSteps>[],
|
||||||
): boolean => {
|
): boolean {
|
||||||
const taskToCheck = Task.extractTask(taskArg);
|
const taskToCheck = Task.extractTask(taskArg);
|
||||||
let result = false;
|
let result = false;
|
||||||
for (const keyArg in touchedTasksArray) {
|
for (const keyArg in touchedTasksArray) {
|
||||||
@@ -52,45 +62,66 @@ export class Task {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
return result;
|
return result;
|
||||||
};
|
}
|
||||||
|
|
||||||
public static runTask = async (
|
public static runTask = async <T, TSteps extends ReadonlyArray<{ name: string; description: string; percentage: number }> = []>(
|
||||||
taskArg: Task | TPreOrAfterTaskFunction,
|
taskArg: Task<T, TSteps> | TPreOrAfterTaskFunction,
|
||||||
optionsArg: { x?: any; touchedTasksArray?: Task[] }
|
optionsArg: { x?: any; touchedTasksArray?: Task<T, TSteps>[] },
|
||||||
) => {
|
) => {
|
||||||
// extracts the task in case it is specified as a return value of a function
|
|
||||||
const taskToRun = Task.extractTask(taskArg);
|
const taskToRun = Task.extractTask(taskArg);
|
||||||
const done = plugins.smartpromise.defer();
|
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) {
|
if (taskToRun.execDelay) {
|
||||||
await plugins.smartdelay.delayFor(taskToRun.execDelay);
|
await plugins.smartdelay.delayFor(taskToRun.execDelay);
|
||||||
}
|
}
|
||||||
|
|
||||||
// set running params
|
|
||||||
taskToRun.running = true;
|
taskToRun.running = true;
|
||||||
|
taskToRun.runCount++;
|
||||||
|
taskToRun.lastRun = new Date();
|
||||||
|
|
||||||
|
// Reset steps at the beginning of task execution
|
||||||
|
taskToRun.resetSteps();
|
||||||
|
|
||||||
done.promise.then(async () => {
|
done.promise.then(async () => {
|
||||||
taskToRun.running = false;
|
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 = {
|
const options = {
|
||||||
...{ x: undefined, touchedTasksArray: [] },
|
...{ x: undefined, touchedTasksArray: [] },
|
||||||
...optionsArg,
|
...optionsArg,
|
||||||
};
|
};
|
||||||
const x = options.x;
|
const x = options.x;
|
||||||
const touchedTasksArray: Task[] = options.touchedTasksArray;
|
const touchedTasksArray: Task<T, TSteps>[] = options.touchedTasksArray;
|
||||||
|
|
||||||
touchedTasksArray.push(taskToRun);
|
touchedTasksArray.push(taskToRun);
|
||||||
|
|
||||||
// run the task cascade
|
|
||||||
const localDeferred = plugins.smartpromise.defer();
|
const localDeferred = plugins.smartpromise.defer();
|
||||||
localDeferred.promise
|
localDeferred.promise
|
||||||
.then(() => {
|
.then(() => {
|
||||||
// lets run any preTask
|
if (
|
||||||
|
taskToRun.preTask &&
|
||||||
if (taskToRun.preTask && !Task.isTaskTouched(taskToRun.preTask, touchedTasksArray)) {
|
!Task.isTaskTouched(taskToRun.preTask, touchedTasksArray)
|
||||||
|
) {
|
||||||
return Task.runTask(taskToRun.preTask, { x, touchedTasksArray });
|
return Task.runTask(taskToRun.preTask, { x, touchedTasksArray });
|
||||||
} else {
|
} else {
|
||||||
const done2 = plugins.smartpromise.defer();
|
const done2 = plugins.smartpromise.defer();
|
||||||
@@ -99,16 +130,21 @@ export class Task {
|
|||||||
}
|
}
|
||||||
})
|
})
|
||||||
.then(async (x) => {
|
.then(async (x) => {
|
||||||
// lets run the main task
|
|
||||||
try {
|
try {
|
||||||
return await taskToRun.taskFunction(x);
|
return await taskToRun.taskFunction(x, taskToRun.setupValue);
|
||||||
} catch (e) {
|
} catch (e) {
|
||||||
console.log(e);
|
console.log(e);
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
.then((x) => {
|
.then((x) => {
|
||||||
if (taskToRun.afterTask && !Task.isTaskTouched(taskToRun.afterTask, touchedTasksArray)) {
|
if (
|
||||||
return Task.runTask(taskToRun.afterTask, { x: x, touchedTasksArray: touchedTasksArray });
|
taskToRun.afterTask &&
|
||||||
|
!Task.isTaskTouched(taskToRun.afterTask, touchedTasksArray)
|
||||||
|
) {
|
||||||
|
return Task.runTask(taskToRun.afterTask, {
|
||||||
|
x: x,
|
||||||
|
touchedTasksArray: touchedTasksArray,
|
||||||
|
});
|
||||||
} else {
|
} else {
|
||||||
const done2 = plugins.smartpromise.defer();
|
const done2 = plugins.smartpromise.defer();
|
||||||
done2.resolve(x);
|
done2.resolve(x);
|
||||||
@@ -125,16 +161,9 @@ export class Task {
|
|||||||
return await done.promise;
|
return await done.promise;
|
||||||
};
|
};
|
||||||
|
|
||||||
// INSTANCE
|
|
||||||
// mandatory properties
|
|
||||||
public name: string;
|
public name: string;
|
||||||
/**
|
|
||||||
* the version of the task
|
|
||||||
* should follow semver
|
|
||||||
* might be important for DistributedCoordinator
|
|
||||||
*/
|
|
||||||
public version: string;
|
public version: string;
|
||||||
public taskFunction: ITaskFunction;
|
public taskFunction: ITaskFunction<T>;
|
||||||
public buffered: boolean;
|
public buffered: boolean;
|
||||||
public cronJob: plugins.smarttime.CronJob;
|
public cronJob: plugins.smarttime.CronJob;
|
||||||
|
|
||||||
@@ -142,62 +171,74 @@ export class Task {
|
|||||||
public execDelay: number;
|
public execDelay: number;
|
||||||
public timeout: number;
|
public timeout: number;
|
||||||
|
|
||||||
// tasks to run before and after
|
public preTask: Task<T, any> | TPreOrAfterTaskFunction;
|
||||||
public preTask: Task | TPreOrAfterTaskFunction;
|
public afterTask: Task<T, any> | TPreOrAfterTaskFunction;
|
||||||
public afterTask: Task | 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 running: boolean = false;
|
||||||
public bufferRunner = new BufferRunner(this);
|
public bufferRunner = new BufferRunner(this);
|
||||||
public cycleCounter = new CycleCounter(this);
|
public cycleCounter = new CycleCounter(this);
|
||||||
|
public lastRun?: Date;
|
||||||
|
public runCount: number = 0;
|
||||||
|
|
||||||
public idle: boolean = true;
|
public get idle() {
|
||||||
private _state: string = 'ready';
|
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: {
|
constructor(optionsArg: {
|
||||||
/**
|
taskFunction: ITaskFunction<T>;
|
||||||
* the task function to run, must return promise
|
preTask?: Task<T, any> | TPreOrAfterTaskFunction;
|
||||||
*/
|
afterTask?: Task<T, any> | TPreOrAfterTaskFunction;
|
||||||
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
|
|
||||||
*/
|
|
||||||
buffered?: boolean;
|
buffered?: boolean;
|
||||||
/**
|
|
||||||
* the maximum buffer
|
|
||||||
*/
|
|
||||||
bufferMax?: number;
|
bufferMax?: number;
|
||||||
/**
|
|
||||||
* the execution delay, before the task is executed
|
|
||||||
* only makes sense when running in buffered mode
|
|
||||||
*/
|
|
||||||
execDelay?: number;
|
execDelay?: number;
|
||||||
/**
|
|
||||||
* the name of the task
|
|
||||||
*/
|
|
||||||
name?: string;
|
name?: string;
|
||||||
|
taskSetup?: ITaskSetupFunction<T>;
|
||||||
|
steps?: TSteps;
|
||||||
}) {
|
}) {
|
||||||
this.taskFunction = optionsArg.taskFunction;
|
this.taskFunction = optionsArg.taskFunction;
|
||||||
this.preTask = optionsArg.preTask;
|
this.preTask = optionsArg.preTask;
|
||||||
this.afterTask = optionsArg.afterTask;
|
this.afterTask = optionsArg.afterTask;
|
||||||
this.idle = !this.running;
|
|
||||||
this.buffered = optionsArg.buffered;
|
this.buffered = optionsArg.buffered;
|
||||||
this.bufferMax = optionsArg.bufferMax;
|
this.bufferMax = optionsArg.bufferMax;
|
||||||
this.execDelay = optionsArg.execDelay;
|
this.execDelay = optionsArg.execDelay;
|
||||||
this.name = optionsArg.name;
|
this.name = optionsArg.name;
|
||||||
|
this.taskSetup = optionsArg.taskSetup;
|
||||||
|
|
||||||
|
// 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?: any): Promise<any> {
|
public trigger(x?: any): Promise<any> {
|
||||||
if (this.buffered) {
|
if (this.buffered) {
|
||||||
return this.triggerBuffered(x);
|
return this.triggerBuffered(x);
|
||||||
@@ -206,31 +247,103 @@ export class Task {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* trigger task unbuffered.
|
|
||||||
* will actually run the task, not considering any buffered limits.
|
|
||||||
*/
|
|
||||||
public triggerUnBuffered(x?: any): Promise<any> {
|
public triggerUnBuffered(x?: any): Promise<any> {
|
||||||
return Task.runTask(this, { x: x });
|
return Task.runTask<T, TSteps>(this, { x: x });
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* trigger task buffered.
|
|
||||||
* note: .trigger() also calls this function
|
|
||||||
*/
|
|
||||||
public triggerBuffered(x?: any): Promise<any> {
|
public triggerBuffered(x?: any): Promise<any> {
|
||||||
return this.bufferRunner.trigger(x);
|
return this.bufferRunner.trigger(x);
|
||||||
}
|
}
|
||||||
|
|
||||||
get state(): string {
|
// Step notification method with typed step names
|
||||||
return this._state;
|
public notifyStep(stepName: StepNames<TSteps>): void {
|
||||||
|
// Complete previous step if exists
|
||||||
|
if (this.currentStepName) {
|
||||||
|
const prevStep = this.steps.get(this.currentStepName);
|
||||||
|
if (prevStep && prevStep.status === 'active') {
|
||||||
|
prevStep.complete();
|
||||||
|
this.stepProgress.set(this.currentStepName, prevStep.percentage);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
set state(stateArg: string) {
|
// Start new step
|
||||||
if (stateArg === 'locked') {
|
const step = this.steps.get(stepName as string);
|
||||||
this._state = 'locked';
|
if (step) {
|
||||||
} else {
|
step.start();
|
||||||
logger.log('error', `state type ${stateArg} could not be set`);
|
this.currentStepName = stepName as string;
|
||||||
|
|
||||||
|
// 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';
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
@@ -27,14 +27,18 @@ export class Taskchain extends Task {
|
|||||||
let taskCounter = 0; // counter for iterating async over the taskArray
|
let taskCounter = 0; // counter for iterating async over the taskArray
|
||||||
const iterateTasks = (x: any) => {
|
const iterateTasks = (x: any) => {
|
||||||
if (typeof this.taskArray[taskCounter] !== 'undefined') {
|
if (typeof this.taskArray[taskCounter] !== 'undefined') {
|
||||||
console.log(this.name + ' running: Task' + this.taskArray[taskCounter].name);
|
console.log(
|
||||||
|
this.name + ' running: Task' + this.taskArray[taskCounter].name,
|
||||||
|
);
|
||||||
this.taskArray[taskCounter].trigger(x).then((x) => {
|
this.taskArray[taskCounter].trigger(x).then((x) => {
|
||||||
logger.log('info', this.taskArray[taskCounter].name);
|
logger.log('info', this.taskArray[taskCounter].name);
|
||||||
taskCounter++;
|
taskCounter++;
|
||||||
iterateTasks(x);
|
iterateTasks(x);
|
||||||
});
|
});
|
||||||
} else {
|
} else {
|
||||||
console.log('Taskchain "' + this.name + '" completed successfully');
|
console.log(
|
||||||
|
'Taskchain "' + this.name + '" completed successfully',
|
||||||
|
);
|
||||||
done.resolve(x);
|
done.resolve(x);
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
@@ -1,6 +1,6 @@
|
|||||||
import * as plugins from './taskbuffer.plugins.js';
|
import * as plugins from './taskbuffer.plugins.js';
|
||||||
|
|
||||||
import { Task, ITaskFunction } from './taskbuffer.classes.task.js';
|
import { Task, type ITaskFunction } from './taskbuffer.classes.task.js';
|
||||||
|
|
||||||
export class TaskDebounced<T = unknown> extends Task {
|
export class TaskDebounced<T = unknown> extends Task {
|
||||||
private _debouncedTaskFunction: ITaskFunction;
|
private _debouncedTaskFunction: ITaskFunction;
|
||||||
@@ -19,7 +19,9 @@ export class TaskDebounced<T = unknown> extends Task {
|
|||||||
});
|
});
|
||||||
this.taskFunction = optionsArg.taskFunction;
|
this.taskFunction = optionsArg.taskFunction;
|
||||||
this._observableIntake.observable
|
this._observableIntake.observable
|
||||||
.pipe(plugins.smartrx.rxjs.ops.debounceTime(optionsArg.debounceTimeInMillis))
|
.pipe(
|
||||||
|
plugins.smartrx.rxjs.ops.debounceTime(optionsArg.debounceTimeInMillis),
|
||||||
|
)
|
||||||
.subscribe((x) => {
|
.subscribe((x) => {
|
||||||
this.taskFunction(x);
|
this.taskFunction(x);
|
||||||
});
|
});
|
||||||
|
@@ -1,155 +1,268 @@
|
|||||||
import * as plugins from './taskbuffer.plugins.js';
|
import * as plugins from './taskbuffer.plugins.js';
|
||||||
import { Task } from './taskbuffer.classes.task.js';
|
import { Task } from './taskbuffer.classes.task.js';
|
||||||
import { AbstractDistributedCoordinator } from './taskbuffer.classes.distributedcoordinator.js';
|
import {
|
||||||
|
AbstractDistributedCoordinator,
|
||||||
|
type IDistributedTaskRequestResult,
|
||||||
|
} from './taskbuffer.classes.distributedcoordinator.js';
|
||||||
|
import type { ITaskMetadata, ITaskExecutionReport, IScheduledTaskInfo } from './taskbuffer.interfaces.js';
|
||||||
|
|
||||||
export interface ICronJob {
|
export interface ICronJob {
|
||||||
cronString: string;
|
cronString: string;
|
||||||
taskNameArg: string;
|
taskName: string;
|
||||||
job: any;
|
job: any;
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface ITaskManagerConstructorOptions {
|
export interface ITaskManagerConstructorOptions {
|
||||||
distributedCoordinator?: AbstractDistributedCoordinator
|
distributedCoordinator?: AbstractDistributedCoordinator;
|
||||||
}
|
}
|
||||||
|
|
||||||
export class TaskManager {
|
export class TaskManager {
|
||||||
public randomId = plugins.isounique.uni();
|
public randomId = plugins.smartunique.shortId();
|
||||||
public taskMap = new plugins.lik.ObjectMap<Task>();
|
public taskMap = new plugins.lik.ObjectMap<Task<any, any>>();
|
||||||
private cronJobManager = new plugins.smarttime.CronManager();
|
private cronJobManager = new plugins.smarttime.CronManager();
|
||||||
|
|
||||||
public options: ITaskManagerConstructorOptions = {
|
public options: ITaskManagerConstructorOptions = {
|
||||||
distributedCoordinator: null
|
distributedCoordinator: null,
|
||||||
};
|
};
|
||||||
|
|
||||||
constructor(optionosArg: ITaskManagerConstructorOptions = {}) {
|
constructor(options: ITaskManagerConstructorOptions = {}) {
|
||||||
this.options = Object.assign(this.options, optionosArg);
|
this.options = Object.assign(this.options, options);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
public getTaskByName(taskName: string): Task<any, any> {
|
||||||
* checks if a task is already present
|
return this.taskMap.findSync((task) => task.name === taskName);
|
||||||
* @param taskNameArg
|
|
||||||
*/
|
|
||||||
public getTaskByName(taskNameArg: string): Task {
|
|
||||||
return this.taskMap.findSync((itemArg) => {
|
|
||||||
return itemArg.name === taskNameArg;
|
|
||||||
});
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
public addTask(task: Task<any, any>): void {
|
||||||
* adds a Task to the TaskManager
|
if (!task.name) {
|
||||||
* @param taskArg
|
throw new Error('Task must have a name to be added to taskManager');
|
||||||
*/
|
|
||||||
public addTask(taskArg: Task): void {
|
|
||||||
if (!taskArg.name) {
|
|
||||||
throw new Error('taskArg needs a name to be added to taskManager');
|
|
||||||
}
|
}
|
||||||
this.taskMap.add(taskArg);
|
this.taskMap.add(task);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
public addAndScheduleTask(task: Task<any, any>, cronString: string) {
|
||||||
* adds and schedules a task at once
|
this.addTask(task);
|
||||||
* @param taskArg
|
this.scheduleTaskByName(task.name, cronString);
|
||||||
* @param cronStringArg
|
|
||||||
*/
|
|
||||||
public addAndScheduleTask(taskArg: Task, cronStringArg: string) {
|
|
||||||
this.addTask(taskArg);
|
|
||||||
this.scheduleTaskByName(taskArg.name, cronStringArg);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
public async triggerTaskByName(taskName: string): Promise<any> {
|
||||||
* triggers a task in the TaskManagerByName
|
const taskToTrigger = this.getTaskByName(taskName);
|
||||||
* @param taskNameArg
|
|
||||||
*/
|
|
||||||
public triggerTaskByName(taskNameArg: string): Promise<any> {
|
|
||||||
const taskToTrigger = this.getTaskByName(taskNameArg);
|
|
||||||
if (!taskToTrigger) {
|
if (!taskToTrigger) {
|
||||||
throw new Error(`There is no task with the name of ${taskNameArg}`);
|
throw new Error(`No task with the name ${taskName} found.`);
|
||||||
}
|
}
|
||||||
return taskToTrigger.trigger();
|
return taskToTrigger.trigger();
|
||||||
}
|
}
|
||||||
|
|
||||||
public async triggerTask(task: Task) {
|
public async triggerTask(task: Task<any, any>) {
|
||||||
return task.trigger();
|
return task.trigger();
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
public scheduleTaskByName(taskName: string, cronString: string) {
|
||||||
* schedules the task by name
|
const taskToSchedule = this.getTaskByName(taskName);
|
||||||
* @param taskNameArg
|
if (!taskToSchedule) {
|
||||||
*/
|
throw new Error(`No task with the name ${taskName} found.`);
|
||||||
public scheduleTaskByName(taskNameArg: string, cronStringArg: string) {
|
}
|
||||||
const taskToSchedule = this.getTaskByName(taskNameArg);
|
this.handleTaskScheduling(taskToSchedule, cronString);
|
||||||
const cronJob = this.cronJobManager.addCronjob(cronStringArg, async (triggerTimeArg: number) => {
|
}
|
||||||
console.log(`taskbuffer schedule triggered task >>${taskToSchedule.name}<<`);
|
|
||||||
console.log(
|
|
||||||
`task >>${taskToSchedule.name}<< is ${
|
|
||||||
taskToSchedule.buffered
|
|
||||||
? `buffered with max ${taskToSchedule.bufferMax} buffered calls`
|
|
||||||
: `unbuffered`
|
|
||||||
}`
|
|
||||||
);
|
|
||||||
if (this.options.distributedCoordinator) {
|
|
||||||
console.log(`Found a distrubuted coordinator, performing distributed consultation.`);
|
|
||||||
const announcementResult = await this.options.distributedCoordinator.fireDistributedTaskRequest({
|
|
||||||
submitterRandomId: this.randomId,
|
|
||||||
status: 'requesting',
|
|
||||||
taskExecutionParallel: 1,
|
|
||||||
taskExecutionTime: triggerTimeArg,
|
|
||||||
taskExecutionTimeout: taskToSchedule.timeout,
|
|
||||||
taskName: taskToSchedule.name,
|
|
||||||
taskVersion: taskToSchedule.version,
|
|
||||||
});
|
|
||||||
|
|
||||||
|
private handleTaskScheduling(task: Task<any, any>, cronString: string) {
|
||||||
|
const cronJob = this.cronJobManager.addCronjob(
|
||||||
|
cronString,
|
||||||
|
async (triggerTime: number) => {
|
||||||
|
this.logTaskState(task);
|
||||||
|
if (this.options.distributedCoordinator) {
|
||||||
|
const announcementResult = await this.performDistributedConsultation(
|
||||||
|
task,
|
||||||
|
triggerTime,
|
||||||
|
);
|
||||||
if (!announcementResult.shouldTrigger) {
|
if (!announcementResult.shouldTrigger) {
|
||||||
console.log('distributed coordinator result: NOT EXECUTING')
|
console.log('Distributed coordinator result: NOT EXECUTING');
|
||||||
return;
|
return;
|
||||||
} else {
|
} else {
|
||||||
console.log('distributed coordinator result: CHOSEN AND EXECUTING')
|
console.log('Distributed coordinator result: CHOSEN AND EXECUTING');
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
await taskToSchedule.trigger();
|
await task.trigger();
|
||||||
});
|
},
|
||||||
taskToSchedule.cronJob = cronJob;
|
);
|
||||||
|
task.cronJob = cronJob;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
private logTaskState(task: Task<any, any>) {
|
||||||
* deschedules a task by name
|
console.log(`Taskbuffer schedule triggered task >>${task.name}<<`);
|
||||||
* @param taskNameArg
|
const bufferState = task.buffered
|
||||||
*/
|
? `buffered with max ${task.bufferMax} buffered calls`
|
||||||
public descheduleTaskByName(taskNameArg: string) {
|
: `unbuffered`;
|
||||||
const taskToDeSchedule = this.getTaskByName(taskNameArg);
|
console.log(`Task >>${task.name}<< is ${bufferState}`);
|
||||||
if (taskToDeSchedule.cronJob) {
|
}
|
||||||
this.cronJobManager.removeCronjob(taskToDeSchedule.cronJob);
|
|
||||||
taskToDeSchedule.cronJob = null;
|
private async performDistributedConsultation(
|
||||||
|
task: Task<any, any>,
|
||||||
|
triggerTime: number,
|
||||||
|
): Promise<IDistributedTaskRequestResult> {
|
||||||
|
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) {
|
if (this.cronJobManager.cronjobs.isEmpty) {
|
||||||
this.cronJobManager.stop();
|
this.cronJobManager.stop();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
public async descheduleTask(task: Task<any, any>) {
|
||||||
* deschedules a task
|
|
||||||
* @param task
|
|
||||||
*/
|
|
||||||
public async descheduleTask(task: Task) {
|
|
||||||
await this.descheduleTaskByName(task.name);
|
await this.descheduleTaskByName(task.name);
|
||||||
}
|
}
|
||||||
/**
|
|
||||||
* returns all schedules of a specific task
|
|
||||||
* @param taskNameArg
|
|
||||||
*/
|
|
||||||
public getSchedulesForTaskName(taskNameArg: string) {}
|
|
||||||
|
|
||||||
/**
|
public getScheduleForTaskName(taskName: string): string | null {
|
||||||
* starts the taskmanager
|
const task = this.getTaskByName(taskName);
|
||||||
*/
|
return task && task.cronJob ? task.cronJob.cronExpression : null;
|
||||||
public start() {
|
}
|
||||||
|
|
||||||
|
public async start() {
|
||||||
|
if (this.options.distributedCoordinator) {
|
||||||
|
await this.options.distributedCoordinator.start();
|
||||||
|
}
|
||||||
this.cronJobManager.start();
|
this.cronJobManager.start();
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
public async stop() {
|
||||||
* stops the taskmanager
|
|
||||||
*/
|
|
||||||
public stop() {
|
|
||||||
this.cronJobManager.stop();
|
this.cronJobManager.stop();
|
||||||
|
if (this.options.distributedCoordinator) {
|
||||||
|
await this.options.distributedCoordinator.stop();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 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.js';
|
import * as plugins from './taskbuffer.plugins.js';
|
||||||
|
|
||||||
import { Task, ITaskFunction } from './taskbuffer.classes.task.js';
|
import { Task, type ITaskFunction } from './taskbuffer.classes.task.js';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* TaskOnce is run exactly once, no matter how often it is triggered
|
* TaskOnce is run exactly once, no matter how often it is triggered
|
||||||
|
@@ -5,7 +5,8 @@ import { Task } from './taskbuffer.classes.task.js';
|
|||||||
export class TaskRunner {
|
export class TaskRunner {
|
||||||
public maxParrallelJobs: number = 1;
|
public maxParrallelJobs: number = 1;
|
||||||
public status: 'stopped' | 'running' = 'stopped';
|
public status: 'stopped' | 'running' = 'stopped';
|
||||||
public runningTasks: plugins.lik.ObjectMap<Task> = new plugins.lik.ObjectMap<Task>();
|
public runningTasks: plugins.lik.ObjectMap<Task> =
|
||||||
|
new plugins.lik.ObjectMap<Task>();
|
||||||
public qeuedTasks: Task[] = [];
|
public qeuedTasks: Task[] = [];
|
||||||
|
|
||||||
constructor() {
|
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,9 +1,17 @@
|
|||||||
import * as isounique from '@pushrocks/isounique';
|
import * as lik from '@push.rocks/lik';
|
||||||
import * as lik from '@pushrocks/lik';
|
import * as smartlog from '@push.rocks/smartlog';
|
||||||
import * as smartlog from '@pushrocks/smartlog';
|
import * as smartpromise from '@push.rocks/smartpromise';
|
||||||
import * as smartpromise from '@pushrocks/smartpromise';
|
import * as smartdelay from '@push.rocks/smartdelay';
|
||||||
import * as smartdelay from '@pushrocks/smartdelay';
|
import * as smartrx from '@push.rocks/smartrx';
|
||||||
import * as smartrx from '@pushrocks/smartrx';
|
import * as smarttime from '@push.rocks/smarttime';
|
||||||
import * as smarttime from '@pushrocks/smarttime';
|
import * as smartunique from '@push.rocks/smartunique';
|
||||||
|
|
||||||
export { isounique, lik, smartlog, smartpromise, smartdelay, smartrx, smarttime };
|
export {
|
||||||
|
lik,
|
||||||
|
smartlog,
|
||||||
|
smartpromise,
|
||||||
|
smartdelay,
|
||||||
|
smartrx,
|
||||||
|
smarttime,
|
||||||
|
smartunique,
|
||||||
|
};
|
||||||
|
8
ts_web/00_commitinfo_data.ts
Normal file
8
ts_web/00_commitinfo_data.ts
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
/**
|
||||||
|
* autocreated commitinfo by @push.rocks/commitinfo
|
||||||
|
*/
|
||||||
|
export const commitinfo = {
|
||||||
|
name: '@push.rocks/taskbuffer',
|
||||||
|
version: '3.4.0',
|
||||||
|
description: 'A flexible task management library supporting TypeScript, allowing for task buffering, scheduling, and execution with dependency management.'
|
||||||
|
}
|
311
ts_web/elements/taskbuffer-dashboard.demo.ts
Normal file
311
ts_web/elements/taskbuffer-dashboard.demo.ts
Normal file
@@ -0,0 +1,311 @@
|
|||||||
|
import { html, css, cssManager } from '@design.estate/dees-element';
|
||||||
|
import { TaskManager, Task } from '../../ts/index.js';
|
||||||
|
import '../taskbuffer-dashboard.js';
|
||||||
|
|
||||||
|
export const demoFunc = () => html`
|
||||||
|
<style>
|
||||||
|
${css`
|
||||||
|
.demoWrapper {
|
||||||
|
box-sizing: border-box;
|
||||||
|
position: relative;
|
||||||
|
width: 100%;
|
||||||
|
min-height: 100vh;
|
||||||
|
padding: 48px;
|
||||||
|
background: ${cssManager.bdTheme('#f8f9fa', '#0a0a0a')};
|
||||||
|
}
|
||||||
|
|
||||||
|
h1 {
|
||||||
|
font-size: 32px;
|
||||||
|
font-weight: 700;
|
||||||
|
color: ${cssManager.bdTheme('#09090b', '#fafafa')};
|
||||||
|
margin-bottom: 12px;
|
||||||
|
text-align: center;
|
||||||
|
}
|
||||||
|
|
||||||
|
p {
|
||||||
|
font-size: 16px;
|
||||||
|
color: ${cssManager.bdTheme('#71717a', '#a1a1aa')};
|
||||||
|
text-align: center;
|
||||||
|
margin-bottom: 48px;
|
||||||
|
}
|
||||||
|
`}
|
||||||
|
</style>
|
||||||
|
|
||||||
|
<div class="demoWrapper">
|
||||||
|
<h1>TaskBuffer Dashboard Demo</h1>
|
||||||
|
<p>Real-time visualization of task execution, progress tracking, and scheduling</p>
|
||||||
|
|
||||||
|
<dees-demowrapper
|
||||||
|
.title=${'Live Dashboard'}
|
||||||
|
.subtitle=${'Interactive task management dashboard with real-time updates'}
|
||||||
|
.runAfterRender=${async (element) => {
|
||||||
|
// Create TaskManager instance
|
||||||
|
const taskManager = new TaskManager();
|
||||||
|
|
||||||
|
// Get dashboard element
|
||||||
|
const dashboard = element.querySelector('taskbuffer-dashboard');
|
||||||
|
dashboard.taskManager = taskManager;
|
||||||
|
dashboard.refreshInterval = 500;
|
||||||
|
|
||||||
|
// Task counter for unique names
|
||||||
|
let taskCounter = 0;
|
||||||
|
|
||||||
|
// Helper to create random delay
|
||||||
|
const randomDelay = () => new Promise(resolve =>
|
||||||
|
setTimeout(resolve, Math.random() * 2000 + 500)
|
||||||
|
);
|
||||||
|
|
||||||
|
// Add initial demo tasks
|
||||||
|
const addDemoTasks = () => {
|
||||||
|
// Add simple task
|
||||||
|
const simpleTask = new Task({
|
||||||
|
name: `SimpleTask_${++taskCounter}`,
|
||||||
|
taskFunction: async () => {
|
||||||
|
console.log(`Executing SimpleTask_${taskCounter}`);
|
||||||
|
await randomDelay();
|
||||||
|
return `Result from SimpleTask_${taskCounter}`;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
taskManager.addTask(simpleTask);
|
||||||
|
|
||||||
|
// Add task with steps
|
||||||
|
const steppedTask = new Task({
|
||||||
|
name: `SteppedTask_${++taskCounter}`,
|
||||||
|
steps: [
|
||||||
|
{ name: 'init', description: 'Initializing', percentage: 20 },
|
||||||
|
{ name: 'fetch', description: 'Fetching data', percentage: 30 },
|
||||||
|
{ name: 'process', description: 'Processing', percentage: 35 },
|
||||||
|
{ name: 'save', description: 'Saving results', percentage: 15 }
|
||||||
|
],
|
||||||
|
taskFunction: async function() {
|
||||||
|
this.notifyStep('init');
|
||||||
|
await randomDelay();
|
||||||
|
this.notifyStep('fetch');
|
||||||
|
await randomDelay();
|
||||||
|
this.notifyStep('process');
|
||||||
|
await randomDelay();
|
||||||
|
this.notifyStep('save');
|
||||||
|
await randomDelay();
|
||||||
|
return `Completed SteppedTask_${taskCounter}`;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
taskManager.addTask(steppedTask);
|
||||||
|
|
||||||
|
// Add buffered task
|
||||||
|
const bufferedTask = new Task({
|
||||||
|
name: `BufferedTask_${++taskCounter}`,
|
||||||
|
buffered: true,
|
||||||
|
bufferMax: 3,
|
||||||
|
steps: [
|
||||||
|
{ name: 'buffer', description: 'Processing buffered item', percentage: 100 }
|
||||||
|
],
|
||||||
|
taskFunction: async function(item) {
|
||||||
|
this.notifyStep('buffer');
|
||||||
|
console.log(`Processing buffered item: ${item}`);
|
||||||
|
await randomDelay();
|
||||||
|
return `Buffered task ${taskCounter} processed: ${item}`;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
taskManager.addTask(bufferedTask);
|
||||||
|
};
|
||||||
|
|
||||||
|
// Add initial tasks
|
||||||
|
addDemoTasks();
|
||||||
|
|
||||||
|
// Automatically trigger some tasks
|
||||||
|
setTimeout(() => {
|
||||||
|
const tasks = taskManager.getAllTasksMetadata();
|
||||||
|
tasks.forEach(taskMeta => {
|
||||||
|
const task = taskManager.getTaskByName(taskMeta.name);
|
||||||
|
if (task && !taskMeta.name.includes('Scheduled')) {
|
||||||
|
if (taskMeta.buffered) {
|
||||||
|
// Trigger buffered task multiple times
|
||||||
|
for (let i = 0; i < 5; i++) {
|
||||||
|
task.trigger(`Data_${i}`);
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
task.trigger();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}, 2000);
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
<taskbuffer-dashboard></taskbuffer-dashboard>
|
||||||
|
</dees-demowrapper>
|
||||||
|
|
||||||
|
<dees-demowrapper
|
||||||
|
.title=${'Scheduled Tasks'}
|
||||||
|
.subtitle=${'Tasks scheduled with cron expressions'}
|
||||||
|
.runAfterRender=${async (element) => {
|
||||||
|
// Create TaskManager instance
|
||||||
|
const taskManager = new TaskManager();
|
||||||
|
|
||||||
|
// Get dashboard element
|
||||||
|
const dashboard = element.querySelector('taskbuffer-dashboard');
|
||||||
|
dashboard.taskManager = taskManager;
|
||||||
|
dashboard.refreshInterval = 1000;
|
||||||
|
|
||||||
|
// Add scheduled tasks
|
||||||
|
const scheduledTask1 = new Task({
|
||||||
|
name: 'HourlyBackup',
|
||||||
|
steps: [
|
||||||
|
{ name: 'prepare', description: 'Preparing backup', percentage: 30 },
|
||||||
|
{ name: 'backup', description: 'Creating backup', percentage: 50 },
|
||||||
|
{ name: 'verify', description: 'Verifying backup', percentage: 20 }
|
||||||
|
],
|
||||||
|
taskFunction: async function() {
|
||||||
|
this.notifyStep('prepare');
|
||||||
|
await new Promise(resolve => setTimeout(resolve, 1000));
|
||||||
|
this.notifyStep('backup');
|
||||||
|
await new Promise(resolve => setTimeout(resolve, 2000));
|
||||||
|
this.notifyStep('verify');
|
||||||
|
await new Promise(resolve => setTimeout(resolve, 500));
|
||||||
|
return 'Backup completed';
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
const scheduledTask2 = new Task({
|
||||||
|
name: 'DailyReport',
|
||||||
|
steps: [
|
||||||
|
{ name: 'collect', description: 'Collecting data', percentage: 40 },
|
||||||
|
{ name: 'analyze', description: 'Analyzing data', percentage: 40 },
|
||||||
|
{ name: 'send', description: 'Sending report', percentage: 20 }
|
||||||
|
],
|
||||||
|
taskFunction: async function() {
|
||||||
|
this.notifyStep('collect');
|
||||||
|
await new Promise(resolve => setTimeout(resolve, 1500));
|
||||||
|
this.notifyStep('analyze');
|
||||||
|
await new Promise(resolve => setTimeout(resolve, 1500));
|
||||||
|
this.notifyStep('send');
|
||||||
|
await new Promise(resolve => setTimeout(resolve, 500));
|
||||||
|
return 'Report sent';
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// Schedule tasks
|
||||||
|
taskManager.addAndScheduleTask(scheduledTask1, '0 * * * *'); // Every hour
|
||||||
|
taskManager.addAndScheduleTask(scheduledTask2, '0 0 * * *'); // Daily at midnight
|
||||||
|
|
||||||
|
// Also add them as regular tasks for demo
|
||||||
|
const demoTask = new Task({
|
||||||
|
name: 'DemoScheduledExecution',
|
||||||
|
steps: [
|
||||||
|
{ name: 'execute', description: 'Simulating scheduled execution', percentage: 100 }
|
||||||
|
],
|
||||||
|
taskFunction: async function() {
|
||||||
|
this.notifyStep('execute');
|
||||||
|
await new Promise(resolve => setTimeout(resolve, 1000));
|
||||||
|
|
||||||
|
// Trigger scheduled tasks for demo
|
||||||
|
scheduledTask1.trigger();
|
||||||
|
scheduledTask2.trigger();
|
||||||
|
|
||||||
|
return 'Triggered scheduled tasks for demo';
|
||||||
|
}
|
||||||
|
});
|
||||||
|
taskManager.addTask(demoTask);
|
||||||
|
|
||||||
|
// Trigger demo after 2 seconds
|
||||||
|
setTimeout(() => {
|
||||||
|
demoTask.trigger();
|
||||||
|
}, 2000);
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
<taskbuffer-dashboard></taskbuffer-dashboard>
|
||||||
|
</dees-demowrapper>
|
||||||
|
|
||||||
|
<dees-demowrapper
|
||||||
|
.title=${'Task Execution Control'}
|
||||||
|
.subtitle=${'Interactive controls for task management'}
|
||||||
|
.runAfterRender=${async (element) => {
|
||||||
|
// Create TaskManager instance
|
||||||
|
const taskManager = new TaskManager();
|
||||||
|
|
||||||
|
// Get dashboard element
|
||||||
|
const dashboard = element.querySelector('taskbuffer-dashboard');
|
||||||
|
dashboard.taskManager = taskManager;
|
||||||
|
dashboard.refreshInterval = 300;
|
||||||
|
|
||||||
|
// Add control buttons
|
||||||
|
const controlsDiv = document.createElement('div');
|
||||||
|
controlsDiv.style.cssText = `
|
||||||
|
display: flex;
|
||||||
|
gap: 8px;
|
||||||
|
margin-bottom: 16px;
|
||||||
|
flex-wrap: wrap;
|
||||||
|
`;
|
||||||
|
|
||||||
|
const createButton = (text, onClick, style = '') => {
|
||||||
|
const button = document.createElement('button');
|
||||||
|
button.textContent = text;
|
||||||
|
button.style.cssText = `
|
||||||
|
padding: 8px 16px;
|
||||||
|
border: none;
|
||||||
|
border-radius: 6px;
|
||||||
|
cursor: pointer;
|
||||||
|
font-size: 14px;
|
||||||
|
transition: all 0.2s;
|
||||||
|
${style}
|
||||||
|
`;
|
||||||
|
button.onclick = onClick;
|
||||||
|
return button;
|
||||||
|
};
|
||||||
|
|
||||||
|
let taskCounter = 0;
|
||||||
|
|
||||||
|
// Add task button
|
||||||
|
controlsDiv.appendChild(createButton('Add Task', () => {
|
||||||
|
const task = new Task({
|
||||||
|
name: `Task_${++taskCounter}`,
|
||||||
|
steps: [
|
||||||
|
{ name: 'step1', description: 'Step 1', percentage: 33 },
|
||||||
|
{ name: 'step2', description: 'Step 2', percentage: 33 },
|
||||||
|
{ name: 'step3', description: 'Step 3', percentage: 34 }
|
||||||
|
],
|
||||||
|
taskFunction: async function() {
|
||||||
|
for (const step of ['step1', 'step2', 'step3']) {
|
||||||
|
this.notifyStep(step);
|
||||||
|
await new Promise(resolve => setTimeout(resolve, 1000));
|
||||||
|
}
|
||||||
|
return `Task_${taskCounter} completed`;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
taskManager.addTask(task);
|
||||||
|
}, 'background: #3b82f6; color: white;'));
|
||||||
|
|
||||||
|
// Trigger all button
|
||||||
|
controlsDiv.appendChild(createButton('Trigger All', () => {
|
||||||
|
const tasks = taskManager.getAllTasksMetadata();
|
||||||
|
tasks.forEach(taskMeta => {
|
||||||
|
const task = taskManager.getTaskByName(taskMeta.name);
|
||||||
|
if (task) {
|
||||||
|
task.trigger();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}, 'background: #22c55e; color: white;'));
|
||||||
|
|
||||||
|
// Clear all button
|
||||||
|
controlsDiv.appendChild(createButton('Clear All', () => {
|
||||||
|
const tasks = taskManager.getAllTasksMetadata();
|
||||||
|
tasks.forEach(taskMeta => {
|
||||||
|
const task = taskManager.getTaskByName(taskMeta.name);
|
||||||
|
if (task) {
|
||||||
|
taskManager.taskMap.remove(task);
|
||||||
|
taskManager.descheduleTaskByName(taskMeta.name);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}, 'background: #ef4444; color: white;'));
|
||||||
|
|
||||||
|
element.insertBefore(controlsDiv, dashboard);
|
||||||
|
|
||||||
|
// Add some initial tasks
|
||||||
|
for (let i = 0; i < 3; i++) {
|
||||||
|
controlsDiv.querySelector('button').click();
|
||||||
|
}
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
<taskbuffer-dashboard></taskbuffer-dashboard>
|
||||||
|
</dees-demowrapper>
|
||||||
|
</div>
|
||||||
|
`;
|
12
ts_web/index.ts
Normal file
12
ts_web/index.ts
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
// Export web components
|
||||||
|
export * from './taskbuffer-dashboard.js';
|
||||||
|
|
||||||
|
// Export types from main module for web usage
|
||||||
|
export type {
|
||||||
|
TaskManager,
|
||||||
|
Task,
|
||||||
|
ITaskMetadata,
|
||||||
|
ITaskExecutionReport,
|
||||||
|
IScheduledTaskInfo,
|
||||||
|
ITaskStep
|
||||||
|
} from '../ts/index.js';
|
541
ts_web/taskbuffer-dashboard.ts
Normal file
541
ts_web/taskbuffer-dashboard.ts
Normal file
@@ -0,0 +1,541 @@
|
|||||||
|
import { DeesElement, customElement, html, css, property, state, cssManager } from '@design.estate/dees-element';
|
||||||
|
import type { TaskManager, ITaskMetadata, IScheduledTaskInfo } from '../ts/index.js';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A web component that displays TaskManager tasks with progress visualization
|
||||||
|
*/
|
||||||
|
@customElement('taskbuffer-dashboard')
|
||||||
|
export class TaskbufferDashboard extends DeesElement {
|
||||||
|
// Properties
|
||||||
|
@property({ type: Object })
|
||||||
|
public taskManager: TaskManager | null = null;
|
||||||
|
|
||||||
|
@property({ type: Number })
|
||||||
|
public refreshInterval: number = 1000; // milliseconds
|
||||||
|
|
||||||
|
// Internal state
|
||||||
|
@state()
|
||||||
|
private tasks: ITaskMetadata[] = [];
|
||||||
|
|
||||||
|
@state()
|
||||||
|
private scheduledTasks: IScheduledTaskInfo[] = [];
|
||||||
|
|
||||||
|
@state()
|
||||||
|
private isRunning: boolean = false;
|
||||||
|
|
||||||
|
private refreshTimer: any;
|
||||||
|
|
||||||
|
// Styles
|
||||||
|
static styles = [
|
||||||
|
cssManager.defaultStyles,
|
||||||
|
css`
|
||||||
|
:host {
|
||||||
|
display: block;
|
||||||
|
font-family: 'Inter', -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif;
|
||||||
|
}
|
||||||
|
|
||||||
|
.dashboard-container {
|
||||||
|
padding: 24px;
|
||||||
|
background: ${cssManager.bdTheme('#ffffff', '#0a0a0a')};
|
||||||
|
min-height: 100vh;
|
||||||
|
}
|
||||||
|
|
||||||
|
.dashboard-header {
|
||||||
|
margin-bottom: 32px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.dashboard-title {
|
||||||
|
font-size: 28px;
|
||||||
|
font-weight: 700;
|
||||||
|
color: ${cssManager.bdTheme('#09090b', '#fafafa')};
|
||||||
|
margin-bottom: 8px;
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 12px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.status-indicator {
|
||||||
|
width: 12px;
|
||||||
|
height: 12px;
|
||||||
|
border-radius: 50%;
|
||||||
|
background: ${cssManager.bdTheme('#22c55e', '#22c55e')};
|
||||||
|
animation: pulse 2s infinite;
|
||||||
|
}
|
||||||
|
|
||||||
|
.status-indicator.inactive {
|
||||||
|
background: ${cssManager.bdTheme('#94a3b8', '#475569')};
|
||||||
|
animation: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
@keyframes pulse {
|
||||||
|
0%, 100% {
|
||||||
|
opacity: 1;
|
||||||
|
}
|
||||||
|
50% {
|
||||||
|
opacity: 0.5;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.dashboard-subtitle {
|
||||||
|
font-size: 14px;
|
||||||
|
color: ${cssManager.bdTheme('#71717a', '#a1a1aa')};
|
||||||
|
}
|
||||||
|
|
||||||
|
.tasks-section {
|
||||||
|
margin-bottom: 48px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.section-title {
|
||||||
|
font-size: 20px;
|
||||||
|
font-weight: 600;
|
||||||
|
color: ${cssManager.bdTheme('#18181b', '#e4e4e7')};
|
||||||
|
margin-bottom: 16px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.tasks-grid {
|
||||||
|
display: grid;
|
||||||
|
grid-template-columns: repeat(auto-fill, minmax(350px, 1fr));
|
||||||
|
gap: 16px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.task-card {
|
||||||
|
background: ${cssManager.bdTheme('#f8fafc', '#18181b')};
|
||||||
|
border: 1px solid ${cssManager.bdTheme('#e2e8f0', '#27272a')};
|
||||||
|
border-radius: 12px;
|
||||||
|
padding: 20px;
|
||||||
|
transition: all 0.2s ease;
|
||||||
|
}
|
||||||
|
|
||||||
|
.task-card:hover {
|
||||||
|
transform: translateY(-2px);
|
||||||
|
box-shadow: 0 4px 12px ${cssManager.bdTheme('rgba(0,0,0,0.1)', 'rgba(0,0,0,0.3)')};
|
||||||
|
}
|
||||||
|
|
||||||
|
.task-header {
|
||||||
|
display: flex;
|
||||||
|
justify-content: space-between;
|
||||||
|
align-items: flex-start;
|
||||||
|
margin-bottom: 12px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.task-name {
|
||||||
|
font-size: 16px;
|
||||||
|
font-weight: 600;
|
||||||
|
color: ${cssManager.bdTheme('#0f172a', '#f1f5f9')};
|
||||||
|
}
|
||||||
|
|
||||||
|
.task-status {
|
||||||
|
display: inline-block;
|
||||||
|
padding: 4px 8px;
|
||||||
|
border-radius: 6px;
|
||||||
|
font-size: 11px;
|
||||||
|
font-weight: 600;
|
||||||
|
text-transform: uppercase;
|
||||||
|
letter-spacing: 0.5px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.task-status.idle {
|
||||||
|
background: ${cssManager.bdTheme('#f1f5f9', '#27272a')};
|
||||||
|
color: ${cssManager.bdTheme('#64748b', '#94a3b8')};
|
||||||
|
}
|
||||||
|
|
||||||
|
.task-status.running {
|
||||||
|
background: ${cssManager.bdTheme('#dbeafe', '#1e3a8a')};
|
||||||
|
color: ${cssManager.bdTheme('#1e40af', '#93c5fd')};
|
||||||
|
}
|
||||||
|
|
||||||
|
.task-status.completed {
|
||||||
|
background: ${cssManager.bdTheme('#dcfce7', '#14532d')};
|
||||||
|
color: ${cssManager.bdTheme('#15803d', '#86efac')};
|
||||||
|
}
|
||||||
|
|
||||||
|
.task-status.failed {
|
||||||
|
background: ${cssManager.bdTheme('#fee2e2', '#7f1d1d')};
|
||||||
|
color: ${cssManager.bdTheme('#dc2626', '#fca5a5')};
|
||||||
|
}
|
||||||
|
|
||||||
|
.task-info {
|
||||||
|
display: flex;
|
||||||
|
gap: 16px;
|
||||||
|
margin-bottom: 16px;
|
||||||
|
font-size: 13px;
|
||||||
|
color: ${cssManager.bdTheme('#64748b', '#94a3b8')};
|
||||||
|
}
|
||||||
|
|
||||||
|
.task-info-item {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 4px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.task-info-icon {
|
||||||
|
width: 14px;
|
||||||
|
height: 14px;
|
||||||
|
opacity: 0.7;
|
||||||
|
}
|
||||||
|
|
||||||
|
.progress-container {
|
||||||
|
margin-bottom: 16px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.progress-label {
|
||||||
|
display: flex;
|
||||||
|
justify-content: space-between;
|
||||||
|
margin-bottom: 8px;
|
||||||
|
font-size: 13px;
|
||||||
|
color: ${cssManager.bdTheme('#475569', '#cbd5e1')};
|
||||||
|
}
|
||||||
|
|
||||||
|
.progress-bar {
|
||||||
|
height: 8px;
|
||||||
|
background: ${cssManager.bdTheme('#e2e8f0', '#27272a')};
|
||||||
|
border-radius: 4px;
|
||||||
|
overflow: hidden;
|
||||||
|
position: relative;
|
||||||
|
}
|
||||||
|
|
||||||
|
.progress-fill {
|
||||||
|
height: 100%;
|
||||||
|
background: linear-gradient(90deg, #3b82f6, #6366f1);
|
||||||
|
border-radius: 4px;
|
||||||
|
transition: width 0.3s ease;
|
||||||
|
position: relative;
|
||||||
|
overflow: hidden;
|
||||||
|
}
|
||||||
|
|
||||||
|
.progress-fill::after {
|
||||||
|
content: '';
|
||||||
|
position: absolute;
|
||||||
|
top: 0;
|
||||||
|
left: 0;
|
||||||
|
right: 0;
|
||||||
|
bottom: 0;
|
||||||
|
background: linear-gradient(
|
||||||
|
90deg,
|
||||||
|
transparent,
|
||||||
|
rgba(255, 255, 255, 0.3),
|
||||||
|
transparent
|
||||||
|
);
|
||||||
|
animation: shimmer 2s infinite;
|
||||||
|
}
|
||||||
|
|
||||||
|
@keyframes shimmer {
|
||||||
|
0% {
|
||||||
|
transform: translateX(-100%);
|
||||||
|
}
|
||||||
|
100% {
|
||||||
|
transform: translateX(100%);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.steps-container {
|
||||||
|
border-top: 1px solid ${cssManager.bdTheme('#e2e8f0', '#27272a')};
|
||||||
|
padding-top: 12px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.steps-title {
|
||||||
|
font-size: 12px;
|
||||||
|
font-weight: 600;
|
||||||
|
color: ${cssManager.bdTheme('#64748b', '#94a3b8')};
|
||||||
|
margin-bottom: 8px;
|
||||||
|
text-transform: uppercase;
|
||||||
|
letter-spacing: 0.5px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.step-item {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 8px;
|
||||||
|
padding: 6px 0;
|
||||||
|
font-size: 13px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.step-indicator {
|
||||||
|
width: 20px;
|
||||||
|
height: 20px;
|
||||||
|
border-radius: 50%;
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
justify-content: center;
|
||||||
|
font-size: 10px;
|
||||||
|
font-weight: 600;
|
||||||
|
flex-shrink: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.step-indicator.pending {
|
||||||
|
background: ${cssManager.bdTheme('#f1f5f9', '#27272a')};
|
||||||
|
color: ${cssManager.bdTheme('#94a3b8', '#64748b')};
|
||||||
|
border: 2px solid ${cssManager.bdTheme('#cbd5e1', '#3f3f46')};
|
||||||
|
}
|
||||||
|
|
||||||
|
.step-indicator.active {
|
||||||
|
background: linear-gradient(135deg, #3b82f6, #6366f1);
|
||||||
|
color: white;
|
||||||
|
animation: pulse 1.5s infinite;
|
||||||
|
}
|
||||||
|
|
||||||
|
.step-indicator.completed {
|
||||||
|
background: ${cssManager.bdTheme('#22c55e', '#22c55e')};
|
||||||
|
color: white;
|
||||||
|
}
|
||||||
|
|
||||||
|
.step-details {
|
||||||
|
flex: 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
.step-name {
|
||||||
|
font-weight: 500;
|
||||||
|
color: ${cssManager.bdTheme('#1e293b', '#e2e8f0')};
|
||||||
|
}
|
||||||
|
|
||||||
|
.step-description {
|
||||||
|
font-size: 11px;
|
||||||
|
color: ${cssManager.bdTheme('#64748b', '#94a3b8')};
|
||||||
|
margin-top: 2px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.step-percentage {
|
||||||
|
font-size: 11px;
|
||||||
|
font-weight: 600;
|
||||||
|
color: ${cssManager.bdTheme('#94a3b8', '#64748b')};
|
||||||
|
}
|
||||||
|
|
||||||
|
.empty-state {
|
||||||
|
text-align: center;
|
||||||
|
padding: 48px;
|
||||||
|
color: ${cssManager.bdTheme('#94a3b8', '#64748b')};
|
||||||
|
}
|
||||||
|
|
||||||
|
.empty-state-icon {
|
||||||
|
width: 64px;
|
||||||
|
height: 64px;
|
||||||
|
margin: 0 auto 16px;
|
||||||
|
opacity: 0.3;
|
||||||
|
}
|
||||||
|
|
||||||
|
.empty-state-text {
|
||||||
|
font-size: 16px;
|
||||||
|
margin-bottom: 8px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.empty-state-subtext {
|
||||||
|
font-size: 14px;
|
||||||
|
color: ${cssManager.bdTheme('#cbd5e1', '#475569')};
|
||||||
|
}
|
||||||
|
|
||||||
|
.scheduled-section {
|
||||||
|
margin-top: 32px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.schedule-info {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 8px;
|
||||||
|
margin-top: 8px;
|
||||||
|
font-size: 12px;
|
||||||
|
color: ${cssManager.bdTheme('#64748b', '#94a3b8')};
|
||||||
|
}
|
||||||
|
|
||||||
|
.schedule-icon {
|
||||||
|
width: 14px;
|
||||||
|
height: 14px;
|
||||||
|
}
|
||||||
|
`,
|
||||||
|
];
|
||||||
|
|
||||||
|
// Lifecycle
|
||||||
|
async connectedCallback() {
|
||||||
|
await super.connectedCallback();
|
||||||
|
this.startRefreshing();
|
||||||
|
}
|
||||||
|
|
||||||
|
async disconnectedCallback() {
|
||||||
|
await super.disconnectedCallback();
|
||||||
|
this.stopRefreshing();
|
||||||
|
}
|
||||||
|
|
||||||
|
// Methods
|
||||||
|
private startRefreshing() {
|
||||||
|
if (this.refreshTimer) {
|
||||||
|
clearInterval(this.refreshTimer);
|
||||||
|
}
|
||||||
|
|
||||||
|
this.updateData();
|
||||||
|
this.refreshTimer = setInterval(() => {
|
||||||
|
this.updateData();
|
||||||
|
}, this.refreshInterval);
|
||||||
|
this.isRunning = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
private stopRefreshing() {
|
||||||
|
if (this.refreshTimer) {
|
||||||
|
clearInterval(this.refreshTimer);
|
||||||
|
this.refreshTimer = null;
|
||||||
|
}
|
||||||
|
this.isRunning = false;
|
||||||
|
}
|
||||||
|
|
||||||
|
private updateData() {
|
||||||
|
if (!this.taskManager) {
|
||||||
|
this.tasks = [];
|
||||||
|
this.scheduledTasks = [];
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
this.tasks = this.taskManager.getAllTasksMetadata();
|
||||||
|
this.scheduledTasks = this.taskManager.getScheduledTasks();
|
||||||
|
}
|
||||||
|
|
||||||
|
private formatNextRun(date: Date): string {
|
||||||
|
const now = new Date();
|
||||||
|
const diff = date.getTime() - now.getTime();
|
||||||
|
|
||||||
|
if (diff < 0) return 'Past due';
|
||||||
|
if (diff < 60000) return 'Less than a minute';
|
||||||
|
if (diff < 3600000) return `${Math.floor(diff / 60000)} minutes`;
|
||||||
|
if (diff < 86400000) return `${Math.floor(diff / 3600000)} hours`;
|
||||||
|
return `${Math.floor(diff / 86400000)} days`;
|
||||||
|
}
|
||||||
|
|
||||||
|
private formatDuration(ms?: number): string {
|
||||||
|
if (!ms) return '-';
|
||||||
|
if (ms < 1000) return `${ms}ms`;
|
||||||
|
if (ms < 60000) return `${(ms / 1000).toFixed(1)}s`;
|
||||||
|
return `${(ms / 60000).toFixed(1)}m`;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Render
|
||||||
|
render() {
|
||||||
|
return html`
|
||||||
|
<div class="dashboard-container">
|
||||||
|
<div class="dashboard-header">
|
||||||
|
<div class="dashboard-title">
|
||||||
|
<span>TaskBuffer Dashboard</span>
|
||||||
|
<span class="status-indicator ${this.isRunning ? '' : 'inactive'}"></span>
|
||||||
|
</div>
|
||||||
|
<div class="dashboard-subtitle">
|
||||||
|
${this.tasks.length} task${this.tasks.length !== 1 ? 's' : ''} registered
|
||||||
|
${this.scheduledTasks.length > 0 ? ` • ${this.scheduledTasks.length} scheduled` : ''}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="tasks-section">
|
||||||
|
<h2 class="section-title">Active Tasks</h2>
|
||||||
|
|
||||||
|
${this.tasks.length > 0 ? html`
|
||||||
|
<div class="tasks-grid">
|
||||||
|
${this.tasks.map(task => this.renderTaskCard(task))}
|
||||||
|
</div>
|
||||||
|
` : html`
|
||||||
|
<div class="empty-state">
|
||||||
|
<svg class="empty-state-icon" fill="none" stroke="currentColor" viewBox="0 0 24 24">
|
||||||
|
<path stroke-linecap="round" stroke-linejoin="round" stroke-width="2"
|
||||||
|
d="M9 5H7a2 2 0 00-2 2v12a2 2 0 002 2h10a2 2 0 002-2V7a2 2 0 00-2-2h-2M9 5a2 2 0 002 2h2a2 2 0 002-2M9 5a2 2 0 012-2h2a2 2 0 012 2" />
|
||||||
|
</svg>
|
||||||
|
<div class="empty-state-text">No tasks registered</div>
|
||||||
|
<div class="empty-state-subtext">Tasks will appear here when added to the TaskManager</div>
|
||||||
|
</div>
|
||||||
|
`}
|
||||||
|
</div>
|
||||||
|
|
||||||
|
${this.scheduledTasks.length > 0 ? html`
|
||||||
|
<div class="scheduled-section">
|
||||||
|
<h2 class="section-title">Scheduled Tasks</h2>
|
||||||
|
<div class="tasks-grid">
|
||||||
|
${this.scheduledTasks.map(task => this.renderScheduledTaskCard(task))}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
` : ''}
|
||||||
|
</div>
|
||||||
|
`;
|
||||||
|
}
|
||||||
|
|
||||||
|
private renderTaskCard(task: ITaskMetadata) {
|
||||||
|
return html`
|
||||||
|
<div class="task-card">
|
||||||
|
<div class="task-header">
|
||||||
|
<div class="task-name">${task.name || 'Unnamed Task'}</div>
|
||||||
|
<div class="task-status ${task.status}">${task.status}</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="task-info">
|
||||||
|
<div class="task-info-item">
|
||||||
|
<svg class="task-info-icon" fill="none" stroke="currentColor" viewBox="0 0 24 24">
|
||||||
|
<path stroke-linecap="round" stroke-linejoin="round" stroke-width="2"
|
||||||
|
d="M13 10V3L4 14h7v7l9-11h-7z" />
|
||||||
|
</svg>
|
||||||
|
<span>Run ${task.runCount || 0} times</span>
|
||||||
|
</div>
|
||||||
|
${task.buffered ? html`
|
||||||
|
<div class="task-info-item">
|
||||||
|
<svg class="task-info-icon" fill="none" stroke="currentColor" viewBox="0 0 24 24">
|
||||||
|
<path stroke-linecap="round" stroke-linejoin="round" stroke-width="2"
|
||||||
|
d="M19 11H5m14 0a2 2 0 012 2v6a2 2 0 01-2 2H5a2 2 0 01-2-2v-6a2 2 0 012-2m14 0V9a2 2 0 00-2-2M5 11V9a2 2 0 012-2m0 0V5a2 2 0 012-2h6a2 2 0 012 2v2M7 7h10" />
|
||||||
|
</svg>
|
||||||
|
<span>Buffer: ${task.bufferMax || 0}</span>
|
||||||
|
</div>
|
||||||
|
` : ''}
|
||||||
|
</div>
|
||||||
|
|
||||||
|
${task.steps && task.steps.length > 0 ? html`
|
||||||
|
<div class="progress-container">
|
||||||
|
<div class="progress-label">
|
||||||
|
<span>Progress</span>
|
||||||
|
<span>${task.currentProgress || 0}%</span>
|
||||||
|
</div>
|
||||||
|
<div class="progress-bar">
|
||||||
|
<div class="progress-fill" style="width: ${task.currentProgress || 0}%"></div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="steps-container">
|
||||||
|
<div class="steps-title">Steps</div>
|
||||||
|
${task.steps.map(step => html`
|
||||||
|
<div class="step-item">
|
||||||
|
<div class="step-indicator ${step.status}">
|
||||||
|
${step.status === 'completed' ? '✓' :
|
||||||
|
step.status === 'active' ? '•' :
|
||||||
|
''}
|
||||||
|
</div>
|
||||||
|
<div class="step-details">
|
||||||
|
<div class="step-name">${step.name}</div>
|
||||||
|
${step.description ? html`
|
||||||
|
<div class="step-description">${step.description}</div>
|
||||||
|
` : ''}
|
||||||
|
</div>
|
||||||
|
<div class="step-percentage">${step.percentage}%</div>
|
||||||
|
</div>
|
||||||
|
`)}
|
||||||
|
</div>
|
||||||
|
` : ''}
|
||||||
|
</div>
|
||||||
|
`;
|
||||||
|
}
|
||||||
|
|
||||||
|
private renderScheduledTaskCard(task: IScheduledTaskInfo) {
|
||||||
|
return html`
|
||||||
|
<div class="task-card">
|
||||||
|
<div class="task-header">
|
||||||
|
<div class="task-name">${task.name}</div>
|
||||||
|
<div class="task-status idle">scheduled</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="schedule-info">
|
||||||
|
<svg class="schedule-icon" fill="none" stroke="currentColor" viewBox="0 0 24 24">
|
||||||
|
<path stroke-linecap="round" stroke-linejoin="round" stroke-width="2"
|
||||||
|
d="M12 8v4l3 3m6-3a9 9 0 11-18 0 9 9 0 0118 0z" />
|
||||||
|
</svg>
|
||||||
|
<span>Next run: ${this.formatNextRun(task.nextRun)}</span>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="schedule-info">
|
||||||
|
<svg class="schedule-icon" fill="none" stroke="currentColor" viewBox="0 0 24 24">
|
||||||
|
<path stroke-linecap="round" stroke-linejoin="round" stroke-width="2"
|
||||||
|
d="M8 7V3m8 4V3m-9 8h10M5 21h14a2 2 0 002-2V7a2 2 0 00-2-2H5a2 2 0 00-2 2v12a2 2 0 002 2z" />
|
||||||
|
</svg>
|
||||||
|
<span>Schedule: ${task.schedule}</span>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
`;
|
||||||
|
}
|
||||||
|
}
|
@@ -3,8 +3,12 @@
|
|||||||
"experimentalDecorators": true,
|
"experimentalDecorators": true,
|
||||||
"useDefineForClassFields": false,
|
"useDefineForClassFields": false,
|
||||||
"target": "ES2022",
|
"target": "ES2022",
|
||||||
"module": "ES2022",
|
"module": "NodeNext",
|
||||||
"moduleResolution": "nodenext",
|
"moduleResolution": "NodeNext",
|
||||||
"esModuleInterop": true
|
"esModuleInterop": true,
|
||||||
}
|
"verbatimModuleSyntax": true,
|
||||||
|
"baseUrl": ".",
|
||||||
|
"paths": {}
|
||||||
|
},
|
||||||
|
"exclude": ["dist_*/**/*.d.ts"]
|
||||||
}
|
}
|
||||||
|
Reference in New Issue
Block a user