@nest-boot/bullmq 8.0.5-beta.0 → 8.0.5-beta.1

package/dist/index.d.ts

@@ -1,5 +1,7 @@
 export { BullModule } from "./bullmq.module.js";
 export * from "./bullmq-module-options.interface.js";
+export { OnQueueEvent } from "./on-queue-event.decorator.js";
+export { OnWorkerEvent } from "./on-worker-event.decorator.js";
 export { type NestWorkerOptions, Processor } from "./processor.decorator.js";
 export * from "@nestjs/bullmq";
 export { QueueEventsListener } from "@nestjs/bullmq";

package/dist/index.js

@@ -1,5 +1,7 @@
 export { BullModule } from "./bullmq.module.js";
 export * from "./bullmq-module-options.interface.js";
+export { OnQueueEvent } from "./on-queue-event.decorator.js";
+export { OnWorkerEvent } from "./on-worker-event.decorator.js";
 export { Processor } from "./processor.decorator.js";
 export * from "@nestjs/bullmq";
 export { QueueEventsListener } from "@nestjs/bullmq";

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChD,cAAc,sCAAsC,CAAC;AACrD,OAAO,EAA0B,SAAS,EAAE,MAAM,0BAA0B,CAAC;AAC7E,cAAc,gBAAgB,CAAC;AAC/B,OAAO,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChD,cAAc,sCAAsC,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAC7D,OAAO,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AAC/D,OAAO,EAA0B,SAAS,EAAE,MAAM,0BAA0B,CAAC;AAC7E,cAAc,gBAAgB,CAAC;AAC/B,OAAO,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC"}

package/dist/on-queue-event.decorator.d.ts

@@ -0,0 +1,15 @@
+import type { QueueEventsListener } from "bullmq";
+/**
+ * Listens to a queue event in an independent queue request context.
+ *
+ * @remarks
+ * Use on a method of a singleton `QueueEventsHost` registered with
+ * `@QueueEventsListener()`. The event's `jobId` becomes the context ID when
+ * present; otherwise an ID is generated. Queue event payloads are not Jobs,
+ * so `JOB_REF` is not bound. Handler and middleware failures are logged and
+ * suppressed because BullMQ does not await listeners.
+ *
+ * @param eventName - The queue event to observe
+ * @returns A method decorator compatible with Nest's queue event discovery
+ */
+export declare function OnQueueEvent(eventName: keyof QueueEventsListener): MethodDecorator;

package/dist/on-queue-event.decorator.js

@@ -0,0 +1,26 @@
+import { OnQueueEvent as BaseOnQueueEvent } from "@nestjs/bullmq";
+import { createContextEventDecorator } from "./utils/create-context-event-decorator.util.js";
+/**
+ * Listens to a queue event in an independent queue request context.
+ *
+ * @remarks
+ * Use on a method of a singleton `QueueEventsHost` registered with
+ * `@QueueEventsListener()`. The event's `jobId` becomes the context ID when
+ * present; otherwise an ID is generated. Queue event payloads are not Jobs,
+ * so `JOB_REF` is not bound. Handler and middleware failures are logged and
+ * suppressed because BullMQ does not await listeners.
+ *
+ * @param eventName - The queue event to observe
+ * @returns A method decorator compatible with Nest's queue event discovery
+ */
+export function OnQueueEvent(eventName) {
+    return createContextEventDecorator(eventName, BaseOnQueueEvent(eventName), ([first]) => ({
+        id: typeof first === "object" &&
+            first !== null &&
+            "jobId" in first &&
+            typeof first.jobId === "string"
+            ? first.jobId
+            : undefined,
+    }));
+}
+//# sourceMappingURL=on-queue-event.decorator.js.map

package/dist/on-queue-event.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"on-queue-event.decorator.js","sourceRoot":"","sources":["../src/on-queue-event.decorator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,IAAI,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAGlE,OAAO,EAAE,2BAA2B,EAAE,MAAM,gDAAgD,CAAC;AAE7F;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,YAAY,CAC1B,SAAoC;IAEpC,OAAO,2BAA2B,CAChC,SAAS,EACT,gBAAgB,CAAC,SAAS,CAAC,EAC3B,CAAC,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC;QACZ,EAAE,EACA,OAAO,KAAK,KAAK,QAAQ;YACzB,KAAK,KAAK,IAAI;YACd,OAAO,IAAI,KAAK;YAChB,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ;YAC7B,CAAC,CAAC,KAAK,CAAC,KAAK;YACb,CAAC,CAAC,SAAS;KAChB,CAAC,CACH,CAAC;AACJ,CAAC"}

package/dist/on-worker-event.decorator.d.ts

@@ -0,0 +1,14 @@
+import type { WorkerListener } from "bullmq";
+/**
+ * Listens to a worker event in an independent queue request context.
+ *
+ * @remarks
+ * Use on a method of a singleton `WorkerHost` registered with `@Processor()`.
+ * Job-bearing events bind `JOB_REF`; `stalled` supplies only the context ID.
+ * Events without a job ID use a generated context ID. Handler and middleware
+ * failures are logged and suppressed because BullMQ does not await listeners.
+ *
+ * @param eventName - The worker event to observe
+ * @returns A method decorator compatible with Nest's worker event discovery
+ */
+export declare function OnWorkerEvent(eventName: keyof WorkerListener): MethodDecorator;

package/dist/on-worker-event.decorator.js

@@ -0,0 +1,30 @@
+import { OnWorkerEvent as BaseOnWorkerEvent } from "@nestjs/bullmq";
+import { createContextEventDecorator } from "./utils/create-context-event-decorator.util.js";
+/**
+ * Listens to a worker event in an independent queue request context.
+ *
+ * @remarks
+ * Use on a method of a singleton `WorkerHost` registered with `@Processor()`.
+ * Job-bearing events bind `JOB_REF`; `stalled` supplies only the context ID.
+ * Events without a job ID use a generated context ID. Handler and middleware
+ * failures are logged and suppressed because BullMQ does not await listeners.
+ *
+ * @param eventName - The worker event to observe
+ * @returns A method decorator compatible with Nest's worker event discovery
+ */
+export function OnWorkerEvent(eventName) {
+    return createContextEventDecorator(eventName, BaseOnWorkerEvent(eventName), ([first]) => {
+        switch (eventName) {
+            case "active":
+            case "completed":
+            case "failed":
+            case "progress":
+                return { job: first };
+            case "stalled":
+                return { id: first };
+            default:
+                return {};
+        }
+    });
+}
+//# sourceMappingURL=on-worker-event.decorator.js.map

package/dist/on-worker-event.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"on-worker-event.decorator.js","sourceRoot":"","sources":["../src/on-worker-event.decorator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,IAAI,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAGpE,OAAO,EAAE,2BAA2B,EAAE,MAAM,gDAAgD,CAAC;AAE7F;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,aAAa,CAC3B,SAA+B;IAE/B,OAAO,2BAA2B,CAChC,SAAS,EACT,iBAAiB,CAAC,SAAS,CAAC,EAC5B,CAAC,CAAC,KAAK,CAAC,EAAE,EAAE;QACV,QAAQ,SAAS,EAAE,CAAC;YAClB,KAAK,QAAQ,CAAC;YACd,KAAK,WAAW,CAAC;YACjB,KAAK,QAAQ,CAAC;YACd,KAAK,UAAU;gBACb,OAAO,EAAE,GAAG,EAAE,KAAwB,EAAE,CAAC;YAC3C,KAAK,SAAS;gBACZ,OAAO,EAAE,EAAE,EAAE,KAAe,EAAE,CAAC;YACjC;gBACE,OAAO,EAAE,CAAC;QACd,CAAC;IACH,CAAC,CACF,CAAC;AACJ,CAAC"}

package/dist/processor.decorator.d.ts

@@ -10,7 +10,7 @@ export type NestWorkerOptions = Omit<WorkerOptions, "connection"> & Partial<Pick
  *
  * @remarks
  * Wraps the `@nestjs/bullmq` `Processor` decorator to automatically
- * create a {@link RequestContext} for each processed job.
+ * create a request context for each processed job.
  *
  * @param queueName - The name of the queue to process
  */

package/dist/processor.decorator.js

@@ -1,18 +1,13 @@
 /* eslint-disable @typescript-eslint/unified-signatures */
-import { RequestContext } from "@nest-boot/request-context";
-import { JOB_REF, Processor as BaseProcessor, } from "@nestjs/bullmq";
+import { Processor as BaseProcessor, } from "@nestjs/bullmq";
+import { runInQueueContext } from "./utils/run-in-queue-context.util.js";
 export function Processor(queueNameOrOptions, maybeWorkerOptions) {
     return (target) => {
         const originalProcess = target.prototype.process;
         if (originalProcess) {
             target.prototype.process = async function (...args) {
                 const [job] = args;
-                const ctx = new RequestContext({
-                    id: job.id,
-                    type: "queue",
-                });
-                ctx.set(JOB_REF, job);
-                return await RequestContext.run(ctx, () => originalProcess.apply(this, args));
+                return await runInQueueContext({ job }, () => originalProcess.apply(this, args));
             };
         }
         BaseProcessor(queueNameOrOptions, maybeWorkerOptions)(target);

package/dist/processor.decorator.js.map

@@ -1 +1 @@
-{"version":3,"file":"processor.decorator.js","sourceRoot":"","sources":["../src/processor.decorator.ts"],"names":[],"mappings":"AAAA,0DAA0D;AAE1D,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EACL,OAAO,EACP,SAAS,IAAI,aAAa,GAG3B,MAAM,gBAAgB,CAAC;AAuDxB,MAAM,UAAU,SAAS,CACvB,kBAA8C,EAC9C,kBAAsC;IAEtC,OAAO,CAAC,MAA2B,EAAE,EAAE;QACrC,MAAM,eAAe,GAAG,MAAM,CAAC,SAAS,CAAC,OAA0B,CAAC;QACpE,IAAI,eAAe,EAAE,CAAC;YACpB,MAAM,CAAC,SAAS,CAAC,OAAO,GAAG,KAAK,WAC9B,GAAG,IAAiC;gBAEpC,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;gBACnB,MAAM,GAAG,GAAG,IAAI,cAAc,CAAC;oBAC7B,EAAE,EAAE,GAAG,CAAC,EAAE;oBACV,IAAI,EAAE,OAAO;iBACd,CAAC,CAAC;gBAEH,GAAG,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;gBAEtB,OAAO,MAAM,cAAc,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,CACxC,eAAe,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAClC,CAAC;YACJ,CAAC,CAAC;QACJ,CAAC;QAED,aAAa,CAAC,kBAAyB,EAAE,kBAAyB,CAAC,CAAC,MAAM,CAAC,CAAC;IAC9E,CAAC,CAAC;AACJ,CAAC"}
+{"version":3,"file":"processor.decorator.js","sourceRoot":"","sources":["../src/processor.decorator.ts"],"names":[],"mappings":"AAAA,0DAA0D;AAE1D,OAAO,EACL,SAAS,IAAI,aAAa,GAG3B,MAAM,gBAAgB,CAAC;AAQxB,OAAO,EAAE,iBAAiB,EAAE,MAAM,sCAAsC,CAAC;AAiDzE,MAAM,UAAU,SAAS,CACvB,kBAA8C,EAC9C,kBAAsC;IAEtC,OAAO,CAAC,MAA2B,EAAE,EAAE;QACrC,MAAM,eAAe,GAAG,MAAM,CAAC,SAAS,CAAC,OAA0B,CAAC;QACpE,IAAI,eAAe,EAAE,CAAC;YACpB,MAAM,CAAC,SAAS,CAAC,OAAO,GAAG,KAAK,WAC9B,GAAG,IAAiC;gBAEpC,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;gBACnB,OAAO,MAAM,iBAAiB,CAAC,EAAE,GAAG,EAAE,EAAE,GAAG,EAAE,CAC3C,eAAe,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAClC,CAAC;YACJ,CAAC,CAAC;QACJ,CAAC;QAED,aAAa,CAAC,kBAAyB,EAAE,kBAAyB,CAAC,CAAC,MAAM,CAAC,CAAC;IAC9E,CAAC,CAAC;AACJ,CAAC"}

package/dist/utils/create-context-event-decorator.util.d.ts

@@ -0,0 +1,3 @@
+import { type QueueContextOptions } from "./run-in-queue-context.util.js";
+/** Wraps an event callback while preserving Nest's discovery metadata. @internal */
+export declare function createContextEventDecorator(eventName: string, baseDecorator: MethodDecorator, getContextOptions: (args: unknown[]) => QueueContextOptions): MethodDecorator;

package/dist/utils/create-context-event-decorator.util.js

@@ -0,0 +1,25 @@
+import { Logger } from "@nestjs/common";
+import { runInQueueContext, } from "./run-in-queue-context.util.js";
+/** Wraps an event callback while preserving Nest's discovery metadata. @internal */
+export function createContextEventDecorator(eventName, baseDecorator, getContextOptions) {
+    return (target, propertyKey, descriptor) => {
+        const original = descriptor.value;
+        const logger = new Logger(`${target.constructor.name}.${String(propertyKey)}`);
+        descriptor.value = async function (...args) {
+            try {
+                return await runInQueueContext(getContextOptions(args), () => original.apply(this, args));
+            }
+            catch (error) {
+                // EventEmitter does not await listeners. Observers must not create
+                // unhandled rejections or turn an already completed job into a failure.
+                const message = error instanceof Error ? error.message : String(error);
+                logger.error(`BullMQ event handler failed (${eventName}): ${message}`, error instanceof Error ? error.stack : undefined);
+            }
+        };
+        for (const key of Reflect.getMetadataKeys(original)) {
+            Reflect.defineMetadata(key, Reflect.getMetadata(key, original), descriptor.value);
+        }
+        return baseDecorator(target, propertyKey, descriptor);
+    };
+}
+//# sourceMappingURL=create-context-event-decorator.util.js.map

package/dist/utils/create-context-event-decorator.util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-context-event-decorator.util.js","sourceRoot":"","sources":["../../src/utils/create-context-event-decorator.util.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC,OAAO,EAEL,iBAAiB,GAClB,MAAM,gCAAgC,CAAC;AAExC,oFAAoF;AACpF,MAAM,UAAU,2BAA2B,CACzC,SAAiB,EACjB,aAA8B,EAC9B,iBAA2D;IAE3D,OAAO,CAAC,MAAM,EAAE,WAAW,EAAE,UAA8B,EAAE,EAAE;QAC7D,MAAM,QAAQ,GAAG,UAAU,CAAC,KAAK,CAAC;QAClC,MAAM,MAAM,GAAG,IAAI,MAAM,CACvB,GAAG,MAAM,CAAC,WAAW,CAAC,IAAI,IAAI,MAAM,CAAC,WAAW,CAAC,EAAE,CACpD,CAAC;QAEF,UAAU,CAAC,KAAK,GAAG,KAAK,WAAW,GAAG,IAAe;YACnD,IAAI,CAAC;gBACH,OAAO,MAAM,iBAAiB,CAAC,iBAAiB,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,CAC3D,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAC3B,CAAC;YACJ,CAAC;YAAC,OAAO,KAAc,EAAE,CAAC;gBACxB,mEAAmE;gBACnE,wEAAwE;gBACxE,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;gBACvE,MAAM,CAAC,KAAK,CACV,gCAAgC,SAAS,MAAM,OAAO,EAAE,EACxD,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CACjD,CAAC;YACJ,CAAC;QACH,CAAC,CAAC;QAEF,KAAK,MAAM,GAAG,IAAI,OAAO,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE,CAAC;YACpD,OAAO,CAAC,cAAc,CACpB,GAAG,EACH,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,QAAQ,CAAC,EAClC,UAAU,CAAC,KAAK,CACjB,CAAC;QACJ,CAAC;QAED,OAAO,aAAa,CAAC,MAAM,EAAE,WAAW,EAAE,UAAU,CAAC,CAAC;IACxD,CAAC,CAAC;AACJ,CAAC"}

package/dist/utils/run-in-queue-context.util.d.ts

@@ -0,0 +1,8 @@
+import type { Job } from "bullmq";
+/** Values available when entering a job processor or event handler. @internal */
+export interface QueueContextOptions {
+    id?: string;
+    job?: Job;
+}
+/** Runs one callback and its middleware in an independent queue context. @internal */
+export declare function runInQueueContext<T>(options: QueueContextOptions, callback: () => T | Promise<T>): Promise<T>;

package/dist/utils/run-in-queue-context.util.js

@@ -0,0 +1,13 @@
+import { RequestContext } from "@nest-boot/request-context";
+import { JOB_REF } from "@nestjs/bullmq";
+/** Runs one callback and its middleware in an independent queue context. @internal */
+export async function runInQueueContext(options, callback) {
+    const context = new RequestContext({
+        id: options.id ?? options.job?.id,
+        type: "queue",
+    });
+    if (options.job)
+        context.set(JOB_REF, options.job);
+    return await RequestContext.run(context, callback);
+}
+//# sourceMappingURL=run-in-queue-context.util.js.map

package/dist/utils/run-in-queue-context.util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"run-in-queue-context.util.js","sourceRoot":"","sources":["../../src/utils/run-in-queue-context.util.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AASzC,sFAAsF;AACtF,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,OAA4B,EAC5B,QAA8B;IAE9B,MAAM,OAAO,GAAG,IAAI,cAAc,CAAC;QACjC,EAAE,EAAE,OAAO,CAAC,EAAE,IAAI,OAAO,CAAC,GAAG,EAAE,EAAE;QACjC,IAAI,EAAE,OAAO;KACd,CAAC,CAAC;IAEH,IAAI,OAAO,CAAC,GAAG;QAAE,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;IAEnD,OAAO,MAAM,cAAc,CAAC,GAAG,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;AACrD,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nest-boot/bullmq",
-  "version": "8.0.5-beta.0",
+  "version": "8.0.5-beta.1",
   "repository": {
     "type": "git",
     "url": "https://github.com/nest-boot/nest-boot.git",