@midwayjs/bull 3.0.4 → 3.6.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2013 - Now midwayjs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,126 +1,9 @@
 # @midwayjs/bull
 
-## 简介
+this is a sub package for midway.
 
-midwayjs/bull 是为了能解决任务系列的模块，例如分布式定时任务、延迟任务调度。例如订单2小时后失效、每日定时的数据处理等工作。
+Document: [https://midwayjs.org](https://midwayjs.org)
 
-## 安装方法
+## License
 
-```bash
-tnpm install @midwayjs/bull -S
-```
-
-## 使用方法
-
-在Configuration.ts 导入组件
-
-```typescript
-
-import * as bull from '@midwayjs/bull';
-
-@Configuration({
-  imports: [bull],
-  importConfigs: [
-    join(__dirname, 'config')
-  ]
-})
-export class AutoConfiguration{
-}
-```
-
-配置：
-
-在 config.default.ts 文件中配置对应的模块信息：
-
-```typescript
-export const bull = {
-  defaultQueueOptions: {
-    redis: `redis://127.0.0.1:6379`,
-    prefix: 'midway-task',
-  }
-  defaultJobOptions: {
-    repeat: {
-      tz: "Asia/Shanghai"
-    }
-  }
-}
-```
-
-## 业务代码编写方式
-
-定义一个任务处理器
-
-```typescript
-@Processor('test')
-export class UserServiceProcessor {
-  @Inject()
-  helloService: HelloService;
-
-  async execute(data: any) {
-    console.log(this.helloService.getName());
-
-    // console data
-    console.log(data);
-  }
-}
-```
-
-在需要的地方手动执行
-
-```typescript
-import * as bull from '@midwayjs/bull';
-
-@Configuration({
-  imports: [bull],
-  importConfigs: [
-    join(__dirname, 'config')
-  ]
-})
-export class AutoConfiguration {
-  @Inject()
-  bullFramework: bull.BullFramework;
-
-  async onServerReady() {
-    bullFramework.getQueue('test').runJob({
-      name: 'test'
-    });
-  }
-}
-```
-
-
-定时执行任务：
-
-```typescript
-@Processor('test', {
-  repeat: {
-    cron: '0 0 0 * * *'
-  }
-})
-export class UserServiceProcessor {
-  @Inject()
-  helloService: HelloService;
-
-  async execute(data: any) {
-    console.log(this.helloService.getName());
-
-    // console data
-    console.log(data);
-  }
-}
-```
-
-## 其他
-
-关于task任务的配置：
-```
-*    *    *    *    *    *
-┬    ┬    ┬    ┬    ┬    ┬
-│    │    │    │    │    |
-│    │    │    │    │    └ day of week (0 - 7) (0 or 7 is Sun)
-│    │    │    │    └───── month (1 - 12)
-│    │    │    └────────── day of month (1 - 31)
-│    │    └─────────────── hour (0 - 23)
-│    └──────────────────── minute (0 - 59)
-└───────────────────────── second (0 - 59, optional)
-```
+[MIT]((http://github.com/midwayjs/midway/blob/master/LICENSE))

package/dist/config/config.default.d.ts

@@ -3,7 +3,7 @@ export declare const bull: {
         prefix: string;
     };
     defaultJobOptions: {
-        removeOnSuccess: boolean;
+        removeOnSuccess: number;
         removeOnFail: number;
     };
     defaultConcurrency: number;

package/dist/config/config.default.js

@@ -3,10 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.midwayLogger = exports.bull = void 0;
 exports.bull = {
     defaultQueueOptions: {
-        prefix: '${midway-bull}',
+        prefix: '{midway-bull}',
     },
     defaultJobOptions: {
-        removeOnSuccess: true,
+        removeOnSuccess: 3,
         removeOnFail: 10,
     },
     defaultConcurrency: 1,

package/dist/configuration.d.ts

@@ -1,5 +1,5 @@
-import { BullFramework } from './framework';
 import { MidwayDecoratorService } from '@midwayjs/core';
+import { BullFramework } from './framework';
 export declare class BullConfiguration {
     framework: BullFramework;
     decoratorService: MidwayDecoratorService;

package/dist/configuration.js

@@ -10,10 +10,9 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BullConfiguration = void 0;
-const decorator_1 = require("@midwayjs/decorator");
+const core_1 = require("@midwayjs/core");
 const DefaultConfig = require("./config/config.default");
 const framework_1 = require("./framework");
-const core_1 = require("@midwayjs/core");
 const constants_1 = require("./constants");
 let BullConfiguration = class BullConfiguration {
     async init() {
@@ -23,22 +22,22 @@ let BullConfiguration = class BullConfiguration {
     }
 };
 __decorate([
-    (0, decorator_1.Inject)(),
+    (0, core_1.Inject)(),
     __metadata("design:type", framework_1.BullFramework)
 ], BullConfiguration.prototype, "framework", void 0);
 __decorate([
-    (0, decorator_1.Inject)(),
+    (0, core_1.Inject)(),
     __metadata("design:type", core_1.MidwayDecoratorService)
 ], BullConfiguration.prototype, "decoratorService", void 0);
 __decorate([
-    (0, decorator_1.Init)(),
+    (0, core_1.Init)(),
     __metadata("design:type", Function),
     __metadata("design:paramtypes", []),
     __metadata("design:returntype", Promise)
 ], BullConfiguration.prototype, "init", null);
 BullConfiguration = __decorate([
-    (0, decorator_1.Configuration)({
-        namespace: 'task',
+    (0, core_1.Configuration)({
+        namespace: 'bull',
         importConfigs: [
             {
                 default: DefaultConfig,

package/dist/decorator.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InjectQueue = exports.Processor = void 0;
-const decorator_1 = require("@midwayjs/decorator");
+const core_1 = require("@midwayjs/core");
 const constants_1 = require("./constants");
 function Processor(queueName, concurrency, jobOptions) {
     return function (target) {
@@ -9,61 +9,21 @@ function Processor(queueName, concurrency, jobOptions) {
             jobOptions = concurrency;
             concurrency = 1;
         }
-        (0, decorator_1.saveModule)(constants_1.BULL_PROCESSOR_KEY, target);
-        (0, decorator_1.saveClassMetadata)(constants_1.BULL_PROCESSOR_KEY, {
+        (0, core_1.saveModule)(constants_1.BULL_PROCESSOR_KEY, target);
+        (0, core_1.saveClassMetadata)(constants_1.BULL_PROCESSOR_KEY, {
             queueName,
             concurrency,
             jobOptions,
         }, target);
-        (0, decorator_1.Provide)()(target);
-        (0, decorator_1.Scope)(decorator_1.ScopeEnum.Request)(target);
+        (0, core_1.Provide)()(target);
+        (0, core_1.Scope)(core_1.ScopeEnum.Request)(target);
     };
 }
 exports.Processor = Processor;
 function InjectQueue(queueName) {
-    return (0, decorator_1.createCustomPropertyDecorator)(constants_1.BULL_QUEUE_KEY, {
+    return (0, core_1.createCustomPropertyDecorator)(constants_1.BULL_QUEUE_KEY, {
         queueName,
     });
 }
 exports.InjectQueue = InjectQueue;
-//
-// export function Queue(queueOptions?: QueueOptions): ClassDecorator;
-// export function Queue(
-//   queueName?: string,
-//   queueOptions?: QueueOptions
-// ): ClassDecorator;
-// export function Queue(
-//   queueName?: string,
-//   concurrency?: number,
-//   queueOptions?: QueueOptions
-// ): ClassDecorator;
-// export function Queue(
-//   queueName?: any,
-//   concurrency?: any,
-//   queueOptions?: QueueOptions
-// ): ClassDecorator {
-//   return function (target) {
-//     if (typeof queueName !== 'string') {
-//       queueOptions = queueName;
-//       queueName = `${target.name}:execute`;
-//       concurrency = 1;
-//     }
-//     if (typeof concurrency !== 'number') {
-//       queueOptions = concurrency;
-//       concurrency = 1;
-//     }
-//     saveModule(BULL_QUEUE_KEY, target);
-//     saveClassMetadata(
-//       BULL_QUEUE_KEY,
-//       {
-//         queueName,
-//         queueOptions,
-//         concurrency,
-//       },
-//       target
-//     );
-//     Provide()(target);
-//     Scope(ScopeEnum.Singleton)(target);
-//   };
-// }
 //# sourceMappingURL=decorator.js.map

package/dist/framework.d.ts

@@ -20,6 +20,7 @@ export declare class BullFramework extends BaseFramework<Application, Context, a
     createQueue(name: string, queueOptions?: QueueOptions): BullQueue;
     getQueue(name: string): BullQueue;
     ensureQueue(name: string): BullQueue;
+    getQueueList(): BullQueue[];
     addProcessor(processor: new (...args: any[]) => IProcessor, queueName: string | BullQueue, concurrency?: number): Promise<void>;
     runJob(queueName: string, jobData: any, options?: JobOptions): Promise<void>;
     getJob(queueName: string, jobName: string): Promise<Job>;

package/dist/framework.js

@@ -8,7 +8,6 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BullFramework = exports.BullQueue = void 0;
 const core_1 = require("@midwayjs/core");
-const decorator_1 = require("@midwayjs/decorator");
 const Bull = require("bull");
 const constants_1 = require("./constants");
 class BullQueue extends Bull {
@@ -42,9 +41,9 @@ let BullFramework = class BullFramework extends core_1.BaseFramework {
     }
     async run() {
         var _a;
-        const processorModules = (0, decorator_1.listModule)(constants_1.BULL_PROCESSOR_KEY);
+        const processorModules = (0, core_1.listModule)(constants_1.BULL_PROCESSOR_KEY);
         for (const mod of processorModules) {
-            const options = (0, decorator_1.getClassMetadata)(constants_1.BULL_PROCESSOR_KEY, mod);
+            const options = (0, core_1.getClassMetadata)(constants_1.BULL_PROCESSOR_KEY, mod);
             const currentQueue = this.ensureQueue(options.queueName);
             // clear old repeat job when start
             if (this.bullClearRepeatJobWhenStart) {
@@ -79,6 +78,9 @@ let BullFramework = class BullFramework extends core_1.BaseFramework {
         }
         return this.queueMap.get(name);
     }
+    getQueueList() {
+        return Array.from(this.queueMap.values());
+    }
     async addProcessor(processor, queueName, concurrency) {
         const queue = typeof queueName === 'string' ? this.queueMap.get(queueName) : queueName;
         queue.process(concurrency !== null && concurrency !== void 0 ? concurrency : this.bullDefaultConcurrency, async (job) => {
@@ -88,9 +90,15 @@ let BullFramework = class BullFramework extends core_1.BaseFramework {
                 from: processor,
             });
             ctx.logger.info(`start process job ${job.id} from ${processor.name}`);
+            const isPassed = await this.app
+                .getFramework()
+                .runGuard(ctx, processor, 'execute');
+            if (!isPassed) {
+                throw new core_1.MidwayInvokeForbiddenError('execute', processor);
+            }
             const service = await ctx.requestContext.getAsync(processor);
             const fn = await this.applyMiddleware(async (ctx) => {
-                return await decorator_1.Utils.toAsyncFunction(service.execute.bind(service))(job.data, job);
+                return await core_1.Utils.toAsyncFunction(service.execute.bind(service))(job.data, job);
             });
             try {
                 const result = await Promise.resolve(await fn(ctx));
@@ -117,7 +125,7 @@ let BullFramework = class BullFramework extends core_1.BaseFramework {
     }
 };
 BullFramework = __decorate([
-    (0, decorator_1.Framework)()
+    (0, core_1.Framework)()
 ], BullFramework);
 exports.BullFramework = BullFramework;
 //# sourceMappingURL=framework.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midwayjs/bull",
-  "version": "3.0.4",
+  "version": "3.6.0",
   "description": "midway component for bull",
   "main": "dist/index.js",
   "typings": "index.d.ts",
@@ -24,15 +24,15 @@
   ],
   "license": "MIT",
   "devDependencies": {
-    "@midwayjs/core": "^3.4.13",
-    "@midwayjs/decorator": "^3.4.11",
-    "@midwayjs/mock": "^3.4.13"
+    "@midwayjs/core": "^3.6.0",
+    "@midwayjs/mock": "^3.6.0"
   },
   "dependencies": {
-    "bull": "4.8.5",
-    "@types/bull": "3.15.9"
+    "@types/bull": "3.15.9",
+    "bull": "4.10.0"
   },
   "engines": {
     "node": ">=12"
-  }
+  },
+  "gitHead": "22643b0e8519766bb7c68b975930199fc136336e"
 }