103 lines
3.7 KiB
TypeScript
103 lines
3.7 KiB
TypeScript
import { readFileSync } from "node:fs";
|
|
import { isWorkerQueueGroup } from "@hivegrid/queue";
|
|
|
|
const FULL_GIT_SHA_PATTERN = /^[0-9a-f]{40}$/;
|
|
const IMAGE_REVISION_PATH = "/myapp/.image-revision";
|
|
const DEFAULT_HEALTH_PORT = "9100";
|
|
const HEALTH_TIMEOUT_MS = 9_000;
|
|
|
|
type WorkerDeployHealthIo = {
|
|
stderr?: Pick<NodeJS.WriteStream, "write">;
|
|
stdout: Pick<NodeJS.WriteStream, "write">;
|
|
};
|
|
|
|
type WorkerReadinessResponse = {
|
|
status?: unknown;
|
|
workerGroup?: unknown;
|
|
checks?: unknown;
|
|
};
|
|
|
|
type WorkerDeployHealthDependencies = {
|
|
fetchReadiness?: (url: string, init: RequestInit) => Promise<Pick<Response, "status" | "json">>;
|
|
readImageRevision?: () => string;
|
|
timeoutSignal?: () => AbortSignal;
|
|
};
|
|
|
|
function fail(io: WorkerDeployHealthIo, message: string): number {
|
|
io.stderr?.write(`${message}\n`);
|
|
return 1;
|
|
}
|
|
|
|
export async function runWorkerDeployHealthCli(
|
|
expectedRevision: string,
|
|
expectedGroup: string,
|
|
env: NodeJS.ProcessEnv = process.env,
|
|
io: WorkerDeployHealthIo = process,
|
|
dependencies: WorkerDeployHealthDependencies = {}
|
|
): Promise<number> {
|
|
if (!FULL_GIT_SHA_PATTERN.test(expectedRevision)) {
|
|
return fail(io, "Worker deployment health requires a full lowercase Git SHA.");
|
|
}
|
|
if (!isWorkerQueueGroup(expectedGroup)) {
|
|
return fail(io, "Worker deployment health requires a valid worker group.");
|
|
}
|
|
|
|
let imageRevision = "";
|
|
try {
|
|
imageRevision = (dependencies.readImageRevision ?? (() => readFileSync(IMAGE_REVISION_PATH, "utf8")))().trim();
|
|
} catch {
|
|
return fail(io, "Worker deployment image revision is unavailable.");
|
|
}
|
|
if (imageRevision !== expectedRevision || env.APP_REVISION !== expectedRevision) {
|
|
return fail(io, "Worker deployment revision does not match the expected image.");
|
|
}
|
|
if (env.WORKER_ENABLED !== "true") {
|
|
return fail(io, "Worker deployment health requires worker processing to be enabled.");
|
|
}
|
|
if (env.WORKER_QUEUE_GROUP !== expectedGroup) {
|
|
return fail(io, "Worker deployment group does not match the expected resource.");
|
|
}
|
|
|
|
const port = env.WORKER_HEALTH_PORT || DEFAULT_HEALTH_PORT;
|
|
if (!/^\d{1,5}$/.test(port) || Number(port) < 1 || Number(port) > 65_535) {
|
|
return fail(io, "Worker deployment health port is invalid.");
|
|
}
|
|
|
|
try {
|
|
const fetchReadiness = dependencies.fetchReadiness ?? fetch;
|
|
const response = await fetchReadiness(`http://127.0.0.1:${port}/readyz`, {
|
|
headers: { Accept: "application/json" },
|
|
signal: (dependencies.timeoutSignal ?? (() => AbortSignal.timeout(HEALTH_TIMEOUT_MS)))(),
|
|
});
|
|
if (response.status !== 200) {
|
|
return fail(io, "Worker deployment readiness is not healthy.");
|
|
}
|
|
const payload = (await response.json()) as WorkerReadinessResponse;
|
|
const checks = payload.checks;
|
|
const readinessChecks = typeof checks === "object" && checks !== null && !Array.isArray(checks) ? (checks as Record<string, unknown>) : null;
|
|
const allChecksReady =
|
|
readinessChecks !== null &&
|
|
readinessChecks.database === "ok" &&
|
|
readinessChecks.redis === "ok" &&
|
|
Object.values(readinessChecks).every((status) => status === "ok");
|
|
if (payload.status !== "ready" || payload.workerGroup !== expectedGroup || !allChecksReady) {
|
|
return fail(io, "Worker deployment readiness response does not match the expected runtime.");
|
|
}
|
|
} catch {
|
|
return fail(io, "Worker deployment readiness probe failed.");
|
|
}
|
|
|
|
io.stdout.write(`${JSON.stringify({ status: "ready", revision: expectedRevision, workerGroup: expectedGroup })}\n`);
|
|
return 0;
|
|
}
|
|
|
|
if (import.meta.url === `file://${process.argv[1]}`) {
|
|
runWorkerDeployHealthCli(process.argv[2] || "", process.argv[3] || "")
|
|
.then((exitCode) => {
|
|
process.exitCode = exitCode;
|
|
})
|
|
.catch(() => {
|
|
process.exitCode = 1;
|
|
});
|
|
}
|