feat: gate verbose logs behind ZCODE_ACP_DEBUG (quiet by default) #6
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -31,7 +31,7 @@ import { | |
| ProjectionDiffer, | ||
| } from "../translators/index.js"; | ||
| import type { InternalEvent } from "../translators/index.js"; | ||
| import { log, warn } from "../utils.js"; | ||
| import type { PendingTurn, ZcodeAcpServer } from "../server.js"; | ||
| import { dispatchEvent } from "./dispatch.js"; | ||
| import { sendSessionUpdate, sendTextChunk } from "./io.js"; | ||
|
|
@@ -512,7 +512,7 @@ async function preemptInFlightTurn( | |
| const t0 = Date.now(); | ||
| while (server.pendingTurns.has(oldRequestId)) { | ||
| if (Date.now() - t0 > PREEMPT_TIMEOUT_MS) { | ||
| warn(` [preempt] timed out waiting for old turn ${oldRequestId} to exit`); | ||
| return; // best-effort: continue anyway, session/send may fail | ||
| } | ||
| await sleep(200); | ||
|
|
@@ -834,7 +834,7 @@ async function emitModeIfChanged( | |
| }); | ||
| log(`session/prompt: mode changed → ${modes.currentModeId}`); | ||
| } catch (e) { | ||
| warn(`emitModeIfChanged failed: ${e instanceof Error ? e.message : String(e)}`); | ||
| } | ||
| } | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -16,8 +16,7 @@ import type * as acp from "@agentclientprotocol/sdk"; | |
| import { RequestError } from "@agentclientprotocol/sdk"; | ||
| import { applyModelSwitch } from "../config/runtime-model.js"; | ||
| import { emitConfigOptionUpdate } from "../config/options.js"; | ||
| import { CONFIG_DISPATCH, warn } from "../utils.js"; | ||
| import type { ZcodeAcpServer } from "../server.js"; | ||
| import { sendTextChunk } from "./io.js"; | ||
| import { compact, fork, rewind, steer } from "./extensions.js"; | ||
|
|
@@ -120,7 +119,7 @@ export async function handleSlashCommand( | |
| return null; | ||
| } | ||
| } catch (e) { | ||
| warn(` /${cmd} failed: ${e instanceof Error ? e.message : String(e)}`); | ||
| throw e; | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -38,7 +38,7 @@ import { | |
| } from "./handlers/extensions.js"; | ||
| import { sendAvailableCommandsDeferred } from "./handlers/io.js"; | ||
| import { ZcodeAcpServer } from "./server.js"; | ||
| import { AGENT_INFO, SLASH_COMMANDS, log, warn } from "./utils.js"; | ||
|
|
||
| async function main(): Promise<void> { | ||
| // stdout is the outbound channel to the client; stdin is inbound. | ||
|
|
@@ -123,6 +123,6 @@ async function main(): Promise<void> { | |
| } | ||
|
|
||
| main().catch((err) => { | ||
| warn(`fatal: ${err instanceof Error ? (err.stack ?? err.message) : String(err)}`); | ||
| process.exit(1); | ||
| }); | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -12,7 +12,7 @@ | |
| * it when `scheduled` arrives without input. | ||
| */ | ||
|
|
||
| import { log, warn } from "../utils.js"; | ||
| import { | ||
| buildResultContent, | ||
| extractLocations, | ||
|
|
@@ -74,7 +74,7 @@ export class EventTranslator { | |
| this.turnError = (payload["error"] as Record<string, unknown>) ?? {}; | ||
| this.turnResultType = (payload["resultType"] as string) ?? "error"; | ||
| const err = this.turnError; | ||
| warn(` [event] turn.failed (code=${err["code"] ?? err["type"] ?? "?"})`); | ||
| } | ||
| return results; | ||
| } | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -95,9 +95,30 @@ export const CONFIG_DISPATCH: Record<string, { method: string; paramKey: string | |
| }; | ||
|
|
||
| /** | ||
| * Logging. Two levels, both write to stderr (stdout is reserved for the ACP | ||
| * JSON-RPC stream): | ||
| * - `warn(msg)`: always emitted — failures the user can perceive (fatal | ||
| * exit, broken backend pipe, command/permission failures, etc.). | ||
| * - `log(msg)`: verbose diagnostic detail — only emitted when | ||
| * `ZCODE_ACP_DEBUG=1` is set. Default (unset) keeps the log quiet so | ||
| * a stable bridge doesn't spam `Zed.log`. | ||
| * | ||
| * Never use `console.log` — it would corrupt the stdout protocol stream. | ||
| */ | ||
|
|
||
| /** True when the user opted into verbose diagnostics. | ||
| * Read at call time so tests can flip it without re-importing the module. */ | ||
| function isDebug(): boolean { | ||
| return process.env.ZCODE_ACP_DEBUG === "1"; | ||
| } | ||
|
|
||
| /** Verbose diagnostic log. Only emitted when `ZCODE_ACP_DEBUG=1`. */ | ||
| export function log(msg: string): void { | ||
| if (!isDebug()) return; | ||
| process.stderr.write(`[zcode-acp] ${msg}\n`); | ||
| } | ||
|
|
||
| /** Warning — always emitted. For perceivable failures. */ | ||
| export function warn(msg: string): void { | ||
| process.stderr.write(`[zcode-acp] ${msg}\n`); | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| /** | ||
| * Tests for the logging utilities: debug-gated verbose log and warn-always. | ||
| * | ||
| * Default behavior is QUIET: verbose `log()` is suppressed unless | ||
| * `ZCODE_ACP_DEBUG=1` is set; `warn()` always emits (perceivable failures). | ||
| */ | ||
|
|
||
| import { afterEach, beforeEach, describe, it, expect, vi } from "vitest"; | ||
|
|
||
| import { log, warn } from "../src/utils.js"; | ||
|
|
||
| describe("logging", () => { | ||
| const prevDebug = process.env.ZCODE_ACP_DEBUG; | ||
| let spy: ReturnType<typeof vi.spyOn>; | ||
|
|
||
| beforeEach(() => { | ||
| spy = vi.spyOn(process.stderr, "write").mockImplementation(() => true); | ||
| }); | ||
| afterEach(() => { | ||
| spy.mockRestore(); | ||
| if (prevDebug === undefined) delete process.env.ZCODE_ACP_DEBUG; | ||
| else process.env.ZCODE_ACP_DEBUG = prevDebug; | ||
| }); | ||
|
|
||
| it("log() is silenced by default (no ZCODE_ACP_DEBUG)", () => { | ||
| delete process.env.ZCODE_ACP_DEBUG; | ||
| log("should be silenced"); | ||
| expect(spy).not.toHaveBeenCalled(); | ||
| }); | ||
|
|
||
| it("log() writes to stderr with the [zcode-acp] prefix when ZCODE_ACP_DEBUG=1", () => { | ||
| process.env.ZCODE_ACP_DEBUG = "1"; | ||
| log("hello"); | ||
| expect(spy).toHaveBeenCalledTimes(1); | ||
| expect(spy.mock.calls[0]?.[0]).toBe("[zcode-acp] hello\n"); | ||
| }); | ||
|
|
||
| it("warn() always writes, even without ZCODE_ACP_DEBUG", () => { | ||
| delete process.env.ZCODE_ACP_DEBUG; | ||
| warn("visible warning"); | ||
| expect(spy).toHaveBeenCalledTimes(1); | ||
| expect(spy.mock.calls[0]?.[0]).toBe("[zcode-acp] visible warning\n"); | ||
| }); | ||
|
|
||
| it("ZCODE_ACP_DEBUG=0 keeps log() silenced (only '1' enables verbose)", () => { | ||
| process.env.ZCODE_ACP_DEBUG = "0"; | ||
| log("still silenced"); | ||
| expect(spy).not.toHaveBeenCalled(); | ||
| }); | ||
| }); |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
在
README.zh-CN.md中，_（未设置）缺少了结尾的下划线_，导致 Markdown 格式不一致。建议将其修改为_（未设置）_以保持与第 62 行_（自动发现）_一致的斜体格式。