httpapi-error-middleware.test.ts 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101
  1. import { NodeHttpServer, NodeServices } from "@effect/platform-node"
  2. import { NamedError } from "@kirincode-ai/core/util/error"
  3. import { describe, expect } from "bun:test"
  4. import { ConfigErrorV1 } from "@kirincode-ai/core/v1/config/error"
  5. import { Effect, Layer } from "effect"
  6. import { HttpClient, HttpClientRequest, HttpRouter } from "effect/unstable/http"
  7. import { errorLayer } from "../../src/server/routes/instance/httpapi/middleware/error"
  8. import { NotFoundError } from "../../src/storage/storage"
  9. import { testEffect } from "../lib/effect"
  10. const it = testEffect(Layer.mergeAll(NodeHttpServer.layerTest, NodeServices.layer))
  11. function expectUnknownErrorBody(body: unknown) {
  12. expect(body).toMatchObject({
  13. name: "UnknownError",
  14. data: { message: "Unexpected server error. Check server logs for details." },
  15. })
  16. expect((body as { data?: { ref?: unknown } }).data?.ref).toMatch(/^err_[0-9a-f-]{8}$/)
  17. }
  18. describe("HttpApi error middleware", () => {
  19. it.live("returns a safe body for unknown 500 defects", () =>
  20. Effect.gen(function* () {
  21. yield* HttpRouter.add("GET", "/boom", Effect.die(new Error("secret stack marker"))).pipe(
  22. Layer.provide(errorLayer),
  23. HttpRouter.serve,
  24. Layer.build,
  25. )
  26. const response = yield* HttpClientRequest.get("/boom").pipe(HttpClient.execute)
  27. const body = yield* response.json
  28. expect(response.status).toBe(500)
  29. expectUnknownErrorBody(body)
  30. expect(JSON.stringify(body)).not.toContain("secret stack marker")
  31. }),
  32. )
  33. it.live("returns a safe body for named defects", () =>
  34. Effect.gen(function* () {
  35. yield* HttpRouter.add(
  36. "GET",
  37. "/named",
  38. Effect.die(new NamedError.Unknown({ message: "secret named marker" })),
  39. ).pipe(Layer.provide(errorLayer), HttpRouter.serve, Layer.build)
  40. const response = yield* HttpClientRequest.get("/named").pipe(HttpClient.execute)
  41. const body = yield* response.json
  42. expect(response.status).toBe(500)
  43. expectUnknownErrorBody(body)
  44. expect(JSON.stringify(body)).not.toContain("secret named marker")
  45. }),
  46. )
  47. it.live("returns invalid config defects as structured client errors", () =>
  48. Effect.gen(function* () {
  49. const configError = new ConfigErrorV1.InvalidError({
  50. path: "/tmp/kirincode.json",
  51. issues: [{ message: "Expected object", path: ["provider", "anthropic", "options"] }],
  52. })
  53. yield* HttpRouter.add("GET", "/config-error", Effect.die(configError)).pipe(
  54. Layer.provide(errorLayer),
  55. HttpRouter.serve,
  56. Layer.build,
  57. )
  58. const response = yield* HttpClientRequest.get("/config-error").pipe(HttpClient.execute)
  59. const body = yield* response.json
  60. const serialized = JSON.stringify(body)
  61. expect(response.status).toBe(400)
  62. expect(body).toMatchObject({
  63. name: "ConfigInvalidError",
  64. data: {
  65. path: "/tmp/kirincode.json",
  66. issues: [{ message: "Expected object", path: ["provider", "anthropic", "options"] }],
  67. },
  68. })
  69. expect(serialized).toContain("/tmp/kirincode.json")
  70. expect(serialized).toContain("anthropic")
  71. }),
  72. )
  73. it.live("does not map storage not-found defects to 404", () =>
  74. Effect.gen(function* () {
  75. yield* HttpRouter.add(
  76. "GET",
  77. "/missing",
  78. Effect.die(new NotFoundError({ message: "Resource not found: secret" })),
  79. ).pipe(Layer.provide(errorLayer), HttpRouter.serve, Layer.build)
  80. const response = yield* HttpClientRequest.get("/missing").pipe(HttpClient.execute)
  81. const body = yield* response.json
  82. expect(response.status).toBe(500)
  83. expectUnknownErrorBody(body)
  84. }),
  85. )
  86. })