fix(core): update

This commit is contained in:
Philipp Kunz 2020-07-12 00:48:51 +00:00
parent f21b53b81d
commit fdfb780c33
28 changed files with 9040 additions and 841 deletions

4
.gitignore vendored
View File

@ -15,8 +15,6 @@ node_modules/
# builds
dist/
dist_web/
dist_serve/
dist_ts_web/
dist_*/
# custom

View File

@ -24,13 +24,14 @@ mirror:
- docker
- notpriv
snyk:
image: registry.gitlab.com/hosttoday/ht-docker-node:snyk
audit:
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
stage: security
script:
- npmci npm prepare
- npmci command npm install --ignore-scripts
- npmci command snyk test
- npmci command npm config set registry https://registry.npmjs.org
- npmci command npm audit --audit-level=high
tags:
- lossless
- docker

29
.vscode/launch.json vendored Normal file
View File

@ -0,0 +1,29 @@
{
"version": "0.2.0",
"configurations": [
{
"name": "current file",
"type": "node",
"request": "launch",
"args": [
"${relativeFile}"
],
"runtimeArgs": ["-r", "@gitzone/tsrun"],
"cwd": "${workspaceRoot}",
"protocol": "inspector",
"internalConsoleOptions": "openOnSessionStart"
},
{
"name": "test.ts",
"type": "node",
"request": "launch",
"args": [
"test/test.ts"
],
"runtimeArgs": ["-r", "@gitzone/tsrun"],
"cwd": "${workspaceRoot}",
"protocol": "inspector",
"internalConsoleOptions": "openOnSessionStart"
}
]
}

26
.vscode/settings.json vendored Normal file
View 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"]
}
}
}
}
}
}
]
}

View File

@ -5,6 +5,7 @@
"npmRegistryUrl": "registry.npmjs.org"
},
"gitzone": {
"projectType": "npm",
"module": {
"githost": "gitlab.com",
"gitscope": "pushrocks",

10221
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -3,11 +3,11 @@
"version": "2.1.1",
"private": false,
"description": "flexible task management. TypeScript ready!",
"main": "dist/index.js",
"typings": "dist/index.d.ts",
"main": "dist_ts/index.js",
"typings": "dist_ts/index.d.ts",
"scripts": {
"test": "(tstest test/)",
"build": "(tsbuild)"
"test": "(tstest test/ --web)",
"build": "(tsbuild --web && tsbundle npm)"
},
"repository": {
"type": "git",
@ -27,31 +27,35 @@
},
"homepage": "https://gitlab.com/pushrocks/taskbuffer#readme",
"dependencies": {
"@pushrocks/lik": "^3.0.13",
"@pushrocks/smartdelay": "^2.0.6",
"@pushrocks/smartlog": "^2.0.21",
"@pushrocks/lik": "^4.0.13",
"@pushrocks/smartdelay": "^2.0.10",
"@pushrocks/smartlog": "^2.0.35",
"@pushrocks/smartpromise": "^3.0.6",
"@types/cron": "^1.7.1",
"cron": "^1.7.2",
"rxjs": "^6.5.3"
"@pushrocks/smarttime": "^3.0.24",
"@types/cron": "^1.7.2"
},
"devDependencies": {
"@gitzone/tsbuild": "^2.1.17",
"@gitzone/tstest": "^1.0.28",
"@pushrocks/tapbundle": "^3.2.0",
"@types/node": "^12.12.14",
"tslint": "^5.20.1",
"@gitzone/tsbuild": "^2.1.24",
"@gitzone/tsbundle": "^1.0.72",
"@gitzone/tstest": "^1.0.41",
"@pushrocks/tapbundle": "^3.2.9",
"@types/node": "^14.0.22",
"tslint": "^6.1.2",
"tslint-config-prettier": "^1.18.0"
},
"files": [
"ts/**/*",
"ts_web/**/*",
"dist/**/*",
"dist_web/**/*",
"dist_*/**/*",
"dist_ts/**/*",
"dist_ts_web/**/*",
"assets/**/*",
"cli.js",
"npmextra.json",
"readme.md"
],
"browserslist": [
"last 1 chrome versions"
]
}

View File

@ -8,13 +8,20 @@ flexible task management. TypeScript ready!
* [docs (typedoc)](https://pushrocks.gitlab.io/taskbuffer/)
## Status for master
[![build status](https://gitlab.com/pushrocks/taskbuffer/badges/master/build.svg)](https://gitlab.com/pushrocks/taskbuffer/commits/master)
[![coverage report](https://gitlab.com/pushrocks/taskbuffer/badges/master/coverage.svg)](https://gitlab.com/pushrocks/taskbuffer/commits/master)
[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/taskbuffer.svg)](https://www.npmjs.com/package/@pushrocks/taskbuffer)
[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/taskbuffer/badge.svg)](https://snyk.io/test/npm/@pushrocks/taskbuffer)
[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
Status Category | Status Badge
-- | --
GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/taskbuffer/badges/master/pipeline.svg)](https://lossless.cloud)
GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/taskbuffer/badges/master/coverage.svg)](https://lossless.cloud)
npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/taskbuffer)](https://lossless.cloud)
Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/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/@pushrocks/taskbuffer)](https://lossless.cloud)
PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/taskbuffer)](https://lossless.cloud)
BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/taskbuffer)](https://lossless.cloud)
Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
## Usage
@ -44,7 +51,6 @@ For further information read the linked docs at the top of this README.
[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks)
## Contribution
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). :)

View File

@ -11,7 +11,7 @@ let testPreTask = new taskbuffer.Task({
taskFunction: async () => {
console.log('preTask executed');
},
preTask: testTask
preTask: testTask,
});
// some more tasks to test with
@ -27,7 +27,7 @@ let task1 = new taskbuffer.Task({
done.resolve();
}, 5000);
return done.promise;
}
},
});
let task2 = new taskbuffer.Task({
@ -40,7 +40,7 @@ let task2 = new taskbuffer.Task({
done.resolve();
}, 5000);
await done.promise;
}
},
});
let task3 = new taskbuffer.Task({
@ -53,7 +53,7 @@ let task3 = new taskbuffer.Task({
done.resolve();
}, 5000);
return done.promise;
}
},
});
tap.test('new Task() should return a new task', async () => {
@ -61,7 +61,7 @@ tap.test('new Task() should return a new task', async () => {
taskFunction: async () => {
console.log('executed twice');
},
preTask: testPreTask
preTask: testPreTask,
});
});
@ -93,7 +93,7 @@ tap.test('expect to run a task without pre and afterTask errorless', async () =>
let localTestTask = new taskbuffer.Task({
taskFunction: async () => {
console.log('only once');
}
},
});
await localTestTask.trigger();
});
@ -104,7 +104,7 @@ tap.test('expect task to run in buffered mode', async () => {
await smartdelay.delayFor(3000);
},
buffered: true,
bufferMax: 2
bufferMax: 2,
});
localTestTask.trigger();
localTestTask.trigger();

View File

@ -9,7 +9,7 @@ const task1 = new taskbuffer.Task({
taskFunction: async () => {
await smartdelay.delayFor(2000);
task1Executed = true;
}
},
});
let task2Executed = false;
@ -17,7 +17,7 @@ const task2 = new taskbuffer.Task({
taskFunction: async () => {
await smartdelay.delayFor(2000);
task2Executed = true;
}
},
});
let task3Executed = false;
@ -25,13 +25,13 @@ 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]
taskArray: [task1, task2, task3],
});
const testPromise = testTaskchain.trigger();
await smartdelay.delayFor(2100);

View File

@ -7,7 +7,7 @@ const task1 = new taskbuffer.Task({
taskFunction: async () => {
await smartdelay.delayFor(2000);
task1Executed = true;
}
},
});
let task2Executed = false;
@ -15,7 +15,7 @@ const task2 = new taskbuffer.Task({
taskFunction: async () => {
await smartdelay.delayFor(2000);
task2Executed = true;
}
},
});
let task3Executed = false;
@ -23,12 +23,12 @@ 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]
taskArray: [task1, task2, task3],
});
await testTaskparallel.trigger();
});

View File

@ -0,0 +1,42 @@
import { expect, tap } from '@pushrocks/tapbundle';
import taskbuffer = require('../ts/index');
import * as smartpromise from '@pushrocks/smartpromise';
import * as smartdelay from '@pushrocks/smartdelay';
let myTaskManager: taskbuffer.TaskManager;
let taskRunCounter = 0;
const taskDone = smartpromise.defer();
tap.test('should create an instance of TaskManager', async () => {
myTaskManager = new taskbuffer.TaskManager();
expect(myTaskManager).to.be.instanceof(taskbuffer.TaskManager);
});
tap.test('should run the task as expected', async () => {
let referenceBoolean = false;
myTaskManager.addTask(
new taskbuffer.Task({
name: 'myTask',
taskFunction: async () => {
console.log('Task executed!');
referenceBoolean = true;
taskRunCounter++;
if (taskRunCounter === 10) {
taskDone.resolve();
}
},
})
);
await myTaskManager.triggerTaskByName('myTask');
// tslint:disable-next-line:no-unused-expression
expect(referenceBoolean).to.be.true;
});
tap.test('should schedule task', async () => {
myTaskManager.scheduleTaskByName('myTask', '* * * * * *');
await taskDone.promise;
myTaskManager.descheduleTaskByName('myTask');
});
tap.start();

View File

@ -25,7 +25,7 @@ tap.test('should run the task as expected', async () => {
if (taskRunCounter === 10) {
taskDone.resolve();
}
}
},
})
);
await myTaskManager.triggerTaskByName('myTask');

View File

@ -11,7 +11,7 @@ const flowTask1 = new taskbuffer.Task({
console.log(x);
done.resolve(x);
return done.promise;
}
},
});
const flowTaskBuffered = new taskbuffer.Task({
@ -23,7 +23,7 @@ const flowTaskBuffered = new taskbuffer.Task({
return done.promise;
},
buffered: true,
bufferMax: 1
bufferMax: 1,
});
const flowTask2 = new taskbuffer.Task({
@ -34,11 +34,11 @@ const flowTask2 = new taskbuffer.Task({
done.resolve(x);
return done.promise;
},
preTask: flowTask1
preTask: flowTask1,
});
const flowTask3 = new taskbuffer.Taskchain({
taskArray: [flowTask1, flowTask2]
taskArray: [flowTask1, flowTask2],
});
tap.test('should let a value flow through a task', async () => {

View File

@ -9,7 +9,7 @@ tap.test('should create a valid instance of TaskOnce', async () => {
myTaskOnce = new taskbuffer.TaskOnce({
taskFunction: async () => {
myNumber++;
}
},
});
expect(myTaskOnce).to.be.instanceof(taskbuffer.TaskOnce);
});

View File

@ -13,11 +13,11 @@ tap.test('should create tasks', async () => {
taskFunction: async () => {
console.log('pretask executed :)');
return 'hi';
}
},
});
afterTask = new taskbuffer.Task({
name: 'myAfterTask',
taskFunction: async x => {
taskFunction: async (x) => {
if (x === 'hi') {
console.log('afterTask: values get passed along alright');
}
@ -25,12 +25,12 @@ tap.test('should create tasks', async () => {
return x;
},
preTask,
afterTask
afterTask,
});
mainTask = new taskbuffer.Task({
name: 'mainTask',
taskFunction: async x => {
taskFunction: async (x) => {
if (x === 'hi') {
console.log('mainTask: values get passed along alright');
}
@ -40,7 +40,7 @@ tap.test('should create tasks', async () => {
preTask: () => {
return preTask;
},
afterTask
afterTask,
});
});

View File

@ -10,18 +10,22 @@ tap.test('should create a valid taskrunner', async () => {
tap.test('should execute task when its scheduled', async (tools) => {
const done = tools.defer();
testTaskRunner.addTask(new taskbuffer.Task({
testTaskRunner.addTask(
new taskbuffer.Task({
taskFunction: async () => {
console.log('hi');
}
}));
},
})
);
testTaskRunner.addTask(new taskbuffer.Task({
testTaskRunner.addTask(
new taskbuffer.Task({
taskFunction: async () => {
console.log('there');
done.resolve();
}
}));
},
})
);
await done.promise;
});

View File

@ -23,11 +23,11 @@ export class BufferRunner {
}
private _run(x) {
const recursiveBufferRunner = x => {
const recursiveBufferRunner = (x) => {
if (this.bufferCounter >= 0) {
this.running = true;
this.task.running = true;
Task.runTask(this.task, { x: x }).then(x => {
Task.runTask(this.task, { x: x }).then((x) => {
this.bufferCounter--;
this.task.cycleCounter.informOfCycle(x);
recursiveBufferRunner(x);

View File

@ -16,14 +16,14 @@ export class CycleCounter {
const done = plugins.smartpromise.defer();
const cycleObject: ICycleObject = {
cycleCounter: cycleCountArg,
deferred: done
deferred: done,
};
this.cycleObjectArray.push(cycleObject);
return done.promise;
}
public informOfCycle(x) {
const newCycleObjectArray: ICycleObject[] = [];
this.cycleObjectArray.forEach(cycleObjectArg => {
this.cycleObjectArray.forEach((cycleObjectArg) => {
cycleObjectArg.cycleCounter--;
if (cycleObjectArg.cycleCounter <= 0) {
cycleObjectArg.deferred.resolve(x);

View File

@ -1,2 +0,0 @@
import plugins = require('./taskbuffer.plugins');
import { Task, ITaskFunction } from './taskbuffer.classes.task';

View File

@ -1,8 +1,9 @@
import * as plugins from './taskbuffer.plugins';
import * as helpers from './taskbuffer.classes.helpers';
import { BufferRunner } from './taskbuffer.classes.bufferrunner';
import { CycleCounter } from './taskbuffer.classes.cyclecounter';
import { logger } from './taskbuffer.logging';
export interface ITaskFunction {
(x?: any): PromiseLike<any>;
}
@ -75,7 +76,7 @@ export class Task {
// handle options
const options = {
...{ x: undefined, touchedTasksArray: [] },
...optionsArg
...optionsArg,
};
const x = options.x;
const touchedTasksArray: Task[] = options.touchedTasksArray;
@ -96,7 +97,7 @@ export class Task {
return done2.promise;
}
})
.then(async x => {
.then(async (x) => {
// lets run the main task
try {
return await taskToRun.taskFunction(x);
@ -104,7 +105,7 @@ export class Task {
console.log(e);
}
})
.then(x => {
.then((x) => {
if (taskToRun.afterTask && !Task.isTaskTouched(taskToRun.afterTask, touchedTasksArray)) {
return Task.runTask(taskToRun.afterTask, { x: x, touchedTasksArray: touchedTasksArray });
} else {
@ -113,10 +114,10 @@ export class Task {
return done2.promise;
}
})
.then(x => {
.then((x) => {
done.resolve(x);
})
.catch(err => {
.catch((err) => {
console.log(err);
});
localDeferred.resolve();
@ -128,6 +129,7 @@ export class Task {
public name: string;
public taskFunction: ITaskFunction;
public buffered: boolean;
public cronJob: plugins.smarttime.CronJob;
public bufferMax: number;
public execDelay: number;
@ -218,7 +220,7 @@ export class Task {
if (stateArg === 'locked') {
this._state = 'locked';
} else {
plugins.smartlog.defaultLogger.log('error', 'state type ' + stateArg + ' could not be set');
logger.log('error', `state type ${stateArg} could not be set`);
}
}
}

View File

@ -3,7 +3,7 @@
import * as plugins from './taskbuffer.plugins';
import { Task } from './taskbuffer.classes.task';
import helpers = require('./taskbuffer.classes.helpers');
import { logger } from './taskbuffer.logging';
export class Taskchain extends Task {
taskArray: Task[];
@ -14,22 +14,22 @@ export class Taskchain extends Task {
buffered?: boolean;
bufferMax?: number;
}) {
let options = {
const options = {
...{
name: 'unnamed Taskchain',
log: false
log: false,
},
...optionsArg,
...{
taskFunction: (x: any) => {
// this is the function that gets executed when TaskChain is triggered
let done = plugins.smartpromise.defer(); // this is the starting Deferred object
const done = plugins.smartpromise.defer(); // this is the starting Deferred object
let taskCounter = 0; // counter for iterating async over the taskArray
let iterateTasks = x => {
const iterateTasks = (x) => {
if (typeof this.taskArray[taskCounter] !== 'undefined') {
console.log(this.name + ' running: Task' + this.taskArray[taskCounter].name);
this.taskArray[taskCounter].trigger(x).then(x => {
plugins.smartlog.defaultLogger.log('info', this.taskArray[taskCounter].name);
this.taskArray[taskCounter].trigger(x).then((x) => {
logger.log('info', this.taskArray[taskCounter].name);
taskCounter++;
iterateTasks(x);
});
@ -40,8 +40,8 @@ export class Taskchain extends Task {
};
iterateTasks(x);
return done.promise;
}
}
},
},
};
super(options);
this.taskArray = optionsArg.taskArray;

View File

@ -1,5 +1,6 @@
import * as plugins from './taskbuffer.plugins';
import { Task } from './taskbuffer.classes.task';
import { threadId } from 'worker_threads';
export interface ICronJob {
cronString: string;
@ -8,8 +9,8 @@ export interface ICronJob {
}
export class TaskManager {
public taskMap = new plugins.lik.Objectmap<Task>();
private cronJobMap = new plugins.lik.Objectmap<ICronJob>();
public taskMap = new plugins.lik.ObjectMap<Task>();
private cronJobManager = new plugins.smarttime.CronManager();
constructor() {
// nothing here
@ -20,7 +21,7 @@ export class TaskManager {
* @param taskNameArg
*/
public getTaskByName(taskNameArg): Task {
return this.taskMap.find(itemArg => {
return this.taskMap.find((itemArg) => {
return itemArg.name === taskNameArg;
});
}
@ -69,18 +70,11 @@ export class TaskManager {
*/
public scheduleTaskByName(taskNameArg: string, cronStringArg: string) {
const taskToSchedule = this.getTaskByName(taskNameArg);
const job = new plugins.cron.CronJob({
cronTime: cronStringArg,
onTick: () => {
this.triggerTaskByName(taskNameArg);
},
start: true
});
this.cronJobMap.add({
taskNameArg: taskToSchedule.name,
cronString: cronStringArg,
job
const cronJob = this.cronJobManager.addCronjob(cronStringArg, async () => {
await taskToSchedule.triggerBuffered();
});
taskToSchedule.cronJob = cronJob;
this.cronJobManager.start();
}
/**
@ -88,10 +82,14 @@ export class TaskManager {
* @param taskNameArg
*/
public descheduleTaskByName(taskNameArg: string) {
const descheduledCron = this.cronJobMap.findOneAndRemove(itemArg => {
return itemArg.taskNameArg === taskNameArg;
});
descheduledCron.job.stop();
const taskToDeSchedule = this.getTaskByName(taskNameArg);
if (taskToDeSchedule.cronJob) {
this.cronJobManager.removeCronjob(taskToDeSchedule.cronJob);
taskToDeSchedule.cronJob = null;
}
if (this.cronJobManager.cronjobs.isEmpty) {
this.cronJobManager.stop();
}
}
/**

View File

@ -15,7 +15,7 @@ export class TaskOnce extends Task {
this.hasTriggered = true;
await optionsArg.taskFunction();
}
}
},
});
}
}

View File

@ -1,5 +1,4 @@
import * as plugins from './taskbuffer.plugins';
import * as helpers from './taskbuffer.classes.helpers';
import { Task } from './taskbuffer.classes.task';
export class Taskparallel extends Task {
@ -16,8 +15,8 @@ export class Taskparallel extends Task {
});
Promise.all(promiseArray).then(done.resolve);
return done.promise;
}
}
},
},
};
super(options);
this.taskArray = optionsArg.taskArray;

View File

@ -5,11 +5,11 @@ import { Task } from './taskbuffer.classes.task';
export class TaskRunner {
public maxParrallelJobs: number = 1;
public status: 'stopped' | 'running' = 'stopped';
public runningTasks: plugins.lik.Objectmap<Task> = new plugins.lik.Objectmap<Task>();
public runningTasks: plugins.lik.ObjectMap<Task> = new plugins.lik.ObjectMap<Task>();
public qeuedTasks: Task[] = [];
constructor() {
this.runningTasks.eventSubject.subscribe(async eventArg => {
this.runningTasks.eventSubject.subscribe(async (eventArg) => {
this.checkExecution();
});
}

3
ts/taskbuffer.logging.ts Normal file
View File

@ -0,0 +1,3 @@
import * as plugins from './taskbuffer.plugins';
export const logger = new plugins.smartlog.ConsoleLog();

View File

@ -1,8 +1,7 @@
import * as smartlog from '@pushrocks/smartlog';
import cron from 'cron';
import * as lik from '@pushrocks/lik';
import * as rxjs from 'rxjs';
import * as smartpromise from '@pushrocks/smartpromise';
import * as smartdelay from '@pushrocks/smartdelay';
import * as smarttime from '@pushrocks/smarttime';
export { smartlog, cron, lik, rxjs, smartpromise, smartdelay };
export { smartlog, lik, smartpromise, smartdelay, smarttime };