session-generate.test.ts 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335
  1. import { expect } from "bun:test"
  2. import { LLMClient, LLMEvent, LLMResponse, Model, SystemPart, ToolDefinition, type LLMRequest } from "@opencode-ai/ai"
  3. import { OpenAIChat } from "@opencode-ai/ai/protocols"
  4. import { AgentV2 } from "@opencode-ai/core/agent"
  5. import { Database } from "@opencode-ai/core/database/database"
  6. import { AppNodeBuilder } from "@opencode-ai/core/effect/app-node-builder"
  7. import { llmClient } from "@opencode-ai/core/effect/app-node-platform"
  8. import { LayerNode } from "@opencode-ai/util/effect/layer-node"
  9. import { EventV2 } from "@opencode-ai/core/event"
  10. import { EventTable } from "@opencode-ai/core/event/sql"
  11. import { InstructionDiscovery } from "@opencode-ai/core/instruction-discovery"
  12. import { Instructions } from "@opencode-ai/core/instructions"
  13. import { InstructionBuiltIns } from "@opencode-ai/core/instructions/builtins"
  14. import { Location } from "@opencode-ai/core/location"
  15. import { McpInstructions } from "@opencode-ai/core/mcp/instructions"
  16. import { ModelV2 } from "@opencode-ai/core/model"
  17. import { Project } from "@opencode-ai/core/project"
  18. import { ProjectTable } from "@opencode-ai/core/project/sql"
  19. import { ProviderV2 } from "@opencode-ai/core/provider"
  20. import { ReferenceInstructions } from "@opencode-ai/core/reference/instructions"
  21. import { AbsolutePath } from "@opencode-ai/core/schema"
  22. import { SessionEvent } from "@opencode-ai/core/session/event"
  23. import { SessionGenerate } from "@opencode-ai/core/session/generate"
  24. import { SessionGenerateNode } from "@opencode-ai/core/session/generate-node"
  25. import { InstructionState } from "@opencode-ai/core/session/instruction-state"
  26. import { SessionMessage } from "@opencode-ai/core/session/message"
  27. import { SessionProjector } from "@opencode-ai/core/session/projector"
  28. import { SessionRunnerModel } from "@opencode-ai/core/session/runner/model"
  29. import { SessionSchema } from "@opencode-ai/core/session/schema"
  30. import {
  31. InstructionBlobTable,
  32. InstructionStateTable,
  33. SessionMessageTable,
  34. SessionPendingTable,
  35. SessionTable,
  36. } from "@opencode-ai/core/session/sql"
  37. import { SessionStore } from "@opencode-ai/core/session/store"
  38. import { SkillInstructions } from "@opencode-ai/core/skill/instructions"
  39. import { PluginHooks } from "@opencode-ai/core/plugin/hooks"
  40. import { PluginSupervisor } from "@opencode-ai/core/plugin/supervisor"
  41. import { ToolRegistry } from "@opencode-ai/core/tool/registry"
  42. import { asc, eq } from "drizzle-orm"
  43. import { Effect, Layer, Schema, Stream } from "effect"
  44. import { testEffect } from "./lib/effect"
  45. const requests: LLMRequest[] = []
  46. let instruction: string | Instructions.Unavailable = "Initial context"
  47. const sessionID = SessionSchema.ID.make("ses_generate_test")
  48. const model = Model.make({ id: "generate-model", provider: "test", route: OpenAIChat.route })
  49. const client = Layer.mock(LLMClient.Service)({
  50. prepare: () => Effect.die(new Error("unused")),
  51. stream: () => Stream.die(new Error("unused")),
  52. generate: (request) =>
  53. Effect.sync(() => {
  54. requests.push(request)
  55. const response = LLMResponse.fromEvents([
  56. LLMEvent.stepStart({ index: 0 }),
  57. LLMEvent.textStart({ id: "generate" }),
  58. LLMEvent.textDelta({ id: "generate", text: "Transient answer" }),
  59. LLMEvent.textEnd({ id: "generate" }),
  60. LLMEvent.stepFinish({
  61. index: 0,
  62. reason: { normalized: "stop" },
  63. usage: { inputTokens: 100, outputTokens: 10 },
  64. }),
  65. LLMEvent.finish({ reason: { normalized: "stop" } }),
  66. ])
  67. if (!response) throw new Error("Incomplete generate response")
  68. return response
  69. }),
  70. })
  71. const models = Layer.mock(SessionRunnerModel.Service)({
  72. resolve: () =>
  73. Effect.succeed(
  74. SessionRunnerModel.resolved(model, {
  75. capabilities: { tools: true, input: ["text", "image"], output: ["text"] },
  76. cost: [],
  77. }),
  78. ),
  79. })
  80. const builtins = Layer.mock(InstructionBuiltIns.Service, {
  81. load: () =>
  82. Effect.succeed(
  83. Instructions.make({
  84. key: Instructions.Key.make("test/context"),
  85. codec: Schema.toCodecJson(Schema.String),
  86. read: Effect.sync(() => instruction),
  87. render: {
  88. initial: String,
  89. changed: (_previous, current) => current,
  90. },
  91. }),
  92. ),
  93. })
  94. const discovery = Layer.mock(InstructionDiscovery.Service, { load: () => Effect.succeed(Instructions.empty) })
  95. const skills = Layer.mock(SkillInstructions.Service, { load: () => Effect.succeed(Instructions.empty) })
  96. const references = Layer.mock(ReferenceInstructions.Service, { load: () => Effect.succeed(Instructions.empty) })
  97. const mcp = Layer.mock(McpInstructions.Service, { load: () => Effect.succeed(Instructions.empty) })
  98. const plugins = Layer.mock(PluginSupervisor.Service, { flush: Effect.void })
  99. const tools = Layer.mock(ToolRegistry.Service, {
  100. snapshot: () =>
  101. Effect.succeed({
  102. codeModeCatalog: [
  103. {
  104. path: "captured.lookup",
  105. description: "Captured Code Mode catalog",
  106. signature: "tools.captured.lookup(input: {}): Promise<string>",
  107. },
  108. ],
  109. definitions: [ToolDefinition.make({ name: "lookup", description: "Lookup", inputSchema: { type: "object" } })],
  110. execute: () => Effect.die(new Error("unused")),
  111. }),
  112. register: () => Effect.die(new Error("unused")),
  113. registerBatch: () => Effect.die(new Error("unused")),
  114. })
  115. const it = testEffect(
  116. AppNodeBuilder.build(
  117. LayerNode.group([
  118. Database.node,
  119. EventV2.node,
  120. SessionProjector.node,
  121. SessionStore.node,
  122. AgentV2.node,
  123. InstructionBuiltIns.node,
  124. PluginHooks.node,
  125. SessionGenerateNode.node,
  126. ]),
  127. [
  128. [llmClient, client],
  129. [SessionRunnerModel.node, models],
  130. [InstructionBuiltIns.node, builtins],
  131. [InstructionDiscovery.node, discovery],
  132. [SkillInstructions.node, skills],
  133. [ReferenceInstructions.node, references],
  134. [McpInstructions.node, mcp],
  135. [PluginSupervisor.node, plugins],
  136. [ToolRegistry.node, tools],
  137. [Location.node, Location.boundNode({ directory: AbsolutePath.make("/project") })],
  138. ],
  139. ),
  140. )
  141. const durableState = (db: Database.Interface["db"], sessionID: SessionSchema.ID) =>
  142. Effect.all({
  143. sequence: EventV2.latestSequence(db, sessionID),
  144. events: db
  145. .select()
  146. .from(EventTable)
  147. .where(eq(EventTable.aggregate_id, sessionID))
  148. .orderBy(asc(EventTable.seq))
  149. .all()
  150. .pipe(Effect.orDie),
  151. messages: db
  152. .select()
  153. .from(SessionMessageTable)
  154. .where(eq(SessionMessageTable.session_id, sessionID))
  155. .orderBy(asc(SessionMessageTable.seq))
  156. .all()
  157. .pipe(Effect.orDie),
  158. pending: db
  159. .select()
  160. .from(SessionPendingTable)
  161. .where(eq(SessionPendingTable.session_id, sessionID))
  162. .orderBy(asc(SessionPendingTable.admitted_seq))
  163. .all()
  164. .pipe(Effect.orDie),
  165. instructions: db
  166. .select()
  167. .from(InstructionStateTable)
  168. .where(eq(InstructionStateTable.session_id, sessionID))
  169. .get()
  170. .pipe(Effect.orDie),
  171. blobs: db.select().from(InstructionBlobTable).orderBy(asc(InstructionBlobTable.hash)).all().pipe(Effect.orDie),
  172. session: db.select().from(SessionTable).where(eq(SessionTable.id, sessionID)).get().pipe(Effect.orDie),
  173. })
  174. const userTexts = (request: LLMRequest) =>
  175. request.messages.flatMap((message) =>
  176. message.role === "user"
  177. ? message.content.flatMap((content) => (content.type === "text" ? [content.text] : []))
  178. : [],
  179. )
  180. const setup = Effect.gen(function* () {
  181. const { db } = yield* Database.Service
  182. const events = yield* EventV2.Service
  183. const agents = yield* AgentV2.Service
  184. const instructionBuiltIns = yield* InstructionBuiltIns.Service
  185. yield* agents.transform((draft) =>
  186. draft.update(AgentV2.ID.make("build"), (agent) => {
  187. agent.mode = "primary"
  188. }),
  189. )
  190. yield* db
  191. .insert(ProjectTable)
  192. .values({ id: Project.ID.global, worktree: AbsolutePath.make("/project"), sandboxes: [] })
  193. .run()
  194. .pipe(Effect.orDie)
  195. yield* db
  196. .insert(SessionTable)
  197. .values({
  198. id: sessionID,
  199. project_id: Project.ID.global,
  200. slug: "generate-test",
  201. directory: "/project",
  202. title: "Generate test",
  203. version: "test",
  204. agent: AgentV2.ID.make("build"),
  205. })
  206. .run()
  207. .pipe(Effect.orDie)
  208. return { db, events, instructions: yield* instructionBuiltIns.load(sessionID) }
  209. })
  210. it.effect("generates from fresh settled Session context without durable mutation", () =>
  211. Effect.gen(function* () {
  212. requests.length = 0
  213. instruction = "Initial context"
  214. const { db, events, instructions } = yield* setup
  215. yield* InstructionState.prepare(db, events, instructions, sessionID)
  216. const existing = SessionMessage.ID.create()
  217. yield* events.publish(SessionEvent.InputAdmitted, {
  218. sessionID,
  219. inputID: existing,
  220. input: { type: "user", data: { text: "Existing durable context" }, delivery: "steer" },
  221. })
  222. yield* events.publish(SessionEvent.InputPromoted, { sessionID, inputID: existing })
  223. const settledAssistant = SessionMessage.ID.create()
  224. yield* events.publish(SessionEvent.Step.Started, {
  225. sessionID,
  226. assistantMessageID: settledAssistant,
  227. agent: AgentV2.ID.make("build"),
  228. model: { id: ModelV2.ID.make("generate-model"), providerID: ProviderV2.ID.make("test") },
  229. })
  230. yield* events.publish(SessionEvent.Text.Started, {
  231. sessionID,
  232. assistantMessageID: settledAssistant,
  233. ordinal: 0,
  234. })
  235. yield* events.publish(SessionEvent.Text.Ended, {
  236. sessionID,
  237. assistantMessageID: settledAssistant,
  238. ordinal: 0,
  239. text: "Settled partial answer",
  240. })
  241. const activeAssistant = SessionMessage.ID.create()
  242. yield* events.publish(SessionEvent.Step.Started, {
  243. sessionID,
  244. assistantMessageID: activeAssistant,
  245. agent: AgentV2.ID.make("build"),
  246. model: { id: ModelV2.ID.make("generate-model"), providerID: ProviderV2.ID.make("test") },
  247. })
  248. yield* events.publish(SessionEvent.Tool.Input.Started, {
  249. sessionID,
  250. assistantMessageID: activeAssistant,
  251. callID: "active-call",
  252. name: "echo",
  253. })
  254. yield* events.publish(SessionEvent.Tool.Input.Ended, {
  255. sessionID,
  256. assistantMessageID: activeAssistant,
  257. callID: "active-call",
  258. text: "{}",
  259. })
  260. yield* events.publish(SessionEvent.Tool.Called, {
  261. sessionID,
  262. assistantMessageID: activeAssistant,
  263. callID: "active-call",
  264. input: {},
  265. executed: false,
  266. })
  267. yield* events.publish(SessionEvent.InputAdmitted, {
  268. sessionID,
  269. inputID: SessionMessage.ID.create(),
  270. input: { type: "user", data: { text: "Queued input must remain invisible" }, delivery: "queue" },
  271. })
  272. instruction = "Changed context"
  273. const before = yield* durableState(db, sessionID)
  274. const hooks = yield* PluginHooks.Service
  275. yield* hooks.register("session", "context", (event) =>
  276. Effect.sync(() => {
  277. event.system = [SystemPart.make("Hooked system"), ...event.system]
  278. if (event.tools.lookup) event.tools.lookup.description = "Hooked lookup"
  279. }),
  280. )
  281. const generate = yield* SessionGenerate.Service
  282. const result = yield* generate.generate({ sessionID, prompt: "Summarize privately" })
  283. expect(result).toBe("Transient answer")
  284. expect(requests).toHaveLength(1)
  285. expect(requests[0]?.model).toBe(model)
  286. expect(requests[0]?.system[0]?.text).toBe("Hooked system")
  287. expect(requests[0]?.system.map((part) => part.text)).toContain("Initial context")
  288. expect(requests[0]?.http?.headers).toMatchObject({ "X-Session-Id": sessionID })
  289. expect(requests[0]?.providerOptions).toMatchObject({ openai: { promptCacheKey: sessionID } })
  290. const instructionUpdates = requests[0]?.messages.flatMap((message) =>
  291. message.role === "system"
  292. ? message.content.flatMap((content) => (content.type === "text" ? [content.text] : []))
  293. : [],
  294. )
  295. expect(instructionUpdates).toHaveLength(1)
  296. expect(instructionUpdates?.[0]).toContain("Changed context")
  297. expect(instructionUpdates?.[0]).toContain("tools.captured.lookup(input: {}): Promise<string>")
  298. expect(userTexts(requests[0])).toEqual(["Existing durable context", "Summarize privately"])
  299. expect(
  300. requests[0]?.messages.flatMap((message) =>
  301. message.role === "assistant"
  302. ? message.content.flatMap((content) => (content.type === "text" ? [content.text] : []))
  303. : [],
  304. ),
  305. ).toEqual(["Settled partial answer"])
  306. expect(requests[0]?.tools).toMatchObject([{ name: "lookup", description: "Hooked lookup" }])
  307. expect(requests[0]?.toolChoice).toBeUndefined()
  308. expect(yield* durableState(db, sessionID)).toEqual(before)
  309. }),
  310. )
  311. it.effect("blocks unavailable initial instructions before generation", () =>
  312. Effect.gen(function* () {
  313. requests.length = 0
  314. instruction = Instructions.unavailable
  315. const { db } = yield* setup
  316. const before = yield* durableState(db, sessionID)
  317. const generate = yield* SessionGenerate.Service
  318. const error = yield* generate.generate({ sessionID, prompt: "Summarize privately" }).pipe(Effect.flip)
  319. expect(error).toBeInstanceOf(Instructions.InitializationBlocked)
  320. expect(requests).toEqual([])
  321. expect(yield* durableState(db, sessionID)).toEqual(before)
  322. }),
  323. )