@alanszp/queue 7.9.0

package/.gitignore

@@ -0,0 +1,3 @@
+node_modules
+*.log
+dist

package/.npmignore

@@ -0,0 +1,3 @@
+node_modules
+src
+*.log

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Alan Szpigiel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/connectionManager.d.ts

@@ -0,0 +1,15 @@
+import { ILogger } from "@alanszp/logger";
+import Redis, { RedisOptions } from "ioredis";
+export declare class ConnectionManager {
+    private static instance;
+    private connection;
+    private redisConfiguration;
+    private serviceName;
+    getLogger: () => ILogger;
+    static getInstance(): ConnectionManager;
+    private connect;
+    setConfiguration(configuration: RedisOptions, service: string, getLogger: () => ILogger): void;
+    getServiceName(): string;
+    getConnection(): Redis;
+    close(): void;
+}

package/dist/connectionManager.js

@@ -0,0 +1,48 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConnectionManager = void 0;
+const ioredis_1 = __importDefault(require("ioredis"));
+class ConnectionManager {
+    static getInstance() {
+        if (!ConnectionManager.instance) {
+            ConnectionManager.instance = new ConnectionManager();
+        }
+        return ConnectionManager.instance;
+    }
+    connect() {
+        if (!this.redisConfiguration) {
+            throw new Error("Redis configuration required");
+        }
+        const redis = new ioredis_1.default(this.redisConfiguration);
+        redis.on("connect", () => this.getLogger().info("redis.connected"));
+        redis.on("ready", () => this.getLogger().info("redis.ready"));
+        redis.on("error", (error) => this.getLogger().error("redis.error", { error }));
+        redis.on("close", () => this.getLogger().warn("redis.closed"));
+        redis.on("reconnecting", () => this.getLogger().info("redis.reconnecting"));
+        redis.on("end", () => this.getLogger().info("redis.ended"));
+        redis.on("wait", () => this.getLogger().info("redis.waiting"));
+        return redis;
+    }
+    setConfiguration(configuration, service, getLogger) {
+        this.redisConfiguration = configuration;
+        this.serviceName = service;
+        this.getLogger = getLogger;
+    }
+    getServiceName() {
+        return this.serviceName;
+    }
+    getConnection() {
+        if (!this.connection) {
+            this.connection = this.connect();
+        }
+        return this.connection;
+    }
+    close() {
+        this.connection.disconnect();
+    }
+}
+exports.ConnectionManager = ConnectionManager;
+//# sourceMappingURL=connectionManager.js.map

package/dist/connectionManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"connectionManager.js","sourceRoot":"","sources":["../src/connectionManager.ts"],"names":[],"mappings":";;;;;;AACA,sDAA8C;AAE9C,MAAa,iBAAiB;IAWrB,MAAM,CAAC,WAAW;QACvB,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE;YAC/B,iBAAiB,CAAC,QAAQ,GAAG,IAAI,iBAAiB,EAAE,CAAC;SACtD;QAED,OAAO,iBAAiB,CAAC,QAAQ,CAAC;IACpC,CAAC;IAEO,OAAO;QACb,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE;YAC5B,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;SACjD;QAED,MAAM,KAAK,GAAG,IAAI,iBAAK,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QACjD,KAAK,CAAC,EAAE,CAAC,SAAS,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;QACpE,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;QAC9D,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAY,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,KAAK,CAAC,aAAa,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;QACtF,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC;QAC/D,KAAK,CAAC,EAAE,CAAC,cAAc,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC,CAAC;QAC5E,KAAK,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;QAC5D,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC;QAE/D,OAAO,KAAK,CAAC;IACf,CAAC;IAEM,gBAAgB,CAAC,aAA2B,EAAE,OAAe,EAAE,SAAwB;QAC5F,IAAI,CAAC,kBAAkB,GAAG,aAAa,CAAC;QACxC,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC;QAC3B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;IAEM,cAAc;QACnB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAEM,aAAa;QAClB,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YACpB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;SAClC;QAED,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAEM,KAAK;QACV,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE,CAAC;IAC/B,CAAC;CACF;AAzDD,8CAyDC"}

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+export * from "./queue/createQueue";
+export * from "./connectionManager";
+export * from "./shutdownQueue";
+export * from "./types";
+export * from "./runner";
+export * from "./worker/worker";
+export * from "./worker/workerRepository";

package/dist/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./queue/createQueue"), exports);
+__exportStar(require("./connectionManager"), exports);
+__exportStar(require("./shutdownQueue"), exports);
+__exportStar(require("./types"), exports);
+__exportStar(require("./runner"), exports);
+__exportStar(require("./worker/worker"), exports);
+__exportStar(require("./worker/workerRepository"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,sDAAoC;AACpC,sDAAoC;AACpC,kDAAgC;AAChC,0CAAwB;AACxB,2CAAyB;AACzB,kDAAgC;AAChC,4DAA0C"}

package/dist/queue/createQueue.d.ts

@@ -0,0 +1,3 @@
+import { Queue } from "./queue";
+import { JobData, QueueOptions } from "../types";
+export declare function createQueue<JobType = JobData>(name: string, queueOptions?: QueueOptions): Queue;

package/dist/queue/createQueue.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createQueue = void 0;
+const queue_1 = require("./queue");
+const queueRepository_1 = require("./queueRepository");
+const connectionManager_1 = require("../connectionManager");
+function createQueue(name, queueOptions) {
+    const connection = connectionManager_1.ConnectionManager.getInstance().getConnection();
+    const queue = new queue_1.Queue(connection, name, connectionManager_1.ConnectionManager.getInstance().getServiceName(), queueOptions);
+    queueRepository_1.QueueRepository.Instance.registerQueue(queue);
+    return queue;
+}
+exports.createQueue = createQueue;
+//# sourceMappingURL=createQueue.js.map

package/dist/queue/createQueue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createQueue.js","sourceRoot":"","sources":["../../src/queue/createQueue.ts"],"names":[],"mappings":";;;AAAA,mCAAgC;AAChC,uDAAoD;AACpD,4DAAyD;AAGzD,SAAgB,WAAW,CAAoB,IAAY,EAAE,YAA2B;IACtF,MAAM,UAAU,GAAG,qCAAiB,CAAC,WAAW,EAAE,CAAC,aAAa,EAAE,CAAC;IACnE,MAAM,KAAK,GAAG,IAAI,aAAK,CAAU,UAAU,EAAE,IAAI,EAAE,qCAAiB,CAAC,WAAW,EAAE,CAAC,cAAc,EAAE,EAAE,YAAY,CAAC,CAAC;IACnH,iCAAe,CAAC,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;IAC9C,OAAO,KAAK,CAAC;AACf,CAAC;AALD,kCAKC"}

package/dist/queue/queue.d.ts

@@ -0,0 +1,10 @@
+import { ConnectionOptions, JobData, QueueOptions } from "../types";
+export declare class Queue<JobType = JobData> {
+    private _queue;
+    private name;
+    constructor(connection: ConnectionOptions, name: string, prefix: string, queueOptions?: QueueOptions);
+    publishJob(job: JobType): Promise<void>;
+    publishBulkJob(jobDatas: JobType[]): Promise<void>;
+    close(): Promise<void>;
+    private get queue();
+}

package/dist/queue/queue.js

@@ -0,0 +1,57 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Queue = void 0;
+const lodash_1 = require("lodash");
+const types_1 = require("../types");
+const BULL_PREFIX = "b";
+const DEFAULT_COMPLETED_JOB_MAX_AGE_IN_SECONDS = 60 * 60 * 24 * 30;
+const DEFAULT_COMPLETED_JOB_MAX_COUNT = 500;
+class Queue {
+    constructor(connection, name, prefix, queueOptions) {
+        this.name = name;
+        this._queue = new types_1.RawQueue(name, Object.assign(Object.assign({}, (0, lodash_1.merge)({
+            defaultJobOptions: {
+                removeOnComplete: {
+                    age: DEFAULT_COMPLETED_JOB_MAX_AGE_IN_SECONDS,
+                    count: DEFAULT_COMPLETED_JOB_MAX_COUNT,
+                },
+                attempts: 3,
+                backoff: {
+                    type: "exponential",
+                    delay: 3000,
+                },
+            },
+            connection,
+        }, queueOptions || {})), { prefix: `{${prefix}}:${BULL_PREFIX}` }));
+    }
+    publishJob(job) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.queue.add(this.name, job);
+        });
+    }
+    publishBulkJob(jobDatas) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const jobs = jobDatas.map((data) => ({ name: this.name, data }));
+            yield this.queue.addBulk(jobs);
+        });
+    }
+    close() {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.queue.close();
+        });
+    }
+    get queue() {
+        return this._queue;
+    }
+}
+exports.Queue = Queue;
+//# sourceMappingURL=queue.js.map

package/dist/queue/queue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"queue.js","sourceRoot":"","sources":["../../src/queue/queue.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,mCAA+B;AAC/B,oCAA8E;AAE9E,MAAM,WAAW,GAAG,GAAG,CAAC;AAExB,MAAM,wCAAwC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;AACnE,MAAM,+BAA+B,GAAG,GAAG,CAAC;AAE5C,MAAa,KAAK;IAKhB,YAAY,UAA6B,EAAE,IAAY,EAAE,MAAc,EAAE,YAA2B;QAClG,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QAEjB,IAAI,CAAC,MAAM,GAAG,IAAI,gBAAQ,CAAU,IAAI,kCACnC,IAAA,cAAK,EACN;YACE,iBAAiB,EAAE;gBACjB,gBAAgB,EAAE;oBAChB,GAAG,EAAE,wCAAwC;oBAC7C,KAAK,EAAE,+BAA+B;iBACvC;gBACD,QAAQ,EAAE,CAAC;gBACX,OAAO,EAAE;oBACP,IAAI,EAAE,aAAa;oBACnB,KAAK,EAAE,IAAI;iBACZ;aACF;YACD,UAAU;SACX,EACD,YAAY,IAAI,EAAE,CACnB,GACE,EAAE,MAAM,EAAE,IAAI,MAAM,KAAK,WAAW,EAAE,EAAE,EAC3C,CAAC;IACL,CAAC;IAEK,UAAU,CAAC,GAAY;;YAC3B,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QACvC,CAAC;KAAA;IAEK,cAAc,CAAC,QAAmB;;YACtC,MAAM,IAAI,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;YACjE,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACjC,CAAC;KAAA;IAEK,KAAK;;YACT,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;QAC3B,CAAC;KAAA;IAED,IAAY,KAAK;QACf,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;CACF;AA9CD,sBA8CC"}

package/dist/queue/queueRepository.d.ts

@@ -0,0 +1,9 @@
+import { Queue } from "./queue";
+export declare class QueueRepository {
+    private _queues;
+    private static _instance;
+    private constructor();
+    static get Instance(): QueueRepository;
+    registerQueue(queue: Queue): void;
+    getCloseConnections(): Promise<void>[];
+}

package/dist/queue/queueRepository.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QueueRepository = void 0;
+class QueueRepository {
+    constructor() {
+        this._queues = [];
+    }
+    static get Instance() {
+        if (this._instance) {
+            return this._instance;
+        }
+        this._instance = new this();
+        return this._instance;
+    }
+    registerQueue(queue) {
+        this._queues.push(queue);
+    }
+    getCloseConnections() {
+        return this._queues.map((q) => q.close());
+    }
+}
+exports.QueueRepository = QueueRepository;
+//# sourceMappingURL=queueRepository.js.map

package/dist/queue/queueRepository.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"queueRepository.js","sourceRoot":"","sources":["../../src/queue/queueRepository.ts"],"names":[],"mappings":";;;AAEA,MAAa,eAAe;IAK1B;QACE,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;IACpB,CAAC;IAEM,MAAM,KAAK,QAAQ;QACxB,IAAI,IAAI,CAAC,SAAS,EAAE;YAClB,OAAO,IAAI,CAAC,SAAS,CAAC;SACvB;QACD,IAAI,CAAC,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC;QAC5B,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAEM,aAAa,CAAC,KAAY;QAC/B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC3B,CAAC;IAEM,mBAAmB;QACxB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;IAC5C,CAAC;CACF;AAxBD,0CAwBC"}

package/dist/runner.d.ts

@@ -0,0 +1 @@
+export declare function runWorkers(queueNames: string): Promise<void>;

package/dist/runner.js

@@ -0,0 +1,27 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runWorkers = void 0;
+const connectionManager_1 = require("./connectionManager");
+const workerRepository_1 = require("./worker/workerRepository");
+function runWorkers(queueNames) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (queueNames.length === 0) {
+            connectionManager_1.ConnectionManager.getInstance().getLogger().warn("worker.env.workers_queues_empty");
+            return Promise.resolve();
+        }
+        const queues = queueNames.replace(/\s/g, "").split(",");
+        const workers = workerRepository_1.WorkerRepository.Instance.getWorkersByQueues(queues);
+        yield Promise.all(workers.map((worker) => worker.run()));
+    });
+}
+exports.runWorkers = runWorkers;
+//# sourceMappingURL=runner.js.map

package/dist/runner.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"runner.js","sourceRoot":"","sources":["../src/runner.ts"],"names":[],"mappings":";;;;;;;;;;;;AACA,2DAAwD;AAExD,gEAA6D;AAE7D,SAAsB,UAAU,CAAC,UAAkB;;QACjD,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE;YAC3B,qCAAiB,CAAC,WAAW,EAAE,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,iCAAiC,CAAC,CAAC;YACpF,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;SAC1B;QAED,MAAM,MAAM,GAAa,UAAU,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAClE,MAAM,OAAO,GAAG,mCAAgB,CAAC,QAAQ,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAErE,MAAM,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAc,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;IACnE,CAAC;CAAA;AAVD,gCAUC"}

package/dist/shutdownQueue.d.ts

@@ -0,0 +1 @@
+export declare function shutdownQueue(): Promise<void>;

package/dist/shutdownQueue.js

@@ -0,0 +1,26 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.shutdownQueue = void 0;
+const queueRepository_1 = require("./queue/queueRepository");
+const connectionManager_1 = require("./connectionManager");
+const workerRepository_1 = require("./worker/workerRepository");
+function shutdownQueue() {
+    return __awaiter(this, void 0, void 0, function* () {
+        yield Promise.all([
+            ...workerRepository_1.WorkerRepository.Instance.getCloseConnections(),
+            ...queueRepository_1.QueueRepository.Instance.getCloseConnections(),
+        ]);
+        connectionManager_1.ConnectionManager.getInstance().close();
+    });
+}
+exports.shutdownQueue = shutdownQueue;
+//# sourceMappingURL=shutdownQueue.js.map

package/dist/shutdownQueue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shutdownQueue.js","sourceRoot":"","sources":["../src/shutdownQueue.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,6DAA0D;AAC1D,2DAAwD;AACxD,gEAA6D;AAE7D,SAAsB,aAAa;;QACjC,MAAM,OAAO,CAAC,GAAG,CAAC;YAChB,GAAG,mCAAgB,CAAC,QAAQ,CAAC,mBAAmB,EAAE;YAClD,GAAG,iCAAe,CAAC,QAAQ,CAAC,mBAAmB,EAAE;SAClD,CAAC,CAAC;QAEH,qCAAiB,CAAC,WAAW,EAAE,CAAC,KAAK,EAAE,CAAC;IAC1C,CAAC;CAAA;AAPD,sCAOC"}

package/dist/types.d.ts

@@ -0,0 +1,2 @@
+export { ConnectionOptions, RedisOptions, Job, Worker as RawWorker, WorkerOptions, Queue as RawQueue, QueueOptions, } from "bullmq";
+export declare type JobData = any;

package/dist/types.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RawQueue = exports.RawWorker = exports.Job = void 0;
+// decoupling from bullmq
+var bullmq_1 = require("bullmq");
+Object.defineProperty(exports, "Job", { enumerable: true, get: function () { return bullmq_1.Job; } });
+Object.defineProperty(exports, "RawWorker", { enumerable: true, get: function () { return bullmq_1.Worker; } });
+Object.defineProperty(exports, "RawQueue", { enumerable: true, get: function () { return bullmq_1.Queue; } });
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AAAA,yBAAyB;AACzB,iCAQgB;AALd,6FAAA,GAAG,OAAA;AACH,mGAAA,MAAM,OAAa;AAEnB,kGAAA,KAAK,OAAY"}

package/dist/worker/worker.d.ts

@@ -0,0 +1,35 @@
+import { JobData, Job, RawWorker, WorkerOptions } from "../types";
+export interface WorkerStatus {
+    running: boolean;
+    paused: boolean;
+}
+export interface WorkerSetup {
+    queueName: string;
+    workerOptions?: WorkerOptions;
+}
+interface Worker<T = JobData> {
+    handleJobFailed?(job: Job<T>, error: Error): Promise<void> | void;
+    handleJobCompleted?(job: Job<T>): Promise<void> | void;
+    handleJobError?(error: Error): Promise<void> | void;
+}
+declare abstract class Worker<T = JobData> {
+    private _worker;
+    private _queue;
+    private getLogger;
+    constructor();
+    abstract process(job: Job<T>): Promise<void>;
+    abstract setup(): WorkerSetup;
+    close(): Promise<void>;
+    get status(): WorkerStatus;
+    get id(): RawWorker["id"];
+    private processJob;
+    processFailed(job: Job<T>, error: Error): Promise<void>;
+    processCompleted(job: Job<T>): Promise<void>;
+    processError(error: Error): Promise<void>;
+    run(): Promise<void>;
+    protected registerHooks(): void;
+    protected get worker(): RawWorker;
+    get queueFullName(): string;
+    get queueName(): string;
+}
+export { Worker };

package/dist/worker/worker.js

@@ -0,0 +1,99 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Worker = void 0;
+const connectionManager_1 = require("../connectionManager");
+const types_1 = require("../types");
+const BULL_PREFIX = "b";
+class Worker {
+    constructor() {
+        const { queueName: name, workerOptions } = this.setup();
+        const connectionManager = connectionManager_1.ConnectionManager.getInstance();
+        this.getLogger = connectionManager.getLogger;
+        const prefix = connectionManager.getServiceName();
+        this._queue = { name, prefix, namespace: BULL_PREFIX };
+        this._worker = new types_1.RawWorker(name, this.processJob(), Object.assign({ autorun: false, connection: connectionManager.getConnection(), prefix: `{${prefix}}:${BULL_PREFIX}` }, workerOptions));
+        this.getLogger().info("worker.ready", { queue: this.queueFullName });
+        this.registerHooks();
+    }
+    close() {
+        return this.worker.close();
+    }
+    get status() {
+        return { running: this.worker.isRunning(), paused: this.worker.isPaused() };
+    }
+    get id() {
+        return this.worker.id;
+    }
+    processJob() {
+        return (job) => __awaiter(this, void 0, void 0, function* () {
+            this.getLogger().info(`worker.process.job_received`, { queue: this.queueFullName, job });
+            yield this.process(job);
+        });
+    }
+    processFailed(job, error) {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.getLogger().warn("worker.job.failed", { queue: this.queueFullName, job, error });
+            if (this.handleJobFailed) {
+                yield this.handleJobFailed(job, error);
+            }
+        });
+    }
+    processCompleted(job) {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.getLogger().info("worker.job.completed", { queue: this.queueFullName, job });
+            if (this.handleJobCompleted) {
+                yield this.handleJobCompleted(job);
+            }
+        });
+    }
+    processError(error) {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.getLogger().error("worker.job.unhandled_exception", { queue: this.queueFullName, error });
+            if (this.handleJobError) {
+                yield this.handleJobError(error);
+            }
+        });
+    }
+    run() {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                this.getLogger().info("worker.run.starting", { queue: this.queueFullName });
+                yield this.worker.run();
+                this.getLogger().info("worker.run.started", { queue: this.queueFullName });
+            }
+            catch (error) {
+                this.getLogger().error("worker.run.error", { queue: this.queueFullName, error });
+                throw error;
+            }
+        });
+    }
+    registerHooks() {
+        // on error: handle unhandled exceptions
+        this.worker.on("error", (error) => this.processError(error));
+        // on completed: allow to do something else after a job is completed
+        this.worker.on("completed", (job) => this.processCompleted(job));
+        // on failed: when the process fails with an exception it is possible to listen for the "failed" event
+        this.worker.on("failed", (job, error) => this.processFailed(job, error));
+    }
+    get worker() {
+        return this._worker;
+    }
+    get queueFullName() {
+        const { name, prefix, namespace } = this._queue;
+        return `{${prefix}}:${namespace}:${name}`;
+    }
+    get queueName() {
+        return this._queue.name;
+    }
+}
+exports.Worker = Worker;
+//# sourceMappingURL=worker.js.map

package/dist/worker/worker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"worker.js","sourceRoot":"","sources":["../../src/worker/worker.ts"],"names":[],"mappings":";;;;;;;;;;;;AACA,4DAAyD;AACzD,oCAAkE;AAsBlE,MAAM,WAAW,GAAG,GAAG,CAAC;AAExB,MAAe,MAAM;IAOnB;QACE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,aAAa,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC;QAExD,MAAM,iBAAiB,GAAG,qCAAiB,CAAC,WAAW,EAAE,CAAC;QAC1D,IAAI,CAAC,SAAS,GAAG,iBAAiB,CAAC,SAAS,CAAC;QAE7C,MAAM,MAAM,GAAG,iBAAiB,CAAC,cAAc,EAAE,CAAC;QAClD,IAAI,CAAC,MAAM,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,WAAW,EAAE,CAAC;QACvD,IAAI,CAAC,OAAO,GAAG,IAAI,iBAAS,CAAI,IAAI,EAAE,IAAI,CAAC,UAAU,EAAE,kBACrD,OAAO,EAAE,KAAK,EACd,UAAU,EAAE,iBAAiB,CAAC,aAAa,EAAE,EAC7C,MAAM,EAAE,IAAI,MAAM,KAAK,WAAW,EAAE,IACjC,aAAa,EAChB,CAAC;QACH,IAAI,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC;QAErE,IAAI,CAAC,aAAa,EAAE,CAAC;IACvB,CAAC;IAOM,KAAK;QACV,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;IAC7B,CAAC;IAED,IAAW,MAAM;QACf,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC;IAC9E,CAAC;IAED,IAAW,EAAE;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;IACxB,CAAC;IAEO,UAAU;QAChB,OAAO,CAAO,GAAG,EAAE,EAAE;YACnB,IAAI,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,6BAA6B,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,aAAa,EAAE,GAAG,EAAE,CAAC,CAAC;YACzF,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC1B,CAAC,CAAA,CAAC;IACJ,CAAC;IAEK,aAAa,CAAC,GAAW,EAAE,KAAY;;YAC3C,IAAI,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,aAAa,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC;YACtF,IAAI,IAAI,CAAC,eAAe,EAAE;gBACxB,MAAM,IAAI,CAAC,eAAe,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;aACxC;QACH,CAAC;KAAA;IAEK,gBAAgB,CAAC,GAAW;;YAChC,IAAI,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,sBAAsB,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,aAAa,EAAE,GAAG,EAAE,CAAC,CAAC;YAClF,IAAI,IAAI,CAAC,kBAAkB,EAAE;gBAC3B,MAAM,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC;aACpC;QACH,CAAC;KAAA;IAEK,YAAY,CAAC,KAAY;;YAC7B,IAAI,CAAC,SAAS,EAAE,CAAC,KAAK,CAAC,gCAAgC,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,aAAa,EAAE,KAAK,EAAE,CAAC,CAAC;YAC/F,IAAI,IAAI,CAAC,cAAc,EAAE;gBACvB,MAAM,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;aAClC;QACH,CAAC;KAAA;IAEK,GAAG;;YACP,IAAI;gBACF,IAAI,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,qBAAqB,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC;gBAE5E,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC;gBACxB,IAAI,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC;aAC5E;YAAC,OAAO,KAAc,EAAE;gBACvB,IAAI,CAAC,SAAS,EAAE,CAAC,KAAK,CAAC,kBAAkB,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,aAAa,EAAE,KAAK,EAAE,CAAC,CAAC;gBACjF,MAAM,KAAK,CAAC;aACb;QACH,CAAC;KAAA;IAES,aAAa;QACrB,wCAAwC;QACxC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAY,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;QACpE,oEAAoE;QACpE,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,CAAC,GAAW,EAAE,EAAE,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC;QACzE,sGAAsG;QACtG,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAW,EAAE,KAAY,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;IAC1F,CAAC;IAED,IAAc,MAAM;QAClB,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,IAAI,aAAa;QACf,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC;QAChD,OAAO,IAAI,MAAM,KAAK,SAAS,IAAI,IAAI,EAAE,CAAC;IAC5C,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;IAC1B,CAAC;CACF;AAGQ,wBAAM"}

package/dist/worker/workerRepository.d.ts

@@ -0,0 +1,24 @@
+import { Worker, WorkerStatus } from "./worker";
+export declare type WokerStatusWithId = {
+    status: WorkerStatus;
+} & {
+    id: string;
+};
+interface WorkerClass {
+    new (): Worker;
+}
+export declare class WorkerRepository {
+    private _workers;
+    private _activeWorkers;
+    private static _instance;
+    private getLogger;
+    private constructor();
+    static get Instance(): WorkerRepository;
+    registerWorker(queueName: string, workerClass: WorkerClass): WorkerRepository;
+    getWorkersByQueues(queueNames: string[]): Worker[];
+    getWorkerStatuses(): WokerStatusWithId[];
+    getCloseConnections(): Promise<void>[];
+    private get workers();
+    private get activeWorkers();
+}
+export {};

package/dist/worker/workerRepository.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkerRepository = void 0;
+const lodash_1 = require("lodash");
+const connectionManager_1 = require("../connectionManager");
+class WorkerRepository {
+    constructor() {
+        this._workers = {};
+        this._activeWorkers = [];
+        this.getLogger = connectionManager_1.ConnectionManager.getInstance().getLogger;
+    }
+    static get Instance() {
+        if (this._instance) {
+            return this._instance;
+        }
+        this._instance = new this();
+        return this._instance;
+    }
+    registerWorker(queueName, workerClass) {
+        Object.assign(this.workers, { [queueName]: workerClass });
+        return this;
+    }
+    getWorkersByQueues(queueNames) {
+        if ((0, lodash_1.isEmpty)(this.workers)) {
+            this.getLogger().warn("worker_repository.queue_worker_map_is_empty");
+            return [];
+        }
+        return (0, lodash_1.compact)(queueNames.map((queueName) => {
+            if (this.workers[queueName]) {
+                const worker = new this.workers[queueName]();
+                // assuming this method is only called in a context for running them
+                this._activeWorkers.push(worker);
+                return worker;
+            }
+            this.getLogger().warn("worker_repository.invalid_queue_name", { queueName });
+            return null;
+        }));
+    }
+    getWorkerStatuses() {
+        return this.activeWorkers.map((worker) => ({ id: worker.id, status: worker.status }));
+    }
+    getCloseConnections() {
+        return this.activeWorkers.map((worker) => worker.close());
+    }
+    get workers() {
+        return this._workers;
+    }
+    get activeWorkers() {
+        return this._activeWorkers;
+    }
+}
+exports.WorkerRepository = WorkerRepository;
+//# sourceMappingURL=workerRepository.js.map

package/dist/worker/workerRepository.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"workerRepository.js","sourceRoot":"","sources":["../../src/worker/workerRepository.ts"],"names":[],"mappings":";;;AACA,mCAA0C;AAC1C,4DAAyD;AASzD,MAAa,gBAAgB;IAS3B;QACE,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;QACnB,IAAI,CAAC,cAAc,GAAG,EAAE,CAAC;QACzB,IAAI,CAAC,SAAS,GAAG,qCAAiB,CAAC,WAAW,EAAE,CAAC,SAAS,CAAC;IAC7D,CAAC;IAEM,MAAM,KAAK,QAAQ;QACxB,IAAI,IAAI,CAAC,SAAS,EAAE;YAClB,OAAO,IAAI,CAAC,SAAS,CAAC;SACvB;QACD,IAAI,CAAC,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC;QAC5B,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAEM,cAAc,CAAC,SAAiB,EAAE,WAAwB;QAC/D,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC,SAAS,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC;IACd,CAAC;IAED,kBAAkB,CAAC,UAAoB;QACrC,IAAI,IAAA,gBAAO,EAAC,IAAI,CAAC,OAAO,CAAC,EAAE;YACzB,IAAI,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,6CAA6C,CAAC,CAAC;YACrE,OAAO,EAAE,CAAC;SACX;QAED,OAAO,IAAA,gBAAO,EACZ,UAAU,CAAC,GAAG,CAAC,CAAC,SAAiB,EAAE,EAAE;YACnC,IAAI,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE;gBAC3B,MAAM,MAAM,GAAG,IAAI,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC7C,oEAAoE;gBACpE,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBACjC,OAAO,MAAM,CAAC;aACf;YACD,IAAI,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,sCAAsC,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;YAC7E,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CACH,CAAC;IACJ,CAAC;IAED,iBAAiB;QACf,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IACxF,CAAC;IAEM,mBAAmB;QACxB,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED,IAAY,OAAO;QACjB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED,IAAY,aAAa;QACvB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;CACF;AA/DD,4CA+DC"}

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@alanszp/queue",
+  "version": "7.9.0",
+  "description": "Workers and queues",
+  "main": "dist/index.js",
+  "typings": "dist/index.d.ts",
+  "license": "MIT",
+  "files": [
+    "**/*"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "compile": "rm -rf ./dist && tsc --declaration",
+    "compile-watch": "tsc -w",
+    "build": "yarn run compile",
+    "prepack": "yarn run build",
+    "yalc-publish": "yarn run yalc publish"
+  },
+  "devDependencies": {
+    "@types/node": "^15.12.3",
+    "ts-node": "^10.0.0",
+    "tslint": "^6.1.3",
+    "typescript": "^4.3.4"
+  },
+  "dependencies": {
+    "@alanszp/logger": "^7.0.0",
+    "bullmq": "^2.1.2",
+    "ioredis": "^5.2.3",
+    "lodash": "^4.17.21"
+  },
+  "gitHead": "3a3685ad54fbde5cea62d5e2cabca96f4bd8faf4"
+}

package/src/connectionManager.ts

@@ -0,0 +1,61 @@
+import { ILogger } from "@alanszp/logger";
+import Redis, { RedisOptions } from "ioredis";
+
+export class ConnectionManager {
+  private static instance: ConnectionManager;
+
+  private connection: Redis;
+
+  private redisConfiguration: RedisOptions;
+
+  private serviceName: string;
+
+  public getLogger: () => ILogger;
+
+  public static getInstance(): ConnectionManager {
+    if (!ConnectionManager.instance) {
+      ConnectionManager.instance = new ConnectionManager();
+    }
+
+    return ConnectionManager.instance;
+  }
+
+  private connect(): Redis {
+    if (!this.redisConfiguration) {
+      throw new Error("Redis configuration required");
+    }
+
+    const redis = new Redis(this.redisConfiguration);
+    redis.on("connect", () => this.getLogger().info("redis.connected"));
+    redis.on("ready", () => this.getLogger().info("redis.ready"));
+    redis.on("error", (error: Error) => this.getLogger().error("redis.error", { error }));
+    redis.on("close", () => this.getLogger().warn("redis.closed"));
+    redis.on("reconnecting", () => this.getLogger().info("redis.reconnecting"));
+    redis.on("end", () => this.getLogger().info("redis.ended"));
+    redis.on("wait", () => this.getLogger().info("redis.waiting"));
+
+    return redis;
+  }
+
+  public setConfiguration(configuration: RedisOptions, service: string, getLogger: () => ILogger) {
+    this.redisConfiguration = configuration;
+    this.serviceName = service;
+    this.getLogger = getLogger;
+  }
+
+  public getServiceName(): string {
+    return this.serviceName;
+  }
+
+  public getConnection(): Redis {
+    if (!this.connection) {
+      this.connection = this.connect();
+    }
+
+    return this.connection;
+  }
+
+  public close(): void {
+    this.connection.disconnect();
+  }
+}

package/src/index.ts

@@ -0,0 +1,7 @@
+export * from "./queue/createQueue";
+export * from "./connectionManager";
+export * from "./shutdownQueue";
+export * from "./types";
+export * from "./runner";
+export * from "./worker/worker";
+export * from "./worker/workerRepository";

package/src/queue/createQueue.ts

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

package/src/queue/queue.ts

@@ -0,0 +1,55 @@
+import { merge } from "lodash";
+import { ConnectionOptions, JobData, QueueOptions, RawQueue } from "../types";
+
+const BULL_PREFIX = "b";
+
+const DEFAULT_COMPLETED_JOB_MAX_AGE_IN_SECONDS = 60 * 60 * 24 * 30;
+const DEFAULT_COMPLETED_JOB_MAX_COUNT = 500;
+
+export class Queue<JobType = JobData> {
+  private _queue: RawQueue;
+
+  private name: string;
+
+  constructor(connection: ConnectionOptions, name: string, prefix: string, queueOptions?: QueueOptions) {
+    this.name = name;
+
+    this._queue = new RawQueue<JobType>(name, {
+      ...merge(
+        {
+          defaultJobOptions: {
+            removeOnComplete: {
+              age: DEFAULT_COMPLETED_JOB_MAX_AGE_IN_SECONDS,
+              count: DEFAULT_COMPLETED_JOB_MAX_COUNT,
+            },
+            attempts: 3,
+            backoff: {
+              type: "exponential",
+              delay: 3000,
+            },
+          },
+          connection,
+        },
+        queueOptions || {}
+      ),
+      ...{ prefix: `{${prefix}}:${BULL_PREFIX}` },
+    });
+  }
+
+  async publishJob(job: JobType): Promise<void> {
+    await this.queue.add(this.name, job);
+  }
+
+  async publishBulkJob(jobDatas: JobType[]): Promise<void> {
+    const jobs = jobDatas.map((data) => ({ name: this.name, data }));
+    await this.queue.addBulk(jobs);
+  }
+
+  async close(): Promise<void> {
+    await this.queue.close();
+  }
+
+  private get queue(): RawQueue<JobType> {
+    return this._queue;
+  }
+}

package/src/queue/queueRepository.ts

@@ -0,0 +1,27 @@
+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/runner.ts

@@ -0,0 +1,16 @@
+
+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

@@ -0,0 +1,12 @@
+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

@@ -0,0 +1,14 @@
+// decoupling from bullmq
+export {
+  ConnectionOptions,
+  RedisOptions,
+  Job,
+  Worker as RawWorker,
+  WorkerOptions,
+  Queue as RawQueue,
+  QueueOptions,
+} from "bullmq";
+
+// This may seems odd but actual Job data type from bullmq is any 🤷‍♂️
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export type JobData = any;

package/src/worker/worker.ts

@@ -0,0 +1,134 @@
+import { ILogger } from "@alanszp/logger";
+import { ConnectionManager } from "../connectionManager";
+import { JobData, Job, RawWorker, WorkerOptions } from "../types";
+
+export interface WorkerStatus {
+  running: boolean;
+  paused: boolean;
+}
+
+export interface WorkerSetup {
+  queueName: string;
+  workerOptions?: WorkerOptions;
+}
+
+// optional methods
+
+interface Worker<T = JobData> {
+  handleJobFailed?(job: Job<T>, error: Error): Promise<void> | void;
+  handleJobCompleted?(job: Job<T>): Promise<void> | void;
+  handleJobError?(error: Error): Promise<void> | void;
+}
+
+type QueueName = { name: string; prefix: string; namespace: string };
+
+const BULL_PREFIX = "b";
+
+abstract class Worker<T = JobData> {
+  private _worker: RawWorker;
+
+  private _queue: QueueName;
+
+  private getLogger: () => ILogger;
+
+  constructor() {
+    const { queueName: name, workerOptions } = this.setup();
+
+    const connectionManager = ConnectionManager.getInstance();
+    this.getLogger = connectionManager.getLogger;
+
+    const prefix = connectionManager.getServiceName();
+    this._queue = { name, prefix, namespace: BULL_PREFIX };
+    this._worker = new RawWorker<T>(name, this.processJob(), {
+      autorun: false,
+      connection: connectionManager.getConnection(),
+      prefix: `{${prefix}}:${BULL_PREFIX}`,
+      ...workerOptions,
+    });
+    this.getLogger().info("worker.ready", { queue: this.queueFullName });
+
+    this.registerHooks();
+  }
+
+  // Handle job
+  abstract process(job: Job<T>): Promise<void>;
+
+  abstract setup(): WorkerSetup;
+
+  public close(): Promise<void> {
+    return this.worker.close();
+  }
+
+  public get status(): WorkerStatus {
+    return { running: this.worker.isRunning(), paused: this.worker.isPaused() };
+  }
+
+  public get id(): RawWorker["id"] {
+    return this.worker.id;
+  }
+
+  private processJob(): (job: Job<T>) => Promise<void> {
+    return async (job) => {
+      this.getLogger().info(`worker.process.job_received`, { queue: this.queueFullName, job });
+      await this.process(job);
+    };
+  }
+
+  async processFailed(job: Job<T>, error: Error): Promise<void> {
+    this.getLogger().warn("worker.job.failed", { queue: this.queueFullName, job, error });
+    if (this.handleJobFailed) {
+      await this.handleJobFailed(job, error);
+    }
+  }
+
+  async processCompleted(job: Job<T>): Promise<void> {
+    this.getLogger().info("worker.job.completed", { queue: this.queueFullName, job });
+    if (this.handleJobCompleted) {
+      await this.handleJobCompleted(job);
+    }
+  }
+
+  async processError(error: Error): Promise<void> {
+    this.getLogger().error("worker.job.unhandled_exception", { queue: this.queueFullName, error });
+    if (this.handleJobError) {
+      await this.handleJobError(error);
+    }
+  }
+
+  async run(): Promise<void> {
+    try {
+      this.getLogger().info("worker.run.starting", { queue: this.queueFullName });
+
+      await this.worker.run();
+      this.getLogger().info("worker.run.started", { queue: this.queueFullName });
+    } catch (error: unknown) {
+      this.getLogger().error("worker.run.error", { queue: this.queueFullName, error });
+      throw error;
+    }
+  }
+
+  protected registerHooks(): void {
+    // on error: handle unhandled exceptions
+    this.worker.on("error", (error: Error) => this.processError(error));
+    // on completed: allow to do something else after a job is completed
+    this.worker.on("completed", (job: Job<T>) => this.processCompleted(job));
+    // on failed: when the process fails with an exception it is possible to listen for the "failed" event
+    this.worker.on("failed", (job: Job<T>, error: Error) => this.processFailed(job, error));
+  }
+
+  protected get worker(): RawWorker {
+    return this._worker;
+  }
+
+  get queueFullName(): string {
+    const { name, prefix, namespace } = this._queue;
+    return `{${prefix}}:${namespace}:${name}`;
+  }
+
+  get queueName(): string {
+    return this._queue.name;
+  }
+}
+
+// this export is required for merging optional methods interface into abstract class
+export { Worker };

package/src/worker/workerRepository.ts

@@ -0,0 +1,75 @@
+import { ILogger } from "@alanszp/logger";
+import { compact, isEmpty } from "lodash";
+import { ConnectionManager } from "../connectionManager";
+import { Worker, WorkerStatus } from "./worker";
+
+export type WokerStatusWithId = { status: WorkerStatus } & { id: string };
+interface WorkerClass {
+  new (): Worker;
+}
+type QueueWorkerMap = Record<string, WorkerClass>;
+
+export class WorkerRepository {
+  private _workers: QueueWorkerMap;
+
+  private _activeWorkers: Worker[];
+
+  private static _instance: WorkerRepository;
+
+  private getLogger: () => ILogger;
+
+  private constructor() {
+    this._workers = {};
+    this._activeWorkers = [];
+    this.getLogger = ConnectionManager.getInstance().getLogger;
+  }
+
+  public static get Instance(): WorkerRepository {
+    if (this._instance) {
+      return this._instance;
+    }
+    this._instance = new this();
+    return this._instance;
+  }
+
+  public registerWorker(queueName: string, workerClass: WorkerClass): WorkerRepository {
+    Object.assign(this.workers, { [queueName]: workerClass });
+    return this;
+  }
+
+  getWorkersByQueues(queueNames: string[]): Worker[] {
+    if (isEmpty(this.workers)) {
+      this.getLogger().warn("worker_repository.queue_worker_map_is_empty");
+      return [];
+    }
+
+    return compact(
+      queueNames.map((queueName: string) => {
+        if (this.workers[queueName]) {
+          const worker = new this.workers[queueName]();
+          // assuming this method is only called in a context for running them
+          this._activeWorkers.push(worker);
+          return worker;
+        }
+        this.getLogger().warn("worker_repository.invalid_queue_name", { queueName });
+        return null;
+      })
+    );
+  }
+
+  getWorkerStatuses(): WokerStatusWithId[] {
+    return this.activeWorkers.map((worker) => ({ id: worker.id, status: worker.status }));
+  }
+
+  public getCloseConnections(): Promise<void>[] {
+    return this.activeWorkers.map((worker) => worker.close());
+  }
+
+  private get workers(): QueueWorkerMap {
+    return this._workers;
+  }
+
+  private get activeWorkers(): Worker[] {
+    return this._activeWorkers;
+  }
+}

package/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "rootDir": "src",
+    "outDir": "dist",
+    "module": "commonjs",
+    "target": "es6",
+    "types": ["node", "jest"],
+    "esModuleInterop": true,
+    "sourceMap": true,
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "alwaysStrict": true,
+    "strictNullChecks": true
+  },
+  "exclude": ["node_modules"]
+}