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

package/lib/parser.js

@@ -0,0 +1,304 @@
+"use strict";
+/**
+ * GitHub Webhook 事件解析器
+ * 需求: 4.1-4.7
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseIssuesEvent = parseIssuesEvent;
+exports.parseIssueCommentEvent = parseIssueCommentEvent;
+exports.parseReleaseEvent = parseReleaseEvent;
+exports.parsePushEvent = parsePushEvent;
+exports.parsePullRequestEvent = parsePullRequestEvent;
+exports.parsePullRequestReviewEvent = parsePullRequestReviewEvent;
+exports.parsePullRequestReviewCommentEvent = parsePullRequestReviewCommentEvent;
+exports.parseStarEvent = parseStarEvent;
+exports.parseForkEvent = parseForkEvent;
+exports.parseCreateEvent = parseCreateEvent;
+exports.parseDeleteEvent = parseDeleteEvent;
+exports.parseWorkflowRunEvent = parseWorkflowRunEvent;
+exports.parseEvent = parseEvent;
+const types_1 = require("./types");
+/** Push 事件最大显示提交数 */
+const MAX_COMMITS = 3;
+/**
+ * 解析 Issues 事件
+ * 需求 4.1: 提取 issue 标题、编号、操作者和链接
+ */
+function parseIssuesEvent(payload) {
+    const { action, issue, repository, sender } = payload;
+    // 只处理 opened/closed/reopened/edited 动作
+    if (!['opened', 'closed', 'reopened', 'edited'].includes(action)) {
+        return null;
+    }
+    return {
+        type: 'issues',
+        displayType: (0, types_1.getDisplayType)('issues'),
+        repo: repository.full_name,
+        actor: sender.login,
+        action,
+        title: issue.title,
+        number: issue.number,
+        url: issue.html_url,
+        body: issue.body,
+    };
+}
+/**
+ * 解析 Issue Comment 事件
+ */
+function parseIssueCommentEvent(payload) {
+    const { action, issue, comment, repository, sender } = payload;
+    // 只处理 created/edited/deleted 动作
+    if (!['created', 'edited', 'deleted'].includes(action)) {
+        return null;
+    }
+    return {
+        type: 'issue_comment',
+        displayType: (0, types_1.getDisplayType)('issue_comment'),
+        repo: repository.full_name,
+        actor: sender.login,
+        action,
+        title: issue.title,
+        number: issue.number,
+        url: comment?.html_url || issue.html_url,
+        body: comment?.body,
+    };
+}
+/**
+ * 解析 Release 事件
+ * 需求 4.2: 提取版本号、发布者和下载链接
+ */
+function parseReleaseEvent(payload) {
+    const { action, release, repository, sender } = payload;
+    // 只处理 published/created 动作
+    if (!['published', 'created'].includes(action)) {
+        return null;
+    }
+    return {
+        type: 'release',
+        displayType: (0, types_1.getDisplayType)('release'),
+        repo: repository.full_name,
+        actor: sender.login,
+        action,
+        title: release.name || release.tag_name,
+        tagName: release.tag_name,
+        url: release.html_url,
+        body: release.body,
+    };
+}
+/**
+ * 解析 Push 事件
+ * 需求 4.3, 4.6: 提取分支名、提交列表（最多5条）和推送者信息
+ */
+function parsePushEvent(payload) {
+    const { ref, commits, repository, sender, compare } = payload;
+    // 提取分支名（去掉 refs/heads/ 前缀）
+    const branch = ref?.replace('refs/heads/', '') || '';
+    // 解析提交列表
+    const allCommits = (commits || []).map((commit) => ({
+        sha: commit.id?.substring(0, 7) || '',
+        message: commit.message?.split('\n')[0] || '', // 只取第一行
+        author: commit.author?.name || commit.author?.username || '',
+        url: commit.url || '',
+    }));
+    // 截断到最多 MAX_COMMITS 条
+    const displayCommits = allCommits.slice(0, MAX_COMMITS);
+    return {
+        type: 'push',
+        displayType: (0, types_1.getDisplayType)('push'), // 显示为 "Commit"
+        repo: repository.full_name,
+        actor: sender.login,
+        ref: branch,
+        commits: displayCommits,
+        totalCommits: allCommits.length,
+        url: compare || `https://github.com/${repository.full_name}`,
+    };
+}
+/**
+ * 解析 Pull Request 事件
+ * 需求 4.4: 提取 PR 标题、编号、操作者和链接
+ */
+function parsePullRequestEvent(payload) {
+    const { action, pull_request, repository, sender } = payload;
+    // 只处理 opened/closed/merged 动作
+    // 注意: merged 实际上是 closed + merged 标志
+    const validActions = ['opened', 'closed', 'reopened', 'edited'];
+    if (!validActions.includes(action)) {
+        return null;
+    }
+    // 判断是否为合并
+    const actualAction = action === 'closed' && pull_request.merged ? 'merged' : action;
+    return {
+        type: 'pull_request',
+        displayType: (0, types_1.getDisplayType)('pull_request'),
+        repo: repository.full_name,
+        actor: sender.login,
+        action: actualAction,
+        title: pull_request.title,
+        number: pull_request.number,
+        url: pull_request.html_url,
+        body: pull_request.body,
+    };
+}
+/**
+ * 解析 Pull Request Review 事件
+ */
+function parsePullRequestReviewEvent(payload) {
+    const { action, review, pull_request, repository, sender } = payload;
+    // 只处理 submitted/edited/dismissed 动作
+    if (!['submitted', 'edited', 'dismissed'].includes(action)) {
+        return null;
+    }
+    return {
+        type: 'pull_request_review',
+        displayType: (0, types_1.getDisplayType)('pull_request_review'),
+        repo: repository.full_name,
+        actor: sender.login,
+        action: review?.state || action,
+        title: pull_request.title,
+        number: pull_request.number,
+        url: review?.html_url || pull_request.html_url,
+        body: review?.body,
+    };
+}
+/**
+ * 解析 Pull Request Review Comment 事件
+ */
+function parsePullRequestReviewCommentEvent(payload) {
+    const { action, comment, pull_request, repository, sender } = payload;
+    // 只处理 created/edited/deleted 动作
+    if (!['created', 'edited', 'deleted'].includes(action)) {
+        return null;
+    }
+    return {
+        type: 'pull_request_review_comment',
+        displayType: (0, types_1.getDisplayType)('pull_request_review_comment'),
+        repo: repository.full_name,
+        actor: sender.login,
+        action,
+        title: pull_request.title,
+        number: pull_request.number,
+        url: comment?.html_url || pull_request.html_url,
+        body: comment?.body,
+    };
+}
+/**
+ * 解析 Star 事件
+ * 需求 4.5: 提取操作者和当前 star 数量
+ */
+function parseStarEvent(payload) {
+    const { action, repository, sender } = payload;
+    // star 事件只有 created 和 deleted 动作
+    if (!['created', 'deleted'].includes(action)) {
+        return null;
+    }
+    return {
+        type: 'star',
+        displayType: (0, types_1.getDisplayType)('star'),
+        repo: repository.full_name,
+        actor: sender.login,
+        action,
+        starCount: repository.stargazers_count,
+        url: repository.html_url,
+    };
+}
+/**
+ * 解析 Fork 事件
+ */
+function parseForkEvent(payload) {
+    const { forkee, repository, sender } = payload;
+    return {
+        type: 'fork',
+        displayType: (0, types_1.getDisplayType)('fork'),
+        repo: repository.full_name,
+        actor: sender.login,
+        action: 'forked',
+        title: forkee?.full_name,
+        url: forkee?.html_url || repository.html_url,
+    };
+}
+/**
+ * 解析 Create 事件
+ */
+function parseCreateEvent(payload) {
+    const { ref, ref_type, repository, sender } = payload;
+    return {
+        type: 'create',
+        displayType: (0, types_1.getDisplayType)('create'),
+        repo: repository.full_name,
+        actor: sender.login,
+        action: 'created',
+        ref: ref ? `${ref_type}:${ref}` : ref_type,
+        url: repository.html_url,
+    };
+}
+/**
+ * 解析 Delete 事件
+ */
+function parseDeleteEvent(payload) {
+    const { ref, ref_type, repository, sender } = payload;
+    return {
+        type: 'delete',
+        displayType: (0, types_1.getDisplayType)('delete'),
+        repo: repository.full_name,
+        actor: sender.login,
+        action: 'deleted',
+        ref: ref ? `${ref_type}:${ref}` : ref_type,
+        url: repository.html_url,
+    };
+}
+/**
+ * 解析 Workflow Run 事件
+ */
+function parseWorkflowRunEvent(payload) {
+    const { action, workflow_run, repository, sender } = payload;
+    // 只处理 requested/completed 动作
+    if (!['requested', 'completed'].includes(action)) {
+        return null;
+    }
+    const conclusion = workflow_run?.conclusion ? `/${workflow_run.conclusion}` : '';
+    return {
+        type: 'workflow_run',
+        displayType: (0, types_1.getDisplayType)('workflow_run'),
+        repo: repository.full_name,
+        actor: sender.login,
+        action: `${action}${conclusion}`,
+        title: workflow_run?.name,
+        url: workflow_run?.html_url || repository.html_url,
+    };
+}
+/**
+ * 统一的事件解析入口函数
+ * @param eventName X-GitHub-Event 头的值
+ * @param payload 解析后的 JSON 负载
+ * @returns 解析后的事件数据，不支持的事件返回 null
+ */
+function parseEvent(eventName, payload) {
+    switch (eventName) {
+        case 'issues':
+            return parseIssuesEvent(payload);
+        case 'issue_comment':
+            return parseIssueCommentEvent(payload);
+        case 'release':
+            return parseReleaseEvent(payload);
+        case 'push':
+            return parsePushEvent(payload);
+        case 'pull_request':
+            return parsePullRequestEvent(payload);
+        case 'pull_request_review':
+            return parsePullRequestReviewEvent(payload);
+        case 'pull_request_review_comment':
+            return parsePullRequestReviewCommentEvent(payload);
+        case 'star':
+            return parseStarEvent(payload);
+        case 'fork':
+            return parseForkEvent(payload);
+        case 'create':
+            return parseCreateEvent(payload);
+        case 'delete':
+            return parseDeleteEvent(payload);
+        case 'workflow_run':
+            return parseWorkflowRunEvent(payload);
+        default:
+            return null;
+    }
+}

package/lib/pusher.d.ts

@@ -0,0 +1,55 @@
+/**
+ * 消息推送器
+ * 需求: 5.1, 5.2, 5.6, 5.7
+ */
+import { Context, Element } from 'koishi';
+import { EventType, ParsedEvent } from './types';
+import { PushTarget } from './repository/subscription';
+/** 推送结果 */
+export interface PushResult {
+    target: PushTarget;
+    success: boolean;
+    error?: Error;
+}
+/**
+ * 查询订阅目标
+ * 需求 5.1: 查询所有订阅该仓库的目标会话
+ * 需求 5.2: 根据订阅的事件类型过滤目标
+ * @param ctx Koishi 上下文
+ * @param repo 仓库名 (owner/repo)
+ * @param eventType 事件类型
+ * @returns 推送目标列表
+ */
+export declare function queryTargets(ctx: Context, repo: string, eventType: EventType): Promise<PushTarget[]>;
+/**
+ * 并发推送消息到多个目标
+ * 需求 5.6: 使用 Promise.allSettled 并发推送并限制并发数
+ * 需求 5.7: 推送失败记录错误日志但不影响其他目标的推送
+ * @param ctx Koishi 上下文
+ * @param targets 推送目标列表
+ * @param message 消息内容
+ * @param concurrency 并发数限制
+ * @returns 推送结果列表
+ */
+export declare function pushWithConcurrency(ctx: Context, targets: PushTarget[], message: Element[], concurrency: number): Promise<PushResult[]>;
+/**
+ * 推送消息到所有订阅目标
+ * @param ctx Koishi 上下文
+ * @param event 解析后的事件
+ * @param concurrency 并发数限制
+ * @returns 推送结果列表
+ */
+export declare function pushMessage(ctx: Context, event: ParsedEvent, concurrency?: number): Promise<PushResult[]>;
+/**
+ * 推送事件（完整流程）
+ * 整合事件解析、消息构建和推送
+ * @param ctx Koishi 上下文
+ * @param event 解析后的事件
+ * @param concurrency 并发数限制
+ * @returns 推送结果
+ */
+export declare function pushEvent(ctx: Context, event: ParsedEvent, concurrency?: number): Promise<{
+    pushed: number;
+    failed: number;
+    results: PushResult[];
+}>;

package/lib/pusher.js

@@ -0,0 +1,128 @@
+"use strict";
+/**
+ * 消息推送器
+ * 需求: 5.1, 5.2, 5.6, 5.7
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.queryTargets = queryTargets;
+exports.pushWithConcurrency = pushWithConcurrency;
+exports.pushMessage = pushMessage;
+exports.pushEvent = pushEvent;
+const koishi_1 = require("koishi");
+const subscription_1 = require("./repository/subscription");
+const message_1 = require("./message");
+const logger = new koishi_1.Logger('github-webhook-pusher');
+/**
+ * 查询订阅目标
+ * 需求 5.1: 查询所有订阅该仓库的目标会话
+ * 需求 5.2: 根据订阅的事件类型过滤目标
+ * @param ctx Koishi 上下文
+ * @param repo 仓库名 (owner/repo)
+ * @param eventType 事件类型
+ * @returns 推送目标列表
+ */
+async function queryTargets(ctx, repo, eventType) {
+    return (0, subscription_1.queryTargets)(ctx, repo, eventType);
+}
+/**
+ * 发送消息到单个目标
+ * @param ctx Koishi 上下文
+ * @param target 推送目标
+ * @param message 消息内容
+ * @returns 推送结果
+ */
+async function sendMessage(ctx, target, message) {
+    try {
+        // 获取对应平台的 bot
+        const bot = ctx.bots.find(b => b.platform === target.platform);
+        if (!bot) {
+            throw new Error(`未找到平台 ${target.platform} 的 bot`);
+        }
+        // 发送消息到目标频道
+        await bot.sendMessage(target.channelId, message, target.guildId);
+        return { target, success: true };
+    }
+    catch (error) {
+        return {
+            target,
+            success: false,
+            error: error instanceof Error ? error : new Error(String(error))
+        };
+    }
+}
+/**
+ * 并发推送消息到多个目标
+ * 需求 5.6: 使用 Promise.allSettled 并发推送并限制并发数
+ * 需求 5.7: 推送失败记录错误日志但不影响其他目标的推送
+ * @param ctx Koishi 上下文
+ * @param targets 推送目标列表
+ * @param message 消息内容
+ * @param concurrency 并发数限制
+ * @returns 推送结果列表
+ */
+async function pushWithConcurrency(ctx, targets, message, concurrency) {
+    if (targets.length === 0) {
+        return [];
+    }
+    const results = [];
+    const queue = [...targets];
+    // 创建工作协程
+    const workers = Array(Math.min(concurrency, queue.length))
+        .fill(null)
+        .map(async () => {
+        while (queue.length > 0) {
+            const target = queue.shift();
+            if (!target)
+                break;
+            const result = await sendMessage(ctx, target, message);
+            results.push(result);
+            // 需求 5.7: 推送失败记录错误日志但不影响其他目标
+            if (!result.success && result.error) {
+                logger.error(`推送失败 [${target.platform}:${target.channelId}]: ${result.error.message}`);
+            }
+        }
+    });
+    await Promise.all(workers);
+    return results;
+}
+/**
+ * 推送消息到所有订阅目标
+ * @param ctx Koishi 上下文
+ * @param event 解析后的事件
+ * @param concurrency 并发数限制
+ * @returns 推送结果列表
+ */
+async function pushMessage(ctx, event, concurrency = 5) {
+    // 查询订阅目标
+    const targets = await queryTargets(ctx, event.repo, event.type);
+    if (targets.length === 0) {
+        logger.debug(`仓库 ${event.repo} 的 ${event.type} 事件没有订阅目标`);
+        return [];
+    }
+    logger.info(`准备推送 ${event.type} 事件到 ${targets.length} 个目标`);
+    // 构建消息
+    const message = (0, message_1.buildMessage)(event);
+    // 并发推送
+    const results = await pushWithConcurrency(ctx, targets, message, concurrency);
+    // 统计结果
+    const successCount = results.filter(r => r.success).length;
+    const failCount = results.filter(r => !r.success).length;
+    logger.info(`推送完成: 成功 ${successCount}, 失败 ${failCount}`);
+    return results;
+}
+/**
+ * 推送事件（完整流程）
+ * 整合事件解析、消息构建和推送
+ * @param ctx Koishi 上下文
+ * @param event 解析后的事件
+ * @param concurrency 并发数限制
+ * @returns 推送结果
+ */
+async function pushEvent(ctx, event, concurrency = 5) {
+    const results = await pushMessage(ctx, event, concurrency);
+    return {
+        pushed: results.filter(r => r.success).length,
+        failed: results.filter(r => !r.success).length,
+        results,
+    };
+}

package/lib/repository/delivery.d.ts

@@ -0,0 +1,38 @@
+/**
+ * 投递记录数据访问层
+ * 需求: 1.6
+ */
+import { Context } from 'koishi';
+import { Delivery } from '../database';
+/**
+ * 记录投递
+ * 需求 1.6: 记录 Delivery ID 用于去重
+ * @param ctx Koishi 上下文
+ * @param deliveryId GitHub Delivery ID
+ * @param repo 仓库名 (owner/repo)
+ * @param event 事件类型
+ * @returns 创建的投递记录
+ */
+export declare function recordDelivery(ctx: Context, deliveryId: string, repo: string, event: string): Promise<Delivery>;
+/**
+ * 检查是否已投递
+ * 需求 1.6: 检查 Delivery ID 是否已处理过，用于去重
+ * @param ctx Koishi 上下文
+ * @param deliveryId GitHub Delivery ID
+ * @returns 是否已投递
+ */
+export declare function isDelivered(ctx: Context, deliveryId: string): Promise<boolean>;
+/**
+ * 获取投递记录
+ * @param ctx Koishi 上下文
+ * @param deliveryId GitHub Delivery ID
+ * @returns 投递记录，不存在返回 null
+ */
+export declare function getDelivery(ctx: Context, deliveryId: string): Promise<Delivery | null>;
+/**
+ * 清理旧的投递记录
+ * @param ctx Koishi 上下文
+ * @param beforeDate 清理此日期之前的记录
+ * @returns 清理的记录数
+ */
+export declare function cleanupDeliveries(ctx: Context, beforeDate: Date): Promise<number>;

package/lib/repository/delivery.js

@@ -0,0 +1,63 @@
+"use strict";
+/**
+ * 投递记录数据访问层
+ * 需求: 1.6
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.recordDelivery = recordDelivery;
+exports.isDelivered = isDelivered;
+exports.getDelivery = getDelivery;
+exports.cleanupDeliveries = cleanupDeliveries;
+/**
+ * 记录投递
+ * 需求 1.6: 记录 Delivery ID 用于去重
+ * @param ctx Koishi 上下文
+ * @param deliveryId GitHub Delivery ID
+ * @param repo 仓库名 (owner/repo)
+ * @param event 事件类型
+ * @returns 创建的投递记录
+ */
+async function recordDelivery(ctx, deliveryId, repo, event) {
+    const now = new Date();
+    await ctx.database.create('github_deliveries', {
+        deliveryId,
+        repo,
+        event,
+        receivedAt: now,
+    });
+    const [created] = await ctx.database.get('github_deliveries', { deliveryId });
+    return created;
+}
+/**
+ * 检查是否已投递
+ * 需求 1.6: 检查 Delivery ID 是否已处理过，用于去重
+ * @param ctx Koishi 上下文
+ * @param deliveryId GitHub Delivery ID
+ * @returns 是否已投递
+ */
+async function isDelivered(ctx, deliveryId) {
+    const deliveries = await ctx.database.get('github_deliveries', { deliveryId });
+    return deliveries.length > 0;
+}
+/**
+ * 获取投递记录
+ * @param ctx Koishi 上下文
+ * @param deliveryId GitHub Delivery ID
+ * @returns 投递记录，不存在返回 null
+ */
+async function getDelivery(ctx, deliveryId) {
+    const deliveries = await ctx.database.get('github_deliveries', { deliveryId });
+    return deliveries.length > 0 ? deliveries[0] : null;
+}
+/**
+ * 清理旧的投递记录
+ * @param ctx Koishi 上下文
+ * @param beforeDate 清理此日期之前的记录
+ * @returns 清理的记录数
+ */
+async function cleanupDeliveries(ctx, beforeDate) {
+    const result = await ctx.database.remove('github_deliveries', {
+        receivedAt: { $lt: beforeDate },
+    });
+    return result.removed ?? 0;
+}

package/lib/repository/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * 数据访问层导出
+ */
+export * from './trust';
+export * from './subscription';
+export * from './delivery';

package/lib/repository/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 });
+__exportStar(require("./trust"), exports);
+__exportStar(require("./subscription"), exports);
+__exportStar(require("./delivery"), exports);