@taicode/common-server 1.0.9 → 1.0.11

package/output/logger/logger.d.ts

@@ -0,0 +1,33 @@
+import { FastifyBaseLogger } from 'fastify';
+import { Bindings, ChildLoggerOptions } from 'fastify/types/logger';
+import { LevelWithSilentOrString, LogFn } from 'pino';
+import { LoggerOptions } from '@taicode/common-base/logger';
+export declare class FastifyLogger implements FastifyBaseLogger {
+    private logger;
+    private _msgPrefix?;
+    constructor(options?: LoggerOptions);
+    /**
+     * 创建子 logger
+     */
+    child(bindings: Bindings, options?: ChildLoggerOptions): FastifyBaseLogger;
+    /**
+     * Pino 兼容的 level getter/setter
+     */
+    get level(): LevelWithSilentOrString;
+    set level(newLevel: LevelWithSilentOrString);
+    /**
+     * 获取消息前缀
+     */
+    get msgPrefix(): string | undefined;
+    /**
+     * 日志方法实现
+     */
+    fatal: LogFn;
+    error: LogFn;
+    warn: LogFn;
+    info: LogFn;
+    debug: LogFn;
+    trace: LogFn;
+    silent: LogFn;
+}
+//# sourceMappingURL=logger.d.ts.map

package/output/logger/logger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../source/logger/logger.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAA;AAC3C,OAAO,EAAE,QAAQ,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAA;AACnE,OAAO,EAAE,uBAAuB,EAAE,KAAK,EAAE,MAAM,MAAM,CAAA;AACrD,OAAO,EAAU,aAAa,EAAE,MAAM,6BAA6B,CAAA;AAEnE,qBAAa,aAAc,YAAW,iBAAiB;IACrD,OAAO,CAAC,MAAM,CAAQ;IACtB,OAAO,CAAC,UAAU,CAAC,CAAQ;gBAEf,OAAO,CAAC,EAAE,aAAa;IAInC;;OAEG;IACH,KAAK,CAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,iBAAiB;IAgB1E;;OAEG;IACH,IAAI,KAAK,IAAI,uBAAuB,CAEnC;IAED,IAAI,KAAK,CAAC,QAAQ,EAAE,uBAAuB,EAK1C;IAED;;OAEG;IACH,IAAI,SAAS,IAAI,MAAM,GAAG,SAAS,CAElC;IAED;;OAEG;IACH,KAAK,EAAE,KAAK,CAEX;IAED,KAAK,EAAE,KAAK,CAEX;IAED,IAAI,EAAE,KAAK,CAEV;IAED,IAAI,EAAE,KAAK,CAEV;IAED,KAAK,EAAE,KAAK,CAEX;IAED,KAAK,EAAE,KAAK,CAEX;IAED,MAAM,EAAE,KAAK,CAEZ;CACF"}

package/output/logger/logger.js

@@ -0,0 +1,65 @@
+import { Logger } from '@taicode/common-base/logger';
+export class FastifyLogger {
+    logger;
+    _msgPrefix;
+    constructor(options) {
+        this.logger = new Logger(options);
+    }
+    /**
+     * 创建子 logger
+     */
+    child(bindings, options) {
+        const childOptions = {
+            level: options?.level,
+            transports: this.logger.getTransports(),
+        };
+        const childLogger = new FastifyLogger(childOptions);
+        // 如果 bindings 包含 msgPrefix，保存它
+        if (bindings && typeof bindings === 'object' && 'msgPrefix' in bindings) {
+            childLogger._msgPrefix = bindings.msgPrefix;
+        }
+        return childLogger;
+    }
+    /**
+     * Pino 兼容的 level getter/setter
+     */
+    get level() {
+        return this.logger.level;
+    }
+    set level(newLevel) {
+        // 过滤掉 'silent' 因为我们的 Logger 不支持它作为 level
+        if (newLevel !== 'silent') {
+            this.logger.level = newLevel;
+        }
+    }
+    /**
+     * 获取消息前缀
+     */
+    get msgPrefix() {
+        return this._msgPrefix;
+    }
+    /**
+     * 日志方法实现
+     */
+    fatal = (...args) => {
+        this.logger.fatal(...args);
+    };
+    error = (...args) => {
+        this.logger.error(...args);
+    };
+    warn = (...args) => {
+        this.logger.warn(...args);
+    };
+    info = (...args) => {
+        this.logger.info(...args);
+    };
+    debug = (...args) => {
+        this.logger.debug(...args);
+    };
+    trace = (...args) => {
+        this.logger.trace(...args);
+    };
+    silent = (...args) => {
+        this.logger.silent();
+    };
+}

package/output/logger/logger.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=logger.test.d.ts.map

package/output/logger/logger.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.test.d.ts","sourceRoot":"","sources":["../../source/logger/logger.test.ts"],"names":[],"mappings":""}

package/output/logger/logger.test.js

@@ -0,0 +1,87 @@
+import { describe, it, expect, vi, beforeEach } from 'vitest';
+import { FastifyLogger } from './logger';
+describe('FastifyLogger', () => {
+    let printMock;
+    let loggerOptions;
+    beforeEach(() => {
+        printMock = vi.fn();
+        loggerOptions = {
+            print: printMock,
+            level: 'info'
+        };
+    });
+    it('应该创建一个 FastifyLogger 实例', () => {
+        const logger = new FastifyLogger(loggerOptions);
+        expect(logger).toBeInstanceOf(FastifyLogger);
+    });
+    it('应该支持所有日志级别方法', () => {
+        const logger = new FastifyLogger(loggerOptions);
+        logger.trace('trace message');
+        logger.debug('debug message');
+        logger.info('info message');
+        logger.warn('warn message');
+        logger.error('error message');
+        logger.fatal('fatal message');
+        // 由于默认级别是 info，trace 和 debug 不应该被调用
+        expect(printMock).not.toHaveBeenCalledWith('trace', 'trace message');
+        expect(printMock).not.toHaveBeenCalledWith('debug', 'debug message');
+        expect(printMock).toHaveBeenCalledWith('info', 'info message');
+        expect(printMock).toHaveBeenCalledWith('warn', 'warn message');
+        expect(printMock).toHaveBeenCalledWith('error', 'error message');
+        expect(printMock).toHaveBeenCalledWith('fatal', 'fatal message');
+    });
+    it('应该支持 silent 方法', () => {
+        const logger = new FastifyLogger(loggerOptions);
+        // silent 方法不应该抛出错误
+        expect(() => logger.silent('test')).not.toThrow();
+        // silent 方法不应该调用 print
+        expect(printMock).not.toHaveBeenCalled();
+    });
+    it('应该支持 level getter/setter', () => {
+        const logger = new FastifyLogger(loggerOptions);
+        expect(logger.level).toBe('info');
+        logger.level = 'warn';
+        expect(logger.level).toBe('warn');
+        // 验证新级别生效
+        printMock.mockClear();
+        logger.info('info message');
+        logger.warn('warn message');
+        expect(printMock).not.toHaveBeenCalledWith('info', 'info message');
+        expect(printMock).toHaveBeenCalledWith('warn', 'warn message');
+    });
+    it('应该忽略 silent 级别设置', () => {
+        const logger = new FastifyLogger(loggerOptions);
+        logger.level = 'silent';
+        // silent 不是有效的 logger 级别，所以应该保持原来的级别
+        expect(logger.level).toBe('info');
+    });
+    it('应该支持创建子 logger', () => {
+        const logger = new FastifyLogger(loggerOptions);
+        const childLogger = logger.child({ requestId: '123' });
+        expect(childLogger).toBeInstanceOf(FastifyLogger);
+        expect(childLogger).not.toBe(logger);
+    });
+    it('应该在子 logger 中保存 msgPrefix', () => {
+        const logger = new FastifyLogger(loggerOptions);
+        const childLogger = logger.child({ msgPrefix: '[Request] ' });
+        expect(childLogger.msgPrefix).toBe('[Request] ');
+    });
+    it('子 logger 应该继承父 logger 的配置', () => {
+        const logger = new FastifyLogger({ ...loggerOptions, level: 'warn' });
+        const childLogger = logger.child({}, { level: 'debug' });
+        // 子 logger 应该使用传入的 level
+        expect(childLogger.level).toBe('debug');
+    });
+    it('应该支持多个参数的日志输出', () => {
+        const logger = new FastifyLogger(loggerOptions);
+        logger.info('message');
+        expect(printMock).toHaveBeenCalledWith('info', 'message');
+    });
+    it('应该正确处理错误对象', () => {
+        const logger = new FastifyLogger(loggerOptions);
+        const error = new Error('test error');
+        logger.error(error);
+        // 验证 print 被调用，不验证具体的格式化内容
+        expect(printMock).toHaveBeenCalledWith('error', expect.stringContaining('test error'));
+    });
+});

package/output/redis-queue/batch-redis-queue.d.ts

@@ -0,0 +1,136 @@
+import type { BatchTaskQueueConfig, TaskData, Task, QueueStats } from './types';
+/**
+ * 批量任务队列类（泛型）
+ *
+ * 提供基于 Redis 的批量任务队列功能，支持：
+ * - 批量处理任务（每次处理多条）
+ * - 任务入队和持久化
+ * - 自动重试机制
+ * - 任务状态追踪
+ * - 分布式消费
+ *
+ * @template T 任务数据类型
+ *
+ * @example
+ * ```ts
+ * interface EmailTask {
+ *   to: string
+ * }
+ *
+ * const queue = new BatchRedisQueue<EmailTask>({
+ *   redisUrl: 'redis://localhost:6379',
+ *   queueKey: 'email-batch-queue',
+ *   batchSize: 50,
+ *   handler: async (dataList) => {
+ *     await sendEmailsBatch(dataList.map(d => d.to))
+ *     return catchIt(() => {})
+ *   }
+ * })
+ *
+ * // 连接 Redis（自动启动消费者）
+ * await queue.connect()
+ *
+ * // 入队任务（自动开始处理）
+ * await queue.enqueue([
+ *   { to: 'user1@example.com' },
+ *   { to: 'user2@example.com' },
+ * ])
+ *
+ * // 获取队列统计信息（O(1) 时间复杂度）
+ * const stats = await queue.statistics()
+ * console.log(stats) // { pending: 100, processing: 50, completed: 200, failed: 5 }
+ * ```
+ */
+export declare class BatchRedisQueue<T extends TaskData = TaskData> {
+    private consumerRunning;
+    private redis;
+    private consumerInterval;
+    private recoveryInterval;
+    private processingBatches;
+    private readonly config;
+    private readonly handler;
+    private readonly failedQueue;
+    private readonly pendingQueue;
+    private readonly processingQueue;
+    private readonly completedQueue;
+    constructor(config: BatchTaskQueueConfig<T>);
+    /**
+     * 连接 Redis 并自动启动消费者
+     */
+    connect(): Promise<void>;
+    /**
+     * 断开 Redis 连接并停止消费者
+     */
+    disconnect(): void;
+    /**
+     * 将任务推入队列(支持单个或批量)
+     * @param data 任务数据(单个或数组)。可以在 data 中包含 `id` 字段来实现幂等性
+     *
+     * @example
+     * // 普通任务,自动生成 ID
+     * await queue.enqueue({ to: 'user@example.com' })
+     *
+     * // 幂等任务,手动指定 ID,重复提交会被忽略
+     * await queue.enqueue({ id: 'email-123', to: 'user@example.com' })
+     * await queue.enqueue({ id: 'email-123', to: 'user@example.com' }) // 会被跳过
+     */
+    enqueue(data: T[]): Promise<string[]>;
+    enqueue(data: T): Promise<string>;
+    /**
+     * 获取任务详情
+     */
+    getTask(taskId: string): Promise<Task<T> | null>;
+    /**
+     * 更新任务状态并移动到对应队列（原子操作）
+     */
+    private applyStatus;
+    /**
+     * 批量更新任务状态
+     */
+    private applyStatusBatch;
+    /**
+     * 根据状态获取对应的队列键
+     */
+    private getQueueByStatus;
+    /**
+     * 恢复超时的任务
+     * 检查 processing 队列中的任务，将超时的任务重试或标记为失败
+     */
+    private recoverStalledTasks;
+    /**
+     * 批量处理任务
+     */
+    private processBatch;
+    /**
+     * 启动恢复机制（内部方法，自动调用）
+     */
+    private startRecovery;
+    /**
+     * 停止恢复机制（内部方法，自动调用）
+     */
+    private stopRecovery;
+    /**
+     * 启动消费者（内部方法，自动调用）
+     */
+    private startConsumer;
+    /**
+     * 停止消费者（内部方法，自动调用）
+     */
+    private stopConsumer;
+    /**
+     * 获取队列统计信息
+     * 返回队列中各种状态任务的详细数量
+     *
+     * 使用分离队列设计，O(1) 时间复杂度
+     */
+    statistics(): Promise<QueueStats>;
+    /**
+     * 清空所有队列
+     */
+    clear(): Promise<void>;
+    /**
+     * 健康检查
+     */
+    health(): Promise<boolean>;
+}
+//# sourceMappingURL=batch-redis-queue.d.ts.map

package/output/redis-queue/batch-redis-queue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"batch-redis-queue.d.ts","sourceRoot":"","sources":["../../source/redis-queue/batch-redis-queue.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,oBAAoB,EAAU,QAAQ,EAAE,IAAI,EAAoB,UAAU,EAAE,MAAM,SAAS,CAAA;AAEzG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,qBAAa,eAAe,CAAC,CAAC,SAAS,QAAQ,GAAG,QAAQ;IACxD,OAAO,CAAC,eAAe,CAAQ;IAC/B,OAAO,CAAC,KAAK,CAA+B;IAC5C,OAAO,CAAC,gBAAgB,CAA8B;IACtD,OAAO,CAAC,gBAAgB,CAA8B;IACtD,OAAO,CAAC,iBAAiB,CAAI;IAE7B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAoD;IAC3E,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAqB;IAG7C,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAQ;IACpC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAQ;IACrC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAQ;IACxC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAQ;gBAE3B,MAAM,EAAE,oBAAoB,CAAC,CAAC,CAAC;IA0C3C;;OAEG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAY9B;;OAEG;IACH,UAAU,IAAI,IAAI;IAUlB;;;;;;;;;;;OAWG;IACG,OAAO,CAAC,IAAI,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IACrC,OAAO,CAAC,IAAI,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAkEvC;;OAEG;IACG,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IAWtD;;OAEG;YACW,WAAW;IA8BzB;;OAEG;YACW,gBAAgB;IAI9B;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAUxB;;;OAGG;YACW,mBAAmB;IA6EjC;;OAEG;YACW,YAAY;IA8F1B;;OAEG;IACH,OAAO,CAAC,aAAa;IAoBrB;;OAEG;IACH,OAAO,CAAC,YAAY;IAQpB;;OAEG;IACH,OAAO,CAAC,aAAa;IA2ErB;;OAEG;IACH,OAAO,CAAC,YAAY;IASpB;;;;;OAKG;IACG,UAAU,IAAI,OAAO,CAAC,UAAU,CAAC;IA0BvC;;OAEG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAkB5B;;OAEG;IACG,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC;CAMjC"}