Open-source status page, incident response and uptime monitoring
TypeScript alertingincident-managementmcpmcp-servermonitoringmonitoring-as-codeobservabilityon-callopen-sourcesrestatus-pagestatuspagesynthetic-monitoringterraformtinybirdtursouptimeuptime-checkeruptime-monitor
import { z } from "@hono/zod-openapi";
import { getLogger } from "@logtape/logtape";
import type { ErrorCode } from "@openstatus/error";
import {
ErrorCodes,
SchemaError,
codeToStatus,
statusToCode,
} from "@openstatus/error";
// Props to Unkey: https://github.com/unkeyed/unkey/blob/main/apps/api/src/pkg/errors/http.ts
import type { Context } from "hono";
import { HTTPException } from "hono/http-exception";
import { ZodError } from "zod";
const logger = getLogger("api-server");
export class OpenStatusApiError extends HTTPException {
public readonly code: ErrorCode;
constructor({
code,
message,
}: {
code: ErrorCode;
message: HTTPException["message"];
}) {
const status = codeToStatus(code);
super(status, { message });
this.code = code;
}
}
export function handleError(err: Error, c: Context): Response {
if (err instanceof ZodError) {
const error = SchemaError.fromZod(err, c);
// If the error is a client error, we disable Sentry
c.get("sentry").setEnabled(false);
return c.json<ErrorSchema>(
{
code: "BAD_REQUEST",
message: error.message,
docs: "https://www.openstatus.dev/docs/api-references/errors/code/BAD_REQUEST",
requestId: c.get("requestId"),
},
{ status: 400 },
);
}
/**
* This is a custom error that we throw in our code so we can handle it
*/
if (err instanceof OpenStatusApiError) {
const code = statusToCode(err.status);
// If the error is a client error, we disable Sentry
if (err.status < 499) {
c.get("sentry").setEnabled(false);
}
return c.json<ErrorSchema>(
{
code: code,
message: err.message,
docs: `https://www.openstatus.dev/docs/api-references/errors/code/${code}`,
requestId: c.get("requestId"),
},
{ status: err.status },
);
}
if (err instanceof HTTPException) {
const code = statusToCode(err.status);
return c.json<ErrorSchema>(
{
code: code,
message: err.message,
docs: `https://www.openstatus.dev/docs/api-references/errors/code/${code}`,
requestId: c.get("requestId"),
},
{ status: err.status },
);
}
logger.error("Request error", {
error: {
name: err.name,
message: err.message,
stack: err.stack,
},
method: c.req.method,
url: c.req.url,
});
c.get("sentry").captureException(err);
return c.json<ErrorSchema>(
{
code: "INTERNAL_SERVER_ERROR",
message: err.message ?? "Something went wrong",
docs: "https://www.openstatus.dev/docs/api-references/errors/code/INTERNAL_SERVER_ERROR",
requestId: c.get("requestId"),
},
{ status: 500 },
);
}
export function handleZodError(
result:
| {
success: true;
data: unknown;
}
| {
success: false;
error: ZodError;
},
c: Context,
) {
if (!result.success) {
const error = SchemaError.fromZod(result.error, c);
return c.json<z.infer<ReturnType<typeof createErrorSchema>>>(
{
code: "BAD_REQUEST",
docs: "https://www.openstatus.dev/docs/api-references/errors/code/BAD_REQUEST",
message: error.message,
requestId: c.get("requestId"),
},
{ status: 400 },
);
}
}
export function createErrorSchema(code: ErrorCode) {
return z.object({
code: z.enum(ErrorCodes).openapi({
example: code,
description: "The error code related to the status code.",
}),
message: z.string().openapi({
description: "A human readable message describing the issue.",
example: "<string>",
}),
docs: z.string().openapi({
description: "A link to the documentation for the error.",
example: `https://www.openstatus.dev/docs/api-references/errors/code/${code}`,
}),
requestId: z.string().openapi({
description:
"The request id to be used for debugging and error reporting.",
example: "<uuid>",
}),
});
}
export type ErrorSchema = z.infer<ReturnType<typeof createErrorSchema>>;