simplify error bodies

Author: beeequeue

src/app.ts

@@ -13,7 +13,7 @@ import { logger } from "./lib/logger.js"
 import { v1Routes } from "./routes/v1/ids/handler.js"
 import { v2Routes } from "./routes/v2/ids/handler.js"
 import { thetvdbRoutes } from "./routes/v2/thetvdb/handler.js"
-import { CacheTimes, cacheReply } from "./utils.js"
+import { CacheTimes, cacheReply, createErrorJson } from "./utils.js"
 
 export const createApp = () => {
   const app = new Hono()
@@ -35,13 +35,7 @@ export const createApp = () => {
     .use("*", sentry({ dsn: process.env.SENTRY_DSN! }))
     .use("*", cors({ origin: (origin) => origin }))
     .use("*", secureHeaders())
-    .notFound((c) => {
-      c.status(404)
-      return c.json({
-        error: "Not Found",
-        statusCode: 404,
-      })
-    })
+    .notFound((c) => createErrorJson(c, new HTTPException(404)))
     .onError((error, c) => {
       /* c8 ignore next 4 */
       if (error instanceof HTTPException) {
@@ -51,19 +45,11 @@ export const createApp = () => {
           cacheReply(res, CacheTimes.WEEK)
         }
 
-        c.status(error.status)
-        return c.json({
-          statusCode: error.status,
-          error: error.message,
-        })
+        return createErrorJson(c, error)
       }
 
-      const badImpl = new HTTPException(500, { message: "Internal Server Error", cause: error })
-      c.status(badImpl.status)
-      return c.json({
-        statusCode: badImpl.status,
-        error: badImpl.message,
-      })
+      const badImpl = new HTTPException(500, { cause: error })
+      return createErrorJson(c, badImpl)
     })
     .route("/api", v1Routes)
     .route("/api/v2", v2Routes)

src/utils.ts

@@ -1,4 +1,6 @@
 import type { Context } from "hono"
+import type { HTTPException } from "hono/http-exception"
+import type { StatusCode } from "hono/utils/http-status"
 import type { JSONSchema7 } from "json-schema"
 import type { TypeOf, ZodError, z } from "zod"
 
@@ -15,6 +17,114 @@ export const mergeSchemas = <One extends JSONSchema7, Two extends JSONSchema7>(
   },
 })
 
+type ErrorJson = {
+  code?: string
+  statusCode: number
+  error: string
+  message?: string
+}
+
+const getErrorText = (code: StatusCode) => {
+  switch (code) {
+    case 400:
+      return "Bad Request"
+    case 401:
+      return "Unauthorized"
+    case 403:
+      return "Forbidden"
+    case 404:
+      return "Not Found"
+    case 405:
+      return "Method Not Allowed"
+    case 406:
+      return "Not Acceptable"
+    case 408:
+      return "Request Timeout"
+    case 409:
+      return "Conflict"
+    case 410:
+      return "Gone"
+    case 411:
+      return "Length Required"
+    case 412:
+      return "Precondition Failed"
+    case 413:
+      return "Payload Too Large"
+    case 414:
+      return "URI Too Long"
+    case 415:
+      return "Unsupported Media Type"
+    case 416:
+      return "Range Not Satisfiable"
+    case 417:
+      return "Expectation Failed"
+    case 418:
+      return "I'm a teapot"
+    case 421:
+      return "Misdirected Request"
+    case 422:
+      return "Unprocessable Entity"
+    case 423:
+      return "Locked"
+    case 424:
+      return "Failed Dependency"
+    case 425:
+      return "Too Early"
+    case 426:
+      return "Upgrade Required"
+    case 428:
+      return "Precondition Required"
+    case 429:
+      return "Too Many Requests"
+    case 431:
+      return "Request Header Fields Too Large"
+    case 451:
+      return "Unavailable For Legal Reasons"
+    case 500:
+      return "Internal Server Error"
+    case 501:
+      return "Not Implemented"
+    case 502:
+      return "Bad Gateway"
+    case 503:
+      return "Service Unavailable"
+    case 504:
+      return "Gateway Timeout"
+    case 505:
+      return "HTTP Version Not Supported"
+    case 506:
+      return "Variant Also Negotiates"
+    case 507:
+      return "Insufficient Storage"
+    case 508:
+      return "Loop Detected"
+    case 510:
+      return "Not Extended"
+    case 511:
+      return "Network Authentication Required"
+    default:
+      return "Error"
+  }
+}
+
+export const createErrorJson = (c: Context, input: Pick<HTTPException, "status" | "message"> & { code?: string }) => {
+  const status: StatusCode = input.status
+  const body: Omit<ErrorJson, "error" | "statusCode"> = {
+    message: input.message ?? "An error occurred.",
+  }
+
+  if (input.code != null) {
+    body.code = input.code
+  }
+
+  c.status(status)
+  return c.json({
+    ...body,
+    statusCode: status,
+    error: getErrorText(status),
+  })
+}
+
 export const zHook = <T extends z.ZodType<any, z.ZodTypeDef, any>>(result: TypeOf<T>, c: Context) => {
   if (result.success === true) return
 
@@ -24,12 +134,10 @@ export const zHook = <T extends z.ZodType<any, z.ZodTypeDef, any>>(result: TypeO
     ...Object.entries(flat.fieldErrors).map(([key, value]) => `${key}: ${value?.join(", ") ?? "error"}`),
   ]
 
-  c.status(400)
-  return c.json({
-    code: "FST_ERR_VALIDATION",
-    error: "Bad Request",
-    statusCode: 400,
+  return createErrorJson(c, {
+    status: 400,
     message: messages.join(", "),
+    code: "FST_ERR_VALIDATION",
   })
 }