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

Ouverte
#2,738 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
5/5
Temps estimé
Plus d'une semaine
Accessibilité débutants
12/100
Type d'issue
Fonctionnalité
Clarté
Plutôt claire
Activité
Active
Stack technique
node.js, python, rust
Domaine
api, backend

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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.

Langage dominant
Rust
Étoiles
2
Forks
0
Merge moyen
9 h 48 min
PR mergées (30 j)
151

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de registrystack/registry-stack

Toutes les issues de registrystack/registry-stack

Issues similaires

Plus d'issues Rust

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.