fix(tests): Update test runner and imports, refresh README and package metadata, add project tooling/config files

This commit is contained in:
2025-08-26 20:15:46 +00:00
parent 65886287c6
commit 67f01417b6
20 changed files with 7946 additions and 4780 deletions

Binary file not shown.

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

View 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

View 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
```

View 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
View 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"

84
changelog.md Normal file
View 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.101.0.16).
- Implemented execDelay for tasks.
- Documentation and test improvements.
## 2016-08-03 - 1.0.6 - types
Type and promise improvements.
- Now returns correct Promise types.
- Dependency and typings updates.
## 2016-08-01 - 1.0.0 - stable
First stable 1.0.0 release.
- Exported public interfaces.
- Base API stabilized for 1.x line.
## 2016-05-15 to 2016-05-06 - 0.1.0..0.0.5 - initial features
Initial implementation of core task primitives and utilities.
- Added Taskparallel class to execute tasks in parallel.
- Introduced basic Task class and working taskchain.
- Added logging and initial task buffering behavior.
- Improvements to README, typings and packaging.
- Early CI and build setup (Travis/GitLab CI).

View File

@@ -7,7 +7,7 @@
"typings": "dist_ts/index.d.ts", "typings": "dist_ts/index.d.ts",
"type": "module", "type": "module",
"scripts": { "scripts": {
"test": "(tstest test/ --web)", "test": "(tstest test/ --verbose --logfile --timeout 120)",
"build": "(tsbuild --web && tsbundle npm)", "build": "(tsbuild --web && tsbundle npm)",
"buildDocs": "tsdoc" "buildDocs": "tsdoc"
}, },
@@ -46,8 +46,7 @@
"@git.zone/tsbuild": "^2.1.66", "@git.zone/tsbuild": "^2.1.66",
"@git.zone/tsbundle": "^2.0.8", "@git.zone/tsbundle": "^2.0.8",
"@git.zone/tsrun": "^1.2.44", "@git.zone/tsrun": "^1.2.44",
"@git.zone/tstest": "^1.0.77", "@git.zone/tstest": "^2.3.5",
"@push.rocks/tapbundle": "^5.0.15",
"@types/node": "^20.8.7" "@types/node": "^20.8.7"
}, },
"files": [ "files": [
@@ -64,5 +63,6 @@
], ],
"browserslist": [ "browserslist": [
"last 1 chrome versions" "last 1 chrome versions"
] ],
"packageManager": "pnpm@10.14.0+sha512.ad27a79641b49c3e481a16a805baa71817a04bbe06a38d17e60e2eaee83f6a146c6a688125f5792e48dd5ba30e7da52a5cda4c3992b9ccf333f9ce223af84748"
} }

11843
pnpm-lock.yaml generated

File diff suppressed because it is too large Load Diff

489
readme.md
View File

@@ -1,151 +1,478 @@
# @push.rocks/taskbuffer # @push.rocks/taskbuffer 🚀
flexible task management. TypeScript ready!
## Install 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.
To install `@push.rocks/taskbuffer`, use the following npm command:
## Install 📦
```bash ```bash
npm install @push.rocks/taskbuffer --save npm install @push.rocks/taskbuffer --save
``` ```
This will add `@push.rocks/taskbuffer` to your project's dependencies, allowing you to use it within your TypeScript project. Or with **pnpm** (recommended):
## Usage ```bash
`@push.rocks/taskbuffer` offers a versatile way to manage tasks in your application. Whether you need simple asynchronous task execution, buffered tasks to limit concurrent executions, or more complex scenarios involving task chaining and parallel execution, `@push.rocks/taskbuffer` has got you covered. Below, you'll find detailed examples showcasing the module's capabilities and how to use them in TypeScript. 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 ### Basic Task Execution
To create and run a simple task:
```typescript ```typescript
import { Task } from '@push.rocks/taskbuffer'; import { Task } from '@push.rocks/taskbuffer';
const simpleTask = new Task({ // Create a simple task
name: 'SimpleTask', const myTask = new Task({
name: 'DataProcessor',
taskFunction: async () => { taskFunction: async () => {
console.log('Executing a simple task'); const data = await fetchData();
// Perform your task here (e.g., fetch data from an API) return processData(data);
} }
}); });
// Trigger the task // Execute the task
simpleTask.trigger(); const result = await myTask.trigger();
``` ```
This basic example creates a task that prints a message to the console when executed. ### Buffered Execution (Rate Limiting)
### Buffered Task Execution Perfect for API calls or database operations that need throttling:
Buffered tasks allow you to throttle task executions, for example, to avoid overwhelming a server with simultaneous requests:
```typescript ```typescript
import { Task } from '@push.rocks/taskbuffer'; const apiTask = new Task({
name: 'APICall',
const bufferedTask = new Task({ taskFunction: async (endpoint: string) => {
name: 'BufferedTask', return await fetch(endpoint);
taskFunction: async () => {
// Task implementation
console.log('Buffered task execution');
}, },
buffered: true, buffered: true,
bufferMax: 3 // Maximum number of concurrent executions bufferMax: 3, // Maximum 3 concurrent executions
execDelay: 1000 // Wait 1 second between executions
}); });
// Trigger the task multiple times // These will be automatically throttled
bufferedTask.trigger(); for (let i = 0; i < 10; i++) {
bufferedTask.trigger(); apiTask.trigger(`/api/data/${i}`);
bufferedTask.trigger(); }
bufferedTask.trigger();
``` ```
In this scenario, only three instances of `bufferedTask` will run concurrently, thanks to the buffer settings. ### Task Chains - Sequential Workflows
### Task Chains Build complex workflows where each step depends on the previous:
Task chains are a powerful feature that allows you to execute tasks in a specified order:
```typescript ```typescript
import { Task, Taskchain } from '@push.rocks/taskbuffer'; import { Task, Taskchain } from '@push.rocks/taskbuffer';
const firstTask = new Task({ const fetchTask = new Task({
name: 'FirstTask', name: 'FetchData',
taskFunction: async () => { taskFunction: async () => {
console.log('First task execution'); const response = await fetch('/api/data');
// First task logic return response.json();
} }
}); });
const secondTask = new Task({ const transformTask = new Task({
name: 'SecondTask', name: 'TransformData',
taskFunction: async () => { taskFunction: async (data) => {
console.log('Second task execution'); return data.map(item => ({
// Second task logic ...item,
processed: true,
timestamp: Date.now()
}));
} }
}); });
const taskChain = new Taskchain({ const saveTask = new Task({
name: 'MyTaskChain', name: 'SaveData',
taskArray: [firstTask, secondTask] // Tasks will be executed in the order they are provided taskFunction: async (transformedData) => {
await database.bulkInsert(transformedData);
return { saved: transformedData.length };
}
}); });
// Trigger the task chain const workflow = new Taskchain({
taskChain.trigger(); name: 'DataPipeline',
taskArray: [fetchTask, transformTask, saveTask]
});
// Execute the entire chain
const result = await workflow.trigger();
console.log(`Processed ${result.saved} items`);
``` ```
### Parallel Task Execution ### Parallel Execution - Maximum Performance
To run tasks in parallel, use `Taskparallel`:
Execute multiple independent tasks simultaneously:
```typescript ```typescript
import { Task, Taskparallel } from '@push.rocks/taskbuffer'; import { Task, Taskparallel } from '@push.rocks/taskbuffer';
const taskOne = new Task({ const tasks = ['user', 'posts', 'comments'].map(resource =>
name: 'TaskOne', new Task({
name: `Fetch${resource}`,
taskFunction: async () => { taskFunction: async () => {
// Task one logic const data = await fetch(`/api/${resource}`);
console.log('Task one execution'); return data.json();
} }
})
);
const parallelFetch = new Taskparallel({
taskArray: tasks
}); });
const taskTwo = new Task({ // All tasks execute simultaneously
name: 'TaskTwo', const [users, posts, comments] = await parallelFetch.trigger();
taskFunction: async () => {
// Task two logic
console.log('Task two execution');
}
});
const parallelTask = new Taskparallel({
taskArray: [taskOne, taskTwo] // These tasks will be executed in parallel
});
// Trigger the parallel tasks
parallelTask.trigger();
``` ```
### Task Scheduling with Task Manager ### Scheduled Tasks with TaskManager
`@push.rocks/taskbuffer` also provides a `TaskManager` to schedule tasks using cron expressions:
Run tasks on a schedule using cron expressions:
```typescript ```typescript
import { Task, TaskManager } from '@push.rocks/taskbuffer'; import { Task, TaskManager } from '@push.rocks/taskbuffer';
const scheduledTask = new Task({ const backupTask = new Task({
name: 'ScheduledTask', name: 'DatabaseBackup',
taskFunction: async () => { taskFunction: async () => {
console.log('Scheduled task execution'); await performBackup();
// Task logic here console.log(`Backup completed at ${new Date().toISOString()}`);
} }
}); });
const taskManager = new TaskManager(); const manager = new TaskManager();
taskManager.addAndScheduleTask(scheduledTask, '0 * * * * *'); // Execute task at the start of every minute
// Start the task manager to enable the scheduled execution // Add and schedule tasks
taskManager.start(); 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();
``` ```
### Advanced Use Cases ### Debounced Tasks - Smart Throttling
The flexibility of `@push.rocks/taskbuffer` allows for more sophisticated task management scenarios. You can combine the features mentioned above to fit your specific needs, such as chaining parallel tasks, dynamically adding tasks to a manager or chain based on conditions, and much more.
`@push.rocks/taskbuffer` leverages TypeScript's advanced typing features to provide you with clear and predictable APIs, making it easier to build and maintain complex task management logic within your application. Prevent task spam with intelligent debouncing:
For further information and advanced configurations, please refer to the [official documentation](https://gitlab.com/pushrocks/taskbuffer). ```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 ## License and Legal Information

View File

@@ -1,4 +1,4 @@
import { expect, tap } from '@push.rocks/tapbundle'; import { expect, tap } from '@git.zone/tstest/tapbundle';
import * as taskbuffer from '../ts/index.js'; import * as taskbuffer from '../ts/index.js';
import * as smartpromise from '@push.rocks/smartpromise'; import * as smartpromise from '@push.rocks/smartpromise';
import * as smartdelay from '@push.rocks/smartdelay'; import * as smartdelay from '@push.rocks/smartdelay';

View File

@@ -1,4 +1,4 @@
import { expect, tap } from '@push.rocks/tapbundle'; import { expect, tap } from '@git.zone/tstest/tapbundle';
import * as taskbuffer from '../ts/index.js'; import * as taskbuffer from '../ts/index.js';

View File

@@ -1,4 +1,4 @@
import { expect, tap } from '@push.rocks/tapbundle'; import { expect, tap } from '@git.zone/tstest/tapbundle';
import * as smartdelay from '@push.rocks/smartdelay'; import * as smartdelay from '@push.rocks/smartdelay';
import * as taskbuffer from '../ts/index.js'; import * as taskbuffer from '../ts/index.js';

View File

@@ -1,4 +1,4 @@
import { expect, tap } from '@push.rocks/tapbundle'; import { expect, tap } from '@git.zone/tstest/tapbundle';
import * as taskbuffer from '../ts/index.js'; import * as taskbuffer from '../ts/index.js';

View File

@@ -1,4 +1,4 @@
import { expect, tap } from '@push.rocks/tapbundle'; import { expect, tap } from '@git.zone/tstest/tapbundle';
import * as taskbuffer from '../ts/index.js'; import * as taskbuffer from '../ts/index.js';

View File

@@ -1,4 +1,4 @@
import { expect, tap } from '@push.rocks/tapbundle'; import { expect, tap } from '@git.zone/tstest/tapbundle';
import * as taskbuffer from '../ts/index.js'; import * as taskbuffer from '../ts/index.js';

View File

@@ -1,4 +1,4 @@
import { tap, expect } from '@push.rocks/tapbundle'; import { tap, expect } from '@git.zone/tstest/tapbundle';
import * as taskbuffer from '../ts/index.js'; import * as taskbuffer from '../ts/index.js';

View File

@@ -1,4 +1,4 @@
import { tap, expect } from '@push.rocks/tapbundle'; import { tap, expect } from '@git.zone/tstest/tapbundle';
import * as taskbuffer from '../ts/index.js'; import * as taskbuffer from '../ts/index.js';

View File

@@ -1,4 +1,4 @@
import { tap, expect } from '@push.rocks/tapbundle'; import { tap, expect } from '@git.zone/tstest/tapbundle';
import * as taskbuffer from '../ts/index.js'; import * as taskbuffer from '../ts/index.js';

View File

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