koishi-plugin-githubsth 1.0.3 → 1.0.4

package/lib/commands/index.js

@@ -37,17 +37,12 @@ exports.apply = apply;
 const repo = __importStar(require("./repo"));
 const admin = __importStar(require("./admin"));
 const subscribe = __importStar(require("./subscribe"));
+const render = __importStar(require("./render"));
 function apply(ctx, config) {
-    console.log('Applying githubsth commands...');
-    // Register parent command to show help
-    ctx.command('githubsth', 'GitHub 推送通知')
-        .action(({ session }) => {
-        session?.execute('help githubsth');
-    });
+    ctx.command('githubsth', 'GitHub 订阅通知')
+        .action(({ session }) => session?.execute('help githubsth'));
     ctx.plugin(repo, config);
-    console.log('githubsth.repo loaded');
     ctx.plugin(admin, config);
-    console.log('githubsth.admin loaded');
     ctx.plugin(subscribe, config);
-    console.log('githubsth.subscribe loaded');
+    ctx.plugin(render, config);
 }

package/lib/commands/render.d.ts

@@ -0,0 +1,3 @@
+import { Context } from 'koishi';
+import { Config } from '../config';
+export declare function apply(ctx: Context, config: Config): void;

package/lib/commands/render.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.apply = apply;
+const modes = ['text', 'image', 'auto'];
+const themes = ['compact', 'card', 'terminal'];
+const events = ['push', 'issues', 'issue_comment', 'pull_request', 'pull_request_review', 'star', 'fork', 'release', 'discussion', 'workflow_run'];
+function apply(ctx, config) {
+    ctx.command('githubsth.render', '通知渲染设置（文本/图片）', { authority: 3 })
+        .alias('gh.render');
+    ctx.command('githubsth.render.status', '查看渲染状态', { authority: 3 })
+        .action(async () => {
+        const status = ctx.githubsthNotifier.getRenderStatus();
+        return [
+            `mode: ${status.mode} (configured: ${status.configuredMode})`,
+            `fallback: ${status.fallback}`,
+            `theme: ${status.theme}`,
+            `width: ${status.width}`,
+            `timeout: ${status.timeoutMs}ms`,
+            `puppeteer: ${status.hasPuppeteer ? 'ready' : 'missing'}`,
+        ].join('\n');
+    });
+    ctx.command('githubsth.render.mode <mode:string>', '切换渲染模式（text/image/auto）', { authority: 3 })
+        .action(async (_, mode) => {
+        if (!mode || !modes.includes(mode)) {
+            return `无效模式。可选：${modes.join(', ')}`;
+        }
+        ctx.githubsthNotifier.setRenderMode(mode);
+        return `已切换运行时渲染模式为 ${mode}（重启后恢复配置值 ${config.renderMode}）。`;
+    });
+    ctx.command('githubsth.render.theme <theme:string>', '切换图片主题（compact/card/terminal）', { authority: 3 })
+        .action(async (_, theme) => {
+        if (!theme || !themes.includes(theme)) {
+            return `无效主题。可选：${themes.join(', ')}`;
+        }
+        config.renderTheme = theme;
+        return `已切换图片主题为 ${theme}（当前进程生效）。`;
+    });
+    ctx.command('githubsth.render.width <width:number>', '设置图片宽度', { authority: 3 })
+        .action(async (_, width) => {
+        if (!width || Number.isNaN(width))
+            return '请提供有效的数字宽度。';
+        const normalized = Math.max(480, Math.min(1600, Math.floor(width)));
+        config.renderWidth = normalized;
+        return `已设置图片宽度为 ${normalized}px（当前进程生效）。`;
+    });
+    ctx.command('githubsth.render.preview [event:string]', '预览通知渲染', { authority: 3 })
+        .action(async ({ session }, event) => {
+        const selected = event && events.includes(event) ? event : 'issue_comment';
+        if (event && !events.includes(event)) {
+            await session?.send(`未知事件 ${event}，已改用默认事件 issue_comment。`);
+        }
+        const preview = await ctx.githubsthNotifier.renderPreview(selected);
+        return preview || '预览失败：请检查 puppeteer 或渲染配置。';
+    });
+}

package/lib/config.d.ts

@@ -5,6 +5,9 @@ export interface Rule {
     platform?: string;
     events: string[];
 }
+export type RenderMode = 'text' | 'image' | 'auto';
+export type RenderFallback = 'text' | 'drop';
+export type RenderTheme = 'compact' | 'card' | 'terminal';
 export interface Config {
     defaultOwner?: string;
     defaultRepo?: string;
@@ -16,6 +19,11 @@ export interface Config {
     sendRetryCount: number;
     sendRetryBaseDelayMs: number;
     formatterLocale: 'zh-CN' | 'en-US';
+    renderMode: RenderMode;
+    renderFallback: RenderFallback;
+    renderTheme: RenderTheme;
+    renderWidth: number;
+    renderTimeoutMs: number;
     rules?: Rule[];
 }
 export declare const Config: Schema<Config>;

package/lib/config.js

@@ -15,6 +15,22 @@ exports.Config = koishi_1.Schema.object({
         koishi_1.Schema.const('zh-CN').description('中文'),
         koishi_1.Schema.const('en-US').description('English'),
     ]).default('zh-CN').description('通知文本语言。'),
+    renderMode: koishi_1.Schema.union([
+        koishi_1.Schema.const('auto').description('自动：优先图片，失败回退'),
+        koishi_1.Schema.const('image').description('仅图片'),
+        koishi_1.Schema.const('text').description('仅文本'),
+    ]).default('auto').description('通知渲染模式。'),
+    renderFallback: koishi_1.Schema.union([
+        koishi_1.Schema.const('text').description('图片失败回退文本'),
+        koishi_1.Schema.const('drop').description('图片失败则丢弃'),
+    ]).default('text').description('图片渲染失败时的回退策略。'),
+    renderTheme: koishi_1.Schema.union([
+        koishi_1.Schema.const('compact').description('紧凑样式'),
+        koishi_1.Schema.const('card').description('卡片样式'),
+        koishi_1.Schema.const('terminal').description('终端样式'),
+    ]).default('compact').description('图片通知主题。'),
+    renderWidth: koishi_1.Schema.number().min(480).max(1600).default(840).description('图片宽度（像素）。'),
+    renderTimeoutMs: koishi_1.Schema.number().min(1000).max(60000).default(12000).description('单次图片渲染超时（毫秒）。'),
     defaultEvents: koishi_1.Schema.array(koishi_1.Schema.string())
         .default(['push', 'issues', 'issue_comment', 'pull_request', 'pull_request_review', 'release', 'star', 'fork'])
         .description('未显式指定时使用的默认订阅事件列表。'),

package/lib/database.js

@@ -10,6 +10,7 @@ function apply(ctx) {
         events: 'list',
     }, {
         autoInc: true,
+        unique: ['repo', 'channelId', 'platform'],
     });
     ctx.model.extend('github_trusted_repo', {
         id: 'unsigned',

package/lib/index.js

@@ -50,7 +50,7 @@ const formatter_1 = require("./services/formatter");
 exports.name = 'githubsth';
 exports.inject = {
     required: ['database'],
-    optional: ['github'],
+    optional: ['github', 'puppeteer'],
 };
 __exportStar(require("./config"), exports);
 function apply(ctx, config) {

package/lib/services/formatter.d.ts

@@ -1,4 +1,4 @@
-import { Context, Service, h } from 'koishi';
+import { Context, Service } from 'koishi';
 import type { Config } from '../config';
 declare module 'koishi' {
     interface Context {
@@ -8,16 +8,16 @@ declare module 'koishi' {
 export declare class Formatter extends Service {
     private readonly locale;
     constructor(ctx: Context, config?: Partial<Config>);
-    formatPush(payload: any): h | null;
-    formatIssue(payload: any): h;
-    formatPullRequest(payload: any): h;
-    formatStar(payload: any): h | null;
-    formatFork(payload: any): h;
-    formatRelease(payload: any): h | null;
-    formatDiscussion(payload: any): h;
-    formatWorkflowRun(payload: any): h | null;
-    formatIssueComment(payload: any): h | null;
-    formatPullRequestReview(payload: any): h | null;
+    formatPush(payload: any): string | null;
+    formatIssue(payload: any): string;
+    formatPullRequest(payload: any): string;
+    formatStar(payload: any): string | null;
+    formatFork(payload: any): string;
+    formatRelease(payload: any): string | null;
+    formatDiscussion(payload: any): string;
+    formatWorkflowRun(payload: any): string | null;
+    formatIssueComment(payload: any): string | null;
+    formatPullRequestReview(payload: any): string | null;
     private summarizeCommentBody;
     private mapAction;
     private t;

package/lib/services/formatter.js

@@ -10,7 +10,6 @@ const I18N = {
         unknownState: '未知状态',
         unknownBranch: '未知分支',
         unknownResult: '未知结果',
-        noDescription: '无描述',
         emptyComment: '（空评论）',
         hiddenMachinePayload: '检测到自动化系统签名/编码载荷，已省略原始内容。',
         pushTitle: '🚀 [代码推送]',
@@ -71,7 +70,6 @@ const I18N = {
         unknownState: 'Unknown state',
         unknownBranch: 'Unknown branch',
         unknownResult: 'Unknown result',
-        noDescription: 'No description',
         emptyComment: '(empty comment)',
         hiddenMachinePayload: 'Detected automated signature/encoded payload. Raw content hidden.',
         pushTitle: '🚀 [Push Event]',
@@ -280,11 +278,9 @@ class Formatter extends koishi_1.Service {
         const content = String(raw || '').replace(/\r/g, '').trim();
         if (!content)
             return this.t('emptyComment');
-        // Typical Vercel/GitHub app machine signature payload: [vc]: #<token>:<payload>
         if (/^\[vc\]:\s*#[A-Za-z0-9+/=_:-]+/i.test(content)) {
             return this.t('hiddenMachinePayload');
         }
-        // Very long high-entropy lines are usually bot payloads/signatures.
         const oneLine = content.replace(/\n+/g, ' ');
         const looksEncoded = oneLine.length > 120 && !/\s/.test(oneLine.slice(0, 80));
         if (looksEncoded)
@@ -301,7 +297,7 @@ class Formatter extends koishi_1.Service {
         return template.replace(/\{(\d+)\}/g, (_, idx) => String(params[Number(idx)] ?? ''));
     }
     render(lines) {
-        return (0, koishi_1.h)('message', [(0, koishi_1.h)('text', { content: `${lines.join('\n')}\n` })]);
+        return `${lines.join('\n')}\n`;
     }
 }
 exports.Formatter = Formatter;

package/lib/services/notifier.d.ts

@@ -1,5 +1,5 @@
-import { Context, Service } from 'koishi';
-import { Config } from '../config';
+import { Context, Service, h } from 'koishi';
+import { Config, RenderMode } from '../config';
 declare module 'koishi' {
     interface Context {
         githubsthNotifier: Notifier;
@@ -11,9 +11,27 @@ export declare class Notifier extends Service {
     private readonly recentEventKeys;
     private readonly memoryDedupWindowMs;
     private dedupWriteCounter;
+    private runtimeRenderMode;
     constructor(ctx: Context, config: Config);
+    setRenderMode(mode: RenderMode): void;
+    getRenderMode(): RenderMode;
+    getRenderStatus(): {
+        mode: RenderMode;
+        configuredMode: RenderMode;
+        fallback: import("../config").RenderFallback;
+        theme: import("../config").RenderTheme;
+        width: number;
+        timeoutMs: number;
+        hasPuppeteer: boolean;
+    };
+    renderPreview(event?: string): Promise<string | h | null>;
     private registerListeners;
     private handleEvent;
+    private formatByEvent;
+    private prepareOutboundMessage;
+    private renderTextAsImage;
+    private buildImageHtml;
+    private escapeHtml;
     private extractRepoName;
     private patchPayloadForEvent;
     private buildEventDedupKey;
@@ -22,4 +40,5 @@ export declare class Notifier extends Service {
     private sendMessage;
     private sendWithRetry;
     private sleep;
+    private getPreviewPayload;
 }

package/lib/services/notifier.js

@@ -10,9 +10,33 @@ class Notifier extends koishi_1.Service {
         this.recentEventKeys = new Map();
         this.memoryDedupWindowMs = 5000;
         this.dedupWriteCounter = 0;
+        this.runtimeRenderMode = null;
         this.ctx.logger('githubsth').info('Notifier service initialized');
         this.registerListeners();
     }
+    setRenderMode(mode) {
+        this.runtimeRenderMode = mode;
+    }
+    getRenderMode() {
+        return this.runtimeRenderMode || this.config.renderMode;
+    }
+    getRenderStatus() {
+        const puppeteer = this.ctx.puppeteer;
+        return {
+            mode: this.getRenderMode(),
+            configuredMode: this.config.renderMode,
+            fallback: this.config.renderFallback,
+            theme: this.config.renderTheme,
+            width: this.config.renderWidth,
+            timeoutMs: this.config.renderTimeoutMs,
+            hasPuppeteer: Boolean(puppeteer?.render),
+        };
+    }
+    async renderPreview(event = 'issue_comment') {
+        const payload = this.getPreviewPayload(event);
+        const text = this.formatByEvent(event, payload) || this.formatByEvent('issue_comment', this.getPreviewPayload('issue_comment')) || 'Preview unavailable.';
+        return this.prepareOutboundMessage(text);
+    }
     registerListeners() {
         const bind = (name, event) => {
             this.ctx.on(name, (payload) => this.handleEvent(event, payload));
@@ -76,9 +100,6 @@ class Notifier extends koishi_1.Service {
         }
     }
     async handleEvent(event, payload) {
-        if (this.config.debug) {
-            this.ctx.logger('githubsth').info(`Received event: ${event}`);
-        }
         const realPayload = payload.payload || payload;
         if (payload.actor && !realPayload.sender) {
             const actorLogin = payload.actor.login || payload.actor.name || 'GitHub';
@@ -128,10 +149,6 @@ class Notifier extends koishi_1.Service {
             this.ctx.logger('githubsth').warn('Cannot query rules: repoName is missing');
             return;
         }
-        if (this.config.debug) {
-            this.ctx.logger('githubsth').info(`Processing event ${event} for ${repoName}`);
-            this.ctx.logger('notifier').debug(JSON.stringify(realPayload, null, 2));
-        }
         const repoNames = [repoName];
         if (repoName !== repoName.toLowerCase())
             repoNames.push(repoName.toLowerCase());
@@ -144,50 +161,151 @@ class Notifier extends koishi_1.Service {
         const matchedRules = allRules.filter((rule) => rule.events.includes('*') || rule.events.includes(event));
         if (!matchedRules.length)
             return;
-        let message = null;
+        // De-duplicate same delivery target to avoid double push caused by duplicated rules.
+        const uniqueRules = Array.from(new Map(matchedRules.map((rule) => [`${repoName}|${rule.channelId}`, rule])).values());
+        const textMessage = this.formatByEvent(event, realPayload);
+        if (!textMessage)
+            return;
+        const outbound = await this.prepareOutboundMessage(textMessage);
+        if (!outbound) {
+            if (this.config.debug)
+                this.ctx.logger('githubsth').warn(`Drop message because render failed and fallback=drop (${event}, ${repoName})`);
+            return;
+        }
+        for (const rule of uniqueRules) {
+            await this.sendMessage(rule, outbound);
+        }
+    }
+    formatByEvent(event, payload) {
+        switch (event) {
+            case 'push':
+                return this.ctx.githubsthFormatter.formatPush(payload);
+            case 'issues':
+                return this.ctx.githubsthFormatter.formatIssue(payload);
+            case 'pull_request':
+                return this.ctx.githubsthFormatter.formatPullRequest(payload);
+            case 'star':
+                return this.ctx.githubsthFormatter.formatStar(payload);
+            case 'fork':
+                return this.ctx.githubsthFormatter.formatFork(payload);
+            case 'release':
+                return this.ctx.githubsthFormatter.formatRelease(payload);
+            case 'discussion':
+                return this.ctx.githubsthFormatter.formatDiscussion(payload);
+            case 'workflow_run':
+                return this.ctx.githubsthFormatter.formatWorkflowRun(payload);
+            case 'issue_comment':
+                return this.ctx.githubsthFormatter.formatIssueComment(payload);
+            case 'pull_request_review':
+                return this.ctx.githubsthFormatter.formatPullRequestReview(payload);
+            default:
+                return null;
+        }
+    }
+    async prepareOutboundMessage(textMessage) {
+        const mode = this.getRenderMode();
+        if (mode === 'text')
+            return textMessage;
+        const image = await this.renderTextAsImage(textMessage);
+        if (image)
+            return image;
+        if (mode === 'image' && this.config.renderFallback === 'drop')
+            return null;
+        return textMessage;
+    }
+    async renderTextAsImage(textMessage) {
+        const puppeteer = this.ctx.puppeteer;
+        if (!puppeteer || typeof puppeteer.render !== 'function')
+            return null;
         try {
-            switch (event) {
-                case 'push':
-                    message = this.ctx.githubsthFormatter.formatPush(realPayload);
-                    break;
-                case 'issues':
-                    message = this.ctx.githubsthFormatter.formatIssue(realPayload);
-                    break;
-                case 'pull_request':
-                    message = this.ctx.githubsthFormatter.formatPullRequest(realPayload);
-                    break;
-                case 'star':
-                    message = this.ctx.githubsthFormatter.formatStar(realPayload);
-                    break;
-                case 'fork':
-                    message = this.ctx.githubsthFormatter.formatFork(realPayload);
-                    break;
-                case 'release':
-                    message = this.ctx.githubsthFormatter.formatRelease(realPayload);
-                    break;
-                case 'discussion':
-                    message = this.ctx.githubsthFormatter.formatDiscussion(realPayload);
-                    break;
-                case 'workflow_run':
-                    message = this.ctx.githubsthFormatter.formatWorkflowRun(realPayload);
-                    break;
-                case 'issue_comment':
-                    message = this.ctx.githubsthFormatter.formatIssueComment(realPayload);
-                    break;
-                case 'pull_request_review':
-                    message = this.ctx.githubsthFormatter.formatPullRequestReview(realPayload);
-                    break;
-            }
+            const html = this.buildImageHtml(textMessage);
+            const task = puppeteer.render(html);
+            const timeout = this.config.renderTimeoutMs || 12000;
+            const buffer = await Promise.race([
+                task,
+                new Promise((resolve) => setTimeout(() => resolve(null), timeout)),
+            ]);
+            if (!buffer)
+                return null;
+            return koishi_1.h.image(buffer, 'image/png');
         }
         catch (error) {
-            this.ctx.logger('githubsth').error(`Error formatting event ${event}:`, error);
-            return;
+            this.ctx.logger('githubsth').warn('Image render failed:', error);
+            return null;
         }
-        if (!message)
-            return;
-        for (const rule of matchedRules) {
-            await this.sendMessage(rule, message);
+    }
+    buildImageHtml(textMessage) {
+        const escaped = this.escapeHtml(textMessage).replace(/\n/g, '<br/>');
+        const width = this.config.renderWidth || 840;
+        let bg = 'linear-gradient(135deg, #1f2937, #111827)';
+        let card = 'rgba(17, 24, 39, 0.92)';
+        let accent = '#22d3ee';
+        let font = "'Segoe UI', 'PingFang SC', 'Microsoft YaHei', sans-serif";
+        if (this.config.renderTheme === 'card') {
+            bg = 'linear-gradient(140deg, #0f172a, #1e293b)';
+            card = 'rgba(15, 23, 42, 0.9)';
+            accent = '#60a5fa';
+        }
+        else if (this.config.renderTheme === 'terminal') {
+            bg = '#0b1020';
+            card = '#0b1220';
+            accent = '#34d399';
+            font = "'Consolas', 'Courier New', monospace";
         }
+        return `<!doctype html>
+<html>
+<head>
+<meta charset="utf-8" />
+<style>
+  * { box-sizing: border-box; }
+  body {
+    margin: 0;
+    width: ${width}px;
+    background: ${bg};
+    color: #e5e7eb;
+    font-family: ${font};
+  }
+  .wrap {
+    padding: 20px;
+  }
+  .card {
+    border-radius: 14px;
+    border: 1px solid rgba(148, 163, 184, 0.28);
+    background: ${card};
+    overflow: hidden;
+  }
+  .head {
+    padding: 12px 16px;
+    border-bottom: 1px solid rgba(148, 163, 184, 0.24);
+    font-weight: 700;
+    color: ${accent};
+    letter-spacing: .3px;
+  }
+  .content {
+    padding: 14px 16px;
+    line-height: 1.55;
+    word-break: break-word;
+    font-size: 14px;
+  }
+</style>
+</head>
+<body>
+  <div class="wrap">
+    <div class="card">
+      <div class="head">GitHub Notification</div>
+      <div class="content">${escaped}</div>
+    </div>
+  </div>
+</body>
+</html>`;
+    }
+    escapeHtml(input) {
+        return String(input)
+            .replace(/&/g, '&amp;')
+            .replace(/</g, '&lt;')
+            .replace(/>/g, '&gt;')
+            .replace(/"/g, '&quot;')
+            .replace(/'/g, '&#39;');
     }
     extractRepoName(payload, realPayload, event) {
         let repoName = realPayload.repository?.full_name;
@@ -329,7 +447,6 @@ class Notifier extends koishi_1.Service {
         if (recent && now - recent <= this.memoryDedupWindowMs)
             return false;
         this.recentEventKeys.set(dedupKey, now);
-        // durable dedup
         const exists = await this.ctx.database.get('github_event_dedup', { dedupKey });
         if (exists.length > 0)
             return false;
@@ -407,6 +524,55 @@ class Notifier extends koishi_1.Service {
     sleep(ms) {
         return new Promise((resolve) => setTimeout(resolve, ms));
     }
+    getPreviewPayload(event) {
+        const baseRepo = { full_name: 'acmuhan/JackalClientDocs', stargazers_count: 128 };
+        const baseUser = { login: 'acmuhan' };
+        const payload = {
+            action: 'created',
+            repository: baseRepo,
+            sender: baseUser,
+            issue: {
+                number: 29,
+                title: 'Delete demobot',
+                html_url: 'https://github.com/acmuhan/JackalClientDocs/issues/29',
+                pull_request: { html_url: 'https://github.com/acmuhan/JackalClientDocs/pull/29' },
+            },
+            comment: {
+                body: '[vc]: #gOsUN...=eyJpc01vbm9yZXBvIjp0cnVl...'
+            },
+            pull_request: {
+                number: 29,
+                title: 'Delete demobot',
+                state: 'open',
+                html_url: 'https://github.com/acmuhan/JackalClientDocs/pull/29',
+            },
+            workflow_run: {
+                name: 'Deploy',
+                conclusion: 'success',
+                head_branch: 'main',
+                html_url: 'https://github.com/acmuhan/JackalClientDocs/actions/runs/1',
+            },
+            commits: [
+                { id: 'ea5eaddca38f25ce013ee50d70addb49c8d28844', message: 'Delete demobot', author: { name: 'MuHan' } },
+            ],
+            ref: 'refs/heads/main',
+            compare: 'https://github.com/acmuhan/JackalClientDocs/compare/old...new',
+            pusher: { name: 'acmuhan' },
+            release: { tag_name: 'v1.2.0', name: 'Spring Patch', html_url: 'https://github.com/acmuhan/JackalClientDocs/releases/tag/v1.2.0' },
+            forkee: { full_name: 'acmuhan/JackalClientDocs-fork' },
+            discussion: { number: 7, title: 'Roadmap', html_url: 'https://github.com/acmuhan/JackalClientDocs/discussions/7' },
+            review: { state: 'approved', html_url: 'https://github.com/acmuhan/JackalClientDocs/pull/29#pullrequestreview-1' },
+        };
+        if (event === 'star')
+            payload.action = 'created';
+        if (event === 'workflow_run')
+            payload.action = 'completed';
+        if (event === 'pull_request_review')
+            payload.action = 'submitted';
+        if (event === 'release')
+            payload.action = 'published';
+        return payload;
+    }
 }
 exports.Notifier = Notifier;
 Notifier.inject = ['githubsthFormatter', 'database'];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "koishi-plugin-githubsth",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "Github Subscriptions Notifications, push notifications for GitHub subscriptions For koishi",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",