mirror of
https://github.com/Elysola/WebHooker.git
synced 2026-11-20 17:13:49 +00:00
* fix(log): preserve structured error details Error objects lose their useful details when serialized as plain JSON. Keep the message, stack and cause in structured log output. * fix(runtime): bound shared in-flight waits A canceled request can leave its shared promise pending forever. Bound joins and coordinate a single replacement so later requests make progress without multiplying upstream work. * fix(bot): reject oversized callback bodies Reject declared oversized bot callbacks before reading their bodies. This keeps unauthenticated requests from wasting worker resources. * test(d1): exercise real sqlite transactions Exercise real foreign keys, transactions and conditional statements instead of mocks that cannot reproduce lost updates or cascades. * fix(storage): preserve claims across kv fallback Only missing tables justify KV fallback; other failures must surface. Remember fallback writes so migration to D1 cannot forget claims and replay completed work. Share marker checks without extra writes. * fix(filter): use isolated linear-time patterns Backtracking patterns can exhaust worker CPU on untrusted payloads. Use linear-time matching and separate bounded cache namespaces so glob and regex entries cannot corrupt each other. * fix(filter): read each event branch correctly Deployment and check branches live in event-specific nested fields. Read those fields and remove only the actual leading ref prefix. * fix(filter): read only own payload properties Inherited object properties are not webhook payload data. Read own properties only so JSONPath cannot traverse prototypes. * fix(filter): validate executable condition trees Malformed trees and unsupported patterns must not silently turn an exclude rule into a pass. Validate the shape and only the patterns the evaluator actually executes. * fix(i18n): bound and cache translation loads Repeated misses and simultaneous override loads spend KV reads for the same language. Cache confirmed misses and share bounded loads without caching read failures as missing translations. * i18n(bot): explain command and account failures Explain account linking, command failures and skipped delivery outcomes consistently in both supported languages. * fix(github): bound and reuse app token fetches Repeated token exchanges waste requests and JWT work for every event. Reuse valid installation tokens, share refreshes and back off briefly after failures while keeping every shared wait bounded. * fix(github): restrict enrichment request urls Webhook-provided URLs must never receive an installation token on another host. Restrict enrichment to GitHub repository API paths, reject redirects and bound optional requests. * fix(formatter): preserve invalid code points Out-of-range numeric entities can throw while formatting a delivery. Keep invalid code points verbatim instead of aborting the message. * fix(formatter): preserve bounded markdown text Code spans, fences, indentation and autolinks are Markdown content, not HTML tags to strip. Preserve them while bounding cleanup input and reusing results across routes for the same event. * fix(formatter): strip only leading ref prefixes A short branch or tag may itself contain refs/heads or refs/tags. Strip one leading full-ref prefix at the caller and keep short names unchanged when generating labels and links. * fix(gitea): link push authors to their forge A Gitea author is not the same-named GitHub account. Build author profile links from the originating forge. * fix(formatter): render deployment state values The deployment status object stringifies as [object Object]. Render its actual state in the status field. * fix(formatter): read security severity levels The scanner severity is not the security severity of an alert. Prefer the security level so critical and high alerts get the right label and color. * fix(formatter): hide actions on other forges Action buttons call the GitHub API as the linked user. Hide them for other forges to avoid operating on a same-named GitHub repository. * fix(check): isolate updates by check suite Same-named checks from different suites must not edit one message. Include the suite or app identity and retain the former key for controlled adoption of existing tracked messages. * fix(logs): scope queries before limiting results Filter authorized groups in SQL before LIMIT and aggregate only visible rows. Preserve current group attribution for late writes, surface read failures and combine related totals in one scan. * perf(d1): index pruning and failed send queries Pruning and failure views should not scan all historical rows. Index the high-value access paths without adding a write-heavy index for infrequent delivery-detail lookups. * fix(discord): bound individual api requests An unbounded API request can outlive an update-chain lock. Bound each request so another holder cannot race a late edit. * fix(discord): defer long rate-limit waits Long rate-limit sleeps block delivery progress inside a worker. Return a retryable 429 for the queue when the wait exceeds the bound. * fix(discord): encode channel path segments Stored channel and message ids are path segments, not URL paths. Encode them so aliases cannot address another Discord resource. * fix(discord): reuse nonces after lost responses A successful create may lose its response. Reuse a stable nonce with enforce_nonce so retries recover that message instead of posting duplicates or accepting an unreadable success. * fix(discord): constrain embeds and role mentions Respect combined embed and component limits as well as field caps. Restrict allowed mentions to validated route roles so payload text cannot notify everyone. * fix(discord): resume bounded command syncs Application changes, command rollbacks and large guild lists can leave commands stale indefinitely. Track the current hash per app and resume bounded paginated work without needless KV writes. * fix(github): verify installation management An installation id is user-controlled, and repository access is not installation management. Verify the owning account or an active organization admin using the user token and read:org scope. * fix(github): resolve immutable member ids A login can be renamed and reclaimed before its first sign-in. Resolve the current immutable user id when membership is granted so a future holder of the login cannot inherit access. * fix(auth): revoke stale sessions and tokens Revoked or rotated credentials must stop working despite stale KV replicas. Track the live token and revocations in D1 and preserve immutable identity bindings rather than trusting a recycled login. * fix(auth): bind sessions and tokens to identity Automatic retries can repeat non-idempotent user actions. Disable those retries and expose a write hook so bot handlers can record completion immediately before the GitHub write. * fix(discord): defer and deduplicate interactions Acknowledge slow actions before Discord times out and deduplicate interaction writes. Preserve comment text and reject edits whose source changed after the modal opened. * fix(telegram): always verify webhook secrets Webhook verification must not silently disable itself when the optional secret is absent. Derive a stable secret from the bot token and reject callbacks when verification is unavailable. * fix(telegram): bound individual api requests Bound individual platform calls so they cannot outlive the lock protecting a message update or stall a whole delivery invocation. * fix(telegram): honor nested rate-limit delays Telegram places retry_after inside parameters, not at the top level. Read that value and defer long waits to the delivery queue. * fix(telegram): report unreadable send results An unreadable successful response may already have sent the message. Report an explicit uncertain result instead of retrying a create without an idempotency key or pretending it succeeded. * fix(telegram): keep editable messages as text Guessing photo versus text from message content makes later edits use the wrong API and a smaller caption budget. Always send text and use the avatar as a link preview. * fix(telegram): render hard breaks as newlines Telegram HTML does not support br tags. Render Markdown hard breaks as plain newlines so otherwise valid messages are accepted. * fix(telegram): clamp visible html characters Telegram counts visible characters, not HTML source bytes. Truncate without splitting tags, entities or surrogate pairs. * fix(telegram): honor the author emoji toggle The author marker must obey the group emoji preference just like formatter-added decoration. * fix(telegram): keep completed commands claimed Redelivery after a completed write must never post another comment. Keep completion claims despite reply failures, scope updates per bot and only issue account-login links in private chats. * fix(feishu): bound individual api requests Bound individual platform calls so they cannot outlive the lock protecting a message update or stall a whole delivery invocation. * fix(feishu): classify retryable api failures Business error codes can be transient even in HTTP 200 responses. Classify token and rate-limit errors for retry and defer long waits. * fix(feishu): retry sends with stable uuids An unreadable response does not prove a send failed. Reuse the same uuid for retries so recovering the result cannot create a second Feishu message. * fix(feishu): refresh and evict tokens safely Separate app token caches, stop reusing refused tokens and share refreshes. Cache failures briefly and keep valid tokens in memory when a best-effort KV cache write fails. * fix(feishu): use the card update endpoint Delayed card updates use the card update endpoint; the config endpoint cannot update an interaction response. * fix(feishu): neutralize untrusted mentions Forge text is untrusted and can contain at-all tags. Neutralize mentions in card bodies and footers before rendering. * fix(feishu): authenticate and dedupe callbacks Authenticate signed or token-verified callbacks before dispatching commands. Decode encrypted envelopes and handle card actions using the correct fields without claiming irrelevant chat events. * fix(target): normalize actual destinations Different target spellings can name the same actual destination. Normalize channel, thread and topic identities for ownership checks and per-route duplicate suppression. * fix(config): transact per-group configuration Whole-table writes and cached snapshots can overwrite other groups or resurrect removed configuration. Use per-group guarded writes, one-time identity migration and explicit unreadable-row failures. * fix(group): preserve identity through lifecycle Group names are mutable and reusable, so they cannot own durable state. Preserve immutable identities across lifecycle operations and commit invite use with membership under transaction-time guards. * fix(oauth): confirm account links and installs A login link or installation id is not proof of account ownership. Verify installation management, bind browser state and require an explicit account-link confirmation before granting chat access. * fix(queue): fence leases and record target outcomes Retries must remember completed targets and distinguish active lease holders. Fence state updates, preserve permanent outcomes and reject missing parked payloads instead of dispatching empty data. * fix(dispatch): isolate and resume tenant sends Check tenant sources before filters and never dispatch orphan routes. Record each target outcome, isolate update chains by forge and group identity, and keep stale events from overwriting newer messages. * fix(queue): bound batches and resume deliveries A queue invocation has shared query and subrequest limits. Use a small batch and shared send budget, renew fenced leases and resume only unfinished work without exhausting unstarted messages. * fix(admin): guard revisions and tenant targets Read-time authorization alone cannot protect concurrent edits. Guard revisions, current roles and destination ownership in the write transaction, and use per-group endpoints for isolated changes. * fix(webhook): confirm only accepted deliveries Acknowledging before queue acceptance permanently loses deliveries. Confirm only accepted work, release failed claims, scope replay identities and strip tenant-supplied installation authority. * fix(storage): prune abandoned parked payloads Oversized payloads can remain after interrupted enqueue attempts. Prune objects beyond their retry lifetime without deleting payloads that a current delivery may still need. * fix(console): expose api conflict statuses Callers need the HTTP status to distinguish stale edits from other failures and reload current data after a conflict. * refactor(console): model group revisions Carry server revisions explicitly so console writes can reject changes based on an outdated group snapshot. * fix(console): send loaded route revisions Send the revision actually loaded with the route list and adopt the server response after a save. Reload on conflict instead of silently overwriting another editor. * fix(console): guard fragment saves by revision Fragments share a group version with other configuration writes. Submit the loaded revision and reload on conflict to preserve concurrent edits. * fix(console): save groups with guarded writes Whole-list saves can overwrite unrelated groups. Use per-group revision-aware writes, retain rename results and confirm deletion on the exact group, routes and version shown to the user. * fix(console): reject edits of stale routes A conflict reload can leave an older route editor open. Compare its original value before saving so it cannot overwrite the newly loaded route. * fix(console): show overview loading failures Failed overview requests must not look like an empty dashboard or a successful refresh. Show the reason while retaining prior data. * fix(console): explain rejected install bindings Explain why an installation binding was refused instead of silently returning to the console with no visible outcome. * fix(console): allow selecting a group named all The all sentinel collides with a valid group id. Use a value that cannot be a group id so that group stays selectable. * fix(console): discard stale log detail responses An older detail request can finish after a newer selection or close. Discard it so the dialog never shows the previously clicked record. * fix(console): retain legacy group owners Groups predating member roles store owners in adminIds. Load those as owners so adding a member never drops all old owners. * fix(console): lock member edits during saves Edits made during a save are overwritten by its result. Disable member controls and guard handlers until the write settles. * fix(console): show invite loading failures Failed invite loads must not look like no pending invites. Show the error and discard responses from a previously shown group. * fix(console): retain legacy discord log targets A stored log target without platform means Discord. Keep that meaning in the editor instead of clearing the target. * fix(console): retain undisplayed forge sources An editor that only displays some providers must preserve the others. Keep stored custom sources when saving unrelated group settings. * fix(console): lock the group editor while saving Prevent edits while a group save is in flight and make super-only installation settings readonly instead of silently ignoring edits. * fix(console): lock route edits and show failures Lock the route editor while saving and show fragment load failures with a retry action rather than presenting a false empty list. * fix(config): expose the legal contact override Declare the public runtime key so the documented environment override reaches legal pages in deployed Nuxt builds. * build(deploy): migrate d1 before deployment Apply pending D1 migrations before deploying code that requires them. Stop deployment when migration fails instead of running against an incomplete schema. * docs(worker): align guides with runtime behavior Synchronize both language guides, API references and examples with the implemented authorization, storage and delivery behavior. Document migration requirements and accepted operational limits. * fix(storage): repair orphaned KV routes Repair orphaned KV routes before serving KV-only configuration. * fix(security): fully escape forge HTML --------- Co-authored-by: RhenCloud <i@rhen.cloud>
13 KiB
13 KiB
Admin API
Admin endpoints manage routes, groups, members, invites, webhook secrets, send logs, and the audit log. They require an admin session cookie obtained via GET /admin/login (GitHub OAuth); the signed-in user must be listed in ADMIN_USER_IDS or manage a group. For local development only, exact DEBUG_MODE=true bypasses authentication and grants full access; never deploy with it enabled. See Configuration → Web UI for setup.
The console itself is served at /admin; its tabs are deep-linkable via the URL path (/admin/groups, /admin/logs, /admin/audit).
Endpoints
| Endpoint | Description |
|---|---|
GET /admin |
Config console UI |
GET /admin/login |
Start admin sign-in (GitHub OAuth) |
GET /admin/logout |
Sign out and destroy the session |
GET /admin/invite?token=… |
Accept a group invite (browser page) |
GET /admin/api/me |
Current session, scope, groups, and roles |
GET /admin/api/routes |
List routes (scoped to access) |
PUT /admin/api/routes |
Replace routes (owner/admin per group) |
GET /admin/api/groups |
List groups (each with its revision) + the signed-in user's role in each, plus the list revision |
PUT /admin/api/groups |
Bulk write (legacy): super admins replace all groups, owners change/delete their own; only groups that differ are written |
POST /admin/api/groups |
Create one group (super admins) — body { group }; 409 when the id exists or was used recently |
PUT /admin/api/groups/:id |
Update one group (owner) — body { group }; 409 when its revision is stale |
DELETE /admin/api/groups/:id |
Delete one group with its routes and fragments (owner) — query revision, routesRevision and version from the confirmation; 409 when anything changed since |
GET /admin/api/groups/:id/routes |
List a group's routes, with the list's revision, the group version and unreadable |
PUT /admin/api/groups/:id/routes |
Replace a group's routes (owner/admin) — 409 when the sent revision is stale |
GET /admin/api/groups/:id/fragments |
List a group's named filter fragments, with the list's revision |
PUT /admin/api/groups/:id/fragments |
Replace a group's named filter fragments (owner/admin) — body { fragments, revision? }; 409 when the revision is stale |
PUT /admin/api/groups/:id/rename |
Rename a group (owner) — body { newId, revision? }; routes, fragments and history move in one transaction, the secret and invites stay with the group; the old id stays retired for a few days |
GET /admin/api/groups/:id/invites |
List pending invites (owner) |
POST /admin/api/groups/:id/invites |
Create an invite link (owner) — body { role, note? } (role is admin or viewer) |
DELETE /admin/api/invites/:token |
Revoke an invite (owner) |
GET /admin/api/groups/:id/webhook |
Group webhook endpoint info (owner) |
POST /admin/api/groups/:id/webhook/regenerate |
Generate/regenerate the group webhook secret (owner) |
DELETE /admin/api/groups/:id/webhook |
Disable the group webhook ingress (owner) |
GET /admin/api/logs |
Send logs of the accessible groups (filtered in SQL before the limit) |
GET /admin/api/logs/:id |
Single send-log entry (scoped) |
GET /admin/api/audit |
Audit log of the accessible groups (filtered in SQL before the limit) |
GET /admin/api/metrics |
Delivery stats (totals, failure rate, per platform/event/status, recent failures); optional ?groupId= scope; every aggregate is limited to the accessible groups |
GET /admin/api/delivery/:deliveryId |
The attempts of one delivery that belong to the accessible groups; optional ?groupId= (two groups' senders may use the same delivery id) |
POST /admin/api/test-match |
Stateless filter dry-run — evaluate a filter node against a pasted JSON payload (no event is stored) |
Validation
PUT /admin/api/routes— Body{ "routes": Route[] }; validates each route (id pattern, unique id within its group, name, enabled,groupId, filters — an array, empty only forfallbackroutes or when a validastis present; patterns the matcher cannot compile — longer than 200 characters, or RE2-unsupported syntax such as backreferences or lookaround — are rejected; flatfiltershold leaf conditions only (all/any/notbelong inast);keywordonly supports the defaulteq;existsmay omitmatch— optionaldiscordRoleIds(at most 50 numeric Discord role ids), and platform-aware targets:target.channelIdfor Discord,target.chatIdfor Telegram/Feishu, with the id rules and duplicate-destination check in Routes & Targets) and persists to D1d1_routes, rewriting only the groups whose routes changed. A non-super admin pointing a target at a channel another group uses gets403. Returns200 { ok, count }or400 { error }/401 { error }/403 { error }. Unchanged routes skip the full validation. Route filters support thefieldtype (a JSONPathpathintopayload, arrays expand so any element matches) and 12opoperators (eqdefault /ne/contains/startsWith/endsWith/regex/gt/gte/lt/lte/in/exists); a nestedast(all/any/not) takes precedence overfilterswhen present.PUT /admin/api/groups/POST /admin/api/groups/PUT /admin/api/groups/:id— Validate group ids,members(or legacyadminIds; a non-emptymemberslist needs at least oneowner),forgeSources(at most 20,nameup to 50 characters, unique type + host),providers(github/gitea/custom), andinstallationId; unknown fields are dropped. The source-isolation fieldsowners,installationIdandisolatedare super-admin only: an owner's write keeps their stored values. New members' logins are resolved to GitHub user ids with the writer's token; the server-only fields (instance, the webhook secret, member user ids) can never be set by the client.- Every write re-checks the writer's role inside its transaction: a request authorized before the role was revoked is refused (
409for route/fragment writes,403for group writes). - Optimistic concurrency — every list or group the API returns carries a
revision. Send it back with the write (group.revision, orrevisionnext toroutes/fragments/newId, or the listrevisionof the bulk groups write) and the server refuses the write with409if the stored data changed since it was loaded, instead of overwriting the newer change. Writes without arevisionare applied as before. In the bulk groups write, a group echoed back unedited is never written. PUT /admin/api/groups/:id/routes— OptionaldiscardUnreadable: truereplaces stored routes that cannot be read (otherwise the save is refused while the group has any).PUT /admin/api/routes— Optionally sendrevisions(the per-group map returned byGET /admin/api/routes): groups whose list comes back unedited are not written, groups the client never loaded are not touched, and edited groups must still be at their loaded revision (409otherwise). Each group is written in its own guarded transaction.PUT /admin/api/groups/:id/rename— Optionalrevision; returns{ ok, id, group, revision }(the renamed group and its new revision). Ids starting withinst-oru-are reserved for super admins.DELETE /admin/api/groups/:id— Requiresrevision,routesRevisionandversionas seen at confirmation (400when missing,409when the group, its routes or fragments changed, or when it has routes that cannot be read). Also revokes the group's invites and webhook secret, detaches its send logs and audit entries (they stay visible to super admins only), and retires the id for a few days so queued deliveries cannot reach a new group that reuses it.POST /admin/api/groups/:id/webhook/regenerate— Returns{ ok, url, secret, hasSecret }; the secret is shown only in this response.POST /admin/api/test-match— Body{ "node": FilterNode | "filters": Filter[], "event"?: string, "payload": object }; evaluates in memory and returns{ matched, explanation }. Nothing is persisted.GET/PUT /admin/api/groups/:id/fragments— Named filter fragments ({ id, groupId, name, node }) stored in D1d1_fragments; the editor inlines a fragment'snodeinto a route'saston insert (the matcher never resolves fragment references).PUTreplaces the group's fragments (at most 200) and returns200 { ok, count }.- Limits: one save accepts at most 200 routes, 200 fragments per group, and 100 groups in the bulk groups write.
Schemas: Routes & Targets, Groups & Access Control.