test(plugin): add tests for debug logging when OPENCODER_DEBUG is set

Signed-off-by: leocavalcante <[email protected]>

Author: leocavalcante

tests/plugin.test.ts

@@ -1,4 +1,4 @@
-import { describe, expect, it } from "bun:test"
+import { afterEach, beforeEach, describe, expect, it, spyOn } from "bun:test"
 import type { PluginInput } from "@opencode-ai/plugin"
 import type { Event } from "@opencode-ai/sdk"
 import { OpenCoderPlugin } from "../src/plugin"
@@ -67,3 +67,138 @@ describe("OpenCoderPlugin", () => {
 		await expect(result["tool.execute.after"]?.(input, output)).resolves.toBeUndefined()
 	})
 })
+
+describe("OpenCoderPlugin debug logging", () => {
+	const createMockContext = () =>
+		({
+			project: {},
+			client: {},
+			$: () => {},
+			directory: "/tmp/test-project",
+			worktree: "/tmp/test-project",
+			serverUrl: new URL("http://localhost:3000"),
+		}) as unknown as PluginInput
+
+	let originalDebug: string | undefined
+	let consoleLogSpy: ReturnType<typeof spyOn>
+	let logCalls: unknown[][]
+
+	beforeEach(() => {
+		originalDebug = process.env.OPENCODER_DEBUG
+		logCalls = []
+		consoleLogSpy = spyOn(console, "log").mockImplementation((...args: unknown[]) => {
+			logCalls.push(args)
+		})
+	})
+
+	afterEach(() => {
+		if (originalDebug === undefined) {
+			delete process.env.OPENCODER_DEBUG
+		} else {
+			process.env.OPENCODER_DEBUG = originalDebug
+		}
+		consoleLogSpy.mockRestore()
+	})
+
+	it("should log event when OPENCODER_DEBUG=1", async () => {
+		process.env.OPENCODER_DEBUG = "1"
+		const result = await OpenCoderPlugin(createMockContext())
+
+		const mockEvent: Event = {
+			type: "session.idle",
+			properties: { sessionID: "test-123" },
+		}
+		await result.event?.({ event: mockEvent })
+
+		expect(logCalls.length).toBe(1)
+		const [prefix, message, jsonStr] = logCalls[0] as [string, string, string]
+		expect(prefix).toMatch(/^\[\d{4}-\d{2}-\d{2}T.*\] \[opencoder\]$/)
+		expect(message).toBe("Event received")
+		const parsed = JSON.parse(jsonStr)
+		expect(parsed.type).toBe("session.idle")
+		expect(parsed.properties).toEqual(["sessionID"])
+		expect(parsed.directory).toBe("/tmp/test-project")
+	})
+
+	it("should log tool.execute.before when OPENCODER_DEBUG=1", async () => {
+		process.env.OPENCODER_DEBUG = "1"
+		const result = await OpenCoderPlugin(createMockContext())
+
+		const input = { tool: "bash", sessionID: "test-123", callID: "call-456" }
+		const output = { args: { command: "ls", workdir: "/tmp" } }
+		await result["tool.execute.before"]?.(input, output)
+
+		expect(logCalls.length).toBe(1)
+		const [prefix, message, jsonStr] = logCalls[0] as [string, string, string]
+		expect(prefix).toMatch(/^\[\d{4}-\d{2}-\d{2}T.*\] \[opencoder\]$/)
+		expect(message).toBe("Tool executing")
+		const parsed = JSON.parse(jsonStr)
+		expect(parsed.tool).toBe("bash")
+		expect(parsed.sessionID).toBe("test-123")
+		expect(parsed.callID).toBe("call-456")
+		expect(parsed.argsKeys).toEqual(["command", "workdir"])
+		expect(parsed.directory).toBe("/tmp/test-project")
+	})
+
+	it("should log tool.execute.after when OPENCODER_DEBUG=1", async () => {
+		process.env.OPENCODER_DEBUG = "1"
+		const result = await OpenCoderPlugin(createMockContext())
+
+		const input = { tool: "bash", sessionID: "test-123", callID: "call-456" }
+		const output = { title: "Command executed", output: "file1.txt\nfile2.txt", metadata: {} }
+		await result["tool.execute.after"]?.(input, output)
+
+		expect(logCalls.length).toBe(1)
+		const [prefix, message, jsonStr] = logCalls[0] as [string, string, string]
+		expect(prefix).toMatch(/^\[\d{4}-\d{2}-\d{2}T.*\] \[opencoder\]$/)
+		expect(message).toBe("Tool completed")
+		const parsed = JSON.parse(jsonStr)
+		expect(parsed.tool).toBe("bash")
+		expect(parsed.sessionID).toBe("test-123")
+		expect(parsed.callID).toBe("call-456")
+		expect(parsed.title).toBe("Command executed")
+		expect(parsed.outputLength).toBe(19) // "file1.txt\nfile2.txt".length
+		expect(parsed.directory).toBe("/tmp/test-project")
+	})
+
+	it("should handle tool.execute.after with undefined output", async () => {
+		process.env.OPENCODER_DEBUG = "1"
+		const result = await OpenCoderPlugin(createMockContext())
+
+		const input = { tool: "bash", sessionID: "test-123", callID: "call-456" }
+		// biome-ignore lint/suspicious/noExplicitAny: Testing edge case with undefined output
+		const output = { title: "Command executed", output: undefined, metadata: {} } as any
+		await result["tool.execute.after"]?.(input, output)
+
+		expect(logCalls.length).toBe(1)
+		const [, , jsonStr] = logCalls[0] as [string, string, string]
+		const parsed = JSON.parse(jsonStr)
+		expect(parsed.outputLength).toBe(0)
+	})
+
+	it("should not log when OPENCODER_DEBUG is not set", async () => {
+		delete process.env.OPENCODER_DEBUG
+		const result = await OpenCoderPlugin(createMockContext())
+
+		const mockEvent: Event = {
+			type: "session.idle",
+			properties: { sessionID: "test-123" },
+		}
+		await result.event?.({ event: mockEvent })
+
+		expect(logCalls.length).toBe(0)
+	})
+
+	it("should not log when OPENCODER_DEBUG is set to other values", async () => {
+		process.env.OPENCODER_DEBUG = "true"
+		const result = await OpenCoderPlugin(createMockContext())
+
+		const mockEvent: Event = {
+			type: "session.idle",
+			properties: { sessionID: "test-123" },
+		}
+		await result.event?.({ event: mockEvent })
+
+		expect(logCalls.length).toBe(0)
+	})
+})