Skip to content

enhance debug log #151

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

Open
henryxwong wants to merge 1 commit into
base: main
Choose a base branch
from
+53 −0
Open

enhance debug log #151

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
53 changes: 53 additions & 0 deletions cli/src/engines/base.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,25 @@
import { spawn, spawnSync } from "node:child_process";
import type { AIEngine, AIResult, EngineOptions, ProgressCallback } from "./types.ts";
import { logDebug } from "../ui/logger.js";

// Check if running in Bun
const isBun = typeof Bun !== "undefined";
const isWindows = process.platform === "win32";

/**
* Format command for logging
*/
function formatCommand(command: string, args: string[]): string {
const joinedArgs = args.map((arg) => {
// Quote arguments with spaces or special characters
if (arg.includes(" ") || arg.includes("&") || arg.includes("|")) {
return `"${arg.replace(/"/g, '\\"')}"`;
}
return arg;
});
return `${command} ${joinedArgs.join(" ")}`;
}

/**
* Check if a command is available in PATH
*/
Expand Down Expand Up @@ -38,6 +53,9 @@ export async function execCommand(
env?: Record<string, string>,
stdinContent?: string,
): Promise<{ stdout: string; stderr: string; exitCode: number }> {
// Log the command being executed
logDebug(`$ ${formatCommand(command, args)}`);

Comment on lines +56 to +58
Copy link
Contributor

@greptile-apps greptile-apps bot Feb 11, 2026

Choose a reason for hiding this comment

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

Sensitive data leakage

execCommand/execCommandStreaming now unconditionally logDebug the full command line (and later stdout/stderr). If args/stdout include secrets (API keys, tokens, auth headers, model provider keys, etc.), those will be printed in verbose mode and can end up in CI logs/bug reports. Consider redacting common secret patterns (or only logging the binary name + arg count) before emitting debug logs.

Prompt To Fix With AI 
This is a comment left during a code review.
Path: cli/src/engines/base.ts
Line: 56:58

Comment:
**Sensitive data leakage**

`execCommand`/`execCommandStreaming` now unconditionally `logDebug` the full command line (and later stdout/stderr). If args/stdout include secrets (API keys, tokens, auth headers, model provider keys, etc.), those will be printed in verbose mode and can end up in CI logs/bug reports. Consider redacting common secret patterns (or only logging the binary name + arg count) before emitting debug logs.


How can I resolve this? If you propose a fix, please make it concise.

if (isBun) {
// On Windows, run through cmd.exe to handle .cmd wrappers (npm global packages)
const spawnArgs = isWindows ? ["cmd.exe", "/c", command, ...args] : [command, ...args];
Expand All @@ -61,6 +79,7 @@ export async function execCommand(
proc.exited,
]);

logCommandOutput(stdout, stderr);
return { stdout, stderr, exitCode };
}

Expand Down Expand Up @@ -91,6 +110,7 @@ export async function execCommand(
});

proc.on("close", (exitCode) => {
logCommandOutput(stdout, stderr);
resolve({ stdout, stderr, exitCode: exitCode ?? 1 });
});

Expand Down Expand Up @@ -207,6 +227,35 @@ function isAuthenticationMessage(messageLower: string): boolean {
);
}

/**
* Format and log command output (truncated if too long)
*/
function logCommandOutput(stdout: string, stderr: string): void {
const maxLines = 50;

// Log stdout
if (stdout.trim()) {
const lines = stdout.split("\n");
const displayed = lines.slice(0, maxLines).join("\n");
if (lines.length > maxLines) {
logDebug(`[stdout] ${displayed}\n... (${lines.length - maxLines} more lines)`);
} else {
logDebug(`[stdout] ${displayed}`);
}
}

// Log stderr
if (stderr.trim()) {
const lines = stderr.split("\n");
const displayed = lines.slice(0, maxLines).join("\n");
if (lines.length > maxLines) {
logDebug(`[stderr] ${displayed}\n... (${lines.length - maxLines} more lines)`);
} else {
logDebug(`[stderr] ${displayed}`);
}
}
}

/**
* Format a command failure with useful output context.
* If the output contains an authentication error, returns just that error message.
Expand Down Expand Up @@ -268,6 +317,9 @@ export async function execCommandStreaming(
env?: Record<string, string>,
stdinContent?: string,
): Promise<{ exitCode: number }> {
// Log the command being executed
logDebug(`$ ${formatCommand(command, args)}`);

if (isBun) {
// On Windows, run through cmd.exe to handle .cmd wrappers (npm global packages)
const spawnArgs = isWindows ? ["cmd.exe", "/c", command, ...args] : [command, ...args];
Expand Down Expand Up @@ -333,6 +385,7 @@ export async function execCommandStreaming(
// Process any remaining data
if (stdoutBuffer.trim()) onLine(stdoutBuffer);
if (stderrBuffer.trim()) onLine(stderrBuffer);
logCommandOutput(stdoutBuffer, stderrBuffer);
resolve({ exitCode: exitCode ?? 1 });
});

Expand Down