Compare commits
11 Commits
Author | SHA1 | Date | |
---|---|---|---|
9c6487c779 | |||
e3f37f5027 | |||
1152bb1138 | |||
9df7787450 | |||
3e81fdacad | |||
f74da6ff0b | |||
e9d976ad1e | |||
f6d314695a | |||
d35b34f4aa | |||
9fec5ce62e | |||
7577479368 |
@ -26,6 +26,7 @@ mirror:
|
|||||||
snyk:
|
snyk:
|
||||||
stage: security
|
stage: security
|
||||||
script:
|
script:
|
||||||
|
- npmci npm prepare
|
||||||
- npmci command npm install -g snyk
|
- npmci command npm install -g snyk
|
||||||
- npmci command npm install --ignore-scripts
|
- npmci command npm install --ignore-scripts
|
||||||
- npmci command snyk test
|
- npmci command snyk test
|
||||||
@ -33,24 +34,39 @@ snyk:
|
|||||||
- docker
|
- docker
|
||||||
- notpriv
|
- notpriv
|
||||||
|
|
||||||
|
sast:
|
||||||
|
stage: security
|
||||||
|
image: registry.gitlab.com/hosttoday/ht-docker-dbase:npmci
|
||||||
|
variables:
|
||||||
|
DOCKER_DRIVER: overlay2
|
||||||
|
allow_failure: true
|
||||||
|
services:
|
||||||
|
- docker:stable-dind
|
||||||
|
script:
|
||||||
|
- npmci npm prepare
|
||||||
|
- npmci npm install
|
||||||
|
- npmci command npm run build
|
||||||
|
- export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
|
||||||
|
- docker run
|
||||||
|
--env SAST_CONFIDENCE_LEVEL="${SAST_CONFIDENCE_LEVEL:-3}"
|
||||||
|
--volume "$PWD:/code"
|
||||||
|
--volume /var/run/docker.sock:/var/run/docker.sock
|
||||||
|
"registry.gitlab.com/gitlab-org/security-products/sast:$SP_VERSION" /app/bin/run /code
|
||||||
|
artifacts:
|
||||||
|
reports:
|
||||||
|
sast: gl-sast-report.json
|
||||||
|
tags:
|
||||||
|
- docker
|
||||||
|
- priv
|
||||||
|
|
||||||
# ====================
|
# ====================
|
||||||
# test stage
|
# test stage
|
||||||
# ====================
|
# ====================
|
||||||
testLEGACY:
|
|
||||||
stage: test
|
|
||||||
script:
|
|
||||||
- npmci node install legacy
|
|
||||||
- npmci npm install
|
|
||||||
- npmci npm test
|
|
||||||
coverage: /\d+.?\d+?\%\s*coverage/
|
|
||||||
tags:
|
|
||||||
- docker
|
|
||||||
- notpriv
|
|
||||||
allow_failure: true
|
|
||||||
|
|
||||||
testLTS:
|
testLTS:
|
||||||
stage: test
|
stage: test
|
||||||
script:
|
script:
|
||||||
|
- npmci npm prepare
|
||||||
- npmci node install lts
|
- npmci node install lts
|
||||||
- npmci npm install
|
- npmci npm install
|
||||||
- npmci npm test
|
- npmci npm test
|
||||||
@ -62,6 +78,7 @@ testLTS:
|
|||||||
testSTABLE:
|
testSTABLE:
|
||||||
stage: test
|
stage: test
|
||||||
script:
|
script:
|
||||||
|
- npmci npm prepare
|
||||||
- npmci node install stable
|
- npmci node install stable
|
||||||
- npmci npm install
|
- npmci npm install
|
||||||
- npmci npm test
|
- npmci npm test
|
||||||
@ -118,6 +135,7 @@ pages:
|
|||||||
stage: metadata
|
stage: metadata
|
||||||
script:
|
script:
|
||||||
- npmci command npm install -g typedoc typescript
|
- npmci command npm install -g typedoc typescript
|
||||||
|
- npmci npm prepare
|
||||||
- npmci npm install
|
- npmci npm install
|
||||||
- npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
|
- npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
|
||||||
tags:
|
tags:
|
||||||
@ -130,13 +148,3 @@ pages:
|
|||||||
paths:
|
paths:
|
||||||
- public
|
- public
|
||||||
allow_failure: true
|
allow_failure: true
|
||||||
|
|
||||||
windowsCompatibility:
|
|
||||||
image: stefanscherer/node-windows:10-build-tools
|
|
||||||
stage: metadata
|
|
||||||
script:
|
|
||||||
- npm install & npm test
|
|
||||||
coverage: /\d+.?\d+?\%\s*coverage/
|
|
||||||
tags:
|
|
||||||
- windows
|
|
||||||
allow_failure: true
|
|
||||||
|
@ -1,87 +0,0 @@
|
|||||||
# taskbuffer
|
|
||||||
|
|
||||||
flexible task management. TypeScript ready!
|
|
||||||
|
|
||||||
## Availabililty
|
|
||||||
|
|
||||||
[](https://www.npmjs.com/package/taskbuffer)
|
|
||||||
[](https://GitLab.com/pushrocks/taskbuffer)
|
|
||||||
[](https://github.com/pushrocks/taskbuffer)
|
|
||||||
[](https://pushrocks.gitlab.io/taskbuffer/)
|
|
||||||
|
|
||||||
## Status for master
|
|
||||||
|
|
||||||
[](https://GitLab.com/pushrocks/taskbuffer/commits/master)
|
|
||||||
[](https://GitLab.com/pushrocks/taskbuffer/commits/master)
|
|
||||||
[](https://www.npmjs.com/package/taskbuffer)
|
|
||||||
[](https://david-dm.org/pushrocks/taskbuffer)
|
|
||||||
[](https://www.bithound.io/github/pushrocks/taskbuffer/master/dependencies/npm)
|
|
||||||
[](https://www.bithound.io/github/pushrocks/taskbuffer)
|
|
||||||
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
|
||||||
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
|
||||||
[](http://standardjs.com/)
|
|
||||||
|
|
||||||
## 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**.
|
|
||||||
|
|
||||||
```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.
|
|
||||||
|
|
||||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
|
||||||
|
|
||||||
[](https://push.rocks)
|
|
1241
package-lock.json
generated
1241
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
29
package.json
29
package.json
@ -1,12 +1,13 @@
|
|||||||
{
|
{
|
||||||
"name": "@pushrocks/taskbuffer",
|
"name": "@pushrocks/taskbuffer",
|
||||||
"version": "2.0.0",
|
"version": "2.0.6",
|
||||||
|
"private": false,
|
||||||
"description": "flexible task management. TypeScript ready!",
|
"description": "flexible task management. TypeScript ready!",
|
||||||
"main": "dist/index.js",
|
"main": "dist/index.js",
|
||||||
"typings": "dist/index.d.ts",
|
"typings": "dist/index.d.ts",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"test": "tstest test/",
|
"test": "(tstest test/)",
|
||||||
"build": "echo \"Not needed for now\""
|
"build": "(tsbuild)"
|
||||||
},
|
},
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
@ -26,18 +27,20 @@
|
|||||||
},
|
},
|
||||||
"homepage": "https://gitlab.com/pushrocks/taskbuffer#readme",
|
"homepage": "https://gitlab.com/pushrocks/taskbuffer#readme",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@pushrocks/lik": "^3.0.1",
|
"@pushrocks/lik": "^3.0.4",
|
||||||
"@pushrocks/smartdelay": "^2.0.1",
|
"@pushrocks/smartdelay": "^2.0.2",
|
||||||
"@pushrocks/smartlog": "^2.0.1",
|
"@pushrocks/smartlog": "^2.0.9",
|
||||||
"@pushrocks/smartpromise": "^2.0.5",
|
"@pushrocks/smartpromise": "^2.0.5",
|
||||||
"@types/cron": "^1.3.0",
|
"@types/cron": "^1.3.0",
|
||||||
"cron": "^1.3.0",
|
"cron": "^1.6.0",
|
||||||
"rxjs": "^6.2.2"
|
"rxjs": "^6.3.3"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@gitzone/tstest": "^1.0.7",
|
"@gitzone/tsbuild": "^2.1.4",
|
||||||
"@pushrocks/tapbundle": "^3.0.1",
|
"@gitzone/tstest": "^1.0.18",
|
||||||
"@types/node": "^10.5.4"
|
"@pushrocks/tapbundle": "^3.0.7",
|
||||||
},
|
"@types/node": "^10.12.18",
|
||||||
"private": true
|
"tslint": "^5.12.1",
|
||||||
|
"tslint-config-prettier": "^1.17.0"
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
62
readme.md
62
readme.md
@ -1,4 +1,4 @@
|
|||||||
# @pushrocks/taskbuffer
|
# taskbuffer
|
||||||
|
|
||||||
flexible task management. TypeScript ready!
|
flexible task management. TypeScript ready!
|
||||||
|
|
||||||
@ -21,13 +21,67 @@ flexible task management. TypeScript ready!
|
|||||||
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
||||||
[](http://standardjs.com/)
|
[](http://standardjs.com/)
|
||||||
|
|
||||||
## Usage
|
## Install
|
||||||
|
|
||||||
Use TypeScript for best in class instellisense.
|
```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**.
|
||||||
|
|
||||||
|
```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.
|
For further information read the linked docs at the top of this README.
|
||||||
|
|
||||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||||
> | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
|
|
||||||
|
|
||||||
[](https://push.rocks)
|
[](https://push.rocks)
|
||||||
|
@ -8,11 +8,8 @@ import * as smartdelay from '@pushrocks/smartdelay';
|
|||||||
let testTask: taskbuffer.Task;
|
let testTask: taskbuffer.Task;
|
||||||
|
|
||||||
let testPreTask = new taskbuffer.Task({
|
let testPreTask = new taskbuffer.Task({
|
||||||
taskFunction: function() {
|
taskFunction: async () => {
|
||||||
let done = smartpromise.defer();
|
|
||||||
console.log('preTask executed');
|
console.log('preTask executed');
|
||||||
done.resolve();
|
|
||||||
return done.promise;
|
|
||||||
},
|
},
|
||||||
preTask: testTask
|
preTask: testTask
|
||||||
});
|
});
|
||||||
@ -35,14 +32,14 @@ let task1 = new taskbuffer.Task({
|
|||||||
|
|
||||||
let task2 = new taskbuffer.Task({
|
let task2 = new taskbuffer.Task({
|
||||||
name: 'Task 1',
|
name: 'Task 1',
|
||||||
taskFunction: () => {
|
taskFunction: async () => {
|
||||||
let done = smartpromise.defer();
|
const done = smartpromise.defer();
|
||||||
console.log('Task2 started');
|
console.log('Task2 started');
|
||||||
setTimeout(() => {
|
setTimeout(() => {
|
||||||
console.log('Task2 executed');
|
console.log('Task2 executed');
|
||||||
done.resolve();
|
done.resolve();
|
||||||
}, 5000);
|
}, 5000);
|
||||||
return done.promise;
|
await done.promise;
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
import { expect, tap } from '@pushrocks/tapbundle';
|
import { expect, tap } from '@pushrocks/tapbundle';
|
||||||
import taskbuffer = require('../ts/index');
|
import taskbuffer = require('../ts/index');
|
||||||
|
|
||||||
import * as smartq from 'smartq';
|
import * as smartpromise from '@pushrocks/smartpromise';
|
||||||
import * as smartdelay from '@pushrocks/smartdelay';
|
import * as smartdelay from '@pushrocks/smartdelay';
|
||||||
|
|
||||||
let task1Executed = false;
|
let task1Executed = false;
|
||||||
|
@ -100,7 +100,7 @@ export class Task {
|
|||||||
if (stateArg === 'locked') {
|
if (stateArg === 'locked') {
|
||||||
this._state = 'locked';
|
this._state = 'locked';
|
||||||
} else {
|
} else {
|
||||||
plugins.smartlog.defaultLogger.error('state type ' + stateArg + ' could not be set');
|
plugins.smartlog.defaultLogger.log('error', 'state type ' + stateArg + ' could not be set');
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -29,7 +29,7 @@ export class Taskchain extends Task {
|
|||||||
if (typeof this.taskArray[taskCounter] !== 'undefined') {
|
if (typeof this.taskArray[taskCounter] !== 'undefined') {
|
||||||
console.log(this.name + ' running: Task' + this.taskArray[taskCounter].name);
|
console.log(this.name + ' running: Task' + this.taskArray[taskCounter].name);
|
||||||
this.taskArray[taskCounter].trigger(x).then(x => {
|
this.taskArray[taskCounter].trigger(x).then(x => {
|
||||||
plugins.smartlog.defaultLogger.info(this.taskArray[taskCounter].name);
|
plugins.smartlog.defaultLogger.log('info', this.taskArray[taskCounter].name);
|
||||||
taskCounter++;
|
taskCounter++;
|
||||||
iterateTasks(x);
|
iterateTasks(x);
|
||||||
});
|
});
|
||||||
|
16
tslint.json
16
tslint.json
@ -1,3 +1,17 @@
|
|||||||
{
|
{
|
||||||
"extends": "tslint-config-standard"
|
"extends": ["tslint:latest", "tslint-config-prettier"],
|
||||||
|
"rules": {
|
||||||
|
"semicolon": [true, "always"],
|
||||||
|
"no-console": false,
|
||||||
|
"ordered-imports": false,
|
||||||
|
"object-literal-sort-keys": false,
|
||||||
|
"member-ordering": {
|
||||||
|
"options":{
|
||||||
|
"order": [
|
||||||
|
"static-method"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"defaultSeverity": "warning"
|
||||||
}
|
}
|
||||||
|
Reference in New Issue
Block a user