3.0.0

.gitlab-ci.yml

@@ -12,6 +12,9 @@ stages:
   - release
   - metadata
 
+before_script:
+  - npm install -g @shipzone/npmci
+
 # ====================
 # security stage
 # ====================
@@ -36,6 +39,7 @@ auditProductionDependencies:
     - npmci command npm audit --audit-level=high --only=prod --production
   tags:
     - docker
+  allow_failure: true
 
 auditDevDependencies:
   image: registry.gitlab.com/hosttoday/ht-docker-node:npmci

.vscode/launch.json

@@ -2,28 +2,10 @@
   "version": "0.2.0",
   "configurations": [
     {
-      "name": "current file",
+      "command": "npm test",
-      "type": "node",
+      "name": "Run npm test",
       "request": "launch",
-      "args": [
+      "type": "node-terminal"
-        "${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"
     }
   ]
 }

package.json

@@ -1,10 +1,11 @@
 {
   "name": "@pushrocks/taskbuffer",
-  "version": "2.1.12",
+  "version": "3.0.0",
   "private": false,
   "description": "flexible task management. TypeScript ready!",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
+  "type": "module",
   "scripts": {
     "test": "(tstest test/ --web)",
     "build": "(tsbuild --web && tsbundle npm)"
@@ -27,20 +28,20 @@
   },
   "homepage": "https://gitlab.com/pushrocks/taskbuffer#readme",
   "dependencies": {
-    "@pushrocks/lik": "^4.0.17",
+    "@pushrocks/lik": "^5.0.4",
-    "@pushrocks/smartdelay": "^2.0.10",
+    "@pushrocks/smartdelay": "^2.0.13",
-    "@pushrocks/smartlog": "^2.0.36",
+    "@pushrocks/smartlog": "^2.0.44",
-    "@pushrocks/smartpromise": "^3.0.6",
+    "@pushrocks/smartpromise": "^3.1.7",
-    "@pushrocks/smartrx": "^2.0.18",
+    "@pushrocks/smartrx": "^2.0.25",
-    "@pushrocks/smarttime": "^3.0.34",
+    "@pushrocks/smarttime": "^3.0.45",
-    "@types/cron": "^1.7.2"
+    "@types/cron": "^1.7.3"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.25",
+    "@gitzone/tsbuild": "^2.1.61",
-    "@gitzone/tsbundle": "^1.0.78",
+    "@gitzone/tsbundle": "^1.0.101",
-    "@gitzone/tstest": "^1.0.44",
+    "@gitzone/tstest": "^1.0.70",
-    "@pushrocks/tapbundle": "^3.2.9",
+    "@pushrocks/tapbundle": "^5.0.3",
-    "@types/node": "^14.6.4",
+    "@types/node": "^17.0.23",
     "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0"
   },

test/test.1.task.ts

@@ -1,5 +1,6 @@
 import { expect, tap } from '@pushrocks/tapbundle';
-import taskbuffer = require('../ts/index');
+
+import * as taskbuffer from '../ts/index.js';
 
 import * as smartpromise from '@pushrocks/smartpromise';
 import * as smartdelay from '@pushrocks/smartdelay';
@@ -66,7 +67,7 @@ tap.test('new Task() should return a new task', async () => {
 });
 
 tap.test('expect testTask to be an instance of Task', async () => {
-  expect(testTask).to.be.instanceof(taskbuffer.Task);
+  expect(testTask).toBeInstanceOf(taskbuffer.Task);
 });
 
 tap.test('expect testTask.idle is true', async () => {
@@ -76,13 +77,13 @@ tap.test('expect testTask.idle is true', async () => {
 });
 
 tap.test('testTask.running should be of type boolean and initially false', async () => {
-  expect(testTask.running).to.be.a('boolean');
+  expect(testTask.running).toBeTypeofBoolean();
   // tslint:disable-next-line:no-unused-expression
-  expect(testTask.running).to.be.false;
+  expect(testTask.running).toBeFalse();
 });
 
 tap.test('testTask.trigger() should return Promise', async () => {
-  expect(testTask.trigger()).to.be.instanceof(Promise);
+  expect(testTask.trigger()).toBeInstanceOf(Promise);
 });
 
 tap.test('testTask.trigger() returned Promise should be fullfilled', async () => {

test/test.2.taskchain.ts

@@ -1,5 +1,6 @@
 import { expect, tap } from '@pushrocks/tapbundle';
-import taskbuffer = require('../ts/index');
+
+import * as taskbuffer from '../ts/index.js';
 
 import * as smartpromise from '@pushrocks/smartpromise';
 import * as smartdelay from '@pushrocks/smartdelay';
@@ -36,12 +37,12 @@ tap.test('expect run tasks in sequence', async () => {
   const testPromise = testTaskchain.trigger();
   await smartdelay.delayFor(2100);
   // tslint:disable-next-line:no-unused-expression
-  expect(task1Executed).to.be.true;
+  expect(task1Executed).toBeTrue();
   // tslint:disable-next-line:no-unused-expression
-  expect(task2Executed).to.be.false;
+  expect(task2Executed).toBeFalse();
   await smartdelay.delayFor(2100);
   // tslint:disable-next-line:no-unused-expression
-  expect(task2Executed).to.be.true;
+  expect(task2Executed).toBeTrue();
   await testPromise;
 });
 

test/test.3.taskparallel.ts

@@ -1,7 +1,8 @@
 import { expect, tap } from '@pushrocks/tapbundle';
-import taskbuffer = require('../ts/index');
 import * as smartdelay from '@pushrocks/smartdelay';
 
+import * as taskbuffer from '../ts/index.js';
+
 let task1Executed = false;
 const task1 = new taskbuffer.Task({
   taskFunction: async () => {

test/test.4.taskmanager.both.ts

@@ -1,5 +1,6 @@
 import { expect, tap } from '@pushrocks/tapbundle';
-import taskbuffer = require('../ts/index');
+
+import * as taskbuffer from '../ts/index.js';
 
 import * as smartpromise from '@pushrocks/smartpromise';
 import * as smartdelay from '@pushrocks/smartdelay';
@@ -10,7 +11,7 @@ const taskDone = smartpromise.defer();
 
 tap.test('should create an instance of TaskManager', async () => {
   myTaskManager = new taskbuffer.TaskManager();
-  expect(myTaskManager).to.be.instanceof(taskbuffer.TaskManager);
+  expect(myTaskManager).toBeInstanceOf(taskbuffer.TaskManager);
 });
 
 tap.test('should run the task as expected', async () => {
@@ -18,8 +19,10 @@ tap.test('should run the task as expected', async () => {
   myTaskManager.addTask(
     new taskbuffer.Task({
       name: 'myTask',
+      bufferMax: 1,
+      buffered: true,
       taskFunction: async () => {
-        console.log('Task executed!');
+        console.log('Task "myTask" executed!');
         referenceBoolean = true;
         taskRunCounter++;
         if (taskRunCounter === 10) {
@@ -31,11 +34,11 @@ tap.test('should run the task as expected', async () => {
   myTaskManager.start();
   await myTaskManager.triggerTaskByName('myTask');
   // tslint:disable-next-line:no-unused-expression
-  expect(referenceBoolean).to.be.true;
+  expect(referenceBoolean).toBeTrue();
 });
 
 tap.test('should schedule task', async () => {
-  myTaskManager.scheduleTaskByName('myTask', '* * * * * *');
+  myTaskManager.scheduleTaskByName('myTask', '*/10 * * * * *');
   await taskDone.promise;
   myTaskManager.descheduleTaskByName('myTask');
 });

test/test.4.taskmanager.ts

@@ -1,47 +0,0 @@
-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();
-        }
-      },
-    })
-  );
-  myTaskManager.start();
-  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.test('should stop the taskmanager', async () => {
-  myTaskManager.stop();
-});
-
-tap.start();

test/test.5.task.paramflow.ts

@@ -1,5 +1,6 @@
 import { expect, tap } from '@pushrocks/tapbundle';
-import taskbuffer = require('../ts/index');
+
+import * as taskbuffer from '../ts/index.js';
 
 import * as smartpromise from '@pushrocks/smartpromise';
 import * as smartdelay from '@pushrocks/smartdelay';
@@ -43,22 +44,22 @@ const flowTask3 = new taskbuffer.Taskchain({
 
 tap.test('should let a value flow through a task', async () => {
   const result = await flowTask1.trigger(12);
-  expect(result).to.equal(12);
+  expect(result).toEqual(12);
 });
 
 tap.test('expect values to flow between tasks', async () => {
   const result = await flowTask2.trigger(12);
-  expect(result).to.equal(12);
+  expect(result).toEqual(12);
 });
 
 tap.test('expect values to flow between tasks when buffered', async () => {
   const result = await flowTaskBuffered.trigger(12);
-  expect(result).to.equal(12);
+  expect(result).toEqual(12);
 });
 
 tap.test('expect values to flow between tasks in Taskchain', async () => {
   const result = await flowTask3.trigger(12);
-  expect(result).to.equal(12);
+  expect(result).toEqual(12);
 });
 
 tap.start();

test/test.6.taskonce.ts

@@ -1,6 +1,6 @@
 import { expect, tap } from '@pushrocks/tapbundle';
 
-import * as taskbuffer from '../ts/index';
+import * as taskbuffer from '../ts/index.js';
 
 let myNumber = 0;
 let myTaskOnce: taskbuffer.TaskOnce;
@@ -11,18 +11,18 @@ tap.test('should create a valid instance of TaskOnce', async () => {
       myNumber++;
     },
   });
-  expect(myTaskOnce).to.be.instanceof(taskbuffer.TaskOnce);
+  expect(myTaskOnce).toBeInstanceOf(taskbuffer.TaskOnce);
 });
 
 tap.test('myNumber should still be 0', async () => {
-  expect(myNumber).to.equal(0);
+  expect(myNumber).toEqual(0);
 });
 
 tap.test('myTaskOnce should trigger once', async () => {
   await myTaskOnce.trigger();
   await myTaskOnce.trigger();
   await myTaskOnce.trigger();
-  expect(myNumber).to.equal(1);
+  expect(myNumber).toEqual(1);
 });
 
 tap.start();

test/test.7.taskloop.ts

@@ -1,6 +1,6 @@
 import { tap, expect } from '@pushrocks/tapbundle';
 
-import * as taskbuffer from '../ts';
+import * as taskbuffer from '../ts/index.js';
 
 let preTask: taskbuffer.Task;
 let afterTask: taskbuffer.Task;

test/test.8.bufferedrun.ts

@@ -0,0 +1,52 @@
+import { tap, expect } from '@pushrocks/tapbundle';
+
+import * as taskbuffer from '../ts/index.js';
+
+let counter1 = 0;
+let counter2 = 0;
+let counter3 = 0;
+
+tap.test('should run buffered', async (tools) => {
+  const task = new taskbuffer.Task({
+    name: 'a buffered task',
+    taskFunction: async () => {
+      counter1++;
+      await tools.delayFor(2000);
+      console.log(`task 1 ran ${counter1} times`);
+    },
+    buffered: true,
+    bufferMax: 1,
+    afterTask: () => {
+      return task2;
+    },
+  });
+  const task2 = new taskbuffer.Task({
+    name: 'a buffered task',
+    taskFunction: async () => {
+      counter2++;
+      await tools.delayFor(2000);
+      console.log(`task2 ran ${counter2} times`);
+    },
+    buffered: true,
+    bufferMax: 1,
+    afterTask: () => {
+      return task3;
+    },
+  });
+  const task3 = new taskbuffer.Task({
+    name: 'a buffered task',
+    taskFunction: async () => {
+      counter3++;
+      await tools.delayFor(2000);
+      console.log(`task3 ran ${counter3} times`);
+    },
+    buffered: true,
+    bufferMax: 1,
+  });
+  while (counter1 < 10) {
+    await tools.delayFor(5000);
+    task.trigger();
+  }
+});
+
+tap.start();

test/test.taskrunner.ts

@@ -1,5 +1,6 @@
 import { tap, expect } from '@pushrocks/tapbundle';
-import * as taskbuffer from '../ts/index';
+
+import * as taskbuffer from '../ts/index.js';
 
 let testTaskRunner: taskbuffer.TaskRunner;
 

ts/index.ts

@@ -1,7 +1,8 @@
-export { Task, ITaskFunction } from './taskbuffer.classes.task';
+export { Task } from './taskbuffer.classes.task.js';
-export { Taskchain } from './taskbuffer.classes.taskchain';
+export type { ITaskFunction } from './taskbuffer.classes.task.js'
-export { Taskparallel } from './taskbuffer.classes.taskparallel';
+export { Taskchain } from './taskbuffer.classes.taskchain.js';
-export { TaskManager } from './taskbuffer.classes.taskmanager';
+export { Taskparallel } from './taskbuffer.classes.taskparallel.js';
-export { TaskOnce } from './taskbuffer.classes.taskonce';
+export { TaskManager } from './taskbuffer.classes.taskmanager.js';
-export { TaskRunner } from './taskbuffer.classes.taskrunner';
+export { TaskOnce } from './taskbuffer.classes.taskonce.js';
-export { TaskDebounced } from './taskbuffer.classes.taskdebounced';
+export { TaskRunner } from './taskbuffer.classes.taskrunner.js';
+export { TaskDebounced } from './taskbuffer.classes.taskdebounced.js';

ts/taskbuffer.classes.bufferrunner.ts

@@ -1,4 +1,4 @@
-import { Task } from './taskbuffer.classes.task';
+import { Task } from './taskbuffer.classes.task.js';
 
 export class BufferRunner {
   public task: Task;
@@ -8,7 +8,7 @@ export class BufferRunner {
     this.task = taskArg;
   }
 
-  public trigger(x): Promise<any> {
+  public trigger(x: any): Promise<any> {
     if (!(this.bufferCounter >= this.task.bufferMax)) {
       this.bufferCounter++;
     }
@@ -21,8 +21,8 @@ export class BufferRunner {
     return returnPromise;
   }
 
-  private _run(x) {
+  private _run(x: any) {
-    const recursiveBufferRunner = (x) => {
+    const recursiveBufferRunner = (x: any) => {
       if (this.bufferCounter >= 0) {
         this.task.running = true;
         Task.runTask(this.task, { x: x }).then((x) => {

ts/taskbuffer.classes.cyclecounter.ts

@@ -1,5 +1,5 @@
-import * as plugins from './taskbuffer.plugins';
+import * as plugins from './taskbuffer.plugins.js';
-import { Task } from './taskbuffer.classes.task';
+import { Task } from './taskbuffer.classes.task.js';
 
 export interface ICycleObject {
   cycleCounter: number;
@@ -21,7 +21,7 @@ export class CycleCounter {
     this.cycleObjectArray.push(cycleObject);
     return done.promise;
   }
-  public informOfCycle(x) {
+  public informOfCycle(x: any) {
     const newCycleObjectArray: ICycleObject[] = [];
     this.cycleObjectArray.forEach((cycleObjectArg) => {
       cycleObjectArg.cycleCounter--;

ts/taskbuffer.classes.task.ts

@@ -1,8 +1,8 @@
-import * as plugins from './taskbuffer.plugins';
+import * as plugins from './taskbuffer.plugins.js';
-import { BufferRunner } from './taskbuffer.classes.bufferrunner';
+import { BufferRunner } from './taskbuffer.classes.bufferrunner.js';
-import { CycleCounter } from './taskbuffer.classes.cyclecounter';
+import { CycleCounter } from './taskbuffer.classes.cyclecounter.js';
 
-import { logger } from './taskbuffer.logging';
+import { logger } from './taskbuffer.logging.js';
 
 export interface ITaskFunction {
   (x?: any): PromiseLike<any>;
@@ -56,8 +56,9 @@ export class Task {
 
   public static runTask = async (
     taskArg: Task | TPreOrAfterTaskFunction,
-    optionsArg: { x?; touchedTasksArray?: Task[] }
+    optionsArg: { x?: any; touchedTasksArray?: Task[] }
   ) => {
+    // extracts the task in case it is specified as a return value of a function
     const taskToRun = Task.extractTask(taskArg);
     const done = plugins.smartpromise.defer();
 
@@ -190,7 +191,7 @@ export class Task {
   /**
    * trigger the task. Will trigger buffered if this.buffered is true
    */
-  public trigger(x?): Promise<any> {
+  public trigger(x?: any): Promise<any> {
     if (this.buffered) {
       return this.triggerBuffered(x);
     } else {
@@ -202,15 +203,15 @@ export class Task {
    * trigger task unbuffered.
    * will actually run the task, not considering any buffered limits.
    */
-  public triggerUnBuffered(x?): Promise<any> {
+  public triggerUnBuffered(x?: any): Promise<any> {
     return Task.runTask(this, { x: x });
   }
 
   /**
    * trigger task buffered.
-   * will simply call task.trigger(), which respects buffering by default
+   * note: .trigger() also calls this function
    */
-  public triggerBuffered(x?): Promise<any> {
+  public triggerBuffered(x?: any): Promise<any> {
     return this.bufferRunner.trigger(x);
   }
 

ts/taskbuffer.classes.taskchain.ts

@@ -1,9 +1,9 @@
 // TaskChain chains tasks
 // and extends Task
 
-import * as plugins from './taskbuffer.plugins';
+import * as plugins from './taskbuffer.plugins.js';
-import { Task } from './taskbuffer.classes.task';
+import { Task } from './taskbuffer.classes.task.js';
-import { logger } from './taskbuffer.logging';
+import { logger } from './taskbuffer.logging.js';
 
 export class Taskchain extends Task {
   taskArray: Task[];
@@ -25,7 +25,7 @@ export class Taskchain extends Task {
           // this is the function that gets executed when TaskChain is triggered
           const done = plugins.smartpromise.defer(); // this is the starting Deferred object
           let taskCounter = 0; // counter for iterating async over the taskArray
-          const iterateTasks = (x) => {
+          const iterateTasks = (x: any) => {
             if (typeof this.taskArray[taskCounter] !== 'undefined') {
               console.log(this.name + ' running: Task' + this.taskArray[taskCounter].name);
               this.taskArray[taskCounter].trigger(x).then((x) => {

ts/taskbuffer.classes.taskdebounced.ts

@@ -1,6 +1,6 @@
-import * as plugins from './taskbuffer.plugins';
+import * as plugins from './taskbuffer.plugins.js';
 
-import { Task, ITaskFunction } from './taskbuffer.classes.task';
+import { Task, ITaskFunction } from './taskbuffer.classes.task.js';
 
 export class TaskDebounced<T = unknown> extends Task {
   private _debouncedTaskFunction: ITaskFunction;

ts/taskbuffer.classes.taskmanager.ts

@@ -1,6 +1,5 @@
-import * as plugins from './taskbuffer.plugins';
+import * as plugins from './taskbuffer.plugins.js';
-import { Task } from './taskbuffer.classes.task';
+import { Task } from './taskbuffer.classes.task.js';
-import { threadId } from 'worker_threads';
 
 export interface ICronJob {
   cronString: string;
@@ -20,8 +19,8 @@ export class TaskManager {
    * checks if a task is already present
    * @param taskNameArg
    */
-  public getTaskByName(taskNameArg): Task {
+  public getTaskByName(taskNameArg: string): Task {
-    return this.taskMap.find((itemArg) => {
+    return this.taskMap.findSync((itemArg) => {
       return itemArg.name === taskNameArg;
     });
   }
@@ -70,7 +69,15 @@ export class TaskManager {
   public scheduleTaskByName(taskNameArg: string, cronStringArg: string) {
     const taskToSchedule = this.getTaskByName(taskNameArg);
     const cronJob = this.cronJobManager.addCronjob(cronStringArg, async () => {
-      await taskToSchedule.triggerBuffered();
+      console.log(`taskbuffer schedule triggered task >>${taskToSchedule.name}<<`);
+      console.log(
+        `task >>${taskToSchedule.name}<< is ${
+          taskToSchedule.buffered
+            ? `buffered with max ${taskToSchedule.bufferMax} buffered calls`
+            : `unbuffered`
+        }`
+      );
+      await taskToSchedule.trigger();
     });
     taskToSchedule.cronJob = cronJob;
   }

ts/taskbuffer.classes.taskonce.ts

@@ -1,6 +1,6 @@
-import * as plugins from './taskbuffer.plugins';
+import * as plugins from './taskbuffer.plugins.js';
 
-import { Task, ITaskFunction } from './taskbuffer.classes.task';
+import { Task, ITaskFunction } from './taskbuffer.classes.task.js';
 
 /**
  * TaskOnce is run exactly once, no matter how often it is triggered

ts/taskbuffer.classes.taskparallel.ts

@@ -1,5 +1,5 @@
-import * as plugins from './taskbuffer.plugins';
+import * as plugins from './taskbuffer.plugins.js';
-import { Task } from './taskbuffer.classes.task';
+import { Task } from './taskbuffer.classes.task.js';
 
 export class Taskparallel extends Task {
   public taskArray: Task[];

ts/taskbuffer.classes.taskrunner.ts

@@ -1,6 +1,6 @@
-import * as plugins from './taskbuffer.plugins';
+import * as plugins from './taskbuffer.plugins.js';
 
-import { Task } from './taskbuffer.classes.task';
+import { Task } from './taskbuffer.classes.task.js';
 
 export class TaskRunner {
   public maxParrallelJobs: number = 1;

ts/taskbuffer.logging.ts

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

tslint.json

@@ -1,17 +0,0 @@
-{
-  "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"
-}