| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015 |
- import { describe, expect, test } from "bun:test"
- import { Cause, Effect, Schema } from "effect"
- import { CodeMode, ExecuteInputSchema, ExecuteResultSchema, Tool, toolError, type ExecutionLimits } from "../src/index.js"
- import type { Definition } from "../src/tool.js"
- const run = (tool: Definition<never>) =>
- Effect.runPromise(CodeMode.make({ tools: { host: { call: tool } } }).execute("return await tools.host.call({})"))
- class UnsafeHostError extends Schema.TaggedErrorClass<UnsafeHostError>()("UnsafeHostError", {
- reason: Schema.String,
- }) {}
- describe("CodeMode host failure boundary", () => {
- test("preserves explicit safe tool failures", async () => {
- const result = await run(
- Tool.make({
- description: "Fail safely",
- input: Schema.Struct({}),
- output: Schema.String,
- run: () => Effect.fail(toolError("Authorized request was refused")),
- }),
- )
- expect(result.ok ? undefined : result.error).toStrictEqual({
- kind: "ToolFailure",
- message: "Authorized request was refused",
- })
- })
- test("sanitizes unknown host failures and defects", async () => {
- for (const failure of [
- Effect.fail(new UnsafeHostError({ reason: "Authorization: Bearer typed-secret" })),
- Effect.die(new Error("postgres://user:defect-secret@example.invalid")),
- ]) {
- const result = await run(
- Tool.make({
- description: "Fail internally",
- input: Schema.Struct({}),
- output: Schema.String,
- run: () => failure,
- }),
- )
- expect(result.ok ? undefined : result.error).toStrictEqual({
- kind: "ToolFailure",
- message: "Tool execution failed",
- })
- expect(JSON.stringify(result)).not.toMatch(/typed-secret|defect-secret|Authorization: Bearer/)
- }
- })
- test("sanitizes invalid host output", async () => {
- const secret = "invalid-output-secret"
- const result = await run(
- Tool.make({
- description: "Return invalid output",
- input: Schema.Struct({}),
- output: Schema.Struct({ safe: Schema.String }),
- run: () => Effect.succeed({ safe: 1, secret } as unknown as { readonly safe: string }),
- }),
- )
- expect(result.ok ? undefined : result.error).toStrictEqual({
- kind: "InvalidToolOutput",
- message: "Invalid output from tool 'host.call'.",
- })
- expect(JSON.stringify(result)).not.toMatch(/invalid-output-secret/)
- })
- test("sanitizes host output that throws while being copied", async () => {
- const result = await run(
- Tool.make({
- description: "Return hostile output",
- input: Schema.Struct({}),
- output: Schema.Unknown,
- run: () =>
- Effect.succeed(
- new Proxy({}, {
- ownKeys: () => {
- throw new Error("host-output-secret")
- },
- }),
- ),
- }),
- )
- expect(result.ok ? undefined : result.error).toStrictEqual({
- kind: "InvalidToolOutput",
- message: "Invalid output from tool 'host.call'.",
- })
- expect(JSON.stringify(result)).not.toMatch(/host-output-secret/)
- })
- test("caught tool failures are Error values in-program", async () => {
- const result = await Effect.runPromise(
- CodeMode.make({
- tools: {
- host: {
- call: Tool.make({
- description: "Refuse",
- input: Schema.Struct({}),
- output: Schema.String,
- run: () => Effect.fail(toolError("Refused")),
- }),
- },
- },
- }).execute(`
- try {
- await tools.host.call({})
- return "no"
- } catch (e) {
- return { isError: e instanceof Error, message: e.message }
- }
- `),
- )
- expect(result.ok).toBe(true)
- if (result.ok) expect(result.value).toStrictEqual({ isError: true, message: "Refused" })
- })
- test("propagates host interruption instead of returning a diagnostic", async () => {
- const exit = await Effect.runPromiseExit(
- CodeMode.make({
- tools: {
- host: {
- call: Tool.make({
- description: "Interrupt",
- input: Schema.Struct({}),
- output: Schema.String,
- run: () => Effect.interrupt,
- }),
- },
- },
- }).execute("return await tools.host.call({})"),
- )
- expect(exit._tag).toBe("Failure")
- if (exit._tag === "Failure") {
- expect(Cause.hasInterruptsOnly(exit.cause)).toBe(true)
- }
- })
- })
- describe("CodeMode tool-call observation", () => {
- test("reports the tools actually invoked with decoded input", async () => {
- const calls: Array<unknown> = []
- const lookup = Tool.make({
- description: "Look up a value",
- input: Schema.Struct({ query: Schema.String }),
- output: Schema.String,
- run: ({ query }) => Effect.succeed(query),
- })
- const result = await Effect.runPromise(
- CodeMode.make({
- tools: { context: { lookup } },
- onToolCallStart: (call) => Effect.sync(() => calls.push(call)),
- }).execute(`
- if (false) await tools.context.lookup({ query: "not called" })
- return await tools.context.lookup({ query: "deployment failure" })
- `),
- )
- expect(result.ok).toBe(true)
- expect(calls).toStrictEqual([
- { index: 0, name: "context.lookup", input: { query: "deployment failure" } },
- ])
- })
- test("observes settled calls with outcome and duration", async () => {
- const events: Array<{ phase: string; index: number; name: string; outcome?: string; message?: string }> = []
- const lookup = Tool.make({
- description: "Look up a value",
- input: Schema.Struct({ query: Schema.String }),
- output: Schema.String,
- run: ({ query }) =>
- query === "boom" ? Effect.fail(toolError("Lookup refused")) : Effect.succeed(query),
- })
- const runtime = CodeMode.make({
- tools: { context: { lookup } },
- onToolCallStart: (call) => Effect.sync(() => {
- events.push({ phase: "start", index: call.index, name: call.name })
- }),
- onToolCallEnd: (call) => Effect.sync(() => {
- expect(call.durationMs).toBeGreaterThanOrEqual(0)
- events.push({
- phase: "end",
- index: call.index,
- name: call.name,
- outcome: call.outcome,
- ...(call.message === undefined ? {} : { message: call.message }),
- })
- }),
- })
- const success = await Effect.runPromise(runtime.execute(`return await tools.context.lookup({ query: "ok" })`))
- expect(success.ok).toBe(true)
- const failure = await Effect.runPromise(runtime.execute(`return await tools.context.lookup({ query: "boom" })`))
- expect(failure.ok).toBe(false)
- expect(events).toStrictEqual([
- { phase: "start", index: 0, name: "context.lookup" },
- { phase: "end", index: 0, name: "context.lookup", outcome: "success" },
- { phase: "start", index: 0, name: "context.lookup" },
- { phase: "end", index: 0, name: "context.lookup", outcome: "failure", message: "Lookup refused" },
- ])
- })
- })
- describe("CodeMode console capture", () => {
- test("captures console output as bounded result logs", async () => {
- const result = await Effect.runPromise(CodeMode.execute({
- code: `
- const returned = console.log("Thread info:", { name: "Demo", count: 2 })
- console.warn("careful")
- return returned
- `,
- }))
- expect(result).toStrictEqual({
- ok: true,
- value: null,
- logs: ['Thread info: {"name":"Demo","count":2}', "[warn] careful"],
- toolCalls: [],
- })
- expect(Schema.decodeUnknownSync(ExecuteResultSchema)(JSON.parse(JSON.stringify(result)))).toStrictEqual(result)
- })
- test("keeps logs captured before failures", async () => {
- const result = await Effect.runPromise(CodeMode.execute({
- code: `
- console.log("before failure")
- throw new Error("boom")
- `,
- }))
- expect(result.ok ? undefined : result.logs).toStrictEqual(["before failure"])
- expect(result.ok ? undefined : result.error.message).toBe("Uncaught: boom")
- })
- test("prints NaN and Infinity literally instead of the JSON null", async () => {
- const result = await Effect.runPromise(CodeMode.execute({
- code: `
- console.log(NaN)
- console.log(Infinity, -Infinity)
- console.log({ ratio: NaN, bounds: [Infinity] })
- return null
- `,
- }))
- expect(result.ok).toBe(true)
- expect(result.logs).toStrictEqual(["NaN", "Infinity -Infinity", '{"ratio":NaN,"bounds":[Infinity]}'])
- })
- test("renders sandbox values nested inside logged containers", async () => {
- const result = await Effect.runPromise(CodeMode.execute({
- code: `
- console.log({ m: new Map([["a", 1]]), when: new Date(0), r: /ab/g, s: new Set([1, 2]) })
- console.log([new Date(0)])
- return null
- `,
- }))
- expect(result.ok).toBe(true)
- expect(result.logs).toStrictEqual([
- '{"m":Map(1) [["a",1]],"when":1970-01-01T00:00:00.000Z,"r":/ab/g,"s":Set(2) [1,2]}',
- "[1970-01-01T00:00:00.000Z]",
- ])
- })
- test("console formatting is total: cycles and opaque references render as markers", async () => {
- const result = await Effect.runPromise(CodeMode.execute({
- code: `
- const m = new Map()
- m.set("self", m)
- console.log({ box: m })
- console.log({ fn: (x) => x, ok: 1 })
- return null
- `,
- }))
- expect(result.ok).toBe(true)
- expect(result.logs).toStrictEqual([
- '{"box":Map(1) [["self",[Circular]]]}',
- '{"fn":[CodeMode reference],"ok":1}',
- ])
- })
- test("console.table renders sandbox value cells", async () => {
- const result = await Effect.runPromise(CodeMode.execute({
- code: `
- console.table([{ when: new Date(0), n: NaN }])
- return null
- `,
- }))
- expect(result.ok).toBe(true)
- expect(result.logs).toStrictEqual(["(index)\twhen\tn\n0\t1970-01-01T00:00:00.000Z\tNaN"])
- })
- test("captures console.dir and console.table output", async () => {
- const result = await Effect.runPromise(CodeMode.execute({
- code: `
- console.dir({ nested: { ok: true } })
- console.table([
- { name: "Kit", count: 1, hidden: "x" },
- { name: "Olive", count: 2, hidden: "y" }
- ], ["name", "count"])
- return "done"
- `,
- }))
- expect(result).toStrictEqual({
- ok: true,
- value: "done",
- logs: [
- '{"nested":{"ok":true}}',
- "(index)\tname\tcount\n0\tKit\t1\n1\tOlive\t2",
- ],
- toolCalls: [],
- })
- })
- })
- describe("CodeMode output budget", () => {
- test("absent maxOutputBytes means no truncation at all", async () => {
- const result = await Effect.runPromise(CodeMode.execute({
- code: `console.log("z".repeat(50_000)); return "x".repeat(100_000)`,
- }))
- expect(result.ok).toBe(true)
- if (!result.ok) return
- expect(result.truncated).toBeUndefined()
- expect(result.value).toBe("x".repeat(100_000))
- expect(result.logs).toStrictEqual(["z".repeat(50_000)])
- })
- test("truncates an oversized result value with a marker instead of failing", async () => {
- const limits: ExecutionLimits = { maxOutputBytes: 40 }
- const result = await Effect.runPromise(CodeMode.execute({
- code: `return { data: "${"x".repeat(200)}" }`,
- limits,
- }))
- expect(result.ok).toBe(true)
- if (!result.ok) return
- expect(result.truncated).toBe(true)
- expect(typeof result.value).toBe("string")
- expect(result.value).toMatch(/^\{"data":"x+ \[result truncated: \d+ bytes exceeds the 40-byte output limit; return a smaller value\]$/)
- expect(Schema.decodeUnknownSync(ExecuteResultSchema)(JSON.parse(JSON.stringify(result)))).toStrictEqual(result)
- })
- test("keeps leading logs within the remaining budget and marks the cut", async () => {
- const limits: ExecutionLimits = { maxOutputBytes: 40 }
- const result = await Effect.runPromise(CodeMode.execute({
- code: `
- console.log("first line")
- console.log("${"y".repeat(200)}")
- return "ok"
- `,
- limits,
- }))
- expect(result.ok).toBe(true)
- if (!result.ok) return
- expect(result.value).toBe("ok")
- expect(result.truncated).toBe(true)
- expect(result.logs).toStrictEqual(["first line", "[logs truncated: showing 1 of 2 lines]"])
- })
- test("does not mark results within the budget", async () => {
- const result = await Effect.runPromise(CodeMode.execute({
- code: `
- console.log("fits")
- return { fits: true }
- `,
- }))
- expect(result).toStrictEqual({
- ok: true,
- value: { fits: true },
- logs: ["fits"],
- toolCalls: [],
- })
- })
- })
- describe("CodeMode schema flexibility", () => {
- test("accepts render-only JSON Schema input and omitted output", async () => {
- const observed: Array<unknown> = []
- const call = Tool.make({
- description: "Call an adapter-described tool",
- input: {
- type: "object",
- properties: { id: { type: "string" }, count: { type: "number" } },
- required: ["id"],
- },
- run: (input) => Effect.sync(() => {
- observed.push(input)
- return { echoed: input }
- }),
- })
- const runtime = CodeMode.make({ tools: { adapter: { call } } })
- expect(runtime.catalog()).toStrictEqual([{
- path: "adapter.call",
- description: "Call an adapter-described tool",
- signature: "tools.adapter.call(input: { id: string; count?: number }): Promise<unknown>",
- }])
- // JSON Schema is render-only: mistyped input passes through unvalidated.
- const result = await Effect.runPromise(runtime.execute(`return await tools.adapter.call({ id: 42 })`))
- expect(result.ok).toBe(true)
- if (result.ok) expect(result.value).toStrictEqual({ echoed: { id: 42 } })
- expect(observed).toStrictEqual([{ id: 42 }])
- })
- test("renders JSON Schema outputs and $defs references", async () => {
- const lookup = Tool.make({
- description: "Look up a user",
- input: { type: "object", properties: { login: { type: "string" } }, required: ["login"] },
- output: {
- $ref: "#/$defs/User",
- $defs: { User: { type: "object", properties: { login: { type: "string" }, id: { type: "number" } }, required: ["login", "id"] } },
- },
- run: () => Effect.succeed({ login: "kit", id: 7 }),
- })
- const runtime = CodeMode.make({ tools: { users: { lookup } } })
- expect(runtime.catalog()).toStrictEqual([{
- path: "users.lookup",
- description: "Look up a user",
- signature: "tools.users.lookup(input: { login: string }): Promise<{ login: string; id: number }>",
- }])
- const result = await Effect.runPromise(runtime.execute(`return await tools.users.lookup({ login: "kit" })`))
- expect(result.ok).toBe(true)
- if (result.ok) expect(result.value).toStrictEqual({ login: "kit", id: 7 })
- })
- test("Effect Schema output without an input transform still renders unknown when omitted", async () => {
- const ping = Tool.make({
- description: "Ping",
- input: Schema.Struct({ host: Schema.String }),
- run: () => Effect.succeed("pong"),
- })
- const runtime = CodeMode.make({ tools: { net: { ping } } })
- expect(runtime.catalog()[0]?.signature).toBe("tools.net.ping(input: { host: string }): Promise<unknown>")
- const result = await Effect.runPromise(runtime.execute(`return await tools.net.ping({ host: "example.test" })`))
- expect(result.ok).toBe(true)
- if (result.ok) expect(result.value).toBe("pong")
- })
- })
- describe("CodeMode public contract", () => {
- const lookup = Tool.make({
- description: "Look up an order by ID",
- input: Schema.Struct({ id: Schema.String }),
- output: Schema.Struct({ id: Schema.String, status: Schema.String }),
- run: ({ id }) => Effect.succeed({ id, status: "open" }),
- })
- const tools = { orders: { lookup } }
- const source = `return await tools.orders.lookup({ id: "order_42" })`
- test("keeps one-shot, reusable, and agent-tool execution equivalent", async () => {
- const runtime = CodeMode.make({ tools })
- const agentTool = runtime.agentTool()
- const [oneShot, reusable, projected] = await Promise.all([
- Effect.runPromise(CodeMode.execute({ tools, code: source })),
- Effect.runPromise(runtime.execute(source)),
- Effect.runPromise(agentTool.execute({ code: source })),
- ])
- expect(reusable).toStrictEqual(oneShot)
- expect(projected).toStrictEqual(oneShot)
- expect(agentTool.name).toBe("code")
- expect(agentTool.input).toBe(ExecuteInputSchema)
- expect(agentTool.output).toBe(ExecuteResultSchema)
- expect(agentTool.description).toBe(runtime.instructions())
- expect(Schema.decodeUnknownSync(ExecuteResultSchema)(JSON.parse(JSON.stringify(projected)))).toStrictEqual(projected)
- })
- test("inlines a COMPLETE small catalog and keeps search registered but unadvertised", async () => {
- const runtime = CodeMode.make({ tools })
- expect(runtime.catalog()).toStrictEqual([{
- path: "orders.lookup",
- description: "Look up an order by ID",
- signature: "tools.orders.lookup(input: { id: string }): Promise<{ id: string; status: string }>",
- }])
- expect(runtime.instructions()).toContain("Available tools (COMPLETE list")
- expect(runtime.instructions()).toContain("- orders (1 tool)")
- expect(runtime.instructions()).toContain(
- " - tools.orders.lookup(input: { id: string }): Promise<{ id: string; status: string }> // Look up an order by ID",
- )
- // A fully inlined catalog does not advertise search in the instructions...
- expect(runtime.instructions()).not.toMatch(/\$codemode/)
- // ...but the search tool stays registered, so a speculative call still works. Search
- // results carry the pretty multiline signature; the inline catalog stays compact.
- const result = await Effect.runPromise(runtime.execute(`return await tools.$codemode.search({ query: "order" })`))
- expect(result.ok).toBe(true)
- if (result.ok) {
- expect(result.value).toStrictEqual({
- items: [{
- path: "tools.orders.lookup",
- description: "Look up an order by ID",
- signature: "tools.orders.lookup(input: {\n id: string\n}): Promise<{\n id: string\n status: string\n}>",
- }],
- total: 1,
- })
- }
- })
- test("renders bracket notation for tool names that are not JavaScript identifiers", async () => {
- const resolveLibrary = Tool.make({
- description: "Resolve a library ID",
- input: Schema.Struct({ libraryName: Schema.String }),
- output: Schema.String,
- run: ({ libraryName }) => Effect.succeed(`/resolved/${libraryName}`),
- })
- const runtime = CodeMode.make({ tools: { context7: { "resolve-library-id": resolveLibrary } } })
- expect(runtime.catalog()).toStrictEqual([{
- path: "context7.resolve-library-id",
- description: "Resolve a library ID",
- signature: 'tools.context7["resolve-library-id"](input: { libraryName: string }): Promise<string>',
- }])
- expect(runtime.instructions()).toContain('tools.context7["resolve-library-id"](input: { libraryName: string }): Promise<string>')
- const search = await Effect.runPromise(runtime.execute(`return await tools.$codemode.search({ query: "resolve library id" })`))
- expect(search.ok).toBe(true)
- if (search.ok) {
- expect(search.value).toStrictEqual({
- items: [{
- path: 'tools.context7["resolve-library-id"]',
- description: "Resolve a library ID",
- signature: 'tools.context7["resolve-library-id"](input: {\n libraryName: string\n}): Promise<string>',
- }],
- total: 1,
- })
- }
- const call = await Effect.runPromise(runtime.execute(`return await tools.context7["resolve-library-id"]({ libraryName: "TypeScript" })`))
- expect(call.ok).toBe(true)
- if (call.ok) expect(call.value).toBe("/resolved/TypeScript")
- const exact = await Effect.runPromise(runtime.execute(`return await tools.$codemode.search({ query: 'tools.context7["resolve-library-id"]' })`))
- expect(exact.ok).toBe(true)
- if (exact.ok) expect((exact.value as { total: number }).total).toBe(1)
- })
- test("instructions use markdown sections with placeholder-only call forms", () => {
- const runtime = CodeMode.make({ tools })
- const instructions = runtime.instructions()
- // Sections in order: workflow at the top, catalog at the bottom.
- expect(instructions).toContain("## Workflow")
- expect(instructions).toContain("## Rules")
- expect(instructions).toContain("## Syntax")
- expect(instructions.indexOf("## Workflow")).toBeLessThan(instructions.indexOf("## Rules"))
- expect(instructions.indexOf("## Rules")).toBeLessThan(instructions.indexOf("## Syntax"))
- expect(instructions.indexOf("## Syntax")).toBeLessThan(instructions.indexOf("\n## Available tools (COMPLETE list"))
- // The workflow carries the result-shape guidance; Rules only add content beyond it.
- expect(instructions).toContain('`const data = typeof res === "string" ? JSON.parse(res) : res` - most tools return JSON as a string')
- expect(instructions).toContain("Return only the fields you need")
- expect(instructions).toContain("raw payloads get truncated and waste context")
- expect(instructions).toContain("`const res = await tools.<namespace>.<tool>(input)`")
- expect(instructions).toContain("surrounding agent tools are not available unless listed here")
- expect(instructions).toContain("Only tools listed here are available inside `tools`")
- expect(instructions).toContain("bracket notation may appear for names that are not JavaScript identifiers")
- // Placeholders use the <namespace>.<tool>/<field> style ONLY - no fabricated tool
- // names, and no real catalog tools cherry-picked into example lines.
- expect(instructions).toContain("`return { <field>: data.<field> }`")
- expect(instructions).not.toContain("total_count")
- expect(instructions).not.toContain("list_issues")
- expect(instructions).not.toContain("tools.orders.lookup({")
- // COMPLETE: step 1 picks from the inlined list; search is not advertised.
- expect(instructions).toContain("1. Pick a tool from the list under `## Available tools`")
- expect(instructions).not.toContain("Browse one namespace")
- const partial = CodeMode.make({ tools, discovery: { maxInlineCatalogTokens: 0 } }).instructions()
- // PARTIAL: the workflow starts with search (with query-style guidance that is clearly
- // a query string, never a tool name) and the browse-namespace rule appears.
- expect(partial).toContain(
- '1. Find a tool (skip when it is already listed below): `const { items } = await tools.$codemode.search({ query: "<intent + key nouns>" })` - short phrases like "list issues" work best.',
- )
- expect(partial).toContain("Only tools listed here or returned by `tools.$codemode.search` are available inside `tools`")
- expect(partial).toContain('- Browse one namespace: `await tools.$codemode.search({ query: "", namespace: "<name>" })`.')
- expect(partial).not.toContain("total_count")
- expect(partial).not.toContain("tools.orders.lookup({")
- })
- test("the syntax section names what is unusual or missing, not an allowlist", () => {
- const instructions = CodeMode.make({ tools }).instructions()
- // Models already know JavaScript; the section leads with that.
- expect(instructions).toContain("Standard modern JavaScript works")
- expect(instructions).toContain("TypeScript type annotations are allowed and stripped before execution")
- // The not-supported list is derived from (and verified against) the interpreter.
- expect(instructions).toContain("Not supported")
- for (const missing of ["classes", "generators", "for await...of", ".then/.catch/.finally"]) {
- expect(instructions).toContain(missing)
- }
- // Implemented by the DSL-expansion pass, so no longer listed as missing.
- expect(instructions).not.toContain("instanceof Error")
- expect(instructions).not.toContain("splice")
- // The data-boundary note survives.
- expect(instructions).toContain("Dates serialize to ISO strings at data boundaries; Map/Set/RegExp serialize to `{}`.")
- })
- test("zero tools keep minimal sections and the no-tools notice", () => {
- const runtime = CodeMode.make({})
- const instructions = runtime.instructions()
- expect(instructions).toContain("No tools are currently available.")
- expect(instructions).toContain("## Syntax")
- expect(instructions).toContain("## Available tools")
- expect(instructions).not.toContain("## Workflow")
- expect(instructions).not.toContain("## Rules")
- expect(instructions).not.toMatch(/\$codemode/)
- })
- test("uses one ranked search returning complete definitions for large catalogs", async () => {
- const upload = Tool.make({
- description: "Upload one readable local file to the current Discord thread",
- input: Schema.Struct({ path: Schema.String }),
- output: Schema.Struct({ sent: Schema.Boolean }),
- run: () => Effect.succeed({ sent: true }),
- })
- const generate = Tool.make({
- description: "Generate an image and upload it to the current Discord thread",
- input: Schema.Struct({ prompt: Schema.String }),
- output: Schema.Struct({ sent: Schema.Boolean }),
- run: () => Effect.succeed({ sent: true }),
- })
- const runtime = CodeMode.make({
- tools: { thread: { uploadFile: upload, generateImage: generate }, orders: { lookup } },
- discovery: { maxInlineCatalogTokens: 0 },
- })
- expect(runtime.instructions()).toContain("Available tools (PARTIAL - 0 of 3 shown; find the rest with tools.$codemode.search)")
- expect(runtime.instructions()).toContain("- thread (2 tools, none shown)")
- expect(runtime.instructions()).toContain("- orders (1 tool, none shown)")
- expect(runtime.instructions()).toMatch(/\$codemode\.search/)
- expect(runtime.instructions()).not.toMatch(/tools\.thread\.uploadFile\(input/)
- const result = await Effect.runPromise(runtime.execute(`
- return await tools.$codemode.search({
- query: "send message attachment upload file to current Discord thread",
- limit: 2
- })
- `))
- expect(result.ok).toBe(true)
- if (!result.ok) return
- expect(result.value).toStrictEqual({
- items: [
- {
- path: "tools.thread.uploadFile",
- description: "Upload one readable local file to the current Discord thread",
- signature: "tools.thread.uploadFile(input: {\n path: string\n}): Promise<{\n sent: boolean\n}>",
- },
- {
- path: "tools.thread.generateImage",
- description: "Generate an image and upload it to the current Discord thread",
- signature: "tools.thread.generateImage(input: {\n prompt: string\n}): Promise<{\n sent: boolean\n}>",
- },
- ],
- total: 2,
- })
- expect(result.toolCalls).toStrictEqual([{ name: "$codemode.search" }])
- const variants = await Effect.runPromise(runtime.execute(`
- return await Promise.all([
- tools.$codemode.search({ query: "file" }),
- tools.$codemode.search({ query: "image" })
- ])
- `))
- expect(variants.ok).toBe(true)
- if (variants.ok) {
- expect((variants.value as Array<{ items: Array<{ path: string }> }>)[0]?.items[0]?.path).toBe("tools.thread.uploadFile")
- expect((variants.value as Array<{ items: Array<{ path: string }> }>)[1]?.items[0]?.path).toBe("tools.thread.generateImage")
- }
- const removed = await Effect.runPromise(runtime.execute(`return await tools.$codemode.describe({ path: "thread.uploadFile" })`))
- expect(removed.ok).toBe(false)
- if (!removed.ok) expect(removed.error.kind).toBe("UnknownTool")
- })
- test("search defaults to 10 results and resolves exact tool paths", async () => {
- const tool = (index: number) =>
- Tool.make({
- description: `Numbered tool ${index}`,
- input: Schema.Struct({ id: Schema.String }),
- output: Schema.String,
- run: () => Effect.succeed("ok"),
- })
- const runtime = CodeMode.make({
- tools: {
- many: Object.fromEntries(Array.from({ length: 14 }, (_, index) => [`tool${index}`, tool(index)])),
- },
- })
- const browse = await Effect.runPromise(runtime.execute(`return await tools.$codemode.search({})`))
- expect(browse.ok).toBe(true)
- if (browse.ok) {
- const value = browse.value as { items: Array<{ path: string }>; total: number }
- expect(value.items).toHaveLength(10)
- expect(value.total).toBe(14)
- }
- for (const query of ["many.tool13", "tools.many.tool13"]) {
- const exact = await Effect.runPromise(runtime.execute(`return await tools.$codemode.search({ query: ${JSON.stringify(query)} })`))
- expect(exact.ok).toBe(true)
- if (exact.ok) {
- expect(exact.value).toStrictEqual({
- items: [{
- path: "tools.many.tool13",
- description: "Numbered tool 13",
- signature: "tools.many.tool13(input: {\n id: string\n}): Promise<string>",
- }],
- total: 1,
- })
- }
- }
- })
- test("scopes search to one namespace and browses it alphabetically", async () => {
- const simple = (description: string) =>
- Tool.make({
- description,
- input: Schema.Struct({ id: Schema.String }),
- output: Schema.String,
- run: () => Effect.succeed("ok"),
- })
- const runtime = CodeMode.make({
- tools: {
- github: { list_issues: simple("List issues"), create_issue: simple("Create an issue") },
- linear: { list_issues: simple("List Linear issues") },
- },
- })
- // Empty query + namespace browses just that namespace, alphabetical by path.
- const browse = await Effect.runPromise(runtime.execute(
- `return await tools.$codemode.search({ query: "", namespace: "github" })`,
- ))
- expect(browse.ok).toBe(true)
- if (browse.ok) {
- const value = browse.value as { items: Array<{ path: string }>; total: number }
- expect(value.total).toBe(2)
- expect(value.items.map((item) => item.path)).toStrictEqual(["tools.github.create_issue", "tools.github.list_issues"])
- }
- // A query + namespace ranks within that namespace only.
- const scoped = await Effect.runPromise(runtime.execute(
- `return await tools.$codemode.search({ query: "issues", namespace: "linear" })`,
- ))
- expect(scoped.ok).toBe(true)
- if (scoped.ok) {
- const value = scoped.value as { items: Array<{ path: string }>; total: number }
- expect(value.total).toBe(1)
- expect(value.items[0]?.path).toBe("tools.linear.list_issues")
- }
- const invalid = await Effect.runPromise(runtime.execute(
- `return await tools.$codemode.search({ query: "issues", namespace: 7 })`,
- ))
- expect(invalid.ok).toBe(false)
- if (!invalid.ok) expect(invalid.error.kind).toBe("InvalidToolInput")
- })
- test("matches input parameter names and partial-word substrings", async () => {
- const upload = Tool.make({
- description: "Send a document to the workspace",
- input: {
- type: "object",
- properties: { attachment: { type: "string", description: "Local path of the payload to send" } },
- required: ["attachment"],
- },
- run: () => Effect.succeed("ok"),
- })
- const other = Tool.make({
- description: "Rename the workspace",
- input: Schema.Struct({ name: Schema.String }),
- output: Schema.String,
- run: () => Effect.succeed("ok"),
- })
- const runtime = CodeMode.make({ tools: { files: { upload, other } } })
- // "attachment" appears in neither path nor description - only in the input schema's
- // property names, which the searchable text includes.
- const byParameter = await Effect.runPromise(runtime.execute(
- `return await tools.$codemode.search({ query: "attachment" })`,
- ))
- expect(byParameter.ok).toBe(true)
- if (byParameter.ok) {
- const value = byParameter.value as { items: Array<{ path: string }>; total: number }
- expect(value.total).toBe(1)
- expect(value.items[0]?.path).toBe("tools.files.upload")
- }
- // Substring matching: a partial word ("docum") still hits the description.
- const bySubstring = await Effect.runPromise(runtime.execute(
- `return await tools.$codemode.search({ query: "docum" })`,
- ))
- expect(bySubstring.ok).toBe(true)
- if (bySubstring.ok) {
- const value = bySubstring.value as { items: Array<{ path: string }>; total: number }
- expect(value.total).toBe(1)
- expect(value.items[0]?.path).toBe("tools.files.upload")
- }
- })
- test("a plural query term matches singular-only tool text", async () => {
- const simple = (description: string) =>
- Tool.make({
- description,
- input: Schema.Struct({ id: Schema.String }),
- output: Schema.String,
- run: () => Effect.succeed("ok"),
- })
- const runtime = CodeMode.make({
- tools: {
- // Neither path nor description contains "issues" - only the singular "issue".
- tracker: { fetch_all: simple("Fetch every open issue in the project") },
- github: { list_issues: simple("List issues") },
- misc: { rename: simple("Rename the workspace") },
- },
- })
- // "issues" still finds the singular-only tool (term OR singular(term) per field)...
- const plural = await Effect.runPromise(runtime.execute(
- `return await tools.$codemode.search({ query: "issues", namespace: "tracker" })`,
- ))
- expect(plural.ok).toBe(true)
- if (plural.ok) {
- const value = plural.value as { items: Array<{ path: string }>; total: number }
- expect(value.total).toBe(1)
- expect(value.items[0]?.path).toBe("tools.tracker.fetch_all")
- }
- // ...while a true "issues" path match still outranks the singular-only description match.
- const ranked = await Effect.runPromise(runtime.execute(
- `return await tools.$codemode.search({ query: "issues" })`,
- ))
- expect(ranked.ok).toBe(true)
- if (ranked.ok) {
- const value = ranked.value as { items: Array<{ path: string }>; total: number }
- expect(value.total).toBe(2)
- expect(value.items.map((item) => item.path)).toStrictEqual(["tools.github.list_issues", "tools.tracker.fetch_all"])
- }
- })
- test("empty query lists everything alphabetically by path", async () => {
- const simple = (description: string) =>
- Tool.make({
- description,
- input: Schema.Struct({}),
- output: Schema.String,
- run: () => Effect.succeed("ok"),
- })
- // Deliberately declared out of alphabetical order.
- const runtime = CodeMode.make({
- tools: {
- zeta: { last: simple("Last") },
- alpha: { beta: simple("Middle"), aardvark: simple("First") },
- },
- })
- const browse = await Effect.runPromise(runtime.execute(`return await tools.$codemode.search({})`))
- expect(browse.ok).toBe(true)
- if (browse.ok) {
- const value = browse.value as { items: Array<{ path: string }>; total: number }
- expect(value.items.map((item) => item.path)).toStrictEqual([
- "tools.alpha.aardvark",
- "tools.alpha.beta",
- "tools.zeta.last",
- ])
- }
- })
- test("inlines round-robin across namespaces so one expensive namespace cannot starve the rest", () => {
- const cheap = Tool.make({
- description: "Cheap",
- input: Schema.Struct({ q: Schema.String }),
- output: Schema.String,
- run: () => Effect.succeed("ok"),
- })
- const expensive = Tool.make({
- description: "An expensive tool whose description alone consumes far more than the remaining inline catalog byte budget for this runtime",
- input: Schema.Struct({ someRatherLongParameterName: Schema.String, anotherEvenLongerParameterName: Schema.Number }),
- output: Schema.String,
- run: () => Effect.succeed("ok"),
- })
- // Round 1 places alpha.cheap (~17 estimated tokens) and beta.cheap (~17); in round 2
- // alpha.expensive does not fit, which marks only alpha done - it must NOT prevent
- // other namespaces from inlining (beta already got its line in the same round).
- const runtime = CodeMode.make({
- tools: { alpha: { cheap, expensive }, beta: { cheap } },
- discovery: { maxInlineCatalogTokens: 40 },
- })
- const instructions = runtime.instructions()
- expect(instructions).toContain("Available tools (PARTIAL - 2 of 3 shown; find the rest with tools.$codemode.search)")
- expect(instructions).toContain("- alpha (2 tools, 1 shown)")
- expect(instructions).toContain(" - tools.alpha.cheap(input: { q: string }): Promise<string> // Cheap")
- expect(instructions).not.toContain("tools.alpha.expensive(")
- // Fully shown namespaces read cleanly (no "shown" annotation).
- expect(instructions).toContain("- beta (1 tool)")
- expect(instructions).toContain(" - tools.beta.cheap(input: { q: string }): Promise<string> // Cheap")
- expect(instructions).toMatch(/\$codemode\.search/)
- })
- test("decodes tool input and output before exposing either side", async () => {
- const observed: Array<unknown> = []
- const transformed = Tool.make({
- description: "Double a number",
- input: Schema.Struct({ value: Schema.NumberFromString }),
- output: Schema.NumberFromString,
- run: ({ value }) => Effect.sync(() => {
- observed.push(value)
- return String(value * 2)
- }),
- })
- const runtime = CodeMode.make({
- tools: { math: { double: transformed } },
- onToolCallStart: (call) => Effect.sync(() => observed.push(call.input)),
- })
- const success = await Effect.runPromise(runtime.execute(`return await tools.math.double({ value: "21" })`))
- expect(success).toStrictEqual({ ok: true, value: 42, toolCalls: [{ name: "math.double" }] })
- expect(observed).toStrictEqual([{ value: 21 }, 21])
- const invalid = await Effect.runPromise(runtime.execute(`return await tools.math.double({ value: 21 })`))
- expect(invalid.ok).toBe(false)
- if (invalid.ok) return
- expect(invalid.error.kind).toBe("InvalidToolInput")
- expect(observed).toStrictEqual([{ value: 21 }, 21])
- })
- test("returns JSON-safe data and normalizes undefined to null", async () => {
- const result = await Effect.runPromise(CodeMode.execute({
- code: `return { top: undefined, nested: [1, undefined] }`,
- }))
- expect(result).toStrictEqual({
- ok: true,
- value: { top: null, nested: [1, null] },
- toolCalls: [],
- })
- expect(Schema.decodeUnknownSync(ExecuteResultSchema)(JSON.parse(JSON.stringify(result)))).toStrictEqual(result)
- })
- test("rejects invalid configuration and discovery limits", async () => {
- expect(() => CodeMode.execute({ code: "return 1", limits: { timeoutMs: 0 } })).toThrow(RangeError)
- expect(() => CodeMode.execute({ code: "return 1", limits: { timeoutMs: Number.POSITIVE_INFINITY } })).toThrow(RangeError)
- expect(() => CodeMode.execute({ code: "return 1", limits: { maxToolCalls: -1 } })).toThrow(RangeError)
- expect(() => CodeMode.execute({ code: "return 1", limits: { maxOutputBytes: -1 } })).toThrow(RangeError)
- expect(() => CodeMode.make({ tools, discovery: { maxInlineCatalogTokens: -1 } })).toThrow(RangeError)
- const result = await Effect.runPromise(CodeMode.make({
- tools,
- discovery: { maxInlineCatalogTokens: 0 },
- }).execute(
- `return await tools.$codemode.search({ query: "order", limit: 0.5 })`,
- ))
- expect(result.ok).toBe(false)
- if (result.ok) return
- expect(result.error.kind).toBe("InvalidToolInput")
- })
- test("enforces the tool-call limit as a diagnostic", async () => {
- const result = await Effect.runPromise(CodeMode.execute({ tools, code: source, limits: { maxToolCalls: 0 } }))
- expect(result.ok).toBe(false)
- if (!result.ok) expect(result.error.kind).toBe("ToolCallLimitExceeded")
- })
- test("timeoutMs and maxToolCalls have no defaults: absent means unlimited", async () => {
- // 150 tool calls would have exceeded the old default cap of 100; with no limits
- // provided, there is no cap and no timeout - budgets are host policy.
- const counter = Tool.make({
- description: "Count invocations",
- input: Schema.Struct({}),
- output: Schema.Number,
- run: () => Effect.succeed(1),
- })
- const result = await Effect.runPromise(CodeMode.execute({
- tools: { host: { count: counter } },
- code: `
- let total = 0
- for (let i = 0; i < 150; i += 1) total += await tools.host.count({})
- return total
- `,
- }))
- expect(result).toMatchObject({ ok: true, value: 150 })
- if (result.ok) expect(result.toolCalls.length).toBe(150)
- })
- test("the timeout interrupts a busy loop without any operation budget", async () => {
- // Regression: timeout interruption must not depend on interpreter-side work accounting.
- // The Effect fiber runtime auto-yields between interpreter steps, so a pure `while
- // (true) {}` loop is interrupted by `timeoutMs` alone.
- const startedAt = Date.now()
- const result = await Effect.runPromise(CodeMode.execute({ code: "while (true) {}", limits: { timeoutMs: 200 } }))
- const elapsedMs = Date.now() - startedAt
- expect(result.ok).toBe(false)
- if (!result.ok) {
- expect(result.error.kind).toBe("TimeoutExceeded")
- expect(result.error.message).toContain("timed out after 200ms")
- }
- expect(elapsedMs).toBeLessThan(3_000)
- })
- test("reserves the discovery namespace", () => {
- expect(() => CodeMode.make({ tools: { $codemode: { lookup } } })).toThrow(
- /reserved for CodeMode discovery tools/,
- )
- })
- })
|