test(session): migrate structured output integration test (#27143)

packages/opencode/test/session/structured-output-integration.test.ts

@@ -1,250 +1,219 @@
 import { describe, expect, test } from "bun:test"
-import path from "path"
 import { Effect, Layer } from "effect"
 import { Session } from "@/session/session"
 import { SessionPrompt } from "../../src/session/prompt"
 import * as Log from "@opencode-ai/core/util/log"
-import { Instance } from "../../src/project/instance"
-import { WithInstance } from "../../src/project/with-instance"
 import { MessageV2 } from "../../src/session/message-v2"
+import { testEffect } from "../lib/effect"
 
-const projectRoot = path.join(__dirname, "../..")
 void Log.init({ print: false })
 
 // Skip tests if no API key is available
 const hasApiKey = !!process.env.ANTHROPIC_API_KEY
-
-// Helper to run test within Instance context
-async function withInstance<T>(fn: () => Promise<T>): Promise<T> {
-  return WithInstance.provide({
-    directory: projectRoot,
-    fn,
-  })
-}
-
-function run<A, E>(fx: Effect.Effect<A, E, SessionPrompt.Service | Session.Service>) {
-  return Effect.runPromise(
-    fx.pipe(Effect.scoped, Effect.provide(Layer.mergeAll(SessionPrompt.defaultLayer, Session.defaultLayer))),
-  )
-}
+const it = testEffect(Layer.mergeAll(SessionPrompt.defaultLayer, Session.defaultLayer))
+const live = hasApiKey ? it.instance : it.instance.skip
 
 describe("StructuredOutput Integration", () => {
-  test.skipIf(!hasApiKey)(
+  live(
     "produces structured output with simple schema",
-    async () => {
-      await withInstance(() =>
-        run(
-          Effect.gen(function* () {
-            const prompt = yield* SessionPrompt.Service
-            const sessions = yield* Session.Service
-            const session = yield* sessions.create({ title: "Structured Output Test" })
-
-            const result = yield* prompt.prompt({
-              sessionID: session.id,
-              parts: [
-                {
-                  type: "text",
-                  text: "What is 2 + 2? Provide a simple answer.",
-                },
-              ],
-              format: {
-                type: "json_schema",
-                schema: {
-                  type: "object",
-                  properties: {
-                    answer: { type: "number", description: "The numerical answer" },
-                    explanation: { type: "string", description: "Brief explanation" },
-                  },
-                  required: ["answer"],
-                },
-                retryCount: 0,
+    () =>
+      Effect.gen(function* () {
+        const prompt = yield* SessionPrompt.Service
+        const sessions = yield* Session.Service
+        const session = yield* sessions.create({ title: "Structured Output Test" })
+
+        const result = yield* prompt.prompt({
+          sessionID: session.id,
+          parts: [
+            {
+              type: "text",
+              text: "What is 2 + 2? Provide a simple answer.",
+            },
+          ],
+          format: {
+            type: "json_schema",
+            schema: {
+              type: "object",
+              properties: {
+                answer: { type: "number", description: "The numerical answer" },
+                explanation: { type: "string", description: "Brief explanation" },
               },
-            })
-
-            // Verify structured output was captured (only on assistant messages)
-            expect(result.info.role).toBe("assistant")
-            if (result.info.role === "assistant") {
-              expect(result.info.structured).toBeDefined()
-              expect(typeof result.info.structured).toBe("object")
-
-              const output = result.info.structured as any
-              expect(output.answer).toBe(4)
-
-              // Verify no error was set
-              expect(result.info.error).toBeUndefined()
-            }
-
-            // Clean up
-            // Note: Not removing session to avoid race with background SessionSummary.summarize
-          }),
-        ),
-      )
-    },
+              required: ["answer"],
+            },
+            retryCount: 0,
+          },
+        })
+
+        // Verify structured output was captured (only on assistant messages)
+        expect(result.info.role).toBe("assistant")
+        if (result.info.role === "assistant") {
+          expect(result.info.structured).toBeDefined()
+          expect(typeof result.info.structured).toBe("object")
+
+          const output = result.info.structured as any
+          expect(output.answer).toBe(4)
+
+          // Verify no error was set
+          expect(result.info.error).toBeUndefined()
+        }
+
+        // Clean up
+        // Note: Not removing session to avoid race with background SessionSummary.summarize
+      }),
+    { git: true },
     60000,
   )
 
-  test.skipIf(!hasApiKey)(
+  live(
     "produces structured output with nested objects",
-    async () => {
-      await withInstance(() =>
-        run(
-          Effect.gen(function* () {
-            const prompt = yield* SessionPrompt.Service
-            const sessions = yield* Session.Service
-            const session = yield* sessions.create({ title: "Nested Schema Test" })
-
-            const result = yield* prompt.prompt({
-              sessionID: session.id,
-              parts: [
-                {
-                  type: "text",
-                  text: "Tell me about Anthropic company in a structured format.",
-                },
-              ],
-              format: {
-                type: "json_schema",
-                schema: {
+    () =>
+      Effect.gen(function* () {
+        const prompt = yield* SessionPrompt.Service
+        const sessions = yield* Session.Service
+        const session = yield* sessions.create({ title: "Nested Schema Test" })
+
+        const result = yield* prompt.prompt({
+          sessionID: session.id,
+          parts: [
+            {
+              type: "text",
+              text: "Tell me about Anthropic company in a structured format.",
+            },
+          ],
+          format: {
+            type: "json_schema",
+            schema: {
+              type: "object",
+              properties: {
+                company: {
                   type: "object",
                   properties: {
-                    company: {
-                      type: "object",
-                      properties: {
-                        name: { type: "string" },
-                        founded: { type: "number" },
-                      },
-                      required: ["name", "founded"],
-                    },
-                    products: {
-                      type: "array",
-                      items: { type: "string" },
-                    },
+                    name: { type: "string" },
+                    founded: { type: "number" },
                   },
-                  required: ["company"],
+                  required: ["name", "founded"],
+                },
+                products: {
+                  type: "array",
+                  items: { type: "string" },
                 },
-                retryCount: 0,
               },
-            })
-
-            // Verify structured output was captured (only on assistant messages)
-            expect(result.info.role).toBe("assistant")
-            if (result.info.role === "assistant") {
-              expect(result.info.structured).toBeDefined()
-              const output = result.info.structured as any
-
-              expect(output.company).toBeDefined()
-              expect(output.company.name).toBe("Anthropic")
-              expect(typeof output.company.founded).toBe("number")
-
-              if (output.products) {
-                expect(Array.isArray(output.products)).toBe(true)
-              }
-
-              // Verify no error was set
-              expect(result.info.error).toBeUndefined()
-            }
-
-            // Clean up
-            // Note: Not removing session to avoid race with background SessionSummary.summarize
-          }),
-        ),
-      )
-    },
+              required: ["company"],
+            },
+            retryCount: 0,
+          },
+        })
+
+        // Verify structured output was captured (only on assistant messages)
+        expect(result.info.role).toBe("assistant")
+        if (result.info.role === "assistant") {
+          expect(result.info.structured).toBeDefined()
+          const output = result.info.structured as any
+
+          expect(output.company).toBeDefined()
+          expect(output.company.name).toBe("Anthropic")
+          expect(typeof output.company.founded).toBe("number")
+
+          if (output.products) {
+            expect(Array.isArray(output.products)).toBe(true)
+          }
+
+          // Verify no error was set
+          expect(result.info.error).toBeUndefined()
+        }
+
+        // Clean up
+        // Note: Not removing session to avoid race with background SessionSummary.summarize
+      }),
+    { git: true },
     60000,
   )
 
-  test.skipIf(!hasApiKey)(
+  live(
     "works with text outputFormat (default)",
-    async () => {
-      await withInstance(() =>
-        run(
-          Effect.gen(function* () {
-            const prompt = yield* SessionPrompt.Service
-            const sessions = yield* Session.Service
-            const session = yield* sessions.create({ title: "Text Output Test" })
-
-            const result = yield* prompt.prompt({
-              sessionID: session.id,
-              parts: [
-                {
-                  type: "text",
-                  text: "Say hello.",
-                },
-              ],
-              format: {
-                type: "text",
-              },
-            })
-
-            // Verify no structured output (text mode) and no error
-            expect(result.info.role).toBe("assistant")
-            if (result.info.role === "assistant") {
-              expect(result.info.structured).toBeUndefined()
-              expect(result.info.error).toBeUndefined()
-            }
-
-            // Verify we got a response with parts
-            expect(result.parts.length).toBeGreaterThan(0)
-
-            // Clean up
-            // Note: Not removing session to avoid race with background SessionSummary.summarize
-          }),
-        ),
-      )
-    },
+    () =>
+      Effect.gen(function* () {
+        const prompt = yield* SessionPrompt.Service
+        const sessions = yield* Session.Service
+        const session = yield* sessions.create({ title: "Text Output Test" })
+
+        const result = yield* prompt.prompt({
+          sessionID: session.id,
+          parts: [
+            {
+              type: "text",
+              text: "Say hello.",
+            },
+          ],
+          format: {
+            type: "text",
+          },
+        })
+
+        // Verify no structured output (text mode) and no error
+        expect(result.info.role).toBe("assistant")
+        if (result.info.role === "assistant") {
+          expect(result.info.structured).toBeUndefined()
+          expect(result.info.error).toBeUndefined()
+        }
+
+        // Verify we got a response with parts
+        expect(result.parts.length).toBeGreaterThan(0)
+
+        // Clean up
+        // Note: Not removing session to avoid race with background SessionSummary.summarize
+      }),
+    { git: true },
     60000,
   )
 
-  test.skipIf(!hasApiKey)(
+  live(
     "stores outputFormat on user message",
-    async () => {
-      await withInstance(() =>
-        run(
-          Effect.gen(function* () {
-            const prompt = yield* SessionPrompt.Service
-            const sessions = yield* Session.Service
-            const session = yield* sessions.create({ title: "OutputFormat Storage Test" })
-
-            yield* prompt.prompt({
-              sessionID: session.id,
-              parts: [
-                {
-                  type: "text",
-                  text: "What is 1 + 1?",
-                },
-              ],
-              format: {
-                type: "json_schema",
-                schema: {
-                  type: "object",
-                  properties: {
-                    result: { type: "number" },
-                  },
-                  required: ["result"],
-                },
-                retryCount: 3,
+    () =>
+      Effect.gen(function* () {
+        const prompt = yield* SessionPrompt.Service
+        const sessions = yield* Session.Service
+        const session = yield* sessions.create({ title: "OutputFormat Storage Test" })
+
+        yield* prompt.prompt({
+          sessionID: session.id,
+          parts: [
+            {
+              type: "text",
+              text: "What is 1 + 1?",
+            },
+          ],
+          format: {
+            type: "json_schema",
+            schema: {
+              type: "object",
+              properties: {
+                result: { type: "number" },
               },
-            })
-
-            // Get all messages from session
-            const messages = yield* sessions.messages({ sessionID: session.id })
-            const userMessage = messages.find((m) => m.info.role === "user")
-
-            // Verify outputFormat was stored on user message
-            expect(userMessage).toBeDefined()
-            if (userMessage?.info.role === "user") {
-              expect(userMessage.info.format).toBeDefined()
-              expect(userMessage.info.format?.type).toBe("json_schema")
-              if (userMessage.info.format?.type === "json_schema") {
-                expect(userMessage.info.format.retryCount).toBe(3)
-              }
-            }
-
-            // Clean up
-            // Note: Not removing session to avoid race with background SessionSummary.summarize
-          }),
-        ),
-      )
-    },
+              required: ["result"],
+            },
+            retryCount: 3,
+          },
+        })
+
+        // Get all messages from session
+        const messages = yield* sessions.messages({ sessionID: session.id })
+        const userMessage = messages.find((m) => m.info.role === "user")
+
+        // Verify outputFormat was stored on user message
+        expect(userMessage).toBeDefined()
+        if (userMessage?.info.role === "user") {
+          expect(userMessage.info.format).toBeDefined()
+          expect(userMessage.info.format?.type).toBe("json_schema")
+          if (userMessage.info.format?.type === "json_schema") {
+            expect(userMessage.info.format.retryCount).toBe(3)
+          }
+        }
+
+        // Clean up
+        // Note: Not removing session to avoid race with background SessionSummary.summarize
+      }),
+    { git: true },
     60000,
   )