Repository Public
1// Onglet « Santé » : état de l'API, de la base, du serveur de courrier et des travailleurs (GET /api/v1/health), latence du2// serveur de courrier (vue d'ensemble), et résumé de l'exposition réseau tel que la documentation de déploiement l'établit.3import { useEffect, useState } from "react"4import { addMessages, fmtDateTime, fmtNumber, t } from "../../../i18n"5import { enAdmInfra } from "../../../i18n/en.adm.infra"6import { frAdmInfra } from "../../../i18n/fr.adm.infra"7import { HttpError, NetworkError } from "../../../jmap/errors"8import { linkProps } from "../../../state/session"9import { Icon, type IconName } from "../../kit"10import { Section } from "../../Page"11import { DASH, Loadable, StatusBadge, errorText, isRecord, loadOverview, useLoad, type Overview } from "../shared"12import "./infra.css"1314addMessages("fr", frAdmInfra)15addMessages("en", enAdmInfra)1617/** Pas d'interrogation plus rapide que 30 s. */18const REFRESH_MS = 30_0001920interface Health {21 ok: boolean22 version: string | null23 database: "ok" | "down" | null24 mailServer: "reachable" | "unreachable" | null25 workers: "on" | "off" | null26 /** code HTTP de la réponse (200, ou 503 quand la base ou le serveur de courrier est en panne) */27 status: number28}2930/**31 * La route répond 503 avec le même corps JSON quand quelque chose est en panne : ce corps est justement ce qu'il faut32 * montrer. `request()` le jetterait avec l'erreur ; lecture directe, même origine, sans effet de bord (GET).33 */34async function loadHealth(signal: AbortSignal): Promise<Health> {35 let r: Response36 try {37 r = await fetch("/api/v1/health", { headers: { accept: "application/json" }, credentials: "same-origin", cache: "no-store", signal })38 } catch (e) {39 if (e instanceof DOMException && e.name === "AbortError") throw e40 throw new NetworkError()41 }42 let body: unknown = null43 try {44 body = await r.json()45 } catch {46 /* corps non JSON */47 }48 if (!isRecord(body) || typeof body.ok !== "boolean") throw new HttpError(r.status, `http_${r.status}`)49 return {50 ok: body.ok,51 version: typeof body.version === "string" ? body.version : null,52 database: body.database === "ok" || body.database === "down" ? body.database : null,53 mailServer: body.mail_server === "reachable" || body.mail_server === "unreachable" ? body.mail_server : null,54 workers: body.workers === "on" || body.workers === "off" ? body.workers : null,55 status: r.status,56 }57}5859interface Data {60 health: Health61 overview: Overview | null62 overviewError: unknown63 at: string64}6566type Exposure = "public" | "private" | "closed"67const EXPOSURE_ICON: Record<Exposure, IconName> = { public: "globe", private: "shieldOk", closed: "close" }68const SERVICES: { id: "smtp" | "web" | "jmap" | "admin" | "legacy"; exposure: Exposure }[] = [69 { id: "smtp", exposure: "public" },70 { id: "web", exposure: "public" },71 { id: "jmap", exposure: "private" },72 { id: "admin", exposure: "private" },73 { id: "legacy", exposure: "closed" },74]7576function Unknown() {77 return <span className="badge">{t("adm.infra.health.unknown")}</span>78}7980export default function HealthTab() {81 const load = useLoad<Data>(async (signal) => {82 const [health, overview] = await Promise.all([loadHealth(signal), loadOverview(signal).then((o) => ({ o, e: null as unknown }), (e: unknown) => ({ o: null, e }))])83 if (signal.aborted) throw new DOMException("aborted", "AbortError")84 return { health, overview: overview.o, overviewError: overview.e, at: new Date().toISOString() }85 })86 const [auto, setAuto] = useState(false)87 const { reload } = load88 useEffect(() => {89 if (!auto) return90 const id = window.setInterval(() => {91 if (!document.hidden) reload()92 }, REFRESH_MS)93 return () => window.clearInterval(id)94 }, [auto, reload])9596 return (97 <Loadable98 load={load}99 toolbar={100 <button type="button" className="btn small" aria-pressed={auto} onClick={() => setAuto((v) => !v)} data-testid="health-auto">101 <Icon name={auto ? "check" : "clock"} small />102 <span>{t(auto ? "adm.infra.health.auto.on" : "adm.infra.health.auto.off")}</span>103 </button>104 }105 >106 {({ health: h, overview: o, overviewError, at }) => (107 <>108 <div className={`banner ${h.ok ? "ok" : "danger"}`} role="status" data-testid="health-banner" data-ok={h.ok}>109 <Icon name={h.ok ? "check" : "warn"} />110 <span>111 {t(h.ok ? "adm.infra.health.allOk" : "adm.infra.health.degraded")} <span className="muted">{t("adm.infra.health.checkedAt", { when: fmtDateTime(at) })}</span>112 </span>113 </div>114115 <p className="muted small" data-testid="health-dashboard-link">116 {t("adm.infra.health.dashboardNote")} <a {...linkProps("/admin/overview")}>{t("adm.infra.health.dashboardLink")}</a>117 </p>118119 <Section title={t("adm.infra.health.services")}>120 <dl className="adm-dl" data-testid="health-services">121 <dt>{t("adm.infra.health.api")}</dt>122 <dd className="row wrap" data-testid="health-api">123 <StatusBadge ok okText={t("adm.infra.health.api.ok")} badText="" />124 <span className="muted small">{t("adm.infra.health.version", { version: h.version ?? DASH })}</span>125 </dd>126 <dt>{t("adm.infra.health.database")}</dt>127 <dd data-testid="health-database" data-state={h.database ?? "unknown"}>128 {h.database === null ? <Unknown /> : <StatusBadge ok={h.database === "ok"} okText={t("adm.infra.health.database.ok")} badText={t("adm.infra.health.database.down")} />}129 </dd>130 <dt>{t("adm.infra.health.mail")}</dt>131 <dd className="row wrap" data-testid="health-mail" data-state={h.mailServer ?? "unknown"}>132 {h.mailServer === null ? <Unknown /> : <StatusBadge ok={h.mailServer === "reachable"} okText={t("adm.infra.health.mail.ok")} badText={t("adm.infra.health.mail.down")} />}133 {o && o.server.reachable && o.server.latencyMs !== null ? (134 <span className="muted small" data-testid="health-latency">135 {t("adm.infra.health.latency", { ms: fmtNumber(Math.round(o.server.latencyMs)) })}136 </span>137 ) : null}138 {o && !o.server.reachable ? <span className="adm-error small">{o.server.error ? t("adm.infra.health.mail.error", { detail: o.server.error }) : t("adm.infra.health.mail.managementDown")}</span> : null}139 </dd>140 <dt>{t("adm.infra.health.workers")}</dt>141 <dd data-testid="health-workers" data-state={h.workers ?? "unknown"}>142 {h.workers === null ? (143 <Unknown />144 ) : h.workers === "on" ? (145 <StatusBadge ok okText={t("adm.infra.health.workers.on")} badText="" />146 ) : (147 <span className="badge warn">148 <Icon name="warn" small />149 {t("adm.infra.health.workers.off")}150 </span>151 )}152 <span className="muted small adm-block">{t(h.workers === "off" ? "adm.infra.health.workers.offHint" : "adm.infra.health.workers.hint")}</span>153 </dd>154 </dl>155 {overviewError ? (156 <p className="adm-error small" role="alert">157 {t("adm.infra.health.overviewFailed", { detail: errorText(overviewError) })}158 </p>159 ) : null}160 </Section>161162 <Section title={t("adm.infra.exposure.title")} description={t("adm.infra.exposure.source")}>163 <div className="table-wrap">164 <table className="table cards-sm" data-testid="health-exposure">165 <caption className="sr-only">{t("adm.infra.exposure.title")}</caption>166 <thead>167 <tr>168 <th scope="col">{t("adm.infra.exposure.col.service")}</th>169 <th scope="col">{t("adm.infra.exposure.col.exposure")}</th>170 <th scope="col">{t("adm.infra.exposure.col.detail")}</th>171 </tr>172 </thead>173 <tbody>174 {SERVICES.map((s) => (175 <tr key={s.id} data-service={s.id} data-exposure={s.exposure}>176 <th scope="row" className="adm-rowhead">177 {t(`adm.infra.exposure.${s.id}`)}178 </th>179 <td data-label={t("adm.infra.exposure.col.exposure")}>180 <span className={`badge ${s.exposure === "public" ? "warn" : s.exposure === "private" ? "ok" : ""}`}>181 <Icon name={EXPOSURE_ICON[s.exposure]} small />182 {t(`adm.infra.exposure.${s.exposure}`)}183 </span>184 </td>185 <td data-label={t("adm.infra.exposure.col.detail")}>{t(`adm.infra.exposure.${s.id}.detail`)}</td>186 </tr>187 ))}188 </tbody>189 </table>190 </div>191 <dl className="adm-dl" data-testid="health-live">192 <dt>{t("adm.infra.exposure.live")}</dt>193 <dd>194 {o195 ? o.server.reachable196 ? t("adm.infra.exposure.live.ok", { ms: o.server.latencyMs === null ? DASH : fmtNumber(Math.round(o.server.latencyMs)) })197 : t("adm.infra.exposure.live.down")198 : t("adm.infra.exposure.live.unknown")}199 </dd>200 <dt>{t("adm.infra.exposure.domains")}</dt>201 <dd className="adm-break">{o && o.domains.length ? o.domains.map((d) => d.name).join(", ") : DASH}</dd>202 </dl>203 <p className="small muted">{t("adm.infra.exposure.noScan")}</p>204 </Section>205 </>206 )}207 </Loadable>208 )209}210