@alanszp/queue 12.0.2 → 13.0.0

package/src/jobsManagement/commands/getCommands.ts

@@ -1,57 +0,0 @@
-import { ILogger } from "@alanszp/logger";
-import { GetJobInput } from "../inputs/GetJobInput";
-import { SearchJobsInput } from "../inputs/SearchJobsInput";
-import { ListResult } from "@alanszp/core";
-import { Queue } from "../../queue/queue";
-import { Job } from "../../types";
-
-export async function getJobStatus<QueueInputBody, ReturnValue>(
-  logger: ILogger,
-  queue: Queue<QueueInputBody, ReturnValue>,
-  input: GetJobInput
-): Promise<Job<QueueInputBody, ReturnValue> | undefined> {
-  const child = logger.child({
-    input,
-    queueName: queue.getName(),
-  });
-
-  child.info("worker.get_job.starting");
-  await input.validate();
-
-  child.debug("worker.get_job.validated");
-
-  const job = await queue.getJobOrFail(input.jobId);
-
-  child.info("worker.get_job.succeed", { jobId: job?.id ?? null });
-
-  return job;
-}
-
-export async function searchJobsCommand<QueueInputBody, ReturnValue>(
-  logger: ILogger,
-  queue: Queue<QueueInputBody, ReturnValue>,
-  input: SearchJobsInput
-): Promise<ListResult<Job<QueueInputBody, ReturnValue>>> {
-  const child = logger.child({
-    input,
-    queueName: queue.getName(),
-  });
-
-  child.info("worker.get_job.starting");
-  await input.validate();
-
-  child.debug("worker.get_job.validated");
-
-  const jobs = await queue.getJobsAndCountByStatus(
-    input.status,
-    input.page,
-    input.pageSize
-  );
-
-  child.info("worker.get_job.succeed", {
-    jobTotal: jobs.total,
-    jobInPage: jobs.elements.length,
-  });
-
-  return jobs;
-}

package/src/jobsManagement/commands/workerHealthCommand.ts

@@ -1,10 +0,0 @@
-import {
-  WorkerStatusWithId,
-  WorkerRepository,
-} from "../../worker/workerRepository";
-
-export function workerHealthCommand(): WorkerStatusWithId[] {
-  const statuses = WorkerRepository.Instance.getWorkerStatuses();
-
-  return statuses;
-}

package/src/jobsManagement/index.ts

@@ -1,6 +0,0 @@
-export * from "./inputs/CreateAsyncJobInput";
-export * from "./inputs/GetJobInput";
-export * from "./inputs/SearchJobsInput";
-export * from "./commands/asyncCreationCommands";
-export * from "./commands/getCommands";
-export * from "./commands/workerHealthCommand";

package/src/jobsManagement/inputs/CreateAsyncJobInput.ts

@@ -1,36 +0,0 @@
-import { IsDateString, IsDefined, IsOptional } from "class-validator";
-import { BaseModel } from "@alanszp/validations";
-
-export interface CreateAsyncJobQueryParams {
-  executeOn?: string;
-}
-
-export class CreateAsyncJobInput<
-  RealInput extends BaseModel
-> extends BaseModel {
-  @IsDateString()
-  @IsOptional()
-  public executeOn?: string;
-
-  @IsDefined()
-  public asyncInput: RealInput;
-
-  constructor(asyncParams: CreateAsyncJobQueryParams, asyncInput: RealInput) {
-    super();
-    this.executeOn = asyncParams.executeOn;
-    this.asyncInput = asyncInput;
-  }
-
-  async validate(): Promise<void> {
-    await super.validate();
-
-    await this.asyncInput.validate();
-  }
-
-  getDelayInMs(): number | undefined {
-    if (!this.executeOn) return undefined;
-    const date = new Date(this.executeOn);
-    const delay = date.getTime() - new Date().getTime();
-    return delay > 0 ? delay : undefined;
-  }
-}

package/src/jobsManagement/inputs/GetJobInput.ts

@@ -1,17 +0,0 @@
-import { IsDefined, IsString } from "class-validator";
-import { BaseModel } from "@alanszp/validations";
-
-export class GetJobInput extends BaseModel {
-  @IsDefined()
-  @IsString()
-  public jobId: string;
-
-  constructor(jobId: string) {
-    super();
-    this.jobId = jobId;
-  }
-
-  async validate(): Promise<void> {
-    await super.validate();
-  }
-}

package/src/jobsManagement/inputs/SearchJobsInput.ts

@@ -1,45 +0,0 @@
-import {
-  IsDefined,
-  IsArray,
-  IsEnum,
-  IsNumber,
-  Min,
-  Max,
-} from "class-validator";
-import { BaseModel } from "@alanszp/validations";
-import { JobTypeEnum } from "../../types";
-import { assignPaginableKeys } from "@alanszp/core";
-
-export interface SearchJobInputProps {
-  status: JobTypeEnum[];
-  page?: string | number;
-  pageSize?: number;
-}
-
-export class SearchJobsInput extends BaseModel {
-  @IsDefined()
-  @IsArray()
-  @IsEnum(JobTypeEnum, { each: true })
-  public status: JobTypeEnum[];
-
-  @IsDefined()
-  @IsNumber()
-  @Min(1)
-  public page: number;
-
-  @IsDefined()
-  @IsNumber()
-  @Min(1)
-  @Max(100)
-  public pageSize: number;
-
-  constructor({ status, page, pageSize }: SearchJobInputProps) {
-    super();
-    this.status = status;
-    assignPaginableKeys(this, { page, pageSize });
-  }
-
-  async validate(): Promise<void> {
-    await super.validate();
-  }
-}

package/src/queue/createQueue.ts

@@ -1,22 +0,0 @@
-import { Queue } from "./queue";
-import { QueueRepository } from "./queueRepository";
-import { ConnectionManager } from "../connectionManager";
-import { JobData, QueueOptions } from "../types";
-import { SharedContext } from "@alanszp/shared-context";
-
-export function createQueue<Data = JobData>(
-  name: string,
-  getContext: () => SharedContext,
-  queueOptions?: QueueOptions
-): Queue<Data> {
-  const connection = ConnectionManager.getInstance().getConnection();
-  const queue = new Queue<Data>(
-    connection,
-    name,
-    ConnectionManager.getInstance().getServiceName(),
-    getContext,
-    queueOptions
-  );
-  QueueRepository.Instance.registerQueue(queue);
-  return queue;
-}

package/src/queue/queue.ts

@@ -1,195 +0,0 @@
-import { merge, repeat } from "lodash";
-import { Job, JobsOptions, RepeatOptions } from "bullmq";
-import { ListResult } from "@alanszp/core";
-import { SharedContext } from "@alanszp/shared-context";
-import {
-  ConnectionOptions,
-  JobData,
-  JobReturnValue,
-  JobStateEnum,
-  JobTypeEnum,
-  QueueOptions,
-  RawQueue,
-} from "../types";
-import { JobNotFoundError } from "../errors/JobNotFoundError";
-import { JobCannotBePromotedError } from "../errors/JobCannotBePromotedError";
-import { ResultTypes } from "ioredis/built/utils/RedisCommander";
-
-const BULL_PREFIX = "b";
-
-const DEFAULT_COMPLETED_JOB_MAX_AGE_IN_SECONDS = 60 * 60 * 24 * 30;
-const DEFAULT_COMPLETED_JOB_MAX_COUNT = 500;
-const DEFAULT_FAILED_JOB_MAX_COUNT = 1000;
-
-export class Queue<Data = JobData, ReturnValue = JobReturnValue> {
-  private _queue: RawQueue;
-
-  private name: string;
-
-  private getSharedContext: () => SharedContext;
-
-  constructor(
-    connection: ConnectionOptions,
-    name: string,
-    prefix: string,
-    getSharedContext: () => SharedContext,
-    queueOptions?: QueueOptions
-  ) {
-    this.name = name;
-
-    this.getSharedContext = getSharedContext;
-
-    this._queue = new RawQueue<Data>(name, {
-      ...merge(
-        {
-          defaultJobOptions: {
-            removeOnComplete: {
-              age: DEFAULT_COMPLETED_JOB_MAX_AGE_IN_SECONDS,
-              count: DEFAULT_COMPLETED_JOB_MAX_COUNT,
-            },
-            removeOnFail: {
-              count: DEFAULT_FAILED_JOB_MAX_COUNT,
-            },
-            attempts: 3,
-            backoff: {
-              type: "exponential",
-              delay: 3000,
-            },
-          },
-          connection,
-        },
-        queueOptions || {}
-      ),
-      ...{ prefix: `{${prefix}}:${BULL_PREFIX}` },
-    });
-  }
-
-  public getName(): string {
-    return this.name;
-  }
-
-  async publishJob(
-    job: Data,
-    opts?: JobsOptions
-  ): Promise<Job<Data, ReturnValue>> {
-    const context = this.getSharedContext();
-    const lid = context.getLifecycleId();
-    const lch = context.getLifecycleChain();
-    return this.queue.add(this.name, { ...job, lid, lch }, opts);
-  }
-
-  async publishRepeatableJob(
-    job: Data,
-    repeatOptions: RepeatOptions,
-    jobId: string
-  ): Promise<Job<Data, ReturnValue>> {
-    return this.queue.add(this.name, job, { ...repeatOptions, jobId });
-  }
-
-  async removeRepeatableJobByKey(repeatJobKey: string): Promise<boolean> {
-    return this.queue.removeRepeatableByKey(repeatJobKey);
-  }
-
-  async removeRepeatableJobByConfig(
-    repeatOptions: RepeatOptions,
-    jobId: string
-  ): Promise<boolean> {
-    return this.queue.removeRepeatable(this.name, repeatOptions, jobId);
-  }
-
-  async publishBulkJob(jobDatas: Data[]): Promise<Job<Data, ReturnValue>[]> {
-    const jobs = jobDatas.map((data) => ({ name: this.name, data }));
-    return this.queue.addBulk(jobs);
-  }
-
-  async publishBulkJobWithOptions(
-    jobDefinitions: { jobData: Data; opts: JobsOptions }[]
-  ): Promise<Job<Data, ReturnValue>[]> {
-    const jobs = jobDefinitions.map(({ jobData: data, opts }) => ({
-      name: this.name,
-      data,
-      opts,
-    }));
-    return this.queue.addBulk(jobs);
-  }
-
-  private pageToStartEnd(pageNumber: number, pageSize: number) {
-    return {
-      start: (pageNumber - 1) * pageSize,
-      end: pageNumber * pageSize - 1,
-    };
-  }
-
-  public async getJobsAndCountByStatus(
-    statuses: JobTypeEnum[],
-    page: number = 1,
-    pageSize: number = 50,
-    ascending: boolean = false
-  ): Promise<ListResult<Job<Data, ReturnValue>>> {
-    const { start, end } = this.pageToStartEnd(page, pageSize);
-    const [total, elements] = await Promise.all([
-      this.queue.getJobCountByTypes(...statuses),
-      this.queue.getJobs(statuses, start, end, ascending),
-    ]);
-
-    return {
-      total,
-      elements,
-      page,
-      pageSize,
-    };
-  }
-
-  public async getJobCountByStatus(
-    statuses: JobTypeEnum[],
-    page: number = 1,
-    pageSize: number = 50
-  ): Promise<number> {
-    return this.queue.getJobCountByTypes(...statuses);
-  }
-
-  public async getJobsByStatus(
-    statuses: JobTypeEnum[],
-    page: number = 1,
-    pageSize: number = 50,
-    ascending: boolean = false
-  ): Promise<Job<Data, ReturnValue>[]> {
-    const { start, end } = this.pageToStartEnd(page, pageSize);
-    return this.queue.getJobs(statuses, start, end, ascending);
-  }
-
-  public async deleteJob(jobId: string) {
-    this.queue.remove(jobId);
-  }
-
-  public async getJob(
-    jobId: string
-  ): Promise<Job<Data, ReturnValue> | undefined> {
-    return this.queue.getJob(jobId);
-  }
-
-  public async getJobOrFail(jobId: string): Promise<Job<Data, ReturnValue>> {
-    const job = await this.queue.getJob(jobId);
-    if (!job) throw new JobNotFoundError(jobId);
-    return job;
-  }
-
-  public async changeDelayToJob(jobId: string, delayMs: number) {
-    const job = await this.getJobOrFail(jobId);
-
-    const state = await job.getState();
-    if (state !== JobStateEnum.DELAYED) {
-      throw new JobCannotBePromotedError(jobId, state);
-    }
-
-    job.changeDelay(delayMs);
-  }
-
-  async close(): Promise<void> {
-    await this.queue.close();
-  }
-
-  private get queue(): RawQueue<Data, ReturnValue> {
-    return this._queue;
-  }
-}

package/src/queue/queueRepository.ts

@@ -1,27 +0,0 @@
-import { Queue } from "./queue";
-
-export class QueueRepository {
-  private _queues: Queue[];
-
-  private static _instance: QueueRepository;
-
-  private constructor() {
-    this._queues = [];
-  }
-
-  public static get Instance(): QueueRepository {
-    if (this._instance) {
-      return this._instance;
-    }
-    this._instance = new this();
-    return this._instance;
-  }
-
-  public registerQueue(queue: Queue) {
-    this._queues.push(queue);
-  }
-
-  public getCloseConnections(): Promise<void>[] {
-    return this._queues.map((q) => q.close());
-  }
-}

package/src/reporter/totalCount/ITotalCountReporter.ts

@@ -1,5 +0,0 @@
-export interface ITotalCountReporter {
-  setTotal(total: number): void;
-  increment(n?: number): void;
-  reset(value?: number): void;
-}

package/src/reporter/totalCount/JobTotalCountReporter.ts

@@ -1,37 +0,0 @@
-import { Job } from "../../types";
-import { ITotalCountReporter } from "./ITotalCountReporter";
-
-export class JobTotalCountReporter<JobInstance extends Job>
-  implements ITotalCountReporter
-{
-  private total = 1;
-
-  private current = 0;
-
-  private job: JobInstance;
-
-  constructor(job: JobInstance) {
-    this.job = job;
-  }
-
-  setTotal(total: number): void {
-    this.total = total;
-    this.reset();
-  }
-
-  increment(n?: number): void {
-    this.current += n ?? 1;
-    this.report();
-  }
-
-  reset(value?: number): void {
-    this.current = value ?? 0;
-    this.report();
-  }
-
-  report() {
-    this.job
-      .updateProgress({ total: this.total, current: this.current })
-      .catch(() => {});
-  }
-}

package/src/reporter/totalCount/MockTotalCountReporter.ts

@@ -1,20 +0,0 @@
-import { ITotalCountReporter } from "./ITotalCountReporter";
-
-export class MockTotalCountReporter implements ITotalCountReporter {
-  private total = 1;
-
-  private progress = 0;
-
-  setTotal(total: number): void {
-    this.total = total;
-    this.reset();
-  }
-
-  increment(n?: number): void {
-    this.progress += n ?? 1;
-  }
-
-  reset(value?: number): void {
-    this.progress = value ?? 0;
-  }
-}

package/src/runner.ts

@@ -1,16 +0,0 @@
-
-import { ConnectionManager } from "./connectionManager";
-import { Worker } from "./worker/worker";
-import { WorkerRepository } from "./worker/workerRepository";
-
-export async function runWorkers(queueNames: string): Promise<void> {
-  if (queueNames.length === 0) {
-    ConnectionManager.getInstance().getLogger().warn("worker.env.workers_queues_empty");
-    return Promise.resolve();
-  }
-
-  const queues: string[] = queueNames.replace(/\s/g, "").split(",");
-  const workers = WorkerRepository.Instance.getWorkersByQueues(queues);
-
-  await Promise.all(workers.map((worker: Worker) => worker.run()));
-}

package/src/shutdownQueue.ts

@@ -1,12 +0,0 @@
-import { QueueRepository } from "./queue/queueRepository";
-import { ConnectionManager } from "./connectionManager";
-import { WorkerRepository } from "./worker/workerRepository";
-
-export async function shutdownQueue(): Promise<void> {
-  await Promise.all([
-    ...WorkerRepository.Instance.getCloseConnections(),
-    ...QueueRepository.Instance.getCloseConnections(),
-  ]);
-
-  ConnectionManager.getInstance().close();
-}

package/src/types.ts

@@ -1,38 +0,0 @@
-// decoupling from bullmq
-export {
-  ConnectionOptions,
-  RedisOptions,
-  Job,
-  Worker as RawWorker,
-  WorkerOptions,
-  Queue as RawQueue,
-  QueueOptions,
-  JobState,
-  JobType,
-  JobsOptions,
-} from "bullmq";
-
-export type JobData = unknown;
-
-export type JobReturnValue = unknown;
-
-export enum JobStateEnum {
-  ACTIVE = "active",
-  DELAYED = "delayed",
-  WAITING = "waiting",
-  COMPLETED = "completed",
-  FAILED = "failed",
-  WAITING_CHILDREN = "waiting-children",
-}
-
-export enum JobTypeEnum {
-  ACTIVE = "active",
-  DELAYED = "delayed",
-  WAITING = "waiting",
-  COMPLETED = "completed",
-  FAILED = "failed",
-  WAITING_CHILDREN = "waiting-children",
-  PAUSED = "paused",
-  REPEAT = "repeat",
-  WAIT = "wait",
-}