Skip to content

fix: add auth health check #843

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
arcoraven merged 2 commits into from
Feb 8, 2025
Merged

fix: add auth health check #843

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b19a23c
fix: add auth health check
arcoraven Feb 8, 2025
5f9bbf0
fix reply schema for 5xx
arcoraven Feb 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 35 additions & 34 deletions src/server/routes/system/health.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ import { isDatabaseReachable } from "../../../shared/db/client";
import { env } from "../../../shared/utils/env";
import { isRedisReachable } from "../../../shared/utils/redis/redis";
import { thirdwebClientId } from "../../../shared/utils/sdk";
import { createCustomError } from "../../middleware/error";

type EngineFeature =
| "KEYPAIR_AUTH"
Expand All @@ -14,8 +13,10 @@ type EngineFeature =
| "HETEROGENEOUS_WALLET_TYPES"
| "SMART_BACKEND_WALLETS";

const ReplySchemaOk = Type.Object({
status: Type.String(),
const ReplySchema = Type.Object({
db: Type.Boolean(),
redis: Type.Boolean(),
auth: Type.Boolean(),
engineVersion: Type.Optional(Type.String()),
engineTier: Type.Optional(Type.String()),
features: Type.Array(
Expand All @@ -30,15 +31,9 @@ const ReplySchemaOk = Type.Object({
clientId: Type.String(),
});

const ReplySchemaError = Type.Object({
error: Type.String(),
});

const responseBodySchema = Type.Union([ReplySchemaOk, ReplySchemaError]);

export async function healthCheck(fastify: FastifyInstance) {
fastify.route<{
Reply: Static<typeof responseBodySchema>;
Reply: Static<typeof ReplySchema>;
}>({
method: "GET",
url: "/system/health",
Expand All @@ -49,34 +44,27 @@ export async function healthCheck(fastify: FastifyInstance) {
tags: ["System"],
operationId: "checkHealth",
response: {
[StatusCodes.OK]: ReplySchemaOk,
[StatusCodes.SERVICE_UNAVAILABLE]: ReplySchemaError,
[StatusCodes.OK]: ReplySchema,
[StatusCodes.SERVICE_UNAVAILABLE]: ReplySchema,
},
},
handler: async (_, res) => {
if (!(await isDatabaseReachable())) {
throw createCustomError(
"The database is unreachable.",
StatusCodes.SERVICE_UNAVAILABLE,
"FAILED_HEALTHCHECK",
);
}

if (!(await isRedisReachable())) {
throw createCustomError(
"Redis is unreachable.",
StatusCodes.SERVICE_UNAVAILABLE,
"FAILED_HEALTHCHECK",
);
}
const db = await isDatabaseReachable();
const redis = await isRedisReachable();
const auth = await isAuthValid();
const isHealthy = db && redis && auth;

res.status(StatusCodes.OK).send({
status: "OK",
engineVersion: env.ENGINE_VERSION,
engineTier: env.ENGINE_TIER ?? "SELF_HOSTED",
features: getFeatures(),
clientId: thirdwebClientId,
});
res
.status(isHealthy ? StatusCodes.OK : StatusCodes.SERVICE_UNAVAILABLE)
.send({
db,
redis,
auth,
engineVersion: env.ENGINE_VERSION,
engineTier: env.ENGINE_TIER ?? "SELF_HOSTED",
features: getFeatures(),
clientId: thirdwebClientId,
});
},
});
}
Expand All @@ -95,3 +83,16 @@ const getFeatures = (): EngineFeature[] => {

return features;
};

async function isAuthValid() {
try {
const resp = await fetch("https://api.thirdweb.com/v2/keys/use", {
headers: {
"x-secret-key": env.THIRDWEB_API_SECRET_KEY,
},
});
return resp.ok;
} catch {
return false;
}
}