feat(integrations): push Sentry issue and installation events by webhook

未关闭
  • 哪里不对？
#421 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
18/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
活跃
技术栈
nextjs, nodejs, typescript
领域
api, backend, security

调研方向

Start by reading the webhook contract delivered by #28 — the route, signature verification and Request-ID dedup this issue builds on — since nothing here can be written before that lands. Then read src/lib/adapters/sentry/ to see what fields the polling adapter already maps, and docs/providers/sentry.md ("Limitations", "Webhooks (Post-MVP)") for the documented gaps. Done means signed issue and installation deliveries enqueue on sync_jobs and reach the timeline via the existing event types, with unit tests over sanitized fixtures and the Playwright simulated-delivery spec passing under npm run lint, npm run typecheck, npm test.

由索引模型根据 Issue 内容生成。

描述

area: integrations blocked enhancement impact: medium priority: P1 size: S

Context

The Sentry adapter (#117, closed) is polling only, built under the "webhooks are Post-MVP" rule. Eddie's decision on #28 (2026-11-14): webhooks first, polling as the backfill, so timeline events arrive in near real time. Sentry is one of the first two providers, because its webhooks need no scope beyond the three read-only scopes the adapter already holds.

Today a Sentry issue event reaches the timeline up to an hour late, and regressions and resolutions are dated when the sync saw them, not when they happened (docs/providers/sentry.md, "Limitations"). An uninstall is only noticed when the next sync fails.

From Sentry's documentation, checked 2026-11-14:

Item Value Source
Where the URL lives One webhook URL on the integration's registration, with resource subscriptions Webhooks
Signature Sentry-Hook-Signature: HMAC SHA-256 hex digest of the raw body bytes, keyed with the client secret (SENTRY_CLIENT_SECRET, already set) Same page
Other headers Sentry-Hook-Resource (installation, issue, ...), Sentry-Hook-Timestamp, Request-ID (unique per request) Same page
Response time Within 1 second, or Sentry counts it as a timeout Same page
Issue actions created, resolved, assigned, archived, unresolved. A regression is unresolved with substatus: "regressed" Issue webhooks
Mapping installation.uuid on every request maps a delivery to a connection Webhooks
Installation actions created, deleted Installation webhooks
Releases and error volume No webhook. Both stay polled docs/providers/sentry.md, "Webhooks (Post-MVP)"

Plan

  1. Implement the Sentry webhook declaration from the contract #28 adds: resources installation and issue, verified with Sentry-Hook-Signature against the raw body in constant time, deduplicated on Request-ID, replay-checked on Sentry-Hook-Timestamp.
  2. Map installation.uuid to the stored installation id. Unknown installations are acknowledged and dropped.
  3. issue deliveries become the existing event types, so the timeline shows one entry whichever path saw it first: created to sentry.issue.created, unresolved with substatus: "regressed" to sentry.issue.regressed, resolved to sentry.issue.resolved. Ignore assigned and archived. Regressions and resolutions are now dated by the delivery, not by the sync.
  4. Read only the fields the adapter reads today (id, shortId, status, substatus, level, firstSeen, lastSeen, permalink, project id). Never store title, culprit, metadata, assignedTo, or actor: they can carry personal data from the user's app.
  5. installation.deleted marks the connection as needing a reconnect at once.
  6. Answer within 1 second by queueing processing on sync_jobs (#10).
  7. Docs: docs/providers/sentry.md (rename "Webhooks (Post-MVP)" to "Webhooks", update "Disconnect and revoke" and "Limitations", and change self-hosted registration step 4 to set the Webhook URL and subscribe to Issue).

Acceptance criteria

  • A signed issue.created delivery puts a "New issue" event on the timeline within a minute, without waiting for a sync.
  • A regression and a resolution are dated by the delivery.
  • The same issue event seen by webhook and then by polling shows once.
  • An unsigned, wrongly signed, stale, or repeated delivery is rejected or ignored, and logged without its body.
  • installation.deleted marks the connection as needing a reconnect.
  • No issue title, culprit, or actor is stored or logged.
  • Polling still runs and still fills in error volume, releases, and any missed delivery.
  • Unit tests on recorded, sanitized payloads from Sentry's documented samples. No live calls in CI.
  • Playwright e2e: a signed delivery for the simulated Sentry provider appears on the timeline.

Files and areas

  • src/lib/adapters/sentry/ (webhook handler, schemas, fixtures, tests), the webhook route from #28, docs/providers/sentry.md, docs/operations/oauth-apps.md.
  • Non-goals: new scopes, error, comment, and alert resources, and pushing error volume (no webhook exists for it).

Verification

  • npm run lint, npm run typecheck, npm test
  • The Playwright spec for the simulated delivery.

Depends on

  • #28 Ingest provider webhooks (contract, route, deduplication)
  • #117 Add the Sentry adapter (closed)

Branch: <issue-number>-sentry-webhooks
Closes with a Closes #<issue-number> footer on the commit or pull request.

Model: anthropic/claude-opus-5-5 | Reasoning effort: unknown

主要语言
TypeScript
星标
1
派生
1
平均合并
6 小时 56 分钟
30 天内合并 PR
136

环境准备

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

eddiejaoude/StackDash 的其他 Issue

查看 eddiejaoude/StackDash 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。