Repository Public
1// Utilisation d'une clé d'API : agrégats (par jour, par route, envois par état) et appels récents filtrables.2// Partagé par l'onglet « Clés d'API » (lien « Utilisation ») et l'onglet « Journal d'utilisation ».3// Le journal ne contient ni corps, ni jeton, ni identifiant : seulement le gabarit de la route.4import { useEffect, useId, useMemo, useRef, useState } from "react"5import { STATUS_CLASSES, defaultCallFilter, filterCalls, methodsOf, statusClass, type CallFilter, type StatusClass } from "../../../admin/scopes"6import { fmtNumber, t } from "../../../i18n"7import { Field, Icon, Spinner } from "../../kit"8import { Section } from "../../Page"9import { DASH, Loadable, fmtWhen, useLoad } from "../shared"10import { loadUsage, type Usage } from "./api"11import "./keys.css"1213const PERIODS = [1, 7, 30, 90] as const14const SHOWN = 1001516function StatusCode({ status }: { status: number }) {17 const c = statusClass(status)18 return <span className={`badge ${c === "2xx" || c === "3xx" ? "ok" : c === "4xx" ? "warn" : "danger"} mono`}>{status}</span>19}2021export function UsageView({ keyId }: { keyId: string }) {22 const [days, setDays] = useState<number>(7)23 const [filter, setFilter] = useState<CallFilter>(() => defaultCallFilter(7))24 const [all, setAll] = useState(false)25 const load = useLoad((signal) => loadUsage(keyId, days, signal))26 const uid = useId()27 const first = useRef(true)28 useEffect(() => {29 if (first.current) first.current = false30 else load.reload()31 // eslint-disable-next-line react-hooks/exhaustive-deps32 }, [keyId, days])33 const changeDays = (n: number) => {34 setDays(n)35 setFilter((f) => ({ ...f, days: n }))36 }3738 return (39 <Loadable40 load={load}41 toolbar={42 <div className="adm-keys-period">43 <Field label={t("adm.keys.usage.period")} id={`${uid}p`}>44 <select id={`${uid}p`} className="select" value={days} onChange={(e) => changeDays(Number(e.target.value))} data-testid="usage-period">45 {PERIODS.map((n) => (46 <option key={n} value={n}>47 {t("adm.keys.usage.days", { n })}48 </option>49 ))}50 </select>51 </Field>52 </div>53 }54 >55 {(u) => (u.key?.id !== keyId || u.days !== days ? <Spinner label={t("common.loading")} /> : <UsageBody u={u} filter={filter} setFilter={setFilter} all={all} setAll={setAll} uid={uid} />)}56 </Loadable>57 )58}5960function UsageBody({ u, filter, setFilter, all, setAll, uid }: { u: Usage; filter: CallFilter; setFilter: (f: CallFilter) => void; all: boolean; setAll: (v: boolean) => void; uid: string }) {61 const requests = u.byDay.reduce((n, d) => n + d.requests, 0)62 const errors = u.byDay.reduce((n, d) => n + d.errors, 0)63 const explorer = u.byDay.reduce((n, d) => n + d.explorer, 0)64 const sent = u.sends.reduce((n, s) => n + s.n, 0)65 const peak = Math.max(1, ...u.byDay.map((d) => d.requests))66 const methods = useMemo(() => methodsOf(u.recent), [u.recent])67 const calls = useMemo(() => filterCalls(u.recent, filter), [u.recent, filter])68 const shown = all ? calls : calls.slice(0, SHOWN)6970 return (71 <div className="adm" data-testid="usage-view" data-key-id={u.key.id}>72 <Section title={t("adm.keys.usage.summary", { name: u.key.name })} description={t("adm.keys.usage.summaryNote", { n: u.days })}>73 <div className="adm-stats">74 <div className="adm-stat">75 <span className="adm-stat-value" data-testid="usage-requests">76 {fmtNumber(requests)}77 </span>78 <span className="small">{t("adm.keys.usage.requests")}</span>79 </div>80 <div className="adm-stat">81 <span className="adm-stat-value">{fmtNumber(errors)}</span>82 <span className="small">{t("adm.keys.usage.errors")}</span>83 </div>84 <div className="adm-stat">85 <span className="adm-stat-value">{fmtNumber(sent)}</span>86 <span className="small">{t("adm.keys.usage.sends")}</span>87 </div>88 <div className="adm-stat">89 <span className="adm-stat-value">{fmtNumber(explorer)}</span>90 <span className="small">{t("adm.keys.usage.explorerCalls")}</span>91 </div>92 </div>93 </Section>9495 <Section title={t("adm.keys.usage.sendsByStatus")}>96 {u.sends.length === 0 ? (97 <p className="muted small">{t("adm.keys.usage.noSends")}</p>98 ) : (99 <ul className="adm-keys-sends" data-testid="usage-sends">100 {u.sends.map((s) => (101 <li key={s.status}>102 <span className="mono">{s.status}</span>103 <strong>{fmtNumber(s.n)}</strong>104 </li>105 ))}106 </ul>107 )}108 </Section>109110 <Section title={t("adm.keys.usage.byDay")}>111 {u.byDay.length === 0 ? (112 <p className="muted small">{t("adm.keys.usage.noCalls")}</p>113 ) : (114 <div className="table-wrap">115 <table className="table cards-sm" data-testid="usage-by-day">116 <caption className="sr-only">{t("adm.keys.usage.byDay")}</caption>117 <thead>118 <tr>119 <th scope="col">{t("adm.keys.usage.col.day")}</th>120 <th scope="col">{t("adm.keys.usage.requests")}</th>121 <th scope="col">{t("adm.keys.usage.errors")}</th>122 <th scope="col">{t("adm.keys.usage.explorerCalls")}</th>123 </tr>124 </thead>125 <tbody>126 {u.byDay.map((d) => (127 <tr key={d.day}>128 <td className="mono adm-nowrap" data-label={t("adm.keys.usage.col.day")}>129 {d.day}130 </td>131 <td data-label={t("adm.keys.usage.requests")}>132 <span className="adm-keys-barcell">133 <span className="adm-keys-num">{fmtNumber(d.requests)}</span>134 <span className="adm-keys-bar" aria-hidden="true">135 <span style={{ width: `${Math.round((d.requests / peak) * 100)}%` }} />136 </span>137 </span>138 </td>139 <td data-label={t("adm.keys.usage.errors")}>{fmtNumber(d.errors)}</td>140 <td data-label={t("adm.keys.usage.explorerCalls")}>{fmtNumber(d.explorer)}</td>141 </tr>142 ))}143 </tbody>144 </table>145 </div>146 )}147 </Section>148149 <Section title={t("adm.keys.usage.byRoute")}>150 {u.byRoute.length === 0 ? (151 <p className="muted small">{t("adm.keys.usage.noCalls")}</p>152 ) : (153 <div className="table-wrap">154 <table className="table cards-sm" data-testid="usage-by-route">155 <caption className="sr-only">{t("adm.keys.usage.byRoute")}</caption>156 <thead>157 <tr>158 <th scope="col">{t("adm.keys.usage.col.method")}</th>159 <th scope="col">{t("adm.keys.usage.col.route")}</th>160 <th scope="col">{t("adm.keys.usage.requests")}</th>161 <th scope="col">{t("adm.keys.usage.errors")}</th>162 <th scope="col">{t("adm.keys.usage.col.avg")}</th>163 </tr>164 </thead>165 <tbody>166 {u.byRoute.map((r) => (167 <tr key={`${r.method} ${r.route}`}>168 <td className="mono" data-label={t("adm.keys.usage.col.method")}>169 {r.method}170 </td>171 <td className="mono adm-break" data-label={t("adm.keys.usage.col.route")}>172 {r.route}173 </td>174 <td data-label={t("adm.keys.usage.requests")}>{fmtNumber(r.requests)}</td>175 <td data-label={t("adm.keys.usage.errors")}>{fmtNumber(r.errors)}</td>176 <td className="adm-nowrap" data-label={t("adm.keys.usage.col.avg")}>177 {r.avgMs === null ? DASH : t("adm.keys.usage.ms", { n: fmtNumber(r.avgMs) })}178 </td>179 </tr>180 ))}181 </tbody>182 </table>183 </div>184 )}185 </Section>186187 <Section title={t("adm.keys.usage.recent")} description={t("adm.keys.usage.recentNote")}>188 <div className="adm-form adm-keys-filters">189 <Field label={t("adm.keys.usage.filter.status")} id={`${uid}fs`}>190 <select id={`${uid}fs`} className="select" value={filter.status} onChange={(e) => setFilter({ ...filter, status: e.target.value as StatusClass })} data-testid="usage-filter-status">191 {STATUS_CLASSES.map((c) => (192 <option key={c} value={c}>193 {t(`adm.keys.usage.status.${c}`)}194 </option>195 ))}196 </select>197 </Field>198 <Field label={t("adm.keys.usage.filter.method")} id={`${uid}fm`}>199 <select id={`${uid}fm`} className="select" value={filter.method} onChange={(e) => setFilter({ ...filter, method: e.target.value })} data-testid="usage-filter-method">200 <option value="all">{t("adm.keys.usage.method.all")}</option>201 {methods.map((m) => (202 <option key={m} value={m}>203 {m}204 </option>205 ))}206 </select>207 </Field>208 <Field label={t("adm.keys.usage.filter.explorer")} id={`${uid}fe`}>209 <select id={`${uid}fe`} className="select" value={filter.explorer} onChange={(e) => setFilter({ ...filter, explorer: e.target.value as CallFilter["explorer"] })} data-testid="usage-filter-explorer">210 <option value="all">{t("adm.keys.usage.explorer.all")}</option>211 <option value="without">{t("adm.keys.usage.explorer.without")}</option>212 <option value="only">{t("adm.keys.usage.explorer.only")}</option>213 </select>214 </Field>215 </div>216 <p className="muted small adm-keys-count" role="status" data-testid="usage-count">217 {t("adm.keys.usage.count", { n: calls.length, total: u.recent.length })}218 </p>219 {calls.length === 0 ? (220 <div className="empty">221 <Icon name="list" />222 <p>{u.recent.length === 0 ? t("adm.keys.usage.noCalls") : t("adm.keys.usage.noMatch")}</p>223 </div>224 ) : (225 <>226 <div className="table-wrap">227 <table className="table cards-sm" data-testid="usage-recent">228 <caption className="sr-only">{t("adm.keys.usage.recent")}</caption>229 <thead>230 <tr>231 <th scope="col">{t("adm.keys.usage.col.at")}</th>232 <th scope="col">{t("adm.keys.usage.col.method")}</th>233 <th scope="col">{t("adm.keys.usage.col.route")}</th>234 <th scope="col">{t("adm.keys.usage.col.status")}</th>235 <th scope="col">{t("adm.keys.usage.col.duration")}</th>236 <th scope="col">{t("adm.keys.usage.col.ip")}</th>237 </tr>238 </thead>239 <tbody>240 {shown.map((c, i) => (241 <tr key={`${c.at}-${i}`} data-route={c.route} data-status={c.status} data-method={c.method}>242 <td className="adm-nowrap" data-label={t("adm.keys.usage.col.at")}>243 {fmtWhen(c.at)}244 </td>245 <td className="mono" data-label={t("adm.keys.usage.col.method")}>246 {c.method}247 </td>248 <td className="mono adm-break" data-label={t("adm.keys.usage.col.route")}>249 {c.route}250 {c.explorer ? <span className="badge adm-keys-inline">{t("adm.keys.usage.explorerBadge")}</span> : null}251 </td>252 <td data-label={t("adm.keys.usage.col.status")}>253 <StatusCode status={c.status} />254 {c.error_code ? <span className="mono small muted adm-keys-inline">{c.error_code}</span> : null}255 </td>256 <td className="adm-nowrap" data-label={t("adm.keys.usage.col.duration")}>257 {c.duration_ms === null ? DASH : t("adm.keys.usage.ms", { n: fmtNumber(c.duration_ms) })}258 </td>259 <td className="mono" data-label={t("adm.keys.usage.col.ip")}>260 {c.ip ?? DASH}261 </td>262 </tr>263 ))}264 </tbody>265 </table>266 </div>267 {calls.length > SHOWN && !all ? (268 <button type="button" className="btn small adm-keys-more" onClick={() => setAll(true)}>269 {t("adm.keys.usage.showAll", { n: calls.length })}270 </button>271 ) : null}272 </>273 )}274 </Section>275 </div>276 )277}278