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

Aperta
#2,738 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
12/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
node.js, python, rust
Ambito
api, backend

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
Rust
Stelle
2
Fork
0
Merge medio
9h 48m
PR unite (30g)
151

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di registrystack/registry-stack

Tutte le issue di registrystack/registry-stack

Issue simili

Altre issue su Rust

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.