BReg: migration.review.required lists changes that need no review

Aperta
#2,766 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à
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
62/100
Tipo di issue
Bug
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
rust
Ambito
cli, documentation

Direzione di ricerca

Start in crates/registry-bregctl/src/lib.rs, where the migration.review.required message is assembled, and compare its filter with compiler_applicable_without_review in crates/registry-breg/src/package.rs. Reproduce the example access-profile change, then split the message into changes that need review and changes that would apply automatically. Update the BReg change rules under docs/site/ to state which access changes require review; done means bregctl test and bregctl package no longer list automatically applicable changes as review items.

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

Descrizione

area:breg bug

When bregctl test or bregctl package refuses a successor with migration.review.required, the message lists every change that is not a compatible addition. Some of the changes it lists would apply without review.

In crates/registry-bregctl/src/lib.rs, the list is built from every change whose class is not CompatibleAdditive. The gate is compiler_applicable_without_review in crates/registry-breg/src/package.rs, which accepts an AccessOrDisclosureChange without review unless it is a query-inventory-changed change that is not an automatic access-grant change, or it targets an action or a timer.

Example: adding an optional field to an access profile that grants list gave this message:

the successor cannot be applied automatically; the changes to review are:
access-profile-changed at contact.directory-editor; query-inventory-changed
at contact.records.contact.directory-editor.list.

Only query-inventory-changed needed review. Adding the same field without adding it to the profile applied automatically. An operator reading the message would start a reviewed migration for both changes.

Proposal:

  1. List only the changes that need review. Changes that would apply automatically can follow under a separate heading.
  2. Decide whether adding an optional field to a profile that grants list should need a reviewed migration. In this case the field applied automatically only when no access profile granted it, so no caller could read or write it through that profile. The BReg change rules in docs/site/ should then say which access changes need review.
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.