From a923596ee7e5b46215acadcf3962a07966a603f1 Mon Sep 17 00:00:00 2001 From: Aiden Cline <63023139+rekram1-node@users.noreply.github.com> Date: Wed, 30 Sep 2026 17:51:36 -0500 Subject: [PATCH] feat(plugin): expose session removal (#52387) --- packages/core/src/plugin/host.ts | 1 + packages/core/test/plugin/host.ts | 1 + .../core/test/plugin/session-remove.test.ts | 61 +++++++++++++++++++ packages/plugin/src/effect/session.ts | 1 + packages/plugin/src/promise/adapter.ts | 1 + packages/plugin/src/promise/session.ts | 1 + .../src/docs/content/build/plugins/effect.mdx | 11 ++++ .../src/docs/content/build/plugins/index.mdx | 7 +++ 8 files changed, 84 insertions(+) create mode 100644 packages/core/test/plugin/session-remove.test.ts diff --git a/packages/core/src/plugin/host.ts b/packages/core/src/plugin/host.ts index 37fe4d80b1b..18eeccaf6bb 100644 --- a/packages/core/src/plugin/host.ts +++ b/packages/core/src/plugin/host.ts @@ -538,6 +538,7 @@ export const make = Effect.fn("PluginHost.make")(function* ( input?.location ?? Location.Ref.make({ directory: location.directory, workspaceID: location.workspaceID }), }), get: (input) => sessions.get(input.sessionID), + remove: (input) => sessions.remove(input.sessionID), switchAgent: sessions.switchAgent, switchModel: sessions.switchModel, prompt: sessions.prompt, diff --git a/packages/core/test/plugin/host.ts b/packages/core/test/plugin/host.ts index 7f9ea715c9a..8778f87e813 100644 --- a/packages/core/test/plugin/host.ts +++ b/packages/core/test/plugin/host.ts @@ -166,6 +166,7 @@ export function host(overrides: Overrides = {}): Plugin.Context { hook: overrides.session?.hook ?? (() => Effect.die("unused session.hook")), create: overrides.session?.create ?? (() => Effect.die("unused session.create")), get: overrides.session?.get ?? (() => Effect.die("unused session.get")), + remove: overrides.session?.remove ?? (() => Effect.die("unused session.remove")), switchAgent: overrides.session?.switchAgent ?? (() => Effect.die("unused session.switchAgent")), switchModel: overrides.session?.switchModel ?? (() => Effect.die("unused session.switchModel")), prompt: overrides.session?.prompt ?? (() => Effect.die("unused session.prompt")), diff --git a/packages/core/test/plugin/session-remove.test.ts b/packages/core/test/plugin/session-remove.test.ts new file mode 100644 index 00000000000..02beb28a826 --- /dev/null +++ b/packages/core/test/plugin/session-remove.test.ts @@ -0,0 +1,61 @@ +import { expect } from "bun:test" +import { Plugin } from "@opencode/core/plugin" +import { PluginHost } from "@opencode/core/plugin/host" +import { PluginPromise } from "@opencode/core/plugin/promise" +import { Session } from "@opencode/core/session" +import { Effect } from "effect" +import { testEffect } from "../lib/effect" +import { PluginTestLayer } from "./fixture" + +const it = testEffect(PluginTestLayer) + +it.live("Effect plugins can remove sessions and their children", () => + Effect.gen(function* () { + const plugins = yield* Plugin.Service + const sessions = yield* Session.Service + const context = yield* PluginHost.make(plugins) + const parent = yield* context.session.create({ title: "Temporary worker" }) + const child = yield* sessions.create({ parentID: parent.id }) + const unrelated = yield* context.session.create({ title: "Unrelated session" }) + + expect(yield* context.session.remove({ sessionID: parent.id })).toBeUndefined() + + expect(yield* sessions.get(parent.id).pipe(Effect.flip)).toMatchObject({ + _tag: "Session.NotFoundError", + sessionID: parent.id, + }) + expect(yield* sessions.get(child.id).pipe(Effect.flip)).toMatchObject({ + _tag: "Session.NotFoundError", + sessionID: child.id, + }) + expect(yield* context.session.get({ sessionID: unrelated.id })).toEqual(unrelated) + expect(yield* context.session.remove({ sessionID: parent.id }).pipe(Effect.flip)).toMatchObject({ + _tag: "Session.NotFoundError", + sessionID: parent.id, + }) + }), +) + +it.live("Promise plugins can remove sessions and their children", () => + Effect.gen(function* () { + const plugins = yield* Plugin.Service + const sessions = yield* Session.Service + const context = yield* PluginHost.make(plugins) + const parent = yield* context.session.create({ title: "Temporary worker" }) + const child = yield* sessions.create({ parentID: parent.id }) + const unrelated = yield* context.session.create({ title: "Unrelated session" }) + + yield* PluginPromise.fromPromise({ + id: "test.session-remove", + async setup(ctx) { + expect(await ctx.session.remove({ sessionID: parent.id })).toBeUndefined() + await expect(ctx.session.get({ sessionID: parent.id })).rejects.toThrow() + await expect(ctx.session.get({ sessionID: child.id })).rejects.toThrow() + expect(await ctx.session.get({ sessionID: unrelated.id })).toMatchObject({ id: unrelated.id }) + await expect(ctx.session.remove({ sessionID: parent.id })).rejects.toThrow() + }, + }).effect(context) + + expect((yield* sessions.list()).data.map((session) => session.id)).toEqual([unrelated.id]) + }), +) diff --git a/packages/plugin/src/effect/session.ts b/packages/plugin/src/effect/session.ts index bea12a93128..c9c73fa84d2 100644 --- a/packages/plugin/src/effect/session.ts +++ b/packages/plugin/src/effect/session.ts @@ -154,6 +154,7 @@ export type SessionDomain = Pick< SessionApi, | "create" | "get" + | "remove" | "switchAgent" | "switchModel" | "prompt" diff --git a/packages/plugin/src/promise/adapter.ts b/packages/plugin/src/promise/adapter.ts index 27b674b4010..c6895e6a65b 100644 --- a/packages/plugin/src/promise/adapter.ts +++ b/packages/plugin/src/promise/adapter.ts @@ -581,6 +581,7 @@ export function fromPromise(plugin: Plugin) { ), create: adaptApiMethod(SessionEndpoints["session.create"], host.session.create), get: adaptApiMethod(SessionEndpoints["session.get"], host.session.get), + remove: adaptApiMethod(SessionEndpoints["session.remove"], host.session.remove), switchAgent: adaptApiMethod(SessionEndpoints["session.switchAgent"], host.session.switchAgent), switchModel: adaptApiMethod(SessionEndpoints["session.switchModel"], host.session.switchModel), prompt: adaptApiMethod(SessionEndpoints["session.prompt"], host.session.prompt), diff --git a/packages/plugin/src/promise/session.ts b/packages/plugin/src/promise/session.ts index ac3aa3888a5..8a9b67b8d06 100644 --- a/packages/plugin/src/promise/session.ts +++ b/packages/plugin/src/promise/session.ts @@ -154,6 +154,7 @@ export type SessionDomain = Pick< SessionApi, | "create" | "get" + | "remove" | "switchAgent" | "switchModel" | "prompt" diff --git a/services/www/src/docs/content/build/plugins/effect.mdx b/services/www/src/docs/content/build/plugins/effect.mdx index e20d15d8320..f2eee19620c 100644 --- a/services/www/src/docs/content/build/plugins/effect.mdx +++ b/services/www/src/docs/content/build/plugins/effect.mdx @@ -821,6 +821,16 @@ effect: (ctx) => }), ``` +Remove a temporary session with `remove`. Removal stops active execution and recursively deletes child sessions. + +```ts +effect: (ctx) => + Effect.gen(function* () { + const created = yield* ctx.session.create({ title: "Temporary worker" }).pipe(Effect.orDie) + yield* ctx.session.remove({ sessionID: created.id }).pipe(Effect.orDie) + }), +``` + Schemas: [`Session.Info`](/api#schema-Session.Info), [`Model.Ref`](/api#schema-Model.Ref), [`Session.Inbox.User`](/api#schema-Session.Inbox.User), [`Session.Inbox.Synthetic`](/api#schema-Session.Inbox.Synthetic). @@ -830,6 +840,7 @@ type SessionDomain = Pick< SessionApi, | "create" | "get" + | "remove" | "switchAgent" | "switchModel" | "prompt" diff --git a/services/www/src/docs/content/build/plugins/index.mdx b/services/www/src/docs/content/build/plugins/index.mdx index fa81169d4bc..f8e1927c604 100644 --- a/services/www/src/docs/content/build/plugins/index.mdx +++ b/services/www/src/docs/content/build/plugins/index.mdx @@ -774,6 +774,12 @@ await ctx.session.interrupt({ sessionID, continue: false }) await ctx.session.wait({ sessionID }) ``` +Remove a temporary session with `remove`. Removal stops active execution and recursively deletes child sessions. + +```ts +await ctx.session.remove({ sessionID }) +``` + #### Reference Schemas: [`Session.Info`](/api#schema-Session.Info), [`Model.Ref`](/api#schema-Model.Ref), @@ -783,6 +789,7 @@ Schemas: [`Session.Info`](/api#schema-Session.Info), [`Model.Ref`](/api#schema-M interface SessionContext { create(input?: SessionCreateInput, requestOptions?: RequestOptions): Promise get(input: SessionGetInput, requestOptions?: RequestOptions): Promise + remove(input: SessionRemoveInput, requestOptions?: RequestOptions): Promise context(input: SessionContextInput, requestOptions?: RequestOptions): Promise switchAgent(input: SessionSwitchAgentInput, requestOptions?: RequestOptions): Promise switchModel(input: SessionSwitchModelInput, requestOptions?: RequestOptions): Promise