Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions extensions/git-read/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,14 @@ function displayRevision(value: string | undefined, fallback = "HEAD") {
return value === undefined || value.trim() === "" ? fallback : value.trim();
}

function renderCallLine(text: string) {
return new Text(
sanitizeTerminalText(text).replace(/\s+/gu, " ").trim(),
0,
0,
);
}

export default function gitReadTools(pi: ExtensionAPI) {
const resultDirectories = new Set<string>();
const rememberOutput = (outcome: GitOutcome) => {
Expand Down Expand Up @@ -202,7 +210,7 @@ export default function gitReadTools(pi: ExtensionAPI) {
},

renderCall(args) {
return new Text(`git show ${displayRevision(args.revision)}`, 0, 0);
return renderCallLine(`git show ${displayRevision(args.revision)}`);
},

renderResult(result, { expanded }, theme) {
Expand Down Expand Up @@ -247,7 +255,7 @@ export default function gitReadTools(pi: ExtensionAPI) {
let text = `git diff ${from} → ${to}`;
if (args.stat) text += " (stat)";
if (args.path) text += ` ${args.path}`;
return new Text(text, 0, 0);
return renderCallLine(text);
},

renderResult(result, { expanded }, theme) {
Expand Down Expand Up @@ -287,7 +295,7 @@ export default function gitReadTools(pi: ExtensionAPI) {
let text = `git log ${displayRevision(args.revision)}`;
if (args.file) text += ` -- ${args.file}`;
if (args.limit !== undefined) text += ` -n ${args.limit}`;
return new Text(text, 0, 0);
return renderCallLine(text);
},

renderResult(result, { expanded }, theme) {
Expand Down
95 changes: 95 additions & 0 deletions tests/extensions/git-read/call-rendering.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
import assert from "node:assert/strict";
import test from "node:test";
import { stripVTControlCharacters } from "node:util";
import {
initTheme,
ToolExecutionComponent,
type ExtensionAPI,
type ExtensionContext,
type ToolDefinition,
} from "@earendil-works/pi-coding-agent";
import type { TUI } from "@earendil-works/pi-tui";
import gitRead from "../../../extensions/git-read/index.ts";

initTheme("dark", false);

const tools: ToolDefinition[] = [];
gitRead({
on() {},
registerTool(tool: ToolDefinition) {
tools.push(tool);
},
} as unknown as ExtensionAPI);

const titleControl = "\u001b]0;openpi-test-title\u0007";
const unsafe = `${titleControl}\u001b[2J\u202espoof\u202c\nnext`;

function render(tool: ToolDefinition, args: Record<string, unknown>) {
const component = new ToolExecutionComponent(
tool.name,
`call-${tool.name}`,
args,
{ showImages: false },
tool,
{ requestRender() {} } as TUI,
process.cwd(),
);
return component.render(160).join("\n");
}

for (const [name, fields] of [
["git_show", ["revision"]],
["git_diff", ["from", "to", "path"]],
["git_log", ["revision", "file"]],
] as const) {
const tool = tools.find((candidate) => candidate.name === name)!;
for (const field of fields) {
test(`${name} ${field} is terminal-safe before argument validation`, async () => {
const args = { [field]: `HEAD${unsafe}` };
const before = structuredClone(args);
const rendered = render(tool, args);
assert.equal(rendered.includes(titleControl), false);
assert.equal(rendered.includes("\u001b[2J"), false);
assert.equal(rendered.includes("\u202e"), false);
assert.equal(rendered.includes("\u202c"), false);
const visible = stripVTControlCharacters(rendered);
assert.match(visible, /HEADspoof next/);
assert.doesNotMatch(visible, /openpi-test-title/);
assert.deepEqual(args, before);
await assert.rejects(
tool.execute("invalid-call", args, undefined, undefined, {
cwd: process.cwd(),
} as ExtensionContext),
/Invalid git revision|Invalid repository path/,
);
assert.deepEqual(
args,
before,
"display must not clean executable arguments",
);
});
}
}

test("normal git call labels keep revisions, options, and Unicode paths", () => {
const fixtures: [string, Record<string, unknown>, string][] = [
["git_show", { revision: " HEAD~1 " }, "git show HEAD~1"],
["git_show", {}, "git show HEAD"],
["git_diff", {}, "git diff index → worktree"],
["git_diff", { staged: true }, "git diff HEAD (staged) → worktree"],
[
"git_diff",
{ from: "main", to: "feature", stat: true, path: "文档/👩‍💻.md" },
"git diff main → feature (stat) 文档/👩‍💻.md",
],
[
"git_log",
{ revision: "main", file: "文档/👩‍💻.md", limit: 5 },
"git log main -- 文档/👩‍💻.md -n 5",
],
];
for (const [name, args, expected] of fixtures) {
const tool = tools.find((candidate) => candidate.name === name)!;
assert.equal(stripVTControlCharacters(render(tool, args)).trim(), expected);
}
});
Loading