breg: keep `resultEffects` in the Action description for a profile that can read a Proposal but not start it

未关闭
#2,719 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
48/100
Issue 类型
缺陷
描述清晰度
描述清楚
活跃度
活跃
技术栈
openapi, rust
领域
api, backend

调研方向

Start with the Proposal metadata loop in crates/registry-breg/src/api/mod.rs:675-716 and the result effect filtering in crates/registry-breg/src/artifacts.rs:1331 and :1554-1566. Read the existing schema test at crates/registry-breg/src/tests/artifacts_response_schema_tests.rs:360-375, then add coverage for readable and hidden record types and confirm the reader still receives no routes. Done means reader-visible effects are filtered by record type, the existing populated-list test passes, and any changed schemas are regenerated.

由索引模型根据 Issue 内容生成。

描述

Problem

A profile with a Proposal get grant but no Start grant receives an Action description in GET /v1/metadata. The description hides the routes, which is deliberate: the profile cannot start the Action. It also sets resultEffects to an empty list. A client cannot then tell which record fields or record types the Action changes, so it has to guess, for example when it shows a reader what a Proposal would do once applied.

The blanking may have been deliberate. Neither the code nor the pull request that introduced it (#2040) says why. If it exists to avoid disclosing effects on record types the reader cannot see, the fix should keep that protection rather than blank everything.

Evidence

All line numbers are on origin/main at 36d25ef652.

  • crates/registry-breg/src/api/mod.rs:675 to :716: the loop that adds a description for each visible Proposal get grant. It empties routes (:706), removes route and conditionRoute, empties requiredConditionKeys, then sets resultEffects to [] at :716. The comment at :675 states only the input-disclosure intent.
  • crates/registry-breg/src/artifacts.rs:1331: the public Action entry builds resultEffects by filtering action.effects through selected_result_effects.
  • crates/registry-breg/src/artifacts.rs:1554 to :1566 (action_selected_result_effects): with a selected profile, effects come only from that profile's Action permission results. A reader has no Action permission, so this path also yields an empty set. This is my reading of the code and I have not run it.
  • The set was introduced by commit 2ec3726883 (#2040, 2026-10-16). git log -S finds no earlier version of the line, and the #2040 description does not mention it.
  • crates/registry-breg/src/tests/artifacts_response_schema_tests.rs:360 to :375 asserts the populated list for a profile that holds an Action grant. No test asserts the empty list for a reader.
  • The clients decode the member as required: crates/registry-breg-client/src/metadata.rs:3310, and resultEffects in crates/registry-breg-client-node/client.d.ts:539.

Proposed change

  1. Stop blanking resultEffects for a Proposal reader. Derive the list from action.result_effects (the effects a Proposal applies), not from an Action permission.
  2. Keep record-type disclosure intact: list only effects whose recordType the profile may see in the same metadata response. Decide whether an effect on a hidden record type is omitted or listed without detail, and record the decision.
  3. Leave routes, route, conditionRoute and requiredConditionKeys as they are.
  4. Document the field for readers on the Proposals configuration page.

Acceptance

  • A test shows a Proposal reader sees the Action's effects for record types it can read.
  • A test shows an effect on a record type the reader cannot read is not disclosed.
  • A test shows the reader still gets no routes.
  • The existing populated-list test still passes.
  • The OpenAPI and metadata schema documents are regenerated with their generators if the change alters them.
主要语言
Rust
星标
2
派生
0
平均合并
9 小时 48 分钟
30 天内合并 PR
151

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

registrystack/registry-stack 的其他 Issue

查看 registrystack/registry-stack 的全部 Issue

相似的 Issue

更多 Rust Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。