@anchan828/nest-cloud-run-queue-worker 2.1.19 → 2.2.1

package/dist/decorators.d.ts

@@ -1,4 +1,5 @@
 import { QueueWorkerName } from "@anchan828/nest-cloud-run-queue-common";
+import { QueueWorkerOptions, QueueWorkerProcessOptions } from "./interfaces";
 /**
  * Define worker
  *
@@ -9,6 +10,7 @@ import { QueueWorkerName } from "@anchan828/nest-cloud-run-queue-common";
  */
 export declare function QueueWorker(name: QueueWorkerName, priority?: number): ClassDecorator;
 export declare function QueueWorker(names: QueueWorkerName[], priority?: number): ClassDecorator;
+export declare function QueueWorker(options: QueueWorkerOptions): ClassDecorator;
 /**
  * Define worker processor
  *
@@ -17,3 +19,4 @@ export declare function QueueWorker(names: QueueWorkerName[], priority?: number)
  * @returns {MethodDecorator}
  */
 export declare function QueueWorkerProcess(priority?: number): MethodDecorator;
+export declare function QueueWorkerProcess(options?: QueueWorkerProcessOptions): MethodDecorator;

package/dist/decorators.js

@@ -4,19 +4,28 @@ exports.QueueWorker = QueueWorker;
 exports.QueueWorkerProcess = QueueWorkerProcess;
 const common_1 = require("@nestjs/common");
 const constants_1 = require("./constants");
-function QueueWorker(names, priority = 0) {
+function QueueWorker(nameOrOptions, priority = 0) {
+    if (Array.isArray(nameOrOptions)) {
+        return (0, common_1.SetMetadata)(constants_1.QUEUE_WORKER_DECORATOR, {
+            names: nameOrOptions,
+            priority,
+        });
+    }
+    if (typeof nameOrOptions === "string") {
+        return (0, common_1.SetMetadata)(constants_1.QUEUE_WORKER_DECORATOR, {
+            names: [nameOrOptions],
+            priority,
+        });
+    }
     return (0, common_1.SetMetadata)(constants_1.QUEUE_WORKER_DECORATOR, {
-        names: Array.isArray(names) ? names : [names],
-        priority,
+        enabled: nameOrOptions.enabled,
+        names: Array.isArray(nameOrOptions.name) ? nameOrOptions.name : [nameOrOptions.name],
+        priority: nameOrOptions.priority || 0,
     });
 }
-/**
- * Define worker processor
- *
- * @export
- * @param {number} [priority=0] Highest priority is 0, and lower the larger integer you use.
- * @returns {MethodDecorator}
- */
-function QueueWorkerProcess(priority = 0) {
-    return (0, common_1.SetMetadata)(constants_1.QUEUE_WORKER_PROCESS_DECORATOR, { priority });
+function QueueWorkerProcess(priorityOrOptions) {
+    const options = typeof priorityOrOptions === "number"
+        ? { priority: priorityOrOptions }
+        : Object.assign({ priority: 0 }, priorityOrOptions);
+    return (0, common_1.SetMetadata)(constants_1.QUEUE_WORKER_PROCESS_DECORATOR, options);
 }

package/dist/explorer.service.js

@@ -33,6 +33,9 @@ let QueueWorkerExplorerService = class QueueWorkerExplorerService {
             .filter((instanceWrapper) => instanceWrapper.instance?.constructor)) {
             const args = Reflect.getMetadata(constants_1.QUEUE_WORKER_DECORATOR, classInstanceWrapper.instance.constructor);
             if (args && Array.isArray(args.names)) {
+                if (args.enabled === false) {
+                    continue;
+                }
                 for (const name of args.names) {
                     metadata.push({
                         instance: classInstanceWrapper.instance,
@@ -49,9 +52,12 @@ let QueueWorkerExplorerService = class QueueWorkerExplorerService {
         const metadata = [];
         const instance = worker.instance;
         const prototype = Object.getPrototypeOf(instance);
-        for (const methodName of this.metadataScanner.getAllFilteredMethodNames(prototype)) {
+        for (const methodName of this.metadataScanner.getAllMethodNames(prototype)) {
             const args = Reflect.getMetadata(constants_1.QUEUE_WORKER_PROCESS_DECORATOR, prototype[methodName]);
             if (args) {
+                if (args.enabled === false) {
+                    continue;
+                }
                 metadata.push({
                     priority: args.priority || 0,
                     processor: prototype[methodName].bind(instance),
@@ -64,5 +70,6 @@ let QueueWorkerExplorerService = class QueueWorkerExplorerService {
 exports.QueueWorkerExplorerService = QueueWorkerExplorerService;
 exports.QueueWorkerExplorerService = QueueWorkerExplorerService = __decorate([
     (0, common_1.Injectable)(),
-    __metadata("design:paramtypes", [core_1.DiscoveryService, metadata_scanner_1.MetadataScanner])
+    __metadata("design:paramtypes", [core_1.DiscoveryService,
+        metadata_scanner_1.MetadataScanner])
 ], QueueWorkerExplorerService);

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 export { ALL_WORKERS_QUEUE_WORKER_NAME as ALL_QUEUE_WORKERS, UNHANDLED_QUEUE_WORKER_NAME as UNHANDLED_QUEUE_WORKER, } from "./constants";
 export { QueueWorker, QueueWorkerProcess } from "./decorators";
-export { QueueWorkerModuleAsyncOptions, QueueWorkerModuleOptions, QueueWorkerModuleOptionsFactory, QueueWorkerProcessor, QueueWorkerProcessorStatus, QueueWorkerExtraConfig, QueueWorkerRawMessage, QueueWorkerControllerInterface, QueueWorkerControllerMetadata, QueueWorkerReceivedMessage, QueueWorkerDecodedMessage, } from "./interfaces";
+export { QueueWorkerControllerInterface, QueueWorkerControllerMetadata, QueueWorkerDecodedMessage, QueueWorkerExtraConfig, QueueWorkerModuleAsyncOptions, QueueWorkerModuleOptions, QueueWorkerModuleOptionsFactory, QueueWorkerOptions, QueueWorkerProcessOptions, QueueWorkerProcessor, QueueWorkerProcessorStatus, QueueWorkerRawMessage, QueueWorkerReceivedMessage, } from "./interfaces";
 export { QueueWorkerModule } from "./worker.module";
 export { QueueWorkerService } from "./worker.service";

package/dist/interfaces.d.ts

@@ -1,4 +1,4 @@
-import { QueueWorkerName, ModuleAsyncOptions, ModuleOptions, ModuleOptionsFactory, Message } from "@anchan828/nest-cloud-run-queue-common";
+import { Message, ModuleAsyncOptions, ModuleOptions, ModuleOptionsFactory, QueueWorkerName } from "@anchan828/nest-cloud-run-queue-common";
 import { RequestMappingMetadata } from "@nestjs/common";
 import { Injectable } from "@nestjs/common/interfaces";
 export interface QueueWorkerModuleOptions extends ModuleOptions {
@@ -61,6 +61,10 @@ export interface QueueWorkerDecoratorArgs {
      * @memberof QueueWorkerDecoratorArgs
      */
     priority: number;
+    /**
+     * If you want to disable the worker, set it to false.
+     */
+    enabled?: boolean;
 }
 export interface QueueWorkerProcessDecoratorArgs {
     /**
@@ -70,6 +74,10 @@ export interface QueueWorkerProcessDecoratorArgs {
      * @memberof QueueWorkerProcessDecoratorArgs
      */
     priority: number;
+    /**
+     * If you want to disable the process, set it to false.
+     */
+    enabled?: boolean;
 }
 export type QueueWorkerRawMessage<T = any> = {
     readonly data?: string | null | Message<T>;
@@ -95,3 +103,27 @@ export interface QueueWorkerControllerMetadata extends RequestMappingMetadata {
 export interface QueueWorkerControllerInterface {
     execute(body: QueueWorkerReceivedMessage, headers: Record<string, string>): Promise<void>;
 }
+export interface QueueWorkerOptions {
+    /**
+     * Worker name. If you want to define multiple names, use an array.
+     */
+    name: QueueWorkerName | QueueWorkerName[];
+    /**
+     * Highest priority is 0, and lower the larger integer you use.
+     */
+    priority?: number;
+    /**
+     * If you want to disable the worker, set it to false.
+     */
+    enabled?: boolean;
+}
+export interface QueueWorkerProcessOptions {
+    /**
+     * Highest priority is 0, and lower the larger integer you use.
+     */
+    priority?: number;
+    /**
+     * If you want to disable the process, set it to false.
+     */
+    enabled?: boolean;
+}

package/dist/util.d.ts

@@ -1,4 +1,5 @@
 import { Message } from "@anchan828/nest-cloud-run-queue-common";
+import { QueueWorkerDecodedMessage, QueueWorkerRawMessage } from "./interfaces";
 /**
  * parse json string to javascript object.
  * JSON.parse has receiver for Date.parse.
@@ -24,3 +25,4 @@ export declare function sortByPriority<T extends {
  * @return {*}  {boolean}
  */
 export declare function isBase64(value?: string | null | Message): value is string;
+export declare function decodeMessage<T = any>(message: QueueWorkerRawMessage | Message): QueueWorkerDecodedMessage<T>;

package/dist/util.js

@@ -3,6 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseJSON = void 0;
 exports.sortByPriority = sortByPriority;
 exports.isBase64 = isBase64;
+exports.decodeMessage = decodeMessage;
+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$/;
 /**
  * parse json string to javascript object.
@@ -57,3 +60,45 @@ function isBase64(value) {
     const firstPaddingChar = value.indexOf("=");
     return (firstPaddingChar === -1 || firstPaddingChar === len - 1 || (firstPaddingChar === len - 2 && value[len - 1] === "="));
 }
+function decodeMessage(message) {
+    let data;
+    if (isBase64(message.data)) {
+        // pubsub
+        data = decodeData(message.data);
+    }
+    else {
+        // tasks / http
+        data = message;
+    }
+    if (!data.name) {
+        throw new common_1.BadRequestException(constants_1.ERROR_QUEUE_WORKER_NAME_NOT_FOUND);
+    }
+    return {
+        data,
+        headers: "headers" in message ? message.headers : undefined,
+        raw: message,
+    };
+}
+function decodeData(data) {
+    if (!data) {
+        throw new common_1.BadRequestException(constants_1.ERROR_INVALID_MESSAGE_FORMAT);
+    }
+    if (Buffer.isBuffer(data)) {
+        data = data.toString();
+    }
+    if (data instanceof Uint8Array) {
+        data = new TextDecoder("utf8").decode(data);
+    }
+    if (isBase64(data)) {
+        data = Buffer.from(data, "base64").toString();
+    }
+    try {
+        if (typeof data === "string") {
+            return (0, exports.parseJSON)(data);
+        }
+        return data;
+    }
+    catch {
+        throw new common_1.BadRequestException(constants_1.ERROR_INVALID_MESSAGE_FORMAT);
+    }
+}

package/dist/worker.controller.js

@@ -23,6 +23,7 @@ function getWorkerController(metadata) {
             this.service = service;
         }
         async execute(body, headers) {
+            this.service.execute({});
             await this.service.execute({ ...body.message, headers });
         }
     };

package/dist/worker.service.d.ts

@@ -1,17 +1,21 @@
 import { Logger } from "@nestjs/common";
-import { QueueWorkerDecodedMessage, QueueWorkerModuleOptions } from "./interfaces";
+import { Message } from "@anchan828/nest-cloud-run-queue-common";
 import { QueueWorkerExplorerService } from "./explorer.service";
-import { QueueWorkerRawMessage } from "./interfaces";
+import { QueueWorkerDecodedMessage, QueueWorkerModuleOptions, QueueWorkerRawMessage } from "./interfaces";
 export declare class QueueWorkerService {
     #private;
     private readonly options;
     private readonly logger;
     private readonly explorerService;
     constructor(options: QueueWorkerModuleOptions, logger: Logger, explorerService: QueueWorkerExplorerService);
-    execute(rawMessage: QueueWorkerRawMessage | QueueWorkerDecodedMessage): Promise<void>;
-    decodeMessage<T = any>(message: QueueWorkerRawMessage): QueueWorkerDecodedMessage<T>;
+    execute<T = any>(meessage: Message<T>): Promise<void>;
+    execute<T = any>(meessage: QueueWorkerDecodedMessage<T>): Promise<void>;
+    execute<T = any>(meessage: QueueWorkerRawMessage<T>): Promise<void>;
+    /**
+     * @deprecated Use `decodeMessage` function instead.
+     */
+    decodeMessage<T = any>(message: QueueWorkerRawMessage | Message): QueueWorkerDecodedMessage<T>;
     private runWorkers;
     private isDecodedMessage;
-    private decodeData;
     private execProcessor;
 }

package/dist/worker.service.js

@@ -38,28 +38,14 @@ let QueueWorkerService = class QueueWorkerService {
         this.explorerService = explorerService;
         _QueueWorkerService__allWorkers.set(this, void 0);
     }
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
-    async execute(rawMessage) {
-        await this.runWorkers(this.isDecodedMessage(rawMessage) ? rawMessage : this.decodeMessage(rawMessage));
+    async execute(meessage) {
+        await this.runWorkers(this.isDecodedMessage(meessage) ? meessage : (0, util_1.decodeMessage)(meessage));
     }
+    /**
+     * @deprecated Use `decodeMessage` function instead.
+     */
     decodeMessage(message) {
-        let data;
-        if ((0, util_1.isBase64)(message.data)) {
-            // pubsub
-            data = this.decodeData(message.data);
-        }
-        else {
-            // tasks / http
-            data = message;
-        }
-        if (!data.name) {
-            throw new common_1.BadRequestException(constants_1.ERROR_QUEUE_WORKER_NAME_NOT_FOUND);
-        }
-        return {
-            data,
-            headers: message.headers,
-            raw: message,
-        };
+        return (0, util_1.decodeMessage)(message);
     }
     async runWorkers(decodedMessage) {
         const maxRetryAttempts = this.options.maxRetryAttempts ?? 1;
@@ -86,30 +72,7 @@ let QueueWorkerService = class QueueWorkerService {
         await this.options.extraConfig?.postProcessor?.(decodedMessage.data.name, decodedMessage.data.data, decodedMessage.raw);
     }
     isDecodedMessage(message) {
-        return !!message.raw;
-    }
-    decodeData(data) {
-        if (!data) {
-            throw new common_1.BadRequestException(constants_1.ERROR_INVALID_MESSAGE_FORMAT);
-        }
-        if (Buffer.isBuffer(data)) {
-            data = data.toString();
-        }
-        if (data instanceof Uint8Array) {
-            data = new TextDecoder("utf8").decode(data);
-        }
-        if ((0, util_1.isBase64)(data)) {
-            data = Buffer.from(data, "base64").toString();
-        }
-        try {
-            if (typeof data === "string") {
-                return (0, util_1.parseJSON)(data);
-            }
-            return data;
-        }
-        catch {
-            throw new common_1.BadRequestException(constants_1.ERROR_INVALID_MESSAGE_FORMAT);
-        }
+        return "raw" in message;
     }
     async execProcessor(processor, maxRetryAttempts, data, raw) {
         for (let i = 0; i < maxRetryAttempts; i++) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@anchan828/nest-cloud-run-queue-worker",
-  "version": "2.1.19",
+  "version": "2.2.1",
   "description": "> TODO: description",
   "homepage": "https://github.com/anchan828/nest-cloud-run-queue/tree/master/packages/worker#readme",
   "bugs": {
@@ -33,10 +33,10 @@
     "watch": "tsc -w"
   },
   "dependencies": {
-    "@anchan828/nest-cloud-run-queue-common": "^2.1.19"
+    "@anchan828/nest-cloud-run-queue-common": "^2.2.1"
   },
   "devDependencies": {
-    "@nestjs/common": "10.3.9",
+    "@nestjs/common": "10.3.10",
     "rxjs": "7.8.1"
   },
   "peerDependencies": {
@@ -46,5 +46,5 @@
     "access": "public"
   },
   "packageManager": "npm@10.8.1",
-  "gitHead": "153d36da9db498fa40bc2cffd1a5a5b63451ecb6"
+  "gitHead": "882db718c2c146c2ec24b95462eccbad2cad2125"
 }