3.0.14

.gitea/workflows/default_nottags.yaml

@@ -0,0 +1,66 @@
+name: Default (not tags)
+
+on:
+  push:
+    tags-ignore:
+      - '**'
+
+env:
+  IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
+  NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
+  NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
+  NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
+  NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
+
+jobs:
+  security:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install pnpm and npmci
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+
+      - name: Run npm prepare
+        run: npmci npm prepare
+
+      - name: Audit production dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --prod
+        continue-on-error: true
+
+      - name: Audit development dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --dev
+        continue-on-error: true
+
+  test:
+    if: ${{ always() }}
+    needs: security
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Test stable
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm test
+
+      - name: Test build
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm build

.gitea/workflows/default_tags.yaml

@@ -0,0 +1,124 @@
+name: Default (tags)
+
+on:
+  push:
+    tags:
+      - '*'
+
+env:
+  IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
+  NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
+  NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
+  NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
+  NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
+
+jobs:
+  security:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Audit production dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --prod
+        continue-on-error: true
+
+      - name: Audit development dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --dev
+        continue-on-error: true
+
+  test:
+    if: ${{ always() }}
+    needs: security
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Test stable
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm test
+
+      - name: Test build
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm build
+
+  release:
+    needs: test
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Release
+        run: |
+          npmci node install stable
+          npmci npm publish
+
+  metadata:
+    needs: test
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+    continue-on-error: true
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Code quality
+        run: |
+          npmci command npm install -g typescript
+          npmci npm install
+
+      - name: Trigger
+        run: npmci trigger
+
+      - name: Build docs and upload artifacts
+        run: |
+          npmci node install stable
+          npmci npm install
+          pnpm install -g @gitzone/tsdoc
+          npmci command tsdoc
+        continue-on-error: true

.gitlab-ci.yml

@@ -1,141 +0,0 @@
-# gitzone ci_default
-image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
-
-cache:
-  paths:
-    - .npmci_cache/
-  key: '$CI_BUILD_STAGE'
-
-stages:
-  - security
-  - test
-  - release
-  - metadata
-
-before_script:
-  - npm install -g @shipzone/npmci
-
-# ====================
-# security stage
-# ====================
-mirror:
-  stage: security
-  script:
-    - npmci git mirror
-  only:
-    - tags
-  tags:
-    - lossless
-    - docker
-    - notpriv
-
-auditProductionDependencies:
-  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
-  stage: security
-  script:
-    - npmci npm prepare
-    - npmci command npm install --production --ignore-scripts
-    - npmci command npm config set registry https://registry.npmjs.org
-    - 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
-  stage: security
-  script:
-    - npmci npm prepare
-    - npmci command npm install --ignore-scripts
-    - npmci command npm config set registry https://registry.npmjs.org
-    - npmci command npm audit --audit-level=high --only=dev
-  tags:
-    - docker
-  allow_failure: true
-
-# ====================
-# test stage
-# ====================
-
-testStable:
-  stage: test
-  script:
-    - npmci npm prepare
-    - npmci node install stable
-    - npmci npm install
-    - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-    - docker
-
-testBuild:
-  stage: test
-  script:
-    - npmci npm prepare
-    - npmci node install stable
-    - npmci npm install
-    - npmci command npm run build
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-    - docker
-
-release:
-  stage: release
-  script:
-    - npmci node install stable
-    - npmci npm publish
-  only:
-    - tags
-  tags:
-    - lossless
-    - docker
-    - notpriv
-
-# ====================
-# metadata stage
-# ====================
-codequality:
-  stage: metadata
-  allow_failure: true
-  only:
-    - tags
-  script:
-    - npmci command npm install -g tslint typescript
-    - npmci npm prepare
-    - npmci npm install
-    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
-  tags:
-    - lossless
-    - docker
-    - priv
-
-trigger:
-  stage: metadata
-  script:
-    - npmci trigger
-  only:
-    - tags
-  tags:
-    - lossless
-    - docker
-    - notpriv
-
-pages:
-  stage: metadata
-  script:
-    - npmci node install lts
-    - npmci command npm install -g @gitzone/tsdoc
-    - npmci npm prepare
-    - npmci npm install
-    - npmci command tsdoc
-  tags:
-    - lossless
-    - docker
-    - notpriv
-  only:
-    - tags
-  artifacts:
-    expire_in: 1 week
-    paths:
-      - public
-  allow_failure: true

npmextra.json

@@ -8,10 +8,10 @@
     "projectType": "npm",
     "module": {
       "githost": "gitlab.com",
-      "gitscope": "pushrocks",
+      "gitscope": "push.rocks",
       "gitrepo": "taskbuffer",
-      "shortDescription": "flexible task management. TypeScript ready!",
+      "description": "flexible task management. TypeScript ready!",
-      "npmPackagename": "@pushrocks/taskbuffer",
+      "npmPackagename": "@push.rocks/taskbuffer",
       "license": "MIT"
     }
   }

package.json

@@ -1,6 +1,6 @@
 {
-  "name": "@pushrocks/taskbuffer",
+  "name": "@push.rocks/taskbuffer",
-  "version": "3.0.8",
+  "version": "3.0.14",
   "private": false,
   "description": "flexible task management. TypeScript ready!",
   "main": "dist_ts/index.js",
@@ -8,7 +8,8 @@
   "type": "module",
   "scripts": {
     "test": "(tstest test/ --web)",
-    "build": "(tsbuild --web && tsbundle npm)"
+    "build": "(tsbuild --web && tsbundle npm)",
+    "buildDocs": "tsdoc"
   },
   "repository": {
     "type": "git",
@@ -28,21 +29,21 @@
   },
   "homepage": "https://gitlab.com/pushrocks/taskbuffer#readme",
   "dependencies": {
-    "@pushrocks/isounique": "^1.0.5",
+    "@push.rocks/isounique": "^1.0.5",
-    "@pushrocks/lik": "^6.0.0",
+    "@push.rocks/lik": "^6.0.3",
-    "@pushrocks/smartdelay": "^2.0.13",
+    "@push.rocks/smartdelay": "^3.0.5",
-    "@pushrocks/smartlog": "^3.0.1",
+    "@push.rocks/smartlog": "^3.0.3",
-    "@pushrocks/smartpromise": "^3.1.7",
+    "@push.rocks/smartpromise": "^4.0.3",
-    "@pushrocks/smartrx": "^3.0.0",
+    "@push.rocks/smartrx": "^3.0.6",
-    "@pushrocks/smarttime": "^4.0.1"
+    "@push.rocks/smarttime": "^4.0.4"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.63",
+    "@gitzone/tsbuild": "^2.1.66",
-    "@gitzone/tsbundle": "^2.0.6",
+    "@gitzone/tsbundle": "^2.0.8",
-    "@gitzone/tsrun": "^1.2.39",
+    "@gitzone/tsrun": "^1.2.44",
-    "@gitzone/tstest": "^1.0.72",
+    "@gitzone/tstest": "^1.0.77",
-    "@pushrocks/tapbundle": "^5.0.4",
+    "@push.rocks/tapbundle": "^5.0.12",
-    "@types/node": "^18.11.18"
+    "@types/node": "^20.4.5"
   },
   "files": [
     "ts/**/*",

readme.md

@@ -1,27 +1,26 @@
-# @pushrocks/taskbuffer
+# @push.rocks/taskbuffer
 flexible task management. TypeScript ready!
 
 ## Availabililty and Links
-* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/taskbuffer)
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@push.rocks/taskbuffer)
-* [gitlab.com (source)](https://gitlab.com/pushrocks/taskbuffer)
+* [gitlab.com (source)](https://gitlab.com/push.rocks/taskbuffer)
-* [github.com (source mirror)](https://github.com/pushrocks/taskbuffer)
+* [github.com (source mirror)](https://github.com/push.rocks/taskbuffer)
-* [docs (typedoc)](https://pushrocks.gitlab.io/taskbuffer/)
+* [docs (typedoc)](https://push.rocks.gitlab.io/taskbuffer/)
 
 ## Status for master
 
 Status Category | Status Badge
 -- | --
-GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/taskbuffer/badges/master/pipeline.svg)](https://lossless.cloud)
+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/pushrocks/taskbuffer/badges/master/coverage.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/@pushrocks/taskbuffer)](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/pushrocks/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/@pushrocks/taskbuffer)](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/@pushrocks/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/@pushrocks/taskbuffer)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@push.rocks/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
 
@@ -57,7 +56,6 @@ We are always happy for code contributions. If you are not the code contributing
 
 For further information read the linked docs at the top of this readme.
 
-> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
+## Legal
+> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
 | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
-
-[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

test/test.1.task.ts

@@ -1,116 +1,96 @@
-import { expect, tap } from '@pushrocks/tapbundle';
+import { expect, tap } from '@push.rocks/tapbundle';
-
 import * as taskbuffer from '../ts/index.js';
-
+import * as smartpromise from '@push.rocks/smartpromise';
-import * as smartpromise from '@pushrocks/smartpromise';
+import * as smartdelay from '@push.rocks/smartdelay';
-import * as smartdelay from '@pushrocks/smartdelay';
-
-// setup some testData to work with
-let testTask: taskbuffer.Task;
-
-let testPreTask = new taskbuffer.Task({
-  taskFunction: async () => {
-    console.log('preTask executed');
-  },
-  preTask: testTask,
-});
-
-// some more tasks to test with
-let task1Counter = 0; // how often task 1 is being executed
-let task1 = new taskbuffer.Task({
-  name: 'Task 1',
-  taskFunction: () => {
-    let done = smartpromise.defer();
-    console.log('Task1 started');
-    setTimeout(() => {
-      task1Counter++;
-      console.log('Task1 executed');
-      done.resolve();
-    }, 5000);
-    return done.promise;
-  },
-});
-
-let task2 = new taskbuffer.Task({
-  name: 'Task 1',
-  taskFunction: async () => {
-    const done = smartpromise.defer();
-    console.log('Task2 started');
-    setTimeout(() => {
-      console.log('Task2 executed');
-      done.resolve();
-    }, 5000);
-    await done.promise;
-  },
-});
-
-let task3 = new taskbuffer.Task({
-  name: 'Task 3',
-  taskFunction: () => {
-    let done = smartpromise.defer();
-    console.log('Task3 started');
-    setTimeout(() => {
-      console.log('Task3 executed');
-      done.resolve();
-    }, 5000);
-    return done.promise;
-  },
-});
 
 tap.test('new Task() should return a new task', async () => {
-  testTask = new taskbuffer.Task({
+  const testTask = new taskbuffer.Task({
     taskFunction: async () => {
       console.log('executed twice');
     },
-    preTask: testPreTask,
   });
-});
-
-tap.test('expect testTask to be an instance of Task', async () => {
   expect(testTask).toBeInstanceOf(taskbuffer.Task);
 });
 
-tap.test('expect testTask.idle is true', async () => {
+tap.test('should be able to get the task state', async () => {
-  if (!testTask.idle) {
+  const testTask = new taskbuffer.Task({
-    throw new Error('testTask.idle is not true');
+    taskFunction: async () => {},
-  }
+  });
+  expect(testTask.state).toEqual('ready');
 });
 
-tap.test('testTask.running should be of type boolean and initially false', async () => {
+tap.test('should have bufferMax set to the provided value', async () => {
-  expect(testTask.running).toBeTypeofBoolean();
+  const task2 = new taskbuffer.Task({
-  // tslint:disable-next-line:no-unused-expression
+    taskFunction: async () => {},
-  expect(testTask.running).toBeFalse();
+  });
+  expect(task2.bufferMax).toBeUndefined();  // test for a task without bufferMax set
+  const bufferedTask = new taskbuffer.Task({
+    taskFunction: async () => {},
+    buffered: true,
+    bufferMax: 3,
+  });
+  expect(bufferedTask.bufferMax).toEqual(3);
 });
 
-tap.test('testTask.trigger() should return Promise', async () => {
+tap.test('should be able to trigger tasks multiple times', async () => {
-  expect(testTask.trigger()).toBeInstanceOf(Promise);
+  let task1Counter = 0; 
-});
+  const task1 = new taskbuffer.Task({
-
+    name: 'Task 1',
-tap.test('testTask.trigger() returned Promise should be fullfilled', async () => {
+    taskFunction: () => {
-  await testTask.trigger();
+      let done = smartpromise.defer();
-});
+      console.log('Task1 started');
-
+      setTimeout(() => {
-tap.test('expect to run a task without pre and afterTask errorless', async () => {
+        task1Counter++;
-  let localTestTask = new taskbuffer.Task({
+        console.log('Task1 executed');
-    taskFunction: async () => {
+        done.resolve();
-      console.log('only once');
+      }, 5000);
+      return done.promise;
     },
   });
-  await localTestTask.trigger();
+  await task1.trigger();
+  await task1.trigger();
+  expect(task1Counter).toEqual(2);
 });
 
-tap.test('expect task to run in buffered mode', async () => {
+tap.test('should execute setup function before the task function', async () => {
-  let localTestTask = new taskbuffer.Task({
+  const task2 = new taskbuffer.Task({
+    name: 'Task 2',
+    taskSetup: async () => {
+      console.log('this is the setup function for task 2. It should only run once.')
+      return {
+        nice: 'yes',
+      }
+    },
+    taskFunction: async (before, setupArg) => {
+      expect(setupArg).toEqual({ nice: 'yes' });
+      const done = smartpromise.defer();
+      console.log('Task2 started');
+      setTimeout(() => {
+        console.log('Task2 executed');
+        done.resolve();
+      }, 5000);
+      await done.promise;
+    },
+  });
+  await task2.trigger();
+});
+
+tap.test('should not exceed bufferMax when task is buffered', async () => {
+  let counter = 0;
+  const bufferedTask = new taskbuffer.Task({
     taskFunction: async () => {
-      await smartdelay.delayFor(3000);
+      counter++;
+      await smartdelay.delayFor(2000);
+      counter--;
     },
     buffered: true,
     bufferMax: 2,
   });
-  localTestTask.trigger();
+  bufferedTask.trigger();
-  localTestTask.trigger();
+  bufferedTask.trigger();
-  localTestTask.trigger();
+  bufferedTask.trigger();
-  await localTestTask.trigger();
+  await smartdelay.delayFor(100);
+  expect(counter <= bufferedTask.bufferMax).toBeTrue();
 });
 
 tap.start();

test/test.2.taskchain.ts

@@ -1,9 +1,9 @@
-import { expect, tap } from '@pushrocks/tapbundle';
+import { expect, tap } from '@push.rocks/tapbundle';
 
 import * as taskbuffer from '../ts/index.js';
 
-import * as smartpromise from '@pushrocks/smartpromise';
+import * as smartpromise from '@push.rocks/smartpromise';
-import * as smartdelay from '@pushrocks/smartdelay';
+import * as smartdelay from '@push.rocks/smartdelay';
 
 let task1Executed = false;
 const task1 = new taskbuffer.Task({

test/test.3.taskparallel.ts

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

test/test.4.taskmanager.both.ts

@@ -1,9 +1,9 @@
-import { expect, tap } from '@pushrocks/tapbundle';
+import { expect, tap } from '@push.rocks/tapbundle';
 
 import * as taskbuffer from '../ts/index.js';
 
-import * as smartpromise from '@pushrocks/smartpromise';
+import * as smartpromise from '@push.rocks/smartpromise';
-import * as smartdelay from '@pushrocks/smartdelay';
+import * as smartdelay from '@push.rocks/smartdelay';
 
 let myTaskManager: taskbuffer.TaskManager;
 let taskRunCounter = 0;

test/test.5.task.paramflow.ts

@@ -1,9 +1,9 @@
-import { expect, tap } from '@pushrocks/tapbundle';
+import { expect, tap } from '@push.rocks/tapbundle';
 
 import * as taskbuffer from '../ts/index.js';
 
-import * as smartpromise from '@pushrocks/smartpromise';
+import * as smartpromise from '@push.rocks/smartpromise';
-import * as smartdelay from '@pushrocks/smartdelay';
+import * as smartdelay from '@push.rocks/smartdelay';
 
 const flowTask1 = new taskbuffer.Task({
   taskFunction: (x: number) => {

test/test.6.taskonce.ts

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

test/test.7.taskloop.ts

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

test/test.8.bufferedrun.ts

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

test/test.taskrunner.ts

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

ts/00_commitinfo_data.ts

@@ -2,7 +2,7 @@
  * autocreated commitinfo by @pushrocks/commitinfo
  */
 export const commitinfo = {
-  name: '@pushrocks/taskbuffer',
+  name: '@push.rocks/taskbuffer',
-  version: '3.0.8',
+  version: '3.0.14',
   description: 'flexible task management. TypeScript ready!'
 }

ts/index.ts

@@ -1,5 +1,5 @@
 export { Task } from './taskbuffer.classes.task.js';
-export type { ITaskFunction } from './taskbuffer.classes.task.js'
+export type { ITaskFunction } from './taskbuffer.classes.task.js';
 export { Taskchain } from './taskbuffer.classes.taskchain.js';
 export { Taskparallel } from './taskbuffer.classes.taskparallel.js';
 export { TaskManager } from './taskbuffer.classes.taskmanager.js';
@@ -7,6 +7,4 @@ export { TaskOnce } from './taskbuffer.classes.taskonce.js';
 export { TaskRunner } from './taskbuffer.classes.taskrunner.js';
 export { TaskDebounced } from './taskbuffer.classes.taskdebounced.js';
 import * as distributedCoordination from './taskbuffer.classes.distributedcoordinator.js';
-export {
+export { distributedCoordination };
-  distributedCoordination
-}

ts/taskbuffer.classes.bufferrunner.ts

@@ -2,9 +2,10 @@ import { Task } from './taskbuffer.classes.task.js';
 
 export class BufferRunner {
   public task: Task;
-  // initialze by default
+  // initialize by default
   public bufferCounter: number = 0;
-  constructor(taskArg: Task) {
+
+  constructor(taskArg: Task<any>) {
     this.task = taskArg;
   }
 
@@ -13,7 +14,7 @@ export class BufferRunner {
       this.bufferCounter++;
     }
     const returnPromise: Promise<any> = this.task.cycleCounter.getPromiseForCycle(
-      this.bufferCounter + 1
+      this.bufferCounter
     );
     if (!this.task.running) {
       this._run(x);
@@ -21,19 +22,13 @@ export class BufferRunner {
     return returnPromise;
   }
 
-  private _run(x: any) {
+  private async _run(x: any) {
-    const recursiveBufferRunner = (x: any) => {
+    this.task.running = true;
-      if (this.bufferCounter >= 0) {
+    while (this.bufferCounter > 0) {
-        this.task.running = true;
+      const result = await Task.runTask(this.task, { x: x });
-        Task.runTask(this.task, { x: x }).then((x) => {
+      this.bufferCounter--;
-          this.bufferCounter--; // this.bufferCounter drops below 0, the recursion stops.
+      this.task.cycleCounter.informOfCycle(result);
-          this.task.cycleCounter.informOfCycle(x);
+    }
-          recursiveBufferRunner(x);
+    this.task.running = false;
-        });
-      } else {
-        this.task.running = false;
-      }
-    };
-    recursiveBufferRunner(x);
   }
 }

ts/taskbuffer.classes.cyclecounter.ts

@@ -9,7 +9,7 @@ export interface ICycleObject {
 export class CycleCounter {
   public task: Task;
   public cycleObjectArray: ICycleObject[] = [];
-  constructor(taskArg: Task) {
+  constructor(taskArg: Task<any>) {
     this.task = taskArg;
   }
   public getPromiseForCycle(cycleCountArg: number) {

ts/taskbuffer.classes.distributedcoordinator.ts

@@ -4,7 +4,7 @@ import * as plugins from './taskbuffer.plugins.js';
 /**
  * constains all data for the final coordinator to actually make an informed decision
  */
-export interface IDistributedDecisionInfoBasis {
+export interface IDistributedTaskRequest {
   /**
    * this needs to correlate to the consultationResult
    */
@@ -17,11 +17,14 @@ export interface IDistributedDecisionInfoBasis {
   status: 'requesting' | 'gotRejected' | 'failed' | 'succeeded';
 }
 
-export interface IDsitributedTaskConsultationResult {
+export interface IDistributedTaskRequestResult {
   /**
    * this needs to correlate to the decisionInfoBasis
    */
   submitterRandomId: string;
+  /**
+   * can be used while debugging
+   */
   considered: boolean;
   rank: string;
   reason: string;
@@ -29,6 +32,10 @@ export interface IDsitributedTaskConsultationResult {
 }
 
 export abstract class AbstractDistributedCoordinator {
-  public abstract announceDistributedDecisionInfoBasis(infoBasisArg: IDistributedDecisionInfoBasis): Promise<IDsitributedTaskConsultationResult>
+  public abstract fireDistributedTaskRequest(
-  public abstract updateDistributedDevisionInfoBasis(infoBasisArg: IDistributedDecisionInfoBasis): Promise<void>
+    infoBasisArg: IDistributedTaskRequest
-}
+  ): Promise<IDistributedTaskRequestResult>;
+  public abstract updateDistributedTaskRequest(
+    infoBasisArg: IDistributedTaskRequest
+  ): Promise<void>;
+}

ts/taskbuffer.classes.task.ts

@@ -4,20 +4,24 @@ import { CycleCounter } from './taskbuffer.classes.cyclecounter.js';
 
 import { logger } from './taskbuffer.logging.js';
 
-export interface ITaskFunction {
+export interface ITaskFunction<T = undefined> {
-  (x?: any): PromiseLike<any>;
+  (x?: any, setupValue?: T): PromiseLike<any>;
 }
 
-export type TPreOrAfterTaskFunction = () => Task;
+export interface ITaskSetupFunction<T = undefined> {
+  (): Promise<T>;
+}
 
-export class Task {
+export type TPreOrAfterTaskFunction = () => Task<any>;
+
+export class Task<T = undefined> {
   // STATIC
-  public static extractTask(preOrAfterTaskArg: Task | TPreOrAfterTaskFunction): Task {
+  public static extractTask<T = undefined>(preOrAfterTaskArg: Task<T> | TPreOrAfterTaskFunction): Task<T> {
     switch (true) {
       case !preOrAfterTaskArg:
         return null;
       case preOrAfterTaskArg instanceof Task:
-        return preOrAfterTaskArg as Task;
+        return preOrAfterTaskArg as Task<T>;
       case typeof preOrAfterTaskArg === 'function':
         const taskFunction = preOrAfterTaskArg as TPreOrAfterTaskFunction;
         return taskFunction();
@@ -32,7 +36,7 @@ export class Task {
     return done.promise;
   };
 
-  public static isTask = (taskArg: Task): boolean => {
+  public static isTask = (taskArg: Task<any>): boolean => {
     if (taskArg instanceof Task && typeof taskArg.taskFunction === 'function') {
       return true;
     } else {
@@ -40,10 +44,10 @@ export class Task {
     }
   };
 
-  public static isTaskTouched = (
+  public static isTaskTouched<T = undefined> (
-    taskArg: Task | TPreOrAfterTaskFunction,
+    taskArg: Task<T> | TPreOrAfterTaskFunction,
-    touchedTasksArray: Task[]
+    touchedTasksArray: Task<T>[]
-  ): boolean => {
+  ): boolean {
     const taskToCheck = Task.extractTask(taskArg);
     let result = false;
     for (const keyArg in touchedTasksArray) {
@@ -54,42 +58,39 @@ export class Task {
     return result;
   };
 
-  public static runTask = async (
+  public static runTask = async <T>(
-    taskArg: Task | TPreOrAfterTaskFunction,
+    taskArg: Task<T> | TPreOrAfterTaskFunction,
-    optionsArg: { x?: any; touchedTasksArray?: Task[] }
+    optionsArg: { x?: any; touchedTasksArray?: Task<T>[] }
   ) => {
-    // 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();
 
-    // pay respect to execDelay
+    if (!taskToRun.setupValue && taskToRun.taskSetup) {
+      taskToRun.setupValue = await taskToRun.taskSetup();
+    }
+
     if (taskToRun.execDelay) {
       await plugins.smartdelay.delayFor(taskToRun.execDelay);
     }
 
-    //  set running params
     taskToRun.running = true;
 
     done.promise.then(async () => {
       taskToRun.running = false;
     });
 
-    // handle options
     const options = {
       ...{ x: undefined, touchedTasksArray: [] },
       ...optionsArg,
     };
     const x = options.x;
-    const touchedTasksArray: Task[] = options.touchedTasksArray;
+    const touchedTasksArray: Task<T>[] = options.touchedTasksArray;
 
     touchedTasksArray.push(taskToRun);
 
-    // run the task cascade
     const localDeferred = plugins.smartpromise.defer();
     localDeferred.promise
       .then(() => {
-        // lets run any preTask
-
         if (taskToRun.preTask && !Task.isTaskTouched(taskToRun.preTask, touchedTasksArray)) {
           return Task.runTask(taskToRun.preTask, { x, touchedTasksArray });
         } else {
@@ -99,9 +100,8 @@ export class Task {
         }
       })
       .then(async (x) => {
-        // lets run the main task
         try {
-          return await taskToRun.taskFunction(x);
+          return await taskToRun.taskFunction(x, taskToRun.setupValue);
         } catch (e) {
           console.log(e);
         }
@@ -126,15 +126,9 @@ export class Task {
   };
 
   // INSTANCE
-  // mandatory properties
   public name: string;
-  /**
-   * the version of the task
-   * should follow semver
-   * might be important for DistributedCoordinator
-   */
   public version: string;
-  public taskFunction: ITaskFunction;
+  public taskFunction: ITaskFunction<T>;
   public buffered: boolean;
   public cronJob: plugins.smarttime.CronJob;
 
@@ -142,11 +136,9 @@ export class Task {
   public execDelay: number;
   public timeout: number;
 
-  // tasks to run before and after
+  public preTask: Task<T> | TPreOrAfterTaskFunction;
-  public preTask: Task | TPreOrAfterTaskFunction;
+  public afterTask: Task<T> | TPreOrAfterTaskFunction;
-  public afterTask: Task | TPreOrAfterTaskFunction;
 
-  // initialize by default
   public running: boolean = false;
   public bufferRunner = new BufferRunner(this);
   public cycleCounter = new CycleCounter(this);
@@ -154,36 +146,18 @@ export class Task {
   public idle: boolean = true;
   private _state: string = 'ready';
 
+  public taskSetup: ITaskSetupFunction<T>;
+  public setupValue: T;
+
   constructor(optionsArg: {
-    /**
+    taskFunction: ITaskFunction<T>;
-     * the task function to run, must return promise
+    preTask?: Task<T> | TPreOrAfterTaskFunction;
-     */
+    afterTask?: Task<T> | TPreOrAfterTaskFunction;
-    taskFunction: ITaskFunction;
-    /**
-     * any other task to run before
-     */
-    preTask?: Task | TPreOrAfterTaskFunction;
-    /**
-     * any other task to run after
-     */
-    afterTask?: Task | TPreOrAfterTaskFunction;
-    /**
-     * wether this task should run buffered
-     */
     buffered?: boolean;
-    /**
-     * the maximum buffer
-     */
     bufferMax?: number;
-    /**
-     * the execution delay, before the task is executed
-     * only makes sense when running in buffered mode
-     */
     execDelay?: number;
-    /**
-     * the name of the task
-     */
     name?: string;
+    taskSetup?: ITaskSetupFunction<T>;
   }) {
     this.taskFunction = optionsArg.taskFunction;
     this.preTask = optionsArg.preTask;
@@ -193,11 +167,9 @@ export class Task {
     this.bufferMax = optionsArg.bufferMax;
     this.execDelay = optionsArg.execDelay;
     this.name = optionsArg.name;
+    this.taskSetup = optionsArg.taskSetup;
   }
 
-  /**
-   * trigger the task. Will trigger buffered if this.buffered is true
-   */
   public trigger(x?: any): Promise<any> {
     if (this.buffered) {
       return this.triggerBuffered(x);
@@ -206,18 +178,10 @@ export class Task {
     }
   }
 
-  /**
-   * trigger task unbuffered.
-   * will actually run the task, not considering any buffered limits.
-   */
   public triggerUnBuffered(x?: any): Promise<any> {
-    return Task.runTask(this, { x: x });
+    return Task.runTask<T>(this, { x: x });
   }
 
-  /**
-   * trigger task buffered.
-   * note: .trigger() also calls this function
-   */
   public triggerBuffered(x?: any): Promise<any> {
     return this.bufferRunner.trigger(x);
   }

ts/taskbuffer.classes.taskdebounced.ts

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

ts/taskbuffer.classes.taskmanager.ts

@@ -9,7 +9,7 @@ export interface ICronJob {
 }
 
 export interface ITaskManagerConstructorOptions {
-  distributedCoordinator?: AbstractDistributedCoordinator
+  distributedCoordinator?: AbstractDistributedCoordinator;
 }
 
 export class TaskManager {
@@ -18,7 +18,7 @@ export class TaskManager {
   private cronJobManager = new plugins.smarttime.CronManager();
 
   public options: ITaskManagerConstructorOptions = {
-    distributedCoordinator: null
+    distributedCoordinator: null,
   };
 
   constructor(optionosArg: ITaskManagerConstructorOptions = {}) {
@@ -78,36 +78,40 @@ export class TaskManager {
    */
   public scheduleTaskByName(taskNameArg: string, cronStringArg: string) {
     const taskToSchedule = this.getTaskByName(taskNameArg);
-    const cronJob = this.cronJobManager.addCronjob(cronStringArg, async (triggerTimeArg: number) => {
+    const cronJob = this.cronJobManager.addCronjob(
-      console.log(`taskbuffer schedule triggered task >>${taskToSchedule.name}<<`);
+      cronStringArg,
-      console.log(
+      async (triggerTimeArg: number) => {
-        `task >>${taskToSchedule.name}<< is ${
+        console.log(`taskbuffer schedule triggered task >>${taskToSchedule.name}<<`);
-          taskToSchedule.buffered
+        console.log(
-            ? `buffered with max ${taskToSchedule.bufferMax} buffered calls`
+          `task >>${taskToSchedule.name}<< is ${
-            : `unbuffered`
+            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.announceDistributedDecisionInfoBasis({
+        if (this.options.distributedCoordinator) {
-          submitterRandomId: this.randomId,
+          console.log(`Found a distrubuted coordinator, performing distributed consultation.`);
-          status: 'requesting',
+          const announcementResult =
-          taskExecutionParallel: 1,
+            await this.options.distributedCoordinator.fireDistributedTaskRequest({
-          taskExecutionTime: triggerTimeArg,
+              submitterRandomId: this.randomId,
-          taskExecutionTimeout: taskToSchedule.timeout,
+              status: 'requesting',
-          taskName: taskToSchedule.name,
+              taskExecutionParallel: 1,
-          taskVersion: taskToSchedule.version,
+              taskExecutionTime: triggerTimeArg,
-        });
+              taskExecutionTimeout: taskToSchedule.timeout,
+              taskName: taskToSchedule.name,
+              taskVersion: taskToSchedule.version,
+            });
 
-        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 taskToSchedule.trigger();
+    );
-    });
     taskToSchedule.cronJob = cronJob;
   }
 

ts/taskbuffer.classes.taskonce.ts

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

ts/taskbuffer.plugins.ts

@@ -1,9 +1,9 @@
-import * as isounique from '@pushrocks/isounique';
+import * as isounique from '@push.rocks/isounique';
-import * as lik from '@pushrocks/lik';
+import * as lik from '@push.rocks/lik';
-import * as smartlog from '@pushrocks/smartlog';
+import * as smartlog from '@push.rocks/smartlog';
-import * as smartpromise from '@pushrocks/smartpromise';
+import * as smartpromise from '@push.rocks/smartpromise';
-import * as smartdelay from '@pushrocks/smartdelay';
+import * as smartdelay from '@push.rocks/smartdelay';
-import * as smartrx from '@pushrocks/smartrx';
+import * as smartrx from '@push.rocks/smartrx';
-import * as smarttime from '@pushrocks/smarttime';
+import * as smarttime from '@push.rocks/smarttime';
 
 export { isounique, lik, smartlog, smartpromise, smartdelay, smartrx, smarttime };

tsconfig.json

@@ -5,6 +5,7 @@
     "target": "ES2022",
     "module": "ES2022",
     "moduleResolution": "nodenext",
-    "esModuleInterop": true
+    "esModuleInterop": true,
+    "verbatimModuleSyntax": true,
   }
 }