@deenruv/core 1.0.0

package/dist/job-queue/job-queue.service.d.ts

@@ -0,0 +1,122 @@
+import { OnModuleDestroy } from "@nestjs/common";
+import { ConfigService } from "../config";
+import { Job } from "./job";
+import { JobBuffer } from "./job-buffer/job-buffer";
+import { JobBufferService } from "./job-buffer/job-buffer.service";
+import { JobQueue } from "./job-queue";
+import { CreateQueueOptions, JobData } from "./types";
+/**
+ * @description
+ * The JobQueueService is used to create new {@link JobQueue} instances and access
+ * existing jobs.
+ *
+ * @example
+ * ```ts
+ * // A service which transcodes video files
+ * class VideoTranscoderService {
+ *
+ *   private jobQueue: JobQueue<{ videoId: string; }>;
+ *
+ *   async onModuleInit() {
+ *     // The JobQueue is created on initialization
+ *     this.jobQueue = await this.jobQueueService.createQueue({
+ *       name: 'transcode-video',
+ *       process: async job => {
+ *         return await this.transcodeVideo(job.data.videoId);
+ *       },
+ *     });
+ *   }
+ *
+ *   addToTranscodeQueue(videoId: string) {
+ *     this.jobQueue.add({ videoId, })
+ *   }
+ *
+ *   private async transcodeVideo(videoId: string) {
+ *     // e.g. call some external transcoding service
+ *   }
+ *
+ * }
+ * ```
+ *
+ * @docsCategory JobQueue
+ */
+export declare class JobQueueService implements OnModuleDestroy {
+    private configService;
+    private jobBufferService;
+    private queues;
+    private hasStarted;
+    private get jobQueueStrategy();
+    constructor(configService: ConfigService, jobBufferService: JobBufferService);
+    /** @internal */
+    onModuleDestroy(): Promise<void[]>;
+    /**
+     * @description
+     * Configures and creates a new {@link JobQueue} instance.
+     */
+    createQueue<Data extends JobData<Data>>(options: CreateQueueOptions<Data>): Promise<JobQueue<Data>>;
+    start(): Promise<void>;
+    /**
+     * @description
+     * Adds a {@link JobBuffer}, which will make it active and begin collecting
+     * jobs to buffer.
+     *
+     * @since 1.3.0
+     */
+    addBuffer(buffer: JobBuffer<any>): void;
+    /**
+     * @description
+     * Removes a {@link JobBuffer}, prevent it from collecting and buffering any
+     * subsequent jobs.
+     *
+     * @since 1.3.0
+     */
+    removeBuffer(buffer: JobBuffer<any>): void;
+    /**
+     * @description
+     * Returns an object containing the number of buffered jobs arranged by bufferId. This
+     * can be used to decide whether a particular buffer has any jobs to flush.
+     *
+     * Passing in JobBuffer instances _or_ ids limits the results to the specified JobBuffers.
+     * If no argument is passed, sizes will be returned for _all_ JobBuffers.
+     *
+     * @example
+     * ```ts
+     * const sizes = await this.jobQueueService.bufferSize('buffer-1', 'buffer-2');
+     *
+     * // sizes = { 'buffer-1': 12, 'buffer-2': 3 }
+     * ```
+     *
+     * @since 1.3.0
+     */
+    bufferSize(...forBuffers: Array<JobBuffer<any> | string>): Promise<{
+        [bufferId: string]: number;
+    }>;
+    /**
+     * @description
+     * Flushes the specified buffers, which means that the buffer is cleared and the jobs get
+     * sent to the job queue for processing. Before sending the jobs to the job queue,
+     * they will be passed through each JobBuffer's `reduce()` method, which is can be used
+     * to optimize the amount of work to be done by e.g. de-duplicating identical jobs or
+     * aggregating data over the collected jobs.
+     *
+     * Passing in JobBuffer instances _or_ ids limits the action to the specified JobBuffers.
+     * If no argument is passed, _all_ JobBuffers will be flushed.
+     *
+     * Returns an array of all Jobs which were added to the job queue.
+     *
+     * @since 1.3.0
+     */
+    flush(...forBuffers: Array<JobBuffer<any> | string>): Promise<Job[]>;
+    /**
+     * @description
+     * Returns an array of `{ name: string; running: boolean; }` for each
+     * registered JobQueue.
+     */
+    getJobQueues(): JobQueue[];
+    /**
+     * We wrap the process function in order to catch any errors thrown and pass them to
+     * any configured ErrorHandlerStrategies.
+     */
+    private createWrappedProcessFn;
+    private shouldStartQueue;
+}

package/dist/job-queue/job-queue.service.js

@@ -0,0 +1,195 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JobQueueService = void 0;
+const common_1 = require("@nestjs/common");
+const config_1 = require("../config");
+const constants_1 = require("./constants");
+const job_buffer_service_1 = require("./job-buffer/job-buffer.service");
+const job_queue_1 = require("./job-queue");
+/**
+ * @description
+ * The JobQueueService is used to create new {@link JobQueue} instances and access
+ * existing jobs.
+ *
+ * @example
+ * ```ts
+ * // A service which transcodes video files
+ * class VideoTranscoderService {
+ *
+ *   private jobQueue: JobQueue<{ videoId: string; }>;
+ *
+ *   async onModuleInit() {
+ *     // The JobQueue is created on initialization
+ *     this.jobQueue = await this.jobQueueService.createQueue({
+ *       name: 'transcode-video',
+ *       process: async job => {
+ *         return await this.transcodeVideo(job.data.videoId);
+ *       },
+ *     });
+ *   }
+ *
+ *   addToTranscodeQueue(videoId: string) {
+ *     this.jobQueue.add({ videoId, })
+ *   }
+ *
+ *   private async transcodeVideo(videoId: string) {
+ *     // e.g. call some external transcoding service
+ *   }
+ *
+ * }
+ * ```
+ *
+ * @docsCategory JobQueue
+ */
+let JobQueueService = class JobQueueService {
+    get jobQueueStrategy() {
+        return this.configService.jobQueueOptions.jobQueueStrategy;
+    }
+    constructor(configService, jobBufferService) {
+        this.configService = configService;
+        this.jobBufferService = jobBufferService;
+        this.queues = [];
+        this.hasStarted = false;
+    }
+    /** @internal */
+    onModuleDestroy() {
+        this.hasStarted = false;
+        return Promise.all(this.queues.map((q) => q.stop()));
+    }
+    /**
+     * @description
+     * Configures and creates a new {@link JobQueue} instance.
+     */
+    async createQueue(options) {
+        if (this.configService.jobQueueOptions.prefix) {
+            options = Object.assign(Object.assign({}, options), { name: `${this.configService.jobQueueOptions.prefix}${options.name}` });
+        }
+        const wrappedProcessFn = this.createWrappedProcessFn(options.process);
+        options = Object.assign(Object.assign({}, options), { process: wrappedProcessFn });
+        const queue = new job_queue_1.JobQueue(options, this.jobQueueStrategy, this.jobBufferService);
+        if (this.hasStarted && this.shouldStartQueue(queue.name)) {
+            await queue.start();
+        }
+        this.queues.push(queue);
+        return queue;
+    }
+    async start() {
+        this.hasStarted = true;
+        for (const queue of this.queues) {
+            if (!queue.started && this.shouldStartQueue(queue.name)) {
+                config_1.Logger.info(`Starting queue: ${queue.name}`, constants_1.loggerCtx);
+                await queue.start();
+            }
+        }
+    }
+    /**
+     * @description
+     * Adds a {@link JobBuffer}, which will make it active and begin collecting
+     * jobs to buffer.
+     *
+     * @since 1.3.0
+     */
+    addBuffer(buffer) {
+        this.jobBufferService.addBuffer(buffer);
+    }
+    /**
+     * @description
+     * Removes a {@link JobBuffer}, prevent it from collecting and buffering any
+     * subsequent jobs.
+     *
+     * @since 1.3.0
+     */
+    removeBuffer(buffer) {
+        this.jobBufferService.removeBuffer(buffer);
+    }
+    /**
+     * @description
+     * Returns an object containing the number of buffered jobs arranged by bufferId. This
+     * can be used to decide whether a particular buffer has any jobs to flush.
+     *
+     * Passing in JobBuffer instances _or_ ids limits the results to the specified JobBuffers.
+     * If no argument is passed, sizes will be returned for _all_ JobBuffers.
+     *
+     * @example
+     * ```ts
+     * const sizes = await this.jobQueueService.bufferSize('buffer-1', 'buffer-2');
+     *
+     * // sizes = { 'buffer-1': 12, 'buffer-2': 3 }
+     * ```
+     *
+     * @since 1.3.0
+     */
+    bufferSize(...forBuffers) {
+        return this.jobBufferService.bufferSize(forBuffers);
+    }
+    /**
+     * @description
+     * Flushes the specified buffers, which means that the buffer is cleared and the jobs get
+     * sent to the job queue for processing. Before sending the jobs to the job queue,
+     * they will be passed through each JobBuffer's `reduce()` method, which is can be used
+     * to optimize the amount of work to be done by e.g. de-duplicating identical jobs or
+     * aggregating data over the collected jobs.
+     *
+     * Passing in JobBuffer instances _or_ ids limits the action to the specified JobBuffers.
+     * If no argument is passed, _all_ JobBuffers will be flushed.
+     *
+     * Returns an array of all Jobs which were added to the job queue.
+     *
+     * @since 1.3.0
+     */
+    flush(...forBuffers) {
+        return this.jobBufferService.flush(forBuffers);
+    }
+    /**
+     * @description
+     * Returns an array of `{ name: string; running: boolean; }` for each
+     * registered JobQueue.
+     */
+    getJobQueues() {
+        return this.queues;
+    }
+    /**
+     * We wrap the process function in order to catch any errors thrown and pass them to
+     * any configured ErrorHandlerStrategies.
+     */
+    createWrappedProcessFn(processFn) {
+        const { errorHandlers } = this.configService.systemOptions;
+        return async (job) => {
+            try {
+                return await processFn(job);
+            }
+            catch (e) {
+                for (const handler of errorHandlers) {
+                    if (e instanceof Error) {
+                        void handler.handleWorkerError(e, { job });
+                    }
+                }
+                throw e;
+            }
+        };
+    }
+    shouldStartQueue(queueName) {
+        if (this.configService.jobQueueOptions.activeQueues.length > 0) {
+            if (!this.configService.jobQueueOptions.activeQueues.includes(queueName)) {
+                return false;
+            }
+        }
+        return true;
+    }
+};
+exports.JobQueueService = JobQueueService;
+exports.JobQueueService = JobQueueService = __decorate([
+    (0, common_1.Injectable)(),
+    __metadata("design:paramtypes", [config_1.ConfigService,
+        job_buffer_service_1.JobBufferService])
+], JobQueueService);
+//# sourceMappingURL=job-queue.service.js.map

package/dist/job-queue/job-queue.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"job-queue.service.js","sourceRoot":"","sources":["../../src/job-queue/job-queue.service.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAA6D;AAG7D,sCAAoE;AAEpE,2CAAwC;AAGxC,wEAAmE;AACnE,2CAAuC;AAGvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AAEI,IAAM,eAAe,GAArB,MAAM,eAAe;IAI1B,IAAY,gBAAgB;QAC1B,OAAO,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,gBAAgB,CAAC;IAC7D,CAAC;IAED,YACU,aAA4B,EAC5B,gBAAkC;QADlC,kBAAa,GAAb,aAAa,CAAe;QAC5B,qBAAgB,GAAhB,gBAAgB,CAAkB;QATpC,WAAM,GAAyB,EAAE,CAAC;QAClC,eAAU,GAAG,KAAK,CAAC;IASxB,CAAC;IAEJ,gBAAgB;IAChB,eAAe;QACb,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;QACxB,OAAO,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IACvD,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,WAAW,CACf,OAAiC;QAEjC,IAAI,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC;YAC9C,OAAO,mCACF,OAAO,KACV,IAAI,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,MAAM,GAAG,OAAO,CAAC,IAAI,EAAE,GACpE,CAAC;QACJ,CAAC;QACD,MAAM,gBAAgB,GAAG,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACtE,OAAO,mCAAQ,OAAO,KAAE,OAAO,EAAE,gBAAgB,GAAE,CAAC;QACpD,MAAM,KAAK,GAAG,IAAI,oBAAQ,CACxB,OAAO,EACP,IAAI,CAAC,gBAAgB,EACrB,IAAI,CAAC,gBAAgB,CACtB,CAAC;QACF,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;YACzD,MAAM,KAAK,CAAC,KAAK,EAAE,CAAC;QACtB,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,KAAK,CAAC,KAAK;QACT,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QACvB,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChC,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;gBACxD,eAAM,CAAC,IAAI,CAAC,mBAAmB,KAAK,CAAC,IAAI,EAAE,EAAE,qBAAS,CAAC,CAAC;gBACxD,MAAM,KAAK,CAAC,KAAK,EAAE,CAAC;YACtB,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,SAAS,CAAC,MAAsB;QAC9B,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;;OAMG;IACH,YAAY,CAAC,MAAsB;QACjC,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,UAAU,CACR,GAAG,UAA0C;QAE7C,OAAO,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,GAAG,UAA0C;QACjD,OAAO,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IACjD,CAAC;IAED;;;;OAIG;IACH,YAAY;QACV,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;;OAGG;IACK,sBAAsB,CAC5B,SAA2C;QAE3C,MAAM,EAAE,aAAa,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC;QAC3D,OAAO,KAAK,EAAE,GAAc,EAAE,EAAE;YAC9B,IAAI,CAAC;gBACH,OAAO,MAAM,SAAS,CAAC,GAAG,CAAC,CAAC;YAC9B,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,KAAK,MAAM,OAAO,IAAI,aAAa,EAAE,CAAC;oBACpC,IAAI,CAAC,YAAY,KAAK,EAAE,CAAC;wBACvB,KAAK,OAAO,CAAC,iBAAiB,CAAC,CAAC,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;oBAC7C,CAAC;gBACH,CAAC;gBACD,MAAM,CAAC,CAAC;YACV,CAAC;QACH,CAAC,CAAC;IACJ,CAAC;IAEO,gBAAgB,CAAC,SAAiB;QACxC,IAAI,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC/D,IACE,CAAC,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,CAAC,EACpE,CAAC;gBACD,OAAO,KAAK,CAAC;YACf,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;CACF,CAAA;AAlKY,0CAAe;0BAAf,eAAe;IAD3B,IAAA,mBAAU,GAAE;qCAUc,sBAAa;QACV,qCAAgB;GAVjC,eAAe,CAkK3B"}

package/dist/job-queue/job.d.ts

@@ -0,0 +1,99 @@
+import { JobState } from "@deenruv/common/lib/generated-types";
+import { JobConfig, JobData } from "./types";
+/**
+ * @description
+ * An event raised by a Job.
+ *
+ * @docsCategory JobQueue
+ * @docsPage Job
+ */
+export type JobEventType = "progress";
+/**
+ * @description
+ * The signature of the event handler expected by the `Job.on()` method.
+ *
+ * @docsCategory JobQueue
+ * @docsPage Job
+ */
+export type JobEventListener<T extends JobData<T>> = (job: Job<T>) => void;
+/**
+ * @description
+ * A Job represents a piece of work to be run in the background, i.e. outside the request-response cycle.
+ * It is intended to be used for long-running work triggered by API requests. Jobs should now generally
+ * be directly instantiated. Rather, the {@link JobQueue} `add()` method should be used to create and
+ * add a new Job to a queue.
+ *
+ * @docsCategory JobQueue
+ * @docsPage Job
+ * @docsWeight 0
+ */
+export declare class Job<T extends JobData<T> = any> {
+    readonly id: number | string | null;
+    readonly queueName: string;
+    readonly retries: number;
+    readonly createdAt: Date;
+    private readonly _data;
+    private _state;
+    private _progress;
+    private _result?;
+    private _error?;
+    private _attempts;
+    private _startedAt?;
+    private _settledAt?;
+    private readonly eventListeners;
+    get name(): string;
+    get data(): T;
+    get state(): JobState;
+    get progress(): number;
+    get result(): any;
+    get error(): any;
+    get isSettled(): boolean;
+    get startedAt(): Date | undefined;
+    get settledAt(): Date | undefined;
+    get duration(): number;
+    get attempts(): number;
+    constructor(config: JobConfig<T>);
+    /**
+     * @description
+     * Calling this signifies that the job work has started. This method should be
+     * called in the {@link JobQueueStrategy} `next()` method.
+     */
+    start(): void;
+    /**
+     * @description
+     * Sets the progress (0 - 100) of the job.
+     */
+    setProgress(percent: number): void;
+    /**
+     * @description
+     * Calling this method signifies that the job succeeded. The result
+     * will be stored in the `Job.result` property.
+     */
+    complete(result?: any): void;
+    /**
+     * @description
+     * Calling this method signifies that the job failed.
+     */
+    fail(err?: any): void;
+    cancel(): void;
+    /**
+     * @description
+     * Sets a RUNNING job back to PENDING. Should be used when the JobQueue is being
+     * destroyed before the job has been completed.
+     */
+    defer(): void;
+    /**
+     * @description
+     * Used to register event handler for job events
+     */
+    on(eventType: JobEventType, listener: JobEventListener<T>): void;
+    off(eventType: JobEventType, listener: JobEventListener<T>): void;
+    private fireEvent;
+    /**
+     * All data in a job must be serializable. This method handles certain problem cases such as when
+     * the data is a class instance with getters. Even though technically the "data" object should
+     * already be serializable per the TS type, in practice data can slip through due to loss of
+     * type safety.
+     */
+    private ensureDataIsSerializable;
+}

package/dist/job-queue/job.js

@@ -0,0 +1,213 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Job = void 0;
+const generated_types_1 = require("@deenruv/common/lib/generated-types");
+const shared_utils_1 = require("@deenruv/common/lib/shared-utils");
+const deenruv_logger_1 = require("../config/logger/deenruv-logger");
+/**
+ * @description
+ * A Job represents a piece of work to be run in the background, i.e. outside the request-response cycle.
+ * It is intended to be used for long-running work triggered by API requests. Jobs should now generally
+ * be directly instantiated. Rather, the {@link JobQueue} `add()` method should be used to create and
+ * add a new Job to a queue.
+ *
+ * @docsCategory JobQueue
+ * @docsPage Job
+ * @docsWeight 0
+ */
+class Job {
+    get name() {
+        return this.queueName;
+    }
+    get data() {
+        return this._data;
+    }
+    get state() {
+        return this._state;
+    }
+    get progress() {
+        return this._progress;
+    }
+    get result() {
+        return this._result;
+    }
+    get error() {
+        return this._error;
+    }
+    get isSettled() {
+        return (!!this._settledAt &&
+            (this._state === generated_types_1.JobState.COMPLETED ||
+                this._state === generated_types_1.JobState.FAILED ||
+                this._state === generated_types_1.JobState.CANCELLED));
+    }
+    get startedAt() {
+        return this._startedAt;
+    }
+    get settledAt() {
+        return this._settledAt;
+    }
+    get duration() {
+        if (this.state === generated_types_1.JobState.PENDING || this.state === generated_types_1.JobState.RETRYING) {
+            return 0;
+        }
+        const end = this._settledAt || new Date();
+        return +end - +(this._startedAt || end);
+    }
+    get attempts() {
+        return this._attempts;
+    }
+    constructor(config) {
+        this.eventListeners = {
+            progress: [],
+        };
+        this.queueName = config.queueName;
+        this._data = this.ensureDataIsSerializable(config.data);
+        this.id = config.id || null;
+        this._state = config.state || generated_types_1.JobState.PENDING;
+        this.retries = config.retries || 0;
+        this._attempts = config.attempts || 0;
+        this._progress = config.progress || 0;
+        this.createdAt = config.createdAt || new Date();
+        this._result = config.result;
+        this._error = config.error;
+        this._startedAt = config.startedAt;
+        this._settledAt = config.settledAt;
+    }
+    /**
+     * @description
+     * Calling this signifies that the job work has started. This method should be
+     * called in the {@link JobQueueStrategy} `next()` method.
+     */
+    start() {
+        var _a, _b;
+        if (this._state === generated_types_1.JobState.PENDING || this._state === generated_types_1.JobState.RETRYING) {
+            this._state = generated_types_1.JobState.RUNNING;
+            this._startedAt = new Date();
+            this._attempts++;
+            deenruv_logger_1.Logger.debug(`Job ${(_b = (_a = this.id) === null || _a === void 0 ? void 0 : _a.toString()) !== null && _b !== void 0 ? _b : "null"} [${this.queueName}] starting (attempt ${this._attempts} of ${this.retries + 1})`);
+        }
+    }
+    /**
+     * @description
+     * Sets the progress (0 - 100) of the job.
+     */
+    setProgress(percent) {
+        this._progress = Math.min(percent || 0, 100);
+        this.fireEvent("progress");
+    }
+    /**
+     * @description
+     * Calling this method signifies that the job succeeded. The result
+     * will be stored in the `Job.result` property.
+     */
+    complete(result) {
+        var _a, _b;
+        this._result = result;
+        this._progress = 100;
+        this._state = generated_types_1.JobState.COMPLETED;
+        this._settledAt = new Date();
+        deenruv_logger_1.Logger.debug(`Job ${(_b = (_a = this.id) === null || _a === void 0 ? void 0 : _a.toString()) !== null && _b !== void 0 ? _b : "null"} [${this.queueName}] completed`);
+    }
+    /**
+     * @description
+     * Calling this method signifies that the job failed.
+     */
+    fail(err) {
+        var _a, _b, _c, _d;
+        this._error = (err === null || err === void 0 ? void 0 : err.message) ? err.message : String(err);
+        this._progress = 0;
+        if (this.retries >= this._attempts) {
+            this._state = generated_types_1.JobState.RETRYING;
+            deenruv_logger_1.Logger.warn(`Job ${(_b = (_a = this.id) === null || _a === void 0 ? void 0 : _a.toString()) !== null && _b !== void 0 ? _b : "null"} [${this.queueName}] failed (attempt ${this._attempts} of ${this.retries + 1})`);
+        }
+        else {
+            if (this._state !== generated_types_1.JobState.CANCELLED) {
+                this._state = generated_types_1.JobState.FAILED;
+                deenruv_logger_1.Logger.warn(`Job ${(_d = (_c = this.id) === null || _c === void 0 ? void 0 : _c.toString()) !== null && _d !== void 0 ? _d : "null"} [${this.queueName}] failed and will not retry.`);
+            }
+            this._settledAt = new Date();
+        }
+    }
+    cancel() {
+        this._settledAt = new Date();
+        this._state = generated_types_1.JobState.CANCELLED;
+    }
+    /**
+     * @description
+     * Sets a RUNNING job back to PENDING. Should be used when the JobQueue is being
+     * destroyed before the job has been completed.
+     */
+    defer() {
+        var _a, _b;
+        if (this._state === generated_types_1.JobState.RUNNING) {
+            this._state = generated_types_1.JobState.PENDING;
+            this._attempts = 0;
+            deenruv_logger_1.Logger.debug(`Job ${(_b = (_a = this.id) === null || _a === void 0 ? void 0 : _a.toString()) !== null && _b !== void 0 ? _b : "null"} [${this.queueName}] deferred back to PENDING state`);
+        }
+    }
+    /**
+     * @description
+     * Used to register event handler for job events
+     */
+    on(eventType, listener) {
+        this.eventListeners[eventType].push(listener);
+    }
+    off(eventType, listener) {
+        const idx = this.eventListeners[eventType].indexOf(listener);
+        if (idx !== -1) {
+            this.eventListeners[eventType].splice(idx, 1);
+        }
+    }
+    fireEvent(eventType) {
+        for (const listener of this.eventListeners[eventType]) {
+            listener(this);
+        }
+    }
+    /**
+     * All data in a job must be serializable. This method handles certain problem cases such as when
+     * the data is a class instance with getters. Even though technically the "data" object should
+     * already be serializable per the TS type, in practice data can slip through due to loss of
+     * type safety.
+     */
+    ensureDataIsSerializable(data, depth = 0) {
+        if (10 < depth) {
+            return "[max depth reached]";
+        }
+        depth++;
+        let output;
+        if (data instanceof Date) {
+            return data.toISOString();
+        }
+        else if ((0, shared_utils_1.isObject)(data)) {
+            if (!output) {
+                output = {};
+            }
+            for (const key of Object.keys(data)) {
+                output[key] = this.ensureDataIsSerializable(data[key], depth);
+            }
+            if ((0, shared_utils_1.isClassInstance)(data)) {
+                const descriptors = Object.getOwnPropertyDescriptors(Object.getPrototypeOf(data));
+                for (const name of Object.keys(descriptors)) {
+                    const descriptor = descriptors[name];
+                    if (typeof descriptor.get === "function") {
+                        output[name] = data[name];
+                    }
+                }
+            }
+        }
+        else if (Array.isArray(data)) {
+            if (!output) {
+                output = [];
+            }
+            data.forEach((item, i) => {
+                output[i] = this.ensureDataIsSerializable(item, depth);
+            });
+        }
+        else {
+            return data;
+        }
+        return output;
+    }
+}
+exports.Job = Job;
+//# sourceMappingURL=job.js.map

package/dist/job-queue/job.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"job.js","sourceRoot":"","sources":["../../src/job-queue/job.ts"],"names":[],"mappings":";;;AAAA,yEAA+D;AAC/D,mEAA6E;AAE7E,oEAAyD;AAsBzD;;;;;;;;;;GAUG;AACH,MAAa,GAAG;IAmBd,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,IAAI,SAAS;QACX,OAAO,CACL,CAAC,CAAC,IAAI,CAAC,UAAU;YACjB,CAAC,IAAI,CAAC,MAAM,KAAK,0BAAQ,CAAC,SAAS;gBACjC,IAAI,CAAC,MAAM,KAAK,0BAAQ,CAAC,MAAM;gBAC/B,IAAI,CAAC,MAAM,KAAK,0BAAQ,CAAC,SAAS,CAAC,CACtC,CAAC;IACJ,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,IAAI,QAAQ;QACV,IAAI,IAAI,CAAC,KAAK,KAAK,0BAAQ,CAAC,OAAO,IAAI,IAAI,CAAC,KAAK,KAAK,0BAAQ,CAAC,QAAQ,EAAE,CAAC;YACxE,OAAO,CAAC,CAAC;QACX,CAAC;QACD,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,IAAI,IAAI,IAAI,EAAE,CAAC;QAC1C,OAAO,CAAC,GAAG,GAAG,CAAC,CAAC,IAAI,CAAC,UAAU,IAAI,GAAG,CAAC,CAAC;IAC1C,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,YAAY,MAAoB;QA3Df,mBAAc,GAE3B;YACF,QAAQ,EAAE,EAAE;SACb,CAAC;QAwDA,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC;QAClC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACxD,IAAI,CAAC,EAAE,GAAG,MAAM,CAAC,EAAE,IAAI,IAAI,CAAC;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,KAAK,IAAI,0BAAQ,CAAC,OAAO,CAAC;QAC/C,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,IAAI,CAAC,CAAC;QACnC,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,QAAQ,IAAI,CAAC,CAAC;QACtC,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,QAAQ,IAAI,CAAC,CAAC;QACtC,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,IAAI,IAAI,IAAI,EAAE,CAAC;QAChD,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC;QAC7B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC;QAC3B,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC;IACrC,CAAC;IAED;;;;OAIG;IACH,KAAK;;QACH,IAAI,IAAI,CAAC,MAAM,KAAK,0BAAQ,CAAC,OAAO,IAAI,IAAI,CAAC,MAAM,KAAK,0BAAQ,CAAC,QAAQ,EAAE,CAAC;YAC1E,IAAI,CAAC,MAAM,GAAG,0BAAQ,CAAC,OAAO,CAAC;YAC/B,IAAI,CAAC,UAAU,GAAG,IAAI,IAAI,EAAE,CAAC;YAC7B,IAAI,CAAC,SAAS,EAAE,CAAC;YACjB,uBAAM,CAAC,KAAK,CACV,OAAO,MAAA,MAAA,IAAI,CAAC,EAAE,0CAAE,QAAQ,EAAE,mCAAI,MAAM,KAAK,IAAI,CAAC,SAAS,uBACrD,IAAI,CAAC,SACP,OAAO,IAAI,CAAC,OAAO,GAAG,CAAC,GAAG,CAC3B,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,WAAW,CAAC,OAAe;QACzB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;QAC7C,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,MAAY;;QACnB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,0BAAQ,CAAC,SAAS,CAAC;QACjC,IAAI,CAAC,UAAU,GAAG,IAAI,IAAI,EAAE,CAAC;QAC7B,uBAAM,CAAC,KAAK,CACV,OAAO,MAAA,MAAA,IAAI,CAAC,EAAE,0CAAE,QAAQ,EAAE,mCAAI,MAAM,KAAK,IAAI,CAAC,SAAS,aAAa,CACrE,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,IAAI,CAAC,GAAS;;QACZ,IAAI,CAAC,MAAM,GAAG,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,OAAO,EAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACvD,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC;QACnB,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnC,IAAI,CAAC,MAAM,GAAG,0BAAQ,CAAC,QAAQ,CAAC;YAChC,uBAAM,CAAC,IAAI,CACT,OAAO,MAAA,MAAA,IAAI,CAAC,EAAE,0CAAE,QAAQ,EAAE,mCAAI,MAAM,KAAK,IAAI,CAAC,SAAS,qBACrD,IAAI,CAAC,SACP,OAAO,IAAI,CAAC,OAAO,GAAG,CAAC,GAAG,CAC3B,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,IAAI,IAAI,CAAC,MAAM,KAAK,0BAAQ,CAAC,SAAS,EAAE,CAAC;gBACvC,IAAI,CAAC,MAAM,GAAG,0BAAQ,CAAC,MAAM,CAAC;gBAC9B,uBAAM,CAAC,IAAI,CACT,OAAO,MAAA,MAAA,IAAI,CAAC,EAAE,0CAAE,QAAQ,EAAE,mCAAI,MAAM,KAAK,IAAI,CAAC,SAAS,8BAA8B,CACtF,CAAC;YACJ,CAAC;YACD,IAAI,CAAC,UAAU,GAAG,IAAI,IAAI,EAAE,CAAC;QAC/B,CAAC;IACH,CAAC;IAED,MAAM;QACJ,IAAI,CAAC,UAAU,GAAG,IAAI,IAAI,EAAE,CAAC;QAC7B,IAAI,CAAC,MAAM,GAAG,0BAAQ,CAAC,SAAS,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACH,KAAK;;QACH,IAAI,IAAI,CAAC,MAAM,KAAK,0BAAQ,CAAC,OAAO,EAAE,CAAC;YACrC,IAAI,CAAC,MAAM,GAAG,0BAAQ,CAAC,OAAO,CAAC;YAC/B,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC;YACnB,uBAAM,CAAC,KAAK,CACV,OAAO,MAAA,MAAA,IAAI,CAAC,EAAE,0CAAE,QAAQ,EAAE,mCAAI,MAAM,KAAK,IAAI,CAAC,SAAS,kCAAkC,CAC1F,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,EAAE,CAAC,SAAuB,EAAE,QAA6B;QACvD,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAChD,CAAC;IAED,GAAG,CAAC,SAAuB,EAAE,QAA6B;QACxD,MAAM,GAAG,GAAG,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC7D,IAAI,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC;YACf,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;QAChD,CAAC;IACH,CAAC;IAEO,SAAS,CAAC,SAAuB;QACvC,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,EAAE,CAAC;YACtD,QAAQ,CAAC,IAAI,CAAC,CAAC;QACjB,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACK,wBAAwB,CAAC,IAAS,EAAE,KAAK,GAAG,CAAC;QACnD,IAAI,EAAE,GAAG,KAAK,EAAE,CAAC;YACf,OAAO,qBAAqB,CAAC;QAC/B,CAAC;QACD,KAAK,EAAE,CAAC;QACR,IAAI,MAAW,CAAC;QAChB,IAAI,IAAI,YAAY,IAAI,EAAE,CAAC;YACzB,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC;QAC5B,CAAC;aAAM,IAAI,IAAA,uBAAQ,EAAC,IAAI,CAAC,EAAE,CAAC;YAC1B,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,MAAM,GAAG,EAAE,CAAC;YACd,CAAC;YACD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBACpC,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,wBAAwB,CAAE,IAAY,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC;YACzE,CAAC;YACD,IAAI,IAAA,8BAAe,EAAC,IAAI,CAAC,EAAE,CAAC;gBAC1B,MAAM,WAAW,GAAG,MAAM,CAAC,yBAAyB,CAClD,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,CAC5B,CAAC;gBACF,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;oBAC5C,MAAM,UAAU,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;oBACrC,IAAI,OAAO,UAAU,CAAC,GAAG,KAAK,UAAU,EAAE,CAAC;wBACzC,MAAM,CAAC,IAAI,CAAC,GAAI,IAAY,CAAC,IAAI,CAAC,CAAC;oBACrC,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;aAAM,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YAC/B,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,MAAM,GAAG,EAAE,CAAC;YACd,CAAC;YACD,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE;gBACvB,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,wBAAwB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;YACzD,CAAC,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AA/OD,kBA+OC"}