@midwayjs/bull 3.0.3 → 3.0.5

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

@@ -2,10 +2,14 @@ export declare const bull: {
     defaultQueueOptions: {
         prefix: string;
     };
+    defaultJobOptions: {
+        removeOnSuccess: boolean;
+        removeOnFail: number;
+    };
+    defaultConcurrency: number;
+    clearRepeatJobWhenStart: boolean;
     contextLoggerApplyLogger: string;
     contextLoggerFormat: (info: any) => string;
-    defaultConcurrency: number;
-    clearJobWhenStart: boolean;
 };
 export declare const midwayLogger: {
     clients: {

package/dist/config/config.default.js

@@ -3,15 +3,19 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.midwayLogger = exports.bull = void 0;
 exports.bull = {
     defaultQueueOptions: {
-        prefix: 'midway-task',
+        prefix: '{midway-bull}',
     },
+    defaultJobOptions: {
+        removeOnSuccess: true,
+        removeOnFail: 10,
+    },
+    defaultConcurrency: 1,
+    clearRepeatJobWhenStart: true,
     contextLoggerApplyLogger: 'bullLogger',
     contextLoggerFormat: info => {
         const { jobId, from } = info.ctx;
         return `${info.timestamp} ${info.LEVEL} ${info.pid} [${jobId} ${from.name}}] ${info.message}`;
     },
-    defaultConcurrency: 1,
-    clearJobWhenStart: true,
 };
 exports.midwayLogger = {
     clients: {

package/dist/configuration.js

@@ -38,7 +38,7 @@ __decorate([
 ], BullConfiguration.prototype, "init", null);
 BullConfiguration = __decorate([
     (0, decorator_1.Configuration)({
-        namespace: 'task',
+        namespace: 'bull',
         importConfigs: [
             {
                 default: DefaultConfig,

package/dist/decorator.js

@@ -26,44 +26,4 @@ function InjectQueue(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

@@ -10,7 +10,7 @@ export declare class BullQueue extends Bull implements IQueue<Job> {
 export declare class BullFramework extends BaseFramework<Application, Context, any> implements IQueueManager<BullQueue, Job> {
     private bullDefaultQueueConfig;
     private bullDefaultConcurrency;
-    private bullClearJobWhenStart;
+    private bullClearRepeatJobWhenStart;
     private queueMap;
     applicationInitialize(options: IMidwayBootstrapOptions): Promise<void>;
     configure(): any;
@@ -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

@@ -32,7 +32,7 @@ let BullFramework = class BullFramework extends core_1.BaseFramework {
         this.app = {};
         this.bullDefaultQueueConfig = this.configService.getConfiguration('bull.defaultQueueOptions');
         this.bullDefaultConcurrency = this.configService.getConfiguration('bull.defaultConcurrency');
-        this.bullClearJobWhenStart = this.configService.getConfiguration('bull.bullClearJobWhenStart');
+        this.bullClearRepeatJobWhenStart = this.configService.getConfiguration('bull.clearRepeatJobWhenStart');
     }
     configure() {
         return this.configService.getConfiguration('bull');
@@ -45,10 +45,13 @@ let BullFramework = class BullFramework extends core_1.BaseFramework {
         const processorModules = (0, decorator_1.listModule)(constants_1.BULL_PROCESSOR_KEY);
         for (const mod of processorModules) {
             const options = (0, decorator_1.getClassMetadata)(constants_1.BULL_PROCESSOR_KEY, mod);
-            this.ensureQueue(options.queueName);
-            // clear old job when start
-            if (this.bullClearJobWhenStart) {
-                await this.queueMap.get(options.queueName).obliterate({ force: true });
+            const currentQueue = this.ensureQueue(options.queueName);
+            // clear old repeat job when start
+            if (this.bullClearRepeatJobWhenStart) {
+                const jobs = await currentQueue.getRepeatableJobs();
+                for (const job of jobs) {
+                    await currentQueue.removeRepeatableByKey(job.key);
+                }
             }
             await this.addProcessor(mod, options.queueName, options.concurrency);
             if ((_a = options.jobOptions) === null || _a === void 0 ? void 0 : _a.repeat) {
@@ -76,6 +79,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) => {

package/index.d.ts

@@ -8,7 +8,7 @@ declare module '@midwayjs/core/dist/interface' {
       defaultQueueOptions?: bull.QueueOptions;
       defaultJobOptions?: bull.JobOptions;
       defaultConcurrency?: number;
-      clearJobWhenStart?: boolean;
+      clearRepeatJobWhenStart?: boolean;
     };
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midwayjs/bull",
-  "version": "3.0.3",
+  "version": "3.0.5",
   "description": "midway component for bull",
   "main": "dist/index.js",
   "typings": "index.d.ts",