koishi-plugin-github-webhook-pusher 0.0.8 → 0.0.9

package/lib/config.d.ts

@@ -6,8 +6,6 @@ export interface Config {
     path: string;
     /** GitHub Webhook Secret */
     secret: string;
-    /** 显示用基础 URL */
-    baseUrl?: string;
     /** 默认订阅事件 */
     defaultEvents: EventType[];
     /** 调试模式 */
@@ -16,5 +14,9 @@ export interface Config {
     allowUntrusted: boolean;
     /** 推送并发数 */
     concurrency: number;
+    /** 投递记录保留天数（<=0 表示不清理） */
+    deliveryRetentionDays: number;
+    /** 投递记录清理间隔（小时） */
+    deliveryCleanupIntervalHours: number;
 }
 export declare const Config: Schema<Config>;

package/lib/config.js

@@ -20,11 +20,12 @@ const EVENT_TYPES = [
 exports.Config = koishi_1.Schema.object({
     path: koishi_1.Schema.string().default('/github/webhook').description('Webhook 接收路径'),
     secret: koishi_1.Schema.string().required().description('GitHub Webhook Secret'),
-    baseUrl: koishi_1.Schema.string().description('显示用基础 URL'),
     defaultEvents: koishi_1.Schema.array(koishi_1.Schema.union(EVENT_TYPES.map(e => koishi_1.Schema.const(e))))
         .default(['issues', 'release', 'push'])
         .description('默认订阅事件'),
     debug: koishi_1.Schema.boolean().default(false).description('调试模式'),
     allowUntrusted: koishi_1.Schema.boolean().default(false).description('允许非信任仓库'),
     concurrency: koishi_1.Schema.number().default(5).description('推送并发数'),
+    deliveryRetentionDays: koishi_1.Schema.number().default(30).description('投递记录保留天数（<=0 表示不清理）'),
+    deliveryCleanupIntervalHours: koishi_1.Schema.number().default(24).description('投递记录清理间隔（小时）'),
 });

package/lib/index.js

@@ -12,6 +12,7 @@ Object.defineProperty(exports, "Config", { enumerable: true, get: function () {
 const database_1 = require("./database");
 const webhook_1 = require("./webhook");
 const commands_1 = require("./commands");
+const repository_1 = require("./repository");
 /** 插件名称 */
 exports.name = 'github-webhook-pusher';
 /** 声明服务依赖 - 需要 server 服务提供 router 和 database 服务 */
@@ -43,6 +44,7 @@ function apply(ctx, config) {
     // 需求 8.1, 8.2: 工具命令
     (0, commands_1.registerUtilCommands)(ctx, config);
     logger.debug('工具命令已注册');
+    scheduleDeliveryCleanup(ctx, config);
     // 插件启动日志
     logger.info(`GitHub Webhook 插件已加载`);
     logger.info(`Webhook 路径: ${config.path}`);
@@ -51,3 +53,28 @@ function apply(ctx, config) {
         logger.info('调试模式已启用');
     }
 }
+function scheduleDeliveryCleanup(ctx, config) {
+    if (config.deliveryRetentionDays <= 0) {
+        logger.debug('投递记录清理已禁用');
+        return;
+    }
+    const intervalHours = Math.max(1, config.deliveryCleanupIntervalHours || 24);
+    const intervalMs = intervalHours * 60 * 60 * 1000;
+    const runCleanup = async () => {
+        const beforeDate = new Date(Date.now() - config.deliveryRetentionDays * 24 * 60 * 60 * 1000);
+        const removed = await (0, repository_1.cleanupDeliveries)(ctx, beforeDate);
+        if (config.debug) {
+            logger.debug(`清理投递记录: ${removed} 条 (保留 ${config.deliveryRetentionDays} 天)`);
+        }
+    };
+    runCleanup().catch(error => {
+        const message = error instanceof Error ? error.message : String(error);
+        logger.warn(`投递记录清理失败: ${message}`);
+    });
+    ctx.setInterval(() => {
+        runCleanup().catch(error => {
+            const message = error instanceof Error ? error.message : String(error);
+            logger.warn(`投递记录清理失败: ${message}`);
+        });
+    }, intervalMs);
+}

package/lib/webhook.js

@@ -43,7 +43,22 @@ function registerWebhook(ctx, config) {
                     koaCtx.body = { error: 'Missing signature' };
                     return;
                 }
-                if (!(0, signature_1.verifySignature)(rawBody, signature, config.secret)) {
+                let payloadForVerify = rawBody;
+                if (!payloadForVerify) {
+                    const requestBody = koaCtx.request?.body;
+                    if (requestBody) {
+                        // fallback: body parser 已消费流，无法获得 raw body
+                        payloadForVerify = JSON.stringify(requestBody);
+                        logger.warn('未获取到原始请求体，已使用解析后的 body 进行验签（可能导致验签失败）');
+                    }
+                    else {
+                        logger.warn('无法获取请求体，无法进行签名验证');
+                        koaCtx.status = 400;
+                        koaCtx.body = { error: 'Missing request body' };
+                        return;
+                    }
+                }
+                if (!(0, signature_1.verifySignature)(payloadForVerify, signature, config.secret)) {
                     // 需求 1.3, 9.2: 签名验证失败
                     logger.warn('签名验证失败');
                     koaCtx.status = 401;
@@ -56,14 +71,28 @@ function registerWebhook(ctx, config) {
             // 需求 1.5: 签名验证成功，继续处理
             // 解析 JSON 负载
             let payload;
-            try {
-                payload = JSON.parse(rawBody);
+            if (rawBody) {
+                try {
+                    payload = JSON.parse(rawBody);
+                }
+                catch (e) {
+                    logger.warn('无法解析 JSON 负载');
+                    koaCtx.status = 400;
+                    koaCtx.body = { error: 'Invalid JSON payload' };
+                    return;
+                }
             }
-            catch (e) {
-                logger.warn('无法解析 JSON 负载');
-                koaCtx.status = 400;
-                koaCtx.body = { error: 'Invalid JSON payload' };
-                return;
+            else {
+                const requestBody = koaCtx.request?.body;
+                if (requestBody) {
+                    payload = requestBody;
+                }
+                else {
+                    logger.warn('请求体为空或无法读取');
+                    koaCtx.status = 400;
+                    koaCtx.body = { error: 'Missing request body' };
+                    return;
+                }
             }
             // 获取仓库名
             const repo = payload.repository?.full_name;
@@ -135,9 +164,15 @@ function registerWebhook(ctx, config) {
  * @returns 原始请求体字符串
  */
 async function getRawBody(koaCtx) {
-    // 如果已经有解析好的 body，尝试重新序列化
-    if (koaCtx.request.body) {
-        return JSON.stringify(koaCtx.request.body);
+    const rawBody = koaCtx.request?.rawBody;
+    if (typeof rawBody === 'string') {
+        return rawBody;
+    }
+    if (Buffer.isBuffer(rawBody)) {
+        return rawBody.toString('utf8');
+    }
+    if (!koaCtx.req?.readable) {
+        return null;
     }
     // 否则从流中读取
     return new Promise((resolve, reject) => {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "koishi-plugin-github-webhook-pusher",
   "description": "GitHub Webhook 事件推送插件",
-  "version": "0.0.8",
+  "version": "0.0.9",
   "contributors": [
     "ClozyA <aoxuan233@gmail.com>"
   ],

package/readme.md

@@ -31,11 +31,12 @@ npm install koishi-plugin-github-webhook-pusher
 |--------|------|--------|------|
 | `path` | string | `/github/webhook` | Webhook 接收路径 |
 | `secret` | string | (必填) | GitHub Webhook Secret，用于签名验证 |
-| `baseUrl` | string | - | 显示用基础 URL |
 | `defaultEvents` | string[] | `['issues', 'release', 'push']` | 新订阅的默认事件类型 |
 | `debug` | boolean | `false` | 启用调试模式，输出详细日志 |
 | `allowUntrusted` | boolean | `false` | 是否允许处理非信任仓库的事件 |
 | `concurrency` | number | `5` | 消息推送并发数 |
+| `deliveryRetentionDays` | number | `30` | 投递记录保留天数（<=0 表示不清理） |
+| `deliveryCleanupIntervalHours` | number | `24` | 投递记录清理间隔（小时） |
 
 ### 配置示例
 
@@ -51,6 +52,8 @@ plugins:
     debug: false
     allowUntrusted: false
     concurrency: 5
+    deliveryRetentionDays: 30
+    deliveryCleanupIntervalHours: 24
 ```
 
 ## GitHub Webhook 设置指南
@@ -178,6 +181,7 @@ https://github.com/owner/repo/releases/tag/v1.0.0
 **A:** 签名验证失败。请检查：
 1. GitHub Webhook 设置中的 Secret 与插件配置的 `secret` 是否一致
 2. Content type 是否设置为 `application/json`
+3. 如果服务器未保留 raw body，插件会使用解析后的 body 回退验签，可能导致签名不一致；建议配置保留原始请求体
 
 ### Q: 收不到 Webhook 事件？