Compare commits
172 Commits
Author | SHA1 | Date | |
---|---|---|---|
863adb3b8c | |||
67f01417b6 | |||
65886287c6 | |||
fdaf772cfc | |||
757b992440 | |||
b4a701d128 | |||
ca3ef8ced6 | |||
6115bae66b | |||
1be83af475 | |||
bd14c41edc | |||
d61b79282d | |||
1cba9245fe | |||
4b0db4da21 | |||
a6cd0cb579 | |||
bd6109d5ea | |||
aa632a5294 | |||
6499dd45cf | |||
d04ed21607 | |||
bae776d4e9 | |||
fcd7ea467e | |||
e061b96056 | |||
c2ce669f0c | |||
05f91c3e35 | |||
94e327c722 | |||
57a27604a7 | |||
b077bd7a1b | |||
f2c2dab782 | |||
53a67c0ebe | |||
5240a80cb3 | |||
fa8be6b6d3 | |||
b5981d67cf | |||
493cd83dda | |||
86b2842ed2 | |||
801e2ad266 | |||
7f837c70fc | |||
f5ca4a696c | |||
b48d42dfb9 | |||
5bf568d0cd | |||
173e1ca35d | |||
ce258c76d2 | |||
4d2756b743 | |||
973678d635 | |||
28e7bad605 | |||
fb44dd47fc | |||
a2f6bccac2 | |||
e4f8be5603 | |||
84f186924e | |||
ff57dccee1 | |||
a9d84d5147 | |||
ae6a6ce67e | |||
05b14136f9 | |||
bf9ca39c36 | |||
e61791ec41 | |||
9001a96df0 | |||
835fa3663d | |||
f50384947d | |||
65c1dd8fdc | |||
613d46bb38 | |||
439da1f342 | |||
e9e4a60fe6 | |||
1630f6971f | |||
7bfb145513 | |||
c367f0f949 | |||
8f9b3151d8 | |||
81e97b513a | |||
7da0035805 | |||
16a77e4c41 | |||
495f63ec71 | |||
17f840d24c | |||
b93407e83a | |||
003c1f2796 | |||
7f72a88846 | |||
823d4f7d55 | |||
7d57fcf07e | |||
eb9ae2fa71 | |||
5fe60c6e50 | |||
6f811b4ab5 | |||
2cf32ac723 | |||
09936fda56 | |||
ddc9a77fe2 | |||
575912eab7 | |||
eee146ae8b | |||
ea8ef61c40 | |||
70bb5b3f5d | |||
5fa7312171 | |||
cb85deeb3d | |||
fdfb780c33 | |||
f21b53b81d | |||
0bf3b2ea8b | |||
0e81b8bd94 | |||
138aefc499 | |||
af5fa857cc | |||
f275f7e2f6 | |||
ea1f434cdd | |||
2cc212f210 | |||
2d2788d1ca | |||
de1652bac9 | |||
5310bef1be | |||
1a5c67efc1 | |||
df21ebd581 | |||
3f749dfdd2 | |||
2a39543a75 | |||
68f7d26d3b | |||
6373a74fb3 | |||
be3d2d41d6 | |||
2affa189a7 | |||
8c4c2a552c | |||
eff9c6e6c9 | |||
4c7a373d98 | |||
6b93a2e7ac | |||
9c6487c779 | |||
e3f37f5027 | |||
1152bb1138 | |||
9df7787450 | |||
3e81fdacad | |||
f74da6ff0b | |||
e9d976ad1e | |||
f6d314695a | |||
d35b34f4aa | |||
9fec5ce62e | |||
7577479368 | |||
dbcd5bbfc8 | |||
d91b6c8360 | |||
b9af186190 | |||
bdb7064394 | |||
f60deddadd | |||
df18aba4b5 | |||
a3699f2869 | |||
017c0789ca | |||
6e6d056617 | |||
3f7f38ee17 | |||
5bfc72a602 | |||
ca8882962e | |||
df6bf2c681 | |||
310a683e14 | |||
3f275ebc08 | |||
01d469960e | |||
2ed701040a | |||
ca3bb38205 | |||
891d727fd4 | |||
e1424ea0fb | |||
cf1b31d635 | |||
d5570311ee | |||
44b3ba1313 | |||
4721d8c9e6 | |||
c7336eedfb | |||
5477911b5e | |||
2f8d3f7625 | |||
b00d31b41a | |||
4031692f6f | |||
174beae65f | |||
c1144d3405 | |||
065d92e573 | |||
46878819df | |||
aa8df29bbb | |||
f5cb0843fc | |||
|
1d52d098fb | ||
eb7eb14415 | |||
670bf5b124 | |||
fab863c66c | |||
402e2b982f | |||
1d0a85e6ca | |||
7ded7b036e | |||
03020eacbc | |||
dc95885646 | |||
11cdaad226 | |||
a1ad463140 | |||
76c57451b3 | |||
5dca9a9460 | |||
d30fb551f9 | |||
7a60f30f0b | |||
9e175245ed |
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: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
|
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{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 @shipzone/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: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
|
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{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 @shipzone/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 @shipzone/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 @shipzone/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 @shipzone/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
|
25
.gitignore
vendored
25
.gitignore
vendored
@@ -1,7 +1,20 @@
|
|||||||
.idea/
|
.nogit/
|
||||||
|
|
||||||
|
# artifacts
|
||||||
coverage/
|
coverage/
|
||||||
docs/
|
public/
|
||||||
ts/*.js
|
pages/
|
||||||
ts/*.js.map
|
|
||||||
ts/typings/
|
# installs
|
||||||
node_modules
|
node_modules/
|
||||||
|
|
||||||
|
# caches
|
||||||
|
.yarn/
|
||||||
|
.cache/
|
||||||
|
.rpt2_cache
|
||||||
|
|
||||||
|
# builds
|
||||||
|
dist/
|
||||||
|
dist_*/
|
||||||
|
|
||||||
|
# custom
|
@@ -1,36 +0,0 @@
|
|||||||
image: hosttoday/ht-docker-node:npmts
|
|
||||||
|
|
||||||
stages:
|
|
||||||
- test
|
|
||||||
- release
|
|
||||||
|
|
||||||
testLEGACY:
|
|
||||||
stage: test
|
|
||||||
script:
|
|
||||||
- npmci test legacy
|
|
||||||
tags:
|
|
||||||
- docker
|
|
||||||
|
|
||||||
testLTS:
|
|
||||||
stage: test
|
|
||||||
script:
|
|
||||||
- npmci test lts
|
|
||||||
tags:
|
|
||||||
- docker
|
|
||||||
|
|
||||||
testSTABLE:
|
|
||||||
stage: test
|
|
||||||
script:
|
|
||||||
- npmci test stable
|
|
||||||
tags:
|
|
||||||
- docker
|
|
||||||
|
|
||||||
release:
|
|
||||||
stage: release
|
|
||||||
environment: npmjs-com_registry
|
|
||||||
script:
|
|
||||||
- npmci publish
|
|
||||||
only:
|
|
||||||
- tags
|
|
||||||
tags:
|
|
||||||
- docker
|
|
@@ -1,5 +1,5 @@
|
|||||||
.idea/
|
|
||||||
docs/
|
docs/
|
||||||
coverage/
|
coverage/
|
||||||
ts/
|
ts/
|
||||||
node_modules/
|
node_modules/
|
||||||
|
pages/
|
||||||
|
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"
|
11
.vscode/launch.json
vendored
Normal file
11
.vscode/launch.json
vendored
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
{
|
||||||
|
"version": "0.2.0",
|
||||||
|
"configurations": [
|
||||||
|
{
|
||||||
|
"command": "npm test",
|
||||||
|
"name": "Run npm test",
|
||||||
|
"request": "launch",
|
||||||
|
"type": "node-terminal"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
26
.vscode/settings.json
vendored
Normal file
26
.vscode/settings.json
vendored
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
{
|
||||||
|
"json.schemas": [
|
||||||
|
{
|
||||||
|
"fileMatch": ["/npmextra.json"],
|
||||||
|
"schema": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"npmci": {
|
||||||
|
"type": "object",
|
||||||
|
"description": "settings for npmci"
|
||||||
|
},
|
||||||
|
"gitzone": {
|
||||||
|
"type": "object",
|
||||||
|
"description": "settings for gitzone",
|
||||||
|
"properties": {
|
||||||
|
"projectType": {
|
||||||
|
"type": "string",
|
||||||
|
"enum": ["website", "element", "service", "npm", "wcc"]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
56
README.md
56
README.md
@@ -1,56 +0,0 @@
|
|||||||
# taskbuffer
|
|
||||||
Flexible task organization for gulp. TypeScript ready!
|
|
||||||
|
|
||||||
## Status
|
|
||||||
[](https://coveralls.io/github/pushrocks/taskbuffer?branch=master)
|
|
||||||
|
|
||||||
## Install
|
|
||||||
|
|
||||||
```sh
|
|
||||||
npm install taskbuffer --save
|
|
||||||
```
|
|
||||||
|
|
||||||
## Concepts
|
|
||||||
|
|
||||||
### class `Task`
|
|
||||||
* A Task in its most simple form is a function that is executed when the task runs.
|
|
||||||
* A Task can have a **preTask** and an **afterTask**
|
|
||||||
(those are run before or after the main function whenever the task is called)
|
|
||||||
* A Task can be buffered.
|
|
||||||
That means it can be called multiple times in a very short time.
|
|
||||||
However execution happens in line:
|
|
||||||
meaning execution of the task's main function is on halt until the previous task call has finished.
|
|
||||||
You can set bufferMax number, which is the max number of buffered task calls.
|
|
||||||
Any additional calls will then be truncated
|
|
||||||
* Task.trigger() and Task.triggerBuffered() always return a Promise
|
|
||||||
which is fullfilled once the related task call has completed.
|
|
||||||
* Task.triggered() is an Observable stream that emits events every time a task call is called and every time a call is completed.
|
|
||||||
* Task is compatible to gulp streams.
|
|
||||||
|
|
||||||
### class `TaskChain`
|
|
||||||
* TaskChain extends Task.
|
|
||||||
* Multiple Tasks can be combined in a bigger task using a TaskChain.
|
|
||||||
* While the tasks are async in themselve, TaskChain **runs Tasks serialized** (one after the other)
|
|
||||||
* that means that tasks can rely on each other and
|
|
||||||
|
|
||||||
### class `TaskParallel`
|
|
||||||
* TaskParallel extends Task.
|
|
||||||
* like TaskChain, however **tasks run in parallel**
|
|
||||||
* Tasks cannot rely on each other.
|
|
||||||
|
|
||||||
### Usage
|
|
||||||
We highly recommend TypeScript as this module supports **TypeScript intellisense**.
|
|
||||||
```
|
|
||||||
import * as taskbuffer from "taskbuffer";
|
|
||||||
|
|
||||||
myTask = new taskbuffer.Task({
|
|
||||||
preTask: someOtherTask // optional, don't worry loops are prevented
|
|
||||||
afterTask: someOtherTask // optional, don't worry loops are prevented
|
|
||||||
name:"myTask1",
|
|
||||||
taskFunction:() => {
|
|
||||||
// do some stuff and return promise
|
|
||||||
// pass on any data through promise resolution
|
|
||||||
// Use TypeScript for better understanding and code completion
|
|
||||||
}
|
|
||||||
})
|
|
||||||
```
|
|
84
changelog.md
Normal file
84
changelog.md
Normal file
@@ -0,0 +1,84 @@
|
|||||||
|
# Changelog
|
||||||
|
|
||||||
|
## 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).
|
5
dist/index.d.ts
vendored
5
dist/index.d.ts
vendored
@@ -1,5 +0,0 @@
|
|||||||
export { Task, ITaskFunction } from "./taskbuffer.classes.task";
|
|
||||||
export { Taskchain } from "./taskbuffer.classes.taskchain";
|
|
||||||
export { Taskparallel } from "./taskbuffer.classes.taskparallel";
|
|
||||||
export { Taskspace } from "./taskbuffer.classes.taskspace";
|
|
||||||
import "./taskbuffer.classes.helpers";
|
|
12
dist/index.js
vendored
12
dist/index.js
vendored
@@ -1,12 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
var taskbuffer_classes_task_1 = require("./taskbuffer.classes.task");
|
|
||||||
exports.Task = taskbuffer_classes_task_1.Task;
|
|
||||||
var taskbuffer_classes_taskchain_1 = require("./taskbuffer.classes.taskchain");
|
|
||||||
exports.Taskchain = taskbuffer_classes_taskchain_1.Taskchain;
|
|
||||||
var taskbuffer_classes_taskparallel_1 = require("./taskbuffer.classes.taskparallel");
|
|
||||||
exports.Taskparallel = taskbuffer_classes_taskparallel_1.Taskparallel;
|
|
||||||
var taskbuffer_classes_taskspace_1 = require("./taskbuffer.classes.taskspace");
|
|
||||||
exports.Taskspace = taskbuffer_classes_taskspace_1.Taskspace;
|
|
||||||
// import for naming only
|
|
||||||
require("./taskbuffer.classes.helpers");
|
|
||||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsd0NBQWlDLDJCQUEyQixDQUFDO0FBQXJELDhDQUFxRDtBQUM3RCw2Q0FBd0IsZ0NBQWdDLENBQUM7QUFBakQsNkRBQWlEO0FBQ3pELGdEQUEyQixtQ0FBbUMsQ0FBQztBQUF2RCxzRUFBdUQ7QUFDL0QsNkNBQXdCLGdDQUFnQyxDQUFDO0FBQWpELDZEQUFpRDtBQUV6RCx5QkFBeUI7QUFDekIsUUFBTyw4QkFBOEIsQ0FBQyxDQUFEIn0=
|
|
10
dist/taskbuffer.classes.helpers.d.ts
vendored
10
dist/taskbuffer.classes.helpers.d.ts
vendored
@@ -1,10 +0,0 @@
|
|||||||
/// <reference types="q" />
|
|
||||||
import plugins = require("./taskbuffer.plugins");
|
|
||||||
import { Task, ITaskFunction } from "./taskbuffer.classes.task";
|
|
||||||
export declare let emptyTaskFunction: ITaskFunction;
|
|
||||||
export declare let isTask: (taskArg: any) => boolean;
|
|
||||||
export declare let isTaskTouched: (taskArg: Task, touchedTasksArray: Task[]) => boolean;
|
|
||||||
export declare let runTask: (taskArg: Task, optionsArg?: {
|
|
||||||
touchedTasksArray: Task[];
|
|
||||||
}) => plugins.Q.Promise<{}>;
|
|
||||||
export declare let runBufferedTask: (taskArg: Task) => void;
|
|
83
dist/taskbuffer.classes.helpers.js
vendored
83
dist/taskbuffer.classes.helpers.js
vendored
@@ -1,83 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
const plugins = require("./taskbuffer.plugins");
|
|
||||||
const taskbuffer_classes_task_1 = require("./taskbuffer.classes.task");
|
|
||||||
exports.emptyTaskFunction = function () {
|
|
||||||
let done = plugins.Q.defer();
|
|
||||||
done.resolve();
|
|
||||||
return done.promise;
|
|
||||||
};
|
|
||||||
exports.isTask = function (taskArg) {
|
|
||||||
if (taskArg instanceof taskbuffer_classes_task_1.Task
|
|
||||||
&& typeof taskArg.task === "function") {
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
else {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
};
|
|
||||||
exports.isTaskTouched = (taskArg, touchedTasksArray) => {
|
|
||||||
let result = false;
|
|
||||||
for (let keyArg in touchedTasksArray) {
|
|
||||||
if (taskArg === touchedTasksArray[keyArg]) {
|
|
||||||
result = true;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return result;
|
|
||||||
};
|
|
||||||
exports.runTask = function (taskArg, optionsArg = { touchedTasksArray: [] }) {
|
|
||||||
let done = plugins.Q.defer();
|
|
||||||
taskArg.running = true;
|
|
||||||
done.promise.then(function () { taskArg.running = false; });
|
|
||||||
let localDeferred = plugins.Q.defer();
|
|
||||||
let touchedTasksArray;
|
|
||||||
if (optionsArg.touchedTasksArray) {
|
|
||||||
touchedTasksArray = optionsArg.touchedTasksArray;
|
|
||||||
}
|
|
||||||
else {
|
|
||||||
touchedTasksArray = [];
|
|
||||||
}
|
|
||||||
touchedTasksArray.push(taskArg);
|
|
||||||
localDeferred.promise
|
|
||||||
.then(() => {
|
|
||||||
if (taskArg.preTask && !exports.isTaskTouched(taskArg.preTask, touchedTasksArray)) {
|
|
||||||
return exports.runTask(taskArg.preTask, { touchedTasksArray: touchedTasksArray });
|
|
||||||
}
|
|
||||||
else {
|
|
||||||
let done2 = plugins.Q.defer();
|
|
||||||
done2.resolve();
|
|
||||||
return done2.promise;
|
|
||||||
}
|
|
||||||
})
|
|
||||||
.then(() => {
|
|
||||||
return taskArg.task();
|
|
||||||
})
|
|
||||||
.then(() => {
|
|
||||||
if (taskArg.afterTask && !exports.isTaskTouched(taskArg.afterTask, touchedTasksArray)) {
|
|
||||||
return exports.runTask(taskArg.afterTask, { touchedTasksArray: touchedTasksArray });
|
|
||||||
}
|
|
||||||
else {
|
|
||||||
let done2 = plugins.Q.defer();
|
|
||||||
done2.resolve();
|
|
||||||
return done2.promise;
|
|
||||||
}
|
|
||||||
})
|
|
||||||
.then(() => {
|
|
||||||
done.resolve();
|
|
||||||
});
|
|
||||||
localDeferred.resolve();
|
|
||||||
return done.promise;
|
|
||||||
};
|
|
||||||
exports.runBufferedTask = (taskArg) => {
|
|
||||||
let recursiveBufferRunner = () => {
|
|
||||||
if (taskArg.bufferCounter > 0) {
|
|
||||||
taskArg.runningBuffered = true;
|
|
||||||
taskArg.bufferCounter--;
|
|
||||||
exports.runTask(taskArg)
|
|
||||||
.then(recursiveBufferRunner);
|
|
||||||
}
|
|
||||||
else {
|
|
||||||
taskArg.runningBuffered = false;
|
|
||||||
}
|
|
||||||
};
|
|
||||||
};
|
|
||||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGFza2J1ZmZlci5jbGFzc2VzLmhlbHBlcnMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy90YXNrYnVmZmVyLmNsYXNzZXMuaGVscGVycy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsTUFBTyxPQUFPLFdBQVcsc0JBQXNCLENBQUMsQ0FBQztBQUNqRCwwQ0FBaUMsMkJBQTJCLENBQUMsQ0FBQTtBQUVsRCx5QkFBaUIsR0FBaUI7SUFDekMsSUFBSSxJQUFJLEdBQUcsT0FBTyxDQUFDLENBQUMsQ0FBQyxLQUFLLEVBQUUsQ0FBQztJQUM3QixJQUFJLENBQUMsT0FBTyxFQUFFLENBQUM7SUFDZixNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQztBQUN4QixDQUFDLENBQUM7QUFFUyxjQUFNLEdBQUcsVUFBUyxPQUFPO0lBQ2hDLEVBQUUsQ0FBQSxDQUNFLE9BQU8sWUFBWSw4QkFBSTtXQUNwQixPQUFPLE9BQU8sQ0FBQyxJQUFJLEtBQUssVUFDL0IsQ0FBQyxDQUFBLENBQUM7UUFDRSxNQUFNLENBQUMsSUFBSSxDQUFDO0lBQ2hCLENBQUM7SUFBQyxJQUFJLENBQUMsQ0FBQztRQUNKLE1BQU0sQ0FBQyxLQUFLLENBQUM7SUFDakIsQ0FBQztBQUNMLENBQUMsQ0FBQztBQUdTLHFCQUFhLEdBQUcsQ0FBQyxPQUFZLEVBQUUsaUJBQXdCO0lBQzlELElBQUksTUFBTSxHQUFHLEtBQUssQ0FBQztJQUNuQixHQUFHLENBQUMsQ0FBQyxJQUFJLE1BQU0sSUFBSSxpQkFBaUIsQ0FBQyxDQUFBLENBQUM7UUFDbEMsRUFBRSxDQUFBLENBQUMsT0FBTyxLQUFLLGlCQUFpQixDQUFDLE1BQU0sQ0FBQyxDQUFDLENBQUEsQ0FBQztZQUN0QyxNQUFNLEdBQUcsSUFBSSxDQUFDO1FBQ2xCLENBQUM7SUFDTCxDQUFDO0lBQ0QsTUFBTSxDQUFDLE1BQU0sQ0FBQztBQUNsQixDQUFDLENBQUE7QUFFVSxlQUFPLEdBQUcsVUFBUyxPQUFZLEVBQUMsVUFBVSxHQUE4QixFQUFDLGlCQUFpQixFQUFDLEVBQUUsRUFBQztJQUNyRyxJQUFJLElBQUksR0FBRyxPQUFPLENBQUMsQ0FBQyxDQUFDLEtBQUssRUFBRSxDQUFDO0lBQzdCLE9BQU8sQ0FBQyxPQUFPLEdBQUcsSUFBSSxDQUFDO0lBQ3ZCLElBQUksQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLGNBQVcsT0FBTyxDQUFDLE9BQU8sR0FBRyxLQUFLLENBQUEsQ0FBQSxDQUFDLENBQUMsQ0FBQztJQUN2RCxJQUFJLGFBQWEsR0FBRyxPQUFPLENBQUMsQ0FBQyxDQUFDLEtBQUssRUFBRSxDQUFDO0lBQ3RDLElBQUksaUJBQXdCLENBQUM7SUFDN0IsRUFBRSxDQUFBLENBQUMsVUFBVSxDQUFDLGlCQUFpQixDQUFDLENBQUEsQ0FBQztRQUM3QixpQkFBaUIsR0FBRyxVQUFVLENBQUMsaUJBQWlCLENBQUM7SUFDckQsQ0FBQztJQUFDLElBQUksQ0FBQyxDQUFDO1FBQ0osaUJBQWlCLEdBQUcsRUFBRSxDQUFDO0lBQzNCLENBQUM7SUFDRCxpQkFBaUIsQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLENBQUM7SUFDaEMsYUFBYSxDQUFDLE9BQU87U0FDaEIsSUFBSSxDQUFDO1FBQ0YsRUFBRSxDQUFBLENBQUMsT0FBTyxDQUFDLE9BQU8sSUFBSSxDQUFDLHFCQUFhLENBQUMsT0FBTyxDQUFDLE9BQU8sRUFBQyxpQkFBaUIsQ0FBQyxDQUFDLENBQUEsQ0FBQztZQUNyRSxNQUFNLENBQUMsZUFBTyxDQUFDLE9BQU8sQ0FBQyxPQUFPLEVBQUMsRUFBQyxpQkFBaUIsRUFBQyxpQkFBaUIsRUFBQyxDQUFDLENBQUE7UUFDekUsQ0FBQztRQUFDLElBQUksQ0FBQyxDQUFDO1lBQ0osSUFBSSxLQUFLLEdBQUcsT0FBTyxDQUFDLENBQUMsQ0FBQyxLQUFLLEVBQUUsQ0FBQztZQUM5QixLQUFLLENBQUMsT0FBTyxFQUFFLENBQUM7WUFDaEIsTUFBTSxDQUFDLEtBQUssQ0FBQyxPQUFPLENBQUM7UUFDekIsQ0FBQztJQUNMLENBQUMsQ0FBQztTQUNELElBQUksQ0FBQztRQUNGLE1BQU0sQ0FBQyxPQUFPLENBQUMsSUFBSSxFQUFFLENBQUM7SUFDMUIsQ0FBQyxDQUFDO1NBQ0QsSUFBSSxDQUFDO1FBQ0YsRUFBRSxDQUFBLENBQUMsT0FBTyxDQUFDLFNBQVMsSUFBSSxDQUFDLHFCQUFhLENBQUMsT0FBTyxDQUFDLFNBQVMsRUFBQyxpQkFBaUIsQ0FBQyxDQUFDLENBQUEsQ0FBQztZQUN6RSxNQUFNLENBQUMsZUFBTyxDQUFDLE9BQU8sQ0FBQyxTQUFTLEVBQUMsRUFBQyxpQkFBaUIsRUFBQyxpQkFBaUIsRUFBQyxDQUFDLENBQUE7UUFDM0UsQ0FBQztRQUFDLElBQUksQ0FBQyxDQUFDO1lBQ0osSUFBSSxLQUFLLEdBQUcsT0FBTyxDQUFDLENBQUMsQ0FBQyxLQUFLLEVBQUUsQ0FBQztZQUM5QixLQUFLLENBQUMsT0FBTyxFQUFFLENBQUM7WUFDaEIsTUFBTSxDQUFDLEtBQUssQ0FBQyxPQUFPLENBQUM7UUFDekIsQ0FBQztJQUNMLENBQUMsQ0FBQztTQUNELElBQUksQ0FBQztRQUNGLElBQUksQ0FBQyxPQUFPLEVBQUUsQ0FBQztJQUNuQixDQUFDLENBQUMsQ0FBQztJQUNQLGFBQWEsQ0FBQyxPQUFPLEVBQUUsQ0FBQztJQUN4QixNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQztBQUN4QixDQUFDLENBQUM7QUFFUyx1QkFBZSxHQUFHLENBQUMsT0FBWTtJQUN0QyxJQUFJLHFCQUFxQixHQUFHO1FBQ3hCLEVBQUUsQ0FBQSxDQUFDLE9BQU8sQ0FBQyxhQUFhLEdBQUcsQ0FBQyxDQUFDLENBQUEsQ0FBQztZQUMxQixPQUFPLENBQUMsZUFBZSxHQUFHLElBQUksQ0FBQztZQUMvQixPQUFPLENBQUMsYUFBYSxFQUFFLENBQUM7WUFDeEIsZUFBTyxDQUFDLE9BQU8sQ0FBQztpQkFDWCxJQUFJLENBQUMscUJBQXFCLENBQUMsQ0FBQztRQUNyQyxDQUFDO1FBQUMsSUFBSSxDQUFDLENBQUM7WUFDSixPQUFPLENBQUMsZUFBZSxHQUFHLEtBQUssQ0FBQztRQUNwQyxDQUFDO0lBQ0wsQ0FBQyxDQUFBO0FBQ0wsQ0FBQyxDQUFDIn0=
|
|
40
dist/taskbuffer.classes.task.d.ts
vendored
40
dist/taskbuffer.classes.task.d.ts
vendored
@@ -1,40 +0,0 @@
|
|||||||
/// <reference types="q" />
|
|
||||||
import * as plugins from "./taskbuffer.plugins";
|
|
||||||
export interface ITaskFunction {
|
|
||||||
(): PromiseLike<any>;
|
|
||||||
}
|
|
||||||
export declare class Task {
|
|
||||||
name: string;
|
|
||||||
task: any;
|
|
||||||
running: boolean;
|
|
||||||
runningBuffered: boolean;
|
|
||||||
idle: boolean;
|
|
||||||
buffered: boolean;
|
|
||||||
bufferCounter: number;
|
|
||||||
bufferMax: number;
|
|
||||||
private _counterTriggerAbsolute;
|
|
||||||
private _state;
|
|
||||||
preTask: Task;
|
|
||||||
afterTask: Task;
|
|
||||||
constructor(optionsArg: {
|
|
||||||
taskFunction: ITaskFunction;
|
|
||||||
preTask?: Task;
|
|
||||||
afterTask?: Task;
|
|
||||||
buffered?: boolean;
|
|
||||||
bufferMax?: number;
|
|
||||||
name?: string;
|
|
||||||
});
|
|
||||||
/**
|
|
||||||
* trigger the task. Will trigger buffered if this.buffered is true
|
|
||||||
*/
|
|
||||||
trigger(): plugins.Q.Promise<{}>;
|
|
||||||
/**
|
|
||||||
* trigger task unbuffered.
|
|
||||||
*/
|
|
||||||
triggerUnBuffered(): plugins.Q.Promise<{}>;
|
|
||||||
/**
|
|
||||||
* trigger task buffered.
|
|
||||||
*/
|
|
||||||
triggerBuffered(): plugins.Q.Promise<{}>;
|
|
||||||
state: string;
|
|
||||||
}
|
|
73
dist/taskbuffer.classes.task.js
vendored
73
dist/taskbuffer.classes.task.js
vendored
@@ -1,73 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
const plugins = require("./taskbuffer.plugins");
|
|
||||||
const helpers = require("./taskbuffer.classes.helpers");
|
|
||||||
class Task {
|
|
||||||
constructor(optionsArg) {
|
|
||||||
this.running = false;
|
|
||||||
this.runningBuffered = false;
|
|
||||||
this.idle = true;
|
|
||||||
this.buffered = false;
|
|
||||||
this.bufferMax = 1;
|
|
||||||
this._counterTriggerAbsolute = 0;
|
|
||||||
var options = optionsArg;
|
|
||||||
this.task = optionsArg.taskFunction;
|
|
||||||
this.preTask = options.preTask;
|
|
||||||
this.afterTask = options.afterTask;
|
|
||||||
this.running = false;
|
|
||||||
this.idle = !this.running && !this.runningBuffered;
|
|
||||||
this.buffered = options.buffered;
|
|
||||||
this.bufferMax = options.bufferMax;
|
|
||||||
this.name = options.name;
|
|
||||||
}
|
|
||||||
/**
|
|
||||||
* trigger the task. Will trigger buffered if this.buffered is true
|
|
||||||
*/
|
|
||||||
trigger() {
|
|
||||||
let done = plugins.Q.defer();
|
|
||||||
if (this.buffered) {
|
|
||||||
this.triggerBuffered()
|
|
||||||
.then(done.resolve);
|
|
||||||
}
|
|
||||||
else {
|
|
||||||
this.triggerUnBuffered()
|
|
||||||
.then(done.resolve);
|
|
||||||
}
|
|
||||||
;
|
|
||||||
return done.promise;
|
|
||||||
}
|
|
||||||
;
|
|
||||||
/**
|
|
||||||
* trigger task unbuffered.
|
|
||||||
*/
|
|
||||||
triggerUnBuffered() {
|
|
||||||
return helpers.runTask(this);
|
|
||||||
}
|
|
||||||
/**
|
|
||||||
* trigger task buffered.
|
|
||||||
*/
|
|
||||||
triggerBuffered() {
|
|
||||||
var done = plugins.Q.defer();
|
|
||||||
if (!(this.bufferCounter >= this.bufferMax)) {
|
|
||||||
this.bufferCounter++;
|
|
||||||
}
|
|
||||||
;
|
|
||||||
if (!this.runningBuffered) {
|
|
||||||
helpers.runBufferedTask(this);
|
|
||||||
}
|
|
||||||
;
|
|
||||||
return done.promise;
|
|
||||||
}
|
|
||||||
get state() {
|
|
||||||
return this._state;
|
|
||||||
}
|
|
||||||
set state(stateArg) {
|
|
||||||
if (stateArg == "locked") {
|
|
||||||
this._state = "locked";
|
|
||||||
}
|
|
||||||
else {
|
|
||||||
plugins.beautylog.error("state type " + stateArg.blue + " could not be set");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
exports.Task = Task;
|
|
||||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGFza2J1ZmZlci5jbGFzc2VzLnRhc2suanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy90YXNrYnVmZmVyLmNsYXNzZXMudGFzay50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsTUFBWSxPQUFPLFdBQU0sc0JBQ3pCLENBQUMsQ0FEOEM7QUFDL0MsTUFBWSxPQUFPLFdBQU0sOEJBR3pCLENBQUMsQ0FIc0Q7QUFPdkQ7SUFjSSxZQUFZLFVBT1g7UUFsQkQsWUFBTyxHQUFXLEtBQUssQ0FBQztRQUN4QixvQkFBZSxHQUFXLEtBQUssQ0FBQztRQUNoQyxTQUFJLEdBQVcsSUFBSSxDQUFDO1FBQ3BCLGFBQVEsR0FBVyxLQUFLLENBQUM7UUFFekIsY0FBUyxHQUFVLENBQUMsQ0FBQztRQUNiLDRCQUF1QixHQUFVLENBQUMsQ0FBQztRQWF2QyxJQUFJLE9BQU8sR0FBRyxVQUFVLENBQUM7UUFDekIsSUFBSSxDQUFDLElBQUksR0FBRyxVQUFVLENBQUMsWUFBWSxDQUFDO1FBQ3BDLElBQUksQ0FBQyxPQUFPLEdBQUcsT0FBTyxDQUFDLE9BQU8sQ0FBQztRQUMvQixJQUFJLENBQUMsU0FBUyxHQUFHLE9BQU8sQ0FBQyxTQUFTLENBQUM7UUFDbkMsSUFBSSxDQUFDLE9BQU8sR0FBRyxLQUFLLENBQUM7UUFDckIsSUFBSSxDQUFDLElBQUksR0FBRyxDQUFDLElBQUksQ0FBQyxPQUFPLElBQUksQ0FBQyxJQUFJLENBQUMsZUFBZSxDQUFDO1FBQ25ELElBQUksQ0FBQyxRQUFRLEdBQUcsT0FBTyxDQUFDLFFBQVEsQ0FBQztRQUNqQyxJQUFJLENBQUMsU0FBUyxHQUFHLE9BQU8sQ0FBQyxTQUFTLENBQUM7UUFDbkMsSUFBSSxDQUFDLElBQUksR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDO0lBQzdCLENBQUM7SUFFRDs7T0FFRztJQUNILE9BQU87UUFDSCxJQUFJLElBQUksR0FBRyxPQUFPLENBQUMsQ0FBQyxDQUFDLEtBQUssRUFBRSxDQUFDO1FBQzdCLEVBQUUsQ0FBQSxDQUFDLElBQUksQ0FBQyxRQUFRLENBQUMsQ0FBQyxDQUFDO1lBQ2YsSUFBSSxDQUFDLGVBQWUsRUFBRTtpQkFDakIsSUFBSSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsQ0FBQztRQUM1QixDQUFDO1FBQ0QsSUFBSSxDQUFDLENBQUM7WUFDRixJQUFJLENBQUMsaUJBQWlCLEVBQUU7aUJBQ25CLElBQUksQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLENBQUM7UUFDNUIsQ0FBQztRQUFBLENBQUM7UUFDRixNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQztJQUN4QixDQUFDOztJQUVEOztPQUVHO0lBQ0gsaUJBQWlCO1FBQ2IsTUFBTSxDQUFDLE9BQU8sQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLENBQUM7SUFDakMsQ0FBQztJQUVEOztPQUVHO0lBQ0gsZUFBZTtRQUNYLElBQUksSUFBSSxHQUFHLE9BQU8sQ0FBQyxDQUFDLENBQUMsS0FBSyxFQUFFLENBQUM7UUFDN0IsRUFBRSxDQUFBLENBQUMsQ0FBQyxDQUFDLElBQUksQ0FBQyxhQUFhLElBQUksSUFBSSxDQUFDLFNBQVMsQ0FBQyxDQUFDLENBQUEsQ0FBQztZQUN4QyxJQUFJLENBQUMsYUFBYSxFQUFFLENBQUE7UUFDeEIsQ0FBQztRQUFBLENBQUM7UUFDRixFQUFFLENBQUEsQ0FBQyxDQUFDLElBQUksQ0FBQyxlQUFlLENBQUMsQ0FBQSxDQUFDO1lBQ3RCLE9BQU8sQ0FBQyxlQUFlLENBQUMsSUFBSSxDQUFDLENBQUM7UUFDbEMsQ0FBQztRQUFBLENBQUM7UUFDRixNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQztJQUN4QixDQUFDO0lBRUQsSUFBSSxLQUFLO1FBQ0wsTUFBTSxDQUFDLElBQUksQ0FBQyxNQUFNLENBQUM7SUFDdkIsQ0FBQztJQUNELElBQUksS0FBSyxDQUFDLFFBQWU7UUFDckIsRUFBRSxDQUFDLENBQUMsUUFBUSxJQUFJLFFBQVEsQ0FBQyxDQUFBLENBQUM7WUFDdEIsSUFBSSxDQUFDLE1BQU0sR0FBRyxRQUFRLENBQUM7UUFDM0IsQ0FBQztRQUFDLElBQUksQ0FBQyxDQUFDO1lBQ0osT0FBTyxDQUFDLFNBQVMsQ0FBQyxLQUFLLENBQUMsYUFBYSxHQUFHLFFBQVEsQ0FBQyxJQUFJLEdBQUcsbUJBQW1CLENBQUMsQ0FBQztRQUNqRixDQUFDO0lBQ0wsQ0FBQztBQUNMLENBQUM7QUFoRlksWUFBSSxPQWdGaEIsQ0FBQSJ9
|
|
14
dist/taskbuffer.classes.taskchain.d.ts
vendored
14
dist/taskbuffer.classes.taskchain.d.ts
vendored
@@ -1,14 +0,0 @@
|
|||||||
import { Task } from "./taskbuffer.classes.task";
|
|
||||||
export declare class Taskchain extends Task {
|
|
||||||
taskArray: Task[];
|
|
||||||
private _oraObject;
|
|
||||||
constructor(optionsArg: {
|
|
||||||
name?: string;
|
|
||||||
log?: boolean;
|
|
||||||
taskArray: Task[];
|
|
||||||
});
|
|
||||||
addTask(taskArg: Task): void;
|
|
||||||
removeTask(taskArg: Task): void;
|
|
||||||
shiftTask(): void;
|
|
||||||
trigger(): any;
|
|
||||||
}
|
|
59
dist/taskbuffer.classes.taskchain.js
vendored
59
dist/taskbuffer.classes.taskchain.js
vendored
@@ -1,59 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
const plugins = require("./taskbuffer.plugins");
|
|
||||||
const taskbuffer_classes_task_1 = require("./taskbuffer.classes.task");
|
|
||||||
const helpers = require("./taskbuffer.classes.helpers");
|
|
||||||
class Taskchain extends taskbuffer_classes_task_1.Task {
|
|
||||||
constructor(optionsArg) {
|
|
||||||
let options = plugins.lodash.merge({
|
|
||||||
name: "unnamed Taskchain",
|
|
||||||
log: false
|
|
||||||
}, optionsArg, {
|
|
||||||
taskFunction: () => {
|
|
||||||
let done = plugins.Q.defer(); // this is the starting Deferred object
|
|
||||||
let taskCounter = 0;
|
|
||||||
let iterateTasks = () => {
|
|
||||||
if (typeof this.taskArray[taskCounter] != "undefined") {
|
|
||||||
this._oraObject.text(this.name + " running: Task" + this.taskArray[taskCounter].name);
|
|
||||||
this.taskArray[taskCounter].trigger()
|
|
||||||
.then(() => {
|
|
||||||
plugins.beautylog.ok(this.taskArray[taskCounter].name);
|
|
||||||
taskCounter++;
|
|
||||||
iterateTasks();
|
|
||||||
});
|
|
||||||
}
|
|
||||||
else {
|
|
||||||
this._oraObject.endOk("Taskchain \"" + this.name + "\" completed successfully");
|
|
||||||
done.resolve();
|
|
||||||
}
|
|
||||||
};
|
|
||||||
iterateTasks();
|
|
||||||
return done.promise;
|
|
||||||
}
|
|
||||||
});
|
|
||||||
super(options);
|
|
||||||
this.taskArray = optionsArg.taskArray;
|
|
||||||
this._oraObject = new plugins.beautylog.Ora("Taskchain idle", "blue");
|
|
||||||
if (optionsArg.log === true) {
|
|
||||||
this._oraObject.start();
|
|
||||||
}
|
|
||||||
;
|
|
||||||
}
|
|
||||||
addTask(taskArg) {
|
|
||||||
this.taskArray.push(taskArg);
|
|
||||||
}
|
|
||||||
;
|
|
||||||
removeTask(taskArg) {
|
|
||||||
//TODO
|
|
||||||
}
|
|
||||||
;
|
|
||||||
shiftTask() {
|
|
||||||
}
|
|
||||||
;
|
|
||||||
trigger() {
|
|
||||||
this._oraObject.start(this.name + " running...");
|
|
||||||
return helpers.runTask(this);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
exports.Taskchain = Taskchain;
|
|
||||||
;
|
|
||||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGFza2J1ZmZlci5jbGFzc2VzLnRhc2tjaGFpbi5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3Rhc2tidWZmZXIuY2xhc3Nlcy50YXNrY2hhaW4udHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLE1BQVksT0FBTyxXQUFNLHNCQUFzQixDQUFDLENBQUE7QUFDaEQsMENBQW1CLDJCQUEyQixDQUFDLENBQUE7QUFDL0MsTUFBTyxPQUFPLFdBQVcsOEJBQThCLENBQUMsQ0FBQztBQUV6RCx3QkFBK0IsOEJBQUk7SUFHL0IsWUFBWSxVQUlYO1FBQ0csSUFBSSxPQUFPLEdBQUcsT0FBTyxDQUFDLE1BQU0sQ0FBQyxLQUFLLENBQzlCO1lBQ0ksSUFBSSxFQUFDLG1CQUFtQjtZQUN4QixHQUFHLEVBQUMsS0FBSztTQUNaLEVBQ0QsVUFBVSxFQUNWO1lBQ0ksWUFBWSxFQUFFO2dCQUNWLElBQUksSUFBSSxHQUFHLE9BQU8sQ0FBQyxDQUFDLENBQUMsS0FBSyxFQUFFLENBQUMsQ0FBQyx3Q0FBd0M7Z0JBQ3RFLElBQUksV0FBVyxHQUFHLENBQUMsQ0FBQztnQkFDcEIsSUFBSSxZQUFZLEdBQUc7b0JBQ2YsRUFBRSxDQUFBLENBQUMsT0FBTyxJQUFJLENBQUMsU0FBUyxDQUFDLFdBQVcsQ0FBQyxJQUFJLFdBQVcsQ0FBQyxDQUFBLENBQUM7d0JBQ2xELElBQUksQ0FBQyxVQUFVLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxJQUFJLEdBQUcsZ0JBQWdCLEdBQUcsSUFBSSxDQUFDLFNBQVMsQ0FBQyxXQUFXLENBQUMsQ0FBQyxJQUFJLENBQUMsQ0FBQzt3QkFDdEYsSUFBSSxDQUFDLFNBQVMsQ0FBQyxXQUFXLENBQUMsQ0FBQyxPQUFPLEVBQUU7NkJBQ2hDLElBQUksQ0FBQzs0QkFDRixPQUFPLENBQUMsU0FBUyxDQUFDLEVBQUUsQ0FBQyxJQUFJLENBQUMsU0FBUyxDQUFDLFdBQVcsQ0FBQyxDQUFDLElBQUksQ0FBQyxDQUFDOzRCQUN2RCxXQUFXLEVBQUUsQ0FBQzs0QkFDZCxZQUFZLEVBQUUsQ0FBQzt3QkFDbkIsQ0FBQyxDQUFDLENBQUM7b0JBQ1gsQ0FBQztvQkFBQyxJQUFJLENBQUMsQ0FBQzt3QkFDSixJQUFJLENBQUMsVUFBVSxDQUFDLEtBQUssQ0FBQyxjQUFjLEdBQUcsSUFBSSxDQUFDLElBQUksR0FBSSwyQkFBMkIsQ0FBQyxDQUFDO3dCQUNqRixJQUFJLENBQUMsT0FBTyxFQUFFLENBQUM7b0JBQ25CLENBQUM7Z0JBQ0wsQ0FBQyxDQUFDO2dCQUNGLFlBQVksRUFBRSxDQUFDO2dCQUNmLE1BQU0sQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDO1lBQ3hCLENBQUM7U0FDSixDQUNKLENBQUM7UUFDRixNQUFNLE9BQU8sQ0FBQyxDQUFDO1FBQ2YsSUFBSSxDQUFDLFNBQVMsR0FBRyxVQUFVLENBQUMsU0FBUyxDQUFDO1FBQ3RDLElBQUksQ0FBQyxVQUFVLEdBQUcsSUFBSSxPQUFPLENBQUMsU0FBUyxDQUFDLEdBQUcsQ0FBQyxnQkFBZ0IsRUFBQyxNQUFNLENBQUMsQ0FBQztRQUNyRSxFQUFFLENBQUEsQ0FBQyxVQUFVLENBQUMsR0FBRyxLQUFLLElBQUksQ0FBQyxDQUFBLENBQUM7WUFDeEIsSUFBSSxDQUFDLFVBQVUsQ0FBQyxLQUFLLEVBQUUsQ0FBQztRQUM1QixDQUFDO1FBQUEsQ0FBQztJQUNOLENBQUM7SUFDRCxPQUFPLENBQUMsT0FBWTtRQUNoQixJQUFJLENBQUMsU0FBUyxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsQ0FBQztJQUNqQyxDQUFDOztJQUNELFVBQVUsQ0FBQyxPQUFZO1FBQ25CLE1BQU07SUFDVixDQUFDOztJQUNELFNBQVM7SUFFVCxDQUFDOztJQUNELE9BQU87UUFDSCxJQUFJLENBQUMsVUFBVSxDQUFDLEtBQUssQ0FBQyxJQUFJLENBQUMsSUFBSSxHQUFHLGFBQWEsQ0FBQyxDQUFDO1FBQ2pELE1BQU0sQ0FBQyxPQUFPLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFDO0lBQ2pDLENBQUM7QUFDTCxDQUFDO0FBekRZLGlCQUFTLFlBeURyQixDQUFBO0FBQUEsQ0FBQyJ9
|
|
7
dist/taskbuffer.classes.taskparallel.d.ts
vendored
7
dist/taskbuffer.classes.taskparallel.d.ts
vendored
@@ -1,7 +0,0 @@
|
|||||||
import { Task } from "./taskbuffer.classes.task";
|
|
||||||
export declare class Taskparallel extends Task {
|
|
||||||
taskArray: Task[];
|
|
||||||
constructor(optionsArg: {
|
|
||||||
taskArray: Task[];
|
|
||||||
});
|
|
||||||
}
|
|
23
dist/taskbuffer.classes.taskparallel.js
vendored
23
dist/taskbuffer.classes.taskparallel.js
vendored
@@ -1,23 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
const plugins = require("./taskbuffer.plugins");
|
|
||||||
const taskbuffer_classes_task_1 = require("./taskbuffer.classes.task");
|
|
||||||
class Taskparallel extends taskbuffer_classes_task_1.Task {
|
|
||||||
constructor(optionsArg) {
|
|
||||||
let options = plugins.lodash.merge(optionsArg, {
|
|
||||||
taskFunction: () => {
|
|
||||||
let done = plugins.Q.defer();
|
|
||||||
let promiseArray = []; // stores promises of all tasks, since they run in parallel
|
|
||||||
this.taskArray.forEach(function (taskArg) {
|
|
||||||
promiseArray.push(taskArg.trigger());
|
|
||||||
});
|
|
||||||
plugins.Q.all(promiseArray)
|
|
||||||
.then(done.resolve);
|
|
||||||
return done.promise;
|
|
||||||
}
|
|
||||||
});
|
|
||||||
super(options);
|
|
||||||
this.taskArray = optionsArg.taskArray;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
exports.Taskparallel = Taskparallel;
|
|
||||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGFza2J1ZmZlci5jbGFzc2VzLnRhc2twYXJhbGxlbC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3Rhc2tidWZmZXIuY2xhc3Nlcy50YXNrcGFyYWxsZWwudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLE1BQVksT0FBTyxXQUFNLHNCQUN6QixDQUFDLENBRDhDO0FBRS9DLDBDQUFxQiwyQkFFckIsQ0FBQyxDQUYrQztBQUVoRCwyQkFBa0MsOEJBQUk7SUFFbEMsWUFBWSxVQUVYO1FBQ0csSUFBSSxPQUFPLEdBQUcsT0FBTyxDQUFDLE1BQU0sQ0FBQyxLQUFLLENBQzlCLFVBQVUsRUFDVjtZQUNJLFlBQVksRUFBRTtnQkFDVixJQUFJLElBQUksR0FBRyxPQUFPLENBQUMsQ0FBQyxDQUFDLEtBQUssRUFBRSxDQUFDO2dCQUM3QixJQUFJLFlBQVksR0FBc0IsRUFBRSxDQUFDLENBQUMsMkRBQTJEO2dCQUNyRyxJQUFJLENBQUMsU0FBUyxDQUFDLE9BQU8sQ0FBQyxVQUFVLE9BQU87b0JBQ3BDLFlBQVksQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLE9BQU8sRUFBRSxDQUFDLENBQUM7Z0JBQ3pDLENBQUMsQ0FBQyxDQUFBO2dCQUNGLE9BQU8sQ0FBQyxDQUFDLENBQUMsR0FBRyxDQUFDLFlBQVksQ0FBQztxQkFDdEIsSUFBSSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsQ0FBQztnQkFDeEIsTUFBTSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUM7WUFDeEIsQ0FBQztTQUNKLENBQ0osQ0FBQztRQUNGLE1BQU0sT0FBTyxDQUFDLENBQUM7UUFDZixJQUFJLENBQUMsU0FBUyxHQUFHLFVBQVUsQ0FBQyxTQUFTLENBQUM7SUFDMUMsQ0FBQztBQUNMLENBQUM7QUF2Qlksb0JBQVksZUF1QnhCLENBQUEifQ==
|
|
2
dist/taskbuffer.classes.taskspace.d.ts
vendored
2
dist/taskbuffer.classes.taskspace.d.ts
vendored
@@ -1,2 +0,0 @@
|
|||||||
export declare class Taskspace {
|
|
||||||
}
|
|
5
dist/taskbuffer.classes.taskspace.js
vendored
5
dist/taskbuffer.classes.taskspace.js
vendored
@@ -1,5 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
class Taskspace {
|
|
||||||
}
|
|
||||||
exports.Taskspace = Taskspace;
|
|
||||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGFza2J1ZmZlci5jbGFzc2VzLnRhc2tzcGFjZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3Rhc2tidWZmZXIuY2xhc3Nlcy50YXNrc3BhY2UudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUdBO0FBRUEsQ0FBQztBQUZZLGlCQUFTLFlBRXJCLENBQUEifQ==
|
|
5
dist/taskbuffer.plugins.d.ts
vendored
5
dist/taskbuffer.plugins.d.ts
vendored
@@ -1,5 +0,0 @@
|
|||||||
import "typings-global";
|
|
||||||
export import beautylog = require("beautylog");
|
|
||||||
export import Q = require("q");
|
|
||||||
export import lodash = require("lodash");
|
|
||||||
export import rxjs = require("rxjs");
|
|
7
dist/taskbuffer.plugins.js
vendored
7
dist/taskbuffer.plugins.js
vendored
@@ -1,7 +0,0 @@
|
|||||||
"use strict";
|
|
||||||
require("typings-global");
|
|
||||||
exports.beautylog = require("beautylog");
|
|
||||||
exports.Q = require("q");
|
|
||||||
exports.lodash = require("lodash");
|
|
||||||
exports.rxjs = require("rxjs");
|
|
||||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGFza2J1ZmZlci5wbHVnaW5zLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvdGFza2J1ZmZlci5wbHVnaW5zLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQSxRQUFPLGdCQUNQLENBQUMsQ0FEc0I7QUFDVCxpQkFBUyxXQUFXLFdBQVcsQ0FBQyxDQUFDO0FBQ2pDLFNBQUMsV0FBVyxHQUFHLENBQUMsQ0FBQztBQUNqQixjQUFNLFdBQVUsUUFBUSxDQUFDLENBQUM7QUFDMUIsWUFBSSxXQUFXLE1BQU0sQ0FBQyxDQUFDIn0=
|
|
@@ -1,5 +1,33 @@
|
|||||||
{
|
{
|
||||||
"npmts":{
|
"npmci": {
|
||||||
"mode":"default"
|
"npmGlobalTools": [],
|
||||||
|
"npmAccessLevel": "public",
|
||||||
|
"npmRegistryUrl": "registry.npmjs.org"
|
||||||
|
},
|
||||||
|
"gitzone": {
|
||||||
|
"projectType": "npm",
|
||||||
|
"module": {
|
||||||
|
"githost": "code.foss.global",
|
||||||
|
"gitscope": "push.rocks",
|
||||||
|
"gitrepo": "taskbuffer",
|
||||||
|
"description": "A flexible task management library supporting TypeScript, allowing for task buffering, scheduling, and execution with dependency management.",
|
||||||
|
"npmPackagename": "@push.rocks/taskbuffer",
|
||||||
|
"license": "MIT",
|
||||||
|
"keywords": [
|
||||||
|
"task management",
|
||||||
|
"TypeScript",
|
||||||
|
"task buffering",
|
||||||
|
"task scheduling",
|
||||||
|
"task execution",
|
||||||
|
"task dependencies",
|
||||||
|
"parallel tasks",
|
||||||
|
"task chains",
|
||||||
|
"debounced tasks",
|
||||||
|
"distributed coordination"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"tsdoc": {
|
||||||
|
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
|
||||||
}
|
}
|
||||||
}
|
}
|
76
package.json
76
package.json
@@ -1,40 +1,68 @@
|
|||||||
{
|
{
|
||||||
"name": "taskbuffer",
|
"name": "@push.rocks/taskbuffer",
|
||||||
"version": "1.0.1",
|
"version": "3.1.8",
|
||||||
"description": "Flexible task organization for gulp. TypeScript ready!",
|
"private": false,
|
||||||
"main": "dist/index.js",
|
"description": "A flexible task management library supporting TypeScript, allowing for task buffering, scheduling, and execution with dependency management.",
|
||||||
"typings": "dist/index.d.ts",
|
"main": "dist_ts/index.js",
|
||||||
|
"typings": "dist_ts/index.d.ts",
|
||||||
|
"type": "module",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"test": "(npmts)"
|
"test": "(tstest test/ --verbose --logfile --timeout 120)",
|
||||||
|
"build": "(tsbuild --web && tsbundle npm)",
|
||||||
|
"buildDocs": "tsdoc"
|
||||||
},
|
},
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "git+https://github.com/pushrocks/taskbuffer.git"
|
"url": "https://code.foss.global/push.rocks/taskbuffer.git"
|
||||||
},
|
},
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"gulp",
|
"task management",
|
||||||
"tasks",
|
"TypeScript",
|
||||||
"watch",
|
"task buffering",
|
||||||
"buffer"
|
"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://github.com/pushrocks/taskbuffer/issues"
|
"url": "https://gitlab.com/pushrocks/taskbuffer/issues"
|
||||||
},
|
},
|
||||||
"homepage": "https://github.com/pushrocks/taskbuffer#readme",
|
"homepage": "https://code.foss.global/push.rocks/taskbuffer",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@types/lodash": "^0.0.28",
|
"@push.rocks/lik": "^6.0.5",
|
||||||
"@types/q": "^0.0.27",
|
"@push.rocks/smartdelay": "^3.0.5",
|
||||||
"beautylog": "^5.0.18",
|
"@push.rocks/smartlog": "^3.0.3",
|
||||||
"lodash": "^4.14.1",
|
"@push.rocks/smartpromise": "^4.0.3",
|
||||||
"q": "^1.4.1",
|
"@push.rocks/smartrx": "^3.0.6",
|
||||||
"rxjs": "^5.0.0-beta.10",
|
"@push.rocks/smarttime": "^4.0.6",
|
||||||
"typings-global": "^1.0.6"
|
"@push.rocks/smartunique": "^3.0.6"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"npmts-g": "^5.2.8",
|
"@git.zone/tsbuild": "^2.1.66",
|
||||||
"should": "^10.0.0",
|
"@git.zone/tsbundle": "^2.0.8",
|
||||||
"typings-test": "^1.0.1"
|
"@git.zone/tsrun": "^1.2.44",
|
||||||
}
|
"@git.zone/tstest": "^2.3.5",
|
||||||
|
"@types/node": "^20.8.7"
|
||||||
|
},
|
||||||
|
"files": [
|
||||||
|
"ts/**/*",
|
||||||
|
"ts_web/**/*",
|
||||||
|
"dist/**/*",
|
||||||
|
"dist_*/**/*",
|
||||||
|
"dist_ts/**/*",
|
||||||
|
"dist_ts_web/**/*",
|
||||||
|
"assets/**/*",
|
||||||
|
"cli.js",
|
||||||
|
"npmextra.json",
|
||||||
|
"readme.md"
|
||||||
|
],
|
||||||
|
"browserslist": [
|
||||||
|
"last 1 chrome versions"
|
||||||
|
],
|
||||||
|
"packageManager": "pnpm@10.14.0+sha512.ad27a79641b49c3e481a16a805baa71817a04bbe06a38d17e60e2eaee83f6a146c6a688125f5792e48dd5ba30e7da52a5cda4c3992b9ccf333f9ce223af84748"
|
||||||
}
|
}
|
||||||
|
8314
pnpm-lock.yaml
generated
Normal file
8314
pnpm-lock.yaml
generated
Normal file
File diff suppressed because it is too large
Load Diff
1
readme.hints.md
Normal file
1
readme.hints.md
Normal file
@@ -0,0 +1 @@
|
|||||||
|
|
494
readme.md
Normal file
494
readme.md
Normal file
@@ -0,0 +1,494 @@
|
|||||||
|
# @push.rocks/taskbuffer 🚀
|
||||||
|
|
||||||
|
A **powerful**, **flexible**, and **TypeScript-first** task management library for orchestrating asynchronous operations with style. From simple task execution to complex distributed workflows, taskbuffer has got you covered.
|
||||||
|
|
||||||
|
## Install 📦
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm install @push.rocks/taskbuffer --save
|
||||||
|
```
|
||||||
|
|
||||||
|
Or with **pnpm** (recommended):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pnpm add @push.rocks/taskbuffer
|
||||||
|
```
|
||||||
|
|
||||||
|
## Why taskbuffer? 🤔
|
||||||
|
|
||||||
|
In the modern JavaScript ecosystem, managing asynchronous tasks efficiently is crucial. Whether you're building a data pipeline, managing API rate limits, or orchestrating complex workflows, **@push.rocks/taskbuffer** provides the tools you need:
|
||||||
|
|
||||||
|
- **🎯 TypeScript-first**: Built with TypeScript for TypeScript - enjoy complete type safety and excellent IDE support
|
||||||
|
- **⚡ Flexible execution**: From simple tasks to complex parallel workflows with dependencies
|
||||||
|
- **🔄 Smart buffering**: Control concurrent executions with intelligent buffer management
|
||||||
|
- **⏰ Built-in scheduling**: Cron-based task scheduling without additional dependencies
|
||||||
|
- **🎭 Multiple paradigms**: Support for debounced, throttled, and one-time execution patterns
|
||||||
|
- **🔌 Extensible**: Clean architecture that's easy to extend and customize
|
||||||
|
- **🏃 Zero dependencies on external schedulers**: Everything you need is included
|
||||||
|
|
||||||
|
## Core Concepts 🎓
|
||||||
|
|
||||||
|
### Task
|
||||||
|
The fundamental unit of work. A task wraps an asynchronous function and provides powerful execution control.
|
||||||
|
|
||||||
|
### Taskchain
|
||||||
|
Sequential task execution - tasks run one after another, with results passed along the chain.
|
||||||
|
|
||||||
|
### Taskparallel
|
||||||
|
Parallel task execution - multiple tasks run simultaneously for maximum performance.
|
||||||
|
|
||||||
|
### TaskManager
|
||||||
|
Centralized task scheduling and management using cron expressions.
|
||||||
|
|
||||||
|
### TaskDebounced
|
||||||
|
Debounced task execution - prevents rapid repeated executions, only running after a quiet period.
|
||||||
|
|
||||||
|
### TaskOnce
|
||||||
|
Singleton task execution - ensures a task runs exactly once, perfect for initialization routines.
|
||||||
|
|
||||||
|
## Quick Start 🏁
|
||||||
|
|
||||||
|
### Basic Task Execution
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { Task } from '@push.rocks/taskbuffer';
|
||||||
|
|
||||||
|
// Create a simple task
|
||||||
|
const myTask = new Task({
|
||||||
|
name: 'DataProcessor',
|
||||||
|
taskFunction: async () => {
|
||||||
|
const data = await fetchData();
|
||||||
|
return processData(data);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// Execute the task
|
||||||
|
const result = await myTask.trigger();
|
||||||
|
```
|
||||||
|
|
||||||
|
### Buffered Execution (Rate Limiting)
|
||||||
|
|
||||||
|
Perfect for API calls or database operations that need throttling:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const apiTask = new Task({
|
||||||
|
name: 'APICall',
|
||||||
|
taskFunction: async (endpoint: string) => {
|
||||||
|
return await fetch(endpoint);
|
||||||
|
},
|
||||||
|
buffered: true,
|
||||||
|
bufferMax: 3, // Maximum 3 concurrent executions
|
||||||
|
execDelay: 1000 // Wait 1 second between executions
|
||||||
|
});
|
||||||
|
|
||||||
|
// These will be automatically throttled
|
||||||
|
for (let i = 0; i < 10; i++) {
|
||||||
|
apiTask.trigger(`/api/data/${i}`);
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Task Chains - Sequential Workflows
|
||||||
|
|
||||||
|
Build complex workflows where each step depends on the previous:
|
||||||
|
|
||||||
|
```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,
|
||||||
|
processed: true,
|
||||||
|
timestamp: Date.now()
|
||||||
|
}));
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
const saveTask = new Task({
|
||||||
|
name: 'SaveData',
|
||||||
|
taskFunction: async (transformedData) => {
|
||||||
|
await database.bulkInsert(transformedData);
|
||||||
|
return { saved: transformedData.length };
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
const workflow = new Taskchain({
|
||||||
|
name: 'DataPipeline',
|
||||||
|
taskArray: [fetchTask, transformTask, saveTask]
|
||||||
|
});
|
||||||
|
|
||||||
|
// Execute the entire chain
|
||||||
|
const result = await workflow.trigger();
|
||||||
|
console.log(`Processed ${result.saved} items`);
|
||||||
|
```
|
||||||
|
|
||||||
|
### Parallel Execution - Maximum Performance
|
||||||
|
|
||||||
|
Execute multiple independent tasks simultaneously:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { Task, Taskparallel } from '@push.rocks/taskbuffer';
|
||||||
|
|
||||||
|
const tasks = ['user', 'posts', 'comments'].map(resource =>
|
||||||
|
new Task({
|
||||||
|
name: `Fetch${resource}`,
|
||||||
|
taskFunction: async () => {
|
||||||
|
const data = await fetch(`/api/${resource}`);
|
||||||
|
return data.json();
|
||||||
|
}
|
||||||
|
})
|
||||||
|
);
|
||||||
|
|
||||||
|
const parallelFetch = new Taskparallel({
|
||||||
|
taskArray: tasks
|
||||||
|
});
|
||||||
|
|
||||||
|
// All tasks execute simultaneously
|
||||||
|
const [users, posts, comments] = await parallelFetch.trigger();
|
||||||
|
```
|
||||||
|
|
||||||
|
### Scheduled Tasks with TaskManager
|
||||||
|
|
||||||
|
Run tasks on a schedule using cron expressions:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { Task, TaskManager } from '@push.rocks/taskbuffer';
|
||||||
|
|
||||||
|
const backupTask = new Task({
|
||||||
|
name: 'DatabaseBackup',
|
||||||
|
taskFunction: async () => {
|
||||||
|
await performBackup();
|
||||||
|
console.log(`Backup completed at ${new Date().toISOString()}`);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
const manager = new TaskManager();
|
||||||
|
|
||||||
|
// Add and schedule tasks
|
||||||
|
manager.addAndScheduleTask(backupTask, '0 0 * * *'); // Daily at midnight
|
||||||
|
manager.addAndScheduleTask(healthCheck, '*/5 * * * *'); // Every 5 minutes
|
||||||
|
|
||||||
|
// Start the scheduler
|
||||||
|
manager.start();
|
||||||
|
|
||||||
|
// Later... stop if needed
|
||||||
|
manager.stop();
|
||||||
|
```
|
||||||
|
|
||||||
|
### Debounced Tasks - Smart Throttling
|
||||||
|
|
||||||
|
Prevent task spam with intelligent debouncing:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { TaskDebounced } from '@push.rocks/taskbuffer';
|
||||||
|
|
||||||
|
const saveTask = new TaskDebounced({
|
||||||
|
name: 'AutoSave',
|
||||||
|
taskFunction: async (content: string) => {
|
||||||
|
await saveToDatabase(content);
|
||||||
|
console.log('Content saved');
|
||||||
|
},
|
||||||
|
debounceTimeInMillis: 2000 // Wait 2 seconds of inactivity
|
||||||
|
});
|
||||||
|
|
||||||
|
// Rapid calls will be debounced
|
||||||
|
input.addEventListener('input', (e) => {
|
||||||
|
saveTask.trigger(e.target.value);
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
### One-Time Tasks - Initialize Once
|
||||||
|
|
||||||
|
Ensure initialization code runs exactly once:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { TaskOnce } from '@push.rocks/taskbuffer';
|
||||||
|
|
||||||
|
const initTask = new TaskOnce({
|
||||||
|
name: 'SystemInitialization',
|
||||||
|
taskFunction: async () => {
|
||||||
|
await database.connect();
|
||||||
|
await cache.initialize();
|
||||||
|
await loadConfiguration();
|
||||||
|
console.log('System initialized');
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// Safe to call multiple times - only runs once
|
||||||
|
await initTask.trigger();
|
||||||
|
await initTask.trigger(); // This won't run again
|
||||||
|
```
|
||||||
|
|
||||||
|
## Advanced Features 🔥
|
||||||
|
|
||||||
|
### Task Dependencies with Pre/Post Hooks
|
||||||
|
|
||||||
|
Create sophisticated task relationships:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const validationTask = new Task({
|
||||||
|
name: 'ValidateInput',
|
||||||
|
taskFunction: async (data) => {
|
||||||
|
if (!isValid(data)) {
|
||||||
|
throw new Error('Validation failed');
|
||||||
|
}
|
||||||
|
return data;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
const mainTask = new Task({
|
||||||
|
name: 'ProcessData',
|
||||||
|
taskFunction: async (data) => {
|
||||||
|
return await complexProcessing(data);
|
||||||
|
},
|
||||||
|
preTask: validationTask, // Runs before main task
|
||||||
|
afterTask: cleanupTask // Runs after main task
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
### Task Runners - Distributed Execution
|
||||||
|
|
||||||
|
The TaskRunner system enables distributed task execution across multiple workers:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { TaskRunner } from '@push.rocks/taskbuffer';
|
||||||
|
|
||||||
|
const runner = new TaskRunner({
|
||||||
|
name: 'WorkerNode1',
|
||||||
|
maxConcurrentTasks: 5
|
||||||
|
});
|
||||||
|
|
||||||
|
// Register tasks this runner can handle
|
||||||
|
runner.registerTask(dataProcessingTask);
|
||||||
|
runner.registerTask(imageResizeTask);
|
||||||
|
|
||||||
|
// Start processing
|
||||||
|
runner.start();
|
||||||
|
```
|
||||||
|
|
||||||
|
### Buffer Management Strategies
|
||||||
|
|
||||||
|
Fine-tune concurrent execution behavior:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const task = new Task({
|
||||||
|
name: 'ResourceIntensive',
|
||||||
|
taskFunction: async () => { /* ... */ },
|
||||||
|
buffered: true,
|
||||||
|
bufferMax: 5, // Max 5 concurrent
|
||||||
|
execDelay: 100, // 100ms between starts
|
||||||
|
timeout: 30000 // 30 second timeout
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
### Cycle Detection and Prevention
|
||||||
|
|
||||||
|
TaskBuffer automatically detects and prevents circular dependencies:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const taskA = new Task({
|
||||||
|
name: 'TaskA',
|
||||||
|
taskFunction: async () => { /* ... */ },
|
||||||
|
preTask: taskB // This would create a cycle
|
||||||
|
});
|
||||||
|
|
||||||
|
const taskB = new Task({
|
||||||
|
name: 'TaskB',
|
||||||
|
taskFunction: async () => { /* ... */ },
|
||||||
|
preTask: taskA // Circular dependency detected!
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
### Dynamic Task Creation
|
||||||
|
|
||||||
|
Create tasks on-the-fly based on runtime conditions:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const dynamicWorkflow = async (config: Config) => {
|
||||||
|
const tasks = config.steps.map(step =>
|
||||||
|
new Task({
|
||||||
|
name: step.name,
|
||||||
|
taskFunction: async (input) => {
|
||||||
|
return await processStep(step, input);
|
||||||
|
}
|
||||||
|
})
|
||||||
|
);
|
||||||
|
|
||||||
|
const chain = new Taskchain({
|
||||||
|
name: 'DynamicWorkflow',
|
||||||
|
taskArray: tasks
|
||||||
|
});
|
||||||
|
|
||||||
|
return await chain.trigger();
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## API Reference 📚
|
||||||
|
|
||||||
|
### Task Options
|
||||||
|
|
||||||
|
| Option | Type | Description |
|
||||||
|
|--------|------|-------------|
|
||||||
|
| `name` | `string` | Unique identifier for the task |
|
||||||
|
| `taskFunction` | `Function` | Async function to execute |
|
||||||
|
| `buffered` | `boolean` | Enable buffer management |
|
||||||
|
| `bufferMax` | `number` | Maximum concurrent executions |
|
||||||
|
| `execDelay` | `number` | Delay between executions (ms) |
|
||||||
|
| `timeout` | `number` | Task timeout (ms) |
|
||||||
|
| `preTask` | `Task` | Task to run before |
|
||||||
|
| `afterTask` | `Task` | Task to run after |
|
||||||
|
|
||||||
|
### TaskManager Methods
|
||||||
|
|
||||||
|
| Method | Description |
|
||||||
|
|--------|-------------|
|
||||||
|
| `addTask(task, cronExpression)` | Add and schedule a task |
|
||||||
|
| `removeTask(taskName)` | Remove a scheduled task |
|
||||||
|
| `start()` | Start the scheduler |
|
||||||
|
| `stop()` | Stop the scheduler |
|
||||||
|
| `getStats()` | Get execution statistics |
|
||||||
|
|
||||||
|
### Taskchain Methods
|
||||||
|
|
||||||
|
| Method | Description |
|
||||||
|
|--------|-------------|
|
||||||
|
| `addTask(task)` | Add task to chain |
|
||||||
|
| `removeTask(taskName)` | Remove task from chain |
|
||||||
|
| `trigger(initialValue)` | Execute the chain |
|
||||||
|
| `reset()` | Reset chain state |
|
||||||
|
|
||||||
|
## Performance Tips 🏎️
|
||||||
|
|
||||||
|
1. **Use buffering for I/O operations**: Prevents overwhelming external services
|
||||||
|
2. **Leverage parallel execution**: When tasks are independent, run them simultaneously
|
||||||
|
3. **Implement proper error handling**: Use try-catch in task functions
|
||||||
|
4. **Monitor task execution**: Use the built-in stats and logging
|
||||||
|
5. **Set appropriate timeouts**: Prevent hanging tasks from blocking your system
|
||||||
|
|
||||||
|
## Error Handling 🛡️
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const robustTask = new Task({
|
||||||
|
name: 'RobustOperation',
|
||||||
|
taskFunction: async (input) => {
|
||||||
|
try {
|
||||||
|
return await riskyOperation(input);
|
||||||
|
} catch (error) {
|
||||||
|
// Log error
|
||||||
|
console.error(`Task failed: ${error.message}`);
|
||||||
|
|
||||||
|
// Optionally retry
|
||||||
|
if (error.retryable) {
|
||||||
|
return await riskyOperation(input);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Or return default value
|
||||||
|
return defaultValue;
|
||||||
|
}
|
||||||
|
},
|
||||||
|
timeout: 5000 // Fail if takes longer than 5 seconds
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
## Real-World Examples 🌍
|
||||||
|
|
||||||
|
### API Rate Limiting
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const apiClient = new Task({
|
||||||
|
name: 'RateLimitedAPI',
|
||||||
|
taskFunction: async (endpoint: string) => {
|
||||||
|
return await fetch(`https://api.example.com${endpoint}`);
|
||||||
|
},
|
||||||
|
buffered: true,
|
||||||
|
bufferMax: 10, // 10 requests
|
||||||
|
execDelay: 100 // Per 100ms = 100 req/s max
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
### Database Migration Pipeline
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const migrationChain = new Taskchain({
|
||||||
|
name: 'DatabaseMigration',
|
||||||
|
taskArray: [
|
||||||
|
backupTask,
|
||||||
|
schemaUpdateTask,
|
||||||
|
dataTransformTask,
|
||||||
|
validationTask,
|
||||||
|
cleanupTask
|
||||||
|
]
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
### Microservice Health Monitoring
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const healthMonitor = new TaskManager();
|
||||||
|
|
||||||
|
services.forEach(service => {
|
||||||
|
const healthCheck = new Task({
|
||||||
|
name: `HealthCheck:${service.name}`,
|
||||||
|
taskFunction: async () => {
|
||||||
|
const healthy = await checkHealth(service.url);
|
||||||
|
if (!healthy) {
|
||||||
|
await alertOps(service);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
healthMonitor.addAndScheduleTask(healthCheck, '*/1 * * * *'); // Every minute
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
## Testing 🧪
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { expect, tap } from '@git.zone/tstest';
|
||||||
|
import { Task } from '@push.rocks/taskbuffer';
|
||||||
|
|
||||||
|
tap.test('should execute task successfully', async () => {
|
||||||
|
const result = await myTask.trigger();
|
||||||
|
expect(result).toEqual(expectedValue);
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.start();
|
||||||
|
```
|
||||||
|
|
||||||
|
## Contributing 🤝
|
||||||
|
|
||||||
|
We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
|
||||||
|
|
||||||
|
## Support 💬
|
||||||
|
|
||||||
|
- 📧 Email: [hello@task.vc](mailto:hello@task.vc)
|
||||||
|
- 🐛 Issues: [GitHub Issues](https://github.com/push-rocks/taskbuffer/issues)
|
||||||
|
- 📖 Docs: [Documentation](https://code.foss.global/push.rocks/taskbuffer)
|
||||||
|
|
||||||
|
## 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.
|
89
test/test.1.task.ts
Normal file
89
test/test.1.task.ts
Normal file
@@ -0,0 +1,89 @@
|
|||||||
|
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||||
|
import * as taskbuffer from '../ts/index.js';
|
||||||
|
import * as smartpromise from '@push.rocks/smartpromise';
|
||||||
|
import * as smartdelay from '@push.rocks/smartdelay';
|
||||||
|
|
||||||
|
tap.test('new Task() should return a new task', async () => {
|
||||||
|
const testTask = new taskbuffer.Task({
|
||||||
|
taskFunction: async () => {
|
||||||
|
console.log('executed twice');
|
||||||
|
},
|
||||||
|
});
|
||||||
|
expect(testTask).toBeInstanceOf(taskbuffer.Task);
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should have bufferMax set to the provided value', async () => {
|
||||||
|
const task2 = new taskbuffer.Task({
|
||||||
|
taskFunction: async () => {},
|
||||||
|
});
|
||||||
|
expect(task2.bufferMax).toBeUndefined(); // test for a task without bufferMax set
|
||||||
|
const bufferedTask = new taskbuffer.Task({
|
||||||
|
taskFunction: async () => {},
|
||||||
|
buffered: true,
|
||||||
|
bufferMax: 3,
|
||||||
|
});
|
||||||
|
expect(bufferedTask.bufferMax).toEqual(3);
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should be able to trigger tasks multiple times', async () => {
|
||||||
|
let task1Counter = 0;
|
||||||
|
const task1 = new taskbuffer.Task({
|
||||||
|
name: 'Task 1',
|
||||||
|
taskFunction: () => {
|
||||||
|
let done = smartpromise.defer();
|
||||||
|
console.log('Task1 started');
|
||||||
|
setTimeout(() => {
|
||||||
|
task1Counter++;
|
||||||
|
console.log('Task1 executed');
|
||||||
|
done.resolve();
|
||||||
|
}, 5000);
|
||||||
|
return done.promise;
|
||||||
|
},
|
||||||
|
});
|
||||||
|
await task1.trigger();
|
||||||
|
await task1.trigger();
|
||||||
|
expect(task1Counter).toEqual(2);
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should execute setup function before the task function', async () => {
|
||||||
|
const task2 = new taskbuffer.Task({
|
||||||
|
name: 'Task 2',
|
||||||
|
taskSetup: async () => {
|
||||||
|
console.log('this is the setup function for task 2. It should only run once.')
|
||||||
|
return {
|
||||||
|
nice: 'yes',
|
||||||
|
}
|
||||||
|
},
|
||||||
|
taskFunction: async (before, setupArg) => {
|
||||||
|
expect(setupArg).toEqual({ nice: 'yes' });
|
||||||
|
const done = smartpromise.defer();
|
||||||
|
console.log('Task2 started');
|
||||||
|
setTimeout(() => {
|
||||||
|
console.log('Task2 executed');
|
||||||
|
done.resolve();
|
||||||
|
}, 5000);
|
||||||
|
await done.promise;
|
||||||
|
},
|
||||||
|
});
|
||||||
|
await task2.trigger();
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should not exceed bufferMax when task is buffered', async () => {
|
||||||
|
let counter = 0;
|
||||||
|
const bufferedTask = new taskbuffer.Task({
|
||||||
|
taskFunction: async () => {
|
||||||
|
counter++;
|
||||||
|
await smartdelay.delayFor(2000);
|
||||||
|
counter--;
|
||||||
|
},
|
||||||
|
buffered: true,
|
||||||
|
bufferMax: 2,
|
||||||
|
});
|
||||||
|
bufferedTask.trigger();
|
||||||
|
bufferedTask.trigger();
|
||||||
|
bufferedTask.trigger();
|
||||||
|
await smartdelay.delayFor(100);
|
||||||
|
expect(counter <= bufferedTask.bufferMax).toBeTrue();
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.start();
|
49
test/test.2.taskchain.ts
Normal file
49
test/test.2.taskchain.ts
Normal file
@@ -0,0 +1,49 @@
|
|||||||
|
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||||
|
|
||||||
|
import * as taskbuffer from '../ts/index.js';
|
||||||
|
|
||||||
|
import * as smartpromise from '@push.rocks/smartpromise';
|
||||||
|
import * as smartdelay from '@push.rocks/smartdelay';
|
||||||
|
|
||||||
|
let task1Executed = false;
|
||||||
|
const task1 = new taskbuffer.Task({
|
||||||
|
taskFunction: async () => {
|
||||||
|
await smartdelay.delayFor(2000);
|
||||||
|
task1Executed = true;
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
let task2Executed = false;
|
||||||
|
const task2 = new taskbuffer.Task({
|
||||||
|
taskFunction: async () => {
|
||||||
|
await smartdelay.delayFor(2000);
|
||||||
|
task2Executed = true;
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
let task3Executed = false;
|
||||||
|
const task3 = new taskbuffer.Task({
|
||||||
|
taskFunction: async () => {
|
||||||
|
await smartdelay.delayFor(2000);
|
||||||
|
task3Executed = true;
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('expect run tasks in sequence', async () => {
|
||||||
|
const testTaskchain = new taskbuffer.Taskchain({
|
||||||
|
name: 'Taskchain1',
|
||||||
|
taskArray: [task1, task2, task3],
|
||||||
|
});
|
||||||
|
const testPromise = testTaskchain.trigger();
|
||||||
|
await smartdelay.delayFor(2100);
|
||||||
|
// tslint:disable-next-line:no-unused-expression
|
||||||
|
expect(task1Executed).toBeTrue();
|
||||||
|
// tslint:disable-next-line:no-unused-expression
|
||||||
|
expect(task2Executed).toBeFalse();
|
||||||
|
await smartdelay.delayFor(2100);
|
||||||
|
// tslint:disable-next-line:no-unused-expression
|
||||||
|
expect(task2Executed).toBeTrue();
|
||||||
|
await testPromise;
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.start();
|
37
test/test.3.taskparallel.ts
Normal file
37
test/test.3.taskparallel.ts
Normal file
@@ -0,0 +1,37 @@
|
|||||||
|
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||||
|
import * as smartdelay from '@push.rocks/smartdelay';
|
||||||
|
|
||||||
|
import * as taskbuffer from '../ts/index.js';
|
||||||
|
|
||||||
|
let task1Executed = false;
|
||||||
|
const task1 = new taskbuffer.Task({
|
||||||
|
taskFunction: async () => {
|
||||||
|
await smartdelay.delayFor(2000);
|
||||||
|
task1Executed = true;
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
let task2Executed = false;
|
||||||
|
const task2 = new taskbuffer.Task({
|
||||||
|
taskFunction: async () => {
|
||||||
|
await smartdelay.delayFor(2000);
|
||||||
|
task2Executed = true;
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
let task3Executed = false;
|
||||||
|
const task3 = new taskbuffer.Task({
|
||||||
|
taskFunction: async () => {
|
||||||
|
await smartdelay.delayFor(2000);
|
||||||
|
task3Executed = true;
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('expect run in Parallel', async () => {
|
||||||
|
const testTaskparallel = new taskbuffer.Taskparallel({
|
||||||
|
taskArray: [task1, task2, task3],
|
||||||
|
});
|
||||||
|
await testTaskparallel.trigger();
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.start();
|
50
test/test.4.taskmanager.ts
Normal file
50
test/test.4.taskmanager.ts
Normal file
@@ -0,0 +1,50 @@
|
|||||||
|
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||||
|
|
||||||
|
import * as taskbuffer from '../ts/index.js';
|
||||||
|
|
||||||
|
import * as smartpromise from '@push.rocks/smartpromise';
|
||||||
|
import * as smartdelay from '@push.rocks/smartdelay';
|
||||||
|
|
||||||
|
let myTaskManager: taskbuffer.TaskManager;
|
||||||
|
let taskRunCounter = 0;
|
||||||
|
const taskDone = smartpromise.defer();
|
||||||
|
|
||||||
|
tap.test('should create an instance of TaskManager', async () => {
|
||||||
|
myTaskManager = new taskbuffer.TaskManager();
|
||||||
|
expect(myTaskManager).toBeInstanceOf(taskbuffer.TaskManager);
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should run the task as expected', async () => {
|
||||||
|
let referenceBoolean = false;
|
||||||
|
myTaskManager.addTask(
|
||||||
|
new taskbuffer.Task({
|
||||||
|
name: 'myTask',
|
||||||
|
bufferMax: 1,
|
||||||
|
buffered: true,
|
||||||
|
taskFunction: async () => {
|
||||||
|
console.log('Task "myTask" executed!');
|
||||||
|
referenceBoolean = true;
|
||||||
|
taskRunCounter++;
|
||||||
|
if (taskRunCounter === 10) {
|
||||||
|
taskDone.resolve();
|
||||||
|
}
|
||||||
|
},
|
||||||
|
})
|
||||||
|
);
|
||||||
|
myTaskManager.start();
|
||||||
|
await myTaskManager.triggerTaskByName('myTask');
|
||||||
|
// tslint:disable-next-line:no-unused-expression
|
||||||
|
expect(referenceBoolean).toBeTrue();
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should schedule task', async () => {
|
||||||
|
myTaskManager.scheduleTaskByName('myTask', '*/10 * * * * *');
|
||||||
|
await taskDone.promise;
|
||||||
|
myTaskManager.descheduleTaskByName('myTask');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should stop the taskmanager', async () => {
|
||||||
|
myTaskManager.stop();
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.start();
|
65
test/test.5.task.paramflow.ts
Normal file
65
test/test.5.task.paramflow.ts
Normal file
@@ -0,0 +1,65 @@
|
|||||||
|
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||||
|
|
||||||
|
import * as taskbuffer from '../ts/index.js';
|
||||||
|
|
||||||
|
import * as smartpromise from '@push.rocks/smartpromise';
|
||||||
|
import * as smartdelay from '@push.rocks/smartdelay';
|
||||||
|
|
||||||
|
const flowTask1 = new taskbuffer.Task({
|
||||||
|
taskFunction: (x: number) => {
|
||||||
|
const done = smartpromise.defer();
|
||||||
|
console.log('flowTask1');
|
||||||
|
console.log(x);
|
||||||
|
done.resolve(x);
|
||||||
|
return done.promise;
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const flowTaskBuffered = new taskbuffer.Task({
|
||||||
|
taskFunction: (x: number) => {
|
||||||
|
const done = smartpromise.defer();
|
||||||
|
console.log('flowTask1');
|
||||||
|
console.log(x);
|
||||||
|
done.resolve(x);
|
||||||
|
return done.promise;
|
||||||
|
},
|
||||||
|
buffered: true,
|
||||||
|
bufferMax: 1,
|
||||||
|
});
|
||||||
|
|
||||||
|
const flowTask2 = new taskbuffer.Task({
|
||||||
|
taskFunction: (x: number) => {
|
||||||
|
const done = smartpromise.defer();
|
||||||
|
console.log('flowTask2');
|
||||||
|
console.log(x);
|
||||||
|
done.resolve(x);
|
||||||
|
return done.promise;
|
||||||
|
},
|
||||||
|
preTask: flowTask1,
|
||||||
|
});
|
||||||
|
|
||||||
|
const flowTask3 = new taskbuffer.Taskchain({
|
||||||
|
taskArray: [flowTask1, flowTask2],
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should let a value flow through a task', async () => {
|
||||||
|
const result = await flowTask1.trigger(12);
|
||||||
|
expect(result).toEqual(12);
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('expect values to flow between tasks', async () => {
|
||||||
|
const result = await flowTask2.trigger(12);
|
||||||
|
expect(result).toEqual(12);
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('expect values to flow between tasks when buffered', async () => {
|
||||||
|
const result = await flowTaskBuffered.trigger(12);
|
||||||
|
expect(result).toEqual(12);
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('expect values to flow between tasks in Taskchain', async () => {
|
||||||
|
const result = await flowTask3.trigger(12);
|
||||||
|
expect(result).toEqual(12);
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.start();
|
28
test/test.6.taskonce.ts
Normal file
28
test/test.6.taskonce.ts
Normal file
@@ -0,0 +1,28 @@
|
|||||||
|
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||||
|
|
||||||
|
import * as taskbuffer from '../ts/index.js';
|
||||||
|
|
||||||
|
let myNumber = 0;
|
||||||
|
let myTaskOnce: taskbuffer.TaskOnce;
|
||||||
|
|
||||||
|
tap.test('should create a valid instance of TaskOnce', async () => {
|
||||||
|
myTaskOnce = new taskbuffer.TaskOnce({
|
||||||
|
taskFunction: async () => {
|
||||||
|
myNumber++;
|
||||||
|
},
|
||||||
|
});
|
||||||
|
expect(myTaskOnce).toBeInstanceOf(taskbuffer.TaskOnce);
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('myNumber should still be 0', async () => {
|
||||||
|
expect(myNumber).toEqual(0);
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('myTaskOnce should trigger once', async () => {
|
||||||
|
await myTaskOnce.trigger();
|
||||||
|
await myTaskOnce.trigger();
|
||||||
|
await myTaskOnce.trigger();
|
||||||
|
expect(myNumber).toEqual(1);
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.start();
|
51
test/test.7.taskloop.ts
Normal file
51
test/test.7.taskloop.ts
Normal file
@@ -0,0 +1,51 @@
|
|||||||
|
import { tap, expect } from '@git.zone/tstest/tapbundle';
|
||||||
|
|
||||||
|
import * as taskbuffer from '../ts/index.js';
|
||||||
|
|
||||||
|
let preTask: taskbuffer.Task;
|
||||||
|
let afterTask: taskbuffer.Task;
|
||||||
|
|
||||||
|
let mainTask: taskbuffer.Task;
|
||||||
|
|
||||||
|
tap.test('should create tasks', async () => {
|
||||||
|
preTask = new taskbuffer.Task({
|
||||||
|
name: 'myPreTask',
|
||||||
|
taskFunction: async () => {
|
||||||
|
console.log('pretask executed :)');
|
||||||
|
return 'hi';
|
||||||
|
},
|
||||||
|
});
|
||||||
|
afterTask = new taskbuffer.Task({
|
||||||
|
name: 'myAfterTask',
|
||||||
|
taskFunction: async (x) => {
|
||||||
|
if (x === 'hi') {
|
||||||
|
console.log('afterTask: values get passed along alright');
|
||||||
|
}
|
||||||
|
console.log('afterTask executed :)');
|
||||||
|
return x;
|
||||||
|
},
|
||||||
|
preTask,
|
||||||
|
afterTask,
|
||||||
|
});
|
||||||
|
|
||||||
|
mainTask = new taskbuffer.Task({
|
||||||
|
name: 'mainTask',
|
||||||
|
taskFunction: async (x) => {
|
||||||
|
if (x === 'hi') {
|
||||||
|
console.log('mainTask: values get passed along alright');
|
||||||
|
}
|
||||||
|
console.log('afterTask executed :)');
|
||||||
|
return x;
|
||||||
|
},
|
||||||
|
preTask: () => {
|
||||||
|
return preTask;
|
||||||
|
},
|
||||||
|
afterTask,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should execute the mainTask', async () => {
|
||||||
|
await mainTask.trigger();
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.start();
|
52
test/test.8.bufferedrun.ts
Normal file
52
test/test.8.bufferedrun.ts
Normal file
@@ -0,0 +1,52 @@
|
|||||||
|
import { tap, expect } from '@git.zone/tstest/tapbundle';
|
||||||
|
|
||||||
|
import * as taskbuffer from '../ts/index.js';
|
||||||
|
|
||||||
|
let counter1 = 0;
|
||||||
|
let counter2 = 0;
|
||||||
|
let counter3 = 0;
|
||||||
|
|
||||||
|
tap.test('should run buffered', async (tools) => {
|
||||||
|
const task = new taskbuffer.Task({
|
||||||
|
name: 'a buffered task',
|
||||||
|
taskFunction: async () => {
|
||||||
|
counter1++;
|
||||||
|
await tools.delayFor(2000);
|
||||||
|
console.log(`task 1 ran ${counter1} times`);
|
||||||
|
},
|
||||||
|
buffered: true,
|
||||||
|
bufferMax: 1,
|
||||||
|
afterTask: () => {
|
||||||
|
return task2;
|
||||||
|
},
|
||||||
|
});
|
||||||
|
const task2 = new taskbuffer.Task({
|
||||||
|
name: 'a buffered task',
|
||||||
|
taskFunction: async () => {
|
||||||
|
counter2++;
|
||||||
|
await tools.delayFor(2000);
|
||||||
|
console.log(`task2 ran ${counter2} times`);
|
||||||
|
},
|
||||||
|
buffered: true,
|
||||||
|
bufferMax: 1,
|
||||||
|
afterTask: () => {
|
||||||
|
return task3;
|
||||||
|
},
|
||||||
|
});
|
||||||
|
const task3 = new taskbuffer.Task({
|
||||||
|
name: 'a buffered task',
|
||||||
|
taskFunction: async () => {
|
||||||
|
counter3++;
|
||||||
|
await tools.delayFor(2000);
|
||||||
|
console.log(`task3 ran ${counter3} times`);
|
||||||
|
},
|
||||||
|
buffered: true,
|
||||||
|
bufferMax: 1,
|
||||||
|
});
|
||||||
|
while (counter1 < 10) {
|
||||||
|
await tools.delayFor(5000);
|
||||||
|
task.trigger();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.start();
|
1
test/test.d.ts
vendored
1
test/test.d.ts
vendored
@@ -1 +0,0 @@
|
|||||||
import "typings-test";
|
|
129
test/test.js
129
test/test.js
File diff suppressed because one or more lines are too long
34
test/test.taskrunner.ts
Normal file
34
test/test.taskrunner.ts
Normal file
@@ -0,0 +1,34 @@
|
|||||||
|
import { tap, expect } from '@git.zone/tstest/tapbundle';
|
||||||
|
|
||||||
|
import * as taskbuffer from '../ts/index.js';
|
||||||
|
|
||||||
|
let testTaskRunner: taskbuffer.TaskRunner;
|
||||||
|
|
||||||
|
tap.test('should create a valid taskrunner', async () => {
|
||||||
|
testTaskRunner = new taskbuffer.TaskRunner();
|
||||||
|
await testTaskRunner.start();
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should execute task when its scheduled', async (tools) => {
|
||||||
|
const done = tools.defer();
|
||||||
|
testTaskRunner.addTask(
|
||||||
|
new taskbuffer.Task({
|
||||||
|
taskFunction: async () => {
|
||||||
|
console.log('hi');
|
||||||
|
},
|
||||||
|
})
|
||||||
|
);
|
||||||
|
|
||||||
|
testTaskRunner.addTask(
|
||||||
|
new taskbuffer.Task({
|
||||||
|
taskFunction: async () => {
|
||||||
|
console.log('there');
|
||||||
|
done.resolve();
|
||||||
|
},
|
||||||
|
})
|
||||||
|
);
|
||||||
|
|
||||||
|
await done.promise;
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.start();
|
130
test/test.ts
130
test/test.ts
@@ -1,130 +0,0 @@
|
|||||||
import "typings-test";
|
|
||||||
import taskbuffer = require("../dist/index");
|
|
||||||
let should = require("should");
|
|
||||||
import q = require("q")
|
|
||||||
|
|
||||||
// setup some testData to work with
|
|
||||||
let testTask:taskbuffer.Task;
|
|
||||||
let testTaskFunction = function(){
|
|
||||||
let done = q.defer();
|
|
||||||
console.log("main function executed!")
|
|
||||||
done.resolve();
|
|
||||||
return done.promise;
|
|
||||||
}
|
|
||||||
let testPreTask = new taskbuffer.Task({
|
|
||||||
taskFunction:function(){
|
|
||||||
let done = q.defer();
|
|
||||||
console.log("preTask executed");
|
|
||||||
done.resolve();
|
|
||||||
return done.promise;
|
|
||||||
},
|
|
||||||
preTask:testTask
|
|
||||||
});
|
|
||||||
|
|
||||||
describe("taskbuffer",function(){
|
|
||||||
describe(".Task",function(){
|
|
||||||
it("new Task() should return a new task",function(){
|
|
||||||
testTask = new taskbuffer.Task({taskFunction:testTaskFunction,preTask:testPreTask});
|
|
||||||
});
|
|
||||||
it("testTask should be and instance of Task",function(){
|
|
||||||
testTask.should.be.instanceof(taskbuffer.Task);
|
|
||||||
});
|
|
||||||
it("testTask.idle is true",function(){
|
|
||||||
if (!testTask.idle){
|
|
||||||
throw new Error("testTask.idle is not true");
|
|
||||||
}
|
|
||||||
|
|
||||||
});
|
|
||||||
it("testTask.running is type boolean and initially false",function(){
|
|
||||||
testTask.running.should.be.type("boolean");
|
|
||||||
testTask.running.should.be.false();
|
|
||||||
});
|
|
||||||
it("testTask.trigger() should return Promise",function(){
|
|
||||||
testTask.trigger().should.be.Promise();
|
|
||||||
});
|
|
||||||
it("testTask.trigger() returned Promise should be fullfilled",function(done){
|
|
||||||
testTask.trigger()
|
|
||||||
.then(done);
|
|
||||||
});
|
|
||||||
it("should run a task without pre and afterTask",function(done){
|
|
||||||
let localTestTask = new taskbuffer.Task({taskFunction:testTaskFunction});
|
|
||||||
localTestTask.trigger().then(done);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
describe("Taskchain",function(){
|
|
||||||
let testTaskchain;
|
|
||||||
let testTaskArray = [
|
|
||||||
new taskbuffer.Task({
|
|
||||||
name:"task1",
|
|
||||||
taskFunction:function(){
|
|
||||||
let done = q.defer();
|
|
||||||
setTimeout(done.resolve,2000);
|
|
||||||
return done.promise;
|
|
||||||
}
|
|
||||||
}),
|
|
||||||
new taskbuffer.Task({
|
|
||||||
name:"task2",
|
|
||||||
taskFunction: function(){
|
|
||||||
let done = q.defer();
|
|
||||||
setTimeout(done.resolve,2000);
|
|
||||||
return done.promise;
|
|
||||||
}
|
|
||||||
}),
|
|
||||||
];
|
|
||||||
it("should run tasks in sequence",function(done){
|
|
||||||
this.timeout(5000);
|
|
||||||
testTaskchain = new taskbuffer.Taskchain({
|
|
||||||
name:"Taskchain1",
|
|
||||||
taskArray:testTaskArray
|
|
||||||
});
|
|
||||||
testTaskchain.trigger().then(done);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
describe("taskparallel",function(){
|
|
||||||
let task1 = new taskbuffer.Task({
|
|
||||||
name:"Task 1",
|
|
||||||
taskFunction: () => {
|
|
||||||
let done = q.defer();
|
|
||||||
console.log("Task1 started");
|
|
||||||
setTimeout(() => {
|
|
||||||
console.log("Task1 executed");
|
|
||||||
done.resolve();
|
|
||||||
},5000)
|
|
||||||
return done.promise;
|
|
||||||
}
|
|
||||||
});
|
|
||||||
let task2 = new taskbuffer.Task({
|
|
||||||
name:"Task 1",
|
|
||||||
taskFunction: () => {
|
|
||||||
let done = q.defer();
|
|
||||||
console.log("Task2 started");
|
|
||||||
setTimeout(() => {
|
|
||||||
console.log("Task2 executed");
|
|
||||||
done.resolve();
|
|
||||||
},5000)
|
|
||||||
return done.promise;
|
|
||||||
}
|
|
||||||
});
|
|
||||||
let task3 = new taskbuffer.Task({
|
|
||||||
name:"Task 3",
|
|
||||||
taskFunction: () => {
|
|
||||||
let done = q.defer();
|
|
||||||
console.log("Task3 started");
|
|
||||||
setTimeout(() => {
|
|
||||||
console.log("Task3 executed");
|
|
||||||
done.resolve();
|
|
||||||
},5000)
|
|
||||||
return done.promise;
|
|
||||||
}
|
|
||||||
});
|
|
||||||
it("should run in Parallel",function(done){
|
|
||||||
this.timeout("7000");
|
|
||||||
let testTaskparallel = new taskbuffer.Taskparallel({
|
|
||||||
taskArray:[task1,task2,task3]
|
|
||||||
});
|
|
||||||
testTaskparallel.trigger().then(() => {
|
|
||||||
done();
|
|
||||||
});
|
|
||||||
})
|
|
||||||
})
|
|
||||||
});
|
|
8
ts/00_commitinfo_data.ts
Normal file
8
ts/00_commitinfo_data.ts
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
/**
|
||||||
|
* autocreated commitinfo by @push.rocks/commitinfo
|
||||||
|
*/
|
||||||
|
export const commitinfo = {
|
||||||
|
name: '@push.rocks/taskbuffer',
|
||||||
|
version: '3.1.8',
|
||||||
|
description: 'A flexible task management library supporting TypeScript, allowing for task buffering, scheduling, and execution with dependency management.'
|
||||||
|
}
|
17
ts/index.ts
17
ts/index.ts
@@ -1,7 +1,10 @@
|
|||||||
export {Task,ITaskFunction} from "./taskbuffer.classes.task";
|
export { Task } from './taskbuffer.classes.task.js';
|
||||||
export {Taskchain} from "./taskbuffer.classes.taskchain";
|
export type { ITaskFunction } from './taskbuffer.classes.task.js';
|
||||||
export {Taskparallel} from "./taskbuffer.classes.taskparallel";
|
export { Taskchain } from './taskbuffer.classes.taskchain.js';
|
||||||
export {Taskspace} from "./taskbuffer.classes.taskspace";
|
export { Taskparallel } from './taskbuffer.classes.taskparallel.js';
|
||||||
|
export { TaskManager } from './taskbuffer.classes.taskmanager.js';
|
||||||
// import for naming only
|
export { TaskOnce } from './taskbuffer.classes.taskonce.js';
|
||||||
import "./taskbuffer.classes.helpers"
|
export { TaskRunner } from './taskbuffer.classes.taskrunner.js';
|
||||||
|
export { TaskDebounced } from './taskbuffer.classes.taskdebounced.js';
|
||||||
|
import * as distributedCoordination from './taskbuffer.classes.distributedcoordinator.js';
|
||||||
|
export { distributedCoordination };
|
||||||
|
34
ts/taskbuffer.classes.bufferrunner.ts
Normal file
34
ts/taskbuffer.classes.bufferrunner.ts
Normal file
@@ -0,0 +1,34 @@
|
|||||||
|
import { Task } from './taskbuffer.classes.task.js';
|
||||||
|
|
||||||
|
export class BufferRunner {
|
||||||
|
public task: Task;
|
||||||
|
// initialize by default
|
||||||
|
public bufferCounter: number = 0;
|
||||||
|
|
||||||
|
constructor(taskArg: Task<any>) {
|
||||||
|
this.task = taskArg;
|
||||||
|
}
|
||||||
|
|
||||||
|
public trigger(x: any): Promise<any> {
|
||||||
|
if (!(this.bufferCounter >= this.task.bufferMax)) {
|
||||||
|
this.bufferCounter++;
|
||||||
|
}
|
||||||
|
const returnPromise: Promise<any> = this.task.cycleCounter.getPromiseForCycle(
|
||||||
|
this.bufferCounter
|
||||||
|
);
|
||||||
|
if (!this.task.running) {
|
||||||
|
this._run(x);
|
||||||
|
}
|
||||||
|
return returnPromise;
|
||||||
|
}
|
||||||
|
|
||||||
|
private async _run(x: any) {
|
||||||
|
this.task.running = true;
|
||||||
|
while (this.bufferCounter > 0) {
|
||||||
|
const result = await Task.runTask(this.task, { x: x });
|
||||||
|
this.bufferCounter--;
|
||||||
|
this.task.cycleCounter.informOfCycle(result);
|
||||||
|
}
|
||||||
|
this.task.running = false;
|
||||||
|
}
|
||||||
|
}
|
36
ts/taskbuffer.classes.cyclecounter.ts
Normal file
36
ts/taskbuffer.classes.cyclecounter.ts
Normal file
@@ -0,0 +1,36 @@
|
|||||||
|
import * as plugins from './taskbuffer.plugins.js';
|
||||||
|
import { Task } from './taskbuffer.classes.task.js';
|
||||||
|
|
||||||
|
export interface ICycleObject {
|
||||||
|
cycleCounter: number;
|
||||||
|
deferred: plugins.smartpromise.Deferred<any>;
|
||||||
|
}
|
||||||
|
|
||||||
|
export class CycleCounter {
|
||||||
|
public task: Task;
|
||||||
|
public cycleObjectArray: ICycleObject[] = [];
|
||||||
|
constructor(taskArg: Task<any>) {
|
||||||
|
this.task = taskArg;
|
||||||
|
}
|
||||||
|
public getPromiseForCycle(cycleCountArg: number) {
|
||||||
|
const done = plugins.smartpromise.defer();
|
||||||
|
const cycleObject: ICycleObject = {
|
||||||
|
cycleCounter: cycleCountArg,
|
||||||
|
deferred: done,
|
||||||
|
};
|
||||||
|
this.cycleObjectArray.push(cycleObject);
|
||||||
|
return done.promise;
|
||||||
|
}
|
||||||
|
public informOfCycle(x: any) {
|
||||||
|
const newCycleObjectArray: ICycleObject[] = [];
|
||||||
|
this.cycleObjectArray.forEach((cycleObjectArg) => {
|
||||||
|
cycleObjectArg.cycleCounter--;
|
||||||
|
if (cycleObjectArg.cycleCounter <= 0) {
|
||||||
|
cycleObjectArg.deferred.resolve(x);
|
||||||
|
} else {
|
||||||
|
newCycleObjectArray.push(cycleObjectArg);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
this.cycleObjectArray = newCycleObjectArray;
|
||||||
|
}
|
||||||
|
}
|
38
ts/taskbuffer.classes.distributedcoordinator.ts
Normal file
38
ts/taskbuffer.classes.distributedcoordinator.ts
Normal file
@@ -0,0 +1,38 @@
|
|||||||
|
import { Task } from './taskbuffer.classes.task.js';
|
||||||
|
import * as plugins from './taskbuffer.plugins.js';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Contains all data for the final coordinator to make an informed decision.
|
||||||
|
*/
|
||||||
|
export interface IDistributedTaskRequest {
|
||||||
|
submitterId: string;
|
||||||
|
requestResponseId: string;
|
||||||
|
taskName: string;
|
||||||
|
taskVersion: string;
|
||||||
|
taskExecutionTime: number;
|
||||||
|
taskExecutionTimeout: number;
|
||||||
|
taskExecutionParallel: number;
|
||||||
|
status: 'requesting' | 'gotRejected' | 'failed' | 'succeeded';
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface IDistributedTaskRequestResult {
|
||||||
|
submitterId: string;
|
||||||
|
requestResponseId: string;
|
||||||
|
considered: boolean;
|
||||||
|
rank: number;
|
||||||
|
reason: string;
|
||||||
|
shouldTrigger: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export abstract class AbstractDistributedCoordinator {
|
||||||
|
public abstract fireDistributedTaskRequest(
|
||||||
|
infoBasis: IDistributedTaskRequest
|
||||||
|
): Promise<IDistributedTaskRequestResult>;
|
||||||
|
|
||||||
|
public abstract updateDistributedTaskRequest(
|
||||||
|
infoBasis: IDistributedTaskRequest
|
||||||
|
): Promise<void>;
|
||||||
|
|
||||||
|
public abstract start(): Promise<void>;
|
||||||
|
public abstract stop(): Promise<void>;
|
||||||
|
}
|
@@ -1,84 +0,0 @@
|
|||||||
import plugins = require("./taskbuffer.plugins");
|
|
||||||
import {Task,ITaskFunction} from "./taskbuffer.classes.task";
|
|
||||||
|
|
||||||
export let emptyTaskFunction:ITaskFunction = function(){
|
|
||||||
let done = plugins.Q.defer();
|
|
||||||
done.resolve();
|
|
||||||
return done.promise;
|
|
||||||
};
|
|
||||||
|
|
||||||
export let isTask = function(taskArg):boolean{
|
|
||||||
if(
|
|
||||||
taskArg instanceof Task
|
|
||||||
&& typeof taskArg.task === "function"
|
|
||||||
){
|
|
||||||
return true;
|
|
||||||
} else {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
|
|
||||||
export let isTaskTouched = (taskArg:Task, touchedTasksArray:Task[]):boolean => {
|
|
||||||
let result = false;
|
|
||||||
for (let keyArg in touchedTasksArray){
|
|
||||||
if(taskArg === touchedTasksArray[keyArg]){
|
|
||||||
result = true;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return result;
|
|
||||||
}
|
|
||||||
|
|
||||||
export let runTask = function(taskArg:Task,optionsArg:{touchedTasksArray:Task[]} = {touchedTasksArray:[]}){
|
|
||||||
let done = plugins.Q.defer();
|
|
||||||
taskArg.running = true;
|
|
||||||
done.promise.then(function(){taskArg.running = false});
|
|
||||||
let localDeferred = plugins.Q.defer();
|
|
||||||
let touchedTasksArray:Task[];
|
|
||||||
if(optionsArg.touchedTasksArray){
|
|
||||||
touchedTasksArray = optionsArg.touchedTasksArray;
|
|
||||||
} else {
|
|
||||||
touchedTasksArray = [];
|
|
||||||
}
|
|
||||||
touchedTasksArray.push(taskArg);
|
|
||||||
localDeferred.promise
|
|
||||||
.then(() =>{
|
|
||||||
if(taskArg.preTask && !isTaskTouched(taskArg.preTask,touchedTasksArray)){
|
|
||||||
return runTask(taskArg.preTask,{touchedTasksArray:touchedTasksArray})
|
|
||||||
} else {
|
|
||||||
let done2 = plugins.Q.defer();
|
|
||||||
done2.resolve();
|
|
||||||
return done2.promise;
|
|
||||||
}
|
|
||||||
})
|
|
||||||
.then(() => {
|
|
||||||
return taskArg.task();
|
|
||||||
})
|
|
||||||
.then(() => {
|
|
||||||
if(taskArg.afterTask && !isTaskTouched(taskArg.afterTask,touchedTasksArray)){
|
|
||||||
return runTask(taskArg.afterTask,{touchedTasksArray:touchedTasksArray})
|
|
||||||
} else {
|
|
||||||
let done2 = plugins.Q.defer();
|
|
||||||
done2.resolve();
|
|
||||||
return done2.promise;
|
|
||||||
}
|
|
||||||
})
|
|
||||||
.then(() => {
|
|
||||||
done.resolve();
|
|
||||||
});
|
|
||||||
localDeferred.resolve();
|
|
||||||
return done.promise;
|
|
||||||
};
|
|
||||||
|
|
||||||
export let runBufferedTask = (taskArg:Task) => {
|
|
||||||
let recursiveBufferRunner = () => {
|
|
||||||
if(taskArg.bufferCounter > 0){
|
|
||||||
taskArg.runningBuffered = true;
|
|
||||||
taskArg.bufferCounter--;
|
|
||||||
runTask(taskArg)
|
|
||||||
.then(recursiveBufferRunner);
|
|
||||||
} else {
|
|
||||||
taskArg.runningBuffered = false;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
};
|
|
@@ -1,89 +1,213 @@
|
|||||||
import * as plugins from "./taskbuffer.plugins"
|
import * as plugins from './taskbuffer.plugins.js';
|
||||||
import * as helpers from "./taskbuffer.classes.helpers"
|
import { BufferRunner } from './taskbuffer.classes.bufferrunner.js';
|
||||||
|
import { CycleCounter } from './taskbuffer.classes.cyclecounter.js';
|
||||||
|
|
||||||
|
import { logger } from './taskbuffer.logging.js';
|
||||||
|
|
||||||
export interface ITaskFunction {
|
export interface ITaskFunction<T = undefined> {
|
||||||
():PromiseLike<any>;
|
(x?: any, setupValue?: T): PromiseLike<any>;
|
||||||
}
|
}
|
||||||
|
|
||||||
export class Task {
|
export interface ITaskSetupFunction<T = undefined> {
|
||||||
name:string;
|
(): Promise<T>;
|
||||||
task:any;
|
}
|
||||||
running:boolean = false;
|
|
||||||
runningBuffered:boolean = false;
|
export type TPreOrAfterTaskFunction = () => Task<any>;
|
||||||
idle:boolean = true;
|
|
||||||
buffered:boolean = false;
|
export class Task<T = undefined> {
|
||||||
bufferCounter:number;
|
public static extractTask<T = undefined>(
|
||||||
bufferMax:number = 1;
|
preOrAfterTaskArg: Task<T> | TPreOrAfterTaskFunction
|
||||||
private _counterTriggerAbsolute:number = 0;
|
): Task<T> {
|
||||||
private _state:string;
|
switch (true) {
|
||||||
preTask:Task;
|
case !preOrAfterTaskArg:
|
||||||
afterTask:Task;
|
return null;
|
||||||
|
case preOrAfterTaskArg instanceof Task:
|
||||||
|
return preOrAfterTaskArg as Task<T>;
|
||||||
|
case typeof preOrAfterTaskArg === 'function':
|
||||||
|
const taskFunction = preOrAfterTaskArg as TPreOrAfterTaskFunction;
|
||||||
|
return taskFunction();
|
||||||
|
default:
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public static emptyTaskFunction: ITaskFunction = function (x) {
|
||||||
|
const done = plugins.smartpromise.defer();
|
||||||
|
done.resolve();
|
||||||
|
return done.promise;
|
||||||
|
};
|
||||||
|
|
||||||
|
public static isTask = (taskArg: Task<any>): boolean => {
|
||||||
|
if (taskArg instanceof Task && typeof taskArg.taskFunction === 'function') {
|
||||||
|
return true;
|
||||||
|
} else {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
public static isTaskTouched<T = undefined>(
|
||||||
|
taskArg: Task<T> | TPreOrAfterTaskFunction,
|
||||||
|
touchedTasksArray: Task<T>[]
|
||||||
|
): boolean {
|
||||||
|
const taskToCheck = Task.extractTask(taskArg);
|
||||||
|
let result = false;
|
||||||
|
for (const keyArg in touchedTasksArray) {
|
||||||
|
if (taskToCheck === touchedTasksArray[keyArg]) {
|
||||||
|
result = true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|
||||||
|
public static runTask = async <T>(
|
||||||
|
taskArg: Task<T> | TPreOrAfterTaskFunction,
|
||||||
|
optionsArg: { x?: any; touchedTasksArray?: Task<T>[] }
|
||||||
|
) => {
|
||||||
|
const taskToRun = Task.extractTask(taskArg);
|
||||||
|
const done = plugins.smartpromise.defer();
|
||||||
|
|
||||||
|
// Wait for all blocking tasks to finish
|
||||||
|
for (const task of taskToRun.blockingTasks) {
|
||||||
|
await task.finished;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!taskToRun.setupValue && taskToRun.taskSetup) {
|
||||||
|
taskToRun.setupValue = await taskToRun.taskSetup();
|
||||||
|
}
|
||||||
|
|
||||||
|
if (taskToRun.execDelay) {
|
||||||
|
await plugins.smartdelay.delayFor(taskToRun.execDelay);
|
||||||
|
}
|
||||||
|
|
||||||
|
taskToRun.running = true;
|
||||||
|
|
||||||
|
done.promise.then(async () => {
|
||||||
|
taskToRun.running = false;
|
||||||
|
|
||||||
|
// 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;
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
const options = {
|
||||||
|
...{ x: undefined, touchedTasksArray: [] },
|
||||||
|
...optionsArg,
|
||||||
|
};
|
||||||
|
const x = options.x;
|
||||||
|
const touchedTasksArray: Task<T>[] = options.touchedTasksArray;
|
||||||
|
|
||||||
|
touchedTasksArray.push(taskToRun);
|
||||||
|
|
||||||
|
const localDeferred = plugins.smartpromise.defer();
|
||||||
|
localDeferred.promise
|
||||||
|
.then(() => {
|
||||||
|
if (taskToRun.preTask && !Task.isTaskTouched(taskToRun.preTask, touchedTasksArray)) {
|
||||||
|
return Task.runTask(taskToRun.preTask, { x, touchedTasksArray });
|
||||||
|
} else {
|
||||||
|
const done2 = plugins.smartpromise.defer();
|
||||||
|
done2.resolve(x);
|
||||||
|
return done2.promise;
|
||||||
|
}
|
||||||
|
})
|
||||||
|
.then(async (x) => {
|
||||||
|
try {
|
||||||
|
return await taskToRun.taskFunction(x, taskToRun.setupValue);
|
||||||
|
} catch (e) {
|
||||||
|
console.log(e);
|
||||||
|
}
|
||||||
|
})
|
||||||
|
.then((x) => {
|
||||||
|
if (taskToRun.afterTask && !Task.isTaskTouched(taskToRun.afterTask, touchedTasksArray)) {
|
||||||
|
return Task.runTask(taskToRun.afterTask, { x: x, touchedTasksArray: touchedTasksArray });
|
||||||
|
} else {
|
||||||
|
const done2 = plugins.smartpromise.defer();
|
||||||
|
done2.resolve(x);
|
||||||
|
return done2.promise;
|
||||||
|
}
|
||||||
|
})
|
||||||
|
.then((x) => {
|
||||||
|
done.resolve(x);
|
||||||
|
})
|
||||||
|
.catch((err) => {
|
||||||
|
console.log(err);
|
||||||
|
});
|
||||||
|
localDeferred.resolve();
|
||||||
|
return await done.promise;
|
||||||
|
};
|
||||||
|
|
||||||
|
public name: string;
|
||||||
|
public version: string;
|
||||||
|
public taskFunction: ITaskFunction<T>;
|
||||||
|
public buffered: boolean;
|
||||||
|
public cronJob: plugins.smarttime.CronJob;
|
||||||
|
|
||||||
|
public bufferMax: number;
|
||||||
|
public execDelay: number;
|
||||||
|
public timeout: number;
|
||||||
|
|
||||||
|
public preTask: Task<T> | TPreOrAfterTaskFunction;
|
||||||
|
public afterTask: Task<T> | TPreOrAfterTaskFunction;
|
||||||
|
|
||||||
|
// Add a list to store the blocking tasks
|
||||||
|
public blockingTasks: Task[] = [];
|
||||||
|
|
||||||
|
// Add a promise that will resolve when the task has finished
|
||||||
|
private finished: Promise<void>;
|
||||||
|
private resolveFinished: () => void;
|
||||||
|
|
||||||
|
public running: boolean = false;
|
||||||
|
public bufferRunner = new BufferRunner(this);
|
||||||
|
public cycleCounter = new CycleCounter(this);
|
||||||
|
|
||||||
|
public get idle() {
|
||||||
|
return !this.running;
|
||||||
|
}
|
||||||
|
|
||||||
|
public taskSetup: ITaskSetupFunction<T>;
|
||||||
|
public setupValue: T;
|
||||||
|
|
||||||
constructor(optionsArg: {
|
constructor(optionsArg: {
|
||||||
taskFunction:ITaskFunction,
|
taskFunction: ITaskFunction<T>;
|
||||||
preTask?:Task,
|
preTask?: Task<T> | TPreOrAfterTaskFunction;
|
||||||
afterTask?:Task,
|
afterTask?: Task<T> | TPreOrAfterTaskFunction;
|
||||||
buffered?:boolean,
|
buffered?: boolean;
|
||||||
bufferMax?:number,
|
bufferMax?: number;
|
||||||
name?:string
|
execDelay?: number;
|
||||||
|
name?: string;
|
||||||
|
taskSetup?: ITaskSetupFunction<T>;
|
||||||
}) {
|
}) {
|
||||||
var options = optionsArg;
|
this.taskFunction = optionsArg.taskFunction;
|
||||||
this.task = optionsArg.taskFunction;
|
this.preTask = optionsArg.preTask;
|
||||||
this.preTask = options.preTask;
|
this.afterTask = optionsArg.afterTask;
|
||||||
this.afterTask = options.afterTask;
|
this.buffered = optionsArg.buffered;
|
||||||
this.running = false;
|
this.bufferMax = optionsArg.bufferMax;
|
||||||
this.idle = !this.running && !this.runningBuffered;
|
this.execDelay = optionsArg.execDelay;
|
||||||
this.buffered = options.buffered;
|
this.name = optionsArg.name;
|
||||||
this.bufferMax = options.bufferMax;
|
this.taskSetup = optionsArg.taskSetup;
|
||||||
this.name = options.name;
|
|
||||||
|
// Create the finished promise
|
||||||
|
this.finished = new Promise((resolve) => {
|
||||||
|
this.resolveFinished = resolve;
|
||||||
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
public trigger(x?: any): Promise<any> {
|
||||||
* trigger the task. Will trigger buffered if this.buffered is true
|
|
||||||
*/
|
|
||||||
trigger(){
|
|
||||||
let done = plugins.Q.defer();
|
|
||||||
if (this.buffered) {
|
if (this.buffered) {
|
||||||
this.triggerBuffered()
|
return this.triggerBuffered(x);
|
||||||
.then(done.resolve);
|
|
||||||
}
|
|
||||||
else {
|
|
||||||
this.triggerUnBuffered()
|
|
||||||
.then(done.resolve);
|
|
||||||
};
|
|
||||||
return done.promise;
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* trigger task unbuffered.
|
|
||||||
*/
|
|
||||||
triggerUnBuffered(){
|
|
||||||
return helpers.runTask(this);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* trigger task buffered.
|
|
||||||
*/
|
|
||||||
triggerBuffered(){
|
|
||||||
var done = plugins.Q.defer();
|
|
||||||
if(!(this.bufferCounter >= this.bufferMax)){
|
|
||||||
this.bufferCounter++
|
|
||||||
};
|
|
||||||
if(!this.runningBuffered){
|
|
||||||
helpers.runBufferedTask(this);
|
|
||||||
};
|
|
||||||
return done.promise;
|
|
||||||
}
|
|
||||||
|
|
||||||
get state():string {
|
|
||||||
return this._state;
|
|
||||||
}
|
|
||||||
set state(stateArg:string){
|
|
||||||
if (stateArg == "locked"){
|
|
||||||
this._state = "locked";
|
|
||||||
} else {
|
} else {
|
||||||
plugins.beautylog.error("state type " + stateArg.blue + " could not be set");
|
return this.triggerUnBuffered(x);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public triggerUnBuffered(x?: any): Promise<any> {
|
||||||
|
return Task.runTask<T>(this, { x: x });
|
||||||
|
}
|
||||||
|
|
||||||
|
public triggerBuffered(x?: any): Promise<any> {
|
||||||
|
return this.bufferRunner.trigger(x);
|
||||||
|
}
|
||||||
}
|
}
|
@@ -1,62 +1,58 @@
|
|||||||
import * as plugins from "./taskbuffer.plugins";
|
// TaskChain chains tasks
|
||||||
import {Task} from "./taskbuffer.classes.task";
|
// and extends Task
|
||||||
import helpers = require("./taskbuffer.classes.helpers");
|
|
||||||
|
import * as plugins from './taskbuffer.plugins.js';
|
||||||
|
import { Task } from './taskbuffer.classes.task.js';
|
||||||
|
import { logger } from './taskbuffer.logging.js';
|
||||||
|
|
||||||
export class Taskchain extends Task {
|
export class Taskchain extends Task {
|
||||||
taskArray: Task[];
|
taskArray: Task[];
|
||||||
private _oraObject:plugins.beautylog.Ora;
|
|
||||||
constructor(optionsArg: {
|
constructor(optionsArg: {
|
||||||
name?:string,
|
taskArray: Task[];
|
||||||
log?:boolean,
|
name?: string;
|
||||||
taskArray:Task[]
|
log?: boolean;
|
||||||
|
buffered?: boolean;
|
||||||
|
bufferMax?: number;
|
||||||
}) {
|
}) {
|
||||||
let options = plugins.lodash.merge(
|
const options = {
|
||||||
{
|
...{
|
||||||
name:"unnamed Taskchain",
|
name: 'unnamed Taskchain',
|
||||||
log:false
|
log: false,
|
||||||
},
|
},
|
||||||
optionsArg,
|
...optionsArg,
|
||||||
{
|
...{
|
||||||
taskFunction: () => { // this is the function that gets executed when TaskChain is triggered
|
taskFunction: (x: any) => {
|
||||||
let done = plugins.Q.defer(); // this is the starting Deferred object
|
// this is the function that gets executed when TaskChain is triggered
|
||||||
let taskCounter = 0;
|
const done = plugins.smartpromise.defer(); // this is the starting Deferred object
|
||||||
let iterateTasks = () => {
|
let taskCounter = 0; // counter for iterating async over the taskArray
|
||||||
if(typeof this.taskArray[taskCounter] != "undefined"){
|
const iterateTasks = (x: any) => {
|
||||||
this._oraObject.text(this.name + " running: Task" + this.taskArray[taskCounter].name);
|
if (typeof this.taskArray[taskCounter] !== 'undefined') {
|
||||||
this.taskArray[taskCounter].trigger()
|
console.log(this.name + ' running: Task' + this.taskArray[taskCounter].name);
|
||||||
.then(()=>{
|
this.taskArray[taskCounter].trigger(x).then((x) => {
|
||||||
plugins.beautylog.ok(this.taskArray[taskCounter].name);
|
logger.log('info', this.taskArray[taskCounter].name);
|
||||||
taskCounter++;
|
taskCounter++;
|
||||||
iterateTasks();
|
iterateTasks(x);
|
||||||
});
|
});
|
||||||
} else {
|
} else {
|
||||||
this._oraObject.endOk("Taskchain \"" + this.name + "\" completed successfully");
|
console.log('Taskchain "' + this.name + '" completed successfully');
|
||||||
done.resolve();
|
done.resolve(x);
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
iterateTasks();
|
iterateTasks(x);
|
||||||
return done.promise;
|
return done.promise;
|
||||||
}
|
},
|
||||||
}
|
},
|
||||||
);
|
};
|
||||||
super(options);
|
super(options);
|
||||||
this.taskArray = optionsArg.taskArray;
|
this.taskArray = optionsArg.taskArray;
|
||||||
this._oraObject = new plugins.beautylog.Ora("Taskchain idle","blue");
|
|
||||||
if(optionsArg.log === true){
|
|
||||||
this._oraObject.start();
|
|
||||||
};
|
|
||||||
}
|
}
|
||||||
addTask(taskArg: Task) {
|
addTask(taskArg: Task) {
|
||||||
this.taskArray.push(taskArg);
|
this.taskArray.push(taskArg);
|
||||||
};
|
|
||||||
removeTask(taskArg:Task){
|
|
||||||
//TODO
|
|
||||||
};
|
|
||||||
shiftTask(){
|
|
||||||
|
|
||||||
};
|
|
||||||
trigger(){
|
|
||||||
this._oraObject.start(this.name + " running...");
|
|
||||||
return helpers.runTask(this);
|
|
||||||
}
|
}
|
||||||
};
|
removeTask(taskArg: Task) {
|
||||||
|
// TODO:
|
||||||
|
}
|
||||||
|
shiftTask() {
|
||||||
|
// TODO:
|
||||||
|
}
|
||||||
|
}
|
||||||
|
27
ts/taskbuffer.classes.taskdebounced.ts
Normal file
27
ts/taskbuffer.classes.taskdebounced.ts
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
import * as plugins from './taskbuffer.plugins.js';
|
||||||
|
|
||||||
|
import { Task, type ITaskFunction } from './taskbuffer.classes.task.js';
|
||||||
|
|
||||||
|
export class TaskDebounced<T = unknown> extends Task {
|
||||||
|
private _debouncedTaskFunction: ITaskFunction;
|
||||||
|
private _observableIntake = new plugins.smartrx.ObservableIntake<T>();
|
||||||
|
|
||||||
|
constructor(optionsArg: {
|
||||||
|
name: string;
|
||||||
|
taskFunction: ITaskFunction;
|
||||||
|
debounceTimeInMillis: number;
|
||||||
|
}) {
|
||||||
|
super({
|
||||||
|
name: optionsArg.name,
|
||||||
|
taskFunction: async (x: T) => {
|
||||||
|
this._observableIntake.push(x);
|
||||||
|
},
|
||||||
|
});
|
||||||
|
this.taskFunction = optionsArg.taskFunction;
|
||||||
|
this._observableIntake.observable
|
||||||
|
.pipe(plugins.smartrx.rxjs.ops.debounceTime(optionsArg.debounceTimeInMillis))
|
||||||
|
.subscribe((x) => {
|
||||||
|
this.taskFunction(x);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
139
ts/taskbuffer.classes.taskmanager.ts
Normal file
139
ts/taskbuffer.classes.taskmanager.ts
Normal file
@@ -0,0 +1,139 @@
|
|||||||
|
import * as plugins from './taskbuffer.plugins.js';
|
||||||
|
import { Task } from './taskbuffer.classes.task.js';
|
||||||
|
import { AbstractDistributedCoordinator, type IDistributedTaskRequestResult } from './taskbuffer.classes.distributedcoordinator.js';
|
||||||
|
|
||||||
|
export interface ICronJob {
|
||||||
|
cronString: string;
|
||||||
|
taskName: string;
|
||||||
|
job: any;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ITaskManagerConstructorOptions {
|
||||||
|
distributedCoordinator?: AbstractDistributedCoordinator;
|
||||||
|
}
|
||||||
|
|
||||||
|
export class TaskManager {
|
||||||
|
public randomId = plugins.smartunique.shortId();
|
||||||
|
public taskMap = new plugins.lik.ObjectMap<Task>();
|
||||||
|
private cronJobManager = new plugins.smarttime.CronManager();
|
||||||
|
public options: ITaskManagerConstructorOptions = {
|
||||||
|
distributedCoordinator: null,
|
||||||
|
};
|
||||||
|
|
||||||
|
constructor(options: ITaskManagerConstructorOptions = {}) {
|
||||||
|
this.options = Object.assign(this.options, options);
|
||||||
|
}
|
||||||
|
|
||||||
|
public getTaskByName(taskName: string): Task {
|
||||||
|
return this.taskMap.findSync((task) => task.name === taskName);
|
||||||
|
}
|
||||||
|
|
||||||
|
public addTask(task: Task): void {
|
||||||
|
if (!task.name) {
|
||||||
|
throw new Error('Task must have a name to be added to taskManager');
|
||||||
|
}
|
||||||
|
this.taskMap.add(task);
|
||||||
|
}
|
||||||
|
|
||||||
|
public addAndScheduleTask(task: Task, cronString: string) {
|
||||||
|
this.addTask(task);
|
||||||
|
this.scheduleTaskByName(task.name, cronString);
|
||||||
|
}
|
||||||
|
|
||||||
|
public async triggerTaskByName(taskName: string): Promise<any> {
|
||||||
|
const taskToTrigger = this.getTaskByName(taskName);
|
||||||
|
if (!taskToTrigger) {
|
||||||
|
throw new Error(`No task with the name ${taskName} found.`);
|
||||||
|
}
|
||||||
|
return taskToTrigger.trigger();
|
||||||
|
}
|
||||||
|
|
||||||
|
public async triggerTask(task: Task) {
|
||||||
|
return task.trigger();
|
||||||
|
}
|
||||||
|
|
||||||
|
public scheduleTaskByName(taskName: string, cronString: string) {
|
||||||
|
const taskToSchedule = this.getTaskByName(taskName);
|
||||||
|
if (!taskToSchedule) {
|
||||||
|
throw new Error(`No task with the name ${taskName} found.`);
|
||||||
|
}
|
||||||
|
this.handleTaskScheduling(taskToSchedule, cronString);
|
||||||
|
}
|
||||||
|
|
||||||
|
private handleTaskScheduling(task: Task, cronString: string) {
|
||||||
|
const cronJob = this.cronJobManager.addCronjob(
|
||||||
|
cronString,
|
||||||
|
async (triggerTime: number) => {
|
||||||
|
this.logTaskState(task);
|
||||||
|
if (this.options.distributedCoordinator) {
|
||||||
|
const announcementResult = await this.performDistributedConsultation(task, triggerTime);
|
||||||
|
if (!announcementResult.shouldTrigger) {
|
||||||
|
console.log('Distributed coordinator result: NOT EXECUTING');
|
||||||
|
return;
|
||||||
|
} else {
|
||||||
|
console.log('Distributed coordinator result: CHOSEN AND EXECUTING');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
await task.trigger();
|
||||||
|
}
|
||||||
|
);
|
||||||
|
task.cronJob = cronJob;
|
||||||
|
}
|
||||||
|
|
||||||
|
private logTaskState(task: Task) {
|
||||||
|
console.log(`Taskbuffer schedule triggered task >>${task.name}<<`);
|
||||||
|
const bufferState = task.buffered
|
||||||
|
? `buffered with max ${task.bufferMax} buffered calls`
|
||||||
|
: `unbuffered`;
|
||||||
|
console.log(`Task >>${task.name}<< is ${bufferState}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
private async performDistributedConsultation(task: Task, triggerTime: number): Promise<IDistributedTaskRequestResult> {
|
||||||
|
console.log('Found a distributed coordinator, performing consultation.');
|
||||||
|
|
||||||
|
return this.options.distributedCoordinator.fireDistributedTaskRequest({
|
||||||
|
submitterId: this.randomId,
|
||||||
|
requestResponseId: plugins.smartunique.shortId(),
|
||||||
|
status: 'requesting',
|
||||||
|
taskExecutionParallel: 1,
|
||||||
|
taskExecutionTime: triggerTime,
|
||||||
|
taskExecutionTimeout: task.timeout,
|
||||||
|
taskName: task.name,
|
||||||
|
taskVersion: task.version,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
public descheduleTaskByName(taskName: string) {
|
||||||
|
const task = this.getTaskByName(taskName);
|
||||||
|
if (task && task.cronJob) {
|
||||||
|
this.cronJobManager.removeCronjob(task.cronJob);
|
||||||
|
task.cronJob = null;
|
||||||
|
}
|
||||||
|
if (this.cronJobManager.cronjobs.isEmpty) {
|
||||||
|
this.cronJobManager.stop();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public async descheduleTask(task: Task) {
|
||||||
|
await this.descheduleTaskByName(task.name);
|
||||||
|
}
|
||||||
|
|
||||||
|
public getScheduleForTaskName(taskName: string): string | null {
|
||||||
|
const task = this.getTaskByName(taskName);
|
||||||
|
return task && task.cronJob ? task.cronJob.cronExpression : null;
|
||||||
|
}
|
||||||
|
|
||||||
|
public async start() {
|
||||||
|
if (this.options.distributedCoordinator) {
|
||||||
|
await this.options.distributedCoordinator.start();
|
||||||
|
}
|
||||||
|
this.cronJobManager.start();
|
||||||
|
}
|
||||||
|
|
||||||
|
public async stop() {
|
||||||
|
this.cronJobManager.stop();
|
||||||
|
if (this.options.distributedCoordinator) {
|
||||||
|
await this.options.distributedCoordinator.stop();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
21
ts/taskbuffer.classes.taskonce.ts
Normal file
21
ts/taskbuffer.classes.taskonce.ts
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
import * as plugins from './taskbuffer.plugins.js';
|
||||||
|
|
||||||
|
import { Task, type ITaskFunction } from './taskbuffer.classes.task.js';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* TaskOnce is run exactly once, no matter how often it is triggered
|
||||||
|
*/
|
||||||
|
export class TaskOnce extends Task {
|
||||||
|
hasTriggered: boolean = false;
|
||||||
|
constructor(optionsArg: { name?: string; taskFunction: ITaskFunction }) {
|
||||||
|
super({
|
||||||
|
name: optionsArg.name,
|
||||||
|
taskFunction: async () => {
|
||||||
|
if (!this.hasTriggered) {
|
||||||
|
this.hasTriggered = true;
|
||||||
|
await optionsArg.taskFunction();
|
||||||
|
}
|
||||||
|
},
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
@@ -1,29 +1,24 @@
|
|||||||
import * as plugins from "./taskbuffer.plugins"
|
import * as plugins from './taskbuffer.plugins.js';
|
||||||
import * as helpers from "./taskbuffer.classes.helpers"
|
import { Task } from './taskbuffer.classes.task.js';
|
||||||
import { Task } from "./taskbuffer.classes.task"
|
|
||||||
|
|
||||||
export class Taskparallel extends Task {
|
export class Taskparallel extends Task {
|
||||||
taskArray: Task[];
|
public taskArray: Task[];
|
||||||
constructor(optionsArg: {
|
constructor(optionsArg: { taskArray: Task[] }) {
|
||||||
taskArray: Task[]
|
const options = {
|
||||||
}){
|
...optionsArg,
|
||||||
let options = plugins.lodash.merge(
|
...{
|
||||||
optionsArg,
|
|
||||||
{
|
|
||||||
taskFunction: () => {
|
taskFunction: () => {
|
||||||
let done = plugins.Q.defer();
|
const done = plugins.smartpromise.defer();
|
||||||
let promiseArray:PromiseLike<any>[] = []; // stores promises of all tasks, since they run in parallel
|
const promiseArray: Promise<any>[] = []; // stores promises of all tasks, since they run in parallel
|
||||||
this.taskArray.forEach(function (taskArg) {
|
this.taskArray.forEach(function (taskArg) {
|
||||||
promiseArray.push(taskArg.trigger());
|
promiseArray.push(taskArg.trigger());
|
||||||
})
|
});
|
||||||
plugins.Q.all(promiseArray)
|
Promise.all(promiseArray).then(done.resolve);
|
||||||
.then(done.resolve);
|
|
||||||
return done.promise;
|
return done.promise;
|
||||||
}
|
},
|
||||||
}
|
},
|
||||||
);
|
};
|
||||||
super(options);
|
super(options);
|
||||||
this.taskArray = optionsArg.taskArray;
|
this.taskArray = optionsArg.taskArray;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
63
ts/taskbuffer.classes.taskrunner.ts
Normal file
63
ts/taskbuffer.classes.taskrunner.ts
Normal file
@@ -0,0 +1,63 @@
|
|||||||
|
import * as plugins from './taskbuffer.plugins.js';
|
||||||
|
|
||||||
|
import { Task } from './taskbuffer.classes.task.js';
|
||||||
|
|
||||||
|
export class TaskRunner {
|
||||||
|
public maxParrallelJobs: number = 1;
|
||||||
|
public status: 'stopped' | 'running' = 'stopped';
|
||||||
|
public runningTasks: plugins.lik.ObjectMap<Task> = new plugins.lik.ObjectMap<Task>();
|
||||||
|
public qeuedTasks: Task[] = [];
|
||||||
|
|
||||||
|
constructor() {
|
||||||
|
this.runningTasks.eventSubject.subscribe(async (eventArg) => {
|
||||||
|
this.checkExecution();
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* adds a task to the qeue
|
||||||
|
*/
|
||||||
|
public addTask(taskArg: Task) {
|
||||||
|
this.qeuedTasks.push(taskArg);
|
||||||
|
this.checkExecution();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* set amount of parallel tasks
|
||||||
|
* be careful, you might loose dependability of tasks
|
||||||
|
*/
|
||||||
|
public setMaxParallelJobs(maxParrallelJobsArg: number) {
|
||||||
|
this.maxParrallelJobs = maxParrallelJobsArg;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* starts the task queue
|
||||||
|
*/
|
||||||
|
public async start() {
|
||||||
|
this.status = 'running';
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* checks wether execution is on point
|
||||||
|
*/
|
||||||
|
public async checkExecution() {
|
||||||
|
if (
|
||||||
|
this.runningTasks.getArray().length < this.maxParrallelJobs &&
|
||||||
|
this.status === 'running' &&
|
||||||
|
this.qeuedTasks.length > 0
|
||||||
|
) {
|
||||||
|
const nextJob = this.qeuedTasks.shift();
|
||||||
|
this.runningTasks.add(nextJob);
|
||||||
|
await nextJob.trigger();
|
||||||
|
this.runningTasks.remove(nextJob);
|
||||||
|
this.checkExecution();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* stops the task queue
|
||||||
|
*/
|
||||||
|
public async stop() {
|
||||||
|
this.status = 'stopped';
|
||||||
|
}
|
||||||
|
}
|
@@ -1,6 +0,0 @@
|
|||||||
import * as plugins from "./taskbuffer.plugins"
|
|
||||||
import * as helpers from "./taskbuffer.classes.helpers"
|
|
||||||
|
|
||||||
export class Taskspace {
|
|
||||||
|
|
||||||
}
|
|
3
ts/taskbuffer.logging.ts
Normal file
3
ts/taskbuffer.logging.ts
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
import * as plugins from './taskbuffer.plugins.js';
|
||||||
|
|
||||||
|
export const logger = new plugins.smartlog.ConsoleLog();
|
@@ -1,5 +1,9 @@
|
|||||||
import "typings-global"
|
import * as lik from '@push.rocks/lik';
|
||||||
export import beautylog = require("beautylog");
|
import * as smartlog from '@push.rocks/smartlog';
|
||||||
export import Q = require("q");
|
import * as smartpromise from '@push.rocks/smartpromise';
|
||||||
export import lodash= require("lodash");
|
import * as smartdelay from '@push.rocks/smartdelay';
|
||||||
export import rxjs = require("rxjs");
|
import * as smartrx from '@push.rocks/smartrx';
|
||||||
|
import * as smarttime from '@push.rocks/smarttime';
|
||||||
|
import * as smartunique from '@push.rocks/smartunique';
|
||||||
|
|
||||||
|
export { lik, smartlog, smartpromise, smartdelay, smartrx, smarttime, smartunique };
|
||||||
|
14
tsconfig.json
Normal file
14
tsconfig.json
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
{
|
||||||
|
"compilerOptions": {
|
||||||
|
"experimentalDecorators": true,
|
||||||
|
"useDefineForClassFields": false,
|
||||||
|
"target": "ES2022",
|
||||||
|
"module": "NodeNext",
|
||||||
|
"moduleResolution": "NodeNext",
|
||||||
|
"esModuleInterop": true,
|
||||||
|
"verbatimModuleSyntax": true
|
||||||
|
},
|
||||||
|
"exclude": [
|
||||||
|
"dist_*/**/*.d.ts"
|
||||||
|
]
|
||||||
|
}
|
Reference in New Issue
Block a user