fix(keybindings): migrate to namespaced ids closes #2391

packages/coding-agent/test/keybindings-migration.test.ts

@@ -0,0 +1,74 @@
+import * as fs from "node:fs";
+import * as os from "node:os";
+import * as path from "node:path";
+import { afterEach, describe, expect, it } from "vitest";
+import { KeybindingsManager, migrateKeybindingsConfigFile } from "../src/core/keybindings.js";
+
+describe("keybindings migration", () => {
+	const tempDirs: string[] = [];
+
+	afterEach(() => {
+		for (const dir of tempDirs.splice(0)) {
+			fs.rmSync(dir, { recursive: true, force: true });
+		}
+	});
+
+	function createAgentDir(config: Record<string, unknown>): string {
+		const agentDir = fs.mkdtempSync(path.join(os.tmpdir(), "pi-keybindings-test-"));
+		tempDirs.push(agentDir);
+		fs.writeFileSync(path.join(agentDir, "keybindings.json"), `${JSON.stringify(config, null, 2)}\n`, "utf-8");
+		return agentDir;
+	}
+
+	it("rewrites old key names to namespaced ids", () => {
+		const agentDir = createAgentDir({
+			cursorUp: ["up", "ctrl+p"],
+			expandTools: "ctrl+x",
+		});
+
+		expect(migrateKeybindingsConfigFile(agentDir)).toBe(true);
+
+		const migrated = JSON.parse(fs.readFileSync(path.join(agentDir, "keybindings.json"), "utf-8")) as Record<
+			string,
+			unknown
+		>;
+		expect(migrated).toEqual({
+			"tui.editor.cursorUp": ["up", "ctrl+p"],
+			"app.tools.expand": "ctrl+x",
+		});
+	});
+
+	it("keeps the namespaced value when old and new names both exist", () => {
+		const agentDir = createAgentDir({
+			expandTools: "ctrl+x",
+			"app.tools.expand": "ctrl+y",
+		});
+
+		expect(migrateKeybindingsConfigFile(agentDir)).toBe(true);
+
+		const migrated = JSON.parse(fs.readFileSync(path.join(agentDir, "keybindings.json"), "utf-8")) as Record<
+			string,
+			unknown
+		>;
+		expect(migrated).toEqual({
+			"app.tools.expand": "ctrl+y",
+		});
+	});
+
+	it("loads old key names in memory before the file is rewritten", () => {
+		const agentDir = createAgentDir({
+			selectConfirm: "enter",
+			interrupt: "ctrl+x",
+		});
+
+		const keybindings = KeybindingsManager.create(agentDir);
+
+		expect(keybindings.getUserBindings()).toEqual({
+			"tui.select.confirm": "enter",
+			"app.interrupt": "ctrl+x",
+		});
+		const effective = keybindings.getEffectiveConfig();
+		expect(effective["tui.select.confirm"]).toBe("enter");
+		expect(effective["app.interrupt"]).toBe("ctrl+x");
+	});
+});