@anchan828/nest-cloud-run-queue-worker 2.2.0 → 2.3.0

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 {
@@ -51,6 +51,24 @@ export declare enum QueueWorkerProcessorStatus {
 export type QueueWorkerExtraConfig = {
     preProcessor?: (name: string, ...args: Parameters<QueueWorkerProcessor>) => (QueueWorkerProcessorStatus | undefined | void) | Promise<QueueWorkerProcessorStatus | undefined | void>;
     postProcessor?: (name: string, ...args: Parameters<QueueWorkerProcessor>) => void | Promise<void>;
+    /**
+     * Exceptions thrown in the processor do not reach the top level and are not detected by the application. If you want to do something with processor exceptions, use this property.
+     * @example
+     * ```ts
+     * catchProcessorException: (error: Error) => {
+     *   captureException(error); // Sentry
+     * }
+     * ```
+     *
+     * @example
+     * ```ts
+     * catchProcessorException: async (error: Error) => {
+     *  // You can throw errors and let them reach the top level. Use an ExceptionFilter or similar to handle them appropriately.
+     *  throw error;
+     * }
+     * ```
+     */
+    catchProcessorException?: <T extends Error = Error>(error: T, raw: QueueWorkerRawMessage) => void | Promise<void>;
 };
 export interface QueueWorkerDecoratorArgs {
     names: QueueWorkerName[];
@@ -61,6 +79,10 @@ export interface QueueWorkerDecoratorArgs {
      * @memberof QueueWorkerDecoratorArgs
      */
     priority: number;
+    /**
+     * If you want to disable the worker, set it to false. Defaults to true.
+     */
+    enabled?: boolean;
 }
 export interface QueueWorkerProcessDecoratorArgs {
     /**
@@ -70,6 +92,10 @@ export interface QueueWorkerProcessDecoratorArgs {
      * @memberof QueueWorkerProcessDecoratorArgs
      */
     priority: number;
+    /**
+     * If you want to disable the process, set it to false. Defaults to true.
+     */
+    enabled?: boolean;
 }
 export type QueueWorkerRawMessage<T = any> = {
     readonly data?: string | null | Message<T>;
@@ -95,3 +121,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. Defaults to true.
+     */
+    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. Defaults to true.
+     */
+    enabled?: boolean;
+}

package/dist/worker.service.js

@@ -82,6 +82,7 @@ let QueueWorkerService = class QueueWorkerService {
             }
             catch (error) {
                 this.logger.error(error.message);
+                await this.options.extraConfig?.catchProcessorException?.(error, raw);
             }
         }
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@anchan828/nest-cloud-run-queue-worker",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "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.2.0"
+    "@anchan828/nest-cloud-run-queue-common": "^2.3.0"
   },
   "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": "9e50ec5859b0fb64fbcd5c19f3d13605d22850c8"
+  "gitHead": "24cf62975961ff44cd62d00128a7510a771a4e8f"
 }