Skip to content

Improve action log step summary: 2-line tool previews and nicer agent messages #24558

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pelikhan merged 3 commits into from
Apr 4, 2026
+157 −54
Merged

Improve action log step summary: 2-line tool previews and nicer agent messages #24558

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
188b4a5
feat: improve action log rendering with 2-line tool previews and nice…
Copilot Apr 4, 2026
fc790bb
fix: remove extra blank line before Statistics comment in generateCop…
Copilot Apr 4, 2026
c99c027
refactor: improve formatResultPreview - CRLF handling, efficient scan…
Copilot Apr 4, 2026
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
2 changes: 1 addition & 1 deletion actions/setup/js/log_parser_bootstrap.test.cjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ describe("log_parser_bootstrap.cjs", () => {
(expect(summaryCall).toBeDefined(),
expect(summaryCall[0]).toContain("```"),
expect(summaryCall[0]).toContain("Conversation:"),
expect(summaryCall[0]).toContain("Agent: Hello"),
expect(summaryCall[0]).toContain("◆ Hello"),
expect(summaryCall[0]).toContain("Statistics:"),
expect(summaryCall[0]).toContain(" Turns: 2"),
expect(summaryCall[0]).toContain(" Duration: 5s"),
Expand Down
120 changes: 80 additions & 40 deletions actions/setup/js/log_parser_shared.cjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -994,6 +994,63 @@ function formatToolCallAsDetails(options) {
return `<details>\n<summary>${fullSummary}</summary>\n\n${detailsContent}\n</details>\n\n`;
}

/**
* Formats a tool result content into a preview string showing the first 2 non-empty lines.
* Uses tree-branch characters (├, └) for visual hierarchy in copilot-cli style.
*
* Examples:
* 1 line: " └ result text"
* 2 lines: " ├ line 1\n └ line 2"
* 3+ lines: " ├ line 1\n └ line 2 (+ 1 more)"
*
* @param {string} resultText - The result text to preview
* @param {number} [maxLineLength=80] - Maximum characters per preview line
* @returns {string} Formatted preview string, or empty string if no content
*/
function formatResultPreview(resultText, maxLineLength = 80) {
Copy link
Copy Markdown
Contributor

@github-actions github-actions bot Apr 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice addition of formatResultPreview as a reusable helper! Extracting this into its own function makes it much cleaner than the duplicated inline logic that existed before. The tree-branch characters (├, └) give a nice visual hierarchy consistent with copilot-cli style.

if (!resultText) return "";

// Scan line-by-line to avoid building a full array for large outputs.
// Normalize CRLF by stripping trailing \r from each line.
let firstLine = "";
let secondLine = "";
let nonEmptyLineCount = 0;
let start = 0;

while (start <= resultText.length) {
const newlineIndex = resultText.indexOf("\n", start);
const end = newlineIndex === -1 ? resultText.length : newlineIndex;
// Strip trailing \r to handle Windows CRLF line endings
const rawLine = resultText.substring(start, end).replace(/\r$/, "");

if (rawLine.trim()) {
nonEmptyLineCount += 1;
if (nonEmptyLineCount === 1) {
const truncated = rawLine.substring(0, maxLineLength);
firstLine = rawLine.length > maxLineLength ? truncated + "..." : truncated;
} else if (nonEmptyLineCount === 2) {
const truncated = rawLine.substring(0, maxLineLength);
secondLine = rawLine.length > maxLineLength ? truncated + "..." : truncated;
}
}

if (newlineIndex === -1) {
break;
}
start = newlineIndex + 1;
}

if (nonEmptyLineCount === 0) return "";
if (nonEmptyLineCount === 1) {
return ` └ ${firstLine}`;
}
if (nonEmptyLineCount === 2) {
return ` ├ ${firstLine}\n └ ${secondLine}`;
}

return ` ├ ${firstLine}\n └ ${secondLine} (+ ${nonEmptyLineCount - 2} more)`;
}

/**
* Generates a lightweight plain text summary optimized for raw text rendering.
* This is designed for console output (core.info) instead of markdown step summaries.
Expand Down Expand Up @@ -1065,14 +1122,15 @@ function generatePlainTextSummary(logEntries, options = {}) {
displayText = displayText.substring(0, MAX_AGENT_TEXT_LENGTH) + `... [truncated: showing first ${MAX_AGENT_TEXT_LENGTH} of ${text.length} chars]`;
}

// Split into lines and add Agent prefix
// Split into lines: first line gets "◆ " prefix, continuation lines are indented
const textLines = displayText.split("\n");
for (const line of textLines) {
for (let i = 0; i < textLines.length; i++) {
if (conversationLineCount >= MAX_CONVERSATION_LINES) {
conversationTruncated = true;
break;
}
lines.push(`Agent: ${line}`);
const prefix = i === 0 ? "◆ " : " ";
lines.push(`${prefix}${textLines[i]}`);
conversationLineCount++;
}
lines.push(""); // Add blank line after agent response
Expand Down Expand Up @@ -1100,38 +1158,28 @@ function generatePlainTextSummary(logEntries, options = {}) {
const cmd = formatBashCommand(input.command || "");
displayName = `$ ${cmd}`;

// Show result preview if available
// Show first 2 lines of result using copilot-cli tree-branch style
if (toolResult && toolResult.content) {
const resultText = typeof toolResult.content === "string" ? toolResult.content : String(toolResult.content);
const resultLines = resultText.split("\n").filter(l => l.trim());
if (resultLines.length > 0) {
const previewLine = resultLines[0].substring(0, 80);
if (resultLines.length > 1) {
resultPreview = ` └ ${resultLines.length} lines...`;
} else if (previewLine) {
resultPreview = ` └ ${previewLine}`;
}
}
resultPreview = formatResultPreview(resultText);
}
} else if (toolName.startsWith("mcp__")) {
// Format MCP tool names like github-list_pull_requests
const formattedName = formatMcpName(toolName).replace("::", "-");
displayName = formatToolDisplayName(formattedName, input);

// Show result preview if available
// Show first 2 lines of result using copilot-cli tree-branch style
if (toolResult && toolResult.content) {
const resultText = typeof toolResult.content === "string" ? toolResult.content : JSON.stringify(toolResult.content);
const truncated = resultText.length > 80 ? resultText.substring(0, 80) + "..." : resultText;
resultPreview = ` └ ${truncated}`;
resultPreview = formatResultPreview(resultText);
}
} else {
displayName = formatToolDisplayName(toolName, input);

// Show result preview if available
// Show first 2 lines of result using copilot-cli tree-branch style
if (toolResult && toolResult.content) {
const resultText = typeof toolResult.content === "string" ? toolResult.content : String(toolResult.content);
const truncated = resultText.length > 80 ? resultText.substring(0, 80) + "..." : resultText;
resultPreview = ` └ ${truncated}`;
resultPreview = formatResultPreview(resultText);
}
}

Expand All @@ -1140,7 +1188,7 @@ function generatePlainTextSummary(logEntries, options = {}) {

if (resultPreview) {
lines.push(resultPreview);
conversationLineCount++;
conversationLineCount += resultPreview.split("\n").length;
Copy link
Copy Markdown
Contributor

@github-actions github-actions bot Apr 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The conversationLineCount += resultPreview.split("\n").length fix is correct — previously only 1 line was counted even for multi-line previews, which could cause premature truncation of the conversation log.

}

lines.push(""); // Add blank line after tool execution
Expand Down Expand Up @@ -1279,14 +1327,15 @@ function generateCopilotCliStyleSummary(logEntries, options = {}) {
displayText = displayText.substring(0, MAX_AGENT_TEXT_LENGTH) + `... [truncated: showing first ${MAX_AGENT_TEXT_LENGTH} of ${text.length} chars]`;
}

// Split into lines and add Agent prefix
// Split into lines: first line gets "◆ " prefix, continuation lines are indented
const textLines = displayText.split("\n");
for (const line of textLines) {
for (let i = 0; i < textLines.length; i++) {
if (conversationLineCount >= MAX_CONVERSATION_LINES) {
conversationTruncated = true;
break;
}
lines.push(`Agent: ${line}`);
const prefix = i === 0 ? "◆ " : " ";
lines.push(`${prefix}${textLines[i]}`);
conversationLineCount++;
}
lines.push(""); // Add blank line after agent response
Expand Down Expand Up @@ -1314,38 +1363,28 @@ function generateCopilotCliStyleSummary(logEntries, options = {}) {
const cmd = formatBashCommand(input.command || "");
displayName = `$ ${cmd}`;

// Show result preview if available
// Show first 2 lines of result using copilot-cli tree-branch style
if (toolResult && toolResult.content) {
const resultText = typeof toolResult.content === "string" ? toolResult.content : String(toolResult.content);
const resultLines = resultText.split("\n").filter(l => l.trim());
if (resultLines.length > 0) {
const previewLine = resultLines[0].substring(0, 80);
if (resultLines.length > 1) {
resultPreview = ` └ ${resultLines.length} lines...`;
} else if (previewLine) {
resultPreview = ` └ ${previewLine}`;
}
}
resultPreview = formatResultPreview(resultText);
}
} else if (toolName.startsWith("mcp__")) {
// Format MCP tool names like github-list_pull_requests
const formattedName = formatMcpName(toolName).replace("::", "-");
displayName = formatToolDisplayName(formattedName, input);

// Show result preview if available
// Show first 2 lines of result using copilot-cli tree-branch style
if (toolResult && toolResult.content) {
const resultText = typeof toolResult.content === "string" ? toolResult.content : JSON.stringify(toolResult.content);
const truncated = resultText.length > 80 ? resultText.substring(0, 80) + "..." : resultText;
resultPreview = ` └ ${truncated}`;
resultPreview = formatResultPreview(resultText);
}
} else {
displayName = formatToolDisplayName(toolName, input);

// Show result preview if available
// Show first 2 lines of result using copilot-cli tree-branch style
if (toolResult && toolResult.content) {
const resultText = typeof toolResult.content === "string" ? toolResult.content : String(toolResult.content);
const truncated = resultText.length > 80 ? resultText.substring(0, 80) + "..." : resultText;
resultPreview = ` └ ${truncated}`;
resultPreview = formatResultPreview(resultText);
}
}

Expand All @@ -1354,7 +1393,7 @@ function generateCopilotCliStyleSummary(logEntries, options = {}) {

if (resultPreview) {
lines.push(resultPreview);
conversationLineCount++;
conversationLineCount += resultPreview.split("\n").length;
}

lines.push(""); // Add blank line after tool execution
Expand Down Expand Up @@ -1628,6 +1667,7 @@ module.exports = {
formatToolUse,
parseLogEntries,
formatToolCallAsDetails,
formatResultPreview,
generatePlainTextSummary,
generateCopilotCliStyleSummary,
wrapAgentLogInSection,
Expand Down
89 changes: 76 additions & 13 deletions actions/setup/js/log_parser_shared.test.cjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1742,9 +1742,9 @@ describe("log_parser_shared.cjs", () => {
const result = generatePlainTextSummary(logEntries, { parserName: "Agent" });

expect(result).toContain("Conversation:");
Copy link
Copy Markdown
Contributor

@github-actions github-actions bot Apr 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The updated test expectations correctly reflect the new ◆ prefix for agent messages instead of the old Agent: prefix. Good to see multi-line agent responses are tested here with the (two-space indent) for continuation lines.

expect(result).toContain("Agent: I'll help you with that task.");
expect(result).toContain("◆ I'll help you with that task.");
expect(result).toContain("✓ $ echo hello");
expect(result).toContain("Agent: The command executed successfully!");
expect(result).toContain("◆ The command executed successfully!");
});

it("should truncate long agent responses", async () => {
Expand All @@ -1764,7 +1764,7 @@ describe("log_parser_shared.cjs", () => {

const result = generatePlainTextSummary(logEntries, { parserName: "Agent" });

expect(result).toContain("Agent: " + "a".repeat(2000) + "... [truncated: showing first 2000 of 2100 chars]");
expect(result).toContain("◆ " + "a".repeat(2000) + "... [truncated: showing first 2000 of 2100 chars]");
expect(result).not.toContain("a".repeat(2001));
});

Expand All @@ -1784,9 +1784,9 @@ describe("log_parser_shared.cjs", () => {

const result = generatePlainTextSummary(logEntries, { parserName: "Agent" });

expect(result).toContain("Agent: Line 1");
expect(result).toContain("Agent: Line 2");
expect(result).toContain("Agent: Line 3");
expect(result).toContain("◆ Line 1");
expect(result).toContain(" Line 2");
expect(result).toContain(" Line 3");
});
});

Expand Down Expand Up @@ -1827,11 +1827,12 @@ describe("log_parser_shared.cjs", () => {
expect(result).toContain("Conversation:");

// Check for Agent message
expect(result).toContain("Agent: I'll help you explore the repository structure first.");
expect(result).toContain("◆ I'll help you explore the repository structure first.");

// Check for tool execution with success icon
// Check for tool execution with success icon and first 2 lines of output
expect(result).toContain("✓ $ ls -la");
expect(result).toContain(" └ 3 lines...");
expect(result).toContain(" ├ file1.txt");
expect(result).toContain(" └ file2.txt (+ 1 more)");

// Check for Statistics section
expect(result).toContain("Statistics:");
Expand Down Expand Up @@ -1884,7 +1885,7 @@ describe("log_parser_shared.cjs", () => {

const result = generateCopilotCliStyleSummary(logEntries, { parserName: "Agent" });

expect(result).toContain("Agent: " + "a".repeat(2000) + "... [truncated: showing first 2000 of 2100 chars]");
expect(result).toContain("◆ " + "a".repeat(2000) + "... [truncated: showing first 2000 of 2100 chars]");
});

it("should skip internal file operation tools", async () => {
Expand Down Expand Up @@ -1940,9 +1941,9 @@ describe("log_parser_shared.cjs", () => {

const result = generateCopilotCliStyleSummary(logEntries, { parserName: "Agent" });

expect(result).toContain("Agent: Line 1");
expect(result).toContain("Agent: Line 2");
expect(result).toContain("Agent: Line 3");
expect(result).toContain("◆ Line 1");
expect(result).toContain(" Line 2");
expect(result).toContain(" Line 3");
});

it("should truncate conversation when it exceeds max lines", async () => {
Expand Down Expand Up @@ -1970,6 +1971,68 @@ describe("log_parser_shared.cjs", () => {
});
});

describe("formatResultPreview", () => {
it("should return empty string for empty or falsy input", async () => {
const { formatResultPreview } = await import("./log_parser_shared.cjs");

expect(formatResultPreview("")).toBe("");
expect(formatResultPreview(null)).toBe("");
expect(formatResultPreview(undefined)).toBe("");
expect(formatResultPreview(" \n \n ")).toBe("");
});

it("should format single non-empty line with └", async () => {
const { formatResultPreview } = await import("./log_parser_shared.cjs");

expect(formatResultPreview("hello")).toBe(" └ hello");
expect(formatResultPreview("\nhello\n")).toBe(" └ hello");
});

it("should format exactly two non-empty lines with ├ and └", async () => {
const { formatResultPreview } = await import("./log_parser_shared.cjs");

expect(formatResultPreview("line1\nline2")).toBe(" ├ line1\n └ line2");
});

it("should show (+ N more) for three or more non-empty lines", async () => {
const { formatResultPreview } = await import("./log_parser_shared.cjs");

expect(formatResultPreview("line1\nline2\nline3")).toBe(" ├ line1\n └ line2 (+ 1 more)");
expect(formatResultPreview("line1\nline2\nline3\nline4\nline5")).toBe(" ├ line1\n └ line2 (+ 3 more)");
});

it("should truncate lines exceeding maxLineLength and append ellipsis", async () => {
const { formatResultPreview } = await import("./log_parser_shared.cjs");

const longLine = "a".repeat(100);
const result = formatResultPreview(longLine, 80);
expect(result).toBe(` └ ${"a".repeat(80)}...`);
});

it("should not add ellipsis when line exactly fits maxLineLength", async () => {
const { formatResultPreview } = await import("./log_parser_shared.cjs");

const exactLine = "a".repeat(80);
const result = formatResultPreview(exactLine, 80);
expect(result).toBe(` └ ${"a".repeat(80)}`);
expect(result).not.toContain("...");
});

it("should handle Windows CRLF line endings without trailing \\r", async () => {
const { formatResultPreview } = await import("./log_parser_shared.cjs");

expect(formatResultPreview("line1\r\nline2\r\n")).toBe(" ├ line1\n └ line2");
expect(formatResultPreview("only\r\n")).toBe(" └ only");
});

it("should skip blank lines when counting", async () => {
const { formatResultPreview } = await import("./log_parser_shared.cjs");

expect(formatResultPreview("\n\nfirst\n\nsecond\n\n")).toBe(" ├ first\n └ second");
expect(formatResultPreview("\n\nonly\n\n")).toBe(" └ only");
});
});

describe("formatSafeOutputsPreview", () => {
it("should return empty string for empty content", async () => {
const { formatSafeOutputsPreview } = await import("./log_parser_shared.cjs");
Expand Down