Fix residual-reference keep reported as drift (#1184)

crates/socket-patch-cli/CLI_CONTRACT.md

@@ -1323,7 +1323,7 @@ Every `--json` invocation emits a single JSON object that follows the **unified
 | `vendor_state_retained`   | `skipped`        | remove `--skip-rollback`: vendor wiring + artifact deliberately left in place (the next `vendor` run reconciles the dropped entry). Also the top-level error code when `--skip-rollback` targets a vendored patch with no manifest record (every `scan`/`get --mode vendored` entry — and, v5.0, the ledger-only leftover of an earlier `remove --skip-rollback` of a manifest-tracked vendored patch). |
 | `hosted_state_retained`   | (top-level error) | remove `--skip-rollback` targeting a hosted-only patch (no manifest entry): restoring the pin's upstream registry entry is the only possible removal, so the combination is refused (exit 1), mirroring the manifest-less vendored refusal above. |
 | `vendor_state_preserved`  | `skipped`        | remove `--preserve-state` (v5.0): lockfile unwired; artifact, ledger entry, and manifest entry all kept for a later re-apply. Rollback's counterpart is the `vendoredPreserved: []` envelope array. |
-| `vendor_revert_kept`      | `skipped` + top-level error | remove (v5.0): the vendored revert drift-kept (`kept_artifact`), so the ledger entry AND the manifest entry were both kept. ANY drift-keep makes the run a `partialFailure` (exit 1) — part of the requested removal did not happen; when EVERY matching entry drift-kept, the top-level error carries this code (`summary.removed` stays 0; the identifier DID match, so never `not_found`). Remedy: re-run `scan --mode vendored` to normalize, then remove. Rollback's counterpart is the `vendoredKept: []` envelope array (also exit 1). |
+| `vendor_revert_kept`      | `skipped` + top-level error | remove (v5.0): the vendored revert drift-kept (`kept_artifact`), so the ledger entry AND the manifest entry were both kept. ANY drift-keep makes the run a `partialFailure` (exit 1) — part of the requested removal did not happen; when EVERY matching entry drift-kept, the top-level error carries this code (`summary.removed` stays 0; the identifier DID match, so never `not_found`). Remedy: re-run `scan --mode vendored` to normalize, then remove. A PyPI revert that restored its recorded wiring but kept the wheel because another project file still installs from it (`vendor_revert_residual_reference`, e.g. a `pipenv requirements` / `uv export` / `poetry export` requirements file) is a keep too, but not a drift (#1184): its skip reason, the per-entry warning, the top-level message and rollback's `vendoredKept[].reason` say that a project file still installs from the vendored artifact, and the remedy is to point the file named by `vendor_revert_residual_reference` back at the registry release (or re-export it from the restored lock), then remove (or roll back) again. Its `vendor_artifact_kept` advisory says the same, and a hosted takeover refused for it (`redirect_vendored_revert_failed`) names the file instead of a wiring edit. Rollback's counterpart is the `vendoredKept: []` envelope array (also exit 1). |
 | `hosted_reverted`         | `removed`        | remove (v5.0): a hosted lockfile pin was restored to its upstream registry entry as part of removing the patch (`verified` on dry-run). Beside a manifest entry it bypasses `summary.removed` like `vendor_reverted`. |
 | `hosted_revert_failed`    | top-level error  | remove (v5.0): a matched hosted pin could not be restored to its upstream registry entry (`--offline`, a registry that does not answer, `bun.lockb`, a lock shape the restore refuses — see "Hosted unwind coverage"), or writing the restored files failed; the message names the `git checkout -- <files>` remedy. The manifest was not modified, exit 1. Rollback's counterpart is a `hosted.failed[]` entry (also `partial_failure` exit 1). v4's `hosted_revert_unsupported` is no longer emitted (every ecosystem has a restore). |
 | `reinstall_required`      | rollback `warnings[]` | rollback (v5.0): vendored/hosted wiring was unwound, but installed trees keep their patched bytes until the next package-manager install — the stale-install advisory. When the run also emits a Bun advisory (`vendor_bun_reinstall_required` / `redirect_bun_reinstall_required`) the detail and the human note add " (Bun: a plain `bun install` keeps them; run `bun install --force`)". |

crates/socket-patch-cli/src/commands/remove.rs

@@ -18,7 +18,9 @@ use super::rollback::{rollback_patches_inner, InnerSelection};
 use crate::args::{apply_env_toggles, GlobalArgs};
 use crate::commands::hosted_unwind::{run_hosted_leg, HostedLegOutcome};
 use crate::commands::lock_cli::acquire_or_emit;
-use crate::commands::vendored_backend::{RevertedEntry, VendorRevertStep, VendoredBackend};
+use crate::commands::vendored_backend::{
+    KeepCause, RevertedEntry, VendorRevertStep, VendoredBackend,
+};
 use crate::json_envelope::{Command, Envelope, EnvelopeError, PatchAction, PatchEvent, Status};
 use crate::ui::short_uuid;
 use crate::ui::{plural, sweep_failure};
@@ -865,11 +867,7 @@ pub async fn run(args: RemoveArgs) -> i32 {
         // this is the only way the removal can be empty): the remove did
         // not happen. NOT not_found; partialFailure keeps `summary.removed`
         // honest at 0.
-        let msg = format!(
-            "{}: every matching entry's vendored state drift-kept; nothing was \
-             removed (re-run `scan --mode vendored` to normalize, then remove)",
-            args.identifier
-        );
+        let msg = all_kept_message(&args.identifier, &vendor_leg.kept_causes);
         track_patch_remove_failed(&msg, &telemetry).await;
         if args.common.json {
             let mut env = Envelope::new(Command::Remove);
@@ -1126,21 +1124,62 @@ pub async fn run(args: RemoveArgs) -> i32 {
         // above are gated, so name the outcome once here.
         if !args.common.json {
             eprintln!(
-                "Error: {} matching entr{} drift-kept (vendored state and manifest \
-                 record retained); re-run `scan --mode vendored` to normalize, then \
-                 remove again",
-                vendor_leg.kept.len(),
-                if vendor_leg.kept.len() == 1 {
-                    "y was"
-                } else {
-                    "ies were"
-                }
+                "Error: {}",
+                kept_error_line(&vendor_leg.kept_causes, "manifest record")
             );
         }
         1
     }
 }
 
+/// The top-level error when every matching vendored entry was kept: the
+/// drift wording and its normalize remedy only for drift-keeps (#1184).
+fn all_kept_message(identifier: &str, causes: &[KeepCause]) -> String {
+    if causes.iter().all(|c| *c == KeepCause::Drift) {
+        return format!(
+            "{identifier}: every matching entry's vendored state drift-kept; nothing was \
+             removed (re-run `scan --mode vendored` to normalize, then remove)"
+        );
+    }
+    format!(
+        "{identifier}: every matching entry's vendored state was kept; nothing was removed \
+         ({})",
+        kept_remedies(causes)
+    )
+}
+
+/// The human error line for kept entries (`retained` names the record kept
+/// beside the vendored state).
+fn kept_error_line(causes: &[KeepCause], retained: &str) -> String {
+    let n = causes.len();
+    let entries = if n == 1 { "y was" } else { "ies were" };
+    if causes.iter().all(|c| *c == KeepCause::Drift) {
+        return format!(
+            "{n} matching entr{entries} drift-kept (vendored state and {retained} \
+             retained); re-run `scan --mode vendored` to normalize, then remove again"
+        );
+    }
+    format!(
+        "{n} matching entr{entries} kept (vendored state and {retained} retained); {}",
+        kept_remedies(causes)
+    )
+}
+
+/// One remedy per distinct keep cause.
+fn kept_remedies(causes: &[KeepCause]) -> String {
+    let mut out: Vec<String> = Vec::new();
+    for cause in [KeepCause::Reference, KeepCause::Drift] {
+        if causes.contains(&cause) {
+            let remedy = cause.remedy("remove again");
+            out.push(match cause {
+                KeepCause::Reference => remedy,
+                KeepCause::Drift => format!("for a drift-kept entry, {remedy}"),
+            });
+        }
+    }
+    out.join("; ")
+}
+
 /// The vendored leg's envelope material, collected by
 /// [`revert_vendored_matches`].
 #[derive(Default)]
@@ -1151,9 +1190,11 @@ struct RemoveVendorLeg {
     /// Backend warnings, drift-keeps and preserved entries — `Skipped`
     /// events.
     skipped: Vec<PatchEvent>,
-    /// Ledger keys whose revert drift-kept: entry, artifact and any
+    /// Ledger keys whose revert kept the artifact: entry, artifact and any
     /// manifest record stay.
     kept: Vec<String>,
+    /// Why each [`Self::kept`] entry was kept (same order).
+    kept_causes: Vec<KeepCause>,
     /// Entries actually reverted and dropped from the ledger (wet runs).
     reverted_count: usize,
     /// Entries unwired with their artifact and ledger entry kept
@@ -1224,29 +1265,29 @@ async fn revert_vendored_matches(
                 );
                 return Err(1);
             }
-            VendorRevertStep::Kept => {
-                // Drift-keep: the lock changed under us and the backend
-                // left both the wiring and the artifact alone. Per the
-                // RevertOutcome contract the ledger entry stays — and so
-                // must any manifest entry, or `vendor`'s reconcile would
-                // re-revert an entry whose backing record is gone.
+            VendorRevertStep::Kept(cause) => {
+                // The backend kept the artifact (a drift-keep, or a file
+                // that still installs from it). Per the RevertOutcome
+                // contract the ledger entry stays — and so must any
+                // manifest entry, or `vendor`'s reconcile would re-revert
+                // an entry whose backing record is gone.
+                let reason = cause.reason();
                 let (note, detail) = if manifest_backed {
                     (
                         "; its manifest entry was kept too",
-                        "lockfile wiring drifted; vendored state and manifest entry kept",
+                        format!("{reason}; vendored state and manifest entry kept"),
                     )
                 } else {
                     (
                         "",
-                        "lockfile wiring drifted; vendored state and ledger entry kept",
+                        format!("{reason}; vendored state and ledger entry kept"),
                     )
                 };
                 if loud {
-                    eprintln!(
-                        "Warning: Kept vendored state for {key}: lockfile wiring drifted{note}"
-                    );
+                    eprintln!("Warning: Kept vendored state for {key}: {reason}{note}");
                 }
                 leg.kept.push(key.clone());
+                leg.kept_causes.push(cause);
                 leg.skipped.push(
                     PatchEvent::new(PatchAction::Skipped, key.clone())
                         .with_reason("vendor_revert_kept", detail),
@@ -1572,11 +1613,7 @@ async fn remove_ledger_only(
         // top-level error names the outcome — nothing was removed.
         env.mark_partial_failure();
         if leg.kept.len() == keys.len() {
-            let msg = format!(
-                "{}: every matching entry's vendored state drift-kept; nothing was \
-                 removed (re-run `scan --mode vendored` to normalize, then remove)",
-                args.identifier
-            );
+            let msg = all_kept_message(&args.identifier, &leg.kept_causes);
             track_patch_remove_failed(&msg, telemetry).await;
             env.error = Some(EnvelopeError::new("vendor_revert_kept", msg));
         }
@@ -1594,14 +1631,8 @@ async fn remove_ledger_only(
         // are gated, so name the outcome once here.
         if !args.common.json {
             eprintln!(
-                "Error: {} matching entr{} drift-kept (vendored state and ledger record \
-                 retained); re-run `scan --mode vendored` to normalize, then remove again",
-                leg.kept.len(),
-                if leg.kept.len() == 1 {
-                    "y was"
-                } else {
-                    "ies were"
-                }
+                "Error: {}",
+                kept_error_line(&leg.kept_causes, "ledger record")
             );
         }
         1

crates/socket-patch-cli/src/commands/rollback.rs

@@ -27,7 +27,9 @@ use std::time::Duration;
 use crate::args::{apply_env_toggles, is_local_go, parse_bool_flag, GlobalArgs};
 use crate::commands::hosted_unwind::run_hosted_leg;
 use crate::commands::lock_cli::acquire_or_emit;
-use crate::commands::vendored_backend::{RevertedEntry, VendorRevertStep, VendoredBackend};
+use crate::commands::vendored_backend::{
+    KeepCause, RevertedEntry, VendorRevertStep, VendoredBackend,
+};
 use crate::ecosystem_dispatch::{
     distinct_npm_copies, find_all_packages_for_rollback, partition_purls, JvmScope,
 };
@@ -794,10 +796,18 @@ async fn run_vendored_leg(
                 }
                 out.failed.push((key, why));
             }
-            VendorRevertStep::Kept => out.kept.push((
+            VendorRevertStep::Kept(KeepCause::Drift) => out.kept.push((
                 key,
                 "lockfile wiring drifted; vendored state left untouched".to_string(),
             )),
+            VendorRevertStep::Kept(cause @ KeepCause::Reference) => out.kept.push((
+                key,
+                format!(
+                    "{}; vendored state kept — {}",
+                    cause.reason(),
+                    cause.remedy("roll back again")
+                ),
+            )),
             VendorRevertStep::WouldRevert if preserve => {
                 if loud {
                     println!("Would unwire vendoring for {key} (artifact preserved)");

crates/socket-patch-cli/src/commands/scan/hosted/takeover.rs

@@ -253,6 +253,11 @@ impl Takeover {
                         outcome.error.as_deref().unwrap_or("unknown error")
                     ),
                 }))
+            } else if let Some(residual) = residual_only_keep(&outcome) {
+                // Nothing drifted: another project file (an exported
+                // requirements file) still installs from the vendored
+                // wheel (#1184). Name it, not a drift.
+                Some(residual_takeover_warning(&purl, &residual))
             } else if revert_keeps_wiring(&outcome) {
                 // A wiring record drifted and was left in place, so the
                 // project may still resolve through the vendored artifact
@@ -552,6 +557,59 @@ fn revert_keeps_wiring(outcome: &RevertOutcome) -> bool {
             .any(|w| w.code == "vendor_revert_residual_reference")
 }
 
+/// The `vendor_revert_residual_reference` detail of a revert whose ONLY
+/// keep signal is a file that still references the artifact.
+fn residual_only_keep(outcome: &RevertOutcome) -> Option<String> {
+    if outcome.drift_skipped() {
+        return None;
+    }
+    outcome
+        .warnings
+        .iter()
+        .find(|w| w.code == socket_patch_core::vendor::RESIDUAL_REFERENCE_CODE)
+        .map(|w| {
+            // `kept <dir>: <file> still resolves through it, and deleting …`:
+            // only the clause naming the file; the revert's own remedy is
+            // not this command's.
+            let detail = w.detail.as_str();
+            detail
+                .split_once(": ")
+                .map_or(detail, |(_, rest)| rest)
+                .split(", and deleting")
+                .next()
+                .unwrap_or(detail)
+                .to_string()
+        })
+}
+
+/// The refusal for a takeover whose vendored wheel another project file
+/// still installs from.
+///
+/// The order matters: the refusal leaves the lock vendored, so re-exporting
+/// from it now would name the wheel again. The file is pinned by hand
+/// first; only after the hosted scan has rewired the lock is a re-export
+/// safe.
+fn residual_takeover_warning(purl: &str, residual: &str) -> serde_json::Value {
+    let pin = purl
+        .strip_prefix("pkg:pypi/")
+        .map(|rest| rest.split(['?', '#']).next().unwrap_or(rest))
+        .and_then(|rest| rest.split_once('@'))
+        .map_or_else(
+            || "the registry release".to_string(),
+            |(name, version)| format!("`{name}=={version}`"),
+        );
+    serde_json::json!({
+        "code": "redirect_vendored_revert_failed",
+        "detail": format!(
+            "{purl} is vendored and another project file still installs from its \
+             vendored wheel ({residual}), so it is left in place; NOT switched to hosted — \
+             first replace the wheel path in that file with {pin} by hand (the lock is \
+             still vendored, so a re-export now would name the wheel again), re-run \
+             `scan --mode hosted`, and only then re-export the file from the rewired lock"
+        ),
+    })
+}
+
 /// The refusal for a takeover whose vendored wiring drifted since vendoring.
 fn drifted_takeover_warning(purl: &str) -> serde_json::Value {
     serde_json::json!({