documents: operator reads and actions for stuck verification, erasure and hook jobs before first release

未关闭
#2,738 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
12/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
活跃
技术栈
node.js, python, rust
领域
api, backend

调研方向

Start by reading crates/registry-documents/src/erasure.rs to see how stuck verification and erasure jobs are currently listed and replayed, then look at the operator routes the other products already expose to copy their list-with-state-and-cursor shape. Hook deliveries have no equivalent yet, so trace where they are stored and what states they can be in. The work is only done when the read routes, then the replay/discard actions with reason and idempotency key, the Rust and Node/Python client methods, metrics and security notes all ship in one change; the scope spans several subsystems and is not a first contribution.

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

描述

Before Document Store ships, an operator needs a way to see and clear its stuck jobs other than documentsctl on the host.

Today

  • Stuck verification and erasure jobs can be listed and replayed only with documentsctl (crates/registry-documents/src/erasure.rs).
  • Hook deliveries have no list, replay or discard.
  • There are no metrics.

Ask

Read routes:

  • Verification and erasure jobs by state, including dead-lettered.
  • Hook deliveries by state.

Actions, after the reads:

  • Replay or discard a dead-lettered job or hook delivery.

Metrics for the same states also belong in the first release.

Shape

These routes follow the same shape as the other products' operator routes. It is a convention, not a shared contract:

  • A list of held or failed work with state, age and cursor paging, plus a detail read.
  • Actions only after the reads ship. Each action takes one item at a time, with a reason and an idempotency key. The product's own access profile authorises it for a named person's token, and the audit records it under that person.
  • Maintained client methods (Rust, and the Node and Python facades) in the same change.
  • An operator disclosure profile. The routes return identifiers, states, ages and failure classes, not record content or personal data.
  • Security review notes in the pull request, because each route widens what an operator token can read or change.

Related: #2291.

主要语言
Rust
星标
2
派生
0
平均合并
9 小时 48 分钟
30 天内合并 PR
151

环境准备

从这里开始

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

registrystack/registry-stack 的其他 Issue

查看 registrystack/registry-stack 的全部 Issue

相似的 Issue

更多 Rust Issue

把新 issue 发到你的邮箱

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