Vendored gem mode writes the rewired `gem` line of a CRLF Gemfile with an LF ending, leaving the Gemfile with mixed line endings
维护者通常 1 天内回复
评估
调研方向
Start with crates/socket-patch-core/src/vendor/gem.rs, especially plan_gemfile_edit, apply_gemfile_plan, and the Append arm; the report also points to restore_gemfile_line. Reproduce with the CRLF Gemfile case in crates/socket-patch-cli/tests/e2e_vendor_gem_build.rs and verify the rewritten line retains CRLF. A pull request is already open for this issue.
由索引模型根据 Issue 内容生成。
描述
[agent] Found by the scheduled Bundler (RubyGems) bug-hunt routine (ledger #316).
Summary
When vendored mode rewires a gem declaration in a CRLF Gemfile, the new gem "x", "<ver>", path: "…" line is written with a bare \n. Every other line keeps \r\n. So after socket-patch vendor the Gemfile has mixed line endings:
source "https://rubygems.org"\r\n
\r\n
gem "rack", "3.2.7", path: ".socket/vendor/gem/<uuid>/rack-3.2.7"\n <- was "...\"~> 3.1\"\r\n"
vendor --revert, rollback and remove restore the recorded original line (with its \r), so the round trip is byte-exact. The vendored state in between is the problem. Bundler parses the file fine, so installs and bundle exec aren't affected.
This is separate from #1808, which is about the CRLF Gemfile.lock (the lock surgery). Its fix PR #1811 only touches the lock path and doesn't change the Gemfile line.
Impact
- A project that commits its
Gemfileas CRLF (.gitattributes-textoreol=crlfwith a non-normalizing checkout, or Windows editors withautocrlf=false) commits a mixed-endingGemfileafter vendoring. The diff shows an EOL change on top of the real edit, and RuboCopLayout/EndOfLine(crlf/nativeon Windows) flags the line. - This is inconsistent with hosted mode, which keeps a CRLF
GemfileCRLF (gemfile_rerun_on_crlf_checkout_never_nests), and with the CRLF-preservation fixes the vendored backends got for other manifests (#662 pnpmpackage.json, #1567 requirements.txt).
Severity is low: the file still works. It's a correctness and hygiene defect in a user-owned manifest.
Repro
This is a scratch addition to gem_vendor_fresh_checkout_bundle_install_and_revert in crates/socket-patch-cli/tests/e2e_vendor_gem_build.rs, with a real bundle install from rubygems.org and the patch staged offline with stage_patch_with_vuln:
Gemfile (CRLF): source "https://rubygems.org"\r\n\r\ngem "rack", "~> 3.1"\r\n
bundle config set --local path vendor/bundle && bundle install # Gemfile.lock stays LF
# stage a lib/rack.rb patch for pkg:gem/[email protected]
socket-patch vendor --json --offline # exit 0, applied 1
ruby -e 'p File.binread("Gemfile")'
# => "source \"https://rubygems.org\"\r\n\r\ngem \"rack\", \"3.2.7\", path: \".socket/vendor/gem/<uuid>/rack-3.2.7\"\n"
socket-patch vendor --revert --json # (or rollback / remove <purl>) -> Gemfile byte-exact CRLF again
Expected vs actual
- Expected: a rewritten line keeps the line ending of the line it replaces (or
utils::line_endings::terminatorof the file), as hosted mode does for the sameGemfile. docs/ecosystems.md lists the vendoredGemfile+Gemfile.lockpair edit as supported, with no line-ending caveat, and #815 / #1108 set one terminator rule for lines a writer inserts. - Actual: the rewired line ends in
\ninside a CRLF file.
Matrix (Linux, Ruby 3.3.6; the edit is pure text handling, so it doesn't depend on the OS)
| Case | Bundler 2.6.9 | Bundler 4.0.23 |
|---|---|---|
vendor on CRLF Gemfile + LF lock: vendored Gemfile has mixed endings |
fail (×3) | fail (×3) |
… then vendor --revert / rollback / remove: Gemfile and lock byte-exact |
pass | pass |
LF Gemfile (control) |
pass | pass |
macOS / Windows probes are unavailable (push-triggered probe runs don't start, see #316). Tested on main ecd4924 (v5.0.1).
Suspect code
crates/socket-patch-core/src/vendor/gem.rs:1346-1360(plan_gemfile_edit):new_lineis built from scratch (format!("gem {q}{name}{q}, …")) whileoriginal_lineislines[idx]fromtext.split('\n'), so it still carries the\r. The new line drops it unless a trailing comment happens to carry it.apply_gemfile_plan(gem.rs:1610-1633) then joins with\n.- The
RewireOursarm keeps the\r(replacenon the original), and theAppendarm (transitive gem,GemfilePlan::Append { block }) appends an LF-only block. I didn't run theAppendarm here. - A related shape I saw (not filed separately): after a vendored LF pair is re-checked-out as CRLF,
restore_gemfile_line(gem.rs:2403) writes back the recorded LF original into the CRLF file. With #1811 applied,vendor --reverton such a checkout then leaves theGemfilemixed as well (…\r\n\r\ngem "rack", "~> 3.1"\n).
- 主要语言
- Rust
- 星标
- 8
- 派生
- 2
- 平均合并
- 19 小时 12 分钟
- 30 天内合并 PR
- 709
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
SocketDev/socket-patch 的其他 Issue
-
agent:triaged arch-audit priority:p3 refactor
难度 2/5 1-3 小时 新手友好度 83/100
SocketDev/socket-patch#1860 ·
维护者通常 1 天内回复
-
agent:triaged arch-audit priority:p3 refactor
难度 2/5 1-3 小时 新手友好度 78/100
SocketDev/socket-patch#1838 ·
维护者通常 1 天内回复
-
Share one scoped env-var test guard: EnvGuard is copy-pasted 11 times across core unit and integration tests可能已有人在做 @mikolalysenko 今天认领。 未关闭agent:claimed agent:triaged arch-audit priority:p3 refactor
难度 4/5 3-5 天 新手友好度 55/100
SocketDev/socket-patch#1889 · 2 条评论 ·
维护者通常 1 天内回复
-
Memoize env-keyed subprocess probes through one helper: composer, python and ruby each define the same env key and drifted on when an answer is kept可能已有人在做 @mikolalysenko 今天认领。 未关闭agent:claimed agent:triaged arch-audit priority:p1 refactor
难度 4/5 1-2 天 新手友好度 25/100
SocketDev/socket-patch#1888 · 3 条评论 ·
维护者通常 1 天内回复
-
agent:triaged arch-audit priority:p3 refactor
难度 4/5 1-2 天 新手友好度 55/100
SocketDev/socket-patch#1887 · 1 条评论 ·
维护者通常 1 天内回复
查看 SocketDev/socket-patch 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 2 天内回复
-
难度 2/5 1-3 小时 新手友好度 85/100
维护者通常 1 天内回复
-
compiler P4 perf
难度 2/5 1-3 小时 新手友好度 78/100
HerringtonDarkholme/hd-lang#1044 ·
维护者通常 1 天内回复
-
good first issue help wanted r-docs
难度 2/5 1-3 小时 新手友好度 72/100
servo/rust-smallvec#824 ·
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 90/100
akitaonrails/ai-usagebar#552 ·
维护者通常 1 天内回复