| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163 |
- import { describe, expect, test } from "bun:test"
- import { Cause, Effect, Schema } from "effect"
- import { CodeMode, Tool, toolError } from "../src/index.js"
- const run = (tool: 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(CodeMode.Result)(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: CodeMode.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(CodeMode.Result)(JSON.parse(JSON.stringify(result)))).toStrictEqual(result)
- })
- test("keeps leading logs within the remaining budget and marks the cut", async () => {
- const limits: CodeMode.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: {\n id: string,\n count?: number,\n}): 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: {\n login: string,\n}): Promise<{\n login: string,\n id: number,\n}>",
- },
- ])
- 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: {\n host: string,\n}): 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 and reusable execution equivalent", async () => {
- const runtime = CodeMode.make({ tools })
- const [oneShot, reusable] = await Promise.all([
- Effect.runPromise(CodeMode.execute({ tools, code: source })),
- Effect.runPromise(runtime.execute(source)),
- ])
- expect(reusable).toStrictEqual(oneShot)
- const input: CodeMode.Input = { code: source }
- expect(Schema.decodeUnknownSync(CodeMode.Input)(input)).toStrictEqual(input)
- expect(Schema.decodeUnknownSync(CodeMode.Result)(JSON.parse(JSON.stringify(reusable)))).toStrictEqual(reusable)
- })
- 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: {\n id: string,\n}): Promise<{\n id: string,\n status: string,\n}>",
- },
- ])
- expect(runtime.instructions()).toContain("Available tools (COMPLETE list")
- expect(runtime.instructions()).toContain("- orders (1 tool)")
- expect(runtime.instructions()).toContain(
- " - tools.orders.lookup(input: {\n id: string,\n}): Promise<{\n id: string,\n status: string,\n}> // 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 with the
- // same signature as the inline catalog.
- 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}>",
- },
- ],
- remaining: 0,
- next: null,
- })
- }
- })
- 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: {\n libraryName: string,\n}): Promise<string>',
- },
- ])
- expect(runtime.instructions()).toContain(
- 'tools.context7["resolve-library-id"](input: {\n libraryName: string,\n}): 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>',
- },
- ],
- remaining: 0,
- next: null,
- })
- }
- 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).toMatchObject({ remaining: 0, next: null })
- })
- 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("## Language")
- expect(instructions.indexOf("## Workflow")).toBeLessThan(instructions.indexOf("## Rules"))
- expect(instructions.indexOf("## Rules")).toBeLessThan(instructions.indexOf("## Language"))
- expect(instructions.indexOf("## Language")).toBeLessThan(
- instructions.indexOf("\n## Available tools (COMPLETE list"),
- )
- expect(instructions).not.toContain("JSON.parse(res)")
- expect(instructions).toContain("Return only the fields you need")
- expect(instructions).toContain("avoid returning large raw payloads")
- expect(instructions).toContain("Do not infer or normalize tool names")
- expect(instructions).toContain("bracket notation and quotes are part of the path")
- expect(instructions).toContain("surrounding agent tools are not available")
- expect(instructions).toContain("Only Code Mode tools listed here and internal runtime tools")
- // Placeholders use generic namespace/tool/field names only - no fabricated real tools
- // and no real catalog tools cherry-picked into example lines.
- expect(instructions).toContain("`const result = await tools.<namespace>.<tool>(input)`")
- expect(instructions).toContain("Return only the fields you need from structured results")
- expect(instructions).toContain("check that it is a non-null object and not an array")
- expect(instructions).not.toContain("result.<field>")
- expect(instructions).not.toContain("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: { catalogBudget: 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. If needed, discover tools: `return await tools.$codemode.search({ query: "<intent + key nouns>" })`.',
- )
- expect(partial).toContain("In the next execution, copy a returned path exactly")
- expect(partial).toContain(
- "Only Code Mode tools listed here or returned by `tools.$codemode.search` and internal runtime tools",
- )
- expect(partial).toContain(
- '- Browse one namespace: `await tools.$codemode.search({ query: "", namespace: "<name>" })`.',
- )
- expect(partial).toContain("repeat the same search with `offset: next.offset`")
- expect(partial).toContain(" limit?: number,\n offset?: number,")
- expect(partial).not.toContain("total_count")
- expect(partial).not.toContain("tools.orders.lookup({")
- })
- test("the language section describes the restricted runtime without overclaiming", () => {
- const instructions = CodeMode.make({ tools }).instructions()
- expect(instructions).toContain("restricted JavaScript language for calling tools")
- expect(instructions).toContain("not a general-purpose runtime")
- expect(instructions).not.toContain("Standard modern JavaScript works")
- expect(instructions).not.toContain("TypeScript type annotations")
- for (const missing of ["Modules/imports", "classes", "generators", "fetch", "promise chaining"]) {
- expect(instructions).toContain(missing)
- }
- expect(instructions).toContain("URL, URLSearchParams, and URI encoding helpers")
- expect(instructions).not.toContain("host globals")
- expect(instructions).toContain("Use Code Mode tools for external operations")
- expect(instructions).toContain(
- "Dates and URLs serialize to strings at data boundaries; Map/Set/RegExp/URLSearchParams 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("## Language")
- 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: { catalogBudget: 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}>",
- },
- ],
- remaining: 0,
- next: null,
- })
- 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 }>
- remaining: number
- next: { offset: number } | null
- }
- expect(value.items).toHaveLength(10)
- expect(value.remaining).toBe(4)
- expect(value.next).toStrictEqual({ offset: 10 })
- }
- 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>",
- },
- ],
- remaining: 0,
- next: null,
- })
- }
- }
- })
- 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 }>; remaining: number }
- expect(value.remaining).toBe(0)
- 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 }>; remaining: number }
- expect(value.remaining).toBe(0)
- 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 }>; remaining: number }
- expect(value.remaining).toBe(0)
- 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 }>; remaining: number }
- expect(value.remaining).toBe(0)
- 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 }>; remaining: number }
- expect(value.remaining).toBe(0)
- 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 }>; remaining: number }
- expect(value.remaining).toBe(0)
- 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 }>; remaining: number; next: unknown }
- expect(value.items.map((item) => item.path)).toStrictEqual([
- "tools.alpha.aardvark",
- "tools.alpha.beta",
- "tools.zeta.last",
- ])
- expect(value.remaining).toBe(0)
- expect(value.next).toBeNull()
- }
- const middle = await Effect.runPromise(
- runtime.execute(`return await tools.$codemode.search({ limit: 1, offset: 1 })`),
- )
- expect(middle.ok).toBe(true)
- if (middle.ok) {
- expect(middle.value).toMatchObject({
- items: [{ path: "tools.alpha.beta" }],
- remaining: 1,
- next: { offset: 2 },
- })
- }
- const exhausted = await Effect.runPromise(
- runtime.execute(`return await tools.$codemode.search({ limit: 1, offset: 3 })`),
- )
- expect(exhausted.ok).toBe(true)
- if (exhausted.ok) expect(exhausted.value).toStrictEqual({ items: [], remaining: 0, next: null })
- })
- 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: { catalogBudget: 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: {\n q: string,\n}): 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: {\n q: string,\n}): Promise<string> // Cheap")
- expect(instructions).toMatch(/\$codemode\.search/)
- })
- test("charges inline JSDoc against the catalog token budget", () => {
- const documented = Tool.make({
- description: "Look up a record",
- input: {
- type: "object",
- properties: {
- id: { type: "string", description: "A detailed identifier description. ".repeat(20) },
- },
- required: ["id"],
- } as const,
- run: () => Effect.succeed("ok"),
- })
- const runtime = CodeMode.make({
- tools: { records: { lookup: documented } },
- discovery: { catalogBudget: 40 },
- })
- expect(runtime.catalog()[0]?.signature).toContain("/** A detailed identifier description.")
- expect(runtime.instructions()).toContain(
- "Available tools (PARTIAL - 0 of 1 shown; find the rest with tools.$codemode.search)",
- )
- expect(runtime.instructions()).not.toContain("tools.records.lookup(input:")
- })
- 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(CodeMode.Result)(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: { catalogBudget: -1 } })).toThrow(RangeError)
- const result = await Effect.runPromise(
- CodeMode.make({
- tools,
- discovery: { catalogBudget: 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")
- for (const offset of [-1, 0.5, Number.MAX_SAFE_INTEGER + 1, "1"]) {
- const invalidOffset = await Effect.runPromise(
- CodeMode.make({ tools }).execute(
- `return await tools.$codemode.search({ query: "order", offset: ${JSON.stringify(offset)} })`,
- ),
- )
- expect(invalidOffset.ok).toBe(false)
- if (!invalidOffset.ok) expect(invalidOffset.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/)
- })
- })
|