pi-profile-switch 0.4.9 → 0.5.0

package/README.md

@@ -2,7 +2,7 @@
 
 [English](README.md) | [中文](README.zh-CN.md)
 
-Named profiles for [Pi](https://github.com/badlogic/pi-mono). A profile is a named capability bundle you define: skills, extensions, MCP servers, tools (including tools exposed by MCP servers and extensions), model defaults, and extra system-prompt instructions. Switch bundles inside a running Pi session — no restart.
+Named profiles for [Pi](https://github.com/badlogic/pi-mono). A profile is a named set of resources you define: skills, extensions, MCP servers, tools (including tools exposed by MCP servers and extensions), model defaults, and extra system-prompt instructions. Switch profiles inside a running Pi session — no restart.
 
 ## Install
 

package/bin/pi-profile.ts

@@ -16,7 +16,7 @@ import { getAgentDir } from "@earendil-works/pi-coding-agent";
 import { ExtensionError } from "../src/extension-discovery.ts";
 import { parseLauncherArgs } from "../src/launcher/args.ts";
 import { UnknownProfileError, resolveInitialProfile } from "../src/launcher/initial-profile.ts";
-import { sweepStaleRuntimeDirs } from "../src/launcher/runtime-cleanup.ts";
+import { sweepStaleInstances } from "../src/launcher/runtime-cleanup.ts";
 import { spawnPi } from "../src/launcher/spawn.ts";
 import { McpConfigError, MissingMcpAdapterError } from "../src/mcp-config.ts";
 import { CatalogError } from "../src/profile-catalog.ts";
@@ -36,10 +36,13 @@ try {
 	for (const warning of warnings) {
 		console.error(`pi-profile: warning: ${warning}`);
 	}
-	// Stale per-launch runtime dirs (dead pid, or no pid past the grace
-	// window) are swept before this launch materializes its own. Best-effort:
-	// sweep errors never block the launch.
-	await sweepStaleRuntimeDirs(agentDir);
+	// Stale per-launch instance dirs (dead pid, or no pid past the grace
+	// window) are swept before this launch materializes its own. Directories
+	// holding state pi-profile did not generate are kept and reported instead of
+	// deleted (ADR-0010). Best-effort: sweep errors never block the launch.
+	for (const warning of await sweepStaleInstances()) {
+		console.error(`pi-profile: warning: ${warning}`);
+	}
 	const generated = await generateRuntimeDir(plan, { agentDir, discovery, projectSettings, projectDir });
 	process.exitCode = await spawnPi({
 		generated,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pi-profile-switch",
-  "version": "0.4.9",
+  "version": "0.5.0",
   "description": "Named profiles for Pi: reference skills, extensions, MCP servers, and tools per workflow, switched without restarting. Install: npm install -g pi-profile-switch (not pi install).",
   "type": "module",
   "keywords": [

package/src/extension-discovery.ts

@@ -1,6 +1,6 @@
 /**
  * ExtensionDiscovery: implicit, read-only discovery of selectable extensions
- * (ADR-0006/0007), so profiles can reference extensions without any
+ * (ADR-0007/0008), so profiles can reference extensions without any
  * registration step.
  *
  * Two implicit sources, both resolved by Pi itself:

package/src/launcher/initial-profile.ts

@@ -31,7 +31,7 @@ export class UnknownProfileError extends Error {
 	}
 }
 
-/** Zero-match glob references surface as launch warnings (ADR-0006):
+/** Zero-match glob references surface as launch warnings (ADR-0009):
  *  visible, but never blocking — globs re-expand on every resolution. */
 function unmatchedWarnings(plan: ActivationPlan): string[] {
 	return (plan.unmatched ?? []).map(

package/src/launcher/runtime-cleanup.ts

@@ -1,35 +1,54 @@
 /**
- * RuntimeCleanup: sweeps stale per-launch runtime directories at startup.
+ * InstanceCleanup: sweeps stale per-launch instance directories at startup.
  *
- * The generated agent dirs under `<agentDir>/pi-profile/runtime/launch-*`
- * (ADR-0005) would otherwise accumulate forever. Startup sweep is the ONLY
- * cleanup mechanism by design: any exit — graceful, signal, SIGKILL, power
- * loss — kills the child pid, so the next launch's sweep converges. There is
- * no exit-time deletion; it would only buy immediacy at the cost of deletion
- * logic on the signal path.
+ * Every launch materializes its own instance dir under
+ * `<PI_PROFILE_SWITCH_DIR>/instances/launch-*` (ADR-0010), which would
+ * otherwise accumulate forever. Startup sweep is the ONLY cleanup mechanism by
+ * design: any exit — graceful, signal, SIGKILL, power loss — kills the child
+ * pid, so the next launch's sweep converges. There is no exit-time deletion; it
+ * would only buy immediacy at the cost of deletion logic on the signal path.
  *
- * Liveness token: a `pid` file written by spawnPi into the runtime dir.
- * (Naming the dir after the pid is impossible — the pid does not exist
- * before spawn, and the running process's PI_CODING_AGENT_DIR path is
- * frozen.) Rules per launch-* dir:
+ * Liveness token: a `pid` file written by spawnPi into the instance dir.
+ * (Naming the dir after the pid is impossible — the pid does not exist before
+ * spawn, and the running process's PI_CODING_AGENT_DIR path is frozen.) Rules
+ * per instance dir:
  * - pid file parses and the process is alive (or EPERM) → keep;
- *   ESRCH → delete.
- * - no/unparsable pid file → delete only when the dir mtime is older than
+ *   ESRCH → candidate.
+ * - no/unparsable pid file → candidate only when the dir mtime is older than
  *   NO_PID_GRACE_MS. The grace window guards the concurrent-launch race (a
- *   second launcher between mkdtemp and its pid write must not be reaped);
- *   it also covers pre-feature dirs and post-mkdtemp crashes.
+ *   second launcher between mkdir and its pid write must not be reaped); it
+ *   also covers post-mkdir crashes.
  * PID reuse needs no /proc check: a wrong keep only delays cleanup and
  * self-heals once the reused pid dies.
  *
+ * A candidate is deleted only when every entry in it is pi-profile's own: a
+ * symlink (the mirror's link into the real agent dir) or a managed generated
+ * file. Anything else is state an extension created at runtime, so the
+ * directory is kept and reported — the sweep never destroys data it cannot
+ * attribute. The check deliberately does NOT consult the real agent dir: a
+ * same-named entry there (a seeded `missions`, say) must not turn an
+ * instance-local real directory into a deletable one.
+ *
  * Everything is best-effort: sweep errors never block a launch.
  */
 
-import { readdir, readFile, rm, stat } from "node:fs/promises";
+import type { Dirent } from "node:fs";
+import { lstat, readdir, readFile, rm, stat } from "node:fs/promises";
 import path from "node:path";
 
-/** Grace period for launch dirs without a (parseable) pid file. */
+import { MANAGED_INSTANCE_FILES } from "../settings-generator.ts";
+import { getInstancesRootDir } from "../workspace.ts";
+
+/** Prefix of the directories this module owns under the instances root. */
+const INSTANCE_DIR_PREFIX = "launch-";
+
+/** Grace period for instance dirs without a (parseable) pid file. */
 export const NO_PID_GRACE_MS = 10 * 60 * 1000;
 
+/** Managed directories whose contents are not necessarily generated: a package
+ *  may write its own files inside them (e.g. an extension's own config). */
+const MANAGED_DIRS_WITH_RUNTIME_CONTENT = new Set(["extensions"]);
+
 function isProcessAlive(pid: number): boolean {
 	try {
 		process.kill(pid, 0);
@@ -40,11 +59,47 @@ function isProcessAlive(pid: number): boolean {
 	}
 }
 
-function runtimeRootOf(agentDir: string): string {
-	return path.join(agentDir, "pi-profile", "runtime");
+/** Paths inside `dir` that pi-profile did not generate, relative to `dir`.
+ *  `undefined` means the directory could not be inspected — the caller must
+ *  treat that as unrecognized rather than as empty. */
+async function unrecognizedEntries(dir: string): Promise<string[] | undefined> {
+	let entries: Dirent<string>[];
+	try {
+		entries = await readdir(dir, { withFileTypes: true });
+	} catch {
+		return undefined;
+	}
+
+	const found: string[] = [];
+	for (const entry of entries) {
+		const entryPath = path.join(dir, entry.name);
+		let linkStat;
+		try {
+			linkStat = await lstat(entryPath);
+		} catch {
+			continue; // Vanished under us: nothing to protect.
+		}
+		// Symlinks only point at the real agent dir and hold no data of their own.
+		if (linkStat.isSymbolicLink()) continue;
+		if (!MANAGED_INSTANCE_FILES.has(entry.name)) {
+			found.push(entry.name);
+			continue;
+		}
+		if (MANAGED_DIRS_WITH_RUNTIME_CONTENT.has(entry.name) && linkStat.isDirectory()) {
+			const nested = await unrecognizedEntries(entryPath);
+			if (nested === undefined) {
+				found.push(entry.name);
+				continue;
+			}
+			found.push(...nested.map((name) => path.join(entry.name, name)));
+		}
+	}
+	return found;
 }
 
-async function sweepEntry(dir: string): Promise<void> {
+/** Reclaims `dir` if it is both dead and free of unrecognized entries.
+ *  Returns the warnings for the cases where it was intentionally kept. */
+async function sweepEntry(dir: string): Promise<string[]> {
 	let pid: number | undefined;
 	try {
 		const raw = await readFile(path.join(dir, "pid"), "utf8");
@@ -55,31 +110,56 @@ async function sweepEntry(dir: string): Promise<void> {
 	}
 
 	if (pid !== undefined) {
-		if (!isProcessAlive(pid)) await rm(dir, { recursive: true, force: true });
-		return;
+		if (isProcessAlive(pid)) return [];
+	} else {
+		const info = await stat(dir);
+		if (Date.now() - info.mtimeMs <= NO_PID_GRACE_MS) return [];
 	}
 
-	const info = await stat(dir);
-	if (Date.now() - info.mtimeMs > NO_PID_GRACE_MS) {
-		await rm(dir, { recursive: true, force: true });
+	const unrecognized = await unrecognizedEntries(dir);
+	if (unrecognized === undefined) {
+		return [
+			`${dir} was not reclaimed: it could not be inspected (permissions?). Check its contents and delete it manually.`,
+		];
 	}
+	if (unrecognized.length > 0) {
+		return [
+			`${dir} was not reclaimed: it holds state pi-profile did not generate (${unrecognized.join(", ")}). ` +
+				`Move that state into the real agent dir (it is mirrored on the next launch), or point the extension that ` +
+				`created it at a fixed path via that extension's own configuration, then delete ${dir}.`,
+		];
+	}
+
+	await rm(dir, { recursive: true, force: true });
+	return [];
 }
 
-/** Deletes stale launch dirs under the agent dir's runtime root. Never throws. */
-export async function sweepStaleRuntimeDirs(agentDir: string): Promise<void> {
+/** Deletes stale instance dirs under the instances root and returns the
+ *  warnings for directories it deliberately kept. Never throws. */
+export async function sweepStaleInstances(): Promise<string[]> {
+	const warnings: string[] = [];
+	const root = getInstancesRootDir();
+
 	let entries: string[];
 	try {
-		entries = await readdir(runtimeRootOf(agentDir));
+		entries = await readdir(root);
 	} catch {
-		return; // No runtime root yet: nothing to sweep.
+		return warnings; // No instances root yet: nothing to sweep.
 	}
+
 	for (const entry of entries) {
-		if (!entry.startsWith("launch-")) continue;
-		const dir = path.join(runtimeRootOf(agentDir), entry);
+		// Only directories this module generated are candidates. Anything else
+		// under the root — 0.4.x's per-profile dirs included — is not ours to
+		// delete, and is left alone without a warning.
+		if (!entry.startsWith(INSTANCE_DIR_PREFIX)) continue;
+		const dir = path.join(root, entry);
 		try {
-			if ((await stat(dir)).isDirectory()) await sweepEntry(dir);
+			if (!(await stat(dir)).isDirectory()) continue;
+			warnings.push(...(await sweepEntry(dir)));
 		} catch {
 			// Best-effort: one bad entry must not stop the sweep or the launch.
 		}
 	}
+
+	return warnings;
 }

package/src/settings-generator.ts

@@ -3,9 +3,9 @@
  * runtime directory (ADR-0005).
  *
  * Two entry points:
- * - `generateRuntimeDir` (launcher): mkdtemp a fresh runtime dir, write the
- *   files, link state (auth/models/mcp/npm/git/bin; trust.json only for
- *   default), derive env.
+ * - `generateRuntimeDir` (launcher): create a fresh per-launch runtime dir
+ *   under the workspace instances root, write the files, mirror the real
+ *   agent dir as symlinks (trust.json only for default), derive env.
  * - `writeRuntimeFiles` (in-session switch, ticket 05): rewrite
  *   settings.json + pi-profile.json inside the EXISTING runtime dir (the
  *   running process's PI_CODING_AGENT_DIR cannot move), and transition the
@@ -99,6 +99,24 @@ export const MANAGED_INSTANCE_FILES = new Set([
 	"extensions",
 ]);
 
+/** State directories that Pi and its extensions resolve under the agent dir,
+ *  and which therefore appear at runtime rather than at install time. They are
+ *  seeded in the REAL agent dir before mirroring, so the instance gets a
+ *  symlink instead of a private real directory: runtime-created state then
+ *  lands where native Pi puts it, and third-party records never embed an
+ *  instance path (ADR-0010). Adding a name here needs observed evidence that a
+ *  package creates that directory under the agent dir; anything unlisted shows
+ *  up as an unrecognized entry in the sweep (src/launcher/runtime-cleanup.ts). */
+const SEEDED_STATE_DIRS = ["sessions", "missions"] as const;
+
+/** State FILES Pi creates at runtime (same evidence rule as the dirs). They
+ *  cannot be created up front — the content is Pi's, not pi-profile's — so the
+ *  instance gets a symlink into the real agent dir that is deliberately allowed
+ *  to dangle: Pi sees no file, writes through the link, and the real agent dir
+ *  gets the file. A real file left here instead would be unrecognized state and
+ *  would strand credentials in a directory the sweep refuses to delete. */
+const SEEDED_STATE_FILES = ["auth.json", "models-store.json"] as const;
+
 /** Resource dirs rooted at the real agent dir, re-included for the default
  *  profile because PI_CODING_AGENT_DIR moves the discovery root. */
 const RESOURCE_DIR_KINDS = ["skills", "extensions", "prompts", "themes"] as const;
@@ -405,7 +423,7 @@ export async function writeRuntimeFiles(
 					skills: plan.skills.map((skill) => ({ name: skill.name, filePath: skill.filePath })),
 					extensions: plan.extensions,
 				},
-				// Zero-match glob references (ADR-0006) — surfaced by /profile status
+				// Zero-match glob references (ADR-0009) — surfaced by /profile status
 				// so a typo'd glob is visible instead of silently selecting nothing.
 				...(plan.unmatched !== undefined ? { unmatched: plan.unmatched } : {}),
 				...options.planExtras,
@@ -494,9 +512,6 @@ export async function syncAgentSymlinks(agentDir: string, runtimeDir: string): P
 	if (!existsSync(agentDir)) return;
 	if (path.resolve(agentDir) === path.resolve(runtimeDir)) return;
 
-	// Ensure the real sessions directory exists so it is always mirrored
-	await mkdir(path.join(agentDir, "sessions"), { recursive: true });
-
 	// 1. Clean up dangling or obsolete symlinks in runtimeDir
 	try {
 		const runtimeEntries = await readdir(runtimeDir);
@@ -517,7 +532,13 @@ export async function syncAgentSymlinks(agentDir: string, runtimeDir: string): P
 		}
 	} catch {}
 
-	// 2. Mirror files and directories from agentDir to runtimeDir
+	// 2. Seed the state paths this process's Pi will create at runtime, so their
+	// writes land in the real agent dir instead of an instance-local copy
+	// (ADR-0010). Runs after the cleanup above, which would otherwise remove the
+	// deliberately dangling file links.
+	await seedRuntimeState(agentDir, runtimeDir);
+
+	// 3. Mirror files and directories from agentDir to runtimeDir
 	try {
 		const entries = await readdir(agentDir);
 		for (const name of entries) {
@@ -547,13 +568,45 @@ export async function syncAgentSymlinks(agentDir: string, runtimeDir: string): P
 	} catch {}
 }
 
+/** Ensures the runtime state paths exist (or are linked) in the real agent dir
+ *  and the instance. Best-effort: a failure here leaves the path unseeded, and
+ *  the sweep's unrecognized-entry warning names it later. */
+async function seedRuntimeState(agentDir: string, runtimeDir: string): Promise<void> {
+	for (const name of SEEDED_STATE_DIRS) {
+		try {
+			await mkdir(path.join(agentDir, name), { recursive: true });
+		} catch {
+			// Best-effort: the mirror then simply links nothing for this name.
+		}
+	}
+
+	for (const name of SEEDED_STATE_FILES) {
+		const linkPath = path.join(runtimeDir, name);
+		// A real file here belongs to an earlier run of a different layout, and a
+		// link may already point somewhere else: leave both alone rather than
+		// replacing state pi-profile cannot attribute.
+		if (await existsLexical(linkPath)) continue;
+		try {
+			await symlink(path.join(agentDir, name), linkPath);
+		} catch {
+			// Best-effort: Pi then creates the file inside the instance, and the
+			// sweep keeps that directory instead of deleting it silently.
+		}
+	}
+}
+
 export async function generateRuntimeDir(
 	plan: ActivationPlan,
 	options: GenerateOptions,
 ): Promise<GeneratedRuntime> {
 	const { agentDir } = options;
-	const runtimeDir = path.join(getInstancesRootDir(), plan.profile, "agent");
-	await mkdir(runtimeDir, { recursive: true });
+	const runtimeRoot = getInstancesRootDir();
+	await mkdir(runtimeRoot, { recursive: true });
+	// One instance per launch, never reused: PI_CODING_AGENT_DIR is frozen for
+	// the life of the spawned process, so a stable path cannot follow an
+	// in-session switch, and a shared path would make concurrent launches (and
+	// their switches) rewrite each other's files (ADR-0010).
+	const runtimeDir = await mkdtemp(path.join(runtimeRoot, "launch-"));
 
 	await writeRuntimeFiles(runtimeDir, plan, options);
 

package/src/switching/apply-plan.ts

@@ -48,7 +48,7 @@ export interface LaunchPlanFile {
 		skills: Array<{ name: string; filePath: string }>;
 		extensions: Array<{ id: string; entry: string }>;
 	};
-	/** Glob references that matched nothing at resolution (ADR-0006). */
+	/** Glob references that matched nothing at resolution (ADR-0009). */
 	unmatched?: string[];
 	previousResolved?: {
 		skills: string[];

package/src/switching/status.ts

@@ -36,7 +36,7 @@ export interface StatusReport {
 	mcp: { enabled: string[]; disabled: string[]; missing: string[] };
 	/** Glob delta versus the previous activation (prefixed names). */
 	delta?: { added: string[]; removed: string[] };
-	/** Glob references that matched nothing at resolution (ADR-0006). */
+	/** Glob references that matched nothing at resolution (ADR-0009). */
 	unmatched?: string[];
 	conflicts: StatusConflict[];
 }