csv_output silently overwrites distinct fields when flattened keys collide

未关闭 适合新手
#3,865 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 2 天内回复

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
84/100
Issue 类型
缺陷
描述清晰度
描述清楚
活跃度
活跃
技术栈
go
领域
backend

调研方向

阅读 pkg/github/csv_output.go,尤其是 appendFlattenedCSVFields 和 csvColumnName,然后查看 pkg/github/csv_output_test.go 中的扁平化测试。添加报告中提到的 JSON 行,其中包含一个带字面点号的键及其对应的嵌套路径。完成标准是输出具有确定性并保留两个值,或者明确报告该行无法无损表示。

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

描述

Summary

When csv_output is enabled, list-tool results are converted to CSV by flattening nested objects with .-joined column names. A literal field name containing . can produce the same column name as a nested field. One value is silently overwritten; Go map iteration makes the surviving value unpredictable.

Reproduction (from the current implementation)

Convert a list response containing this JSON row through jsonTextToCSV:

[{"user.login":"literal","user":{"login":"nested"}}]

appendFlattenedCSVFields maps both the top-level user.login and the nested user → login to the same row["user.login"]. The resulting CSV has only one user.login column, containing either literal or nested, depending on map iteration order. The other value is lost.

The conversion is used by withCSVOutput for default list_* tools whenever the csv_output feature flag is enabled (including insiders mode). This is a code-path demonstration, not a claim of a live GitHub API response with these exact fields.

Expected behavior

Distinct JSON fields remain distinguishable in CSV, or the conversion explicitly reports that it cannot represent this row without loss. The chosen output should be deterministic.

Suggested fix

Escape/encode path components when building flattened column names, or detect collisions and use unambiguous names/fail clearly. Add a regression test with both a literal dotted key and an equivalent nested path (and verify neither value is silently dropped).

Source
  • pkg/github/csv_output.go: appendFlattenedCSVFields, csvColumnName, csvRowsFromArray, and withCSVOutput.
  • pkg/github/csv_output_test.go: existing flattening tests cover nested objects, but not colliding flattened names.
主要语言
Go
星标
34.4k
派生
5.3k
平均合并
3 天 10 小时
30 天内合并 PR
11

环境准备

从这里开始

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

github/github-mcp-server 的其他 Issue

查看 github/github-mcp-server 的全部 Issue

相似的 Issue

更多 Go Issue

把新 issue 发到你的邮箱

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