diff --git a/crates/socket-patch-cli/CLI_CONTRACT.md b/crates/socket-patch-cli/CLI_CONTRACT.md index d52add4f8..698dc8412 100644 --- a/crates/socket-patch-cli/CLI_CONTRACT.md +++ b/crates/socket-patch-cli/CLI_CONTRACT.md @@ -214,7 +214,7 @@ For a **9.0 root lock**, the CLI ensures `pnpm-workspace.yaml` carries `trustLoc **Vendored entries and the rest of the CLI.** Because nothing is in the manifest, vendored patches are invisible to `apply` (nothing to apply in place) but fully visible to `list` (listed from the ledger, labeled `Mode: vendored (recorded in .socket/vendor/state.json)` in human mode, exit 0 on a vendored-only project), `vex` (attested from the embedded records while a lockfile still wires the artifact — see "Manifest-less VEX"), `repair` (health-checked and rebuilt from the ledger), and `scan --prune` (lockfile-driven reconcile). They are exempt from standalone `vendor`'s manifest reconcile (`reconcile_dropped` never touches `detached` entries) and exit via `remove ` (which reverts them), `vendor --revert`, or `rollback`, whose vendored leg reverts every in-scope ledger entry (unscoped and identifier-scoped runs; path-scoped runs reach them only when an installed copy matches). -`scan --mode hosted` swaps the in-place apply for the registry-redirect pipeline: discover → resolve hosted-patch references (grant token + integrity + per-dep registry override) → rewrite ONLY the patched dependencies' lockfile / registry-config entries to point at the hosted packages. A dep counts as **redirected** only when its hosted-artifact URL (or per-dep registry index URL) actually landed in a project file — a granted reference whose rewriter found nothing to edit is neither counted nor attested. **No ledger (v5.0)**: hosted mode writes ONLY the lockfile / registry-config edits — `.socket/vendor/redirect-state.json` is never written (on success or failure), and a pre-v5 one on disk is ignored (never read for planning, never quarantined, left byte-identical). The lockfiles are the only record of a hosted patch: `list`, `vex`, `rollback`, `remove`, `vendor` and `repair` all discover the hosted pins from them (a hosted URL counts only on `https://patch.socket.dev` or the `--patch-server-url` / `SOCKET_PATCH_SERVER_URL` origin), and commit-ready output is just the lockfile / config changes. Cargo and golang are confirmed only by their rewriter's own report (`confirmed_cargo_uuids` / `confirmed_golang_uuids`): a golang dep counts only when its go.mod `replace M V => patch.socket.dev/gopatch/ ` and both go.sum lines are in place, never because the patch-server origin or leftover go.sum lines appear somewhere. Gradle is confirmed the same way (`confirmed_gradle_uuids`): only when the final files hold the owned script, the index row, the live apply line in every build's settings file and the suffixed version in every lock entry of the GA (see [Gradle builds](#gradle-builds-v50)). A golang module that go.mod does not require and go.sum does not list at the patched version is outside the build graph and is refused with `redirect_golang_not_in_module_graph` (nothing written). Only the exact module `patch.socket.dev/gopatch/` is socket-owned; any other module path is refused with `redirect_golang_untrusted_module_path`. A vendored golang module is taken over like cargo and the npm family: its vendor wiring, committed copy and ledger entry are reverted first (`redirect_takeover_reverted_vendored`). A vendored PyPI package (requirements.txt, Poetry, Pipenv, uv, Hatch, PDM, pylock) is taken over the same way: its vendored wiring is restored to the recorded registry entry, its ledger entry and wheel are removed, and it is redirected in the same commit. The Python rewriters treat any non-registry source as user-authored, so without the revert they refused socket-patch's own vendored source and left the project vendored. A takeover revert that leaves vendored wiring in place is refused with `redirect_vendored_revert_failed`. That covers a drift-skipped record (`vendor_lock_entry_drifted`) and a reverted file that still references the artifact (`vendor_revert_residual_reference`). The ledger entry and artifact are kept, and the package stays vendored and skipped. `--dry-run` predicts the same refusal from the same signals instead of previewing `redirect_would_revert_vendored`. The hosted requirements.txt rewriter only rewrites an existing pin in the root `requirements.txt`, so a vendored requirements.txt package whose wiring is a pin in a `-r` include or a `(transitive)` line vendored mode appended is kept vendored, wet and `--dry-run` alike, with `redirect_requirements_takeover_unreachable` (`redirect.warnings[]`, and `redirect.skipped[].reason`). Its wiring, ledger entry and wheel are kept, so it stays vendored and patched (exit 0). The uv and Poetry rewriters are covered the same way: a vendored uv package whose recorded pre-vendor `uv.lock` entry is at another version than the patch (vendored uv pins the entry down to the patch's version; the revert brings the lock's own version back, and hosted mode only pins the version the lock resolves) is kept vendored with `redirect_uv_takeover_version_unreachable`, and a vendored Poetry package on a Poetry 0.x lock (which hosted mode refuses outright) is kept vendored with `redirect_poetry_lock_unsupported`. **Staged takeover (v5.0)**: the takeover is atomic. Each purl's vendored revert is staged in memory (the run's group commit, the same journaled commit vendored mode uses), the hosted rewrite plans against the reverted project, and a staged purl the rewrite does not pin is retracted: every staged revert is undone, that purl keeps its vendored wiring, ledger entry and artifact byte-identical, and the rest are staged and rewritten again. A retracted purl is skipped (`redirect.skipped[].reason`) with the cause: its existing skip reason (unavailable wheel metadata, …), the rewriter warning that names the package (`redirect_yarn_berry_missing_checksum`, `redirect_pypi_platform_wheel`, …), `redirect_requirements_takeover_unreachable`, the rewrite's lock-level refusal (`redirect_yarn_berry_mixed_line_endings`, `redirect_bun_lock_unsupported`, a Gradle planner refusal, …) or `redirect_takeover_not_pinned`; that warning is reported in `redirect.warnings[]`, followed by `redirect_takeover_kept_vendored` naming the package. Exit 0: the package stays vendored and patched, never unpatched in both modes. The reverts, the hosted pins and the vendored ledger then reach the disk in one commit, and the reverted artifacts are deleted only after it: a refusal or write failure before the commit writes nothing, a failed commit puts back the files it replaced, and a commit interrupted after its journal was written is finished by the next command that takes the apply lock. `--dry-run` runs the same steps and drops the staged state instead of committing, so its `redirected` count and warnings are the wet run's. A hosted run with no takeover stages its writes the same way but commits them without the journal (it writes nothing under `.socket/`): a file that fails to be replaced puts back the ones already replaced, so a failed run leaves no lock half-redirected. Re-runs over already-rewritten output plan from the current lock text and are idempotent (exit 0, lock unchanged). **Lock (v5.0)**: the hosted engine acquires `<.socket>/apply.lock` before its first wet write (the staged takeover reverts) — not on `--dry-run`, and not when the run would write nothing (zero redirects, all skipped) — so previews and no-op runs never create `.socket/`; contention is `lock_held` and a lock-file I/O fault (a read-only project root, a file squatting on `.socket/`) is `lock_io` — both exit 1, refused BEFORE any project file is written, and rendered like every other lock holder: human `Error (): ` on stderr (+ the `--lock-timeout` hint for a live holder); JSON keeps the hosted shape — top-level `status: "error"`, `error: {code: "lock_held" | "lock_io", message}` (v5.0: the same object every command uses; no top-level `error.code`), and `redirect: {mode: "hosted"}` retained. **Takeover symlink pre-check (v5.0)**: a vendored→hosted takeover whose recorded wiring file is a symlink is refused up front with `redirect_symlinked_file_unsupported` — wet and `--dry-run` alike, before any revert — so "nothing was written" holds. **Human mode (v5.0)**: hosted `scan` prints the results table and update detection like the other modes, then rewrites without a prompt (scan never prompts); `--dry-run` previews through the engine, and a detail fetch that leaves nothing to redirect enters the engine as a no-op (`Redirected 0 packages; rewrote 0 files.`, no lock, no `.socket/`). The detail fetch prints the same progress counter and per-package `Warning: could not fetch details for …` lines as the agent arm. An EMPTY hosted discovery prints `No patches available for installed packages.` and exits 0 without entering the engine; a discovery whose every offer is paid-tier for an org without paid access prints the table's paid nudge, then `No downloadable patches (paid subscription required).`, and exits 0 without entering the engine (parity with the agent/vendored arms). JSON output gains a `redirect` sub-object: `{ mode: "hosted", redirected, rewrittenFiles, skipped, patches, warnings, dryRun }` (`mode` is additive so consumers can dispatch without inferring it). `patches` (additive, v5.0) is the per-purl outcome of every selected patch, sorted by purl: `{purl, uuid, action}` with `action` `pinned` (`would_pin` under `--dry-run`; `redirected` counts these), `skipped` (`errorCode` = the `skipped[]` reason, `error` = its detail when it has one), or `unpinned` (`errorCode: redirect_unconfirmed` — the patch was granted but no lockfile entry pinning it could be rewritten; the human output's `Not hosted : …` line). An `unpinned` or `skipped` row does not change `status` or the exit code (the hosted exit policy is an open decision, #704). Rewriter warnings carry stable `redirect_*` codes (e.g. `redirect_npm_no_lockfile`, `redirect_gradle_manual_snippet`, `redirect_golang_unsupported`); new codes are additive (MINOR). v5.0 additive codes: `redirect_composer_no_lockfile` / `redirect_gem_no_gemfile` (composer / gem: neither manifest nor lock present — once per run, after the intake gates), `redirect_gem_bundle_gemfile_unsupported` (gem: `BUNDLE_GEMFILE` — `BUNDLE_GEMFILE:` in the bundler app config, which outranks the environment variable as in `Bundler::Settings`, else the environment variable — names a manifest other than the project's `Gemfile` / `gems.rb`, so no gem is redirected or attested; a value naming one of those two selects that pair even when the other spelling is present), `redirect_gem_bundle_lockfile_unsupported` (gem: bundler 4's custom lockfile — the `BUNDLE_LOCKFILE` environment variable, else `BUNDLE_LOCKFILE:` in the bundler app config, else in the global config — names a lock other than the loaded pair's own `Gemfile.lock` / `gems.locked`, so no gem is redirected or attested rather than pinning a lock bundler ignores), `redirect_gem_twin_manifest_ambiguous` (gem: a `Gemfile` + `gems.rb` twin under default discovery; bundler 1.x loads the `Gemfile` and bundler ≥ 2 loads `gems.rb`, and a lock's `BUNDLED WITH` records which bundler wrote it, not which one installs it, so neither pair is wired or attested — remove the unused spelling or set `BUNDLE_GEMFILE` to the one in use), `redirect_gem_mirror_overrides_source` (gem: Bundler's all-source, exact patch-source or patch-hostname mirror can route the per-dep `source` block to an unpatched upstream gem. Intake reads the app config (`BUNDLE_APP_CONFIG`, where a set-but-empty value selects `/config`, honoring `BUNDLE_IGNORE_CONFIG`) and all `BUNDLE_MIRROR__...` variables visible to the scan; app config overrides the environment per encoded key, then `mirror.all` takes precedence over exact source, which takes precedence over hostname. URI matching follows Bundler's whole-URI case folding, default-port/trailing-slash normalization and single slash key alias, not URL prefixes. An exact-source fallback-timeout key without a mirror URL shadows the hostname mirror and fetches that source directly; a configured URL is conservatively refused even if a timeout could bypass an unreachable mirror at install time. Like `redirect_gem_bundle_gemfile_unsupported`, the gate leaves the Gemfile pair byte-identical and confirms no gem redirect. On an embedded `scan --vex`, rediscovered older hosted gem pins may attest only from verified installed bytes: a missing tree is not excused by the lockfile, and `--vex-no-verify` omits those hosted gems with `mirror_overrides_source` rather than trusting their intercepted source. Agent/vendored evidence, unrelated ecosystems and standalone VEX behavior are unchanged. Details identify the setting form and its app/environment origin without printing mirror values or source URLs, which may contain credentials. Remove the applicable all/source/hostname setting (including any slash alias) from that origin and reuse its existing mirror URL under `mirror.https://rubygems.org` to clear the refusal; an environment setting must be unset in the scan/install environment. User-global Bundler config and mirrors set only in a later install environment are not inspected; keep those mirrors scoped to the upstream source too), `redirect_maven_no_pom` (no `pom.xml` and no Gradle build), `redirect_nuget_lock_unparseable` (a present-but-corrupt `packages.lock.json` — warned once, nothing mutated; an absent lock still proceeds; a leading UTF-8 BOM, which dotnet reads past, is not corrupt and is kept on rewrite), `redirect_nuget_lock_other_version` (the lock also resolves the patched id at another version in some target framework: the exact-id `packageSourceMapping` would route that framework to a feed that serves only the patched version, so the dep is skipped with nothing written; only lock entries at the patched version are ever re-pinned, and `resolved` is never rewritten), `redirect_cargo_lock_pkg_ambiguous` (several same-name+version `[[package]]` blocks and none carries the index `source` — transactional skip), `redirect_cargo_dep_overridden` (the crate does not resolve to crates.io because the user overrides it — its one `Cargo.lock` block carries a git / other-registry `source`, as a `[patch]` git or registry override in the root manifest or any cargo config leaves it, or has no `source` while the root `Cargo.toml` / project `.cargo/config*` holds a `[patch]` path entry for it; with no `Cargo.lock`, the same `[patch.crates-io]` / `[patch."https://github.com/rust-lang/crates.io-index"]` entry for the crate, by key or `package = "…"`, in the root `Cargo.toml` or the project `.cargo/config*` — transactional skip, nothing rewritten: a Socket pin would silently replace the user's fork and the then-unused `[patch]` entry breaks `cargo --locked`). Also additive: `redirect_gem_version_not_locked` (gem: no `GEM` section of the lock lists the crawled `name (version)`, for example a version another project installed into the shared gem home; the gem is skipped with nothing written, so the user's declared constraint and the locked version are never overwritten), `redirect_gem_no_lockfile` (gem: the project has a `Gemfile` / `gems.rb` but no `Gemfile.lock` / `gems.locked`, so nothing records which version it resolves and the crawled version may be another project's copy in the shared gem home; the gem is skipped with nothing written, never pinned over the user's constraint or appended as a new dependency, and the detail asks for `bundle lock` (or `bundle install`) and a re-run). Also v5.0: a registry override of the wrong kind (or none at all) warns the arm's missing-override code for nuget/gem/golang. Refusals stay fail-closed with a diagnosis that names the actual cause: a yarn-berry lock entry resolving through a non-`npm:` protocol keeps `redirect_yarn_berry_unsupported_protocol` with the entry's ACTUAL protocol in the detail — except socket-patch's OWN vendored wiring (a `file:` range into `.socket/vendor/`), which gets the distinct `redirect_yarn_berry_vendored_entry` code whose detail names the retirement path (`remove ` per package, or `vendor --revert` which unwinds every vendored package, then re-run `scan --mode hosted`). Both leave the entry byte-identical; neither changes exit code or status. **yarn berry line endings (v5.0)**: yarn writes a NEW `yarn.lock` with the OS line ending (`os.EOL` — CRLF on Windows) and keeps an existing lock's majority ending on every later write, and a `core.autocrlf` checkout turns an LF lock CRLF on any OS — so a uniformly CRLF lock is rewritten in its own ending: every untouched byte (a leading BOM included) round-trips (and `rollback`'s upstream restore keeps the lock's own ending). A lock that MIXES CRLF and LF (or holds a bare CR) has no single ending to keep — yarn's own `--immutable` check rejects it too (YN0028) — so it is refused untouched with `redirect_yarn_berry_mixed_line_endings` (the detail names `yarn install`, which normalizes it). The root `package.json`, which the rewrite re-renders to add `resolutions`, gets the same gate: a mixed one is refused untouched with the same code — the decision vendored mode takes with `vendor_yarn_berry_mixed_line_endings`, from the same shared berry gate set. This replaces v4's `redirect_yarn_berry_crlf_unsupported`, which refused every CRLF lock and is no longer emitted. A vendored→hosted takeover of a yarn-berry entry is checked against these project gates (mixed `yarn.lock` / `package.json` line endings, unsupported `cacheKey`, a non-zero `.yarnrc.yml` `compressionLevel`) on the project as it is before any revert, because the revert re-renders `package.json` in its majority ending — wet and `--dry-run` alike. A refused purl keeps its vendored wiring, ledger entry and artifact byte-identical, is skipped with the gate's code (reported in `redirect.warnings[]`, followed by `redirect_takeover_kept_vendored`) and is never announced as `redirect_takeover_reverted_vendored`. +`scan --mode hosted` swaps the in-place apply for the registry-redirect pipeline: discover → resolve hosted-patch references (grant token + integrity + per-dep registry override) → rewrite ONLY the patched dependencies' lockfile / registry-config entries to point at the hosted packages. A dep counts as **redirected** only when its hosted-artifact URL (or per-dep registry index URL) actually landed in a project file — a granted reference whose rewriter found nothing to edit is neither counted nor attested. **No ledger (v5.0)**: hosted mode writes ONLY the lockfile / registry-config edits — `.socket/vendor/redirect-state.json` is never written (on success or failure), and a pre-v5 one on disk is ignored (never read for planning, never quarantined, left byte-identical). The lockfiles are the only record of a hosted patch: `list`, `vex`, `rollback`, `remove`, `vendor` and `repair` all discover the hosted pins from them (a hosted URL counts only on `https://patch.socket.dev` or the `--patch-server-url` / `SOCKET_PATCH_SERVER_URL` origin), and commit-ready output is just the lockfile / config changes. Cargo and golang are confirmed only by their rewriter's own report (`confirmed_cargo_uuids` / `confirmed_golang_uuids`): a golang dep counts only when its go.mod `replace M V => patch.socket.dev/gopatch/ ` and both go.sum lines are in place, never because the patch-server origin or leftover go.sum lines appear somewhere. Gradle is confirmed the same way (`confirmed_gradle_uuids`): only when the final files hold the owned script, the index row, the live apply line in every build's settings file and the suffixed version in every lock entry of the GA (see [Gradle builds](#gradle-builds-v50)). A golang module that go.mod does not require and go.sum does not list at the patched version is outside the build graph and is refused with `redirect_golang_not_in_module_graph` (nothing written). Only the exact module `patch.socket.dev/gopatch/` is socket-owned; any other module path is refused with `redirect_golang_untrusted_module_path`. A vendored golang module is taken over like cargo and the npm family: its vendor wiring, committed copy and ledger entry are reverted first (`redirect_takeover_reverted_vendored`). A vendored PyPI package (requirements.txt, Poetry, Pipenv, uv, Hatch, PDM, pylock) is taken over the same way: its vendored wiring is restored to the recorded registry entry, its ledger entry and wheel are removed, and it is redirected in the same commit. The Python rewriters treat any non-registry source as user-authored, so without the revert they refused socket-patch's own vendored source and left the project vendored. A takeover revert that leaves vendored wiring in place is refused with `redirect_vendored_revert_failed`. That covers a drift-skipped record (`vendor_lock_entry_drifted`) and a reverted file that still references the artifact (`vendor_revert_residual_reference`). The ledger entry and artifact are kept, and the package stays vendored and skipped. `--dry-run` predicts the same refusal from the same signals instead of previewing `redirect_would_revert_vendored`. The hosted requirements.txt rewriter only rewrites an existing pin in the root `requirements.txt`, so a vendored requirements.txt package whose wiring is a pin in a `-r` include or a `(transitive)` line vendored mode appended is kept vendored, wet and `--dry-run` alike, with `redirect_requirements_takeover_unreachable` (`redirect.warnings[]`, and `redirect.skipped[].reason`). Its wiring, ledger entry and wheel are kept, so it stays vendored and patched (exit 0). The uv and Poetry rewriters are covered the same way: a vendored uv package whose recorded pre-vendor `uv.lock` entry is at another version than the patch (vendored uv pins the entry down to the patch's version; the revert brings the lock's own version back, and hosted mode only pins the version the lock resolves) is kept vendored with `redirect_uv_takeover_version_unreachable`, and a vendored Poetry package on a Poetry 0.x lock (which hosted mode refuses outright) is kept vendored with `redirect_poetry_lock_unsupported`. **Staged takeover (v5.0)**: the takeover is atomic. Each purl's vendored revert is staged in memory (the run's group commit, the same journaled commit vendored mode uses), the hosted rewrite plans against the reverted project, and a staged purl the rewrite does not pin is retracted: every staged revert is undone, that purl keeps its vendored wiring, ledger entry and artifact byte-identical, and the rest are staged and rewritten again. A retracted purl is skipped (`redirect.skipped[].reason`) with the cause: its existing skip reason (unavailable wheel metadata, …), the rewriter warning that names the package (`redirect_yarn_berry_missing_checksum`, `redirect_pypi_platform_wheel`, …), `redirect_requirements_takeover_unreachable`, the rewrite's lock-level refusal (`redirect_yarn_berry_mixed_line_endings`, `redirect_bun_lock_unsupported`, a Gradle planner refusal, …) or `redirect_takeover_not_pinned`; that warning is reported in `redirect.warnings[]`, followed by `redirect_takeover_kept_vendored` naming the package. Exit 0: the package stays vendored and patched, never unpatched in both modes. The reverts, the hosted pins and the vendored ledger then reach the disk in one commit, and the reverted artifacts are deleted only after it: a refusal or write failure before the commit writes nothing, a failed commit puts back the files it replaced, and a commit interrupted after its journal was written is finished by the next command that takes the apply lock. `--dry-run` runs the same steps and drops the staged state instead of committing, so its `redirected` count and warnings are the wet run's. A hosted run with no takeover stages its writes the same way but commits them without the journal (it writes nothing under `.socket/`): a file that fails to be replaced puts back the ones already replaced, so a failed run leaves no lock half-redirected. Re-runs over already-rewritten output plan from the current lock text and are idempotent (exit 0, lock unchanged). **Lock (v5.0)**: the hosted engine acquires `<.socket>/apply.lock` before its first wet write (the staged takeover reverts) — not on `--dry-run`, and not when the run would write nothing (zero redirects, all skipped) — so previews and no-op runs never create `.socket/`; contention is `lock_held` and a lock-file I/O fault (a read-only project root, a file squatting on `.socket/`) is `lock_io` — both exit 1, refused BEFORE any project file is written, and rendered like every other lock holder: human `Error (): ` on stderr (+ the `--lock-timeout` hint for a live holder); JSON keeps the hosted shape — top-level `status: "error"`, `error: {code: "lock_held" | "lock_io", message}` (v5.0: the same object every command uses; no top-level `error.code`), and `redirect: {mode: "hosted"}` retained. **Takeover symlink pre-check (v5.0)**: a vendored→hosted takeover whose recorded wiring file is a symlink is refused up front with `redirect_symlinked_file_unsupported` — wet and `--dry-run` alike, before any revert — so "nothing was written" holds. **Human mode (v5.0)**: hosted `scan` prints the results table and update detection like the other modes, then rewrites without a prompt (scan never prompts); `--dry-run` previews through the engine, and a detail fetch that leaves nothing to redirect enters the engine as a no-op (`Redirected 0 packages; rewrote 0 files.`, no lock, no `.socket/`). The detail fetch prints the same progress counter and per-package `Warning: could not fetch details for …` lines as the agent arm. An EMPTY hosted discovery prints `No patches available for installed packages.` and exits 0 without entering the engine; a discovery whose every offer is paid-tier for an org without paid access prints the table's paid nudge, then `No downloadable patches (paid subscription required).`, and exits 0 without entering the engine (parity with the agent/vendored arms). JSON output gains a `redirect` sub-object: `{ mode: "hosted", redirected, rewrittenFiles, skipped, patches, warnings, dryRun }` (`mode` is additive so consumers can dispatch without inferring it). `patches` (additive, v5.0) is the per-purl outcome of every selected patch, sorted by purl: `{purl, uuid, action}` with `action` `pinned` (`would_pin` under `--dry-run`; `redirected` counts these), `skipped` (`errorCode` = the `skipped[]` reason, `error` = its detail when it has one), or `unpinned` (`errorCode: redirect_unconfirmed` — the patch was granted but no lockfile entry pinning it could be rewritten; the human output's `Not hosted : …` line). An `unpinned` or `skipped` row does not change `status` or the exit code (the hosted exit policy is an open decision, #704). Rewriter warnings carry stable `redirect_*` codes (e.g. `redirect_npm_no_lockfile`, `redirect_gradle_manual_snippet`, `redirect_golang_unsupported`); new codes are additive (MINOR). v5.0 additive codes: `redirect_composer_no_lockfile` / `redirect_gem_no_gemfile` (composer / gem: neither manifest nor lock present — once per run, after the intake gates), `redirect_gem_bundle_gemfile_unsupported` (gem: `BUNDLE_GEMFILE` — `BUNDLE_GEMFILE:` in the bundler app config, which outranks the environment variable as in `Bundler::Settings`, else the environment variable — names a manifest other than the project's `Gemfile` / `gems.rb`, so no gem is redirected or attested; a value naming one of those two selects that pair even when the other spelling is present), `redirect_gem_bundle_lockfile_unsupported` (gem: bundler 4's custom lockfile — the `BUNDLE_LOCKFILE` environment variable, else `BUNDLE_LOCKFILE:` in the bundler app config, else in the global config — names a lock other than the loaded pair's own `Gemfile.lock` / `gems.locked`, so no gem is redirected or attested rather than pinning a lock bundler ignores), `redirect_gem_twin_manifest_ambiguous` (gem: a `Gemfile` + `gems.rb` twin under default discovery; bundler 1.x loads the `Gemfile` and bundler ≥ 2 loads `gems.rb`, and a lock's `BUNDLED WITH` records which bundler wrote it, not which one installs it, so neither pair is wired or attested — remove the unused spelling or set `BUNDLE_GEMFILE` to the one in use), `redirect_gem_mirror_overrides_source` (gem: Bundler's all-source, exact patch-source or patch-hostname mirror can route the per-dep `source` block to an unpatched upstream gem. Intake reads the app config (`BUNDLE_APP_CONFIG`, where a set-but-empty value selects `/config`, honoring `BUNDLE_IGNORE_CONFIG`) and all `BUNDLE_MIRROR__...` variables visible to the scan; app config overrides the environment per encoded key, then `mirror.all` takes precedence over exact source, which takes precedence over hostname. URI matching follows Bundler's whole-URI case folding, default-port/trailing-slash normalization and single slash key alias, not URL prefixes. An exact-source fallback-timeout key without a mirror URL shadows the hostname mirror and fetches that source directly; a configured URL is conservatively refused even if a timeout could bypass an unreachable mirror at install time. Like `redirect_gem_bundle_gemfile_unsupported`, the gate leaves the Gemfile pair byte-identical and confirms no gem redirect. On an embedded `scan --vex`, rediscovered older hosted gem pins may attest only from verified installed bytes: a missing tree is not excused by the lockfile, and `--vex-no-verify` omits those hosted gems with `mirror_overrides_source` rather than trusting their intercepted source. Agent/vendored evidence, unrelated ecosystems and standalone VEX behavior are unchanged. Details identify the setting form and its app/environment origin without printing mirror values or source URLs, which may contain credentials. Remove the applicable all/source/hostname setting (including any slash alias) from that origin and reuse its existing mirror URL under `mirror.https://rubygems.org` to clear the refusal; an environment setting must be unset in the scan/install environment. User-global Bundler config and mirrors set only in a later install environment are not inspected; keep those mirrors scoped to the upstream source too), `redirect_maven_no_pom` (no `pom.xml` and no Gradle build), `redirect_nuget_lock_unparseable` (a present-but-corrupt `packages.lock.json` — warned once, nothing mutated; an absent lock still proceeds; a leading UTF-8 BOM, which dotnet reads past, is not corrupt and is kept on rewrite), `redirect_nuget_lock_other_version` (the lock also resolves the patched id at another version in some target framework: the exact-id `packageSourceMapping` would route that framework to a feed that serves only the patched version, so the dep is skipped with nothing written; only lock entries at the patched version are ever re-pinned, and `resolved` is never rewritten), `redirect_nuget_mapping_set_aside` (v5.0 #462: another source's `packageSourceMapping` also named the patched id exactly — Visual Studio's mapping UI writes such lists — which ties with the Socket source so NuGet would take the package from whichever feed answers first; that pattern, or its whole `` when it was the only one, is commented out in a `` comment while the patch is wired, and `remove` / `rollback` put it back byte-exact), `redirect_nuget_mapping_conflict` (such a pattern sits in markup that cannot go in a comment; the dep is skipped, nothing written). v5.0 #354: when the rewriter creates the `packageSourceMapping`, its `*` catch-all also names the sources NuGet merges in from the user config and every parent directory's config (honoring ``), since NuGet drops every source no pattern names; a fresh config only seeds `nuget.org` when those inherited configs have it (a parent that cleared it for a mirror keeps that choice); when an inherited config already has a `packageSourceMapping` (NuGet merges those too), no catch-all is written at all — only the Socket pattern — so a source the parent restricts is never widened; the exclusivity set-aside exempts only the source the run wires, so a `socket-patch-*` lookalike key or a stale uuid naming the id is set aside too, `redirect_cargo_lock_pkg_ambiguous` (several same-name+version `[[package]]` blocks and none carries the index `source` — transactional skip), `redirect_cargo_dep_overridden` (the crate does not resolve to crates.io because the user overrides it — its one `Cargo.lock` block carries a git / other-registry `source`, as a `[patch]` git or registry override in the root manifest or any cargo config leaves it, or has no `source` while the root `Cargo.toml` / project `.cargo/config*` holds a `[patch]` path entry for it; with no `Cargo.lock`, the same `[patch.crates-io]` / `[patch."https://github.com/rust-lang/crates.io-index"]` entry for the crate, by key or `package = "…"`, in the root `Cargo.toml` or the project `.cargo/config*` — transactional skip, nothing rewritten: a Socket pin would silently replace the user's fork and the then-unused `[patch]` entry breaks `cargo --locked`). Also additive: `redirect_gem_version_not_locked` (gem: no `GEM` section of the lock lists the crawled `name (version)`, for example a version another project installed into the shared gem home; the gem is skipped with nothing written, so the user's declared constraint and the locked version are never overwritten), `redirect_gem_no_lockfile` (gem: the project has a `Gemfile` / `gems.rb` but no `Gemfile.lock` / `gems.locked`, so nothing records which version it resolves and the crawled version may be another project's copy in the shared gem home; the gem is skipped with nothing written, never pinned over the user's constraint or appended as a new dependency, and the detail asks for `bundle lock` (or `bundle install`) and a re-run). Also v5.0: a registry override of the wrong kind (or none at all) warns the arm's missing-override code for nuget/gem/golang. Refusals stay fail-closed with a diagnosis that names the actual cause: a yarn-berry lock entry resolving through a non-`npm:` protocol keeps `redirect_yarn_berry_unsupported_protocol` with the entry's ACTUAL protocol in the detail — except socket-patch's OWN vendored wiring (a `file:` range into `.socket/vendor/`), which gets the distinct `redirect_yarn_berry_vendored_entry` code whose detail names the retirement path (`remove ` per package, or `vendor --revert` which unwinds every vendored package, then re-run `scan --mode hosted`). Both leave the entry byte-identical; neither changes exit code or status. **yarn berry line endings (v5.0)**: yarn writes a NEW `yarn.lock` with the OS line ending (`os.EOL` — CRLF on Windows) and keeps an existing lock's majority ending on every later write, and a `core.autocrlf` checkout turns an LF lock CRLF on any OS — so a uniformly CRLF lock is rewritten in its own ending: every untouched byte (a leading BOM included) round-trips (and `rollback`'s upstream restore keeps the lock's own ending). A lock that MIXES CRLF and LF (or holds a bare CR) has no single ending to keep — yarn's own `--immutable` check rejects it too (YN0028) — so it is refused untouched with `redirect_yarn_berry_mixed_line_endings` (the detail names `yarn install`, which normalizes it). The root `package.json`, which the rewrite re-renders to add `resolutions`, gets the same gate: a mixed one is refused untouched with the same code — the decision vendored mode takes with `vendor_yarn_berry_mixed_line_endings`, from the same shared berry gate set. This replaces v4's `redirect_yarn_berry_crlf_unsupported`, which refused every CRLF lock and is no longer emitted. A vendored→hosted takeover of a yarn-berry entry is checked against these project gates (mixed `yarn.lock` / `package.json` line endings, unsupported `cacheKey`, a non-zero `.yarnrc.yml` `compressionLevel`) on the project as it is before any revert, because the revert re-renders `package.json` in its majority ending — wet and `--dry-run` alike. A refused purl keeps its vendored wiring, ledger entry and artifact byte-identical, is skipped with the gate's code (reported in `redirect.warnings[]`, followed by `redirect_takeover_kept_vendored`) and is never announced as `redirect_takeover_reverted_vendored`. **Attribution gate (v5.0).** A hosted run never leaves wiring that lockfile discovery calls contested: before the rewrite writes any lockfile, the same discovery `vex`, `list`, `rollback`, `remove` and `vendor` read runs over the project as the rewrite would leave it. A candidate whose pin discovery reads but cannot attribute to one package version (a requirements `-r` include resolving the same version from the registry beside a rewired `Pipfile.lock`, #567; a Maven pin in a ``, #260) is left out of the rewrite and reported in `redirect.skipped[]` as `redirect_unattributable` (nothing written for it; exit code unchanged). Unchanged: a pin in a file discovery does not read (a pre-2.6 bundler `Gemfile`, locked by the next `bundle install`) keeps the rewriter's verdict, and so does a deliberate partial redirect the run already reports (a bundled or `bun patch`-ed copy left on the registry, a yarn `npm:` alias entry left on the registry with `redirect_yarn_classic_alias_skipped` / `redirect_yarn_berry_alias_skipped` while the package's direct entry is pinned, a dep withheld from the vlt rewrite while a sibling lock takes it), and so does a vendored→hosted takeover: its vendored wiring is reverted in the run's staged overlay before the rewrite plans, and it is redirected when the rewriters pin it (otherwise it is retracted and stays vendored), in a `--dry-run` preview the same. A lockless NuGet / Cargo pin (an exclusive Socket source mapping without `packages.lock.json`, a Cargo registry pin without `Cargo.lock`) is still written, with a `redirect_pin_lockless` warning: no lockfile records its version, so `vex` cannot attest it and `rollback` / `remove` / `vendor` refuse it until the lockfile exists (whether such pins should be written at all is an open decision). The rollout's recorded view uses the same discovery: a uuid a file merely mentions (a stale `package.json` field, an inactive `pdm.lock`, a comment) is not a pin and does not count as already patched. @@ -815,7 +815,7 @@ to **six flavors**. | pypi / pdm (pdm.lock) | (rebuilt wheel) | lock-only: the `[[package]]` gains the local-file `path` + `files[]` hash. pyproject + `content_hash` untouched. Non-fixture `[metadata] strategy` / hash-less locks refused | `pdm sync` (+ `pdm install --check`), cold cache | | pypi / pipenv (Pipfile.lock) | (rebuilt wheel) | lock-only: the `default`/`develop` entry → `{file, hashes:[sha256-of-our-wheel]}`. Pipfile + `_meta.hash` untouched. Emits `vendor_integrity_unverified` — pipenv does not hash-check file entries; the committed wheel bytes are the protection | `pipenv install --deploy` (+ `pipenv verify`), cold cache | | pypi / requirements.txt (pip / `uv pip`) | (rebuilt wheel) | pin line → `./` (markers carried over; transitive deps appended), plus `--hash=sha256:` only when the requirements tree is already in pip's hash-checking mode (any `--hash` or `--require-hashes`) | `pip install -r` / `uv pip install -r` **run from the project root** (both resolve bare paths against the CWD) | -| nuget | deterministically rebuilt `.nupkg` at `..nupkg` (the uuid dir IS a NuGet folder feed; the stale embedded signature is dropped — unsigned is accepted under NuGet's default validation), plus `/.gitignore` (`!*`: re-includes the nupkg against the project's ignores, such as VisualStudio.gitignore's `*.nupkg`); refuses `vendor_artifact_gitignored` when git would still drop it | `nuget.config` source + `packageSourceMapping` for the id (creating the mapping from scratch ALSO fans a `` out to every pre-existing source — mapping is exclusive, NU1100 otherwise) **+** `packages.lock.json` `contentHash` → `base64(sha512(nupkg))` for the entries at the patched version in every lock a project under the root restores into — the root `packages.lock.json`, member projects' locks, `packages..lock.json`, a literal `NuGetLockFilePath` (v5.0 #353/#514; an unevaluable `NuGetLockFilePath` is refused with `vendor_nuget_lock_path_unresolved`) — (`vendor_nuget_no_lockfile` warning when there is none; a lock that also resolves the id at another version is refused with `vendor_nuget_lock_other_version`, nothing written) | `dotnet restore --locked-mode`, cold cache, `--network none` (tampered nupkg fails NU1403) | +| nuget | deterministically rebuilt `.nupkg` at `..nupkg` (the uuid dir IS a NuGet folder feed; the stale embedded signature is dropped — unsigned is accepted under NuGet's default validation), plus `/.gitignore` (`!*`: re-includes the nupkg against the project's ignores, such as VisualStudio.gitignore's `*.nupkg`); refuses `vendor_artifact_gitignored` when git would still drop it | `nuget.config` source + `packageSourceMapping` for the id (creating the mapping from scratch ALSO fans a `` out to every pre-existing source, including the ones NuGet inherits from the user config and parent directories' configs (v5.0 #354), none at all when an inherited config already maps packages — mapping is exclusive, NU1100 otherwise; another source's exact pattern for the id is set aside in a comment while vendored, `vendor_nuget_mapping_set_aside`, #462) **+** `packages.lock.json` `contentHash` → `base64(sha512(nupkg))` for the entries at the patched version in every lock a project under the root restores into — the root `packages.lock.json`, member projects' locks, `packages..lock.json`, a literal `NuGetLockFilePath` (v5.0 #353/#514; an unevaluable `NuGetLockFilePath` is refused with `vendor_nuget_lock_path_unresolved`) — (`vendor_nuget_no_lockfile` warning when there is none; a lock that also resolves the id at another version is refused with `vendor_nuget_lock_other_version`, nothing written) | `dotnet restore --locked-mode`, cold cache, `--network none` (tampered nupkg fails NU1403) | | maven | the patched `.jar` + the upstream pom (only its `` suffixed; transitives survive) + `.sha1` sidecars + an ownership marker under `.socket/vendor/maven2///-socket./`; every JVM tree root (`.socket/vendor/maven2`, Gradle's `.socket/vendor/gradle`, Coursier's `.socket/vendor/coursier`) owns a `.gitignore` (`!*`) that re-includes the jars against the project's ignores, such as Java.gitignore's `*.jar`, plus a `.gitattributes` (`-text`); a tree root git ignores itself refuses `vendor_artifact_gitignored` | every pom root, single-module (a reactor of one) or multi-module: the pinned `` + `` pin, `.mvn/maven.config` (`maven.repo.local.tail`) and the `socket-patch-vendor` fallback file repository (`checksumPolicy=fail`); Gradle, sbt and scala-cli roots go to the same JVM backend (ledger ecosystem `jvm`). Pre-v5 `maven_pom_repository` entries (`` to `.socket/vendor/maven/`) are revert-only: vendoring their root is refused (`vendor_jvm_shape_unsupported`, `legacy_maven_root`) | `mvn` build on a fresh checkout with a warm local repository and behind `mirrorOf external:*` (host capstone `e2e_vendor_maven_build` across the Maven matrix) | Ecosystems with no vendor backend (jsr) refuse per-purl with diff --git a/crates/socket-patch-core/src/formats/nuget/mod.rs b/crates/socket-patch-core/src/formats/nuget/mod.rs index f3617fb90..fcfee128c 100644 --- a/crates/socket-patch-core/src/formats/nuget/mod.rs +++ b/crates/socket-patch-core/src/formats/nuget/mod.rs @@ -31,6 +31,14 @@ pub(crate) struct NugetConfig { pub(crate) mappings: Vec<(String, Vec)>, /// Keys `configuration/disabledPackageSources` turns off. pub(crate) disabled: BTreeSet, + /// `configuration/packageSources` holds a ``: the sources every + /// farther config (parent directories, the user config) defined are + /// dropped, and only the ones after it count. + pub(crate) sources_cleared: bool, + /// Where each `mappings` row sits (parallel to it): the whole + /// `` element and each of its pattern tags, so a writer can + /// set one aside and put it back byte-exact. + pub(crate) mapping_spans: Vec, /// Live XML locations for writers. Routing readers and writers share /// the same treatment of comments, quoted attributes and element scope. pub(crate) configuration: Option, @@ -41,6 +49,15 @@ pub(crate) struct NugetConfig { pub(crate) repeated_sections: bool, } +/// The byte ranges of one `packageSourceMapping/packageSource` element. +#[derive(Debug, Clone)] +pub(crate) struct MappingSpan { + /// The whole element, open tag through close tag. + pub(crate) element: Range, + /// Each `` tag, parallel to the row's patterns. + pub(crate) patterns: Vec>, +} + #[derive(Debug)] pub(crate) struct ConfigSection { pub(crate) open: Range, @@ -64,6 +81,11 @@ fn section_mut<'a>( } fn record_clear(cfg: &mut NugetConfig, parents: &[&str], end: usize) { + if parents == ["configuration", "packageSources"] { + cfg.sources_cleared = true; + // NuGet drops what the file itself defined before the ``. + cfg.sources.clear(); + } let section = match parents { ["configuration", "packageSources"] => cfg.package_sources.as_mut(), ["configuration", "packageSourceMapping"] => cfg.source_mapping.as_mut(), @@ -97,6 +119,11 @@ pub(crate) fn parse_config(text: &str) -> Option { let mut stack: Vec<&str> = Vec::new(); // Index into `cfg.mappings` of the open `` element. let mut open_mapping: Option = None; + // Index into `cfg.mapping_spans` of the open `` element. + let mut open_span: Option = None; + // `(span, pattern)` of an open (not self-closing) `` element: + // its span runs through its close tag. + let mut open_pattern: Option<(usize, usize)> = None; let mut i = 0; while let Some(rel) = text[i..].find('<') { let at = i + rel; @@ -123,6 +150,18 @@ pub(crate) fn parse_config(text: &str) -> Option { if name == "clear" { record_clear(&mut cfg, &stack, i); } + if name == "package" + && stack[..] == ["configuration", "packageSourceMapping", "packageSource"] + { + if let Some((span, pattern)) = open_pattern.take() { + cfg.mapping_spans[span].patterns[pattern].end = i; + } + } + if name == "packageSource" && stack[..] == ["configuration", "packageSourceMapping"] { + if let Some(idx) = open_span.take() { + cfg.mapping_spans[idx].element.end = i; + } + } } else { let (tag, consumed) = parse_open_tag(&rest[1..])?; i = at + 1 + consumed; @@ -139,7 +178,25 @@ pub(crate) fn parse_config(text: &str) -> Option { if tag.name == "clear" && tag.self_closing { record_clear(&mut cfg, &stack, i); } + let (rows, patterns) = ( + cfg.mappings.len(), + open_mapping.map(|idx| cfg.mappings[idx].1.len()), + ); visit(&stack, &tag, &mut cfg, &mut open_mapping); + if cfg.mappings.len() > rows { + cfg.mapping_spans.push(MappingSpan { + element: at..i, + patterns: Vec::new(), + }); + open_span = (!tag.self_closing).then(|| cfg.mapping_spans.len() - 1); + } else if let (Some(idx), Some(before)) = (open_mapping, patterns) { + if cfg.mappings[idx].1.len() > before { + cfg.mapping_spans[idx].patterns.push(at..i); + if !tag.self_closing { + open_pattern = Some((idx, cfg.mapping_spans[idx].patterns.len() - 1)); + } + } + } if !tag.self_closing { if stack.len() >= MAX_XML_DEPTH { return None; @@ -293,6 +350,120 @@ fn decode_entities(raw: &str) -> String { out } +/// The package source keys NuGet merges from `chain`, farthest config first +/// (the user config, then each parent directory down to the nearest): a +/// config's `` drops every source a farther one defined. Keys keep +/// their first-seen order; a nearer redefinition keeps its place. +pub(crate) fn effective_source_keys<'a>( + chain: impl IntoIterator, +) -> Vec { + let mut keys: Vec = Vec::new(); + for cfg in chain { + if cfg.sources_cleared { + keys.clear(); + } + for (key, _) in &cfg.sources { + if !keys.contains(key) { + keys.push(key.clone()); + } + } + } + keys +} + +/// The comment a writer sets a competing mapping element aside in while the +/// Socket source `key` is wired: ``. +fn set_aside_open(key: &str) -> String { + format!(""; + +/// Set aside every OTHER source's exact pattern for `id` (#462). +/// +/// NuGet routes a package by its most specific pattern, and an exact id is +/// as specific as it gets: when another source also names `id` exactly +/// (Visual Studio's mapping UI writes such lists), the two tie and NuGet +/// takes the package from whichever answers first — the patched bytes or +/// the upstream ones. So while the Socket source `key` is wired, each such +/// pattern is commented out where it stands (the whole `` +/// when it was its only pattern: NuGet rejects an element with none), in a +/// comment naming `key` that [`restore_set_aside`] turns back into the +/// original bytes. A `socket-patch-*` key is no exception: the key alone +/// proves nothing about the feed behind it (a stale uuid, or any URL under a +/// Socket-looking name), and only the source this run wires may serve `id`. +/// +/// `Ok((text, keys))` with the sources set aside (empty: nothing competed); +/// `Err` when an element cannot be put in a comment (it holds `--`). +pub(crate) fn set_aside_competing_patterns( + text: &str, + cfg: &NugetConfig, + key: &str, + id: &str, +) -> Result<(String, Vec), String> { + // The key opens the comment: `--` in it could close the comment early. + if key.contains("--") { + return Err(format!( + "source key {key} cannot name a set-aside comment (it holds `--`)" + )); + } + let mut cuts: Vec> = Vec::new(); + let mut keys: Vec = Vec::new(); + for ((source, patterns), span) in cfg.mappings.iter().zip(&cfg.mapping_spans) { + if source == key { + continue; + } + let hits: Vec = (0..patterns.len()) + .filter(|&j| patterns[j].eq_ignore_ascii_case(id)) + .collect(); + if hits.is_empty() { + continue; + } + if hits.len() == patterns.len() { + cuts.push(span.element.clone()); + } else { + cuts.extend(hits.iter().map(|&j| span.patterns[j].clone())); + } + if !keys.contains(source) { + keys.push(source.clone()); + } + } + cuts.sort_by_key(|r| std::cmp::Reverse(r.start)); + let mut out = text.to_string(); + for cut in cuts { + let inner = &text[cut.clone()]; + if inner.contains("--") { + return Err(format!( + "nuget.config maps {id} to {} too, in markup that cannot be set aside in a comment", + keys.join(", ") + )); + } + out.replace_range( + cut, + &format!("{}{inner}{SET_ASIDE_CLOSE}", set_aside_open(key)), + ); + } + Ok((out, keys)) +} + +/// Undo [`set_aside_competing_patterns`] for `key`: every comment it wrote +/// becomes the original markup again, byte for byte. +pub(crate) fn restore_set_aside(text: &str, key: &str) -> String { + let open = set_aside_open(key); + let mut out = String::with_capacity(text.len()); + let mut rest = text; + while let Some(at) = rest.find(&open) { + let after = &rest[at + open.len()..]; + let Some(end) = after.find(SET_ASIDE_CLOSE) else { + break; + }; + out.push_str(&rest[..at]); + out.push_str(&after[..end]); + rest = &after[end + SET_ASIDE_CLOSE.len()..]; + } + out.push_str(rest); + out +} + /// Encode `value` for a double-quoted attribute: the inverse of /// [`parse_config`]'s decoding, so a key read as `a&b` is written back as /// `a&b` and keeps its identity. @@ -315,4 +486,107 @@ mod tests { assert_eq!(super::decode_entities("&bogus;&"), "&bogus;&"); assert_eq!(super::decode_entities("�"), "�"); } + + #[test] + fn clear_drops_earlier_and_farther_sources() { + let cfg = super::parse_config( + "", + ) + .unwrap(); + assert!(cfg.sources_cleared); + assert_eq!(cfg.sources, [("new".to_string(), "y".to_string())]); + let parent = super::parse_config( + "", + ) + .unwrap(); + let plain = super::parse_config( + "", + ) + .unwrap(); + assert_eq!(super::effective_source_keys([&parent, &plain]), ["a", "b"]); + assert_eq!(super::effective_source_keys([&parent, &cfg]), ["new"]); + } + + const COMPETING: &str = "\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n"; + + /// #462: another source's exact pattern for the id is set aside (the + /// whole element when it is its only pattern) and restored byte-exact. + #[test] + fn competing_exact_patterns_are_set_aside_and_restored() { + let cfg = super::parse_config(COMPETING).unwrap(); + assert_eq!(cfg.mapping_spans.len(), cfg.mappings.len()); + let (out, keys) = super::set_aside_competing_patterns( + COMPETING, + &cfg, + "socket-patch-u", + "NEWTONSOFT.JSON", + ) + .unwrap(); + assert_eq!(keys, ["nuget.org", "corp"]); + let after = super::parse_config(&out).unwrap(); + let exact: Vec<&str> = after + .mappings + .iter() + .filter(|(_, p)| p.iter().any(|p| p.eq_ignore_ascii_case("newtonsoft.json"))) + .map(|(k, _)| k.as_str()) + .collect(); + assert_eq!(exact, ["socket-patch-u"], "{out}"); + assert!(after + .mappings + .iter() + .any(|(k, p)| k == "nuget.org" && p == &["*"])); + assert_eq!(super::restore_set_aside(&out, "socket-patch-u"), COMPETING); + // Idempotent: nothing left to set aside. + let (again, keys) = + super::set_aside_competing_patterns(&out, &after, "socket-patch-u", "Newtonsoft.Json") + .unwrap(); + assert!(keys.is_empty()); + assert_eq!(again, out); + // A `` written with a close tag is set aside whole. + let open_close = COMPETING + .replace( + "", + "", + ) + .replacen( + "", + "\n ", + 1, + ); + let cfg2 = super::parse_config(&open_close).unwrap(); + let (out2, _) = super::set_aside_competing_patterns( + &open_close, + &cfg2, + "socket-patch-u", + "Newtonsoft.Json", + ) + .unwrap(); + assert!(super::parse_config(&out2).is_some(), "{out2}"); + assert_eq!( + super::restore_set_aside(&out2, "socket-patch-u"), + open_close + ); + // A key that could close the comment is refused. + assert!(super::set_aside_competing_patterns( + COMPETING, + &cfg, + "socket-patch-x-->", + "Newtonsoft.Json" + ) + .is_err()); + // A Socket-looking key is a competitor like any other. + let lookalike = COMPETING.replace("key=\"corp\"", "key=\"socket-patch-evil\""); + let cfg3 = super::parse_config(&lookalike).unwrap(); + let (out3, keys3) = super::set_aside_competing_patterns( + &lookalike, + &cfg3, + "socket-patch-u", + "Newtonsoft.Json", + ) + .unwrap(); + assert_eq!(keys3, ["nuget.org", "socket-patch-evil"]); + assert_eq!(super::restore_set_aside(&out3, "socket-patch-u"), lookalike); + // Another key's markers are not ours to restore. + assert_eq!(super::restore_set_aside(&out, "socket-patch-v"), out); + } } diff --git a/crates/socket-patch-core/src/hosted/engine.rs b/crates/socket-patch-core/src/hosted/engine.rs index 917614c0a..25b2ac5e9 100644 --- a/crates/socket-patch-core/src/hosted/engine.rs +++ b/crates/socket-patch-core/src/hosted/engine.rs @@ -634,6 +634,33 @@ pub async fn read_candidate_files( } } + // NuGet merges the user config and every parent directory's config + // under the project's own: a catch-all mapping the rewriter creates + // must name their sources too (#354). Disk only (the in-memory engine + // refuses NuGet, and could not see them). + if candidates.iter().any(|c| c.dep.ecosystem == "nuget") + && !matches!(view, ProjectView::Memory(_)) + { + // The configs live outside the project: read beside the view, then + // handed to it as such reads (asking for its raw root would end a + // re-scan read cache's recording). + if let Some(root) = view.disk_root_reading(std::iter::empty::<&str>()) { + let (inherited, touched) = + crate::vendor::nuget_config::inherited_source_keys_traced(root).await; + view.disk_root_reading(&touched); + out.files.insert( + crate::patch::redirect::NUGET_INHERITED_SOURCES_KEY.to_string(), + inherited.keys.join("\n"), + ); + if inherited.mapped { + out.files.insert( + crate::patch::redirect::NUGET_INHERITED_MAPPING_KEY.to_string(), + String::new(), + ); + } + } + } + // NuGet: the root config routes every project under the root, so each // project's lock is pinned with it (#353, #514). The walk's answer rides // a synthetic key (the lock paths, an unevaluable NuGetLockFilePath, or diff --git a/crates/socket-patch-core/src/patch/redirect/mod.rs b/crates/socket-patch-core/src/patch/redirect/mod.rs index 12f426ecc..7071f0c8a 100644 --- a/crates/socket-patch-core/src/patch/redirect/mod.rs +++ b/crates/socket-patch-core/src/patch/redirect/mod.rs @@ -5973,6 +5973,8 @@ const NUGET_ORG_URL: &str = "https://api.nuget.org/v3/index.json"; fn add_nuget_source( config: &str, parsed: &crate::formats::nuget::NugetConfig, + inherited: Option<&[String]>, + inherited_mapped: bool, reg: &str, index_url: &str, pkg_id: &str, @@ -5980,11 +5982,34 @@ fn add_nuget_source( // The same source identities restore and VEX read, before Socket is added. let mut pre_existing_keys: Vec<&str> = parsed.sources.iter().map(|(key, _)| key.as_str()).collect(); + let own_sources = !pre_existing_keys.is_empty(); + // The sources NuGet merges in from the configs below this one (#354): + // once a mapping exists every source no pattern names is dropped, so a + // created catch-all must name them too — unless this file ``s + // them. `None` (the in-memory engine, which cannot see them) keeps the + // file-only reading. + let inherited: &[String] = match inherited { + Some(keys) if !parsed.sources_cleared => keys, + _ => &[], + }; + for key in inherited { + if !pre_existing_keys.contains(&key.as_str()) { + pre_existing_keys.push(key); + } + } let creating_mapping = parsed .source_mapping .as_ref() .is_none_or(|section| section.close_start.is_none()); - let seed_nuget_org = creating_mapping && pre_existing_keys.is_empty(); + // nuget.org is only seeded when the inherited configs have it (or + // nothing): a parent that cleared it for a mirror keeps that choice. + // An inherited mapping already routes everything else (NuGet merges + // mappings too): no catch-all, which would widen a source it restricts. + let seed_nuget_org = creating_mapping + && !own_sources + && !inherited_mapped + && (inherited.is_empty() || inherited.iter().any(|k| k == NUGET_ORG_KEY)); + let creating_mapping = creating_mapping && !inherited_mapped; let reg = nuget_xml_attribute(reg); let mut source_lines = format!( " ", @@ -5996,7 +6021,9 @@ fn add_nuget_source( source_lines.push_str(&format!( "\n " )); - pre_existing_keys.push(NUGET_ORG_KEY); + if !pre_existing_keys.contains(&NUGET_ORG_KEY) { + pre_existing_keys.push(NUGET_ORG_KEY); + } } let out = if let Some(section) = &parsed.package_sources { insert_nuget_children(config, section, "packageSources", &source_lines) @@ -6077,6 +6104,20 @@ fn nuget_xml_attribute(value: &str) -> String { .replace('\r', " ") } +/// The synthetic candidate key carrying the package source keys the configs +/// below the project's own NuGet merges in (the user config, parent +/// directories), one per line ([`crate::vendor::nuget_config::inherited_source_keys`]). +/// Never a path (see [`sbt::SYNTHETIC_KEY_PREFIX`]). +pub const NUGET_INHERITED_SOURCES_KEY: &str = ""; + +/// The synthetic candidate key present when one of those configs maps +/// packages already (`packageSourceMapping`, which NuGet merges too). +pub const NUGET_INHERITED_MAPPING_KEY: &str = ""; + +/// A config with no sources, the base of a fresh one when the inherited +/// configs dropped nuget.org. +const EMPTY_NUGET_CONFIG: &str = "\n\n \n \n\n"; + /// The synthetic candidate key carrying the locks the engine found every /// project under the root restoring into (#353, #514), one per line: /// `lock\t`, `unresolved\t\t` for a `NuGetLockFilePath` @@ -6103,10 +6144,21 @@ fn rewrite_nuget( .into_iter() .find(|name| files.contains_key(*name)) .unwrap_or(NUGET_CONFIG_FILE_NAMES[0]); - let mut config = files - .get(config_path) - .cloned() - .unwrap_or_else(default_nuget_config); + // The source keys the configs below this one define (the engine reads + // them from disk; absent in memory). + let inherited: Option> = files + .get(NUGET_INHERITED_SOURCES_KEY) + .map(|keys| keys.lines().map(str::to_string).collect()); + let mut config = files.get(config_path).cloned().unwrap_or_else(|| { + match &inherited { + // A parent cleared nuget.org (a mirror instead): a fresh config + // must not add it back (#354). + Some(keys) if !keys.is_empty() && !keys.iter().any(|k| k == NUGET_ORG_KEY) => { + EMPTY_NUGET_CONFIG.to_string() + } + _ => default_nuget_config(), + } + }); // A config this run authors from scratch records its source edits as // `added` — the spelling every other rewriter uses for a created file. let source_action = if files.contains_key(config_path) { @@ -6182,6 +6234,24 @@ fn rewrite_nuget( } for dep in &nuget { + // The uuid lands in the source key, the mapping and the set-aside + // comment: one carrying markup (`-->`, a quote, `<`) could write live + // nuget.config elements. Only ASCII alphanumerics and single hyphens + // pass (every canonical uuid does). + let uuid = &dep.patch_uuid; + if uuid.is_empty() + || uuid.contains("--") + || !uuid.bytes().all(|b| b.is_ascii_alphanumeric() || b == b'-') + { + result.warnings.push(RewriteWarning { + code: "redirect_nuget_invalid_uuid".into(), + detail: format!( + "{} has a malformed patch uuid; dependency skipped", + dep.name + ), + }); + continue; + } let Some(ov) = registry_override_of_kind(dep, "nuget-v3") else { result.warnings.push(RewriteWarning { code: "redirect_nuget_missing_override".into(), @@ -6258,19 +6328,66 @@ fn rewrite_nuget( result.warnings.push(unwritable()); continue; }; - if !parsed.sources.iter().any(|(key, _)| key == ®) { + let wired = parsed.sources.iter().any(|(key, _)| key == ®); + let base = if wired { + config.clone() + } else { // A failed insert skips the WHOLE dep (no edit record, no lock // re-pin): a mapping without its source routes the patched id to // a source that was never defined, and a lock pinned at the // patched contentHash over an upstream fetch fails NU1403 — both // while the ledger would claim the redirect landed. - let Some(updated) = add_nuget_source(&config, &parsed, ®, &ov.index_url, &dep.name) - else { + let Some(updated) = add_nuget_source( + &config, + &parsed, + inherited.as_deref(), + files.contains_key(NUGET_INHERITED_MAPPING_KEY), + ®, + &ov.index_url, + &dep.name, + ) else { result.warnings.push(unwritable()); continue; }; - config = updated; + updated + }; + // Another source naming the id exactly ties with ours, and NuGet + // takes the package from whichever answers first (#462): set that + // pattern aside while the patch is wired (the upstream restore puts + // it back), or skip the dep when it cannot be. + let Some(based) = crate::formats::nuget::parse_config(&base) else { + result.warnings.push(unwritable()); + continue; + }; + let (aside, moved) = match crate::formats::nuget::set_aside_competing_patterns( + &base, &based, ®, &dep.name, + ) { + Ok(done) => done, + Err(why) => { + result.warnings.push(RewriteWarning { + code: "redirect_nuget_mapping_conflict".into(), + detail: format!("{why}; {} not redirected", dep.name), + }); + continue; + } + }; + if !moved.is_empty() { + result.warnings.push(RewriteWarning { + code: "redirect_nuget_mapping_set_aside".into(), + detail: format!( + "{config_path} also mapped {} to {}; that pattern is commented out while the \ + patch is wired, so the Socket source alone serves it (remove / rollback \ + restore it)", + dep.name, + moved.join(", ") + ), + }); + } + if aside != config { + config = aside; config_changed = true; + } + if !wired { result.edits.push(FileEdit { path: config_path.into(), kind: "redirect_nuget_source".into(), @@ -9255,6 +9372,30 @@ mod tests { } } + #[test] + fn nuget_markup_in_the_patch_uuid_is_refused() { + let config = "\n \n \ + \n \ + \n \n \ + \n \ + \n\n"; + let files = BTreeMap::from([("nuget.config".into(), config.to_string())]); + for uuid in [ + "x --> \n"), + ) + .await + .unwrap(); + let reverted = revert_nuget(&entry.unwrap(), root, false).await; + assert!(reverted.success, "{:?}", reverted.error); + let after = tokio::fs::read_to_string(root.join("nuget.config")) + .await + .unwrap(); + assert_eq!( + after, + cfg.replace("", "\n") + ); + } + + /// #354 review: an inherited config that maps packages already routes + /// everything else (NuGet merges mappings too), so no `*` catch-all is + /// written — it would widen a source the parent restricts. + #[test] + fn inherited_mapping_gets_no_catch_all() { + let own = "\n \n \n \n\n"; + for original in [None, Some(own)] { + let t = build_config_edit_with( + original, + &["nuget.org".to_string(), "corp".to_string()], + true, + &source_key(), + &format!(".socket/vendor/nuget/{UUID}"), + "Newtonsoft.Json", + ) + .unwrap() + .new_text; + assert!(catch_all_of(&t).is_empty(), "{t}"); + let parsed = crate::formats::nuget::parse_config(&t).unwrap(); + assert_eq!( + parsed.mappings, + [(source_key(), vec!["Newtonsoft.Json".to_string()])], + "{t}" + ); + } + } + + /// #354 end to end: the project sits under a directory whose + /// nuget.config defines a private feed; vendoring creates a config whose + /// catch-all keeps that feed (and the implicit nuget.org) eligible. + #[tokio::test] + async fn vendor_keeps_a_parent_directorys_feed_routable() { + let (dir, blobs, installed, record) = fixture(true, None).await; + let outer = dir.path(); + tokio::fs::write( + outer.join("nuget.config"), + "\n \n \n \n\n", + ) + .await + .unwrap(); + // The project is a subdirectory: copy the fixture's lock into it. + let root = outer.join("app"); + tokio::fs::create_dir_all(&root).await.unwrap(); + tokio::fs::rename(outer.join(PACKAGES_LOCK), root.join(PACKAGES_LOCK)) + .await + .unwrap(); + let (result, _entry, _w) = + unwrap_done(run_vendor(&root, &blobs, &installed, &record, false).await); + assert!(result.success, "{:?}", result.error); + let t = tokio::fs::read_to_string(root.join("nuget.config")) + .await + .unwrap(); + assert_eq!(catch_all_of(&t), ["nuget.org", "corp"], "{t}"); + } + /// A key listed twice gets one catch-all, and an `` without a key /// gets none. #[test]