@anchan828/nest-cloud-run-queue-worker 3.0.0 → 3.1.1

package/dist/interfaces.d.ts

@@ -69,9 +69,17 @@ export interface QueueWorkerProcessDecoratorArgs {
 }
 export type QueueWorkerRawMessage<T = any> = {
     readonly data?: string | null | Message<T>;
+    readonly messageId?: string;
     readonly headers?: Record<string, string>;
 } & Record<string, any>;
 export type QueueWorkerDecodedMessage<T = any> = {
+    /**
+     * The message ID is a unique identifier.
+     * If controller recieve from Pub/Sub, it will be body.message.messageId.
+     * If controller recieve from Cloud Tasks, it will be body.message.headers["X-CloudTasks-TaskName"].
+     * If nothing is obtained, it will be an empty string.
+     */
+    readonly id: string;
     readonly data: Message<T>;
     readonly headers?: Record<string, string>;
     readonly raw: QueueWorkerRawMessage;
@@ -87,6 +95,10 @@ export interface QueueWorkerControllerMetadata extends RequestMappingMetadata {
      * @memberof QueueWorkerControllerMetadata
      */
     statusCode?: number;
+    /**
+     * Whether to throw the error as is when Processor throws an error. Default is true.
+     */
+    throwError?: boolean;
 }
 export interface QueueWorkerControllerInterface {
     execute(body: QueueWorkerReceivedMessage, headers: Record<string, string>): Promise<void>;

package/dist/util.js

@@ -73,9 +73,13 @@ function decodeMessage(message) {
     return {
         data,
         headers: "headers" in message ? message.headers : undefined,
+        id: getMessageId(message),
         raw: message,
     };
 }
+function getMessageId(raw) {
+    return raw.messageId ?? raw.headers?.["x-cloudtasks-taskname"] ?? "";
+}
 function decodeData(data) {
     if (!data) {
         throw new common_1.BadRequestException(constants_1.ERROR_INVALID_MESSAGE_FORMAT);

package/dist/worker.controller.js

@@ -18,12 +18,18 @@ const worker_service_1 = require("./worker.service");
 function getWorkerController(metadata) {
     const path = metadata?.path;
     const method = metadata?.method || common_1.RequestMethod.POST;
+    const throwError = metadata?.throwError ?? true;
     let WorkerController = class WorkerController {
         constructor(service) {
             this.service = service;
         }
         async execute(body, headers) {
-            await this.service.execute({ ...body.message, headers });
+            const results = await this.service.execute({ ...body.message, headers });
+            for (const result of results) {
+                if (!result.success && throwError) {
+                    throw result.error;
+                }
+            }
         }
     };
     __decorate([

package/dist/worker.service.d.ts

@@ -10,11 +10,15 @@ export declare class QueueWorkerService {
     /**
      * Execute all workers that match the worker name. If you want to execute a each worker, use `getWorkers` method.
      */
-    execute<T = any>(meessage: QueueWorkerRawMessage<T> | QueueWorkerDecodedMessage<T> | Message<T>): Promise<QueueWorkerProcessResult<T>[]>;
+    execute<T = any>(meessage: QueueWorkerRawMessage<T>): Promise<QueueWorkerProcessResult<T>[]>;
+    execute<T = any>(meessage: Message<T>): Promise<QueueWorkerProcessResult<T>[]>;
+    execute<T = any>(meessage: QueueWorkerDecodedMessage<T>): Promise<QueueWorkerProcessResult<T>[]>;
     /**
      * Get all workers that match the worker name. Use this method to execute manually when you want to execute only on specific conditions using metadata such as class name or processor name.
      * If you want to execute all workers simply, use `execute` method.
      */
-    getWorkers<T = any>(meessage: QueueWorkerRawMessage<T> | QueueWorkerDecodedMessage<T> | Message<T>): Worker<T>[];
+    getWorkers<T = any>(meessage: QueueWorkerRawMessage<T>): Worker<T>[];
+    getWorkers<T = any>(meessage: Message<T>): Worker<T>[];
+    getWorkers<T = any>(meessage: QueueWorkerDecodedMessage<T>): Worker<T>[];
     private isDecodedMessage;
 }

package/dist/worker.service.js

@@ -37,9 +37,6 @@ let QueueWorkerService = class QueueWorkerService {
         this.explorerService = explorerService;
         _QueueWorkerService__allWorkers.set(this, void 0);
     }
-    /**
-     * Execute all workers that match the worker name. If you want to execute a each worker, use `getWorkers` method.
-     */
     async execute(meessage) {
         const decodedMessage = this.isDecodedMessage(meessage) ? meessage : (0, util_1.decodeMessage)(meessage);
         if (this.options.throwModuleError && !decodedMessage.data.name) {
@@ -55,10 +52,6 @@ let QueueWorkerService = class QueueWorkerService {
         }
         return results;
     }
-    /**
-     * Get all workers that match the worker name. Use this method to execute manually when you want to execute only on specific conditions using metadata such as class name or processor name.
-     * If you want to execute all workers simply, use `execute` method.
-     */
     getWorkers(meessage) {
         const decodedMessage = this.isDecodedMessage(meessage) ? meessage : (0, util_1.decodeMessage)(meessage);
         if (!decodedMessage.data.name) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@anchan828/nest-cloud-run-queue-worker",
-  "version": "3.0.0",
+  "version": "3.1.1",
   "description": "> TODO: description",
   "homepage": "https://github.com/anchan828/nest-cloud-run-queue/tree/master/packages/worker#readme",
   "bugs": {
@@ -33,7 +33,7 @@
     "watch": "tsc -w"
   },
   "dependencies": {
-    "@anchan828/nest-cloud-run-queue-common": "^3.0.0"
+    "@anchan828/nest-cloud-run-queue-common": "^3.1.1"
   },
   "devDependencies": {
     "@nestjs/common": "10.3.10",
@@ -45,6 +45,6 @@
   "publishConfig": {
     "access": "public"
   },
-  "packageManager": "npm@10.8.1",
-  "gitHead": "696d3bba1c948cbf84d1386ae553602ac5a53cfd"
+  "packageManager": "npm@10.8.2",
+  "gitHead": "aa316926176b40816565704e5372ceb0d3938543"
 }