@push.rocks/taskbuffer 3.0.10

package/ts/taskbuffer.classes.task.ts

@@ -0,0 +1,236 @@
+import * as plugins from './taskbuffer.plugins.js';
+import { BufferRunner } from './taskbuffer.classes.bufferrunner.js';
+import { CycleCounter } from './taskbuffer.classes.cyclecounter.js';
+
+import { logger } from './taskbuffer.logging.js';
+
+export interface ITaskFunction {
+  (x?: any): PromiseLike<any>;
+}
+
+export type TPreOrAfterTaskFunction = () => Task;
+
+export class Task {
+  // STATIC
+  public static extractTask(preOrAfterTaskArg: Task | TPreOrAfterTaskFunction): Task {
+    switch (true) {
+      case !preOrAfterTaskArg:
+        return null;
+      case preOrAfterTaskArg instanceof Task:
+        return preOrAfterTaskArg as Task;
+      case typeof preOrAfterTaskArg === 'function':
+        const taskFunction = preOrAfterTaskArg as TPreOrAfterTaskFunction;
+        return taskFunction();
+      default:
+        return null;
+    }
+  }
+
+  public static emptyTaskFunction: ITaskFunction = function (x) {
+    const done = plugins.smartpromise.defer();
+    done.resolve();
+    return done.promise;
+  };
+
+  public static isTask = (taskArg: Task): boolean => {
+    if (taskArg instanceof Task && typeof taskArg.taskFunction === 'function') {
+      return true;
+    } else {
+      return false;
+    }
+  };
+
+  public static isTaskTouched = (
+    taskArg: Task | TPreOrAfterTaskFunction,
+    touchedTasksArray: Task[]
+  ): boolean => {
+    const taskToCheck = Task.extractTask(taskArg);
+    let result = false;
+    for (const keyArg in touchedTasksArray) {
+      if (taskToCheck === touchedTasksArray[keyArg]) {
+        result = true;
+      }
+    }
+    return result;
+  };
+
+  public static runTask = async (
+    taskArg: Task | TPreOrAfterTaskFunction,
+    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();
+
+    // pay respect to execDelay
+    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;
+
+    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 {
+          const done2 = plugins.smartpromise.defer();
+          done2.resolve(x);
+          return done2.promise;
+        }
+      })
+      .then(async (x) => {
+        // lets run the main task
+        try {
+          return await taskToRun.taskFunction(x);
+        } catch (e) {
+          console.log(e);
+        }
+      })
+      .then((x) => {
+        if (taskToRun.afterTask && !Task.isTaskTouched(taskToRun.afterTask, touchedTasksArray)) {
+          return Task.runTask(taskToRun.afterTask, { x: x, touchedTasksArray: touchedTasksArray });
+        } else {
+          const done2 = plugins.smartpromise.defer();
+          done2.resolve(x);
+          return done2.promise;
+        }
+      })
+      .then((x) => {
+        done.resolve(x);
+      })
+      .catch((err) => {
+        console.log(err);
+      });
+    localDeferred.resolve();
+    return await done.promise;
+  };
+
+  // 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 buffered: boolean;
+  public cronJob: plugins.smarttime.CronJob;
+
+  public bufferMax: number;
+  public execDelay: number;
+  public timeout: number;
+
+  // tasks to run before and after
+  public preTask: Task | TPreOrAfterTaskFunction;
+  public afterTask: Task | TPreOrAfterTaskFunction;
+
+  // initialize by default
+  public running: boolean = false;
+  public bufferRunner = new BufferRunner(this);
+  public cycleCounter = new CycleCounter(this);
+
+  public idle: boolean = true;
+  private _state: string = 'ready';
+
+  constructor(optionsArg: {
+    /**
+     * the task function to run, must return promise
+     */
+    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;
+  }) {
+    this.taskFunction = optionsArg.taskFunction;
+    this.preTask = optionsArg.preTask;
+    this.afterTask = optionsArg.afterTask;
+    this.idle = !this.running;
+    this.buffered = optionsArg.buffered;
+    this.bufferMax = optionsArg.bufferMax;
+    this.execDelay = optionsArg.execDelay;
+    this.name = optionsArg.name;
+  }
+
+  /**
+   * trigger the task. Will trigger buffered if this.buffered is true
+   */
+  public trigger(x?: any): Promise<any> {
+    if (this.buffered) {
+      return this.triggerBuffered(x);
+    } else {
+      return this.triggerUnBuffered(x);
+    }
+  }
+
+  /**
+   * 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 });
+  }
+
+  /**
+   * trigger task buffered.
+   * note: .trigger() also calls this function
+   */
+  public triggerBuffered(x?: any): Promise<any> {
+    return this.bufferRunner.trigger(x);
+  }
+
+  get state(): string {
+    return this._state;
+  }
+
+  set state(stateArg: string) {
+    if (stateArg === 'locked') {
+      this._state = 'locked';
+    } else {
+      logger.log('error', `state type ${stateArg} could not be set`);
+    }
+  }
+}

package/ts/taskbuffer.classes.taskchain.ts

@@ -0,0 +1,58 @@
+// TaskChain chains tasks
+// and extends Task
+
+import * as plugins from './taskbuffer.plugins.js';
+import { Task } from './taskbuffer.classes.task.js';
+import { logger } from './taskbuffer.logging.js';
+
+export class Taskchain extends Task {
+  taskArray: Task[];
+  constructor(optionsArg: {
+    taskArray: Task[];
+    name?: string;
+    log?: boolean;
+    buffered?: boolean;
+    bufferMax?: number;
+  }) {
+    const options = {
+      ...{
+        name: 'unnamed Taskchain',
+        log: false,
+      },
+      ...optionsArg,
+      ...{
+        taskFunction: (x: any) => {
+          // 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: any) => {
+            if (typeof this.taskArray[taskCounter] !== 'undefined') {
+              console.log(this.name + ' running: Task' + this.taskArray[taskCounter].name);
+              this.taskArray[taskCounter].trigger(x).then((x) => {
+                logger.log('info', this.taskArray[taskCounter].name);
+                taskCounter++;
+                iterateTasks(x);
+              });
+            } else {
+              console.log('Taskchain "' + this.name + '" completed successfully');
+              done.resolve(x);
+            }
+          };
+          iterateTasks(x);
+          return done.promise;
+        },
+      },
+    };
+    super(options);
+    this.taskArray = optionsArg.taskArray;
+  }
+  addTask(taskArg: Task) {
+    this.taskArray.push(taskArg);
+  }
+  removeTask(taskArg: Task) {
+    // TODO:
+  }
+  shiftTask() {
+    // TODO:
+  }
+}

package/ts/taskbuffer.classes.taskdebounced.ts

@@ -0,0 +1,27 @@
+import * as plugins from './taskbuffer.plugins.js';
+
+import { Task, ITaskFunction } from './taskbuffer.classes.task.js';
+
+export class TaskDebounced<T = unknown> extends Task {
+  private _debouncedTaskFunction: ITaskFunction;
+  private _observableIntake = new plugins.smartrx.ObservableIntake<T>();
+
+  constructor(optionsArg: {
+    name: string;
+    taskFunction: ITaskFunction;
+    debounceTimeInMillis: number;
+  }) {
+    super({
+      name: optionsArg.name,
+      taskFunction: async (x: T) => {
+        this._observableIntake.push(x);
+      },
+    });
+    this.taskFunction = optionsArg.taskFunction;
+    this._observableIntake.observable
+      .pipe(plugins.smartrx.rxjs.ops.debounceTime(optionsArg.debounceTimeInMillis))
+      .subscribe((x) => {
+        this.taskFunction(x);
+      });
+  }
+}

package/ts/taskbuffer.classes.taskmanager.ts

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

package/ts/taskbuffer.classes.taskonce.ts

@@ -0,0 +1,21 @@
+import * as plugins from './taskbuffer.plugins.js';
+
+import { Task, ITaskFunction } from './taskbuffer.classes.task.js';
+
+/**
+ * TaskOnce is run exactly once, no matter how often it is triggered
+ */
+export class TaskOnce extends Task {
+  hasTriggered: boolean = false;
+  constructor(optionsArg: { name?: string; taskFunction: ITaskFunction }) {
+    super({
+      name: optionsArg.name,
+      taskFunction: async () => {
+        if (!this.hasTriggered) {
+          this.hasTriggered = true;
+          await optionsArg.taskFunction();
+        }
+      },
+    });
+  }
+}

package/ts/taskbuffer.classes.taskparallel.ts

@@ -0,0 +1,24 @@
+import * as plugins from './taskbuffer.plugins.js';
+import { Task } from './taskbuffer.classes.task.js';
+
+export class Taskparallel extends Task {
+  public taskArray: Task[];
+  constructor(optionsArg: { taskArray: Task[] }) {
+    const options = {
+      ...optionsArg,
+      ...{
+        taskFunction: () => {
+          const done = plugins.smartpromise.defer();
+          const promiseArray: Promise<any>[] = []; // stores promises of all tasks, since they run in parallel
+          this.taskArray.forEach(function (taskArg) {
+            promiseArray.push(taskArg.trigger());
+          });
+          Promise.all(promiseArray).then(done.resolve);
+          return done.promise;
+        },
+      },
+    };
+    super(options);
+    this.taskArray = optionsArg.taskArray;
+  }
+}

package/ts/taskbuffer.classes.taskrunner.ts

@@ -0,0 +1,63 @@
+import * as plugins from './taskbuffer.plugins.js';
+
+import { Task } from './taskbuffer.classes.task.js';
+
+export class TaskRunner {
+  public maxParrallelJobs: number = 1;
+  public status: 'stopped' | 'running' = 'stopped';
+  public runningTasks: plugins.lik.ObjectMap<Task> = new plugins.lik.ObjectMap<Task>();
+  public qeuedTasks: Task[] = [];
+
+  constructor() {
+    this.runningTasks.eventSubject.subscribe(async (eventArg) => {
+      this.checkExecution();
+    });
+  }
+
+  /**
+   * adds a task to the qeue
+   */
+  public addTask(taskArg: Task) {
+    this.qeuedTasks.push(taskArg);
+    this.checkExecution();
+  }
+
+  /**
+   * set amount of parallel tasks
+   * be careful, you might loose dependability of tasks
+   */
+  public setMaxParallelJobs(maxParrallelJobsArg: number) {
+    this.maxParrallelJobs = maxParrallelJobsArg;
+  }
+
+  /**
+   * starts the task queue
+   */
+  public async start() {
+    this.status = 'running';
+  }
+
+  /**
+   * checks wether execution is on point
+   */
+  public async checkExecution() {
+    if (
+      this.runningTasks.getArray().length < this.maxParrallelJobs &&
+      this.status === 'running' &&
+      this.qeuedTasks.length > 0
+    ) {
+      const nextJob = this.qeuedTasks.shift();
+      this.runningTasks.add(nextJob);
+      await nextJob.trigger();
+      this.runningTasks.remove(nextJob);
+      this.checkExecution();
+    }
+  }
+
+  /**
+   * stops the task queue
+   */
+  public async stop() {
+    this.status = 'stopped';
+  }
+}

package/ts/taskbuffer.logging.ts

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

package/ts/taskbuffer.plugins.ts

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