@alanszp/queue 8.0.0 → 9.2.3

package/dist/helpers/appIdentifier.d.ts

@@ -0,0 +1 @@
+export declare function appIdentifier(): string;

package/dist/helpers/appIdentifier.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.appIdentifier = void 0;
+function appIdentifier() {
+    const appName = process.env.API_ORIGIN_NAME || "undefined";
+    const env = process.env.NODE_ENV || "development";
+    return `${appName}:${env}`;
+}
+exports.appIdentifier = appIdentifier;
+//# sourceMappingURL=appIdentifier.js.map

package/dist/helpers/appIdentifier.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"appIdentifier.js","sourceRoot":"","sources":["../../src/helpers/appIdentifier.ts"],"names":[],"mappings":";;;AAAA,SAAgB,aAAa;IAC3B,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,eAAe,IAAI,WAAW,CAAC;IAC3D,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,IAAI,aAAa,CAAC;IAClD,OAAO,GAAG,OAAO,IAAI,GAAG,EAAE,CAAC;AAC7B,CAAC;AAJD,sCAIC"}

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./queue/createQueue";
+export * from "./queue/queue";
 export * from "./connectionManager";
 export * from "./shutdownQueue";
 export * from "./types";

package/dist/index.js

@@ -11,6 +11,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./queue/createQueue"), exports);
+__exportStar(require("./queue/queue"), exports);
 __exportStar(require("./connectionManager"), exports);
 __exportStar(require("./shutdownQueue"), exports);
 __exportStar(require("./types"), exports);

package/dist/index.js.map

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

package/dist/queue/createQueue.d.ts

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

package/dist/queue/createQueue.js

@@ -4,9 +4,9 @@ exports.createQueue = void 0;
 const queue_1 = require("./queue");
 const queueRepository_1 = require("./queueRepository");
 const connectionManager_1 = require("../connectionManager");
-function createQueue(name, queueOptions) {
+function createQueue(name, getContext, queueOptions) {
     const connection = connectionManager_1.ConnectionManager.getInstance().getConnection();
-    const queue = new queue_1.Queue(connection, name, connectionManager_1.ConnectionManager.getInstance().getServiceName(), queueOptions);
+    const queue = new queue_1.Queue(connection, name, connectionManager_1.ConnectionManager.getInstance().getServiceName(), getContext, queueOptions);
     queueRepository_1.QueueRepository.Instance.registerQueue(queue);
     return queue;
 }

package/dist/queue/createQueue.js.map

@@ -1 +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"}
+{"version":3,"file":"createQueue.js","sourceRoot":"","sources":["../../src/queue/createQueue.ts"],"names":[],"mappings":";;;AAAA,mCAAgC;AAChC,uDAAoD;AACpD,4DAAyD;AAIzD,SAAgB,WAAW,CACzB,IAAY,EACZ,UAA+B,EAC/B,YAA2B;IAE3B,MAAM,UAAU,GAAG,qCAAiB,CAAC,WAAW,EAAE,CAAC,aAAa,EAAE,CAAC;IACnE,MAAM,KAAK,GAAG,IAAI,aAAK,CACrB,UAAU,EACV,IAAI,EACJ,qCAAiB,CAAC,WAAW,EAAE,CAAC,cAAc,EAAE,EAChD,UAAU,EACV,YAAY,CACb,CAAC;IACF,iCAAe,CAAC,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;IAC9C,OAAO,KAAK,CAAC;AACf,CAAC;AAfD,kCAeC"}

package/dist/queue/queue.d.ts

@@ -1,10 +1,18 @@
+import { Job, JobsOptions } from "bullmq";
+import { SharedContext } from "@alanszp/shared-context";
 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>;
+    private getSharedContext;
+    constructor(connection: ConnectionOptions, name: string, prefix: string, getSharedContext: () => SharedContext, queueOptions?: QueueOptions);
+    getName(): string;
+    publishJob(job: JobType, opts?: JobsOptions): Promise<Job<JobType>>;
+    publishBulkJob(jobDatas: JobType[]): Promise<Job<JobType>[]>;
+    publishBulkJobWithOptions(jobDefinitions: {
+        jobData: JobType;
+        opts: JobsOptions;
+    }[]): Promise<void>;
     close(): Promise<void>;
     private get queue();
 }

package/dist/queue/queue.js

@@ -16,8 +16,9 @@ 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) {
+    constructor(connection, name, prefix, getSharedContext, queueOptions) {
         this.name = name;
+        this.getSharedContext = getSharedContext;
         this._queue = new types_1.RawQueue(name, Object.assign(Object.assign({}, (0, lodash_1.merge)({
             defaultJobOptions: {
                 removeOnComplete: {
@@ -33,14 +34,30 @@ class Queue {
             connection,
         }, queueOptions || {})), { prefix: `{${prefix}}:${BULL_PREFIX}` }));
     }
-    publishJob(job) {
+    getName() {
+        return this.name;
+    }
+    publishJob(job, opts) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield this.queue.add(this.name, job);
+            const context = this.getSharedContext();
+            const lid = context.getLifecycleId();
+            const lch = context.getLifecycleChain();
+            return this.queue.add(this.name, Object.assign(Object.assign({}, job), { lid, lch }), opts);
         });
     }
     publishBulkJob(jobDatas) {
         return __awaiter(this, void 0, void 0, function* () {
             const jobs = jobDatas.map((data) => ({ name: this.name, data }));
+            return this.queue.addBulk(jobs);
+        });
+    }
+    publishBulkJobWithOptions(jobDefinitions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const jobs = jobDefinitions.map(({ jobData: data, opts }) => ({
+                name: this.name,
+                data,
+                opts,
+            }));
             yield this.queue.addBulk(jobs);
         });
     }

package/dist/queue/queue.js.map

@@ -1 +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"}
+{"version":3,"file":"queue.js","sourceRoot":"","sources":["../../src/queue/queue.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,mCAA+B;AAG/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;IAOhB,YACE,UAA6B,EAC7B,IAAY,EACZ,MAAc,EACd,gBAAqC,EACrC,YAA2B;QAE3B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QAEjB,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;QAEzC,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;IAEM,OAAO;QACZ,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAEK,UAAU,CAAC,GAAY,EAAE,IAAkB;;YAC/C,MAAM,OAAO,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACxC,MAAM,GAAG,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;YACrC,MAAM,GAAG,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;YACxC,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,kCAAO,GAAG,KAAE,GAAG,EAAE,GAAG,KAAI,IAAI,CAAC,CAAC;QAC/D,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,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAClC,CAAC;KAAA;IAEK,yBAAyB,CAC7B,cAAyD;;YAEzD,MAAM,IAAI,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;gBAC5D,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,IAAI;gBACJ,IAAI;aACL,CAAC,CAAC,CAAC;YACJ,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;AA1ED,sBA0EC"}

package/dist/types.d.ts

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

package/dist/types.js.map

@@ -1 +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"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AAAA,yBAAyB;AACzB,iCASgB;AANd,6FAAA,GAAG,OAAA;AACH,mGAAA,MAAM,OAAa;AAEnB,kGAAA,KAAK,OAAY"}

package/dist/worker/worker.d.ts

@@ -1,4 +1,7 @@
+import { ILogger } from "@alanszp/logger";
 import { JobData, Job, RawWorker, WorkerOptions } from "../types";
+import { SharedContext } from "@alanszp/shared-context";
+import { Audit } from "@alanszp/audit";
 export interface WorkerStatus {
     running: boolean;
     paused: boolean;
@@ -7,6 +10,11 @@ export interface WorkerSetup {
     queueName: string;
     workerOptions?: WorkerOptions;
 }
+export interface WorkerContext {
+    sharedContext: SharedContext;
+    baseLogger: ILogger;
+    audit: Audit;
+}
 interface Worker<T = JobData> {
     handleJobFailed?(job: Job<T>, error: Error): Promise<void> | void;
     handleJobCompleted?(job: Job<T>): Promise<void> | void;
@@ -19,6 +27,7 @@ declare abstract class Worker<T = JobData> {
     constructor();
     abstract process(job: Job<T>): Promise<void>;
     abstract setup(): WorkerSetup;
+    abstract getContext(): WorkerContext;
     close(): Promise<void>;
     get status(): WorkerStatus;
     get id(): RawWorker["id"];

package/dist/worker/worker.js

@@ -12,6 +12,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Worker = void 0;
 const connectionManager_1 = require("../connectionManager");
 const types_1 = require("../types");
+const withContext_1 = require("../wrappers/withContext");
 const BULL_PREFIX = "b";
 class Worker {
     constructor() {
@@ -34,14 +35,21 @@ class Worker {
         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 });
+        return (0, withContext_1.withContext)(this.getContext(), (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 });
+            this.getLogger().warn("worker.job.failed", {
+                queue: this.queueFullName,
+                job,
+                error,
+            });
             if (this.handleJobFailed) {
                 yield this.handleJobFailed(job, error);
             }
@@ -49,7 +57,10 @@ class Worker {
     }
     processCompleted(job) {
         return __awaiter(this, void 0, void 0, function* () {
-            this.getLogger().info("worker.job.completed", { queue: this.queueFullName, job });
+            this.getLogger().info("worker.job.completed", {
+                queue: this.queueFullName,
+                job,
+            });
             if (this.handleJobCompleted) {
                 yield this.handleJobCompleted(job);
             }
@@ -57,7 +68,10 @@ class Worker {
     }
     processError(error) {
         return __awaiter(this, void 0, void 0, function* () {
-            this.getLogger().error("worker.job.unhandled_exception", { queue: this.queueFullName, error });
+            this.getLogger().error("worker.job.unhandled_exception", {
+                queue: this.queueFullName,
+                error,
+            });
             if (this.handleJobError) {
                 yield this.handleJobError(error);
             }
@@ -66,12 +80,19 @@ class Worker {
     run() {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                this.getLogger().info("worker.run.starting", { queue: this.queueFullName });
+                this.getLogger().info("worker.run.starting", {
+                    queue: this.queueFullName,
+                });
                 yield this.worker.run();
-                this.getLogger().info("worker.run.started", { queue: this.queueFullName });
+                this.getLogger().info("worker.run.started", {
+                    queue: this.queueFullName,
+                });
             }
             catch (error) {
-                this.getLogger().error("worker.run.error", { queue: this.queueFullName, error });
+                this.getLogger().error("worker.run.error", {
+                    queue: this.queueFullName,
+                    error,
+                });
                 throw error;
             }
         });

package/dist/worker/worker.js.map

@@ -1 +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"}
+{"version":3,"file":"worker.js","sourceRoot":"","sources":["../../src/worker/worker.ts"],"names":[],"mappings":";;;;;;;;;;;;AACA,4DAAyD;AACzD,oCAAkE;AAGlE,yDAAsD;AA4BtD,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;IASM,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,IAAA,yBAAW,EAAC,IAAI,CAAC,UAAU,EAAE,EAAE,CAAO,GAAG,EAAE,EAAE;YAClD,IAAI,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,6BAA6B,EAAE;gBACnD,KAAK,EAAE,IAAI,CAAC,aAAa;gBACzB,GAAG;aACJ,CAAC,CAAC;YACH,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC1B,CAAC,CAAA,CAAC,CAAC;IACL,CAAC;IAEK,aAAa,CAAC,GAAW,EAAE,KAAY;;YAC3C,IAAI,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,mBAAmB,EAAE;gBACzC,KAAK,EAAE,IAAI,CAAC,aAAa;gBACzB,GAAG;gBACH,KAAK;aACN,CAAC,CAAC;YACH,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;gBAC5C,KAAK,EAAE,IAAI,CAAC,aAAa;gBACzB,GAAG;aACJ,CAAC,CAAC;YACH,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;gBACvD,KAAK,EAAE,IAAI,CAAC,aAAa;gBACzB,KAAK;aACN,CAAC,CAAC;YACH,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;oBAC3C,KAAK,EAAE,IAAI,CAAC,aAAa;iBAC1B,CAAC,CAAC;gBAEH,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC;gBACxB,IAAI,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,oBAAoB,EAAE;oBAC1C,KAAK,EAAE,IAAI,CAAC,aAAa;iBAC1B,CAAC,CAAC;aACJ;YAAC,OAAO,KAAc,EAAE;gBACvB,IAAI,CAAC,SAAS,EAAE,CAAC,KAAK,CAAC,kBAAkB,EAAE;oBACzC,KAAK,EAAE,IAAI,CAAC,aAAa;oBACzB,KAAK;iBACN,CAAC,CAAC;gBACH,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,CACrD,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,KAAK,CAAC,CAC/B,CAAC;IACJ,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/wrappers/withContext.d.ts

@@ -0,0 +1,3 @@
+import { Job, JobData } from "bullmq";
+import { WorkerContext } from "../worker/worker";
+export declare function withContext<T = JobData>(workerContext: WorkerContext, executor: (job: Job<T>) => Promise<void>): (job: Job<T>) => Promise<void>;

package/dist/wrappers/withContext.js

@@ -0,0 +1,33 @@
+"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());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.withContext = void 0;
+const cuid_1 = __importDefault(require("cuid"));
+const appIdentifier_1 = require("../helpers/appIdentifier");
+function withContext(workerContext, executor) {
+    return (job) => {
+        const { lid, lch } = job.data;
+        return workerContext.sharedContext.run(() => __awaiter(this, void 0, void 0, function* () {
+            return executor(job);
+        }), {
+            logger: workerContext.baseLogger,
+            audit: workerContext.audit.withState(),
+            lifecycleId: lid || (0, cuid_1.default)(),
+            lifecycleChain: lch || (0, appIdentifier_1.appIdentifier)(),
+            contextId: (0, cuid_1.default)(),
+        });
+    };
+}
+exports.withContext = withContext;
+//# sourceMappingURL=withContext.js.map

package/dist/wrappers/withContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"withContext.js","sourceRoot":"","sources":["../../src/wrappers/withContext.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,gDAAwB;AACxB,4DAAyD;AAIzD,SAAgB,WAAW,CACzB,aAA4B,EAC5B,QAAwC;IAExC,OAAO,CAAC,GAAG,EAAE,EAAE;QACb,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,GAAG,CAAC,IAAsC,CAAC;QAChE,OAAO,aAAa,CAAC,aAAa,CAAC,GAAG,CACpC,GAAS,EAAE;YACT,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC;QACvB,CAAC,CAAA,EACD;YACE,MAAM,EAAE,aAAa,CAAC,UAAU;YAChC,KAAK,EAAE,aAAa,CAAC,KAAK,CAAC,SAAS,EAAE;YACtC,WAAW,EAAE,GAAG,IAAI,IAAA,cAAI,GAAE;YAC1B,cAAc,EAAE,GAAG,IAAI,IAAA,6BAAa,GAAE;YACtC,SAAS,EAAE,IAAA,cAAI,GAAE;SAClB,CACF,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC;AAnBD,kCAmBC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alanszp/queue",
-  "version": "8.0.0",
+  "version": "9.2.3",
   "description": "Workers and queues",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -25,10 +25,12 @@
     "typescript": "^4.3.4"
   },
   "dependencies": {
-    "@alanszp/logger": "^8.0.0",
+    "@alanszp/audit": "^9.0.0",
+    "@alanszp/logger": "^9.0.0",
+    "@alanszp/shared-context": "^9.0.0",
     "bullmq": "^2.1.2",
     "ioredis": "^5.2.3",
     "lodash": "^4.17.21"
   },
-  "gitHead": "8ddbd6ae78e2404fb35497e18308644d3760dd17"
+  "gitHead": "dcb2a6f5d6489dbcb67197d26b8da716ea3c9c97"
 }

package/src/helpers/appIdentifier.ts

@@ -0,0 +1,5 @@
+export function appIdentifier() {
+  const appName = process.env.API_ORIGIN_NAME || "undefined";
+  const env = process.env.NODE_ENV || "development";
+  return `${appName}:${env}`;
+}

package/src/index.ts

@@ -1,4 +1,5 @@
 export * from "./queue/createQueue";
+export * from "./queue/queue";
 export * from "./connectionManager";
 export * from "./shutdownQueue";
 export * from "./types";

package/src/queue/createQueue.ts

@@ -2,10 +2,21 @@ 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<JobType = JobData>(name: string, queueOptions?: QueueOptions): Queue {
+export function createQueue<JobType = JobData>(
+  name: string,
+  getContext: () => SharedContext,
+  queueOptions?: QueueOptions
+): Queue {
   const connection = ConnectionManager.getInstance().getConnection();
-  const queue = new Queue<JobType>(connection, name, ConnectionManager.getInstance().getServiceName(), queueOptions);
+  const queue = new Queue<JobType>(
+    connection,
+    name,
+    ConnectionManager.getInstance().getServiceName(),
+    getContext,
+    queueOptions
+  );
   QueueRepository.Instance.registerQueue(queue);
   return queue;
 }

package/src/queue/queue.ts

@@ -1,4 +1,6 @@
 import { merge } from "lodash";
+import { Job, JobsOptions } from "bullmq";
+import { SharedContext } from "@alanszp/shared-context";
 import { ConnectionOptions, JobData, QueueOptions, RawQueue } from "../types";
 
 const BULL_PREFIX = "b";
@@ -11,9 +13,19 @@ export class Queue<JobType = JobData> {
 
   private name: string;
 
-  constructor(connection: ConnectionOptions, name: string, prefix: string, queueOptions?: QueueOptions) {
+  private getSharedContext: () => SharedContext;
+
+  constructor(
+    connection: ConnectionOptions,
+    name: string,
+    prefix: string,
+    getSharedContext: () => SharedContext,
+    queueOptions?: QueueOptions
+  ) {
     this.name = name;
 
+    this.getSharedContext = getSharedContext;
+
     this._queue = new RawQueue<JobType>(name, {
       ...merge(
         {
@@ -36,12 +48,30 @@ export class Queue<JobType = JobData> {
     });
   }
 
-  async publishJob(job: JobType): Promise<void> {
-    await this.queue.add(this.name, job);
+  public getName(): string {
+    return this.name;
+  }
+
+  async publishJob(job: JobType, opts?: JobsOptions): Promise<Job<JobType>> {
+    const context = this.getSharedContext();
+    const lid = context.getLifecycleId();
+    const lch = context.getLifecycleChain();
+    return this.queue.add(this.name, { ...job, lid, lch }, opts);
   }
 
-  async publishBulkJob(jobDatas: JobType[]): Promise<void> {
+  async publishBulkJob(jobDatas: JobType[]): Promise<Job<JobType>[]> {
     const jobs = jobDatas.map((data) => ({ name: this.name, data }));
+    return this.queue.addBulk(jobs);
+  }
+
+  async publishBulkJobWithOptions(
+    jobDefinitions: { jobData: JobType; opts: JobsOptions }[]
+  ): Promise<void> {
+    const jobs = jobDefinitions.map(({ jobData: data, opts }) => ({
+      name: this.name,
+      data,
+      opts,
+    }));
     await this.queue.addBulk(jobs);
   }
 

package/src/types.ts

@@ -7,6 +7,7 @@ export {
   WorkerOptions,
   Queue as RawQueue,
   QueueOptions,
+  JobsOptions,
 } from "bullmq";
 
 // This may seems odd but actual Job data type from bullmq is any 🤷‍♂️

package/src/worker/worker.ts

@@ -1,6 +1,9 @@
 import { ILogger } from "@alanszp/logger";
 import { ConnectionManager } from "../connectionManager";
 import { JobData, Job, RawWorker, WorkerOptions } from "../types";
+import { SharedContext } from "@alanszp/shared-context";
+import { Audit } from "@alanszp/audit";
+import { withContext } from "../wrappers/withContext";
 
 export interface WorkerStatus {
   running: boolean;
@@ -12,6 +15,12 @@ export interface WorkerSetup {
   workerOptions?: WorkerOptions;
 }
 
+export interface WorkerContext {
+  sharedContext: SharedContext;
+  baseLogger: ILogger;
+  audit: Audit;
+}
+
 // optional methods
 
 interface Worker<T = JobData> {
@@ -55,6 +64,8 @@ abstract class Worker<T = JobData> {
 
   abstract setup(): WorkerSetup;
 
+  abstract getContext(): WorkerContext;
+
   public close(): Promise<void> {
     return this.worker.close();
   }
@@ -68,28 +79,41 @@ abstract class Worker<T = JobData> {
   }
 
   private processJob(): (job: Job<T>) => Promise<void> {
-    return async (job) => {
-      this.getLogger().info(`worker.process.job_received`, { queue: this.queueFullName, job });
+    return withContext(this.getContext(), 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 });
+    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 });
+    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 });
+    this.getLogger().error("worker.job.unhandled_exception", {
+      queue: this.queueFullName,
+      error,
+    });
     if (this.handleJobError) {
       await this.handleJobError(error);
     }
@@ -97,12 +121,19 @@ abstract class Worker<T = JobData> {
 
   async run(): Promise<void> {
     try {
-      this.getLogger().info("worker.run.starting", { queue: this.queueFullName });
+      this.getLogger().info("worker.run.starting", {
+        queue: this.queueFullName,
+      });
 
       await this.worker.run();
-      this.getLogger().info("worker.run.started", { queue: this.queueFullName });
+      this.getLogger().info("worker.run.started", {
+        queue: this.queueFullName,
+      });
     } catch (error: unknown) {
-      this.getLogger().error("worker.run.error", { queue: this.queueFullName, error });
+      this.getLogger().error("worker.run.error", {
+        queue: this.queueFullName,
+        error,
+      });
       throw error;
     }
   }
@@ -113,7 +144,9 @@ abstract class Worker<T = JobData> {
     // 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));
+    this.worker.on("failed", (job: Job<T>, error: Error) =>
+      this.processFailed(job, error)
+    );
   }
 
   protected get worker(): RawWorker {

package/src/wrappers/withContext.ts

@@ -0,0 +1,25 @@
+import cuid from "cuid";
+import { appIdentifier } from "../helpers/appIdentifier";
+import { Job, JobData } from "bullmq";
+import { WorkerContext } from "../worker/worker";
+
+export function withContext<T = JobData>(
+  workerContext: WorkerContext,
+  executor: (job: Job<T>) => Promise<void>
+): (job: Job<T>) => Promise<void> {
+  return (job) => {
+    const { lid, lch } = job.data as { lid?: string; lch?: string };
+    return workerContext.sharedContext.run(
+      async () => {
+        return executor(job);
+      },
+      {
+        logger: workerContext.baseLogger,
+        audit: workerContext.audit.withState(),
+        lifecycleId: lid || cuid(),
+        lifecycleChain: lch || appIdentifier(),
+        contextId: cuid(),
+      }
+    );
+  };
+}