All files / lib/job JobQueue.ts

77.77% Statements 7/9
25% Branches 2/8
60% Functions 3/5
75% Lines 6/8

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 1311x 1x                                                                                                                             2x   1x                                 1x   1x                                                                                          
import EventEmitter from "events";
import "durr";
 
export interface ClientEvents<Response = undefined> extends IClientEvents {
  readonly init: () => void;
  readonly success: (response?: Response) => void;
  readonly fail: (reason: string) => void;
  readonly close: () => void;
}
 
export interface WorkerEvents extends IWorkerEvents {
  readonly init: () => void;
  readonly cancel: () => void;
  readonly close: () => void;
}
 
export type IWorkerEvents = {
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
  [key: string | symbol]: ((...args: any[]) => void) | (() => void);
};
export type IClientEvents = {
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
  [key: string | symbol]: ((...args: any[]) => void) | (() => void);
};
export type BasePayload = unknown;
export interface Job<Payload extends BasePayload = unknown> {
  readonly payload: Payload;
}
 
export function isJob<Payload extends BasePayload = unknown>(
  it: unknown,
  payloadTypeGuard: (p: unknown) => p is Payload = function (
    _: unknown
  ): _ is Payload {
    return true;
  }
): it is Job {
  return (
    !!it &&
    typeof it === "object" &&
    "payload" in it &&
    !!it.payload &&
    payloadTypeGuard(it.payload)
  );
}
 
export interface ClientEventEmitter<
  Response,
  Client extends ClientEvents<Response> = ClientEvents<Response>
> extends EventEmitter {
  on<U extends keyof Client>(event: U, listener: Client[U]): this;
 
  emit<U extends keyof Client>(
    event: U,
    ...args: Parameters<Client[U]>
  ): boolean;
}
 
export class ClientEventEmitter<
  Response,
  // eslint-disable-next-line @typescript-eslint/no-unused-vars
  Client extends ClientEvents<Response> = ClientEvents<Response>
> extends EventEmitter {
  constructor() {
    super();
  }
}
 
export interface WorkerEventEmitter<Worker extends WorkerEvents = WorkerEvents>
  extends EventEmitter {
  on<U extends keyof Worker>(event: U, listener: Worker[U]): this;
 
  emit<U extends keyof Worker>(
    event: U,
    ...args: Parameters<Worker[U]>
  ): boolean;
}
 
export class WorkerEventEmitter<
  // eslint-disable-next-line @typescript-eslint/no-unused-vars
  Worker extends WorkerEvents = WorkerEvents
> extends EventEmitter {
  constructor() {
    super();
  }
}
 
export type JobId = string;
 
export type JobHandler<
  Payload extends BasePayload = unknown,
  Response = undefined,
  Client extends ClientEvents<Response> = ClientEvents<Response>,
  Worker extends WorkerEvents = WorkerEvents
> = (
  job: Job<Payload>,
  context: ClientEventEmitter<Response, Client>,
  workerEvents: WorkerEventEmitter<Worker>
) => void;
 
export interface JobQueue<
  Payload extends BasePayload = unknown,
  Response = undefined,
  Client extends ClientEvents<Response> = ClientEvents<Response>,
  Worker extends WorkerEvents = WorkerEvents
> {
  submit(
    job: Job<Payload>,
    preHook?: (
      emitter: ClientEventEmitter<Response, Client>,
      id: JobId
    ) => Promise<void>
  ): Promise<JobId>;
  register(
    handler: JobHandler<Payload, Response, Client, Worker>
  ): Promise<JobWorker>;
  monitor(jobId: JobId): Promise<ClientEventEmitter<Response, Client>>;
  cancel(jobId: JobId): void;
  notify(
    jobId: JobId,
    eventName: keyof Worker,
    ...params: Parameters<Worker[typeof eventName]>
  ): Promise<void>;
  close(): Promise<void>;
}
 
export interface JobWorker {
  readonly isCanceled: () => boolean;
  readonly cancel: () => void;
}