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

package/dist/constants.d.ts

@@ -1,6 +1,6 @@
 export declare const QUEUE_WORKER_MODULE_OPTIONS = "QUEUE_WORKER_MODULE_OPTIONS";
 export declare const QUEUE_WORKER_DECORATOR = "QUEUE_WORKER_DECORATOR";
 export declare const QUEUE_WORKER_PROCESS_DECORATOR = "QUEUE_WORKER_PROCESS_DECORATOR";
-export declare const ERROR_INVALID_MESSAGE_FORMAT = "Invalid message format.";
-export declare const ERROR_QUEUE_WORKER_NAME_NOT_FOUND = "QueueWorker name not found.";
+export declare const ERROR_INVALID_MESSAGE_FORMAT = "Invalid message format. The message must be an object that has a 'name' property.";
+export declare const ERROR_QUEUE_WORKER_NAME_NOT_FOUND = "Worker name not found.";
 export declare const ERROR_WORKER_NOT_FOUND: (name: string) => string;

package/dist/constants.js

@@ -5,7 +5,7 @@ exports.QUEUE_WORKER_MODULE_OPTIONS = "QUEUE_WORKER_MODULE_OPTIONS";
 exports.QUEUE_WORKER_DECORATOR = "QUEUE_WORKER_DECORATOR";
 exports.QUEUE_WORKER_PROCESS_DECORATOR = "QUEUE_WORKER_PROCESS_DECORATOR";
 // errors
-exports.ERROR_INVALID_MESSAGE_FORMAT = "Invalid message format.";
-exports.ERROR_QUEUE_WORKER_NAME_NOT_FOUND = "QueueWorker name not found.";
-const ERROR_WORKER_NOT_FOUND = (name) => `QueueWorker '${name}' not found.`;
+exports.ERROR_INVALID_MESSAGE_FORMAT = "Invalid message format. The message must be an object that has a 'name' property.";
+exports.ERROR_QUEUE_WORKER_NAME_NOT_FOUND = "Worker name not found.";
+const ERROR_WORKER_NOT_FOUND = (name) => `Worker '${name}' not found.`;
 exports.ERROR_WORKER_NOT_FOUND = ERROR_WORKER_NOT_FOUND;

package/dist/interfaces.d.ts

@@ -16,6 +16,13 @@ export interface QueueWorkerModuleOptions extends ModuleOptions {
      * @memberof QueueWorkerModuleOptions
      */
     maxRetryAttempts?: number;
+    /**
+     * extra config
+     *
+     * @type {QueueWorkerExtraConfig}
+     * @memberof QueueWorkerModuleOptions
+     */
+    extraConfig?: QueueWorkerExtraConfig;
     /**
      * Define a Route for the controller.
      * Default: POST /
@@ -40,6 +47,9 @@ export interface QueueWorkerProcessorMetadata extends QueueWorkerProcessDecorato
     processorName: string;
     processor: QueueWorkerProcessor;
 }
+export type QueueWorkerExtraConfig = {
+    parseReviver?: (key: string, value: any) => any;
+};
 export interface QueueWorkerDecoratorArgs {
     names: QueueWorkerName[];
     /**

package/dist/util.d.ts

@@ -5,7 +5,7 @@ import { QueueWorkerDecodedMessage, QueueWorkerRawMessage } from "./interfaces";
  * JSON.parse has receiver for Date.parse.
  * @param json
  */
-export declare const parseJSON: <T>(json: string) => T;
+export declare const parseJSON: <T>(json: string, reviver?: (key: string, value: any) => any) => T;
 /**
  * sort array by priority prop
  *
@@ -24,5 +24,10 @@ export declare function sortByPriority<T extends {
  * @param {string} value
  * @return {*}  {boolean}
  */
-export declare function isBase64(value?: string | null | Message): value is string;
-export declare function decodeMessage<T = any>(message: QueueWorkerRawMessage | Message): QueueWorkerDecodedMessage<T>;
+export declare function isBase64<T = any>(value?: string | null | Message<T>): value is string;
+export declare function decodeMessage<T = any>(message: QueueWorkerRawMessage<T> | Message, reviver?: (key: string, value: any) => any): QueueWorkerDecodedMessage<T>;
+export declare function isDecodedMessage<T = any>(message: QueueWorkerRawMessage<T> | QueueWorkerDecodedMessage<T> | Message<T>): message is QueueWorkerDecodedMessage<T>;
+export declare function isTaskMessage<T>(message?: QueueWorkerRawMessage<T> | Message<T> | null): message is Message<T> & {
+    headers?: Record<string, string>;
+};
+export declare function isMessage<T>(message?: QueueWorkerRawMessage<T> | Message<T> | null): message is Message<T>;

package/dist/util.js

@@ -4,6 +4,9 @@ exports.parseJSON = void 0;
 exports.sortByPriority = sortByPriority;
 exports.isBase64 = isBase64;
 exports.decodeMessage = decodeMessage;
+exports.isDecodedMessage = isDecodedMessage;
+exports.isTaskMessage = isTaskMessage;
+exports.isMessage = isMessage;
 const common_1 = require("@nestjs/common");
 const constants_1 = require("./constants");
 const dateRegExp = /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$/;
@@ -12,18 +15,19 @@ const dateRegExp = /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$/;
  * JSON.parse has receiver for Date.parse.
  * @param json
  */
-const parseJSON = (json) => {
-    return JSON.parse(json, (_, value) => {
-        if (typeof value === "string" && value.length === 24 && dateRegExp.test(value)) {
-            const date = new Date(value);
-            if (+date === +date) {
-                return date;
-            }
-        }
-        return value;
-    });
+const parseJSON = (json, reviver) => {
+    return JSON.parse(json, (key, value) => reviver ? reviver(key, parseDate(key, value)) : parseDate(key, value));
 };
 exports.parseJSON = parseJSON;
+function parseDate(key, value) {
+    if (typeof value === "string" && value.length === 24 && dateRegExp.test(value)) {
+        const date = new Date(value);
+        if (+date === +date) {
+            return date;
+        }
+    }
+    return value;
+}
 /**
  * sort array by priority prop
  *
@@ -60,15 +64,26 @@ function isBase64(value) {
     const firstPaddingChar = value.indexOf("=");
     return (firstPaddingChar === -1 || firstPaddingChar === len - 1 || (firstPaddingChar === len - 2 && value[len - 1] === "="));
 }
-function decodeMessage(message) {
+function decodeMessage(message, reviver) {
     let data;
     if (isBase64(message.data)) {
         // pubsub
-        data = decodeData(message.data);
+        data = decodeData(message.data, reviver);
+    }
+    else if (isTaskMessage(message)) {
+        // tasks
+        data = { data: JSON.parse(JSON.stringify(message.data), reviver), name: message.name };
     }
     else {
-        // tasks / http
-        data = message;
+        // http / raw
+        const _message = isMessage(message) ? message : isMessage(message.data) ? message.data : undefined;
+        if (!_message) {
+            throw new common_1.BadRequestException(constants_1.ERROR_INVALID_MESSAGE_FORMAT);
+        }
+        data = _message;
+    }
+    if (!data) {
+        throw new common_1.BadRequestException(constants_1.ERROR_INVALID_MESSAGE_FORMAT);
     }
     return {
         data,
@@ -77,10 +92,36 @@ function decodeMessage(message) {
         raw: message,
     };
 }
+function isDecodedMessage(message) {
+    return "raw" in message;
+}
+function isTaskMessage(message) {
+    if (!message) {
+        return false;
+    }
+    const keys = Object.keys(message);
+    return keys.length <= 3 && keys.includes("name") && keys.includes("headers");
+}
+function isMessage(message) {
+    if (!message) {
+        return false;
+    }
+    const keys = Object.keys(message);
+    return keys.length <= 3 && keys.includes("name");
+}
 function getMessageId(raw) {
-    return raw.messageId ?? raw.headers?.["x-cloudtasks-taskname"] ?? "";
+    if (!raw) {
+        return "";
+    }
+    if ("messageId" in raw) {
+        return raw.messageId ?? "";
+    }
+    if ("headers" in raw && raw.headers?.["x-cloudtasks-taskname"]) {
+        return raw.headers["x-cloudtasks-taskname"];
+    }
+    return "";
 }
-function decodeData(data) {
+function decodeData(data, reviver) {
     if (!data) {
         throw new common_1.BadRequestException(constants_1.ERROR_INVALID_MESSAGE_FORMAT);
     }
@@ -95,7 +136,7 @@ function decodeData(data) {
     }
     try {
         if (typeof data === "string") {
-            return (0, exports.parseJSON)(data);
+            return (0, exports.parseJSON)(data, reviver);
         }
         return data;
     }

package/dist/worker.service.d.ts

@@ -20,5 +20,4 @@ export declare class QueueWorkerService {
     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

@@ -38,7 +38,9 @@ let QueueWorkerService = class QueueWorkerService {
         _QueueWorkerService__allWorkers.set(this, void 0);
     }
     async execute(meessage) {
-        const decodedMessage = this.isDecodedMessage(meessage) ? meessage : (0, util_1.decodeMessage)(meessage);
+        const decodedMessage = (0, util_1.isDecodedMessage)(meessage)
+            ? meessage
+            : (0, util_1.decodeMessage)(meessage, this.options.extraConfig?.parseReviver);
         if (this.options.throwModuleError && !decodedMessage.data.name) {
             throw new common_1.BadRequestException(constants_1.ERROR_QUEUE_WORKER_NAME_NOT_FOUND);
         }
@@ -53,7 +55,9 @@ let QueueWorkerService = class QueueWorkerService {
         return results;
     }
     getWorkers(meessage) {
-        const decodedMessage = this.isDecodedMessage(meessage) ? meessage : (0, util_1.decodeMessage)(meessage);
+        const decodedMessage = (0, util_1.isDecodedMessage)(meessage)
+            ? meessage
+            : (0, util_1.decodeMessage)(meessage, this.options.extraConfig?.parseReviver);
         if (!decodedMessage.data.name) {
             return [];
         }
@@ -61,9 +65,6 @@ let QueueWorkerService = class QueueWorkerService {
             .filter((worker) => decodedMessage.data.name === worker.name)
             .map((metadata) => new worker_1.Worker(decodedMessage, metadata, this.options));
     }
-    isDecodedMessage(message) {
-        return "raw" in message;
-    }
 };
 exports.QueueWorkerService = QueueWorkerService;
 _QueueWorkerService__allWorkers = new WeakMap();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@anchan828/nest-cloud-run-queue-worker",
-  "version": "3.1.1",
+  "version": "3.1.3",
   "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.1.1"
+    "@anchan828/nest-cloud-run-queue-common": "^3.1.3"
   },
   "devDependencies": {
     "@nestjs/common": "10.3.10",
@@ -46,5 +46,5 @@
     "access": "public"
   },
   "packageManager": "npm@10.8.2",
-  "gitHead": "aa316926176b40816565704e5372ceb0d3938543"
+  "gitHead": "c33cfa67028e79e9bf101108d7392e73ba26edca"
 }