Fix keybindings parse error wrapping behavior

Julius Marminge committed 8 months ago

Commit e52db0b1 parent 71d8f742 files · +38 −5Browse files

Unified · Split

2 files

apps/server/src/keybindings.test.ts +25 −0
apps/server/src/keybindings.ts +13 −5

apps/server/src/keybindings.test.ts+25−0

@@ -171,6 +171,31 @@ describe("server keybindings", () => { · 170 unmodified lines
171	expect(fs.readFileSync(configPath, "utf8")).toBe("{ not-json");	171	expect(fs.readFileSync(configPath, "utf8")).toBe("{ not-json");
172	});	172	});
173		173
		174	it("reports non-array config parse errors without duplicate prefix", () => {
		175	const fakeHome = makeTempDir("t3code-keybindings-non-array-");
		176	const configDir = path.join(fakeHome, ".t3");
		177	fs.mkdirSync(configDir, { recursive: true });
		178	const configPath = path.join(configDir, "keybindings.json");
		179	fs.writeFileSync(configPath, JSON.stringify({ key: "mod+j", command: "terminal.toggle" }), "utf8");
		180	vi.spyOn(os, "homedir").mockReturnValue(fakeHome);
		181
		182	expect(() =>
		183	upsertKeybindingRule(logger, {
		184	key: "mod+shift+r",
		185	command: "script.run-tests.run",
		186	}),
		187	).toThrow(new RegExp(`Unable to parse keybindings config at ${configPath}: expected JSON array`));
		188
		189	expect(() =>
		190	upsertKeybindingRule(logger, {
		191	key: "mod+shift+r",
		192	command: "script.run-tests.run",
		193	}),
		194	).not.toThrow(
		195	new RegExp(`Unable to parse keybindings config at ${configPath}: Unable to parse keybindings config at`),
		196	);
		197	});
		198
174	it("cleans up temp files when atomic keybinding write fails", () => {	199	it("cleans up temp files when atomic keybinding write fails", () => {
175	const fakeHome = makeTempDir("t3code-keybindings-atomic-");	200	const fakeHome = makeTempDir("t3code-keybindings-atomic-");
176	const configDir = path.join(fakeHome, ".t3");	201	const configDir = path.join(fakeHome, ".t3");

apps/server/src/keybindings.ts+13−5

 const KEYBINDINGS_CONFIG_PATH = path.join(".t3", "keybindings.json");
 const MAX_KEYBINDINGS = 256;
+class KeybindingsConfigParseError extends Error {
+  constructor(configPath: string, detail: string, options?: { cause?: unknown }) {
+    super(`Unable to parse keybindings config at ${configPath}: ${detail}`, options);
+  }
+}
 function resolveKeybindingsConfigPath(): string {
   return path.join(os.homedir(), KEYBINDINGS_CONFIG_PATH);
 }
     const parsed = JSON.parse(raw) as unknown;
     if (!Array.isArray(parsed)) {
       if (options?.throwOnUnreadableConfig) {
-        throw new Error(`Unable to parse keybindings config at ${configPath}: expected JSON array`);
+        throw new KeybindingsConfigParseError(configPath, "expected JSON array");
       }
       logger.warn("ignoring keybindings config with unsupported format; expected array", {
         path: configPath,
       return [];
     }
     if (options?.throwOnUnreadableConfig) {
-      throw new Error(
+      if (error instanceof KeybindingsConfigParseError) {
-        `Unable to parse keybindings config at ${configPath}: ${
+        throw error;
-          error instanceof Error ? error.message : String(error)
+      }
-        }`,
+      throw new KeybindingsConfigParseError(
+        configPath,
+        error instanceof Error ? error.message : String(error),
         { cause: error },
       );
     }