@hlw-midway/task 1.0.0

package/dist/base.d.ts

@@ -0,0 +1,43 @@
+import { Job, JobsOptions, Queue, QueueGetters, Worker } from 'bullmq';
+/**
+ * 队列基类
+ */
+export declare abstract class BaseHlwQueue {
+    /**
+     * @deprecated 将在后续版本废弃
+     */
+    queue: BaseHlwQueue;
+    getters: QueueGetters;
+    worker: Worker;
+    queueName: string;
+    metaQueue: Queue;
+    constructor();
+    data(job: Job, done: Function): Promise<void>;
+    /**
+     * 发送数据
+     * @param data
+     * @param opts
+     */
+    add(data: any, opts?: JobsOptions): Promise<Job<any, any, string>>;
+    /**
+     * 批量新增
+     * @param datas
+     * @param opts
+     */
+    addBulk(datas: any[], opts?: JobsOptions): Promise<Job<any, any, string>[]>;
+    defaultJobOptions(): JobsOptions;
+    repeat(): Promise<import("bullmq").Repeat>;
+    pause(): Promise<void>;
+    resume(): Promise<void>;
+    isPaused(): Promise<boolean>;
+    getJobSchedulers(start?: number, end?: number, asc?: boolean): Promise<import("bullmq").JobSchedulerJson<any>[]>;
+    removeJobScheduler(jobId: string): Promise<void>;
+    remove(jobId: string): Promise<number>;
+    drain(delayed?: boolean): Promise<void>;
+    clean(grace: number, limit: number, type?: 'completed' | 'wait' | 'active' | 'paused' | 'delayed' | 'failed'): Promise<string[]>;
+    obliterate(opts?: {
+        force?: boolean;
+        count?: number;
+    }): Promise<void>;
+    trimEvents(maxLength: number): Promise<number>;
+}

package/dist/base.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseHlwQueue = void 0;
+/**
+ * 队列基类
+ */
+class BaseHlwQueue {
+    constructor() {
+        this.queue = this;
+    }
+    // 数据
+    async data(job, done) { }
+    /**
+     * 发送数据
+     * @param data
+     * @param opts
+     */
+    async add(data, opts) {
+        return this.metaQueue.add(this.queueName, data, opts);
+    }
+    /**
+     * 批量新增
+     * @param datas
+     * @param opts
+     */
+    async addBulk(datas, opts) {
+        return this.metaQueue.addBulk(datas.map(data => {
+            return {
+                name: this.queueName,
+                data,
+                opts,
+            };
+        }));
+    }
+    defaultJobOptions() {
+        return this.metaQueue.defaultJobOptions;
+    }
+    async repeat() {
+        return this.metaQueue.repeat;
+    }
+    async pause() {
+        this.metaQueue.pause();
+    }
+    async resume() {
+        this.metaQueue.resume();
+    }
+    async isPaused() {
+        return this.metaQueue.isPaused();
+    }
+    async getJobSchedulers(start, end, asc) {
+        return this.metaQueue.getJobSchedulers(start, end, asc);
+    }
+    async removeJobScheduler(jobId) {
+        this.metaQueue.removeJobScheduler(jobId);
+    }
+    async remove(jobId) {
+        return this.metaQueue.remove(jobId);
+    }
+    async drain(delayed) {
+        this.metaQueue.drain(delayed);
+    }
+    async clean(grace, limit, type) {
+        return this.metaQueue.clean(grace, limit, type);
+    }
+    async obliterate(opts) {
+        this.metaQueue.obliterate(opts);
+    }
+    async trimEvents(maxLength) {
+        return this.metaQueue.trimEvents(maxLength);
+    }
+}
+exports.BaseHlwQueue = BaseHlwQueue;

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

@@ -0,0 +1,7 @@
+/**
+ * hlw的配置
+ */
+declare const _default: {
+    hlw: {};
+};
+export default _default;

package/dist/config/config.default.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * hlw的配置
+ */
+exports.default = {
+    hlw: {},
+};

package/dist/configuration.d.ts

@@ -0,0 +1,4 @@
+import { IMidwayContainer } from '@midwayjs/core';
+export declare class HlwTaskConfiguration {
+    onReady(container: IMidwayContainer): Promise<void>;
+}

package/dist/configuration.js

@@ -0,0 +1,29 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HlwTaskConfiguration = void 0;
+const core_1 = require("@midwayjs/core");
+const DefaultConfig = require("./config/config.default");
+const queue_1 = require("./queue");
+let HlwTaskConfiguration = class HlwTaskConfiguration {
+    async onReady(container) {
+        await container.getAsync(queue_1.HlwQueueHandle);
+        // TODO something
+    }
+};
+exports.HlwTaskConfiguration = HlwTaskConfiguration;
+exports.HlwTaskConfiguration = HlwTaskConfiguration = __decorate([
+    (0, core_1.Configuration)({
+        namespace: 'hlw:task',
+        importConfigs: [
+            {
+                default: DefaultConfig,
+            },
+        ],
+    })
+], HlwTaskConfiguration);

package/dist/decorator/queue.d.ts

@@ -0,0 +1,7 @@
+import { JobsOptions, WorkerOptions } from 'bullmq';
+export declare const HLW_TASK_KEY = "decorator:hlw:task";
+export declare function HlwQueue(config?: {
+    type?: "comm" | "getter" | "noworker" | "single";
+    queue?: JobsOptions;
+    worker?: Omit<WorkerOptions, "connection" | "prefix">;
+}): ClassDecorator;

package/dist/decorator/queue.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HLW_TASK_KEY = void 0;
+exports.HlwQueue = HlwQueue;
+const core_1 = require("@midwayjs/core");
+exports.HLW_TASK_KEY = 'decorator:hlw:task';
+function HlwQueue(config = { type: 'comm', queue: {}, worker: {} }) {
+    return (target) => {
+        // 将装饰的类，绑定到该装饰器，用于后续能获取到 class
+        (0, core_1.saveModule)(exports.HLW_TASK_KEY, target);
+        // 保存一些元数据信息，任意你希望存的东西
+        (0, core_1.saveClassMetadata)(exports.HLW_TASK_KEY, config, target);
+        // 指定 IoC 容器创建实例的作用域，这里注册为请求作用域，这样能取到 ctx
+        (0, core_1.Scope)(core_1.ScopeEnum.Singleton)(target);
+    };
+}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export { HlwTaskConfiguration as Configuration } from './configuration';
+export * from './base';
+export * from './queue';
+export * from './decorator/queue';

package/dist/index.js

@@ -0,0 +1,22 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Configuration = void 0;
+var configuration_1 = require("./configuration");
+Object.defineProperty(exports, "Configuration", { enumerable: true, get: function () { return configuration_1.HlwTaskConfiguration; } });
+__exportStar(require("./base"), exports);
+__exportStar(require("./queue"), exports);
+__exportStar(require("./decorator/queue"), exports);

package/dist/queue.d.ts

@@ -0,0 +1,29 @@
+import { ILogger, IMidwayApplication } from '@midwayjs/core';
+import { BaseHlwQueue } from './base';
+/**
+ * 任务队列
+ */
+export declare class HlwQueueHandle {
+    redisConfig: any;
+    coreLogger: ILogger;
+    app: IMidwayApplication;
+    redis: any;
+    init(): Promise<void>;
+    /**
+     * 扫描队列
+     */
+    scan(): Promise<void>;
+    /**
+     * 获得锁
+     * @param key 键
+     * @param expireTime 过期时间
+     * @returns
+     */
+    getLock(key: any, expireTime: any): Promise<boolean>;
+    /**
+     * 队列名称
+     * @param cls
+     * @param mod
+     */
+    createQueue(cls: BaseHlwQueue, mod: any): Promise<void>;
+}

package/dist/queue.js

@@ -0,0 +1,145 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HlwQueueHandle = void 0;
+const core_1 = require("@midwayjs/core");
+const bullmq_1 = require("bullmq");
+const queue_1 = require("./decorator/queue");
+const ioredis_1 = require("ioredis");
+/**
+ * 任务队列
+ */
+let HlwQueueHandle = class HlwQueueHandle {
+    async init() {
+        if (!this.redisConfig) {
+            this.coreLogger.error('@hlw-midway/task组件 redis未配置');
+        }
+        await this.scan();
+    }
+    /**
+     * 扫描队列
+     */
+    async scan() {
+        const modules = (0, core_1.listModule)(queue_1.HLW_TASK_KEY);
+        for (let mod of modules) {
+            const cls = await this.app
+                .getApplicationContext()
+                .getAsync(mod);
+            this.createQueue(cls, mod);
+        }
+    }
+    /**
+     * 获得锁
+     * @param key 键
+     * @param expireTime 过期时间
+     * @returns
+     */
+    async getLock(key, expireTime) {
+        const lockSuccessful = await this.redis.setnx(key, 'locked');
+        if (lockSuccessful) {
+            await this.redis.expire(key, expireTime);
+            return true;
+        }
+        else {
+            return false;
+        }
+    }
+    /**
+     * 队列名称
+     * @param cls
+     * @param mod
+     */
+    async createQueue(cls, mod) {
+        this.redis;
+        if (this.redisConfig instanceof Array) {
+            this.redis = new ioredis_1.default.Cluster(this.redisConfig, {
+                enableReadyCheck: false,
+            });
+        }
+        else {
+            this.redis = new ioredis_1.default({
+                ...this.redisConfig,
+                enableReadyCheck: false,
+                maxRetriesPerRequest: null,
+            });
+        }
+        const name = mod.name;
+        const config = (0, core_1.getClassMetadata)(queue_1.HLW_TASK_KEY, mod);
+        const opts = {
+            connection: this.redis,
+            prefix: `{queue${name}}`,
+            defaultJobOptions: {
+                removeOnComplete: true,
+                removeOnFail: true,
+                attempts: 5,
+                backoff: {
+                    type: 'fixed',
+                    delay: 10000,
+                },
+                ...(config.queue || {}),
+            },
+        };
+        const queue = new bullmq_1.Queue(name, opts);
+        cls.metaQueue = queue;
+        cls.queueName = name;
+        let lock = false;
+        // 本地开发的情况下直接获得锁
+        if (config.type == 'single') {
+            if (this.app.getEnv() == 'local') {
+                lock = true;
+            }
+            else {
+                // cluster 需要配合redis 获得锁
+                if (await this.getLock('HLW_QUEUE_SINGLE', 15)) {
+                    lock = true;
+                }
+            }
+        }
+        if (config.type == 'comm' || (config.type == 'single' && lock)) {
+            cls.worker = new bullmq_1.Worker(name, async (job) => {
+                await cls.data(job, async () => {
+                    await job.isCompleted();
+                });
+            }, {
+                connection: opts.connection,
+                prefix: opts.prefix,
+                ...(config.worker || {}),
+            });
+        }
+        else {
+            cls.getters = new bullmq_1.QueueGetters(name, opts);
+        }
+        this.coreLogger.info(`\x1B[36m [hlw:task] create ${name} queue \x1B[0m`);
+    }
+};
+exports.HlwQueueHandle = HlwQueueHandle;
+__decorate([
+    (0, core_1.Config)('hlw.redis'),
+    __metadata("design:type", Object)
+], HlwQueueHandle.prototype, "redisConfig", void 0);
+__decorate([
+    (0, core_1.Logger)(),
+    __metadata("design:type", Object)
+], HlwQueueHandle.prototype, "coreLogger", void 0);
+__decorate([
+    (0, core_1.App)(),
+    __metadata("design:type", Object)
+], HlwQueueHandle.prototype, "app", void 0);
+__decorate([
+    (0, core_1.Init)(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Promise)
+], HlwQueueHandle.prototype, "init", null);
+exports.HlwQueueHandle = HlwQueueHandle = __decorate([
+    (0, core_1.Provide)(),
+    (0, core_1.Scope)(core_1.ScopeEnum.Singleton)
+], HlwQueueHandle);

package/index.d.ts

@@ -0,0 +1,10 @@
+export * from './dist/index';
+
+declare module '@midwayjs/core/dist/interface' {
+  interface MidwayConfig {
+    book?: PowerPartial<{
+      a: number;
+      b: string;
+    }>;
+  }
+}

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@hlw-midway/task",
+  "version": "1.0.0",
+  "description": "hlw-admin midway task",
+  "main": "dist/index.js",
+  "typings": "index.d.ts",
+  "scripts": {
+    "build": "mwtsc --cleanOutDir",
+    "test": "cross-env NODE_ENV=unittest jest",
+    "cov": "jest --coverage",
+    "lint": "mwts check",
+    "lint:fix": "mwts fix"
+  },
+  "keywords": [
+    "hlw",
+    "hlw-admin"
+  ],
+  "author": "HLW",
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.d.ts",
+    "index.d.ts"
+  ],
+  "readme": "README.md",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://www.baidu.com"
+  },
+  "devDependencies": {
+    "@hlw-midway/core": "file:../core",
+    "@midwayjs/core": "^3.20.0",
+    "@midwayjs/mock": "^3.20.0",
+    "@midwayjs/redis": "^3.20.0",
+    "@types/jest": "^29.5.14",
+    "@types/node": "^22.10.7",
+    "cross-env": "^7.0.3",
+    "mwtsc": "^1.15.1",
+    "jest": "^29.7.0",
+    "lodash": "^4.17.21",
+    "mwts": "^1.3.0",
+    "ts-jest": "^29.2.5",
+    "typescript": "^5.7.3"
+  },
+  "dependencies": {
+    "bullmq": "^5.34.10",
+    "ioredis": "^5.4.2"
+  }
+}