fix(background-task): clarify task id contracts

This commit is contained in:
YeonGyu-Kim
2026-05-15 15:41:30 +09:00
parent 15e7330ff0
commit c25cb8dcef
30 changed files with 238 additions and 79 deletions
+1 -1
View File
@@ -1,4 +1,4 @@
export const BACKGROUND_TASK_DESCRIPTION = `Run agent task in background. Returns task_id immediately; notifies on completion.
export const BACKGROUND_TASK_DESCRIPTION = `Run agent task in background. Returns a background task ID (\`bg_...\`) immediately; notifies on completion.
Use \`background_output\` to get results. Prompts MUST be in English.`
@@ -4,7 +4,9 @@ import type { ToolContext } from "@opencode-ai/plugin/tool"
import { describe, expect, test } from "bun:test"
import type { BackgroundTask } from "../../features/background-agent"
import { clearPendingStore, consumeToolMetadata } from "../../features/tool-metadata-store"
import { unsafeTestValue } from "../../../test-support/unsafe-test-value"
import type { BackgroundOutputClient, BackgroundOutputManager } from "./clients"
import { BACKGROUND_TASK_DESCRIPTION } from "./constants"
import { createBackgroundOutput } from "./create-background-output"
const projectDir = "/Users/yeongyu/local-workspaces/oh-my-opencode"
@@ -14,6 +16,38 @@ type ToolContextWithCallID = ToolContext & {
}
describe("createBackgroundOutput metadata", () => {
test("describes background task launch output as a bg id", () => {
// #given, #when
const description = BACKGROUND_TASK_DESCRIPTION
// #then
expect(description).toContain("background task ID")
expect(description).toContain("bg_")
expect(description).not.toContain("Returns task_id")
})
test("describes task_id as a background task id instead of a session id", () => {
// #given
const manager: BackgroundOutputManager = {
getTask: () => undefined,
}
const client: BackgroundOutputClient = {
session: {
messages: async () => ({ data: [] }),
},
}
const tool = createBackgroundOutput(manager, client)
// #when
const taskIdArg = unsafeTestValue<{ description?: string }>(tool.args.task_id)
// #then
expect(taskIdArg.description).toContain("background task ID")
expect(taskIdArg.description).toContain("bg_")
expect(taskIdArg.description).toContain("not a session ID")
expect(taskIdArg.description).toContain("ses_")
})
test("omits sessionId metadata when task session is not yet assigned", async () => {
// #given
clearPendingStore()
@@ -93,7 +93,9 @@ export function createBackgroundOutput(manager: BackgroundOutputManager, client:
return tool({
description: BACKGROUND_OUTPUT_DESCRIPTION,
args: {
task_id: tool.schema.string().describe("Task ID to get output from"),
task_id: tool.schema
.string()
.describe("background task ID (`bg_...`) from launch/completion; not a session ID (`ses_...`)."),
block: tool.schema
.boolean()
.optional()