fix(background-agent): pass query directory to session.get in 4 call-sites (#2937)

resolveSubagentSpawnContext and related lookups called client.session.get
without the query.directory parameter, causing project-scoped sessions
to 404 under newer OpenCode SDK versions. Threaded directory through
SpawnerContext/BackgroundManager so all four call-sites pass it.

🤖 Generated with OhMyOpenCode assistance
https://github.com/code-yeongyu/oh-my-opencode
This commit is contained in:
YeonGyu-Kim
2026-04-12 02:30:01 +09:00
parent d8b9bf1aad
commit 3bfa3bd608
9 changed files with 192 additions and 22 deletions
@@ -6,6 +6,48 @@ import type { PluginInput } from "@opencode-ai/plugin"
import { BackgroundManager } from "./manager" import { BackgroundManager } from "./manager"
describe("BackgroundManager session permission", () => { describe("BackgroundManager session permission", () => {
test("passes query directory when loading the parent session", async () => {
// given
const getCalls: Array<Record<string, unknown>> = []
const client = {
session: {
get: async (input: Record<string, unknown>) => {
getCalls.push(input)
return { data: { directory: "/parent" } }
},
create: async () => ({ data: { id: "ses_child" } }),
promptAsync: async () => ({}),
abort: async () => ({}),
},
}
const directory = tmpdir()
const manager = new BackgroundManager({ client, directory } as unknown as PluginInput)
// when
await manager.launch({
description: "Test task",
prompt: "Do something",
agent: "explore",
parentSessionID: "ses_parent",
parentMessageID: "msg_parent",
})
await new Promise((resolve) => setTimeout(resolve, 50))
manager.shutdown()
// then
expect(getCalls).toHaveLength(2)
expect(getCalls).toEqual([
{
path: { id: "ses_parent" },
query: { directory },
},
{
path: { id: "ses_parent" },
query: { directory },
},
])
})
test("passes explicit session permission rules to child session creation", async () => { test("passes explicit session permission rules to child session creation", async () => {
// given // given
const createCalls: Array<Record<string, unknown>> = [] const createCalls: Array<Record<string, unknown>> = []
+6 -3
View File
@@ -207,7 +207,7 @@ export class BackgroundManager {
} }
async assertCanSpawn(parentSessionID: string): Promise<SubagentSpawnContext> { async assertCanSpawn(parentSessionID: string): Promise<SubagentSpawnContext> {
const spawnContext = await resolveSubagentSpawnContext(this.client, parentSessionID) const spawnContext = await resolveSubagentSpawnContext(this.client, parentSessionID, this.directory)
const maxDepth = getMaxSubagentDepth(this.config) const maxDepth = getMaxSubagentDepth(this.config)
if (spawnContext.childDepth > maxDepth) { if (spawnContext.childDepth > maxDepth) {
throw createSubagentDepthLimitError({ throw createSubagentDepthLimitError({
@@ -453,6 +453,7 @@ export class BackgroundManager {
const parentSession = await this.client.session.get({ const parentSession = await this.client.session.get({
path: { id: input.parentSessionID }, path: { id: input.parentSessionID },
query: { directory: this.directory },
}).catch((err) => { }).catch((err) => {
log(`[background-agent] Failed to get parent session: ${err}`) log(`[background-agent] Failed to get parent session: ${err}`)
return null return null
@@ -1060,7 +1061,8 @@ export class BackgroundManager {
task.progress.toolCalls += 1 task.progress.toolCalls += 1
task.progress.lastTool = partInfo.tool task.progress.lastTool = partInfo.tool
const circuitBreaker = this.cachedCircuitBreakerSettings ?? (this.cachedCircuitBreakerSettings = resolveCircuitBreakerSettings(this.config)) const circuitBreaker = this.cachedCircuitBreakerSettings ?? resolveCircuitBreakerSettings(this.config)
this.cachedCircuitBreakerSettings = circuitBreaker
if (partInfo.tool) { if (partInfo.tool) {
task.progress.toolCallWindow = recordToolCall( task.progress.toolCallWindow = recordToolCall(
task.progress.toolCallWindow, task.progress.toolCallWindow,
@@ -1947,6 +1949,7 @@ export class BackgroundManager {
await checkAndInterruptStaleTasks({ await checkAndInterruptStaleTasks({
tasks: this.tasks.values(), tasks: this.tasks.values(),
client: this.client, client: this.client,
directory: this.directory,
config: this.config, config: this.config,
concurrencyManager: this.concurrencyManager, concurrencyManager: this.concurrencyManager,
notifyParentSession: (task) => this.enqueueNotificationForParent(task.parentSessionID, () => this.notifyParentSession(task)), notifyParentSession: (task) => this.enqueueNotificationForParent(task.parentSessionID, () => this.notifyParentSession(task)),
@@ -1955,7 +1958,7 @@ export class BackgroundManager {
} }
private async verifySessionExists(sessionID: string): Promise<boolean> { private async verifySessionExists(sessionID: string): Promise<boolean> {
return verifySessionStillExists(this.client, sessionID) return verifySessionStillExists(this.client, sessionID, this.directory)
} }
private async failCrashedTask(task: BackgroundTask, errorMessage: string): Promise<void> { private async failCrashedTask(task: BackgroundTask, errorMessage: string): Promise<void> {
@@ -0,0 +1,26 @@
import { describe, expect, mock, test } from "bun:test"
import type { OpencodeClient } from "./opencode-client"
import { verifySessionExists } from "./session-existence"
describe("verifySessionExists", () => {
test("passes query directory to session lookup when provided", async () => {
// given
const get = mock(async () => ({ data: { id: "session-123" } }))
const client = {
session: {
get,
},
} as unknown as OpencodeClient
// when
const result = await verifySessionExists(client, "session-123", "/project/root")
// then
expect(result).toBe(true)
expect(get).toHaveBeenCalledWith({
path: { id: "session-123" },
query: { directory: "/project/root" },
})
})
})
@@ -35,9 +35,16 @@ function isSessionNotFoundError(error: unknown): boolean {
return message.includes("not found") || message.includes("missing") return message.includes("not found") || message.includes("missing")
} }
export async function verifySessionExists(client: OpencodeClient, sessionID: string): Promise<boolean> { export async function verifySessionExists(
client: OpencodeClient,
sessionID: string,
directory?: string
): Promise<boolean> {
try { try {
const response = await client.session.get({ path: { id: sessionID } }) const response = await client.session.get({
path: { id: sessionID },
...(directory ? { query: { directory } } : {}),
})
if (response.error !== undefined && response.error !== null) { if (response.error !== undefined && response.error !== null) {
return !isSessionNotFoundError(response.error) return !isSessionNotFoundError(response.error)
@@ -467,6 +467,62 @@ describe("background-agent spawner fallback model promotion", () => {
expect(promptCalls[0]?.body?.variant).toBe("medium") expect(promptCalls[0]?.body?.variant).toBe("medium")
}) })
test("passes query.directory when loading the parent session", async () => {
// given
const getCalls: Array<Record<string, unknown>> = []
const client = {
session: {
get: async (input: Record<string, unknown>) => {
getCalls.push(input)
return { data: { directory: "/parent/dir" } }
},
create: async () => ({ data: { id: "ses_child_query" } }),
promptAsync: async () => ({}),
},
}
const task = createTask({
description: "Test task",
prompt: "Do work",
agent: "sisyphus-junior",
parentSessionID: "ses_parent",
parentMessageID: "msg_parent",
})
const item = {
task,
input: {
description: task.description,
prompt: task.prompt,
agent: task.agent,
parentSessionID: task.parentSessionID,
parentMessageID: task.parentMessageID,
parentModel: task.parentModel,
parentAgent: task.parentAgent,
model: task.model,
},
}
// when
await startTask(item as never, {
client: client as never,
directory: "/fallback",
concurrencyManager: { release: () => {} } as never,
tmuxEnabled: false,
onTaskError: () => {},
})
await new Promise((resolve) => setTimeout(resolve, 0))
// then
expect(getCalls).toEqual([
{
path: { id: "ses_parent" },
query: { directory: "/fallback" },
},
])
})
test("strips leading zwsp from prompt body agent before promptAsync", async () => { test("strips leading zwsp from prompt body agent before promptAsync", async () => {
//#given //#given
const promptCalls: Array<{ body?: { agent?: string } }> = [] const promptCalls: Array<{ body?: { agent?: string } }> = []
+1
View File
@@ -86,6 +86,7 @@ export async function startTask(
const parentSession = await client.session.get({ const parentSession = await client.session.get({
path: { id: input.parentSessionID }, path: { id: input.parentSessionID },
query: { directory },
}).catch((err) => { }).catch((err) => {
log(`[background-agent] Failed to get parent session: ${err}`) log(`[background-agent] Failed to get parent session: ${err}`)
return null return null
@@ -19,13 +19,44 @@ function createMockClient(sessionGet: OpencodeClient["session"]["get"]): Opencod
} }
describe("resolveSubagentSpawnContext", () => { describe("resolveSubagentSpawnContext", () => {
describe("#given a directory-scoped session lookup", () => {
test("passes query.directory to each session.get call", async () => {
// given
const sessionGetCalls: Array<Record<string, unknown>> = []
const client = createMockClient((async (input) => {
sessionGetCalls.push(input as Record<string, unknown>)
if (input.path.id === "child-session") {
return { data: { id: "child-session", parentID: "root-session" } }
}
return { data: { id: "root-session", parentID: undefined } }
}) as unknown as OpencodeClient["session"]["get"])
// when
const result = await resolveSubagentSpawnContext(client, "child-session", "/project/root")
// then
expect(result.rootSessionID).toBe("root-session")
expect(sessionGetCalls).toEqual([
{
path: { id: "child-session" },
query: { directory: "/project/root" },
},
{
path: { id: "root-session" },
query: { directory: "/project/root" },
},
])
})
})
describe("#given session.get returns an SDK error response", () => { describe("#given session.get returns an SDK error response", () => {
test("throws a fail-closed spawn blocked error", async () => { test("throws a fail-closed spawn blocked error", async () => {
// given // given
const client = createMockClient(async () => ({ const client = createMockClient((async () => ({
error: "lookup failed", error: "lookup failed",
data: undefined, data: undefined,
})) })) as unknown as OpencodeClient["session"]["get"])
// when // when
const result = resolveSubagentSpawnContext(client, "parent-session") const result = resolveSubagentSpawnContext(client, "parent-session")
@@ -38,9 +69,9 @@ describe("resolveSubagentSpawnContext", () => {
describe("#given session.get returns no session data", () => { describe("#given session.get returns no session data", () => {
test("throws a fail-closed spawn blocked error", async () => { test("throws a fail-closed spawn blocked error", async () => {
// given // given
const client = createMockClient(async () => ({ const client = createMockClient((async () => ({
data: undefined, data: undefined,
})) })) as unknown as OpencodeClient["session"]["get"])
// when // when
const result = resolveSubagentSpawnContext(client, "parent-session") const result = resolveSubagentSpawnContext(client, "parent-session")
@@ -53,12 +84,12 @@ describe("resolveSubagentSpawnContext", () => {
describe("depth calculation smoke tests (regression guard)", () => { describe("depth calculation smoke tests (regression guard)", () => {
test("root session (no parentID) reports depth 0 and childDepth 1", async () => { test("root session (no parentID) reports depth 0 and childDepth 1", async () => {
// given - a root session with no parent // given - a root session with no parent
const client = createMockClient(async (opts) => { const client = createMockClient((async (opts) => {
if (opts.path.id === "root-session") { if (opts.path.id === "root-session") {
return { data: { id: "root-session", parentID: undefined } } return { data: { id: "root-session", parentID: undefined } }
} }
return { error: "not found", data: undefined } return { error: "not found", data: undefined }
}) }) as unknown as OpencodeClient["session"]["get"])
// when // when
const result = await resolveSubagentSpawnContext(client, "root-session") const result = await resolveSubagentSpawnContext(client, "root-session")
@@ -71,7 +102,7 @@ describe("resolveSubagentSpawnContext", () => {
test("depth-1 child reports childDepth 2", async () => { test("depth-1 child reports childDepth 2", async () => {
// given - child -> root chain // given - child -> root chain
const client = createMockClient(async (opts) => { const client = createMockClient((async (opts) => {
if (opts.path.id === "child-1") { if (opts.path.id === "child-1") {
return { data: { id: "child-1", parentID: "root-session" } } return { data: { id: "child-1", parentID: "root-session" } }
} }
@@ -79,7 +110,7 @@ describe("resolveSubagentSpawnContext", () => {
return { data: { id: "root-session", parentID: undefined } } return { data: { id: "root-session", parentID: undefined } }
} }
return { error: "not found", data: undefined } return { error: "not found", data: undefined }
}) }) as unknown as OpencodeClient["session"]["get"])
// when // when
const result = await resolveSubagentSpawnContext(client, "child-1") const result = await resolveSubagentSpawnContext(client, "child-1")
@@ -92,7 +123,7 @@ describe("resolveSubagentSpawnContext", () => {
test("depth-2 grandchild reports childDepth 3", async () => { test("depth-2 grandchild reports childDepth 3", async () => {
// given - grandchild -> child -> root chain // given - grandchild -> child -> root chain
const client = createMockClient(async (opts) => { const client = createMockClient((async (opts) => {
const sessions: Record<string, { id: string; parentID?: string }> = { const sessions: Record<string, { id: string; parentID?: string }> = {
"grandchild": { id: "grandchild", parentID: "child" }, "grandchild": { id: "grandchild", parentID: "child" },
"child": { id: "child", parentID: "root" }, "child": { id: "child", parentID: "root" },
@@ -101,7 +132,7 @@ describe("resolveSubagentSpawnContext", () => {
const session = sessions[opts.path.id] const session = sessions[opts.path.id]
if (session) return { data: session } if (session) return { data: session }
return { error: "not found", data: undefined } return { error: "not found", data: undefined }
}) }) as unknown as OpencodeClient["session"]["get"])
// when // when
const result = await resolveSubagentSpawnContext(client, "grandchild") const result = await resolveSubagentSpawnContext(client, "grandchild")
@@ -125,11 +156,11 @@ describe("resolveSubagentSpawnContext", () => {
} }
} }
const client = createMockClient(async (opts) => { const client = createMockClient((async (opts) => {
const session = sessions[opts.path.id] const session = sessions[opts.path.id]
if (session) return { data: session } if (session) return { data: session }
return { error: "not found", data: undefined } return { error: "not found", data: undefined }
}) }) as unknown as OpencodeClient["session"]["get"])
// when - resolve from the deepest session // when - resolve from the deepest session
const deepest = `session-${DEFAULT_MAX_SUBAGENT_DEPTH}` const deepest = `session-${DEFAULT_MAX_SUBAGENT_DEPTH}`
@@ -142,7 +173,7 @@ describe("resolveSubagentSpawnContext", () => {
test("detects parent cycle and throws", async () => { test("detects parent cycle and throws", async () => {
// given - A -> B -> A (cycle) // given - A -> B -> A (cycle)
const client = createMockClient(async (opts) => { const client = createMockClient((async (opts) => {
const sessions: Record<string, { id: string; parentID?: string }> = { const sessions: Record<string, { id: string; parentID?: string }> = {
"session-a": { id: "session-a", parentID: "session-b" }, "session-a": { id: "session-a", parentID: "session-b" },
"session-b": { id: "session-b", parentID: "session-a" }, "session-b": { id: "session-b", parentID: "session-a" },
@@ -150,7 +181,7 @@ describe("resolveSubagentSpawnContext", () => {
const session = sessions[opts.path.id] const session = sessions[opts.path.id]
if (session) return { data: session } if (session) return { data: session }
return { error: "not found", data: undefined } return { error: "not found", data: undefined }
}) }) as unknown as OpencodeClient["session"]["get"])
// when // when
const result = resolveSubagentSpawnContext(client, "session-a") const result = resolveSubagentSpawnContext(client, "session-a")
@@ -20,7 +20,8 @@ export function getMaxRootSessionSpawnBudget(config?: BackgroundTaskConfig): num
export async function resolveSubagentSpawnContext( export async function resolveSubagentSpawnContext(
client: OpencodeClient, client: OpencodeClient,
parentSessionID: string parentSessionID: string,
directory?: string
): Promise<SubagentSpawnContext> { ): Promise<SubagentSpawnContext> {
const visitedSessionIDs = new Set<string>() const visitedSessionIDs = new Set<string>()
let rootSessionID = parentSessionID let rootSessionID = parentSessionID
@@ -38,6 +39,7 @@ export async function resolveSubagentSpawnContext(
try { try {
const response = await client.session.get({ const response = await client.session.get({
path: { id: currentSessionID }, path: { id: currentSessionID },
...(directory ? { query: { directory } } : {}),
}) })
if (response.error) { if (response.error) {
throw new Error(String(response.error)) throw new Error(String(response.error))
+4 -2
View File
@@ -103,6 +103,7 @@ export type SessionStatusMap = Record<string, { type: string }>
export async function checkAndInterruptStaleTasks(args: { export async function checkAndInterruptStaleTasks(args: {
tasks: Iterable<BackgroundTask> tasks: Iterable<BackgroundTask>
client: OpencodeClient client: OpencodeClient
directory?: string
config: BackgroundTaskConfig | undefined config: BackgroundTaskConfig | undefined
concurrencyManager: ConcurrencyManager concurrencyManager: ConcurrencyManager
notifyParentSession: (task: BackgroundTask) => Promise<void> notifyParentSession: (task: BackgroundTask) => Promise<void>
@@ -112,6 +113,7 @@ export async function checkAndInterruptStaleTasks(args: {
const { const {
tasks, tasks,
client, client,
directory,
config, config,
concurrencyManager, concurrencyManager,
notifyParentSession, notifyParentSession,
@@ -151,7 +153,7 @@ export async function checkAndInterruptStaleTasks(args: {
const effectiveTimeout = sessionGone ? sessionGoneTimeoutMs : messageStalenessMs const effectiveTimeout = sessionGone ? sessionGoneTimeoutMs : messageStalenessMs
if (runtime <= effectiveTimeout) continue if (runtime <= effectiveTimeout) continue
if (sessionGone && await verifySessionExists(client, sessionID)) { if (sessionGone && await verifySessionExists(client, sessionID, directory)) {
task.consecutiveMissedPolls = 0 task.consecutiveMissedPolls = 0
continue continue
} }
@@ -189,7 +191,7 @@ export async function checkAndInterruptStaleTasks(args: {
if (timeSinceLastUpdate <= effectiveStaleTimeout) continue if (timeSinceLastUpdate <= effectiveStaleTimeout) continue
if (task.status !== "running") continue if (task.status !== "running") continue
if (sessionGone && await verifySessionExists(client, sessionID)) { if (sessionGone && await verifySessionExists(client, sessionID, directory)) {
task.consecutiveMissedPolls = 0 task.consecutiveMissedPolls = 0
continue continue
} }