oh-my-pi/packages/coding-agent/test/plan-mode/approved-plan.test.ts

import { afterEach, beforeEach, describe, expect, it } from "bun:test";
import * as fs from "node:fs/promises";
import * as os from "node:os";
import * as path from "node:path";
import {
	humanizePlanTitle,
	normalizePlanTitle,
	renameApprovedPlanFile,
	resolvePlanTitle,
} from "@oh-my-pi/pi-coding-agent/plan-mode/approved-plan";

describe("renameApprovedPlanFile", () => {
	let tmpDir: string;
	let artifactsDir: string;

	beforeEach(async () => {
		tmpDir = await fs.mkdtemp(path.join(os.tmpdir(), "approved-plan-"));
		artifactsDir = path.join(tmpDir, "artifacts");
		await fs.mkdir(path.join(artifactsDir, "local"), { recursive: true });
	});

	afterEach(async () => {
		await fs.rm(tmpDir, { recursive: true, force: true });
	});

	function options(planFilePath: string, finalPlanFilePath: string) {
		return {
			planFilePath,
			finalPlanFilePath,
			getArtifactsDir: () => artifactsDir,
			getSessionId: () => "session-z",
		};
	}

	it("fails with actionable error when destination already exists", async () => {
		await Bun.write(path.join(artifactsDir, "local", "PLAN.md"), "draft");
		await Bun.write(path.join(artifactsDir, "local", "WP_MIGRATION_PLAN.md"), "existing");

		await expect(renameApprovedPlanFile(options("local://PLAN.md", "local://WP_MIGRATION_PLAN.md"))).rejects.toThrow(
			"Plan destination already exists at local://WP_MIGRATION_PLAN.md",
		);
	});

	it("renames PLAN.md to titled artifact path", async () => {
		await Bun.write(path.join(artifactsDir, "local", "PLAN.md"), "draft body");

		await renameApprovedPlanFile(options("local://PLAN.md", "local://WP_MIGRATION_PLAN.md"));

		expect(await Bun.file(path.join(artifactsDir, "local", "WP_MIGRATION_PLAN.md")).text()).toBe("draft body");
		await expect(fs.stat(path.join(artifactsDir, "local", "PLAN.md"))).rejects.toThrow();
	});
});

describe("humanizePlanTitle", () => {
	it("replaces separators with spaces and capitalizes", () => {
		expect(humanizePlanTitle("migrate-mcp-loader")).toBe("Migrate mcp loader");
		expect(humanizePlanTitle("fix_session_naming")).toBe("Fix session naming");
		expect(humanizePlanTitle("RefactorRouter")).toBe("RefactorRouter");
	});

	it("collapses runs of separators", () => {
		expect(humanizePlanTitle("foo--bar__baz")).toBe("Foo bar baz");
	});

	it("returns empty string for blank-ish input", () => {
		expect(humanizePlanTitle("")).toBe("");
		expect(humanizePlanTitle("---")).toBe("");
	});
});

describe("normalizePlanTitle", () => {
	it("accepts a clean identifier as-is", () => {
		expect(normalizePlanTitle("my-plan")).toEqual({ title: "my-plan", fileName: "my-plan.md" });
		expect(normalizePlanTitle("feature_branch")).toEqual({ title: "feature_branch", fileName: "feature_branch.md" });
	});

	it("strips a trailing .md suffix provided by the model", () => {
		expect(normalizePlanTitle("my-plan.md")).toEqual({ title: "my-plan", fileName: "my-plan.md" });
	});

	it("converts spaces to hyphens (natural-language titles)", () => {
		expect(normalizePlanTitle("My Improvement Plan")).toEqual({
			title: "My-Improvement-Plan",
			fileName: "My-Improvement-Plan.md",
		});
	});

	it("collapses consecutive spaces / resulting hyphens", () => {
		expect(normalizePlanTitle("foo  bar")).toEqual({ title: "foo-bar", fileName: "foo-bar.md" });
	});

	it("drops characters outside the allowed set after space replacement", () => {
		expect(normalizePlanTitle("plan: v1.0 (draft)")).toEqual({
			title: "plan-v10-draft",
			fileName: "plan-v10-draft.md",
		});
	});

	it("trims leading/trailing hyphens that result from sanitization", () => {
		expect(normalizePlanTitle("!!! plan !!!")).toEqual({ title: "plan", fileName: "plan.md" });
	});

	it("throws for empty title", () => {
		expect(() => normalizePlanTitle("")).toThrow("Plan title is required");
		expect(() => normalizePlanTitle("   ")).toThrow("Plan title is required");
	});

	it("throws for path separators", () => {
		expect(() => normalizePlanTitle("../etc/passwd")).toThrow("path separators");
		expect(() => normalizePlanTitle("a/b")).toThrow("path separators");
	});

	it("throws when sanitization produces empty result", () => {
		expect(() => normalizePlanTitle("!!!")).toThrow("at least one letter");
	});
});

describe("resolvePlanTitle", () => {
	const planContent = "# Code Review: nettools — Updated Issues\n\nbody...\n";
	const planFilePath = "local://PLAN.md";

	it("uses a string `suppliedTitle` when present", () => {
		const result = resolvePlanTitle({ suppliedTitle: "my-plan", planContent, planFilePath });
		expect(result).toEqual({ title: "my-plan", fileName: "my-plan.md", source: "supplied" });
	});

	it("falls back to the plan's first H1 when the model emits a non-string title (issue #1179)", () => {
		const result = resolvePlanTitle({ suppliedTitle: {}, planContent, planFilePath });
		// "Code Review: nettools — Updated Issues" → sanitized
		expect(result.source).toBe("heading");
		expect(result.title).toBe("Code-Review-nettools-Updated-Issues");
		expect(result.fileName).toBe("Code-Review-nettools-Updated-Issues.md");
	});

	it("falls back to the H1 when `suppliedTitle` is missing entirely", () => {
		const result = resolvePlanTitle({ planContent, planFilePath });
		expect(result.source).toBe("heading");
	});

	it("falls back to the H1 when `suppliedTitle` is an empty / whitespace string", () => {
		expect(resolvePlanTitle({ suppliedTitle: "", planContent, planFilePath }).source).toBe("heading");
		expect(resolvePlanTitle({ suppliedTitle: "   ", planContent, planFilePath }).source).toBe("heading");
	});

	it("falls back to the plan filename stem when no usable H1 exists", () => {
		const result = resolvePlanTitle({ planContent: "body only, no heading\n", planFilePath });
		expect(result).toEqual({ title: "PLAN", fileName: "PLAN.md", source: "filename" });
	});

	it("falls back through to the literal `plan` when every candidate sanitizes to empty", () => {
		const result = resolvePlanTitle({
			suppliedTitle: "!!!",
			planContent: "# !!!\n",
			planFilePath: "local://!!!.md",
		});
		expect(result).toEqual({ title: "plan", fileName: "plan.md", source: "default" });
	});

	it("skips a `suppliedTitle` that contains path separators and uses the next candidate", () => {
		const result = resolvePlanTitle({
			suppliedTitle: "../etc/passwd",
			planContent,
			planFilePath,
		});
		expect(result.source).toBe("heading");
	});

	it("picks the first H1 line, not the first heading of any level", () => {
		const result = resolvePlanTitle({
			planContent: "## Subheading first\n\n# Real Title\n",
			planFilePath,
		});
		expect(result.title).toBe("Real-Title");
	});
});