mirror of
https://github.com/ReCloudStudio/WebHooker.git
synced 2026-09-22 16:11:29 +00:00
refactor: modularize into core/events/formatters/drivers
This commit is contained in:
parent
7b341ff9f4
commit
0af6b9a4b8
62 changed files with 2430 additions and 2015 deletions
|
|
@ -15,26 +15,42 @@ npm run dev # Start local dev server
|
|||
```text
|
||||
src/
|
||||
├── index.ts # CF Workers entry (fetch + scheduled), scheduled = command sync
|
||||
├── types.ts # Env, Config, Route, Filter, WebhookEvent, FormattedMessage
|
||||
├── types.ts # Env, Config, Route, Filter, WebhookEvent, NeutralMessage
|
||||
├── config.ts # Loads routes from KV (returns [] if unset), builds Config from env
|
||||
├── server.ts # Hono app: /health, /webhook, /discord/interactions, mounts /auth, /admin + /
|
||||
├── webhook.ts # HMAC verify (Web Crypto), parseEvent, extractBranch, matchRoute
|
||||
├── discord.ts # Dispatch to Discord via REST (sendMessage)
|
||||
├── discord-rest.ts # Discord REST sendMessage with retry + rate-limit handling
|
||||
├── discord-interactions.ts # Ed25519 verify + interaction handlers (/gh, buttons, modals) + command registration
|
||||
├── formatter.ts # 23 event formatters + generic fallback
|
||||
├── github-oauth.ts # OAuth URL, callback token exchange, getUserOctokit
|
||||
├── oauth-routes.ts # GET /auth/github, callback, DELETE /token/:userId (KV state)
|
||||
├── action-routes.ts # POST /api/comment|merge|close|react (Bearer token auth via KV lookup)
|
||||
├── admin-routes.ts # /admin API: routes, groups, me, logs (session + scope auth)
|
||||
├── admin-session.ts # Admin session CRUD (KV session:{id}), cookie helpers
|
||||
├── groups.ts # Group loading, group-admin access scoping
|
||||
├── i18n.ts # Message language overrides (en/zh)
|
||||
├── send-log.ts # Send logging (logs:send KV keys)
|
||||
├── token-store.ts # KV-based token CRUD with findUserIdByToken reverse lookup
|
||||
├── home-routes.ts # Landing page routes
|
||||
├── legal-routes.ts # Legal page routes
|
||||
└── log.ts # JSON console logger (info/warn/error/fatal)
|
||||
├── core/
|
||||
│ └── dispatch.ts # Platform-neutral dispatch: match routes → formatEvent → getDriver().send
|
||||
├── events/ # GitHub webhook pipeline
|
||||
│ ├── verify.ts # HMAC signature verification (Web Crypto, timing-safe)
|
||||
│ ├── parse.ts # parseEvent (headers + body → WebhookEvent)
|
||||
│ └── match.ts # matchRoute, eventOwners, extractBranch, keyword filtering
|
||||
├── formatters/ # Platform-neutral formatters (produce NeutralMessage)
|
||||
│ ├── index.ts # formatEvent: 24-event switch → NeutralMessage + re-exports
|
||||
│ ├── colors.ts # GITHUB_COLORS + WORKFLOW_CONCLUSION_EMOJI
|
||||
│ ├── helpers.ts # emojiPrefix, T, buildMessage
|
||||
│ └── *.ts # push, pull-request, issues, comments, workflow, release, repo, ...
|
||||
├── drivers/ # Platform drivers (pluggable push targets)
|
||||
│ ├── types.ts # PlatformDriver interface + SendResult
|
||||
│ ├── index.ts # getDriver() registry (discord + telegram stub)
|
||||
│ ├── discord/ # index.ts (driver), render.ts (NeutralMessage → embed),
|
||||
│ │ # rest.ts, interactions.ts, commands.ts
|
||||
│ └── telegram/ # TelegramDriver stub (not implemented yet)
|
||||
├── github/ # GitHub OAuth + as-user actions
|
||||
│ ├── oauth.ts # OAuth URL, callback token exchange, getUserOctokit, actions
|
||||
│ └── store.ts # KV-based token CRUD + discord-link mapping
|
||||
├── web/ # HTTP UI/API routes
|
||||
│ ├── oauth-routes.ts # GET /auth/github, callback, DELETE /token/:userId (KV state)
|
||||
│ ├── action-routes.ts # POST /api/comment|merge|close|react (Bearer token auth via KV lookup)
|
||||
│ ├── admin-routes.ts # /admin API: routes, groups, me, logs (session + scope auth)
|
||||
│ ├── session.ts # Admin session CRUD (KV session:{id}), cookie helpers
|
||||
│ ├── groups.ts # Group loading, group-admin access scoping
|
||||
│ ├── home-routes.ts # Landing page routes
|
||||
│ └── legal-routes.ts # Legal page routes
|
||||
└── lib/ # Shared infrastructure
|
||||
├── i18n.ts # Message language overrides (en/zh)
|
||||
├── send-log.ts # Send logging (logs:send KV keys)
|
||||
├── log.ts # JSON console logger (info/warn/error/fatal)
|
||||
└── locales/ # en.ts, zh.ts translation dictionaries
|
||||
```
|
||||
|
||||
## Scripts
|
||||
|
|
@ -74,11 +90,11 @@ curl http://localhost:8787/health
|
|||
|
||||
## Adding a New Event Formatter
|
||||
|
||||
1. Add the event type to `GITHUB_COLORS` in `formatter.ts` (if new color needed)
|
||||
1. Add the event type to `GITHUB_COLORS` in `src/formatters/colors.ts` (if new color needed)
|
||||
2. Add action labels to `ACTION_LABELS` (if new actions)
|
||||
3. Create a `formatEventType` function in `formatter.ts`
|
||||
4. Add the case to the `formatEvent` switch statement
|
||||
5. Update `extractBranch` in `webhook.ts` if the event has branch info
|
||||
3. Create a `formatEventType` function in `src/formatters/`
|
||||
4. Add the case to the `formatEvent` switch statement in `src/formatters/index.ts`
|
||||
5. Update `extractBranch` in `src/events/match.ts` if the event has branch info
|
||||
6. Add the event to the documentation in `docs/events/supported.md`
|
||||
7. Subscribe to the event in your GitHub App settings
|
||||
|
||||
|
|
|
|||
|
|
@ -15,26 +15,42 @@ npm run dev # 启动本地开发服务器
|
|||
```text
|
||||
src/
|
||||
├── index.ts # CF Workers 入口 (fetch + scheduled)，scheduled = 命令同步
|
||||
├── types.ts # Env、Config、Route、Filter、WebhookEvent、FormattedMessage
|
||||
├── types.ts # Env、Config、Route、Filter、WebhookEvent、NeutralMessage
|
||||
├── config.ts # 从 KV 加载路由（未设置时返回 []），从 env 构建 Config
|
||||
├── server.ts # Hono 应用: /health、/webhook、/discord/interactions，挂载 /auth、/admin + /
|
||||
├── webhook.ts # HMAC 验证 (Web Crypto)、parseEvent、extractBranch、matchRoute
|
||||
├── discord.ts # 通过 Discord REST 分发 (sendMessage)
|
||||
├── discord-rest.ts # Discord REST sendMessage，带重试和限流处理
|
||||
├── discord-interactions.ts # Ed25519 验签 + 交互处理 (/gh、按钮、modal) + 命令注册
|
||||
├── formatter.ts # 23 种事件格式化器 + 通用回退
|
||||
├── github-oauth.ts # OAuth URL、回调 Token 交换、getUserOctokit
|
||||
├── oauth-routes.ts # GET /auth/github、回调、DELETE /token/:userId (KV 状态)
|
||||
├── action-routes.ts # POST /api/comment|merge|close|react (通过 KV 查找进行 Bearer Token 鉴权)
|
||||
├── admin-routes.ts # /admin API：路由、分组、me、日志（会话 + 权限范围鉴权）
|
||||
├── admin-session.ts # 管理员会话 CRUD (KV session:{id})、Cookie 辅助函数
|
||||
├── groups.ts # 分组加载、分组管理员权限范围
|
||||
├── i18n.ts # 消息语言覆盖 (en/zh)
|
||||
├── send-log.ts # 发送日志 (logs:send KV 键)
|
||||
├── token-store.ts # 基于 KV 的 Token CRUD，带 findUserIdByToken 反向查找
|
||||
├── home-routes.ts # 落地页路由
|
||||
├── legal-routes.ts # 法律页面路由
|
||||
└── log.ts # JSON 控制台日志 (info/warn/error/fatal)
|
||||
├── core/
|
||||
│ └── dispatch.ts # 平台中立分发：匹配路由 → formatEvent → getDriver().send
|
||||
├── events/ # GitHub webhook 事件流水线
|
||||
│ ├── verify.ts # HMAC 签名验证 (Web Crypto，时间安全)
|
||||
│ ├── parse.ts # parseEvent (headers + body → WebhookEvent)
|
||||
│ └── match.ts # matchRoute、eventOwners、extractBranch、关键词过滤
|
||||
├── formatters/ # 平台中立格式化器（产出 NeutralMessage）
|
||||
│ ├── index.ts # formatEvent：24 事件 switch → NeutralMessage + re-export
|
||||
│ ├── colors.ts # GITHUB_COLORS + WORKFLOW_CONCLUSION_EMOJI
|
||||
│ ├── helpers.ts # emojiPrefix、T、buildMessage
|
||||
│ └── *.ts # push、pull-request、issues、comments、workflow、release、repo 等
|
||||
├── drivers/ # 平台驱动（可插拔推送目标）
|
||||
│ ├── types.ts # PlatformDriver 接口 + SendResult
|
||||
│ ├── index.ts # getDriver() 注册表（discord + telegram 占位）
|
||||
│ ├── discord/ # index.ts (驱动)、render.ts (NeutralMessage → embed)、
|
||||
│ │ # rest.ts、interactions.ts、commands.ts
|
||||
│ └── telegram/ # TelegramDriver 占位（未实现）
|
||||
├── github/ # GitHub OAuth + 以用户身份操作
|
||||
│ ├── oauth.ts # OAuth URL、回调 Token 交换、getUserOctokit、操作
|
||||
│ └── store.ts # 基于 KV 的 Token CRUD + discord-link 映射
|
||||
├── web/ # HTTP UI/API 路由
|
||||
│ ├── oauth-routes.ts # GET /auth/github、回调、DELETE /token/:userId (KV 状态)
|
||||
│ ├── action-routes.ts # POST /api/comment|merge|close|react (通过 KV 查找进行 Bearer Token 鉴权)
|
||||
│ ├── admin-routes.ts # /admin API：路由、分组、me、日志（会话 + 权限范围鉴权）
|
||||
│ ├── session.ts # 管理员会话 CRUD (KV session:{id})、Cookie 辅助函数
|
||||
│ ├── groups.ts # 分组加载、分组管理员权限范围
|
||||
│ ├── home-routes.ts # 落地页路由
|
||||
│ └── legal-routes.ts # 法律页面路由
|
||||
└── lib/ # 共享基础设施
|
||||
├── i18n.ts # 消息语言覆盖 (en/zh)
|
||||
├── send-log.ts # 发送日志 (logs:send KV 键)
|
||||
├── log.ts # JSON 控制台日志 (info/warn/error/fatal)
|
||||
└── locales/ # en.ts、zh.ts 翻译字典
|
||||
```
|
||||
|
||||
## 脚本
|
||||
|
|
@ -74,11 +90,11 @@ curl http://localhost:8787/health
|
|||
|
||||
## 添加新事件格式化器
|
||||
|
||||
1. 将事件类型添加到 `formatter.ts` 中的 `GITHUB_COLORS`（如果需要新颜色）
|
||||
1. 将事件类型添加到 `src/formatters/colors.ts` 中的 `GITHUB_COLORS`（如果需要新颜色）
|
||||
2. 将操作标签添加到 `ACTION_LABELS`（如果有新操作）
|
||||
3. 在 `formatter.ts` 中创建 `formatEventType` 函数
|
||||
4. 将 case 添加到 `formatEvent` switch 语句
|
||||
5. 如果事件包含分支信息，更新 `webhook.ts` 中的 `extractBranch`
|
||||
3. 在 `src/formatters/` 中创建 `formatEventType` 函数
|
||||
4. 将 case 添加到 `src/formatters/index.ts` 中的 `formatEvent` switch 语句
|
||||
5. 如果事件包含分支信息，更新 `src/events/match.ts` 中的 `extractBranch`
|
||||
6. 将事件添加到 `docs/events/supported.md` 文档中
|
||||
7. 在 GitHub App 设置中订阅该事件
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue