Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 7 additions & 2 deletions packages/core/src/background-job.ts
Original file line number Diff line number Diff line change
Expand Up @@ -106,8 +106,13 @@ function snapshot(job: Active): Info {
}

function errorText(error: unknown) {
if (error instanceof Error) return error.message
return String(error)
if (error instanceof Error) {
if (typeof error.message === "string" && error.message.trim()) return error.message
if ("_tag" in error && typeof error._tag === "string" && error._tag.trim()) return error._tag
if (typeof error.name === "string" && error.name.trim()) return error.name
}
const text = String(error)
return text.trim() ? text : "Unknown error"
}

/**
Expand Down
30 changes: 29 additions & 1 deletion packages/core/test/background-job.test.ts
Original file line number Diff line number Diff line change
@@ -1,12 +1,40 @@
import { describe, expect } from "bun:test"
import { BackgroundJob } from "@opencode-ai/core/background-job"
import { LayerNode } from "@opencode-ai/core/effect/layer-node"
import { Deferred, Effect, Exit, Scope } from "effect"
import { Cause, Deferred, Effect, Exit, Schema, Scope } from "effect"
import { it } from "./lib/effect"

const jobsLayer = LayerNode.compile(BackgroundJob.node)

class MessageLessError extends Schema.TaggedErrorClass<MessageLessError>()("MessageLessError", {}) {}

describe("BackgroundJob", () => {
it.live("renders a tag when a failed error has no message", () =>
Effect.gen(function* () {
const jobs = yield* BackgroundJob.Service
const tagged = yield* jobs.start({ type: "test", run: Effect.fail(new MessageLessError()) })
const withMessage = yield* jobs.start({ type: "test", run: Effect.fail(new Error("real message")) })

expect((yield* jobs.wait({ id: tagged.id })).info?.error).toBe("MessageLessError")
expect((yield* jobs.wait({ id: withMessage.id })).info?.error).toBe("real message")
}).pipe(Effect.provide(jobsLayer)),
)

it.live("renders TimeoutError when a timed-out job settles", () =>
Effect.gen(function* () {
const jobs = yield* BackgroundJob.Service
const job = yield* jobs.start({
type: "test",
run: Effect.timeoutOrElse(Effect.never, {
duration: "1 millis",
orElse: () => Effect.fail(new Cause.TimeoutError()),
}),
})

expect((yield* jobs.wait({ id: job.id, timeout: 1_000 })).info?.error).toBe("TimeoutError")
}).pipe(Effect.provide(jobsLayer)),
)

it.live("tracks process-local work through explicit observation", () =>
Effect.gen(function* () {
const jobs = yield* BackgroundJob.Service
Expand Down
4 changes: 2 additions & 2 deletions packages/opencode/src/tool/task.ts
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,7 @@ export const TaskTool = Tool.define(
yield* background.wait({ id: jobID }).pipe(
Effect.flatMap((result) => {
if (result.info?.status === "completed") return inject("completed", result.info.output ?? "")
if (result.info?.status === "error") return inject("error", result.info.error ?? "")
if (result.info?.status === "error") return inject("error", result.info.error || "Task failed")
return Effect.void
}),
Effect.forkIn(scope, { startImmediately: true }),
Expand Down Expand Up @@ -325,7 +325,7 @@ export const TaskTool = Tool.define(
background.waitForPromotion(nextSession.id),
)
if (result?.metadata?.background === true) return backgroundResult()
if (result?.status === "error") return yield* Effect.fail(new Error(result.error ?? "Task failed"))
if (result?.status === "error") return yield* Effect.fail(new Error(result.error || "Task failed"))
if (result?.status === "cancelled") return yield* Effect.fail(new Error("Task cancelled"))
return {
title: params.description,
Expand Down
149 changes: 148 additions & 1 deletion packages/opencode/test/tool/task.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { SessionV1 } from "@opencode-ai/core/v1/session"
import { Database } from "@opencode-ai/core/database/database"
import { LayerNode } from "@opencode-ai/core/effect/layer-node"
import { SessionProjector } from "@opencode-ai/core/session/projector"
import { Deferred, Effect, Exit, Fiber, Layer } from "effect"
import { Cause, Deferred, Effect, Exit, Fiber, Layer } from "effect"
import { Agent } from "../../src/agent/agent"
import { BackgroundJob } from "@/background/job"
import { EventV2Bridge } from "@/event-v2-bridge"
Expand Down Expand Up @@ -778,6 +778,153 @@ describe("tool.task", () => {
}),
)

it.instance("uses a fallback when a foreground task error string is blank", () =>
Effect.gen(function* () {
const { chat, assistant } = yield* seed()
let error = ""
const fakeBackground: BackgroundJob.Interface = {
list: () => Effect.succeed([]),
get: () => Effect.succeed(undefined),
start: (input) =>
Effect.succeed({
id: input.id ?? "task",
type: input.type,
title: input.title,
status: "running",
started_at: 0,
metadata: input.metadata,
}),
extend: () => Effect.succeed(false),
wait: () => Effect.succeed({ timedOut: false, info: { id: "task", type: "task", status: "error", started_at: 0, error } }),
waitForPromotion: () => Effect.never,
promote: () => Effect.succeed(undefined),
cancel: () => Effect.succeed(undefined),
}
const task = yield* TaskTool.pipe(Effect.provideService(BackgroundJob.Service, fakeBackground))
const def = yield* task.init()
const execute = () =>
def.execute(
{
description: "inspect bug",
prompt: "look into the cache key path",
subagent_type: "general",
},
{
sessionID: chat.id,
messageID: assistant.id,
agent: "build",
abort: new AbortController().signal,
extra: { promptOps: stubOps() },
messages: [],
metadata: () => Effect.void,
ask: () => Effect.void,
},
)

const blank = yield* execute().pipe(Effect.exit)
expect(Exit.isFailure(blank)).toBe(true)
if (Exit.isFailure(blank)) {
const failure = Cause.squash(blank.cause)
expect(failure).toBeInstanceOf(Error)
if (failure instanceof Error) expect(failure.message).toBe("Task failed")
}

error = "real task error"
const real = yield* execute().pipe(Effect.exit)
expect(Exit.isFailure(real)).toBe(true)
if (Exit.isFailure(real)) {
const failure = Cause.squash(real.cause)
expect(failure).toBeInstanceOf(Error)
if (failure instanceof Error) expect(failure.message).toBe("real task error")
}
}),
)

background.instance("notifies the parent with a fallback when a background task error is blank", () =>
Effect.gen(function* () {
const { chat, assistant } = yield* seed()
const injected = yield* Deferred.make<SessionPrompt.PromptInput>()
let error = ""
const fakeBackground: BackgroundJob.Interface = {
list: () => Effect.succeed([]),
get: () => Effect.succeed(undefined),
start: (input) =>
Effect.succeed({
id: input.id ?? "task",
type: input.type,
title: input.title,
status: "running",
started_at: 0,
metadata: input.metadata,
}),
extend: () => Effect.succeed(false),
wait: () => Effect.succeed({ timedOut: false, info: { id: "task", type: "task", status: "error", started_at: 0, error } }),
waitForPromotion: () => Effect.never,
promote: () => Effect.succeed(undefined),
cancel: () => Effect.succeed(undefined),
}
const task = yield* TaskTool.pipe(Effect.provideService(BackgroundJob.Service, fakeBackground))
const def = yield* task.init()
const promptOps: TaskPromptOps = {
cancel: () => Effect.void,
resolvePromptParts: (template) => Effect.succeed([{ type: "text" as const, text: template }]),
prompt: (input) => {
if (input.sessionID === chat.id) return Deferred.succeed(injected, input).pipe(Effect.as(reply(input, "injected")))
return Effect.succeed(reply(input, "done"))
},
}
const execute = () =>
def.execute(
{
description: "inspect bug",
prompt: "look into the cache key path",
subagent_type: "general",
background: true,
},
{
sessionID: chat.id,
messageID: assistant.id,
agent: "build",
abort: new AbortController().signal,
extra: { promptOps },
messages: [],
metadata: () => Effect.void,
ask: () => Effect.void,
},
)

yield* execute()
const blank = yield* Deferred.await(injected)
expect(blank.parts[0]?.type).toBe("text")
if (blank.parts[0]?.type === "text") expect(blank.parts[0].text).toContain("Task failed")

error = "real task error"
const injectedReal = yield* Deferred.make<SessionPrompt.PromptInput>()
const realPromptOps = { ...promptOps, prompt: (input: SessionPrompt.PromptInput) => Deferred.succeed(injectedReal, input).pipe(Effect.as(reply(input, "injected"))) }
yield* def.execute(
{
description: "inspect bug",
prompt: "look into the cache key path",
subagent_type: "general",
background: true,
},
{
sessionID: chat.id,
messageID: assistant.id,
agent: "build",
abort: new AbortController().signal,
extra: { promptOps: realPromptOps },
messages: [],
metadata: () => Effect.void,
ask: () => Effect.void,
},
)
const real = yield* Deferred.await(injectedReal)
expect(real.parts[0]?.type).toBe("text")
if (real.parts[0]?.type === "text") expect(real.parts[0].text).toContain("real task error")
}),
)

background.instance("background task completion does not wait for the parent async prompt", () =>
Effect.gen(function* () {
const jobs = yield* BackgroundJob.Service
Expand Down
Loading