Compare commits

..

23 Commits

Author SHA1 Message Date
65886287c6 update description 2024-05-29 14:17:28 +02:00
fdaf772cfc update tsconfig 2024-04-14 18:38:20 +02:00
757b992440 update tsconfig 2024-04-01 21:42:31 +02:00
b4a701d128 update npmextra.json: githost 2024-04-01 20:00:12 +02:00
ca3ef8ced6 update npmextra.json: githost 2024-03-30 21:49:13 +01:00
6115bae66b 3.1.7 2023-10-20 13:05:40 +02:00
1be83af475 fix(core): update 2023-10-20 13:05:39 +02:00
bd14c41edc 3.1.6 2023-08-21 12:40:24 +02:00
d61b79282d fix(core): update 2023-08-21 12:40:24 +02:00
1cba9245fe 3.1.5 2023-08-15 12:02:45 +02:00
4b0db4da21 fix(core): update 2023-08-15 12:02:44 +02:00
a6cd0cb579 3.1.4 2023-08-15 11:39:32 +02:00
bd6109d5ea fix(core): update 2023-08-15 11:39:31 +02:00
aa632a5294 3.1.3 2023-08-13 09:37:24 +02:00
6499dd45cf fix(core): update 2023-08-13 09:37:23 +02:00
d04ed21607 3.1.2 2023-08-12 12:24:11 +02:00
bae776d4e9 fix(core): update 2023-08-12 12:24:10 +02:00
fcd7ea467e 3.1.1 2023-08-12 12:10:38 +02:00
e061b96056 fix(core): update 2023-08-12 12:10:37 +02:00
c2ce669f0c 3.1.0 2023-08-04 13:03:29 +02:00
05f91c3e35 feat(Task): Tasks can now be blocked by other tasks. 2023-08-04 13:03:28 +02:00
94e327c722 3.0.15 2023-08-04 11:58:54 +02:00
57a27604a7 fix(core): update 2023-08-04 11:58:53 +02:00
13 changed files with 1855 additions and 854 deletions

View File

@ -119,6 +119,6 @@ jobs:
run: | run: |
npmci node install stable npmci node install stable
npmci npm install npmci npm install
pnpm install -g @gitzone/tsdoc pnpm install -g @git.zone/tsdoc
npmci command tsdoc npmci command tsdoc
continue-on-error: true continue-on-error: true

View File

@ -7,12 +7,27 @@
"gitzone": { "gitzone": {
"projectType": "npm", "projectType": "npm",
"module": { "module": {
"githost": "gitlab.com", "githost": "code.foss.global",
"gitscope": "push.rocks", "gitscope": "push.rocks",
"gitrepo": "taskbuffer", "gitrepo": "taskbuffer",
"description": "flexible task management. TypeScript ready!", "description": "A flexible task management library supporting TypeScript, allowing for task buffering, scheduling, and execution with dependency management.",
"npmPackagename": "@push.rocks/taskbuffer", "npmPackagename": "@push.rocks/taskbuffer",
"license": "MIT" "license": "MIT",
} "keywords": [
"task management",
"TypeScript",
"task buffering",
"task scheduling",
"task execution",
"task dependencies",
"parallel tasks",
"task chains",
"debounced tasks",
"distributed coordination"
]
}
},
"tsdoc": {
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
} }
} }

View File

@ -1,8 +1,8 @@
{ {
"name": "@push.rocks/taskbuffer", "name": "@push.rocks/taskbuffer",
"version": "3.0.14", "version": "3.1.7",
"private": false, "private": false,
"description": "flexible task management. TypeScript ready!", "description": "A flexible task management library supporting TypeScript, allowing for task buffering, scheduling, and execution with dependency management.",
"main": "dist_ts/index.js", "main": "dist_ts/index.js",
"typings": "dist_ts/index.d.ts", "typings": "dist_ts/index.d.ts",
"type": "module", "type": "module",
@ -13,37 +13,42 @@
}, },
"repository": { "repository": {
"type": "git", "type": "git",
"url": "git+https://gitlab.com/pushrocks/taskbuffer.git" "url": "https://code.foss.global/push.rocks/taskbuffer.git"
}, },
"keywords": [ "keywords": [
"gulp", "task management",
"task",
"buffer",
"TypeScript", "TypeScript",
"push.rocks" "task buffering",
"task scheduling",
"task execution",
"task dependencies",
"parallel tasks",
"task chains",
"debounced tasks",
"distributed coordination"
], ],
"author": "Lossless GmbH", "author": "Lossless GmbH",
"license": "MIT", "license": "MIT",
"bugs": { "bugs": {
"url": "https://gitlab.com/pushrocks/taskbuffer/issues" "url": "https://gitlab.com/pushrocks/taskbuffer/issues"
}, },
"homepage": "https://gitlab.com/pushrocks/taskbuffer#readme", "homepage": "https://code.foss.global/push.rocks/taskbuffer",
"dependencies": { "dependencies": {
"@push.rocks/isounique": "^1.0.5", "@push.rocks/lik": "^6.0.5",
"@push.rocks/lik": "^6.0.3",
"@push.rocks/smartdelay": "^3.0.5", "@push.rocks/smartdelay": "^3.0.5",
"@push.rocks/smartlog": "^3.0.3", "@push.rocks/smartlog": "^3.0.3",
"@push.rocks/smartpromise": "^4.0.3", "@push.rocks/smartpromise": "^4.0.3",
"@push.rocks/smartrx": "^3.0.6", "@push.rocks/smartrx": "^3.0.6",
"@push.rocks/smarttime": "^4.0.4" "@push.rocks/smarttime": "^4.0.6",
"@push.rocks/smartunique": "^3.0.6"
}, },
"devDependencies": { "devDependencies": {
"@gitzone/tsbuild": "^2.1.66", "@git.zone/tsbuild": "^2.1.66",
"@gitzone/tsbundle": "^2.0.8", "@git.zone/tsbundle": "^2.0.8",
"@gitzone/tsrun": "^1.2.44", "@git.zone/tsrun": "^1.2.44",
"@gitzone/tstest": "^1.0.77", "@git.zone/tstest": "^1.0.77",
"@push.rocks/tapbundle": "^5.0.12", "@push.rocks/tapbundle": "^5.0.15",
"@types/node": "^20.4.5" "@types/node": "^20.8.7"
}, },
"files": [ "files": [
"ts/**/*", "ts/**/*",

2148
pnpm-lock.yaml generated

File diff suppressed because it is too large Load Diff

1
readme.hints.md Normal file
View File

@ -0,0 +1 @@

204
readme.md
View File

@ -1,61 +1,167 @@
# @push.rocks/taskbuffer # @push.rocks/taskbuffer
flexible task management. TypeScript ready! flexible task management. TypeScript ready!
## Availabililty and Links ## Install
* [npmjs.org (npm package)](https://www.npmjs.com/package/@push.rocks/taskbuffer) To install `@push.rocks/taskbuffer`, use the following npm command:
* [gitlab.com (source)](https://gitlab.com/push.rocks/taskbuffer)
* [github.com (source mirror)](https://github.com/push.rocks/taskbuffer)
* [docs (typedoc)](https://push.rocks.gitlab.io/taskbuffer/)
## Status for master ```bash
npm install @push.rocks/taskbuffer --save
Status Category | Status Badge
-- | --
GitLab Pipelines | [![pipeline status](https://gitlab.com/push.rocks/taskbuffer/badges/master/pipeline.svg)](https://lossless.cloud)
GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/push.rocks/taskbuffer/badges/master/coverage.svg)](https://lossless.cloud)
npm | [![npm downloads per month](https://badgen.net/npm/dy/@push.rocks/taskbuffer)](https://lossless.cloud)
Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/push.rocks/taskbuffer)](https://lossless.cloud)
TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@push.rocks/taskbuffer)](https://lossless.cloud)
PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@push.rocks/taskbuffer)](https://lossless.cloud)
BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@push.rocks/taskbuffer)](https://lossless.cloud)
## Usage
We highly recommend TypeScript as this module supports **TypeScript intellisense**.
```javascript
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",
buffered: true, // optional
bufferMax: 3, // optional, call qeues greater than this are truncated
execDelay: 1000, // optional, time in ms to wait before executing task call
taskFunction:() => {
// do some stuff and return promise
// pass on any data through promise resolution
// Use TypeScript for better understanding and code completion
}
})
``` ```
For further information read the linked docs at the top of this README. This will add `@push.rocks/taskbuffer` to your project's dependencies, allowing you to use it within your TypeScript project.
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh) ## Usage
`@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.
[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks) ### Basic Task Execution
To create and run a simple task:
## Contribution ```typescript
import { Task } from '@push.rocks/taskbuffer';
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :) const simpleTask = new Task({
name: 'SimpleTask',
taskFunction: async () => {
console.log('Executing a simple task');
// Perform your task here (e.g., fetch data from an API)
}
});
For further information read the linked docs at the top of this readme. // Trigger the task
simpleTask.trigger();
```
## Legal This basic example creates a task that prints a message to the console when executed.
> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy) ### Buffered Task Execution
Buffered tasks allow you to throttle task executions, for example, to avoid overwhelming a server with simultaneous requests:
```typescript
import { Task } from '@push.rocks/taskbuffer';
const bufferedTask = new Task({
name: 'BufferedTask',
taskFunction: async () => {
// Task implementation
console.log('Buffered task execution');
},
buffered: true,
bufferMax: 3 // Maximum number of concurrent executions
});
// Trigger the task multiple times
bufferedTask.trigger();
bufferedTask.trigger();
bufferedTask.trigger();
bufferedTask.trigger();
```
In this scenario, only three instances of `bufferedTask` will run concurrently, thanks to the buffer settings.
### Task Chains
Task chains are a powerful feature that allows you to execute tasks in a specified order:
```typescript
import { Task, Taskchain } from '@push.rocks/taskbuffer';
const firstTask = new Task({
name: 'FirstTask',
taskFunction: async () => {
console.log('First task execution');
// First task logic
}
});
const secondTask = new Task({
name: 'SecondTask',
taskFunction: async () => {
console.log('Second task execution');
// Second task logic
}
});
const taskChain = new Taskchain({
name: 'MyTaskChain',
taskArray: [firstTask, secondTask] // Tasks will be executed in the order they are provided
});
// Trigger the task chain
taskChain.trigger();
```
### Parallel Task Execution
To run tasks in parallel, use `Taskparallel`:
```typescript
import { Task, Taskparallel } from '@push.rocks/taskbuffer';
const taskOne = new Task({
name: 'TaskOne',
taskFunction: async () => {
// Task one logic
console.log('Task one execution');
}
});
const taskTwo = new Task({
name: 'TaskTwo',
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
`@push.rocks/taskbuffer` also provides a `TaskManager` to schedule tasks using cron expressions:
```typescript
import { Task, TaskManager } from '@push.rocks/taskbuffer';
const scheduledTask = new Task({
name: 'ScheduledTask',
taskFunction: async () => {
console.log('Scheduled task execution');
// Task logic here
}
});
const taskManager = new TaskManager();
taskManager.addAndScheduleTask(scheduledTask, '0 * * * * *'); // Execute task at the start of every minute
// Start the task manager to enable the scheduled execution
taskManager.start();
```
### Advanced Use Cases
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.
For further information and advanced configurations, please refer to the [official documentation](https://gitlab.com/pushrocks/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.

View File

@ -12,13 +12,6 @@ tap.test('new Task() should return a new task', async () => {
expect(testTask).toBeInstanceOf(taskbuffer.Task); expect(testTask).toBeInstanceOf(taskbuffer.Task);
}); });
tap.test('should be able to get the task state', async () => {
const testTask = new taskbuffer.Task({
taskFunction: async () => {},
});
expect(testTask.state).toEqual('ready');
});
tap.test('should have bufferMax set to the provided value', async () => { tap.test('should have bufferMax set to the provided value', async () => {
const task2 = new taskbuffer.Task({ const task2 = new taskbuffer.Task({
taskFunction: async () => {}, taskFunction: async () => {},

View File

@ -3,6 +3,6 @@
*/ */
export const commitinfo = { export const commitinfo = {
name: '@push.rocks/taskbuffer', name: '@push.rocks/taskbuffer',
version: '3.0.14', version: '3.1.7',
description: 'flexible task management. TypeScript ready!' description: 'flexible task management. TypeScript ready!'
} }

View File

@ -2,13 +2,11 @@ import { Task } from './taskbuffer.classes.task.js';
import * as plugins from './taskbuffer.plugins.js'; import * as plugins from './taskbuffer.plugins.js';
/** /**
* constains all data for the final coordinator to actually make an informed decision * Contains all data for the final coordinator to make an informed decision.
*/ */
export interface IDistributedTaskRequest { export interface IDistributedTaskRequest {
/** submitterId: string;
* this needs to correlate to the consultationResult requestResponseId: string;
*/
submitterRandomId: string;
taskName: string; taskName: string;
taskVersion: string; taskVersion: string;
taskExecutionTime: number; taskExecutionTime: number;
@ -18,24 +16,23 @@ export interface IDistributedTaskRequest {
} }
export interface IDistributedTaskRequestResult { export interface IDistributedTaskRequestResult {
/** submitterId: string;
* this needs to correlate to the decisionInfoBasis requestResponseId: string;
*/
submitterRandomId: string;
/**
* can be used while debugging
*/
considered: boolean; considered: boolean;
rank: string; rank: number;
reason: string; reason: string;
shouldTrigger: boolean; shouldTrigger: boolean;
} }
export abstract class AbstractDistributedCoordinator { export abstract class AbstractDistributedCoordinator {
public abstract fireDistributedTaskRequest( public abstract fireDistributedTaskRequest(
infoBasisArg: IDistributedTaskRequest infoBasis: IDistributedTaskRequest
): Promise<IDistributedTaskRequestResult>; ): Promise<IDistributedTaskRequestResult>;
public abstract updateDistributedTaskRequest( public abstract updateDistributedTaskRequest(
infoBasisArg: IDistributedTaskRequest infoBasis: IDistributedTaskRequest
): Promise<void>; ): Promise<void>;
public abstract start(): Promise<void>;
public abstract stop(): Promise<void>;
} }

View File

@ -15,8 +15,9 @@ export interface ITaskSetupFunction<T = undefined> {
export type TPreOrAfterTaskFunction = () => Task<any>; export type TPreOrAfterTaskFunction = () => Task<any>;
export class Task<T = undefined> { export class Task<T = undefined> {
// STATIC public static extractTask<T = undefined>(
public static extractTask<T = undefined>(preOrAfterTaskArg: Task<T> | TPreOrAfterTaskFunction): Task<T> { preOrAfterTaskArg: Task<T> | TPreOrAfterTaskFunction
): Task<T> {
switch (true) { switch (true) {
case !preOrAfterTaskArg: case !preOrAfterTaskArg:
return null; return null;
@ -56,7 +57,7 @@ export class Task<T = undefined> {
} }
} }
return result; return result;
}; }
public static runTask = async <T>( public static runTask = async <T>(
taskArg: Task<T> | TPreOrAfterTaskFunction, taskArg: Task<T> | TPreOrAfterTaskFunction,
@ -65,6 +66,11 @@ export class Task<T = undefined> {
const taskToRun = Task.extractTask(taskArg); const taskToRun = Task.extractTask(taskArg);
const done = plugins.smartpromise.defer(); 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) { if (!taskToRun.setupValue && taskToRun.taskSetup) {
taskToRun.setupValue = await taskToRun.taskSetup(); taskToRun.setupValue = await taskToRun.taskSetup();
} }
@ -77,6 +83,14 @@ export class Task<T = undefined> {
done.promise.then(async () => { done.promise.then(async () => {
taskToRun.running = false; 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 = { const options = {
@ -125,7 +139,6 @@ export class Task<T = undefined> {
return await done.promise; return await done.promise;
}; };
// INSTANCE
public name: string; public name: string;
public version: string; public version: string;
public taskFunction: ITaskFunction<T>; public taskFunction: ITaskFunction<T>;
@ -139,12 +152,20 @@ export class Task<T = undefined> {
public preTask: Task<T> | TPreOrAfterTaskFunction; public preTask: Task<T> | TPreOrAfterTaskFunction;
public afterTask: 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 running: boolean = false;
public bufferRunner = new BufferRunner(this); public bufferRunner = new BufferRunner(this);
public cycleCounter = new CycleCounter(this); public cycleCounter = new CycleCounter(this);
public idle: boolean = true; public get idle() {
private _state: string = 'ready'; return !this.running;
}
public taskSetup: ITaskSetupFunction<T>; public taskSetup: ITaskSetupFunction<T>;
public setupValue: T; public setupValue: T;
@ -162,12 +183,16 @@ export class Task<T = undefined> {
this.taskFunction = optionsArg.taskFunction; this.taskFunction = optionsArg.taskFunction;
this.preTask = optionsArg.preTask; this.preTask = optionsArg.preTask;
this.afterTask = optionsArg.afterTask; this.afterTask = optionsArg.afterTask;
this.idle = !this.running;
this.buffered = optionsArg.buffered; this.buffered = optionsArg.buffered;
this.bufferMax = optionsArg.bufferMax; this.bufferMax = optionsArg.bufferMax;
this.execDelay = optionsArg.execDelay; this.execDelay = optionsArg.execDelay;
this.name = optionsArg.name; this.name = optionsArg.name;
this.taskSetup = optionsArg.taskSetup; this.taskSetup = optionsArg.taskSetup;
// Create the finished promise
this.finished = new Promise((resolve) => {
this.resolveFinished = resolve;
});
} }
public trigger(x?: any): Promise<any> { public trigger(x?: any): Promise<any> {
@ -185,16 +210,4 @@ export class Task<T = undefined> {
public triggerBuffered(x?: any): Promise<any> { public triggerBuffered(x?: any): Promise<any> {
return this.bufferRunner.trigger(x); return this.bufferRunner.trigger(x);
} }
get state(): string {
return this._state;
}
set state(stateArg: string) {
if (stateArg === 'locked') {
this._state = 'locked';
} else {
logger.log('error', `state type ${stateArg} could not be set`);
}
}
} }

View File

@ -1,10 +1,10 @@
import * as plugins from './taskbuffer.plugins.js'; import * as plugins from './taskbuffer.plugins.js';
import { Task } from './taskbuffer.classes.task.js'; import { Task } from './taskbuffer.classes.task.js';
import { AbstractDistributedCoordinator } from './taskbuffer.classes.distributedcoordinator.js'; import { AbstractDistributedCoordinator, type IDistributedTaskRequestResult } from './taskbuffer.classes.distributedcoordinator.js';
export interface ICronJob { export interface ICronJob {
cronString: string; cronString: string;
taskNameArg: string; taskName: string;
job: any; job: any;
} }
@ -13,57 +13,37 @@ export interface ITaskManagerConstructorOptions {
} }
export class TaskManager { export class TaskManager {
public randomId = plugins.isounique.uni(); public randomId = plugins.smartunique.shortId();
public taskMap = new plugins.lik.ObjectMap<Task>(); public taskMap = new plugins.lik.ObjectMap<Task>();
private cronJobManager = new plugins.smarttime.CronManager(); private cronJobManager = new plugins.smarttime.CronManager();
public options: ITaskManagerConstructorOptions = { public options: ITaskManagerConstructorOptions = {
distributedCoordinator: null, distributedCoordinator: null,
}; };
constructor(optionosArg: ITaskManagerConstructorOptions = {}) { constructor(options: ITaskManagerConstructorOptions = {}) {
this.options = Object.assign(this.options, optionosArg); this.options = Object.assign(this.options, options);
} }
/** public getTaskByName(taskName: string): Task {
* checks if a task is already present return this.taskMap.findSync((task) => task.name === taskName);
* @param taskNameArg
*/
public getTaskByName(taskNameArg: string): Task {
return this.taskMap.findSync((itemArg) => {
return itemArg.name === taskNameArg;
});
} }
/** public addTask(task: Task): void {
* adds a Task to the TaskManager if (!task.name) {
* @param taskArg throw new Error('Task must have a name to be added to taskManager');
*/
public addTask(taskArg: Task): void {
if (!taskArg.name) {
throw new Error('taskArg needs a name to be added to taskManager');
} }
this.taskMap.add(taskArg); this.taskMap.add(task);
} }
/** public addAndScheduleTask(task: Task, cronString: string) {
* adds and schedules a task at once this.addTask(task);
* @param taskArg this.scheduleTaskByName(task.name, cronString);
* @param cronStringArg
*/
public addAndScheduleTask(taskArg: Task, cronStringArg: string) {
this.addTask(taskArg);
this.scheduleTaskByName(taskArg.name, cronStringArg);
} }
/** public async triggerTaskByName(taskName: string): Promise<any> {
* triggers a task in the TaskManagerByName const taskToTrigger = this.getTaskByName(taskName);
* @param taskNameArg
*/
public triggerTaskByName(taskNameArg: string): Promise<any> {
const taskToTrigger = this.getTaskByName(taskNameArg);
if (!taskToTrigger) { if (!taskToTrigger) {
throw new Error(`There is no task with the name of ${taskNameArg}`); throw new Error(`No task with the name ${taskName} found.`);
} }
return taskToTrigger.trigger(); return taskToTrigger.trigger();
} }
@ -72,88 +52,88 @@ export class TaskManager {
return task.trigger(); return task.trigger();
} }
/** public scheduleTaskByName(taskName: string, cronString: string) {
* schedules the task by name const taskToSchedule = this.getTaskByName(taskName);
* @param taskNameArg if (!taskToSchedule) {
*/ throw new Error(`No task with the name ${taskName} found.`);
public scheduleTaskByName(taskNameArg: string, cronStringArg: string) { }
const taskToSchedule = this.getTaskByName(taskNameArg); this.handleTaskScheduling(taskToSchedule, cronString);
const cronJob = this.cronJobManager.addCronjob( }
cronStringArg,
async (triggerTimeArg: number) => {
console.log(`taskbuffer schedule triggered task >>${taskToSchedule.name}<<`);
console.log(
`task >>${taskToSchedule.name}<< is ${
taskToSchedule.buffered
? `buffered with max ${taskToSchedule.bufferMax} buffered calls`
: `unbuffered`
}`
);
if (this.options.distributedCoordinator) {
console.log(`Found a distrubuted coordinator, performing distributed consultation.`);
const announcementResult =
await this.options.distributedCoordinator.fireDistributedTaskRequest({
submitterRandomId: this.randomId,
status: 'requesting',
taskExecutionParallel: 1,
taskExecutionTime: triggerTimeArg,
taskExecutionTimeout: taskToSchedule.timeout,
taskName: taskToSchedule.name,
taskVersion: taskToSchedule.version,
});
private handleTaskScheduling(task: Task, cronString: string) {
const cronJob = this.cronJobManager.addCronjob(
cronString,
async (triggerTime: number) => {
this.logTaskState(task);
if (this.options.distributedCoordinator) {
const announcementResult = await this.performDistributedConsultation(task, triggerTime);
if (!announcementResult.shouldTrigger) { if (!announcementResult.shouldTrigger) {
console.log('distributed coordinator result: NOT EXECUTING'); console.log('Distributed coordinator result: NOT EXECUTING');
return; return;
} else { } else {
console.log('distributed coordinator result: CHOSEN AND EXECUTING'); console.log('Distributed coordinator result: CHOSEN AND EXECUTING');
} }
} }
await taskToSchedule.trigger(); await task.trigger();
} }
); );
taskToSchedule.cronJob = cronJob; task.cronJob = cronJob;
} }
/** private logTaskState(task: Task) {
* deschedules a task by name console.log(`Taskbuffer schedule triggered task >>${task.name}<<`);
* @param taskNameArg const bufferState = task.buffered
*/ ? `buffered with max ${task.bufferMax} buffered calls`
public descheduleTaskByName(taskNameArg: string) { : `unbuffered`;
const taskToDeSchedule = this.getTaskByName(taskNameArg); console.log(`Task >>${task.name}<< is ${bufferState}`);
if (taskToDeSchedule.cronJob) { }
this.cronJobManager.removeCronjob(taskToDeSchedule.cronJob);
taskToDeSchedule.cronJob = null; private async performDistributedConsultation(task: Task, triggerTime: number): Promise<IDistributedTaskRequestResult> {
console.log('Found a distributed coordinator, performing consultation.');
return this.options.distributedCoordinator.fireDistributedTaskRequest({
submitterId: this.randomId,
requestResponseId: plugins.smartunique.shortId(),
status: 'requesting',
taskExecutionParallel: 1,
taskExecutionTime: triggerTime,
taskExecutionTimeout: task.timeout,
taskName: task.name,
taskVersion: task.version,
});
}
public descheduleTaskByName(taskName: string) {
const task = this.getTaskByName(taskName);
if (task && task.cronJob) {
this.cronJobManager.removeCronjob(task.cronJob);
task.cronJob = null;
} }
if (this.cronJobManager.cronjobs.isEmpty) { if (this.cronJobManager.cronjobs.isEmpty) {
this.cronJobManager.stop(); this.cronJobManager.stop();
} }
} }
/**
* deschedules a task
* @param task
*/
public async descheduleTask(task: Task) { public async descheduleTask(task: Task) {
await this.descheduleTaskByName(task.name); await this.descheduleTaskByName(task.name);
} }
/**
* returns all schedules of a specific task
* @param taskNameArg
*/
public getSchedulesForTaskName(taskNameArg: string) {}
/** public getScheduleForTaskName(taskName: string): string | null {
* starts the taskmanager const task = this.getTaskByName(taskName);
*/ return task && task.cronJob ? task.cronJob.cronExpression : null;
public start() { }
public async start() {
if (this.options.distributedCoordinator) {
await this.options.distributedCoordinator.start();
}
this.cronJobManager.start(); this.cronJobManager.start();
} }
/** public async stop() {
* stops the taskmanager
*/
public stop() {
this.cronJobManager.stop(); this.cronJobManager.stop();
if (this.options.distributedCoordinator) {
await this.options.distributedCoordinator.stop();
}
} }
} }

View File

@ -1,9 +1,9 @@
import * as isounique from '@push.rocks/isounique';
import * as lik from '@push.rocks/lik'; import * as lik from '@push.rocks/lik';
import * as smartlog from '@push.rocks/smartlog'; import * as smartlog from '@push.rocks/smartlog';
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';
import * as smartrx from '@push.rocks/smartrx'; import * as smartrx from '@push.rocks/smartrx';
import * as smarttime from '@push.rocks/smarttime'; import * as smarttime from '@push.rocks/smarttime';
import * as smartunique from '@push.rocks/smartunique';
export { isounique, lik, smartlog, smartpromise, smartdelay, smartrx, smarttime }; export { lik, smartlog, smartpromise, smartdelay, smartrx, smarttime, smartunique };

View File

@ -3,9 +3,12 @@
"experimentalDecorators": true, "experimentalDecorators": true,
"useDefineForClassFields": false, "useDefineForClassFields": false,
"target": "ES2022", "target": "ES2022",
"module": "ES2022", "module": "NodeNext",
"moduleResolution": "nodenext", "moduleResolution": "NodeNext",
"esModuleInterop": true, "esModuleInterop": true,
"verbatimModuleSyntax": true, "verbatimModuleSyntax": true
} },
"exclude": [
"dist_*/**/*.d.ts"
]
} }