@taicode/common-server 3.7.5 → 3.7.7

package/output/redis-queue/redis-queue-common.js

@@ -1,303 +0,0 @@
-import { createClient } from 'redis';
-import { logger } from '@taicode/common-base';
-/**
- * Redis 队列基础类
- * 封装 Provider 和 Consumer 的公共逻辑
- */
-export class RedisQueueCommon {
-    redis = null;
-    isExternalRedis = false; // 是否使用外部传入的 Redis 客户端
-    queueKey;
-    redisUrl;
-    cleanupDelay;
-    // 不同状态队列的键名
-    failedQueue;
-    pendingQueue;
-    processingQueue;
-    completedQueue;
-    constructor(queueKey, config = {}) {
-        // 验证必填参数
-        if (!config.redisUrl && !config.redisClient) {
-            throw new Error('[RedisQueue] Either redisUrl or redisClient is required');
-        }
-        if (config.redisUrl && config.redisClient) {
-            throw new Error('[RedisQueue] Cannot specify both redisUrl and redisClient');
-        }
-        if (!queueKey) {
-            throw new Error('[RedisQueue] queueKey is required');
-        }
-        if (queueKey.length < 6) {
-            throw new Error('[RedisQueue] queueKey must be at least 6 characters long');
-        }
-        this.redisUrl = config.redisUrl;
-        this.queueKey = queueKey;
-        this.cleanupDelay = config.cleanupDelay ?? 86400; // 24 hours
-        // 初始化不同状态队列的键名
-        this.failedQueue = `${queueKey}:failed`;
-        this.pendingQueue = `${queueKey}:pending`;
-        this.completedQueue = `${queueKey}:completed`;
-        this.processingQueue = `${queueKey}:processing`;
-        // 使用外部客户端或创建新客户端
-        if (config.redisClient) {
-            this.redis = config.redisClient;
-            this.isExternalRedis = true;
-        }
-        else {
-            this.redis = createClient({ url: this.redisUrl });
-            this.isExternalRedis = false;
-            // 添加错误处理
-            this.redis.on('error', (err) => {
-                logger.error(`[${this.getLogPrefix()}] Redis Client Error:`, err);
-            });
-        }
-    }
-    /**
-     * 连接 Redis
-     */
-    async connect() {
-        if (this.redis && !this.redis.isOpen) {
-            await this.redis.connect().catch((error) => {
-                logger.error(`[${this.getLogPrefix()}] Failed to connect to Redis:`, error);
-                throw error;
-            });
-        }
-    }
-    /**
-     * 断开 Redis 连接
-     */
-    disconnect() {
-        // 如果是外部传入的客户端,不主动断开连接
-        if (this.isExternalRedis) {
-            return;
-        }
-        if (this.redis && this.redis.isOpen) {
-            this.redis.disconnect().catch((error) => {
-                logger.error(`[${this.getLogPrefix()}] Failed to disconnect:`, error);
-            });
-        }
-    }
-    /**
-     * 获取任务详情
-     */
-    async getTask(taskId) {
-        if (!this.redis || !this.redis.isOpen)
-            return null;
-        const taskKey = `${this.queueKey}:task:${taskId}`;
-        const taskData = await this.redis.get(taskKey);
-        if (!taskData)
-            return null;
-        return JSON.parse(taskData);
-    }
-    /**
-     * 根据状态获取对应的队列键
-     */
-    getQueueByStatus(status) {
-        switch (status) {
-            case 'pending': return this.pendingQueue;
-            case 'processing': return this.processingQueue;
-            case 'completed': return this.completedQueue;
-            case 'failed': return this.failedQueue;
-            default: return this.pendingQueue;
-        }
-    }
-    /**
-     * 更新任务状态并移动到对应队列（原子操作）
-     */
-    async applyStatus(taskId, oldStatus, newStatus) {
-        if (!this.redis || !this.redis.isOpen)
-            return;
-        const task = await this.getTask(taskId);
-        if (!task)
-            return;
-        task.status = newStatus;
-        const taskKey = `${this.queueKey}:task:${taskId}`;
-        const oldQueue = this.getQueueByStatus(oldStatus);
-        const newQueue = this.getQueueByStatus(newStatus);
-        if (oldQueue !== newQueue) {
-            // 使用 Lua 脚本确保原子性：更新任务 + 移动队列
-            const script = `
-        local taskKey = KEYS[1]
-        local oldQueue = KEYS[2]
-        local newQueue = KEYS[3]
-        local ttl = tonumber(ARGV[1])
-        local taskData = ARGV[2]
-        local taskId = ARGV[3]
-        
-        redis.call('SETEX', taskKey, ttl, taskData)
-        redis.call('LREM', oldQueue, 0, taskId)
-        redis.call('RPUSH', newQueue, taskId)
-        return 1
-      `;
-            await this.redis.eval(script, {
-                keys: [taskKey, oldQueue, newQueue],
-                arguments: [this.cleanupDelay.toString(), JSON.stringify(task), taskId],
-            });
-        }
-        else {
-            // 只更新任务数据
-            await this.redis.setEx(taskKey, this.cleanupDelay, JSON.stringify(task));
-        }
-    }
-    /**
-     * 批量更新任务状态（使用 Lua 脚本保证原子性）
-     * 注意: 此方法会在 Lua 脚本中读取任务数据,不需要提前获取
-     */
-    async applyStatusBatch(taskIds, oldStatus, newStatus) {
-        if (!this.redis || !this.redis.isOpen || taskIds.length === 0)
-            return 0;
-        const oldQueue = this.getQueueByStatus(oldStatus);
-        const newQueue = this.getQueueByStatus(newStatus);
-        // 使用 Lua 脚本批量更新状态并移动队列
-        const batchUpdateScript = `
-      local oldQueue = KEYS[1]
-      local newQueue = KEYS[2]
-      local queueKeyPrefix = ARGV[1]
-      local ttl = tonumber(ARGV[2])
-      local newStatus = ARGV[3]
-      local updatedCount = 0
-      
-      -- ARGV[4], ARGV[5], ARGV[6]... 是 taskId
-      for i = 4, #ARGV do
-        local taskId = ARGV[i]
-        local taskKey = queueKeyPrefix .. ':task:' .. taskId
-        local existingData = redis.call('GET', taskKey)
-        
-        if existingData then
-          -- 读取现有任务并更新状态
-          local task = cjson.decode(existingData)
-          task.status = newStatus
-          redis.call('SETEX', taskKey, ttl, cjson.encode(task))
-          
-          -- 如果队列不同,移动任务
-          if oldQueue ~= newQueue then
-            redis.call('LREM', oldQueue, 0, taskId)
-            redis.call('RPUSH', newQueue, taskId)
-          end
-          
-          updatedCount = updatedCount + 1
-        end
-      end
-      
-      return updatedCount
-    `;
-        const result = await this.redis.eval(batchUpdateScript, {
-            keys: [oldQueue, newQueue],
-            arguments: [
-                this.queueKey,
-                this.cleanupDelay.toString(),
-                newStatus,
-                ...taskIds,
-            ],
-        });
-        return result;
-    }
-    /**
-     * 获取队列统计信息（O(1) 时间复杂度）
-     */
-    async statistics() {
-        if (!this.redis || !this.redis.isOpen) {
-            return { pending: 0, processing: 0, completed: 0, failed: 0 };
-        }
-        const [pending, processing, completed, failed] = await Promise.all([
-            this.redis.lLen(this.pendingQueue),
-            this.redis.lLen(this.processingQueue),
-            this.redis.lLen(this.completedQueue),
-            this.redis.lLen(this.failedQueue),
-        ]);
-        return { pending, processing, completed, failed };
-    }
-    /**
-     * 健康检查
-     */
-    async health() {
-        if (!this.redis || !this.redis.isOpen)
-            return false;
-        try {
-            await this.redis.ping();
-            return true;
-        }
-        catch {
-            return false;
-        }
-    }
-    /**
-     * 恢复超时的任务
-     * 检查 processing 队列中的任务，将超时的任务直接标记为失败
-     * 使用 Lua 脚本批量处理以提高性能和原子性
-     *
-     * @param processingTimeout 处理超时时间（毫秒）
-     * @returns 恢复的任务统计 {timeoutFailed: number, cleaned: number}
-     */
-    async recoverStalled(processingTimeout) {
-        if (!this.redis || !this.redis.isOpen) {
-            return { timeoutFailed: 0, cleaned: 0 };
-        }
-        try {
-            const processingTaskIds = await this.redis.lRange(this.processingQueue, 0, -1);
-            if (processingTaskIds.length === 0) {
-                return { timeoutFailed: 0, cleaned: 0 };
-            }
-            // 使用 Lua 脚本批量恢复超时任务
-            const batchRecoveryScript = `
-        local processingQueue = KEYS[1]
-        local pendingQueue = KEYS[2]
-        local failedQueue = KEYS[3]
-        local queueKeyPrefix = ARGV[1]
-        local ttl = tonumber(ARGV[2])
-        local processingTimeout = tonumber(ARGV[3])
-        local now = tonumber(ARGV[4])
-        
-        local retryCount = 0
-        local failedCount = 0
-        local cleanupCount = 0
-        
-        -- ARGV[5], ARGV[6], ARGV[7]... 是 taskId
-        for i = 5, #ARGV do
-          local taskId = ARGV[i]
-          local taskKey = queueKeyPrefix .. ':task:' .. taskId
-          local taskData = redis.call('GET', taskKey)
-          
-          if not taskData then
-            -- 任务不存在，从队列中清理
-            redis.call('LREM', processingQueue, 0, taskId)
-            cleanupCount = cleanupCount + 1
-          else
-            local task = cjson.decode(taskData)
-            local processingTime = now - (task.processingStartTime or now)
-            
-            -- 检查是否超时
-            if processingTime > processingTimeout then
-              -- 超时直接标记为失败
-              task.status = 'failed'
-              task.processingStartTime = nil
-              
-              redis.call('SETEX', taskKey, ttl, cjson.encode(task))
-              redis.call('LREM', processingQueue, 0, taskId)
-              redis.call('RPUSH', failedQueue, taskId)
-              failedCount = failedCount + 1
-            end
-          end
-        end
-        
-        return {retryCount, failedCount, cleanupCount}
-      `;
-            const result = await this.redis.eval(batchRecoveryScript, {
-                keys: [this.processingQueue, this.pendingQueue, this.failedQueue],
-                arguments: [
-                    this.queueKey,
-                    this.cleanupDelay.toString(),
-                    processingTimeout.toString(),
-                    Date.now().toString(),
-                    ...processingTaskIds,
-                ],
-            });
-            const [, failedCount, cleanupCount] = result;
-            return { timeoutFailed: failedCount, cleaned: cleanupCount };
-        }
-        catch (error) {
-            const logPrefix = this.getLogPrefix();
-            logger.error(`[${logPrefix}] Failed to recover stalled tasks:`, error);
-            return { timeoutFailed: 0, cleaned: 0 };
-        }
-    }
-}

package/output/redis-queue/redis-queue-common.test.d.ts

@@ -1,19 +0,0 @@
-declare module './types.js' {
-    interface RedisQueueRegistry {
-        'test-queue': Record<string, any>;
-        'test-queue-error': Record<string, any>;
-        'short': Record<string, any>;
-        'valid-key': Record<string, any>;
-        'test-default': Record<string, any>;
-        'test-custom': Record<string, any>;
-        '': Record<string, any>;
-        'my-queue': Record<string, any>;
-        'test-error': Record<string, any>;
-        'test-bad': Record<string, any>;
-        'queue-one': Record<string, any>;
-        'queue-two': Record<string, any>;
-        [key: `test:reconnect:${number}`]: Record<string, any>;
-    }
-}
-export {};
-//# sourceMappingURL=redis-queue-common.test.d.ts.map

package/output/redis-queue/redis-queue-common.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"redis-queue-common.test.d.ts","sourceRoot":"","sources":["../../source/redis-queue/redis-queue-common.test.ts"],"names":[],"mappings":"AAOA,OAAO,QAAQ,YAAY,CAAC;IAC1B,UAAU,kBAAkB;QAC1B,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;QACjC,kBAAkB,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;QACvC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;QAC5B,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;QAChC,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;QACnC,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;QAClC,EAAE,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;QACvB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;QAC/B,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;QACjC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;QAC/B,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;QAChC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;QAChC,CAAC,GAAG,EAAE,kBAAkB,MAAM,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;KACvD;CACF"}