Carry apply/rollback advisories as typed values: ApplyResult.error doubles as a warning string that three consumers decode by substring, and they disagree

Aperta
  • Qualcosa non va?
#1,987 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à
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
35/100
Tipo di issue
Refactoring
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
rust
Ambito
cli

Direzione di ricerca

Start in crates/socket-patch-core/src/patch/apply.rs, where ApplyResult.error gets advisories joined with "; " (join_notes) and advisory_warning_codes matches marker consts. Then read the CLI consumers in crates/socket-patch-cli/src/commands/apply.rs and rollback.rs, plus store_copies.rs fold. Done means a typed Advisory enum on the results, one mapping helper to RunWarning, and the listed tests asserting variants; the maintainer's open decision on rollback's fallback needs settling first.

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

Descrizione

arch-audit refactor

[agent] Filed by the scheduled architecture audit (audit-core). Register: discussion #1830 register.

Kind: refactor. Register ID: A76.

Problem

ApplyResult.error (and the rollback result) means "why it failed" when success == false, but on a successful result it carries advisories instead: a --force skip note, an ownership restore the process could not make, or a failed stale-bytecode cleanup. These are joined with "; " into one string (apply.rs L121-L125, join_notes L1192). Consumers then get the warning codes back by substring-matching marker text (advisory_warning_codes L977-L989, which uses OWNERSHIP_NOT_RESTORED_MARKER and STALE_BYTECODE_NOT_REMOVED_MARKER).

The three consumers handle a note differently:

  • CLI apply (apply.rs L1411-L1419): a note that matches no marker, such as the --force skip note, produces no run warning.
  • CLI rollback (rollback.rs L2316-L2323):`` a note that matches no marker is labelled ownership_not_restored anyway.
  • Core store_copies::fold (store_copies.rs L65-L72): a successful store copy keeps its advisory only if it contains the ownership marker. A store copy's stale-bytecode advisory is dropped before the CLI sees it. This is read from the code; I did not execute it.

Refusals are matched by marker the same way, for example SHARED_STORE_REFUSAL_MARKER, so tests can only check them with .contains on a sentence (rollback.rs L3086).

Proposed change
  • Add a typed advisories: Vec<Advisory> to the apply and rollback results, with enum Advisory { ForceSkipped(..), OwnershipNotRestored(..), StaleBytecodeNotRemoved(..) }. Each variant has its warning code and display text.
  • Keep error for failures only.
  • Make store_copies::fold concatenate every copy's advisories.
  • Have both CLI commands map variants to RunWarning through one helper.
  • Delete advisory_warning_codes and the two marker consts, or make them private if a test still needs the text.
Size

About 6 files: core patch/{apply,rollback,store_copies}.rs and CLI commands/{apply,rollback}.rs, plus their tests. Estimated diff is ±250 lines.

Acceptance criteria
  • The human text and the --json warning codes stay the same for ownership and bytecode advisories.
  • Decide whether rollback's fallback to ownership_not_restored for unrecognized notes is intended. If not, delete it and add a test.
  • A store-copy stale-bytecode advisory now reaches the run warnings, with a test.
  • test_restore_file_permissions_ownership_failure_is_a_warning and the shared-store refusal tests assert variants instead of sentence substrings.
Lingua principale
Rust
Stelle
9
Fork
2
Merge medio
18h 47m
PR unite (30g)
637

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 SocketDev/socket-patch

Tutte le issue di SocketDev/socket-patch

Issue simili

Altre issue su Rust

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.