313 lines
11 KiB
TypeScript
313 lines
11 KiB
TypeScript
import * as Tool from "./tool"
|
|
import DESCRIPTION from "./task.txt"
|
|
import { ToolJsonSchema } from "./json-schema"
|
|
import { SessionV1 } from "@opencode-ai/core/v1/session"
|
|
import { BackgroundJob } from "@/background/job"
|
|
import { Session } from "@/session/session"
|
|
import { SessionID, MessageID } from "../session/schema"
|
|
import { MessageV2 } from "../session/message-v2"
|
|
import { Agent } from "../agent/agent"
|
|
import { deriveSubagentSessionPermission } from "../agent/subagent-permissions"
|
|
import type { SessionPrompt } from "../session/prompt"
|
|
import { Config } from "@/config/config"
|
|
import { Effect, Exit, Schema, Scope } from "effect"
|
|
import { EffectBridge } from "@/effect/bridge"
|
|
import { RuntimeFlags } from "@/effect/runtime-flags"
|
|
import { Database } from "@opencode-ai/core/database/database"
|
|
|
|
export interface TaskPromptOps {
|
|
cancel(sessionID: SessionID): Effect.Effect<void>
|
|
resolvePromptParts(template: string): Effect.Effect<SessionPrompt.PromptInput["parts"]>
|
|
prompt(input: SessionPrompt.PromptInput): Effect.Effect<SessionV1.WithParts>
|
|
}
|
|
|
|
const id = "task"
|
|
const BACKGROUND_DESCRIPTION = [
|
|
"Background mode: background=true launches the subagent asynchronously and returns immediately.",
|
|
"Foreground is the default; use it when you need the result before continuing.",
|
|
"Use background only for independent work that can run while you continue elsewhere.",
|
|
"You will be notified automatically when it finishes.",
|
|
].join(" ")
|
|
const BACKGROUND_STARTED = [
|
|
"Background task started. You will be notified automatically when it finishes.",
|
|
"Do not poll for progress, ask the task for status, or duplicate its work by investigating the same files or topic yourself.",
|
|
"Continue only with non-overlapping work, or briefly tell the user what you launched and stop.",
|
|
].join("\n")
|
|
const BACKGROUND_UPDATED = [
|
|
"Additional context sent to the running background task.",
|
|
"The task is still running; wait for the automatic completion notification.",
|
|
"Do not poll for progress or duplicate its work.",
|
|
].join("\n")
|
|
|
|
const BaseParameterFields = {
|
|
description: Schema.String.annotate({ description: "A short (3-5 words) description of the task" }),
|
|
prompt: Schema.String.annotate({ description: "The task for the agent to perform" }),
|
|
subagent_type: Schema.String.annotate({ description: "The type of specialized agent to use for this task" }),
|
|
task_id: Schema.optional(Schema.String).annotate({
|
|
description:
|
|
"This should only be set if you mean to resume a previous task (you can pass a prior task_id and the task will continue the same subagent session as before instead of creating a fresh one)",
|
|
}),
|
|
command: Schema.optional(Schema.String).annotate({ description: "The command that triggered this task" }),
|
|
}
|
|
|
|
const BaseParameters = Schema.Struct(BaseParameterFields)
|
|
|
|
export const Parameters = Schema.Struct({
|
|
...BaseParameterFields,
|
|
background: Schema.optional(Schema.Boolean).annotate({
|
|
description: "Run the agent in the background. You will be notified when it completes.",
|
|
}),
|
|
})
|
|
|
|
function renderOutput(input: {
|
|
sessionID: SessionID
|
|
state: "running" | "completed" | "error"
|
|
summary?: string
|
|
text: string
|
|
}) {
|
|
const tag = input.state === "error" ? "task_error" : "task_result"
|
|
return [
|
|
`<task id="${input.sessionID}" state="${input.state}">`,
|
|
...(input.summary ? [`<summary>${input.summary}</summary>`] : []),
|
|
`<${tag}>`,
|
|
input.text,
|
|
`</${tag}>`,
|
|
"</task>",
|
|
].join("\n")
|
|
}
|
|
|
|
export const TaskTool = Tool.define(
|
|
id,
|
|
Effect.gen(function* () {
|
|
const agent = yield* Agent.Service
|
|
const background = yield* BackgroundJob.Service
|
|
const config = yield* Config.Service
|
|
const sessions = yield* Session.Service
|
|
const scope = yield* Scope.Scope
|
|
const flags = yield* RuntimeFlags.Service
|
|
const database = yield* Database.Service
|
|
|
|
const run = Effect.fn("TaskTool.execute")(function* (
|
|
params: Schema.Schema.Type<typeof Parameters>,
|
|
ctx: Tool.Context,
|
|
) {
|
|
const cfg = yield* config.get()
|
|
const runInBackground = params.background === true
|
|
if (runInBackground && !flags.experimentalBackgroundSubagents) {
|
|
return yield* Effect.fail(
|
|
new Error("Background subagents require OPENCODE_EXPERIMENTAL_BACKGROUND_SUBAGENTS=true"),
|
|
)
|
|
}
|
|
|
|
if (!ctx.extra?.bypassAgentCheck) {
|
|
yield* ctx.ask({
|
|
permission: id,
|
|
patterns: [params.subagent_type],
|
|
always: ["*"],
|
|
metadata: {
|
|
description: params.description,
|
|
subagent_type: params.subagent_type,
|
|
},
|
|
})
|
|
}
|
|
|
|
const next = yield* agent.get(params.subagent_type)
|
|
if (!next) {
|
|
return yield* Effect.fail(new Error(`Unknown agent type: ${params.subagent_type} is not a valid agent type`))
|
|
}
|
|
|
|
const session = params.task_id
|
|
? yield* sessions.get(SessionID.make(params.task_id)).pipe(Effect.catchCause(() => Effect.succeed(undefined)))
|
|
: undefined
|
|
const parent = yield* sessions.get(ctx.sessionID)
|
|
const parentAgent = parent.agent
|
|
? yield* agent.get(parent.agent).pipe(Effect.catchCause(() => Effect.succeed(undefined)))
|
|
: undefined
|
|
const nextSession =
|
|
session ??
|
|
(yield* sessions.create({
|
|
parentID: ctx.sessionID,
|
|
title: params.description + ` (@${next.name} subagent)`,
|
|
permission: [
|
|
...deriveSubagentSessionPermission({
|
|
parentSessionPermission: parent.permission ?? [],
|
|
parentAgent,
|
|
subagent: next,
|
|
}),
|
|
...(cfg.experimental?.primary_tools?.map((item) => ({
|
|
pattern: "*",
|
|
action: "allow" as const,
|
|
permission: item,
|
|
})) ?? []),
|
|
],
|
|
}))
|
|
|
|
const msg = yield* MessageV2.get({ sessionID: ctx.sessionID, messageID: ctx.messageID }).pipe(
|
|
Effect.provideService(Database.Service, database),
|
|
Effect.orDie,
|
|
)
|
|
if (msg.info.role !== "assistant") return yield* Effect.fail(new Error("Not an assistant message"))
|
|
const variant = msg.info.variant
|
|
|
|
const model = next.model ?? {
|
|
modelID: msg.info.modelID,
|
|
providerID: msg.info.providerID,
|
|
}
|
|
const metadata = {
|
|
parentSessionId: ctx.sessionID,
|
|
sessionId: nextSession.id,
|
|
model,
|
|
...(runInBackground ? { background: true } : {}),
|
|
}
|
|
|
|
yield* ctx.metadata({
|
|
title: params.description,
|
|
metadata,
|
|
})
|
|
|
|
const ops = ctx.extra?.promptOps as TaskPromptOps
|
|
if (!ops) return yield* Effect.fail(new Error("TaskTool requires promptOps in ctx.extra"))
|
|
|
|
const runTask = Effect.fn("TaskTool.runTask")(function* () {
|
|
const parts = yield* ops.resolvePromptParts(params.prompt)
|
|
const result = yield* ops.prompt({
|
|
messageID: MessageID.ascending(),
|
|
sessionID: nextSession.id,
|
|
model: {
|
|
modelID: model.modelID,
|
|
providerID: model.providerID,
|
|
},
|
|
variant: next.model ? undefined : variant,
|
|
agent: next.name,
|
|
tools: {
|
|
...(next.permission.some((rule) => rule.permission === "todowrite") ? {} : { todowrite: false }),
|
|
...(next.permission.some((rule) => rule.permission === id) ? {} : { task: false }),
|
|
...Object.fromEntries((cfg.experimental?.primary_tools ?? []).map((item) => [item, false])),
|
|
},
|
|
parts,
|
|
})
|
|
return result.parts.findLast((item) => item.type === "text")?.text ?? ""
|
|
})
|
|
|
|
const inject = Effect.fn("TaskTool.injectBackgroundResult")(function* (
|
|
state: "completed" | "error",
|
|
text: string,
|
|
) {
|
|
const currentParent = yield* sessions.get(ctx.sessionID)
|
|
yield* ops
|
|
.prompt({
|
|
sessionID: ctx.sessionID,
|
|
agent: currentParent.agent ?? ctx.agent,
|
|
variant,
|
|
parts: [
|
|
{
|
|
type: "text",
|
|
synthetic: true,
|
|
text: renderOutput({
|
|
sessionID: nextSession.id,
|
|
state,
|
|
summary:
|
|
state === "completed"
|
|
? `Background task completed: ${params.description}`
|
|
: `Background task failed: ${params.description}`,
|
|
text,
|
|
}),
|
|
},
|
|
],
|
|
})
|
|
.pipe(Effect.ignore, Effect.forkIn(scope, { startImmediately: true }))
|
|
})
|
|
|
|
if (yield* background.extend({ id: nextSession.id, run: runTask() })) {
|
|
return {
|
|
title: params.description,
|
|
metadata: {
|
|
...metadata,
|
|
background: true,
|
|
jobId: nextSession.id,
|
|
},
|
|
output: renderOutput({
|
|
sessionID: nextSession.id,
|
|
state: "running",
|
|
summary: "Background task updated",
|
|
text: BACKGROUND_UPDATED,
|
|
}),
|
|
}
|
|
}
|
|
|
|
if (runInBackground) {
|
|
const info = yield* background.start({
|
|
id: nextSession.id,
|
|
type: id,
|
|
title: params.description,
|
|
metadata,
|
|
run: runTask(),
|
|
})
|
|
yield* background.wait({ id: info.id }).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 ?? "")
|
|
return Effect.void
|
|
}),
|
|
Effect.forkIn(scope, { startImmediately: true }),
|
|
)
|
|
|
|
return {
|
|
title: params.description,
|
|
metadata: {
|
|
...metadata,
|
|
jobId: info.id,
|
|
},
|
|
output: renderOutput({
|
|
sessionID: nextSession.id,
|
|
state: "running",
|
|
summary: "Background task started",
|
|
text: BACKGROUND_STARTED,
|
|
}),
|
|
}
|
|
}
|
|
|
|
const runCancel = yield* EffectBridge.make()
|
|
const cancel = ops.cancel(nextSession.id)
|
|
|
|
function onAbort() {
|
|
runCancel.fork(cancel)
|
|
}
|
|
|
|
return yield* Effect.acquireUseRelease(
|
|
Effect.sync(() => {
|
|
ctx.abort.addEventListener("abort", onAbort)
|
|
}),
|
|
() =>
|
|
Effect.gen(function* () {
|
|
const text = yield* runTask()
|
|
return {
|
|
title: params.description,
|
|
metadata,
|
|
output: renderOutput({ sessionID: nextSession.id, state: "completed", text }),
|
|
}
|
|
}),
|
|
(_, exit) =>
|
|
Effect.gen(function* () {
|
|
if (Exit.hasInterrupts(exit)) yield* cancel
|
|
}).pipe(
|
|
Effect.ensuring(
|
|
Effect.sync(() => {
|
|
ctx.abort.removeEventListener("abort", onAbort)
|
|
}),
|
|
),
|
|
),
|
|
)
|
|
})
|
|
|
|
return {
|
|
description: flags.experimentalBackgroundSubagents
|
|
? [DESCRIPTION, BACKGROUND_DESCRIPTION].join("\n\n")
|
|
: DESCRIPTION,
|
|
parameters: Parameters,
|
|
jsonSchema: flags.experimentalBackgroundSubagents ? undefined : ToolJsonSchema.fromSchema(BaseParameters),
|
|
execute: (params: Schema.Schema.Type<typeof Parameters>, ctx: Tool.Context) =>
|
|
run(params, ctx).pipe(Effect.orDie),
|
|
}
|
|
}),
|
|
)
|