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

オープン
  • 何か問題がありますか？
#1,987 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
35/100
issue の種類
リファクタリング
明瞭さ
おおむね明確
活発さ
活発
技術スタック
rust
領域
cli

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

agent:triaged arch-audit priority:p3 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.
主要言語
Rust
スター
9
フォーク
2
平均マージ
20時間 47分
マージ済み PR（30日）
681

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

SocketDev/socket-patch のほかの issue

SocketDev/socket-patch の issue をすべて見る

似ている issue

Rust の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。