executor.test.ts 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400
  1. import { describe, expect } from "bun:test"
  2. import { Effect, Layer, Ref } from "effect"
  3. import { Headers, HttpClient, HttpClientRequest, HttpClientResponse } from "effect/unstable/http"
  4. import { LLM, LLMError } from "../src"
  5. import { LLMClient, RequestExecutor } from "../src/route"
  6. import * as OpenAIChat from "../src/protocols/openai-chat"
  7. import { dynamicResponse } from "./lib/http"
  8. import { deltaChunk } from "./lib/openai-chunks"
  9. import { sseRaw } from "./lib/sse"
  10. import { it } from "./lib/effect"
  11. const request = HttpClientRequest.post("https://provider.test/v1/chat?api_key=secret&key=secret&debug=1").pipe(
  12. HttpClientRequest.setHeaders(Headers.fromInput({ authorization: "Bearer secret", "x-safe": "visible" })),
  13. )
  14. const secretRequest = HttpClientRequest.post("https://provider.test/v1/chat?api_key=query-secret-123&debug=1").pipe(
  15. HttpClientRequest.setHeaders(Headers.fromInput({ authorization: "Bearer header-secret-456" })),
  16. )
  17. const responsesLayer = (responses: ReadonlyArray<Response>) =>
  18. RequestExecutor.layer.pipe(
  19. Layer.provide(
  20. Layer.unwrap(
  21. Effect.gen(function* () {
  22. const cursor = yield* Ref.make(0)
  23. return Layer.succeed(
  24. HttpClient.HttpClient,
  25. HttpClient.make((request) =>
  26. Effect.gen(function* () {
  27. const index = yield* Ref.getAndUpdate(cursor, (value) => value + 1)
  28. return HttpClientResponse.fromWeb(request, responses[index] ?? responses[responses.length - 1])
  29. }),
  30. ),
  31. )
  32. }),
  33. ),
  34. ),
  35. )
  36. const countedResponsesLayer = (attempts: Ref.Ref<number>, responses: ReadonlyArray<Response>) =>
  37. RequestExecutor.layer.pipe(
  38. Layer.provide(
  39. Layer.unwrap(
  40. Effect.gen(function* () {
  41. const cursor = yield* Ref.make(0)
  42. return Layer.succeed(
  43. HttpClient.HttpClient,
  44. HttpClient.make((request) =>
  45. Effect.gen(function* () {
  46. yield* Ref.update(attempts, (value) => value + 1)
  47. const index = yield* Ref.getAndUpdate(cursor, (value) => value + 1)
  48. return HttpClientResponse.fromWeb(request, responses[index] ?? responses[responses.length - 1])
  49. }),
  50. ),
  51. )
  52. }),
  53. ),
  54. ),
  55. )
  56. const expectLLMError = (error: unknown) => {
  57. expect(error).toBeInstanceOf(LLMError)
  58. if (!(error instanceof LLMError)) throw new Error("expected LLMError")
  59. return error
  60. }
  61. const errorHttp = (error: LLMError) => ("http" in error.reason ? error.reason.http : undefined)
  62. describe("RequestExecutor", () => {
  63. it.effect("classifies context overflow responses", () =>
  64. Effect.gen(function* () {
  65. const executor = yield* RequestExecutor.Service
  66. const error = yield* executor.execute(request).pipe(Effect.flip)
  67. expectLLMError(error)
  68. expect(error.reason).toMatchObject({ _tag: "InvalidRequest", classification: "context-overflow" })
  69. }).pipe(
  70. Effect.provide(
  71. responsesLayer([
  72. new Response('{"error":{"code":"context_length_exceeded","message":"prompt too long"}}', {
  73. status: 400,
  74. }),
  75. ]),
  76. ),
  77. ),
  78. )
  79. it.effect("does not classify generic HTTP 413 payload errors as context overflow", () =>
  80. Effect.gen(function* () {
  81. const executor = yield* RequestExecutor.Service
  82. const error = yield* executor.execute(request).pipe(Effect.flip)
  83. expectLLMError(error)
  84. expect(error.reason).toMatchObject({ _tag: "InvalidRequest" })
  85. expect("classification" in error.reason ? error.reason.classification : undefined).toBeUndefined()
  86. }).pipe(Effect.provide(responsesLayer([new Response("request too large", { status: 413 })]))),
  87. )
  88. it.effect("does not classify ordinary invalid requests as context overflow", () =>
  89. Effect.gen(function* () {
  90. const executor = yield* RequestExecutor.Service
  91. const error = yield* executor.execute(request).pipe(Effect.flip)
  92. expectLLMError(error)
  93. expect(error.reason).toMatchObject({ _tag: "InvalidRequest" })
  94. expect("classification" in error.reason ? error.reason.classification : undefined).toBeUndefined()
  95. }).pipe(Effect.provide(responsesLayer([new Response("invalid parameter", { status: 400 })]))),
  96. )
  97. it.effect("classifies provider rate limits hidden behind HTTP 400", () =>
  98. Effect.gen(function* () {
  99. const classify = (body: string) =>
  100. Effect.gen(function* () {
  101. const executor = yield* RequestExecutor.Service
  102. const error = yield* executor.execute(request).pipe(Effect.flip)
  103. expectLLMError(error)
  104. expect(error.reason).toMatchObject({ _tag: "RateLimit" })
  105. }).pipe(Effect.provide(responsesLayer([new Response(body, { status: 400 })])))
  106. yield* classify("Request rate increased too quickly")
  107. yield* classify('{"type":"error","error":{"type":"too_many_requests"}}')
  108. yield* classify('{"type":"error","error":{"code":"rate_limit_exceeded"}}')
  109. }),
  110. )
  111. it.effect("classifies provider overloads hidden behind HTTP 400", () =>
  112. Effect.gen(function* () {
  113. const classify = (body: string) =>
  114. Effect.gen(function* () {
  115. const executor = yield* RequestExecutor.Service
  116. const error = yield* executor.execute(request).pipe(Effect.flip)
  117. expectLLMError(error)
  118. expect(error.reason).toMatchObject({ _tag: "ProviderInternal" })
  119. }).pipe(Effect.provide(responsesLayer([new Response(body, { status: 400 })])))
  120. yield* classify('{"code":"resource_exhausted"}')
  121. yield* classify('{"code":"service_unavailable"}')
  122. }),
  123. )
  124. it.effect("returns redacted diagnostics for rate limits", () =>
  125. Effect.gen(function* () {
  126. const executor = yield* RequestExecutor.Service
  127. const error = yield* executor.execute(request).pipe(Effect.flip)
  128. expectLLMError(error)
  129. expect(error).toMatchObject({
  130. reason: {
  131. _tag: "RateLimit",
  132. retryAfterMs: 0,
  133. rateLimit: { retryAfterMs: 0 },
  134. http: {
  135. requestId: "req_123",
  136. request: {
  137. method: "POST",
  138. url: "https://provider.test/v1/chat?api_key=%3Credacted%3E&key=%3Credacted%3E&debug=1",
  139. headers: { authorization: "<redacted>", "x-safe": "visible" },
  140. },
  141. response: {
  142. status: 429,
  143. headers: {
  144. "retry-after-ms": "0",
  145. "x-request-id": "req_123",
  146. "x-api-key": "<redacted>",
  147. },
  148. },
  149. },
  150. },
  151. })
  152. expect(errorHttp(error)?.body).toBe("rate limited")
  153. }).pipe(
  154. Effect.provide(
  155. responsesLayer([
  156. new Response("rate limited", {
  157. status: 429,
  158. headers: { "retry-after-ms": "0", "x-request-id": "req_123", "x-api-key": "secret" },
  159. }),
  160. ]),
  161. ),
  162. ),
  163. )
  164. it.effect("honors current redacted header names in diagnostics", () =>
  165. Effect.gen(function* () {
  166. const executor = yield* RequestExecutor.Service
  167. const error = yield* executor.execute(request).pipe(Effect.flip)
  168. expectLLMError(error)
  169. expect(errorHttp(error)?.request.headers["x-safe"]).toBe("<redacted>")
  170. expect(errorHttp(error)?.response?.headers["x-safe"]).toBe("<redacted>")
  171. }).pipe(
  172. Effect.provide(responsesLayer([new Response("bad", { status: 400, headers: { "x-safe": "response-secret" } })])),
  173. Effect.provideService(Headers.CurrentRedactedNames, ["x-safe"]),
  174. ),
  175. )
  176. it.effect("extracts OpenAI-style rate-limit diagnostics", () =>
  177. Effect.gen(function* () {
  178. const executor = yield* RequestExecutor.Service
  179. const error = yield* executor.execute(request).pipe(Effect.flip)
  180. expectLLMError(error)
  181. expect(error.reason).toMatchObject({ _tag: "RateLimit" })
  182. expect(error.reason._tag === "RateLimit" ? error.reason.rateLimit : undefined).toEqual({
  183. retryAfterMs: 0,
  184. limit: { requests: "500", tokens: "30000" },
  185. remaining: { requests: "499", tokens: "29900" },
  186. reset: { requests: "1s", tokens: "10s" },
  187. })
  188. }).pipe(
  189. Effect.provide(
  190. responsesLayer([
  191. new Response("rate limited", {
  192. status: 429,
  193. headers: {
  194. "retry-after-ms": "0",
  195. "x-ratelimit-limit-requests": "500",
  196. "x-ratelimit-limit-tokens": "30000",
  197. "x-ratelimit-remaining-requests": "499",
  198. "x-ratelimit-remaining-tokens": "29900",
  199. "x-ratelimit-reset-requests": "1s",
  200. "x-ratelimit-reset-tokens": "10s",
  201. },
  202. }),
  203. ]),
  204. ),
  205. ),
  206. )
  207. it.effect("extracts Anthropic-style rate-limit diagnostics", () =>
  208. Effect.gen(function* () {
  209. const executor = yield* RequestExecutor.Service
  210. const error = yield* executor.execute(request).pipe(Effect.flip)
  211. expectLLMError(error)
  212. expect(error.reason).toMatchObject({ _tag: "ProviderInternal" })
  213. expect(errorHttp(error)?.rateLimit).toEqual({
  214. retryAfterMs: 0,
  215. limit: { requests: "100", "input-tokens": "10000" },
  216. remaining: { requests: "12", "input-tokens": "9000" },
  217. reset: { requests: "2026-05-06T12:00:00Z", "input-tokens": "2026-05-06T12:00:10Z" },
  218. })
  219. }).pipe(
  220. Effect.provide(
  221. responsesLayer([
  222. new Response("overloaded", {
  223. status: 529,
  224. headers: {
  225. "retry-after-ms": "0",
  226. "anthropic-ratelimit-requests-limit": "100",
  227. "anthropic-ratelimit-requests-remaining": "12",
  228. "anthropic-ratelimit-requests-reset": "2026-05-06T12:00:00Z",
  229. "anthropic-ratelimit-input-tokens-limit": "10000",
  230. "anthropic-ratelimit-input-tokens-remaining": "9000",
  231. "anthropic-ratelimit-input-tokens-reset": "2026-05-06T12:00:10Z",
  232. },
  233. }),
  234. ]),
  235. ),
  236. ),
  237. )
  238. it.effect("returns provider status failures without retrying", () =>
  239. Effect.gen(function* () {
  240. const attempts = yield* Ref.make(0)
  241. const error = yield* Effect.gen(function* () {
  242. const executor = yield* RequestExecutor.Service
  243. return yield* executor.execute(request).pipe(Effect.flip)
  244. }).pipe(
  245. Effect.provide(
  246. countedResponsesLayer(attempts, [
  247. new Response("busy", { status: 503, headers: { "retry-after-ms": "0" } }),
  248. new Response("ok", { status: 200 }),
  249. ]),
  250. ),
  251. )
  252. expectLLMError(error)
  253. expect(error.reason).toMatchObject({ _tag: "ProviderInternal", status: 503 })
  254. expect(yield* Ref.get(attempts)).toBe(1)
  255. }),
  256. )
  257. it.effect("marks 504 and 529 status responses as provider-internal", () =>
  258. Effect.gen(function* () {
  259. const failWith = (status: number) =>
  260. Effect.gen(function* () {
  261. const executor = yield* RequestExecutor.Service
  262. const error = yield* executor.execute(request).pipe(Effect.flip)
  263. expectLLMError(error)
  264. expect(error.reason).toMatchObject({ _tag: "ProviderInternal", status })
  265. }).pipe(
  266. Effect.provide(
  267. responsesLayer([
  268. new Response("provider failure", {
  269. status,
  270. headers: { "retry-after-ms": "0" },
  271. }),
  272. ]),
  273. ),
  274. )
  275. yield* failWith(504)
  276. yield* failWith(529)
  277. }),
  278. )
  279. it.effect("truncates large authentication error bodies", () =>
  280. Effect.gen(function* () {
  281. const executor = yield* RequestExecutor.Service
  282. const error = yield* executor.execute(request).pipe(Effect.flip)
  283. expectLLMError(error)
  284. expect(error.reason).toMatchObject({ _tag: "Authentication" })
  285. expect(errorHttp(error)?.bodyTruncated).toBe(true)
  286. expect(errorHttp(error)?.body).toHaveLength(16_384)
  287. }).pipe(
  288. Effect.provide(
  289. responsesLayer([
  290. new Response("x".repeat(20_000), { status: 401 }),
  291. new Response("should not retry", { status: 200 }),
  292. ]),
  293. ),
  294. ),
  295. )
  296. it.effect("redacts common secret fields in response bodies", () =>
  297. Effect.gen(function* () {
  298. const executor = yield* RequestExecutor.Service
  299. const error = yield* executor.execute(request).pipe(Effect.flip)
  300. expectLLMError(error)
  301. expect(errorHttp(error)?.body).toContain('"key":"<redacted>"')
  302. expect(errorHttp(error)?.body).toContain("api_key=<redacted>")
  303. expect(errorHttp(error)?.body).not.toContain("body-secret")
  304. expect(errorHttp(error)?.body).not.toContain("query-secret")
  305. }).pipe(
  306. Effect.provide(
  307. responsesLayer([
  308. new Response('{"error":{"message":"bad","key":"body-secret","detail":"api_key=query-secret"}}', {
  309. status: 400,
  310. }),
  311. ]),
  312. ),
  313. ),
  314. )
  315. it.effect("redacts echoed request secret values in response bodies", () =>
  316. Effect.gen(function* () {
  317. const executor = yield* RequestExecutor.Service
  318. const error = yield* executor.execute(secretRequest).pipe(Effect.flip)
  319. expectLLMError(error)
  320. expect(errorHttp(error)?.body).toContain("provider echoed <redacted>")
  321. expect(errorHttp(error)?.body).toContain("authorization <redacted>")
  322. expect(errorHttp(error)?.body).not.toContain("query-secret-123")
  323. expect(errorHttp(error)?.body).not.toContain("header-secret-456")
  324. }).pipe(
  325. Effect.provide(
  326. responsesLayer([
  327. new Response("provider echoed query-secret-123 and authorization header-secret-456", { status: 400 }),
  328. ]),
  329. ),
  330. ),
  331. )
  332. it.effect("does not re-execute after a successful response reaches stream parsing", () =>
  333. Effect.gen(function* () {
  334. const attempts = yield* Ref.make(0)
  335. const model = OpenAIChat.route
  336. .with({ endpoint: { baseURL: "https://api.openai.test/v1" } })
  337. .model({ id: "gpt-4o-mini" })
  338. const error = yield* LLMClient.generate(LLM.request({ model, prompt: "Say hello." })).pipe(
  339. Effect.provide(
  340. dynamicResponse((input) =>
  341. Ref.update(attempts, (value) => value + 1).pipe(
  342. Effect.as(
  343. input.respond(
  344. sseRaw(
  345. `data: ${JSON.stringify(deltaChunk({ role: "assistant", content: "Hello" }))}`,
  346. "data: not-json",
  347. ),
  348. { headers: { "content-type": "text/event-stream" } },
  349. ),
  350. ),
  351. ),
  352. ),
  353. ),
  354. Effect.flip,
  355. )
  356. expectLLMError(error)
  357. expect(error.reason).toMatchObject({ _tag: "InvalidProviderOutput" })
  358. expect(yield* Ref.get(attempts)).toBe(1)
  359. }),
  360. )
  361. })