ROADMAP gains the Stage 5 table it never had — the whole S5/S6/S7 definition lived outside the repo, so `main` described the order and nothing else. Five live bugs are recorded there because none of them were S5 features: the wedged slot, the missing lifecycle markers, the removal that ignored its cancellation token, the swallowed `--no-snapshot`, and the pin button that was a tab stop. DATA-FLOW §5 now says the dialog is not the enforcement point, and §9.1 names its proof per plan shape: a `ResolutionReport` for a resolve, a `GuardReport` plus a `GuardAck` for a removal, a `RollbackPlan` for a restore. It had required a `ResolutionReport` "accepted in this session", which the uninstall path cannot produce — there is nothing to resolve — so the one flow with no preview was also the one flow the invariant did not describe. UI-SPEC §4 records two inline row buttons rather than the `⋮` menu it specified, with the click arithmetic that forced it, and the Pins screen's Exclude-only scope with the reason: `pins::hold_requirements` has no caller and `plan_requirements` restates the installed version, so a Hold at another version is a promise nothing keeps. §5 states the click-counting convention it had been applying inconsistently. §6 corrects the inventory to **13 of 16** — the "16 of 16" claim after S4 had folded in components that are not on that list — and names the four that are load-bearing but unlisted. CLI-SPEC §5 and §7 follow the exit code from 1 to 2. TESTING §1.5 says the guard must be enforced and not merely reported. CLAUDE.md: 31 → 32 codes, and adding one now re-blesses every schema that *embeds* `Code`, not just `Code`; 46 → 52 goldens; and the rule S5 leaves behind — a decision that sits between two IPC messages needs a value the executing call demands, or "somebody forgot to look" stays expressible. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
9.8 KiB
PipDock — Data Flow
Version 0.1 · 2026-07-17. This document is the corrected, authoritative version of the original concept flows.
1. Correction log vs. original concept
| Original concept | Corrected design | Why |
|---|---|---|
| "Check Conflict → If True → update" | No conflict → update. Conflict → explain → 3-way choice | Original condition was inverted; binary Yes/No hid the safe middle option |
| Per-package conflict check | Group dry-run resolve of the whole selection | Resolving A+B+D together often succeeds where one-by-one is stuck; matches how pip's resolver actually works |
| "Show the full list of all Python packages" | Search-first over a locally cached PyPI name index | PyPI hosts ~600 k projects; a browsable list is unusable and unfetchable |
| (absent) | Environment selection + PEP 668 guard as step zero | Without it, users mutate system Python by accident — the worst possible outcome |
| (absent) | Snapshot before every batch | Makes every flow reversible; prerequisite for user trust |
2. Shared preamble (all mutating flows)
[Select env] → probe.py -I → env facts (python ver, PEP 668, hidden_user_site, dist metadata)
│
├─ EXTERNALLY-MANAGED detected → BLOCKED banner (PD-ENV-002)
│ └─ explicit override in Settings → proceed with persistent warning chip
├─ hidden_user_site non-null → Installed screen shows the partial-listing note
│ (not a block; see SECURITY §2)
└─ ok → flow continues; reverse-dep graph built from probe data
Every candidate is then screened against the environment's Python version by
pipdock-core (ARCHITECTURE §3): incompatible ones are dropped from the plan with
PD-PKG-001 before any engine command runs, so the preview is identical under pip
and uv even though the engines themselves disagree.
3. Update flow (state machine)
Idle
└─ env selected → Scanning engine.list_outdated()
└─ SelectionReady rows: name, current → latest, pinned rows locked out of Select-all
└─ user selects + [Update] → Resolving
│ engine.resolve(PlanRequest{upgrades, strategy: Compatible})
├─ error → Failed(code) catalog-classified; retry available
└─ PreviewReady ResolutionReport rendered as a diff:
│ · clean upgrades (A 1.2 → 2.0)
│ · new transitive installs
│ · held-back items (B → 0.1.9, latest 0.5.0, blocked by A: "requests<0.2")
│ · impossible items
├─ conflicts exist → ConflictDecision (per held-back/impossible pkg):
│ [Keep compatible] default; accept resolver's version (held-back only)
│ [Skip] drop pkg from this plan
│ [Force latest] adds per-pkg override; warning names what breaks
│ any Force/Skip chosen → re-Resolve with overrides → PreviewReady (loop, max 3 rounds
│ then require manual pruning — prevents decision ping-pong)
└─ [Confirm] → Snapshotting freeze + meta written; failure here ABORTS the plan (PD-SNP-001)
└─ Executing
Phase A: single batch install of pinned set ── ok ──→ PostCheck
Phase B (on A-failure): per-pkg sequential, skip-and-continue,
live stderr → console via plan-progress events
└─ PostCheck engine.check(); findings appended to summary
└─ Summary see §6
Cancellation: allowed in Resolving/Executing; kills child process group; completed steps remain; summary marks the rest Skipped(UserCancelled); snapshot offers full revert.
4. Install flow
SearchIdle → (keystrokes) → QueryingIndex (local fuzzy, <50 ms) → Results
└─ row focus → MetadataFetch (PyPI JSON, cached 24 h) → detail panel
└─ [Add] → Queue ("dock bay", persists across searches; versions default latest, editable to spec)
Queue → [Install n packages] → Resolving (PlanRequest{installs}) → PreviewReady → … same tail as §3
Installed-tab presentation (per original concept, kept): up-to-date rows dimmed, outdated rows carry an UPDATE badge and are mirrored into the Updates tab; already-installed packages appearing in search results show an INSTALLED ✓ chip (or UPDATE if outdated) instead of [Add].
5. Uninstall flow
Selection → [Uninstall] → GuardCheck: reverse-dep graph over full removal set
├─ breaks nothing → Confirm dialog (lists removals)
└─ breaks {Y,Z} → Warning dialog: "Removing X breaks Y (requires X>=1), Z"
options: [Cancel] [Remove dependents too] (adds Y,Z to set, re-guard) [Force remove only X]
→ Snapshot → sequential engine.uninstall per pkg (skip-and-continue) → Summary
Rationale: bare pip uninstall performs no dependency check — this guard is a core value-add.
The dialog is not the enforcement point. Remove dependents too is the caller running the guard
again over the widened set, because pulling Y in can break Z and stopping after one level hands the
user a set that still breaks something. And the removal itself refuses to run unless the guard was
clear or the user explicitly accepted the breakage — flow::GuardAck, checked in
UninstallFlow::execute the way SnapshotProof is, so a caller that never looked at the report
cannot proceed by omission. Attempting it anyway is PD-RES-004, raised before the snapshot is
written so a plan that will not run leaves nothing behind.
A removal is blocked on a PEP 668 environment exactly as an update is: §2's preamble is "all mutating flows", and removing from a system Python is the more dangerous of the two, since no resolver stands between the user and the damage.
6. Summary model (owner requirement)
{ "planId":"…","phase":"B","results":[
{"pkg":"httpx","from":"0.27.0","to":"0.28.1","status":"ok"},
{"pkg":"oldlib","to":"2.0.0","status":"failed","code":"PD-BLD-002",
"reason":"build backend error in pyproject.toml","stderrTail":"…"}],
"check":{"ok":true,"findings":[]},
"counts":{"ok":13,"failed":2,"skipped":1} }
Rendered as: "13 successful, 2 failed, 1 skipped" with an expandable row per failure (catalog code, human reason EN/VI, stderr tail, Copy log, Report bug deep link — see ERROR-CATALOG §4).
7. Engine command mapping
| Operation | pip (<py> -m pip …) |
uv (uv pip … --python <py>) |
Adapter notes |
|---|---|---|---|
| List installed | (not used — see below) | (not used — see below) | Engine::list_installed exists and normalizes both shapes to Dist, but only resolve() calls it, to build SP-1's guard set |
| List outdated | list --outdated --format=json |
list --outdated --format=json |
uv output pinned in SP-1 fixtures |
| Dry-run resolve | install -U --dry-run --quiet --report - (JSON to stdout) |
uv pip install -U --dry-run (text plan; no stable JSON report) |
uv adapter parses text; exact format frozen via SP-1 fixtures + snapshot tests |
| Install pinned | install pkg==v [--no-deps in Phase A per-report set] |
uv pip install pkg==v |
Phase A passes the full pinned set in one call |
| Uninstall | uninstall -y pkg |
uv pip uninstall pkg |
|
| Env check | check |
uv pip check |
normalize findings |
| Freeze (snapshots) | freeze --all |
uv pip freeze |
pip's --all includes pip/setuptools; record engine in snapshot meta |
| Upgrade pip | install -U pip |
(n/a — surface "pip upkeep" only when pip engine active or pip present in env) |
Neither head lists installed packages through the engine. pipdock list and pkg_list both read probe.py instead, because the probe carries Requires-Dist — which list --format=json does not report, and which the reverse-dependency graph, the uninstall guard and blocker attribution are all built from. Reading the engine here would give the Installed screen a different package set than the guard that protects it. The -I trade-off this buys is documented in ARCHITECTURE §4 and surfaced as hidden_user_site.
Version floors: pip ≥ 22.2 for --dry-run --report (offer in-app pip upgrade when older); uv minimum pinned after SP-1.
8. Rollback flow
Snapshot selected → Diff = (current freeze) vs (snapshot freeze)
→ plan: uninstall {added}, install {removed ∪ changed @ snapshot versions}
→ dry-run resolve the restore set (a yanked/deleted release cannot be restored → PD-SNP-002,
listed explicitly; user may proceed partially)
→ snapshot current state first (rollback is itself reversible) → execute two-phase → summary
9. Data-flow invariants (enforced in pipdock-core, tested)
- No mutating engine call without an accepted proof for this session: a
ResolutionReportfor a resolve-shaped plan (update, install), aGuardReportplus aGuardAckfor a removal (§5), aRollbackPlanfor a restore (§8). Originally written as "aResolutionReport", which the uninstall path cannot produce — there is nothing to resolve — leaving the one flow with no preview also the one flow the invariant did not describe. - No mutating engine call without a successful snapshot write.
plan_executerefuses a report older than 10 minutes or if the env's probe hash changed (env drifted → re-resolve).- Every failure surfaced to UI/CLI carries a catalog code.
- Pinned packages never appear in a
PlanRequest.upgradesunless the user explicitly unpinned them this session.