opencode/packages/opencode/src/tool/task.ts at dev · argszero/opencode · GitHub

History

360 lines (333 loc) · 13.2 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

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 = [

"The task is working in the background. You will be notified automatically when it finishes.",

"DO NOT sleep, poll for progress, ask the task for status, or duplicate this task's work — avoid working with the same files or topics it is using.",

"Work on non-overlapping tasks, or briefly tell the user what you launched and end your response.",

].join("\n")

const BACKGROUND_UPDATED = [

"Additional context sent to the running background task.",

"The task is still working in the background. You will be notified automatically when it finishes.",

"DO NOT sleep, poll for progress, ask the task for status, or duplicate this task's work — avoid working with the same files or topics it is using.",

"Work on non-overlapping tasks, or briefly tell the user what you sent and end your response.",

].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. DO NOT sleep, poll, or proactively check on its progress",

}),

})

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"),

)

}

const parent = yield* sessions.get(ctx.sessionID)

let current = parent

let depth = 0

while (current.parentID) {

depth++

current = yield* sessions.get(current.parentID)

}

if (depth >= (cfg.subagent_depth ?? 1)) {

return yield* Effect.fail(

new Error(

`Subagent depth limit reached (${cfg.subagent_depth ?? 1}). Increase "subagent_depth" to allow nested subagents.`,

)

}

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 childPermission = deriveSubagentSessionPermission({

parentSessionPermission: parent.permission ?? [],

subagent: next,

})

const childToolDenies = [

...(next.permission.some((rule) => rule.permission === "todowrite")

? []

: [{ permission: "todowrite" as const, pattern: "*" as const, action: "deny" as const }]),

...(next.permission.some((rule) => rule.permission === id)

? []

: [{ permission: id, pattern: "*" as const, action: "deny" as const }]),

...(cfg.experimental?.primary_tools?.map((permission) => ({

permission,

pattern: "*" as const,

action: "deny" as const,

})) ?? []),

]

const nextSession =

session ??

(yield* sessions.create({

parentID: ctx.sessionID,

title: params.description + ` (@${next.name} subagent)`,

agent: next.name,

permission: [

...childPermission,

...childToolDenies.filter(

(deny) =>

!childPermission.some(

(rule) =>

rule.permission === deny.permission && rule.pattern === deny.pattern && rule.action === deny.action,

}))

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,

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 }))

})

const notify = Effect.fn("TaskTool.notifyBackgroundResult")(function* (jobID: string) {

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 ?? "")

return Effect.void

}),

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,

}),

}

const info = yield* background.start({

id: nextSession.id,

type: id,

title: params.description,

metadata,

onPromote: Effect.all([

ctx.metadata({

title: params.description,

metadata: { ...metadata, background: true, jobId: nextSession.id },

}),

notify(nextSession.id),

]),

run: runTask().pipe(Effect.onInterrupt(() => ops.cancel(nextSession.id))),

})

function backgroundResult() {

return {

title: params.description,

metadata: {

...metadata,

background: true,

jobId: info.id,

output: renderOutput({

sessionID: nextSession.id,

state: "running",

summary: "Background task started",

text: BACKGROUND_STARTED,

}),

}

if (runInBackground) {

yield* notify(info.id)

return backgroundResult()

}

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 result = yield* Effect.raceFirst(

background.wait({ id: nextSession.id }).pipe(Effect.map((waited) => waited.info)),

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 === "cancelled") return yield* Effect.fail(new Error("Task cancelled"))

return {

title: params.description,

metadata,

output: renderOutput({ sessionID: nextSession.id, state: "completed", text: result?.output ?? "" }),

}

}),

(_, exit) =>

Effect.gen(function* () {

if (Exit.hasInterrupts(exit))

yield* Effect.all([cancel, background.cancel(nextSession.id)], { discard: true })

}).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),

}

}),

)

opencode/packages/opencode/src/tool/task.ts at dev · argszero/opencode · GitHub

Expand file tree

Breadcrumbs

task.ts

Latest commit

History

Breadcrumbs

task.ts

File metadata and controls