task-handler/src/index.js

Handle Javascript Timers like a boss! https://odo-network.github.io/task-handler/

/* @flow */
import type {
  Task$Types,
  Task$Handler,
  Task$Ref,
  Task$RefMap,
  Task$Job,
} from './types';

import {
  NOOP,
  EXECUTE_RESULT,
  TASK_CANCELLED,
  STATIC_EMPTY_ARRAY,
} from './constants';

import createDeferQueue from './defer';

export { TASK_CANCELLED } from './constants';

/**
 * Runs a sequential loop where the first fn is awaited
 * then the second is awaited until one of the calls returns
 * 'CANCEL'
 */
async function sequentialLoop(ref, next, execute, deferPromise): Promise<void> {
  // eslint-disable-next-line no-constant-condition
  if (deferPromise) {
    await deferPromise;
    await execute();
  }
  while (!ref.status.complete) {
    await next();
    if (ref.status.complete) return;
    await execute();
  }
}

function createTaskRef<+ID: any, +A: Array<any>>(
  type: Task$Types,
  id: ID,
  handler: Task$Handler,
  clearRef,
  jobDescriptor?: [(...args: A) => Task$Job, A, Task$RefMap],
): Task$Ref {
  handler.cancel(id);
  let promise: void | Promise<Task$Ref>;
  let promiseActions;
  let lastResult;
  let job: Task$Job;

  const getNextPromise = () => {
    if (promise) return promise;
    promise = new Promise((resolve, reject) => {
      promiseActions = [resolve, reject];
    });
    return promise;
  };

  const getTaskError = err => {
    ref.status.error = true;
    const error: { taskRef?: Task$Ref } & Error = typeof err === 'object' ? err : new Error(err);
    error.taskRef = ref;
    lastResult = error;
    if (ref.type !== 'every') {
      ref.cancel();
    }
    return error;
  };

  const ref: Task$Ref = {
    get result() {
      if (ref.status.complete) {
        return lastResult;
      }
      return undefined;
    },
    get promise() {
      return async function promisedResult(): Promise<Task$Ref> {
        let instancePromise;
        try {
          if (ref.status.complete) {
            if (ref.status.error) {
              throw lastResult;
            }
            return ref;
          }
          instancePromise = getNextPromise();
          await instancePromise;
          return ref;
        } finally {
          if (instancePromise === promise) {
            promiseActions = undefined;
            promise = undefined;
          }
        }
      };
    },
    get promises() {
      if (type !== 'every') {
        throw new Error(
          `[ERROR] | task-handler | "ref.promises()" may only be used with iterative tasks such as every and everyNow, but tried with "${type}" task with ID: "${id}"`,
        );
      }
      return async function* promiseIterator(): AsyncGenerator<
        Task$Ref,
        Task$Ref,
        *,
        > {
        let instancePromise;
        try {
          while (!ref.status.complete) {
            instancePromise = getNextPromise();
            // eslint-disable-next-line no-await-in-loop
            await instancePromise;
            yield ref;
            if (instancePromise === promise) {
              promiseActions = undefined;
              promise = undefined;
            }
          }
          return ref;
        } finally {
          if (instancePromise === promise) {
            promiseActions = undefined;
            promise = undefined;
          }
        }
      };
    },
    status: {
      resolving: false,
      complete: false,
      error: false,
      cancelled: false,
    },
    // $FlowIgnore
    [TASK_CANCELLED](promises) {
      if (ref.status.complete || ref.status.resolving) {
        return;
      }
      ref.status.complete = true;
      if (ref.status.error === false) {
        lastResult = TASK_CANCELLED;
        ref.status.cancelled = true;
        if (promiseActions) {
          promiseActions[0](ref);
        }
        if (job) {
          /* istanbul ignore else */
          if (typeof job.cancelled === 'function') {
            promises.push(job.cancelled.call(ref, ref));
          } else if (
            !job.complete
            && typeof process === 'object'
            && process.env.NODE_ENV !== 'production'
          ) {
            console.warn(
              `[WARN] | task-handler | Async Job "${id}" was cancelled but provided no "cancelled" or "complete" handler.`,
            );
          }
          if (job.complete) {
            promises.push(job.complete.call(ref, ref));
          }
        }
      }
    },
    // $FlowIgnore
    [EXECUTE_RESULT](err, result) {
      if (!ref.status.complete) {
        lastResult = result;
        if (ref.type !== 'every') {
          ref.status.complete = true;
        }
        if (err && !promiseActions) {
          console.error(
            `[ERROR] | task-handler | An unhandled error occurred while running a task with id "${
              ref.id
            }" with type "${
              ref.type
            }".  If the errors can not be caught in the handler function that is called, these errors can be handled by calling 'ref.promise().catch()' or through async iteration handling if the task is using intervals.\n`,
            err,
          );
          return;
        }
        const error = err ? getTaskError(err) : undefined;
        if (job) {
          if (error && job.error) {
            job.error.call(ref, error);
          }
          if (job.complete) {
            job.complete.call(ref, ref);
          }
        }
        if (promiseActions) {
          if (error) return promiseActions[1](error);
          return promiseActions[0](ref);
        }
      }
    },
    id,
    type,
    task: handler,
    resolve(result) {
      ref.status.resolving = true;
      clearRef(id);
      // $FlowIgnore
      return ref[EXECUTE_RESULT](undefined, result);
    },
    reject(err) {
      ref.status.resolving = true;
      clearRef(id);
      // $FlowIgnore
      return ref[EXECUTE_RESULT](err);
    },
    cancel() {
      if (!ref.status.complete && !ref.status.resolving) {
        if (ref.status.error === false) {
          lastResult = TASK_CANCELLED;
          ref.status.cancelled = true;
        }
        handler.cancel(id);
      }
    },
  };

  if (jobDescriptor) {
    const [getJob, args, refs] = jobDescriptor;
    job = getJob.call(ref, ref, ...args);
    ref.promise().catch(NOOP);
    // in the case of async jobs we need to set the refs
    // before we run the start call synchronously so that
    // we can handle any actions called during execution.
    refs.set(id, [ref, NOOP]);
    job.start.call(ref, ref);
  }

  return Object.freeze(ref);
}

export default function createTaskHandler(): Task$Handler {
  const refs: Task$RefMap = new Map();
  let queue;

  function getQueue() {
    if (queue) {
      return queue;
    }
    queue = createDeferQueue(refs);
    return queue;
  }

  function clearRef(id, withRef) {
    const descriptor = refs.get(id);
    if (!descriptor) return;
    try {
      const [ref, canceller] = descriptor;
      if (!withRef || withRef === ref) {
        try {
          canceller();
        } catch (err) {
          console.error(
            '[task-handler] | ERROR | Failed to call canceller for ref with id: ',
            id,
          );
        }
      }
      return ref;
    } finally {
      refs.delete(id);
    }
  }

  function cancelID(id: any, promises: Array<any>): void {
    // Required for Flow to resolve
    const ref = clearRef(id);
    if (ref) {
      // $FlowIgnore
      ref[TASK_CANCELLED](promises);
    }
  }

  function execute<R: Task$Ref, +A: Array<any>, +F:(...args: A) => any>(
    ref: R,
    fn: void | F,
    args: A) {
    try {
      if (ref.type !== 'every') {
        ref.status.resolving = true;
        clearRef(ref.id);
      }
      const result = typeof fn === 'function' ? fn.apply(ref, args) : undefined;
      // $FlowIgnore
      ref[EXECUTE_RESULT](undefined, result);
    } catch (e) {
      // $FlowIgnore
      ref[EXECUTE_RESULT](e);
    }
  }

  async function asyncExecute<
    R: Task$Ref,
    +A: Array<any>,
    +F:(...args: A) => any,
  >(ref: R, fn: void | F, args: A) {
    try {
      if (ref.type !== 'every') {
        ref.status.resolving = true;
        clearRef(ref.id);
      }
      const result = typeof fn === 'function' ? await fn.apply(ref, args) : undefined;
      // $FlowIgnore
      await ref[EXECUTE_RESULT](undefined, result);
    } catch (e) {
      // $FlowIgnore
      await ref[EXECUTE_RESULT](e);
    }
  }

  const handler: Task$Handler = Object.freeze({
    get size(): number {
      return refs.size;
    },
    has(...ids: Array<any>) {
      return ids.every(id => refs.has(id));
    },
    after<+ID: any, +A: Array<any>, +F: (...args: A) => any>(
      id: ID,
      delay: number,
      fn?: F,
      ...args: A
    ): Task$Ref {
      const ref = createTaskRef('after', id, handler, clearRef);
      const timeoutID = setTimeout(execute, delay, ref, fn, args);
      refs.set(id, [ref, () => clearTimeout(timeoutID)]);
      return ref;
    },
    defer<+ID: any, +A: Array<any>, +F: (...args: A) => any>(
      id: ID,
      fn?: F,
      ...args: A
    ): Task$Ref {
      const ref = createTaskRef('defer', id, handler, clearRef);
      const cancelDefer = getQueue().add(ref, () => execute(ref, fn, args));
      refs.set(id, [ref, () => cancelDefer()]);
      return ref;
    },
    every<+ID: any, +A: Array<any>, +F: (...args: A) => any>(
      id: ID,
      interval: number,
      fn?: F,
      ...args: A
    ): Task$Ref {
      const ref = createTaskRef('every', id, handler, clearRef);
      const timerID = setInterval(execute, interval, ref, fn, args);
      refs.set(id, [ref, () => clearInterval(timerID)]);
      return ref;
    },
    everyNow<+ID: any, +A: Array<any>, F: (...args: A) => any>(
      id: ID,
      interval: number,
      fn?: F,
      ...args: A
    ): Task$Ref {
      const ref = createTaskRef('every', id, handler, clearRef);
      const timerID = setInterval(execute, interval, ref, fn, args);
      const cancelDefer = getQueue().add(id, () => execute(ref, fn, args));
      refs.set(id, [
        ref,
        () => {
          clearInterval(timerID);
          cancelDefer();
        },
      ]);
      return ref;
    },
    everyNowSequential<+ID: any, +A: Array<any>, +F: (...args: A) => any>(
      id: ID,
      interval: number,
      fn?: F,
      ...args: A
    ): Task$Ref {
      let timerID;
      let resolveNext;
      const ref = createTaskRef('every', id, handler, clearRef);

      const deferPromise = new Promise(resolve => {
        resolveNext = resolve;
      });

      const cancelDefer = getQueue().add(id, () => {
        resolveNext();
      });

      refs.set(id, [
        ref,
        () => {
          cancelDefer();
          clearTimeout(timerID);
          resolveNext();
        },
      ]);

      const next = () => new Promise(resolve => {
        resolveNext = resolve;
        timerID = setTimeout(resolve, interval);
      });

      const executeNext = () => asyncExecute(ref, fn, args);

      sequentialLoop(ref, next, executeNext, deferPromise);

      return ref;
    },
    everySequential<+ID: any, +A: Array<any>, +F: (...args: A) => any>(
      id: ID,
      interval: number,
      fn?: F,
      ...args: A
    ): Task$Ref {
      let timerID;
      let resolveNext;
      const ref = createTaskRef('every', id, handler, clearRef);

      refs.set(id, [
        ref,
        () => {
          clearTimeout(timerID);
          resolveNext();
        },
      ]);

      const next = () => new Promise(resolve => {
        resolveNext = resolve;
        timerID = setTimeout(resolve, interval);
      });

      const executeNext = () => asyncExecute(ref, fn, args);

      sequentialLoop(ref, next, executeNext);

      return ref;
    },
    job<+ID: any, +A: Array<any>, F: (...args: A) => Task$Job>(
      id: ID,
      getJob: F,
      ...args: A
    ): Task$Ref {
      const ref = createTaskRef('job', id, handler, clearRef, [
        getJob,
        args || STATIC_EMPTY_ARRAY,
        refs,
      ]);
      return ref;
    },
    cancel(...ids: Array<any>) {
      const promises = [];
      ids.forEach(id => cancelID(id, promises));
      return {
        promise() {
          return Promise.all(promises);
        },
      };
    },
    clear() {
      return handler.cancel(...Array.from(refs.keys()));
    },
  });

  return handler;
}