Vendored Hatch wiring makes every Hatch install fail when the checkout path contains %XX, # or ; (e.g. a Jenkins "feature%2Fx" workspace), because Hatch's {root:uri} only escapes spaces
维护者通常 1 天内回复
已经有一个关联 PR 被合并了。
- #1428 来自 @mikolalysenko —— 已合并
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 58/100
- Issue 类型
- 缺陷
- 描述清晰度
- 基本清楚
- 活跃度
- 活跃
- 领域
- build-system, tooling
调研方向
Start with crates/socket-patch-core/src/vendor/pypi_hatch.rs at lines 46, 95, and 180, then inspect crates/socket-patch-core/src/utils/hatch.rs:361 and Hatchling's path_to_uri behavior. Reproduce the vendored scan and Hatch install in paths containing %, #, or ;. Done means the scan no longer silently produces unusable wiring, and the documented limitation or supported behavior is clear.
由索引模型根据 Issue 内容生成。
描述
[agent] Found by the scheduled Hatch bug-hunt routine (ledger #314).
Summary
Vendored Hatch wiring writes six @ {root:uri}/.socket/vendor/pypi/<uuid>/<wheel>#sha256=… into project.dependencies and env dependencies / extra-dependencies. docs/testing/hatch.md says this is done "so checkouts remain relocatable". But Hatch/Hatchling expand {root:uri} with hatchling/utils/fs.py:path_to_uri, which only escapes spaces:
def path_to_uri(path: str) -> str:
if os.sep == "/":
return f"file://{os.path.abspath(path).replace(' ', '%20')}"
return f"file:///{os.path.abspath(path).replace(' ', '%20').replace(os.sep, '/')}"
So when the checkout path contains a URL-significant character, the expanded requirement points somewhere else, or doesn't parse at all:
%2F/%20/ any%XX: pip percent-decodes it, giving…/app_feature/six-patch/.socket/…andOSError: [Errno 2] No such file or directory.#: the rest of the path becomes a URL fragment, givingNo such file or directory: '/…/a'.;:Invalid requirement: 'six @ file:///…/semi': Expected a marker variable or quoted string.
Jenkins multibranch pipelines put the branch name into the workspace directory with / encoded as %2F (e.g. app_feature%2Fsix-patch), so this is a realistic CI path. The native (unwired) project installs fine in the same directory. Only the socket-patch wiring breaks it.
The scan itself gives no warning, even when it runs from such a path. It reports applied / success.
Impact
- In any checkout whose absolute path contains
%XX,#or;, every Hatch env that carries a vendored reference fails to create (hatch run,hatch env create,hatch test). That includes the default env, because project dependencies go through the same expansion during the dev-mode install. CI goes red, and the cause is far from obvious. vexin that checkout still emitsnot_affected/inline_mitigations_already_exist(from the committed artifact, with only a "live tree does not match" warning), even though no Hatch env can be installed there.- Hosted mode is unaffected (http URL).
This is the same class as the Maven #350 (file://${project.basedir} not URI-encoded), but in the Hatch lane.
Repro (Linux, Hatch 1.18.1; local mock patch API serving a patched six 1.16.0 wheel, --vendor-source service)
mkdir -p dev/app/src/app && cd dev/app && touch src/app/__init__.py && git init -q
cat > pyproject.toml <<'EOF'
[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"
[project]
name = "app"
version = "0.1.0"
dependencies = ["six==1.16.0"]
[tool.hatch.build.targets.wheel]
packages = ["src/app"]
[tool.hatch.envs.lint]
extra-dependencies = ["six==1.16.0"]
EOF
socket-patch scan --vendor --vendor-source service --json # applied, success
git add -A && git commit -qm vendored
git clone -q . "../../ws/app_feature%2Fsix-patch" && cd "../../ws/app_feature%2Fsix-patch"
hatch run python -c 'import six'
# ERROR: Could not install packages due to an OSError: [Errno 2] No such file or directory:
# '/…/ws/app_feature/six-patch/.socket/vendor/pypi/<uuid>/six-1.16.0-py2.py3-none-any.whl'
hatch run lint:python -c 'import six' # same error
git clone -q . ../plain && cd ../plain && hatch run python -c 'import six; print(six.SOCKET_PATCHED)' # control: True
The same failure happens with the scan run directly inside directories named a#b, p%20q and semi;colon. Directories named at@sign and quo'te work.
Expected vs actual
- Expected: docs/testing/hatch.md: "Vendored references use
{root:uri}so checkouts remain relocatable." A vendored scan should either produce wiring that installs from any checkout path, or refuse / warn at scan time when the root contains characters that Hatch's{root:uri}doesn't encode (%,#,;,?). It should also document that a checkout can't be relocated to such a path. - Actual: the scan succeeds silently, and every Hatch env install fails in such checkouts.
OS × Hatch matrix (main 61cfb9b, vendored)
| 1.2.1 | 1.7.0 | 1.16.5 | 1.18.1 | |
|---|---|---|---|---|
Linux, %2F path (default env + env extra-dependencies) |
fail | fail | fail | fail (reproduced 2×) |
Linux, # / %20 / ; path |
— | — | — | fail |
Linux, @ / ' / space path |
— | pass (space, earlier run) | — | pass |
| Linux, same commit in a plain path (control) | pass | pass | pass | pass |
| macOS / Windows | untested (same path_to_uri; probe branches currently can't be cleaned up by the routine) |
|||
| Hosted, any path | not affected |
First bad
Present since vendored Hatch landed (#244). Released v4.0.0 has no Hatch lane.
Suspect code
crates/socket-patch-core/src/vendor/pypi_hatch.rs:46,:95,:180: they emit{root:uri}/…without checking whether the project root is URI-safe for Hatch's expansion.crates/socket-patch-core/src/utils/hatch.rs:361(vendored preflight): it checks the Hatch version but not the root path.- The root cause is upstream in
hatchling/utils/fs.py:path_to_uri(only' 'is escaped). A scan-time refusal or warning, plus a documented limitation, would avoid silently breaking CI.
- 主要语言
- Rust
- 星标
- 8
- 派生
- 1
- 平均合并
- 16 小时 19 分钟
- 30 天内合并 PR
- 586
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
SocketDev/socket-patch 的其他 Issue
-
agent:triaged bug bughunt pm:pipenv priority:p1
难度 2/5 1-3 小时 新手友好度 78/100
SocketDev/socket-patch#1608 · 1 条评论 ·
维护者通常 1 天内回复
-
agent:triaged bug bughunt pm:vlt priority:p1
难度 2/5 1-3 小时 新手友好度 62/100
SocketDev/socket-patch#1601 · 2 条评论 ·
维护者通常 1 天内回复
-
agent:triaged bug bughunt pm:npm priority:p3 ux
难度 2/5 1-3 小时 新手友好度 75/100
SocketDev/socket-patch#1072 · 2 条评论 ·
维护者通常 1 天内回复
-
agent:triaged bug bughunt pm:yarn-berry priority:p1
难度 2/5 1-3 小时 新手友好度 73/100
SocketDev/socket-patch#783 · 1 条评论 ·
维护者通常 1 天内回复
-
Vendored cargo warns cargo_multi_version_old_cargo ("declares no rust-version") when the root package inherits rust-version from [workspace.package]可能已有人在做 @mikolalysenko 于 5 天前认领。 未关闭agent:triaged bug bughunt pm:cargo priority:p2
难度 2/5 1-3 小时 新手友好度 84/100
SocketDev/socket-patch#651 · 3 条评论 ·
维护者通常 1 天内回复
查看 SocketDev/socket-patch 的全部 Issue
相似的 Issue
-
bug documentation sev-0
难度 2/5 1-3 小时 新手友好度 72/100
-
bug
难度 2/5 1-3 小时 新手友好度 85/100
dekobon/big-code-analysis#1620 ·
维护者通常 3 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 65/100
-
bug soroban
难度 2/5 1-3 小时 新手友好度 68/100
utilityjnr1/lumena#358 ·
维护者通常 1 天内回复
-
enhancement
难度 2/5 1-3 小时 新手友好度 75/100
charles-hood/DiagramCraft#63 ·